|
| closeReadFile (Istream stream) |
| Closes a file opened by a previous call to open_read_file(). This really just deletes the istream pointer, but it is recommended to use this interface instead of deleting it explicitly, to help work around compiler issues. More...
|
|
| closeReadWriteFile (Iostream stream) |
| Closes a file opened by a previous call to open_read_write_file(). This really just deletes the iostream pointer, but it is recommended to use this interface instead of deleting it explicitly, to help work around compiler issues. More...
|
|
| closeWriteFile (Ostream stream) |
| Closes a file opened by a previous call to open_write_file(). This really just deletes the ostream pointer, but it is recommended to use this interface instead of deleting it explicitly, to help work around compiler issues. More...
|
|
bool | copyFile (VirtualFile new_file) |
| Attempts to copy the contents of this file to the indicated file. Returns true on success, false on failure. More...
|
|
bool | deleteFile () |
| Attempts to delete this file or directory. This can remove a single file or an empty directory. It will not remove a nonempty directory. Returns true on success, false on failure. More...
|
|
Filename | getFilename () |
|
Streamsize | getFileSize () |
| Returns the current size on disk (or wherever it is) of the file before it has been opened. More...
|
|
Streamsize | getFileSize (Istream stream) |
| Returns the current size on disk (or wherever it is) of the already-open file. Pass in the stream that was returned by open_read_file(); some implementations may require this stream to determine the size. More...
|
|
VirtualFileSystem | getFileSystem () |
|
const Filename | getOriginalFilename () |
| Returns the original filename as it was used to locate this VirtualFile. This is usually, but not always, the same string returned by get_filename(). More...
|
|
bool | getSystemInfo (SubfileInfo info) |
| Populates the SubfileInfo structure with the data representing where the file actually resides on disk, if this is knowable. Returns true if the file might reside on disk, and the info is populated, or false if it does not (or it is not known where the file resides), in which case the info is meaningless. More...
|
|
time_t | getTimestamp () |
| Returns a time_t value that represents the time the file was last modified, to within whatever precision the operating system records this information (on a Windows95 system, for instance, this may only be accurate to within 2 seconds). More...
|
|
bool | hasFile () |
| Returns true if this file exists, false otherwise. More...
|
|
bool | isDirectory () |
| Returns true if this file represents a directory (and scan_directory() may be called), false otherwise. More...
|
|
bool | isRegularFile () |
| Returns true if this file represents a regular file (and read_file() may be called), false otherwise. More...
|
|
bool | isWritable () |
| Returns true if this file may be written to, which implies write_file() may be called (unless it is a directory instead of a regular file). More...
|
|
| ls (Ostream out) |
| If the file represents a directory, lists its contents. More...
|
|
| lsAll (Ostream out) |
| If the file represents a directory, recursively lists its contents and those of all subdirectories. More...
|
|
Ostream | openAppendFile () |
| Works like open_write_file(), but the file is opened in append mode. Like open_write_file, the returned pointer should eventually be passed to close_write_file(). More...
|
|
Iostream | openReadAppendFile () |
| Works like open_read_write_file(), but the file is opened in append mode. Like open_read_write_file, the returned pointer should eventually be passed to close_read_write_file(). More...
|
|
Istream | openReadFile (bool auto_unwrap) |
| Opens the file for reading. Returns a newly allocated istream on success (which you should eventually delete when you are done reading). Returns NULL on failure. More...
|
|
Iostream | openReadWriteFile (bool truncate) |
| Opens the file for writing. Returns a newly allocated iostream on success (which you should eventually delete when you are done writing). Returns NULL on failure. More...
|
|
Ostream | openWriteFile (bool auto_wrap, bool truncate) |
| Opens the file for writing. Returns a newly allocated ostream on success (which you should eventually delete when you are done writing). Returns NULL on failure. More...
|
|
| output (Ostream out) |
|
str | readFile (bool auto_unwrap) |
| Returns the entire contents of the file as a string. More...
|
|
bool | renameFile (VirtualFile new_file) |
| Attempts to move or rename this file or directory. If the original file is an ordinary file, it will quietly replace any already-existing file in the new filename (but not a directory). If the original file is a directory, the new filename must not already exist. More...
|
|
VirtualFileList | scanDirectory () |
| If the file represents a directory (that is, is_directory() returns true), this returns the list of files within the directory at the current time. Returns NULL if the file is not a directory or if the directory cannot be read. More...
|
|
bool | wasReadSuccessful () |
| Call this method after a reading the istream returned by open_read_file() to completion. If it returns true, the file was read completely and without error; if it returns false, there may have been some errors or a truncated file read. This is particularly likely if the stream is a VirtualFileHTTP. More...
|
|
bool | writeFile (str data, bool auto_wrap) |
| Writes the entire contents of the file as a string, if it is writable. More...
|
|
Public Member Functions inherited from TypedObject |
TypeHandle | getType () |
| Derived classes should override this function to return get_class_type(). More...
|
|
int | getTypeIndex () |
| Returns the internal index number associated with this object's TypeHandle, a unique number for each different type. This is equivalent to get_type().get_index(). More...
|
|
bool | isExactType (TypeHandle handle) |
| Returns true if the current object is the indicated type exactly. More...
|
|
bool | isOfType (TypeHandle handle) |
| Returns true if the current object is or derives from the indicated type. More...
|
|
Public Member Functions inherited from ReferenceCount |
int | getRefCount () |
| Returns the current reference count. More...
|
|
| ref () |
| Explicitly increments the reference count. User code should avoid using ref() and unref() directly, which can result in missed reference counts. Instead, let a PointerTo object manage the reference counting automatically. More...
|
|
bool | testRefCountIntegrity () |
| Does some easy checks to make sure that the reference count isn't completely bogus. Returns true if ok, false otherwise. More...
|
|
bool | testRefCountNonzero () |
| Does some easy checks to make sure that the reference count isn't zero, or completely bogus. Returns true if ok, false otherwise. More...
|
|
bool | unref () |
| Explicitly decrements the reference count. Note that the object will not be implicitly deleted by unref() simply because the reference count drops to zero. (Having a member function delete itself is problematic.) However, see the helper function unref_delete(). More...
|
|
The abstract base class for a file or directory within the VirtualFileSystem.