VirtualFileSystem

Inheritance:

Methods of VirtualFileSystem:

Constants in VirtualFileSystem:

VirtualFileSystem
VirtualFileSystem::VirtualFileSystem(void);

Description:

chdir
bool VirtualFileSystem::chdir(Filename const &new_directory);

Description: Changes the current directory. This is used to resolve relative pathnames in get_file() and/or find_file(). Returns true if successful, false otherwise.

closeReadFile
static void VirtualFileSystem::close_read_file(istream *stream);

Description: 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.

exists
bool VirtualFileSystem::exists(Filename const &filename) const;

Description: Convenience function; returns true if the named file exists.

findAllFiles
int VirtualFileSystem::find_all_files(Filename const &filename, DSearchPath const &searchpath, DSearchPath::Results &results) const;

Description: Searches all the directories in the search list for the indicated file, in order. Fills up the results list with *all* of the matching filenames found, if any. Returns the number of matches found.
It is the responsibility of the the caller to clear the results list first; otherwise, the newly-found files will be appended to the list.

findFile
PointerTo< VirtualFile > VirtualFileSystem::find_file(Filename const &filename, DSearchPath const &searchpath, bool status_only = (0)) const;

Description: Uses the indicated search path to find the file within the file system. Returns the first occurrence of the file found, or NULL if the file cannot be found.

getCwd
Filename VirtualFileSystem::get_cwd(void) const;

Description: Returns the current directory name. See chdir().

getFile
PointerTo< VirtualFile > VirtualFileSystem::get_file(Filename const &filename, bool status_only = (0)) const;

Description: Looks up the file by the indicated name in the file system. Returns a VirtualFile pointer representing the file if it is found, or NULL if it is not.
If status_only is true, the file will be checked for existence and length and so on, but the returned file's contents cannot be read. This is an optimization which is especially important for certain mount types, for instance HTTP, for which opening a file to determine its status is substantially less expensive than opening it to read its contents.

getGlobalPtr
static VirtualFileSystem *VirtualFileSystem::get_global_ptr(void);

Description: Returns the default global VirtualFileSystem. You may create your own personal VirtualFileSystem objects and use them for whatever you like, but Panda will attempt to load models and stuff from this default object.
Initially, the global VirtualFileSystem is set up to mount the OS filesystem to root; i.e. it is equivalent to the OS filesystem. This may be subsequently adjusted by the user.

getMount
PointerTo< VirtualFileMount > VirtualFileSystem::get_mount(int n) const;

Description: Returns the nth mount in the system.

getNumMounts
int VirtualFileSystem::get_num_mounts(void) const;

Description: Returns the number of individual mounts in the system.

isDirectory
bool VirtualFileSystem::is_directory(Filename const &filename) const;

Description: Convenience function; returns true if the named file exists and is a directory.

isRegularFile
bool VirtualFileSystem::is_regular_file(Filename const &filename) const;

Description: Convenience function; returns true if the named file exists and is a regular file.

ls
void VirtualFileSystem::ls(Filename const &filename) const;

Description: Convenience function; lists the files within the indicated directory.

lsAll
void VirtualFileSystem::ls_all(Filename const &filename) const;

Description: Convenience function; lists the files within the indicated directory, and all files below, recursively.

mount
bool VirtualFileSystem::mount(Multifile *multifile, Filename const &mount_point, int flags);

Description: Mounts the indicated Multifile at the given mount point.
Description: Mounts the indicated system file or directory at the given mount point. If the named file is a directory, mounts the directory. If the named file is a Multifile, mounts it as a Multifile. Returns true on success, false on failure.
A given system directory may be mounted to multiple different mount point, and the same mount point may share multiple system directories. In the case of ambiguities (that is, two different files with exactly the same full pathname), the most-recently mounted system wins.
Note that a mounted VirtualFileSystem directory is fully case-sensitive, unlike the native Windows file system, so you must refer to files within the virtual file system with exactly the right case.
Description: Adds the given VirtualFileMount object to the mount list. This is a lower-level function that the other flavors of mount(); it requires you to create a VirtualFileMount object specifically.

openReadFile
istream *VirtualFileSystem::open_read_file(Filename const &filename, bool auto_unwrap) const;

Description: Convenience function; returns a newly allocated istream if the file exists and can be read, or NULL otherwise. Does not return an invalid istream.
If auto_unwrap is true, an explicitly-named .pz file is automatically decompressed and the decompressed contents are returned. This is different than vfs-implicit-pz, which will automatically decompress a file if the extension .pz is *not* given.

readFile
string VirtualFileSystem::read_file(Filename const &filename, bool auto_unwrap) const;

Description: Convenience function; returns the entire contents of the indicated file as a string.
If auto_unwrap is true, an explicitly-named .pz file is automatically decompressed and the decompressed contents are returned. This is different than vfs-implicit-pz, which will automatically decompress a file if the extension .pz is *not* given.
Description: Convenience function; fills the string up with the data from the indicated file, if it exists and can be read. Returns true on success, false otherwise.
Description: Convenience function; fills the pvector up with the data from the indicated file, if it exists and can be read. Returns true on success, false otherwise.

resolveFilename
bool VirtualFileSystem::resolve_filename(Filename &filename, DSearchPath const &searchpath, string const &default_extension = ((string()))) const;

Description: Searches the given search path for the filename. If it is found, updates the filename to the full pathname found and returns true; otherwise, returns false.

scanDirectory
PointerTo< VirtualFileList > VirtualFileSystem::scan_directory(Filename const &filename) const;

Description: 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.

unmount
int VirtualFileSystem::unmount(Multifile *multifile);

Description: Unmounts all appearances of the indicated Multifile from the file system. Returns the number of appearances unmounted.
Description: Unmounts all appearances of the indicated directory name or multifile name from the file system. Returns the number of appearances unmounted.
Description: Unmounts the indicated VirtualFileMount object from the file system. Returns the number of appearances unmounted.

unmountAll
int VirtualFileSystem::unmount_all(void);

Description: Unmounts all files from the file system. Returns the number of systems unmounted.

unmountPoint
int VirtualFileSystem::unmount_point(Filename const &mount_point);

Description: Unmounts all systems attached to the given mount point from the file system. Returns the number of appearances unmounted.

write
void VirtualFileSystem::write(ostream &out) const;

Description: Print debugging information. (e.g. from Python or gdb prompt).