Panda3D
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
VirtualFileSystem Class Reference

A hierarchy of directories and files that appears to be one continuous file system, even though the files may originate from several different sources that may not be related to the actual OS's file system. More...

Public Types

enum  MountFlags { MF_read_only = 2 }
 

Public Member Functions

 __init__ ()
 
bool chdir (const Filename new_directory)
 Changes the current directory. More...
 
bool copyFile (const Filename orig_filename, const Filename new_filename)
 Attempts to copy the contents of the indicated file to the indicated file. More...
 
VirtualFile createFile (const Filename filename)
 Attempts to create a file by the indicated name in the filesystem, if possible, and returns it. More...
 
bool deleteFile (const Filename filename)
 Attempts to delete the indicated file or directory. More...
 
bool exists (const Filename filename)
 Convenience function; returns true if the named file exists. More...
 
int findAllFiles (const Filename filename, const DSearchPath searchpath, DSearchPath::Results results)
 Searches all the directories in the search list for the indicated file, in order. More...
 
VirtualFile findFile (const Filename filename, const DSearchPath searchpath, bool status_only)
 Uses the indicated search path to find the file within the file system. More...
 
Filename getCwd ()
 Returns the current directory name. More...
 
VirtualFile getFile (const Filename filename, bool status_only)
 Looks up the file by the indicated name in the file system. More...
 
VirtualFileMount getMount (int n)
 Returns the nth mount in the system. More...
 
list getMounts ()
 
int getNumMounts ()
 Returns the number of individual mounts in the system. More...
 
bool isDirectory (const Filename filename)
 Convenience function; returns true if the named file exists and is a directory. More...
 
bool isRegularFile (const Filename filename)
 Convenience function; returns true if the named file exists and is a regular file. More...
 
 ls (const Filename filename)
 Convenience function; lists the files within the indicated directory. More...
 
 lsAll (const Filename filename)
 Convenience function; lists the files within the indicated directory, and all files below, recursively. More...
 
bool makeDirectory (const Filename filename)
 Attempts to create a directory within the file system. More...
 
bool makeDirectoryFull (const Filename filename)
 Attempts to create a directory within the file system. More...
 
bool mount (const Filename physical_filename, const Filename mount_point, int flags, str password)
 Mounts the indicated system file or directory at the given mount point. More...
 
bool mount (Multifile multifile, const Filename mount_point, int flags)
 Mounts the indicated Multifile at the given mount point. More...
 
bool mount (VirtualFileMount mount, const Filename mount_point, int flags)
 Adds the given VirtualFileMount object to the mount list. More...
 
bool mountLoop (const Filename virtual_filename, const Filename mount_point, int flags, str password)
 This is similar to mount(), but it receives the name of a Multifile that already appears within the virtual file system. More...
 
Ostream openAppendFile (const Filename filename)
 Works like open_write_file(), but the file is opened in append mode. More...
 
Iostream openReadAppendFile (const Filename filename)
 Works like open_read_write_file(), but the file is opened in append mode. More...
 
Istream openReadFile (const Filename filename, bool auto_unwrap)
 Convenience function; returns a newly allocated istream if the file exists and can be read, or NULL otherwise. More...
 
Iostream openReadWriteFile (const Filename filename, bool truncate)
 Convenience function; returns a newly allocated iostream if the file exists and can be written, or NULL otherwise. More...
 
Ostream openWriteFile (const Filename filename, bool auto_wrap, bool truncate)
 Convenience function; returns a newly allocated ostream if the file exists and can be written, or NULL otherwise. More...
 
object readFile (const Filename filename, bool auto_unwrap)
 Convenience function; returns the entire contents of the indicated file as a string. More...
 
bool renameFile (const Filename orig_filename, const Filename new_filename)
 Attempts to move or rename the indicated file or directory. More...
 
bool resolveFilename (Filename filename, const DSearchPath searchpath, str default_extension)
 Searches the given search path for the filename. More...
 
VirtualFileList scanDirectory (const Filename filename)
 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. More...
 
int unmount (const Filename physical_filename)
 Unmounts all appearances of the indicated directory name or multifile name from the file system. More...
 
int unmount (Multifile multifile)
 Unmounts all appearances of the indicated Multifile from the file system. More...
 
int unmount (VirtualFileMount mount)
 Unmounts the indicated VirtualFileMount object from the file system. More...
 
int unmountAll ()
 Unmounts all files from the file system. More...
 
int unmountPoint (const Filename mount_point)
 Unmounts all systems attached to the given mount point from the file system. More...
 
 write (Ostream out)
 Print debugging information. More...
 
object writeFile (const Filename filename, object data, bool auto_wrap)
 

Static Public Member Functions

static closeReadFile (Istream stream)
 Closes a file opened by a previous call to open_read_file(). More...
 
static closeReadWriteFile (Iostream stream)
 Closes a file opened by a previous call to open_read_write_file(). More...
 
static closeWriteFile (Ostream stream)
 Closes a file opened by a previous call to open_write_file(). More...
 
static VirtualFileSystem getGlobalPtr ()
 Returns the default global VirtualFileSystem. More...
 

Public Attributes

PointerToVirtualFileMount mounts []
 

Detailed Description

A hierarchy of directories and files that appears to be one continuous file system, even though the files may originate from several different sources that may not be related to the actual OS's file system.

For instance, a VirtualFileSystem can transparently mount one or more Multifiles as their own subdirectory hierarchies.

Member Enumeration Documentation

◆ MountFlags

enum MountFlags
Enumerator
MF_read_only 

Member Function Documentation

◆ __init__()

__init__ ( )

◆ chdir()

bool chdir ( const Filename  new_directory)

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 closeReadFile ( Istream  stream)
static

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.

◆ closeReadWriteFile()

static closeReadWriteFile ( Iostream  stream)
static

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.

◆ closeWriteFile()

static closeWriteFile ( Ostream  stream)
static

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.

◆ copyFile()

bool copyFile ( const Filename  orig_filename,
const Filename  new_filename 
)

Attempts to copy the contents of the indicated file to the indicated file.

Returns true on success, false on failure.

◆ createFile()

VirtualFile createFile ( const Filename  filename)

Attempts to create a file by the indicated name in the filesystem, if possible, and returns it.

If a file by this name already exists, returns the same thing as get_file(). If the filename is located within a read- only directory, or the directory doesn't exist, returns NULL.

◆ deleteFile()

bool deleteFile ( const Filename  filename)

Attempts to delete the indicated 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.

◆ exists()

bool exists ( const Filename  filename)

Convenience function; returns true if the named file exists.

◆ findAllFiles()

int findAllFiles ( const Filename  filename,
const DSearchPath  searchpath,
DSearchPath::Results  results 
)

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()

VirtualFile findFile ( const Filename  filename,
const DSearchPath  searchpath,
bool  status_only 
)

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 getCwd ( )

Returns the current directory name.

See chdir().

◆ getFile()

VirtualFile getFile ( const Filename  filename,
bool  status_only 
)

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 getGlobalPtr ( )
static

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()

VirtualFileMount getMount ( int  n)

Returns the nth mount in the system.

◆ getMounts()

list getMounts ( )

◆ getNumMounts()

int getNumMounts ( )

Returns the number of individual mounts in the system.

◆ isDirectory()

bool isDirectory ( const Filename  filename)

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

◆ isRegularFile()

bool isRegularFile ( const Filename  filename)

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

◆ ls()

ls ( const Filename  filename)

Convenience function; lists the files within the indicated directory.

◆ lsAll()

lsAll ( const Filename  filename)

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

◆ makeDirectory()

bool makeDirectory ( const Filename  filename)

Attempts to create a directory within the file system.

Returns true on success, false on failure (for instance, because the parent directory does not exist, or is read-only). If the directory already existed prior to this call, returns true.

◆ makeDirectoryFull()

bool makeDirectoryFull ( const Filename  filename)

Attempts to create a directory within the file system.

Will also create any intervening directories needed. Returns true on success, false on failure.

◆ mount() [1/3]

bool mount ( const Filename  physical_filename,
const Filename  mount_point,
int  flags,
str  password 
)

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.

The filename specified as the first parameter must refer to a real, physical filename on disk; it cannot be a virtual file already appearing within the vfs filespace. However, it is possible to mount such a file; see mount_loop() for this.

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.

◆ mount() [2/3]

bool mount ( Multifile  multifile,
const Filename  mount_point,
int  flags 
)

Mounts the indicated Multifile at the given mount point.

◆ mount() [3/3]

bool mount ( VirtualFileMount  mount,
const Filename  mount_point,
int  flags 
)

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.

◆ mountLoop()

bool mountLoop ( const Filename  virtual_filename,
const Filename  mount_point,
int  flags,
str  password 
)

This is similar to mount(), but it receives the name of a Multifile that already appears within the virtual file system.

It can be used to mount a Multifile that is itself hosted within a virtually-mounted Multifile.

This interface can also be used to mount physical files (that appear within the virtual filespace), but it cannot be used to mount directories. Use mount() if you need to mount a directory.

Note that there is additional overhead, in the form of additional buffer copies of the data, for recursively mounting a multifile like this.

◆ openAppendFile()

Ostream openAppendFile ( const Filename  filename)

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().

◆ openReadAppendFile()

Iostream openReadAppendFile ( const Filename  filename)

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().

◆ openReadFile()

Istream openReadFile ( const Filename  filename,
bool  auto_unwrap 
)

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.

◆ openReadWriteFile()

Iostream openReadWriteFile ( const Filename  filename,
bool  truncate 
)

Convenience function; returns a newly allocated iostream if the file exists and can be written, or NULL otherwise.

Does not return an invalid iostream.

◆ openWriteFile()

Ostream openWriteFile ( const Filename  filename,
bool  auto_wrap,
bool  truncate 
)

Convenience function; returns a newly allocated ostream if the file exists and can be written, or NULL otherwise.

Does not return an invalid ostream.

If auto_wrap is true, an explicitly-named .pz file is automatically compressed while writing. If truncate is true, the file is truncated to zero length before writing.

◆ readFile()

object readFile ( const Filename  filename,
bool  auto_unwrap 
)

Convenience function; returns the entire contents of the indicated file as a string.

If auto_unwrap is true, an explicitly-named .pz/.gz 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.

◆ renameFile()

bool renameFile ( const Filename  orig_filename,
const Filename  new_filename 
)

Attempts to move or rename the indicated 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.

If the file is a directory, the new filename must be within the same mount point. If the file is an ordinary file, the new filename may be anywhere; but if it is not within the same mount point then the rename operation is automatically performed as a two-step copy-and-delete operation.

◆ resolveFilename()

bool resolveFilename ( Filename  filename,
const DSearchPath  searchpath,
str  default_extension 
)

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()

VirtualFileList scanDirectory ( const Filename  filename)

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() [1/3]

int unmount ( const Filename  physical_filename)

Unmounts all appearances of the indicated directory name or multifile name from the file system.

Returns the number of appearances unmounted.

◆ unmount() [2/3]

int unmount ( Multifile  multifile)

Unmounts all appearances of the indicated Multifile from the file system.

Returns the number of appearances unmounted.

◆ unmount() [3/3]

int unmount ( VirtualFileMount  mount)

Unmounts the indicated VirtualFileMount object from the file system.

Returns the number of appearances unmounted.

◆ unmountAll()

int unmountAll ( )

Unmounts all files from the file system.

Returns the number of systems unmounted.

◆ unmountPoint()

int unmountPoint ( const Filename  mount_point)

Unmounts all systems attached to the given mount point from the file system.

Returns the number of appearances unmounted.

◆ write()

write ( Ostream  out)

Print debugging information.

(e.g. from Python or gdb prompt).

◆ writeFile()

object writeFile ( const Filename  filename,
object  data,
bool  auto_wrap 
)

Member Data Documentation

◆ mounts