platform_file.h revision 201ade2fbba22bfb27ae029f4d23fca6ded109a0
1c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// Copyright (c) 2006-2008 The Chromium Authors. All rights reserved. 2c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// Use of this source code is governed by a BSD-style license that can be 3c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// found in the LICENSE file. 4c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 5c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott#ifndef BASE_PLATFORM_FILE_H_ 6c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott#define BASE_PLATFORM_FILE_H_ 73345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick#pragma once 8c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 93345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick#include "base/basictypes.h" 10c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott#include "build/build_config.h" 113345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick#include "base/time.h" 12c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott#if defined(OS_WIN) 13c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott#include <windows.h> 14c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott#endif 15c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 16c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott#include <string> 17c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 18c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scottclass FilePath; 19c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 20c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scottnamespace base { 21c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 22c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott#if defined(OS_WIN) 23c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scotttypedef HANDLE PlatformFile; 24c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scottconst PlatformFile kInvalidPlatformFileValue = INVALID_HANDLE_VALUE; 25c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott#elif defined(OS_POSIX) 26c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scotttypedef int PlatformFile; 27c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scottconst PlatformFile kInvalidPlatformFileValue = -1; 28c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott#endif 29c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 30c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scottenum PlatformFileFlags { 31c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott PLATFORM_FILE_OPEN = 1, 32c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott PLATFORM_FILE_CREATE = 2, 33c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott PLATFORM_FILE_OPEN_ALWAYS = 4, // May create a new file. 34c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott PLATFORM_FILE_CREATE_ALWAYS = 8, // May overwrite an old file. 35c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott PLATFORM_FILE_READ = 16, 36c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott PLATFORM_FILE_WRITE = 32, 37c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott PLATFORM_FILE_EXCLUSIVE_READ = 64, // EXCLUSIVE is opposite of Windows SHARE 38c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott PLATFORM_FILE_EXCLUSIVE_WRITE = 128, 39c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott PLATFORM_FILE_ASYNC = 256, 40c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott PLATFORM_FILE_TEMPORARY = 512, // Used on Windows only 41c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott PLATFORM_FILE_HIDDEN = 1024, // Used on Windows only 423345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick PLATFORM_FILE_DELETE_ON_CLOSE = 2048, 433345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick PLATFORM_FILE_TRUNCATE = 4096, 443345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick PLATFORM_FILE_WRITE_ATTRIBUTES = 8192 // Used on Windows only 453345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick}; 463345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick 473345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick// PLATFORM_FILE_ERROR_ACCESS_DENIED is returned when a call fails because of 483345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick// a filesystem restriction. PLATFORM_FILE_ERROR_SECURITY is returned when a 493345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick// browser policy doesn't allow the operation to be executed. 503345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrickenum PlatformFileError { 513345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick PLATFORM_FILE_OK = 0, 523345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick PLATFORM_FILE_ERROR_FAILED = -1, 533345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick PLATFORM_FILE_ERROR_IN_USE = -2, 543345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick PLATFORM_FILE_ERROR_EXISTS = -3, 553345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick PLATFORM_FILE_ERROR_NOT_FOUND = -4, 563345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick PLATFORM_FILE_ERROR_ACCESS_DENIED = -5, 573345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick PLATFORM_FILE_ERROR_TOO_MANY_OPENED = -6, 583345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick PLATFORM_FILE_ERROR_NO_MEMORY = -7, 593345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick PLATFORM_FILE_ERROR_NO_SPACE = -8, 603345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick PLATFORM_FILE_ERROR_NOT_A_DIRECTORY = -9, 613345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick PLATFORM_FILE_ERROR_INVALID_OPERATION = -10, 623345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick PLATFORM_FILE_ERROR_SECURITY = -11, 63731df977c0511bca2206b5f333555b1205ff1f43Iain Merrick PLATFORM_FILE_ERROR_ABORT = -12, 64731df977c0511bca2206b5f333555b1205ff1f43Iain Merrick PLATFORM_FILE_ERROR_NOT_A_FILE = -13, 65731df977c0511bca2206b5f333555b1205ff1f43Iain Merrick PLATFORM_FILE_ERROR_NOT_EMPTY = -14, 663345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick}; 673345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick 683345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick// Used to hold information about a given file. 693345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick// If you add more fields to this structure (platform-specific fields are OK), 703345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick// make sure to update all functions that use it in file_util_{win|posix}.cc 713345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick// too, and the ParamTraits<base::PlatformFileInfo> implementation in 723345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick// chrome/common/common_param_traits.cc. 733345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrickstruct PlatformFileInfo { 743345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick // The size of the file in bytes. Undefined when is_directory is true. 753345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick int64 size; 763345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick 773345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick // True if the file corresponds to a directory. 783345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick bool is_directory; 793345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick 80201ade2fbba22bfb27ae029f4d23fca6ded109a0Ben Murdoch // True if the file corresponds to a symbolic link. 81201ade2fbba22bfb27ae029f4d23fca6ded109a0Ben Murdoch bool is_symbolic_link; 82201ade2fbba22bfb27ae029f4d23fca6ded109a0Ben Murdoch 833345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick // The last modified time of a file. 843345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick base::Time last_modified; 853345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick 863345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick // The last accessed time of a file. 873345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick base::Time last_accessed; 883345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick 893345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick // The creation time of a file. 903345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick base::Time creation_time; 91c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott}; 92c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 93c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// Creates or opens the given file. If PLATFORM_FILE_OPEN_ALWAYS is used, and 94c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// |created| is provided, |created| will be set to true if the file was created 953345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick// or to false in case the file was just opened. |error_code| can be NULL. 96c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick ScottPlatformFile CreatePlatformFile(const FilePath& name, 97c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott int flags, 983345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick bool* created, 993345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick PlatformFileError* error_code); 100c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// Deprecated. 101c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick ScottPlatformFile CreatePlatformFile(const std::wstring& name, 102c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott int flags, 103c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott bool* created); 104c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 1053345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick// Closes a file handle. Returns |true| on success and |false| otherwise. 106c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scottbool ClosePlatformFile(PlatformFile file); 107c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 1083345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick// Reads the given number of bytes (or until EOF is reached) starting with the 1093345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick// given offset. Returns the number of bytes read, or -1 on error. 1103345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrickint ReadPlatformFile(PlatformFile file, int64 offset, char* data, int size); 1113345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick 1123345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick// Writes the given buffer into the file at the given offset, overwritting any 1133345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick// data that was previously there. Returns the number of bytes written, or -1 1143345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick// on error. 1153345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrickint WritePlatformFile(PlatformFile file, int64 offset, 1163345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick const char* data, int size); 1173345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick 1183345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick// Truncates the given file to the given length. If |length| is greater than 1193345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick// the current size of the file, the file is extended with zeros. If the file 1203345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick// doesn't exist, |false| is returned. 1213345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrickbool TruncatePlatformFile(PlatformFile file, int64 length); 1223345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick 1233345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick// Flushes the buffers of the given file. 1243345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrickbool FlushPlatformFile(PlatformFile file); 1253345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick 1263345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick// Touches the given file. 1273345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrickbool TouchPlatformFile(PlatformFile file, const Time& last_access_time, 1283345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick const Time& last_modified_time); 1293345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick 1303345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick// Returns some information for the given file. 1313345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrickbool GetPlatformFileInfo(PlatformFile file, PlatformFileInfo* info); 1323345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick 1333345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick// Use this class to pass ownership of a PlatformFile to a receiver that may or 1343345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick// may not want to accept it. This class does not own the storage for the 1353345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick// PlatformFile. 1363345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick// 1373345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick// EXAMPLE: 1383345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick// 1393345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick// void MaybeProcessFile(PassPlatformFile pass_file) { 1403345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick// if (...) { 1413345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick// PlatformFile file = pass_file.ReleaseValue(); 1423345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick// // Now, we are responsible for closing |file|. 1433345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick// } 1443345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick// } 1453345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick// 1463345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick// void OpenAndMaybeProcessFile(const FilePath& path) { 1473345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick// PlatformFile file = CreatePlatformFile(path, ...); 1483345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick// MaybeProcessFile(PassPlatformFile(&file)); 1493345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick// if (file != kInvalidPlatformFileValue) 1503345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick// ClosePlatformFile(file); 1513345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick// } 1523345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick// 1533345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrickclass PassPlatformFile { 1543345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick public: 1553345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick explicit PassPlatformFile(PlatformFile* value) : value_(value) { 1563345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick } 1573345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick 1583345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick // Called to retrieve the PlatformFile stored in this object. The caller 1593345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick // gains ownership of the PlatformFile and is now responsible for closing it. 1603345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick // Any subsequent calls to this method will return an invalid PlatformFile. 1613345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick PlatformFile ReleaseValue() { 1623345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick PlatformFile temp = *value_; 1633345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick *value_ = kInvalidPlatformFileValue; 1643345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick return temp; 1653345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick } 1663345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick 1673345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick private: 1683345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick PlatformFile* value_; 1693345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick}; 1703345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick 171c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott} // namespace base 172c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 173c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott#endif // BASE_PLATFORM_FILE_H_ 174