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

#include "virtualFileSystem.h"

Public Types
enum	MountFlags { MF_read_only = 0x0002 }
Public Member Functions
bool	chdir (const Filename &new_directory)
	Changes the current directory.
bool	exists (const Filename &filename) const
	Convenience function; returns true if the named file exists.
int	find_all_files (const Filename &filename, const DSearchPath &searchpath, DSearchPath::Results &results) const
	Searches all the directories in the search list for the indicated file, in order.
Filename	get_cwd () const
	Returns the current directory name.
int	get_num_mounts () const
	Returns the number of individual mounts in the system.
bool	is_directory (const Filename &filename) const
	Convenience function; returns true if the named file exists and is a directory.
bool	is_regular_file (const Filename &filename) const
	Convenience function; returns true if the named file exists and is a regular file.
void	ls (const Filename &filename) const
	Convenience function; lists the files within the indicated directory.
void	ls_all (const Filename &filename) const
	Convenience function; lists the files within the indicated directory, and all files below, recursively.
	MAKE_SEQ (get_mounts, get_num_mounts, get_mount)
bool	mount (VirtualFileMount *mount, const Filename &mount_point, int flags)
	Adds the given VirtualFileMount object to the mount list.
bool	mount (const Filename &physical_filename, const Filename &mount_point, int flags, const string &password="")
	Mounts the indicated system file or directory at the given mount point.
bool	mount (Multifile *multifile, const Filename &mount_point, int flags)
	Mounts the indicated Multifile at the given mount point.
bool	mount_loop (const Filename &virtual_filename, const Filename &mount_point, int flags, const string &password="")
	This is similar to mount(), but it receives the name of a Multifile that already appears within the virtual file system.
istream *	open_read_file (const Filename &filename, bool auto_unwrap) const
	Convenience function; returns a newly allocated istream if the file exists and can be read, or NULL otherwise.
	PT (VirtualFile) get_file(const Filename &filename
	PT (VirtualFile) find_file(const Filename &filename
	PT (VirtualFileList) scan_directory(const Filename &filename) const
	PT (VirtualFileMount) get_mount(int n) const
string	read_file (const Filename &filename, bool auto_unwrap) const
	Convenience function; returns the entire contents of the indicated file as a string.
bool	read_file (const Filename &filename, string &result, bool auto_unwrap) const
	Convenience function; fills the string up with the data from the indicated file, if it exists and can be read.
bool	read_file (const Filename &filename, pvector< unsigned char > &result, bool auto_unwrap) const
	Convenience function; fills the pvector up with the data from the indicated file, if it exists and can be read.
bool	resolve_filename (Filename &filename, const DSearchPath &searchpath, const string &default_extension=string()) const
	Searches the given search path for the filename.
void	scan_mount_points (vector_string &names, const Filename &path) const
	Adds to names a list of all the mount points in use that are one directory below path, if any.
int	unmount (VirtualFileMount *mount)
	Unmounts the indicated VirtualFileMount object from the file system.
int	unmount (const Filename &physical_filename)
	Unmounts all appearances of the indicated directory name or multifile name from the file system.
int	unmount (Multifile *multifile)
	Unmounts all appearances of the indicated Multifile from the file system.
int	unmount_all ()
	Unmounts all files from the file system.
int	unmount_point (const Filename &mount_point)
	Unmounts all systems attached to the given mount point from the file system.
void	write (ostream &out) const
	Print debugging information.
Static Public Member Functions
static void	close_read_file (istream *stream)
	Closes a file opened by a previous call to open_read_file().
static VirtualFileSystem *	get_global_ptr ()
	Returns the default global VirtualFileSystem.
static void	parse_option (const string &option, int &flags, string &password)
	Parses one of the option flags in the options list on the vfs-mount Config.prc line.
Public Attributes
const DSearchPath &	searchpath
bool	status_only = false) const
const DSearchPath bool	status_only = false) const
ConfigVariableBool	vfs_case_sensitive
ConfigVariableBool	vfs_implicit_mf
ConfigVariableBool	vfs_implicit_pz

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.

Definition at line 44 of file virtualFileSystem.h.

Member Function Documentation

bool VirtualFileSystem::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.

Definition at line 470 of file virtualFileSystem.cxx.

Referenced by get_global_ptr().

void VirtualFileSystem::close_read_file ( 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.

Definition at line 831 of file virtualFileSystem.cxx.

Referenced by DatagramInputFile::close(), Texture::do_read_dds_file(), Texture::do_read_txo_file(), PNMImageHeader::make_reader(), open_read_file(), DXFFile::process(), XFile::read(), EggData::read(), DCFile::read(), FltHeader::read_flt(), and IffInputFile::set_input().

bool VirtualFileSystem::exists ( const Filename & filename ) const [inline]

Convenience function; returns true if the named file exists.

Definition at line 23 of file virtualFileSystem.I.

Referenced by Texture::do_read(), find_all_files(), PathReplace::full_convert_path(), WindowFramework::load_model(), Texture::load_related(), PathReplace::match_path(), EggData::resolve_egg_filename(), and resolve_filename().

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

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.

Definition at line 624 of file virtualFileSystem.cxx.

References DSearchPath::Results::add_file(), exists(), DSearchPath::get_directory(), DSearchPath::get_num_directories(), Filename::is_fully_qualified(), and Filename::is_local().

Filename VirtualFileSystem::get_cwd ( ) const

Returns the current directory name.

See chdir().

Definition at line 495 of file virtualFileSystem.cxx.

Referenced by Texture::write_datagram().

VirtualFileSystem * VirtualFileSystem::get_global_ptr ( ) [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.

Definition at line 685 of file virtualFileSystem.cxx.

References chdir(), ExecutionEnvironment::expand_string(), Filename::from_os_specific(), ExecutionEnvironment::get_cwd(), ConfigVariableList::get_num_unique_values(), ConfigVariableList::get_unique_value(), mount(), and parse_option().

Referenced by DatagramInputFile::close(), Texture::do_read(), Texture::do_read_dds_file(), Texture::do_read_txo_file(), PathReplace::full_convert_path(), AudioManager::get_dls_pathname(), VirtualFileMountSystem::has_file(), VirtualFileMountSystem::is_directory(), VirtualFileMountSystem::is_regular_file(), WindowFramework::load_model(), Texture::load_related(), Texture::make_from_bam(), PNMImageHeader::make_reader(), PathReplace::match_path(), DatagramInputFile::open(), IffInputFile::open_read(), Multifile::open_read(), VirtualFileMountSystem::open_read_file(), DXFFile::process(), XFile::read(), EggData::read(), DCFile::read(), FltHeader::read_flt(), EggData::resolve_egg_filename(), EggGroupNode::resolve_filenames(), VirtualFileMountSystem::scan_directory(), IffInputFile::set_input(), and Texture::write_datagram().

int VirtualFileSystem::get_num_mounts ( ) const

Returns the number of individual mounts in the system.

Definition at line 437 of file virtualFileSystem.cxx.

bool VirtualFileSystem::is_directory ( const Filename & filename ) const [inline]

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

Definition at line 34 of file virtualFileSystem.I.

bool VirtualFileSystem::is_regular_file ( const Filename & filename ) const [inline]

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

Definition at line 46 of file virtualFileSystem.I.

void VirtualFileSystem::ls ( const Filename & filename ) const [inline]

Convenience function; lists the files within the indicated directory.

Definition at line 77 of file virtualFileSystem.I.

void VirtualFileSystem::ls_all ( const Filename & filename ) const [inline]

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

Definition at line 95 of file virtualFileSystem.I.

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

Mounts the indicated Multifile at the given mount point.

Definition at line 90 of file virtualFileSystem.cxx.

Referenced by get_global_ptr(), mount(), mount_loop(), scan_mount_points(), unmount(), unmount_all(), unmount_point(), and write().

bool VirtualFileSystem::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.

Definition at line 210 of file virtualFileSystem.cxx.

bool VirtualFileSystem::mount	(	const Filename &	physical_filename,
		const Filename &	mount_point,
		int	flags,
		const string &	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.

Definition at line 124 of file virtualFileSystem.cxx.

References mount(), and Multifile::set_encryption_password().

bool VirtualFileSystem::mount_loop	(	const Filename &	virtual_filename,
		const Filename &	mount_point,
		int	flags,
		const string &	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.

Definition at line 171 of file virtualFileSystem.cxx.

References mount(), and Multifile::set_encryption_password().

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

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.

Definition at line 808 of file virtualFileSystem.cxx.

References close_read_file(), and VirtualFile::open_read_file().

Referenced by PNMImageHeader::make_reader(), IffInputFile::open_read(), Multifile::open_read(), DXFFile::process(), XFile::read(), EggData::read(), DCFile::read(), and FltHeader::read_flt().

void VirtualFileSystem::parse_option	(	const string &	option,
		int &	flags,
		string &	password
	)		`[static]`

Parses one of the option flags in the options list on the vfs-mount Config.prc line.

Definition at line 897 of file virtualFileSystem.cxx.

Referenced by get_global_ptr().

string VirtualFileSystem::read_file	(	const Filename &	filename,
		bool	auto_unwrap
	)		const `[inline]`

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.

Definition at line 118 of file virtualFileSystem.I.

bool VirtualFileSystem::read_file	(	const Filename &	filename,
		string &	result,
		bool	auto_unwrap
	)		const `[inline]`

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.

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.

Definition at line 139 of file virtualFileSystem.I.

bool VirtualFileSystem::read_file	(	const Filename &	filename,
		pvector< unsigned char > &	result,
		bool	auto_unwrap
	)		const `[inline]`

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.

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.

Definition at line 158 of file virtualFileSystem.I.