#include <file.h>
Inheritance diagram for PFile:
Construction | |
enum | OpenMode { ReadOnly, WriteOnly, ReadWrite } |
enum | OpenOptions { ModeDefault = -1, MustExist = 0, Create = 1, Truncate = 2, Exclusive = 4, Temporary = 8, DenySharedRead = 16, DenySharedWrite = 32 } |
PFile () | |
PFile (OpenMode mode, int opts=ModeDefault) | |
PFile (const PFilePath &name, OpenMode mode=ReadWrite, int opts=ModeDefault) | |
~PFile () | |
Close the file on destruction. | |
File channel functions | |
enum | FilePositionOrigin { Start = SEEK_SET, Current = SEEK_CUR, End = SEEK_END } |
Options for the origin in setting the file position. More... | |
const PFilePath & | GetFilePath () const |
void | SetFilePath (const PString &path) |
virtual BOOL | Open (OpenMode mode=ReadWrite, int opts=ModeDefault) |
virtual BOOL | Open (const PFilePath &name, OpenMode mode=ReadWrite, int opts=ModeDefault) |
virtual off_t | GetLength () const |
virtual BOOL | SetLength (off_t len) |
virtual BOOL | SetPosition (off_t pos, FilePositionOrigin origin=Start) |
virtual off_t | GetPosition () const |
BOOL | IsEndOfFile () const |
BOOL | GetInfo (PFileInfo &info) |
BOOL | SetPermissions (int permissions) |
static BOOL | GetInfo (const PFilePath &name, PFileInfo &info) |
static BOOL | SetPermissions (const PFilePath &name, int permissions) |
File manipulation functions | |
BOOL | Exists () const |
BOOL | Access (OpenMode mode) |
BOOL | Remove (BOOL force=FALSE) |
BOOL | Rename (const PString &newname, BOOL force=FALSE) |
BOOL | Copy (const PFilePath &newname, BOOL force=FALSE) |
BOOL | Move (const PFilePath &newname, BOOL force=FALSE) |
static BOOL | Exists (const PFilePath &name) |
static BOOL | Access (const PFilePath &name, OpenMode mode) |
static BOOL | Remove (const PFilePath &name, BOOL force=FALSE) |
static BOOL | Rename (const PFilePath &oldname, const PString &newname, BOOL force=FALSE) |
static BOOL | Copy (const PFilePath &oldname, const PFilePath &newname, BOOL force=FALSE) |
static BOOL | Move (const PFilePath &oldname, const PFilePath &newname, BOOL force=FALSE) |
Public Member Functions | |
Overrides from class PObject | |
Comparison | Compare (const PObject &obj) const |
Overrides from class PChannel | |
virtual PString | GetName () const |
virtual BOOL | Read (void *buf, PINDEX len) |
virtual BOOL | Write (const void *buf, PINDEX len) |
virtual BOOL | Close () |
Protected Attributes | |
PFilePath | path |
The fully qualified path name for the file. | |
BOOL | removeOnClose |
File is to be removed when closed. |
The basic model for files is that they are a named sequence of bytes that persists within a directory structure. The transfer of data to and from the file is made at a current position in the file. This may be set to random locations within the file.
|
Options for the origin in setting the file position.
|
|
When a file is opened, it may restrict the access available to operations on the object instance. A value from this enum is passed to the Open()# function to set the mode. |
|
When a file is opened, a number of options may be associated with the open file. These describe what action to take on opening the file and what to do on closure. A value from this enum is passed to the Open()# function to set the options. The ModeDefault# option will use the following values: {tabular}{rr} Mode & Options \ ReadOnly# & MustExist# \ WriteOnly# & Create | Truncate# \ ReadWrite# & Create# \ {tabular}
|
|
Create a file object but do not open it. It does not initially have a valid file name. However, an attempt to open the file using the Open()# function will generate a unique temporary file. |
|
Create a unique temporary file name, and open the file in the specified mode and using the specified options. Note that opening a new, unique, temporary file name in ReadOnly mode will always fail. This would only be usefull in a mode and options that will create the file. The PChannel::IsOpen()# function may be used after object construction to determine if the file was successfully opened.
|
|
Create a file object with the specified name and open it in the specified mode and with the specified options. The PChannel::IsOpen()# function may be used after object construction to determine if the file was successfully opened.
|
|
Close the file on destruction.
|
|
Check for file access modes. Determine if the file path specification associated with the instance of the object may be opened in the specified mode. This would check the current access rights to the file for the mode. For example, for a file that is read only, using mode == ReadWrite would return FALSE but mode == ReadOnly would return TRUE.
|
|
Check for file access modes. Determine if the file specified may be opened in the specified mode. This would check the current access rights to the file for the mode. For example, for a file that is read only, using mode == ReadWrite would return FALSE but mode == ReadOnly would return TRUE.
|
|
Close the file channel.
Reimplemented from PChannel. Reimplemented in PWAVFile. |
|
Determine the relative rank of the two objects. This is essentially the string comparison of the PFilePath# names of the files.
Reimplemented from PChannel. Reimplemented in PMemoryFile. |
|
Make a copy of the current file.
|
|
Make a copy of the specified file.
|
|
Check for file existance. Determine if the file path specification associated with the instance of the object actually exists within the platforms file system.
|
|
Check for file existance. Determine if the file specified actually exists within the platforms file system.
|
|
Get the full path name of the file. The PFilePath# object describes the full file name specification for the particular platform.
|
|
Get information (eg protection, timestamps) on the current file.
|
|
Get information (eg protection, timestamps) on the specified file.
|
|
Get the current size of the file.
Reimplemented in PMemoryFile. |
|
Get the platform and I/O channel type name of the channel. For example, it would return the filename in PFile# type channels.
Reimplemented from PChannel. |
|
Get the current active position in the file for the next read or write operation.
Reimplemented in PMemoryFile, and PWAVFile. |
|
Determine if the current file position is at the end of the file. If this is TRUE then any read operation will fail.
|
|
Move the current file. This will move the file from one position in the directory hierarchy to another position. The actual operation is platform dependent but the reslt is the same. For instance, for Unix, if the move is within a file system then a simple rename is done, if it is across file systems then a copy and a delete is performed.
|
|
Move the specified file. This will move the file from one position in the directory hierarchy to another position. The actual operation is platform dependent but the reslt is the same. For instance, for Unix, if the move is within a file system then a simple rename is done, if it is across file systems then a copy and a delete is performed.
|
|
Open the specified file name in the specified mode and with the specified options. If the file object already has an open file then it is closed. Note: if mode# is StandardInput, StandardOutput or StandardError, then the name# parameter is ignored.
|
|
Open the current file in the specified mode and with the specified options. If the file object already has an open file then it is closed. If there has not been a filename attached to the file object (via SetFilePath()#, the name# parameter or a previous open) then a new unique temporary filename is generated.
|
|
Low level read from the file channel. The read timeout is ignored for file I/O. The GetLastReadCount() function returns the actual number of bytes read. The GetErrorCode() function should be consulted after Read() returns FALSE to determine what caused the failure.
Reimplemented from PChannel. Reimplemented in PMemoryFile, and PWAVFile. |
|
Delete the current file. If force# is FALSE and the file is protected against being deleted then the function fails. If force# is TRUE then the protection is ignored. What constitutes file deletion protection is platform dependent, eg on DOS is the Read Only attribute and on a Novell network it is a Delete trustee right. Some protection may not be able to overridden with the force# parameter at all, eg on a Unix system and you are not the owner of the file.
|
|
Delete the specified file. If force# is FALSE and the file is protected against being deleted then the function fails. If force# is TRUE then the protection is ignored. What constitutes file deletion protection is platform dependent, eg on DOS is the Read Only attribute and on a Novell network it is a Delete trustee right. Some protection may not be able to overridden with the force# parameter at all, eg on a Unix system and you are not the owner of the file.
|
|
Change the current files name. This does not move the file in the directory hierarchy, it only changes the name of the directory entry. The newname# parameter must consist only of the file name part, as returned by the PFilePath::GetFileName()# function. Any other file path parts will cause an error. The first form uses the file path specification associated with the instance of the object. The name within the instance is changed to the new name if the function succeeds. The second static function uses an arbitrary file specified by name.
|
|
Change the specified files name. This does not move the file in the directory hierarchy, it only changes the name of the directory entry. The newname# parameter must consist only of the file name part, as returned by the PFilePath::GetFileName()# function. Any other file path parts will cause an error. The first form uses the file path specification associated with the instance of the object. The name within the instance is changed to the new name if the function succeeds. The second static function uses an arbitrary file specified by name.
|
|
Set the full path name of the file. The PFilePath# object describes the full file name specification for the particular platform.
|
|
Set the size of the file, padding with 0 bytes if it would require expanding the file, or truncating it if being made shorter.
Reimplemented in PMemoryFile. |
|
Set permissions on the current file.
|
|
Set permissions on the specified file.
|
|
Set the current active position in the file for the next read or write operation. The pos# variable is a signed number which is added to the specified origin. For origin == PFile::Start# only positive values for pos# are meaningful. For origin == PFile::End# only negative values for pos# are meaningful.
|
|
Low level write to the file channel. The write timeout is ignored for file I/O. The GetLastWriteCount() function returns the actual number of bytes written. The GetErrorCode() function should be consulted after Write() returns FALSE to determine what caused the failure.
Reimplemented from PChannel. Reimplemented in PMemoryFile, and PWAVFile. |
|
The fully qualified path name for the file.
|
|
File is to be removed when closed.
|