Main Page Class Hierarchy Alphabetical List Compound List File List Compound Members File Members

VirtualFile Class Reference

The abstract base class for a file or directory within the VirtualFileSystem. More...

#include <virtualFile.h>

Inheritance diagram for VirtualFile:


Public Member Functions
	VirtualFile ()
virtual VirtualFileSystem *	get_file_system () const=0
virtual Filename	get_filename () const=0
virtual bool	is_directory () const
	Returns true if this file represents a directory (and scan_directory() may be called), false otherwise.
virtual bool	is_regular_file () const
	Returns true if this file represents a regular file (and read_file() may be called), false otherwise.
PointerTo< VirtualFileList >	scan_directory () const
	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.
void	output (ostream &out) const
void	ls (ostream &out=cout) const
	If the file represents a directory, lists its contents.
void	ls_all (ostream &out=cout) const
	If the file represents a directory, recursively lists its contents and those of all subdirectories.
string	read_file () const
	Returns the entire contents of the file as a string.
virtual istream *	open_read_file () const
	Opens the file for reading.
bool	read_file (string &result) const
	Fills up the indicated string with the contents of the file, if it is a regular file.
virtual TypeHandle	get_type () const
virtual TypeHandle	force_init_type ()
int	get_type_index () const
	Returns the internal index number associated with this object's TypeHandle, a unique number for each different type.
bool	is_of_type (TypeHandle handle) const
	Returns true if the current object is or derives from the indicated type.
bool	is_exact_type (TypeHandle handle) const
	Returns true if the current object is the indicated type exactly.
int	get_ref_count () const
	Returns the current reference count.
int	ref () const
	Explicitly increments the reference count.
int	unref () const
	Explicitly decrements the reference count.
void	test_ref_count_integrity () const
	Does some easy checks to make sure that the reference count isn't completely bogus.
Static Public Member Functions
TypeHandle	get_class_type ()
void	init_type ()
Protected Member Functions
virtual bool	scan_local_directory (VirtualFileList *file_list, const ov_set< string > &mount_points) const
	Fills file_list up with the list of files that are within this directory, excluding those whose basenames are listed in mount_points.
Private Member Functions
void	r_ls_all (ostream &out, const Filename &root) const
	The recursive implementation of ls_all().
Static Private Attributes
TypeHandle	_type_handle
Friends
class	VirtualFileComposite

Detailed Description

The abstract base class for a file or directory within the VirtualFileSystem.

Definition at line 45 of file virtualFile.h.

Constructor & Destructor Documentation

VirtualFile::VirtualFile ( ) [inline]

Definition at line 32 of file virtualFile.I.
References INLINE, and read_file().

Member Function Documentation

virtual TypeHandle VirtualFile::force_init_type ( void ) [inline, virtual]

Reimplemented from TypedReferenceCount.
Reimplemented in VirtualFileComposite, and VirtualFileSimple.
Definition at line 81 of file virtualFile.h.

TypeHandle VirtualFile::get_class_type ( void ) [inline, static]

Reimplemented from TypedReferenceCount.
Reimplemented in VirtualFileComposite, and VirtualFileSimple.
Definition at line 82 of file virtualFile.h.

virtual VirtualFileSystem* VirtualFile::get_file_system ( ) const [pure virtual]

Implemented in VirtualFileComposite, and VirtualFileSimple.
Referenced by is_regular_file(), and VirtualFileComposite::VirtualFileComposite().

virtual Filename VirtualFile::get_filename ( ) const [pure virtual]

Implemented in VirtualFileComposite, and VirtualFileSimple.
Referenced by is_regular_file(), ls(), ls_all(), read_file(), and VirtualFileComposite::VirtualFileComposite().

int ReferenceCount::get_ref_count ( ) const [inline, inherited]

Returns the current reference count.

Definition at line 183 of file referenceCount.I.
Referenced by RenderState::determine_bin_index(), RenderEffects::determine_show_bounds(), FontPool::ns_garbage_collect(), TexturePool::ns_garbage_collect(), MaterialPool::ns_get_material(), and TexturePool::ns_release_texture().

virtual TypeHandle VirtualFile::get_type ( void ) const [inline, virtual]

Reimplemented from TypedReferenceCount.
Reimplemented in VirtualFileComposite, and VirtualFileSimple.
Definition at line 78 of file virtualFile.h.
References TypedReferenceCount::init_type(), and register_type().

int TypedObject::get_type_index ( ) const [inline, inherited]

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().
Definition at line 71 of file typedObject.I.
References TypeHandle::get_name(), TypedObject::get_type(), and INLINE.

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

Reimplemented from TypedReferenceCount.
Reimplemented in VirtualFileComposite, and VirtualFileSimple.
Definition at line 85 of file virtualFile.h.

bool VirtualFile::is_directory ( ) const [virtual]

Returns true if this file represents a directory (and scan_directory() may be called), false otherwise.

Reimplemented in VirtualFileComposite, and VirtualFileSimple.
Definition at line 40 of file virtualFile.cxx.
Referenced by ls(), read_file(), and VirtualFileComposite::VirtualFileComposite().

bool TypedObject::is_exact_type ( TypeHandle handle ) const [inline, inherited]

Returns true if the current object is the indicated type exactly.

Definition at line 101 of file typedObject.I.
Referenced by PT(), and CollisionNode::xform().

bool TypedObject::is_of_type ( TypeHandle handle ) const [inline, inherited]

Returns true if the current object is or derives from the indicated type.

Definition at line 86 of file typedObject.I.
Referenced by EggMaterialCollection::collapse_equivalent_materials(), EggTextureCollection::collapse_equivalent_textures(), DeferredNodeProperty::compose(), AnimBundleMaker::create_s_channel(), CharacterMaker::create_slider(), ProjectionScreen::cull_callback(), DataNode::define_output(), EggNode::determine_draw_order(), CharacterMaker::egg_to_index(), EggGroupUniquifier::EggGroupUniquifier(), EggPoolUniquifier::EggPoolUniquifier(), EggGroupNode::find_textures(), StaticTextFont::get_glyph(), EggMaterialCollection::insert_materials(), EggTextureCollection::insert_textures(), CharacterJoint::make_copy(), PT(), EggGroupNode::r_flatten_transforms(), EggGroupNode::r_transform_vertices(), EggGroupNode::recompute_polygon_normals(), CollisionLevelState::reserve(), PandaFramework::reset_frame_rate(), PandaFramework::set_texture(), EggGroupNode::steal_children(), and DataGraphTraverser::traverse().

bool VirtualFile::is_regular_file ( ) const [virtual]

Returns true if this file represents a regular file (and read_file() may be called), false otherwise.

Reimplemented in VirtualFileSimple.
Definition at line 55 of file virtualFile.cxx.
References get_file_system(), get_filename(), PT, VirtualFileSystem::scan_mount_points(), and ov_set< Key, Compare >::sort().

void VirtualFile::ls ( ostream & out = cout ) const

If the file represents a directory, lists its contents.

Definition at line 144 of file virtualFile.cxx.
References get_filename(), is_directory(), and r_ls_all().

void VirtualFile::ls_all ( ostream & out = cout ) const

If the file represents a directory, recursively lists its contents and those of all subdirectories.

Definition at line 173 of file virtualFile.cxx.
References get_filename(), NULL, and open_read_file().

istream * VirtualFile::open_read_file ( ) const [virtual]

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.
Reimplemented in VirtualFileSimple.
Definition at line 196 of file virtualFile.cxx.
Referenced by ls_all().

void VirtualFile::output ( ostream & out ) const

Definition at line 129 of file virtualFile.cxx.

void VirtualFile::r_ls_all ( ostream & out,

const Filename & root

) const [private]

The recursive implementation of ls_all().

Definition at line 267 of file virtualFile.cxx.
Referenced by ls(), and read_file().

bool VirtualFile::read_file ( string & result ) const

Fills up the indicated string with the contents of the file, if it is a regular file.
Returns true on success, false otherwise.
Definition at line 213 of file virtualFile.cxx.
References CPT, get_filename(), is_directory(), Filename::make_relative_to(), NULL, r_ls_all(), root, and scan_directory().

string VirtualFile::read_file ( ) const [inline]

Returns the entire contents of the file as a string.

Definition at line 44 of file virtualFile.I.
Referenced by VirtualFile().

int ReferenceCount::ref ( ) const [inline, inherited]

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.
This function is const, even though it changes the object, because generally fiddling with an object's reference count isn't considered part of fiddling with the object. An object might be const in other ways, but we still need to accurately count the number of references to it.
The return value is the new reference count.
Definition at line 225 of file referenceCount.I.
Referenced by ClientDevice::ClientDevice(), EggGroupNode::find_textures(), EggGroupNode::r_apply_texmats(), EggGroupNode::r_flatten_transforms(), and EggGroupNode::reverse_vertex_ordering().

PointerTo< VirtualFileList > VirtualFile::scan_directory ( ) const

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.
Definition at line 76 of file virtualFile.cxx.
Referenced by read_file().

bool VirtualFile::scan_local_directory ( VirtualFileList * file_list,

const ov_set< string > & mount_points

) const [protected, virtual]

Fills file_list up with the list of files that are within this directory, excluding those whose basenames are listed in mount_points.
Returns true if successful, false if the file is not a directory or the directory cannot be read.
Reimplemented in VirtualFileComposite, and VirtualFileSimple.
Definition at line 254 of file virtualFile.cxx.

void ReferenceCount::test_ref_count_integrity ( ) const [inline, inherited]

Does some easy checks to make sure that the reference count isn't completely bogus.

Definition at line 328 of file referenceCount.I.
References INLINE.
Referenced by EggNode::determine_bin(), and ReferenceCount::~ReferenceCount().

int ReferenceCount::unref ( ) const [inline, inherited]

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; plus, we don't have a virtual destructor anyway.) However, see the helper function unref_delete().
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.
This function is const, even though it changes the object, because generally fiddling with an object's reference count isn't considered part of fiddling with the object. An object might be const in other ways, but we still need to accurately count the number of references to it.
The return value is the new reference count.
Definition at line 293 of file referenceCount.I.
References INLINE.
Referenced by RenderState::determine_bin_index(), and RenderEffects::determine_show_bounds().

Friends And Related Function Documentation

friend class VirtualFileComposite [friend]

Definition at line 94 of file virtualFile.h.

Member Data Documentation

TypeHandle VirtualFile::_type_handle [static, private]

Reimplemented from TypedReferenceCount.
Reimplemented in VirtualFileComposite, and VirtualFileSimple.
Definition at line 27 of file virtualFile.cxx.

The documentation for this class was generated from the following files:

panda/src/express/virtualFile.h
panda/src/express/virtualFile.cxx
panda/src/express/virtualFile.I

Generated on Fri May 2 00:56:04 2003 for Panda by

1.3

VirtualFile Class Reference

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Static Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation