Panda3D
Public Member Functions | Static Public Member Functions

VirtualFileMountSystem Class Reference

Maps an actual OS directory into the VirtualFileSystem. More...

#include "virtualFileMountSystem.h"

Inheritance diagram for VirtualFileMountSystem:
VirtualFileMount TypedReferenceCount TypedObject ReferenceCount MemoryBase MemoryBase

List of all members.

Public Member Functions

 VirtualFileMountSystem (const Filename &physical_filename)
virtual TypeHandle force_init_type ()
virtual off_t get_file_size (const Filename &file) const
 Returns the current size on disk (or wherever it is) of the file before it has been opened.
virtual off_t get_file_size (const Filename &file, istream *stream) const
 Returns the current size on disk (or wherever it is) of the already-open file.
const Filenameget_physical_filename () const
 Returns the name of the source file on the OS filesystem of the directory or file that is mounted.
virtual time_t get_timestamp (const Filename &file) const
 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).
virtual TypeHandle get_type () const
virtual bool has_file (const Filename &file) const
 Returns true if the indicated file exists within the mount system.
virtual bool is_directory (const Filename &file) const
 Returns true if the indicated file exists within the mount system and is a directory.
virtual bool is_regular_file (const Filename &file) const
 Returns true if the indicated file exists within the mount system and is a regular file.
virtual istream * open_read_file (const Filename &file) const
 Opens the file for reading, if it exists.
virtual void output (ostream &out) const
virtual bool scan_directory (vector_string &contents, const Filename &dir) const
 Fills the given vector up with the list of filenames that are local to this directory, if the filename is a directory.

Static Public Member Functions

static TypeHandle get_class_type ()
static void init_type ()
 This function is declared non-inline to work around a compiler bug in g++ 2.96.

Detailed Description

Maps an actual OS directory into the VirtualFileSystem.

Definition at line 27 of file virtualFileMountSystem.h.


Member Function Documentation

off_t VirtualFileMountSystem::get_file_size ( const Filename file,
istream *  stream 
) const [virtual]

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.

Implements VirtualFileMount.

Definition at line 130 of file virtualFileMountSystem.cxx.

off_t VirtualFileMountSystem::get_file_size ( const Filename file) const [virtual]

Returns the current size on disk (or wherever it is) of the file before it has been opened.

Implements VirtualFileMount.

Definition at line 159 of file virtualFileMountSystem.cxx.

const Filename & VirtualFileMountSystem::get_physical_filename ( ) const [inline]

Returns the name of the source file on the OS filesystem of the directory or file that is mounted.

Definition at line 34 of file virtualFileMountSystem.I.

Referenced by VirtualFileSystem::unmount().

time_t VirtualFileMountSystem::get_timestamp ( const Filename file) const [virtual]

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

If the timestamp cannot be determined, either because it is not supported by the operating system or because there is some error (such as file not found), returns 0.

Implements VirtualFileMount.

Definition at line 179 of file virtualFileMountSystem.cxx.

bool VirtualFileMountSystem::has_file ( const Filename file) const [virtual]

Returns true if the indicated file exists within the mount system.

Implements VirtualFileMount.

Definition at line 27 of file virtualFileMountSystem.cxx.

References VirtualFileSystem::get_global_ptr().

Referenced by is_directory(), is_regular_file(), open_read_file(), and scan_directory().

static void VirtualFileMountSystem::init_type ( ) [inline, static]

This function is declared non-inline to work around a compiler bug in g++ 2.96.

Making it inline seems to cause problems in the optimizer.

Reimplemented from VirtualFileMount.

Definition at line 59 of file virtualFileMountSystem.h.

References VirtualFileMount::init_type().

bool VirtualFileMountSystem::is_directory ( const Filename file) const [virtual]

Returns true if the indicated file exists within the mount system and is a directory.

Implements VirtualFileMount.

Definition at line 53 of file virtualFileMountSystem.cxx.

References VirtualFileSystem::get_global_ptr(), and has_file().

bool VirtualFileMountSystem::is_regular_file ( const Filename file) const [virtual]

Returns true if the indicated file exists within the mount system and is a regular file.

Implements VirtualFileMount.

Definition at line 73 of file virtualFileMountSystem.cxx.

References VirtualFileSystem::get_global_ptr(), and has_file().

istream * VirtualFileMountSystem::open_read_file ( const Filename file) const [virtual]

Opens the file for reading, if it exists.

Returns a newly allocated istream on success (which you should eventually delete when you are done reading). Returns NULL on failure.

Implements VirtualFileMount.

Definition at line 95 of file virtualFileMountSystem.cxx.

References VirtualFileMount::close_read_file(), VirtualFileSystem::get_global_ptr(), has_file(), Filename::is_text(), Filename::open_read(), Filename::set_binary(), and Filename::set_text().

bool VirtualFileMountSystem::scan_directory ( vector_string &  contents,
const Filename dir 
) const [virtual]

Fills the given vector up with the list of filenames that are local to this directory, if the filename is a directory.

Returns true if successful, or false if the file is not a directory or cannot be read.

Implements VirtualFileMount.

Definition at line 193 of file virtualFileMountSystem.cxx.

References VirtualFileSystem::get_global_ptr(), and has_file().


The documentation for this class was generated from the following files:
 All Classes Functions Variables Enumerations