Panda3D
|
A composite directory within the VirtualFileSystem: this maps to more than one directory on different mount points. More...
#include "virtualFileComposite.h"
Public Member Functions | |
VirtualFileComposite (VirtualFileSystem *file_system, const Filename &filename) | |
void | add_component (VirtualFile *file) |
Adds one more component to the composite directory. | |
TypedObject * | as_typed_object () |
Returns the object, upcast (if necessary) to a TypedObject pointer. | |
const TypedObject * | as_typed_object () const |
Returns the object, upcast (if necessary) to a TypedObject pointer. | |
void | close_read_file (istream *stream) const |
Closes a file opened by a previous call to open_read_file(). | |
virtual TypeHandle | force_init_type () |
int | get_best_parent_from_Set (const std::set< int > &) const |
virtual off_t | get_file_size (istream *stream) const |
Returns the current size on disk (or wherever it is) of the already-open file. | |
virtual off_t | get_file_size () const |
Returns the current size on disk (or wherever it is) of the file before it has been opened. | |
virtual VirtualFileSystem * | get_file_system () const |
Returns the VirtualFileSystem this file is associated with. | |
virtual Filename | get_filename () const |
Returns the full pathname to this file within the virtual file system. | |
const Filename & | get_original_filename () const |
Returns the original filename as it was used to locate this VirtualFile. | |
int | get_ref_count () const |
Returns the current reference count. | |
virtual time_t | get_timestamp () 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 |
int | get_type_index () const |
Returns the internal index number associated with this object's TypeHandle, a unique number for each different type. | |
WeakReferenceList * | get_weak_list () const |
Returns the WeakReferenceList associated with this ReferenceCount object. | |
virtual bool | has_file () const |
Returns true if this file exists, false otherwise. | |
bool | has_weak_list () const |
Returns true if this particular ReferenceCount object has a WeakReferenceList created, false otherwise. | |
virtual bool | is_directory () const |
Returns true if this file represents a directory (and scan_directory() may be called), false otherwise. | |
bool | is_exact_type (TypeHandle handle) const |
Returns true if the current object is the indicated type exactly. | |
bool | is_of_type (TypeHandle handle) const |
Returns true if the current object is or derives from the indicated type. | |
virtual bool | is_regular_file () const |
Returns true if this file represents a regular file (and read_file() may be called), false otherwise. | |
void | local_object () |
This function should be called, once, immediately after creating a new instance of some ReferenceCount-derived object on the stack. | |
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. | |
virtual istream * | open_read_file (bool auto_unwrap) const |
Opens the file for reading. | |
void | operator delete (void *ptr) |
void | operator delete (void *ptr, void *) |
void | operator delete (void *ptr, void *) |
void | operator delete (void *ptr) |
void | operator delete[] (void *ptr) |
void | operator delete[] (void *ptr) |
void | operator delete[] (void *, void *) |
void | operator delete[] (void *, void *) |
void * | operator new (size_t size) |
void * | operator new (size_t size, void *ptr) |
void * | operator new (size_t size, void *ptr) |
void * | operator new (size_t size) |
void * | operator new[] (size_t size, void *ptr) |
void * | operator new[] (size_t size, void *ptr) |
void * | operator new[] (size_t size) |
void * | operator new[] (size_t size) |
void | output (ostream &out) const |
PT (VirtualFileList) scan_directory() const | |
string | read_file (bool auto_unwrap) const |
Returns the entire contents of the file as a string. | |
virtual bool | read_file (pvector< unsigned char > &result, bool auto_unwrap) const |
Fills up the indicated pvector with the contents of the file, if it is a regular file. | |
bool | read_file (string &result, bool auto_unwrap) const |
Fills up the indicated string with the contents of the file, if it is a regular file. | |
void | ref () const |
Explicitly increments the reference count. | |
void | set_original_filename (const Filename &filename) |
Stores the original filename that was used to locate this VirtualFile. | |
bool | test_ref_count_integrity () const |
Does some easy checks to make sure that the reference count isn't completely bogus. | |
bool | test_ref_count_nonzero () const |
Does some easy checks to make sure that the reference count isn't zero, or completely bogus. | |
virtual bool | unref () const |
Explicitly decrements the reference count. | |
virtual bool | was_read_successful () const |
Call this method after a reading the istream returned by open_read_file() to completion. | |
void | weak_ref (WeakPointerToVoid *ptv) |
Adds the indicated PointerToVoid as a weak reference to this object. | |
void | weak_unref (WeakPointerToVoid *ptv) |
Removes the indicated PointerToVoid as a weak reference to this object. | |
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. | |
static bool | simple_read_file (istream *stream, pvector< unsigned char > &result) |
Fills up the indicated pvector with the contents of the just-opened file. | |
static bool | simple_read_file (istream *stream, pvector< unsigned char > &result, size_t max_bytes) |
As in simple_read_file() with two parameters, above, but only reads up to max_bytes bytes from the file. | |
Protected Member Functions | |
bool | do_test_ref_count_integrity () const |
Does some easy checks to make sure that the reference count isn't completely bogus. | |
bool | do_test_ref_count_nonzero () const |
Returns true if the reference count is nonzero, false otherwise. | |
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. |
A composite directory within the VirtualFileSystem: this maps to more than one directory on different mount points.
The resulting directory appears to be the union of all the individual simple directories.
Definition at line 29 of file virtualFileComposite.h.
void VirtualFileComposite::add_component | ( | VirtualFile * | file | ) | [inline] |
Adds one more component to the composite directory.
The component should be a directory and the file system and filename should match the composite.
Definition at line 36 of file virtualFileComposite.I.
References VirtualFile::is_directory().
TypedObject * TypedObject::as_typed_object | ( | ) | [inline, inherited] |
Returns the object, upcast (if necessary) to a TypedObject pointer.
Definition at line 99 of file typedObject.I.
const TypedObject * TypedObject::as_typed_object | ( | ) | const [inline, inherited] |
Returns the object, upcast (if necessary) to a TypedObject pointer.
Definition at line 110 of file typedObject.I.
void VirtualFile::close_read_file | ( | istream * | stream | ) | const [inherited] |
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 226 of file virtualFile.cxx.
bool ReferenceCount::do_test_ref_count_integrity | ( | ) | const [protected, inherited] |
Does some easy checks to make sure that the reference count isn't completely bogus.
Returns true if ok, false otherwise.
Reimplemented in NodeReferenceCount, CachedTypedWritableReferenceCount, and NodeCachedReferenceCount.
Definition at line 29 of file referenceCount.cxx.
Referenced by ReferenceCount::do_test_ref_count_nonzero(), and ReferenceCount::test_ref_count_integrity().
bool ReferenceCount::do_test_ref_count_nonzero | ( | ) | const [protected, inherited] |
Returns true if the reference count is nonzero, false otherwise.
Definition at line 56 of file referenceCount.cxx.
References ReferenceCount::do_test_ref_count_integrity().
Referenced by ReferenceCount::test_ref_count_nonzero().
off_t VirtualFile::get_file_size | ( | istream * | stream | ) | const [virtual, inherited] |
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.
Reimplemented in VirtualFileSimple.
Definition at line 182 of file virtualFile.cxx.
References VirtualFile::get_file_size().
off_t VirtualFile::get_file_size | ( | ) | const [virtual, inherited] |
Returns the current size on disk (or wherever it is) of the file before it has been opened.
Reimplemented in VirtualFileSimple.
Definition at line 193 of file virtualFile.cxx.
Referenced by VirtualFile::get_file_size().
VirtualFileSystem * VirtualFileComposite::get_file_system | ( | ) | const [virtual] |
Returns the VirtualFileSystem this file is associated with.
Implements VirtualFile.
Definition at line 27 of file virtualFileComposite.cxx.
Filename VirtualFileComposite::get_filename | ( | ) | const [virtual] |
Returns the full pathname to this file within the virtual file system.
Implements VirtualFile.
Definition at line 38 of file virtualFileComposite.cxx.
const Filename & VirtualFile::get_original_filename | ( | ) | const [inline, inherited] |
Returns the original filename as it was used to locate this VirtualFile.
This is usually, but not always, the same string returned by get_filename().
Definition at line 33 of file virtualFile.I.
int ReferenceCount::get_ref_count | ( | ) | const [inline, inherited] |
Returns the current reference count.
Definition at line 155 of file referenceCount.I.
References ReferenceCount::test_ref_count_integrity().
Referenced by TransformState::clear_cache(), RenderState::clear_cache(), RenderState::finalize(), RenderEffects::finalize(), RenderEffect::finalize(), RenderAttrib::finalize(), InternalName::finalize(), TransformState::get_num_unused_states(), RenderState::get_num_unused_states(), TransformState::list_cycles(), RenderState::list_cycles(), GeomVertexFormat::remove_column(), TransformState::unref(), RenderState::unref(), RenderState::~RenderState(), and TransformState::~TransformState().
time_t VirtualFile::get_timestamp | ( | ) | const [virtual, inherited] |
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.
Reimplemented in VirtualFileSimple.
Definition at line 212 of file virtualFile.cxx.
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 52 of file typedObject.I.
References TypeHandle::get_index().
WeakReferenceList * ReferenceCount::get_weak_list | ( | ) | const [inline, inherited] |
Returns the WeakReferenceList associated with this ReferenceCount object.
If there has never been a WeakReferenceList associated with this object, creates one now.
Definition at line 307 of file referenceCount.I.
Referenced by ReferenceCount::weak_ref().
bool VirtualFileComposite::has_file | ( | ) | const [virtual] |
Returns true if this file exists, false otherwise.
Reimplemented from VirtualFile.
Definition at line 48 of file virtualFileComposite.cxx.
bool ReferenceCount::has_weak_list | ( | ) | const [inline, inherited] |
Returns true if this particular ReferenceCount object has a WeakReferenceList created, false otherwise.
In general, this will be true if there was ever a WeakPointerTo created for this object (even if there is not any for it now).
Definition at line 294 of file referenceCount.I.
Referenced by ReferenceCount::weak_unref().
static void VirtualFileComposite::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 VirtualFile.
Definition at line 64 of file virtualFileComposite.h.
References VirtualFile::init_type().
bool VirtualFileComposite::is_directory | ( | ) | const [virtual] |
Returns true if this file represents a directory (and scan_directory() may be called), false otherwise.
Reimplemented from VirtualFile.
Definition at line 59 of file virtualFileComposite.cxx.
bool TypedObject::is_exact_type | ( | TypeHandle | handle | ) | const [inline, inherited] |
Returns true if the current object is the indicated type exactly.
Definition at line 74 of file typedObject.I.
References TypeHandle::get_name().
Referenced by GraphicsStateGuardian::async_reload_texture(), PortalNode::combine_with(), PandaNode::combine_with(), GeomNode::combine_with(), CollisionNode::combine_with(), Character::combine_with(), PGItem::cull_callback(), FactoryParams::get_param_of_type(), CollisionHandlerPusher::handle_entries(), SceneGraphReducer::r_flatten(), ConnectionWriter::send(), FltToEggLevelState::set_transform(), and VirtualFileSystem::unmount().
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 63 of file typedObject.I.
References TypeHandle::is_derived_from().
Referenced by EggSliderData::add_back_pointer(), EggJointData::add_back_pointer(), CIntervalManager::add_c_interval(), XFileNode::add_child(), CollisionTraverser::add_collider(), CollisionHandlerPhysical::add_collider(), EggXfmSAnim::add_data(), CharacterJointBundle::add_node(), NonlinearImager::add_screen(), EggGroupNode::apply_first_attribute(), EggGroupNode::apply_last_attribute(), DeferredNodeProperty::apply_to_node(), RecorderController::begin_playback(), NodePath::clear_clip_plane(), EggGroupNode::clear_connected_shading(), NodePath::clear_light(), EggBase::convert_paths(), NodePath::decode_from_bam_stream(), VrpnClient::disconnect_device(), PhysicsManager::do_physics(), GraphicsStateGuardian::fetch_specified_part(), EggRenderState::fill_state(), AnimBundleNode::find_anim_bundle(), EggGroupNode::find_coordsys_entry(), XFile::find_data_object(), Character::find_joint(), EggGroupNode::find_materials(), Character::find_slider(), XFile::find_template(), EggGroupNode::find_textures(), EggMaterialCollection::find_used_materials(), EggTextureCollection::find_used_textures(), EggGroupNode::force_filenames(), EggJointData::force_initial_rest_frame(), WindowFramework::get_aspect_2d(), EggPoolUniquifier::get_category(), EggGroupUniquifier::get_category(), EggGroupNode::get_connected_shading(), PandaFramework::get_mouse(), FactoryParams::get_param_of_type(), EggGroupNode::has_absolute_pathnames(), NodePath::has_clip_plane(), NodePath::has_clip_plane_off(), NodePath::has_light(), PandaFramework::hide_collision_solids(), x11GraphicsWindow::open_window(), eglGraphicsWindow::open_window(), EggNode::parse_egg(), CharacterMaker::part_to_node(), EggGroupNode::post_apply_flat_attribute(), EggBinner::prepare_node(), PortalClipper::prepare_portal(), NodePath::project_texture(), EggMatrixTablePointer::quantize_channels(), ParametricCurveCollection::r_add_curves(), SceneGraphReducer::r_collect_vertex_data(), EggGroupNode::r_load_externals(), EggGroupNode::rebuild_vertex_pools(), EggGroupNode::recompute_polygon_normals(), EggGroupNode::remove_invalid_primitives(), EggGroupNode::remove_unused_vertices(), EggLoader::reparent_decals(), EggMaterialCollection::replace_materials(), EggTextureCollection::replace_textures(), EggGroupNode::resolve_filenames(), EggGroupNode::reverse_vertex_ordering(), NodePath::set_clip_plane(), NodePath::set_clip_plane_off(), NodePath::set_light(), ProjectionScreen::set_projector(), NonlinearImager::set_source_camera(), EggXfmSAnim::set_value(), NonlinearImager::set_viewer_camera(), PandaFramework::show_collision_solids(), BamCache::store(), XFileToEggConverter::strip_nodes(), EggGroupNode::strip_normals(), DataGraphTraverser::traverse(), DataGraphTraverser::traverse_below(), EggGroupNode::triangulate_polygons(), EggGroupNode::unify_attributes(), EggNameUniquifier::uniquify(), NodeCullCallbackData::upcall(), PhysicsCollisionHandler::validate_target(), EggXfmSAnim::write(), EggGroup::write(), EggToDXFLayer::write_3d_face(), and EggToDXFLayer::write_entities().
bool VirtualFile::is_regular_file | ( | ) | const [virtual, inherited] |
Returns true if this file represents a regular file (and read_file() may be called), false otherwise.
Reimplemented in VirtualFileSimple.
Definition at line 51 of file virtualFile.cxx.
void ReferenceCount::local_object | ( | ) | [inline, inherited] |
This function should be called, once, immediately after creating a new instance of some ReferenceCount-derived object on the stack.
This allows the object to be passed to functions that will increment and decrement the object's reference count temporarily, and it will prevent the object from being deleted (inappropriately), when the reference count returns to zero. It actually achieves this by setting a large positive value in the reference count field.
Definition at line 276 of file referenceCount.I.
Referenced by PGTop::cull_callback(), BoundingSphere::extend_by_hexahedron(), AsyncTaskManager::find_task(), AsyncTaskManager::find_tasks(), and AsyncTaskManager::find_tasks_matching().
void VirtualFile::ls | ( | ostream & | out = cout | ) | const [inherited] |
If the file represents a directory, lists its contents.
Definition at line 126 of file virtualFile.cxx.
References Filename::get_basename(), and VirtualFile::is_directory().
void VirtualFile::ls_all | ( | ostream & | out = cout | ) | const [inherited] |
If the file represents a directory, recursively lists its contents and those of all subdirectories.
Definition at line 151 of file virtualFile.cxx.
References VirtualFile::is_directory().
istream * VirtualFile::open_read_file | ( | bool | auto_unwrap | ) | const [virtual, inherited] |
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 168 of file virtualFile.cxx.
Referenced by VirtualFileSystem::open_read_file().
string VirtualFile::read_file | ( | bool | auto_unwrap | ) | const [inline, inherited] |
Returns the entire contents of the file as a string.
Definition at line 43 of file virtualFile.I.
Referenced by VirtualFile::read_file().
bool VirtualFile::read_file | ( | string & | result, |
bool | auto_unwrap | ||
) | const [inherited] |
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 264 of file virtualFile.cxx.
References VirtualFile::read_file().
bool VirtualFile::read_file | ( | pvector< unsigned char > & | result, |
bool | auto_unwrap | ||
) | const [virtual, inherited] |
Fills up the indicated pvector with the contents of the file, if it is a regular file.
Returns true on success, false otherwise.
Reimplemented in VirtualFileSimple.
Definition at line 287 of file virtualFile.cxx.
void 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.
Definition at line 179 of file referenceCount.I.
References ReferenceCount::test_ref_count_integrity().
Referenced by CachedTypedWritableReferenceCount::cache_ref(), TypedWritable::decode_raw_from_bam_stream(), NodeCachedReferenceCount::node_ref(), NodeReferenceCount::node_ref(), BamCacheRecord::set_data(), CullableObject::set_draw_callback(), and ModelRoot::set_reference().
bool VirtualFileComposite::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 from VirtualFile.
Definition at line 73 of file virtualFileComposite.cxx.
void VirtualFile::set_original_filename | ( | const Filename & | filename | ) | [inline, inherited] |
Stores the original filename that was used to locate this VirtualFile.
This is normally called only by the VirtualFileSystem, as it creates each VirtualFile.
Definition at line 58 of file virtualFile.I.
bool VirtualFile::simple_read_file | ( | istream * | in, |
pvector< unsigned char > & | result | ||
) | [static, inherited] |
Fills up the indicated pvector with the contents of the just-opened file.
Returns true on success, false otherwise. If the pvector was not empty on entry, the data read from the file will be appended onto it.
Definition at line 300 of file virtualFile.cxx.
Referenced by VirtualFileMount::read_file(), and Multifile::read_subfile().
bool VirtualFile::simple_read_file | ( | istream * | stream, |
pvector< unsigned char > & | result, | ||
size_t | max_bytes | ||
) | [static, inherited] |
As in simple_read_file() with two parameters, above, but only reads up to max_bytes bytes from the file.
Definition at line 323 of file virtualFile.cxx.
bool ReferenceCount::test_ref_count_integrity | ( | ) | const [inline, inherited] |
Does some easy checks to make sure that the reference count isn't completely bogus.
Returns true if ok, false otherwise.
Reimplemented in NodeReferenceCount, CachedTypedWritableReferenceCount, and NodeCachedReferenceCount.
Definition at line 236 of file referenceCount.I.
References ReferenceCount::do_test_ref_count_integrity().
Referenced by EggGroupNode::add_child(), InternalName::find_ancestor(), InternalName::get_ancestor(), ReferenceCount::get_ref_count(), InternalName::get_top(), ReferenceCount::ref(), EggVertex::test_gref_integrity(), EggVertex::test_pref_integrity(), EggNode::test_under_integrity(), EggPrimitive::test_vref_integrity(), EggGroup::test_vref_integrity(), MouseWatcher::throw_event_pattern(), ReferenceCount::unref(), and EggNode::update_under().
bool ReferenceCount::test_ref_count_nonzero | ( | ) | const [inline, inherited] |
Does some easy checks to make sure that the reference count isn't zero, or completely bogus.
Returns true if ok, false otherwise.
Definition at line 252 of file referenceCount.I.
References ReferenceCount::do_test_ref_count_nonzero().
Referenced by CopyOnWritePointer::test_ref_count_nonzero().
bool ReferenceCount::unref | ( | ) | const [inline, virtual, 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.) 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 true if the new reference count is nonzero, false if it is zero.
Reimplemented in GeomVertexArrayFormat, GeomVertexFormat, InternalName, RenderAttrib, RenderEffects, RenderState, and TransformState.
Definition at line 214 of file referenceCount.I.
References ReferenceCount::test_ref_count_integrity().
Referenced by CachedTypedWritableReferenceCount::cache_unref(), TypedWritable::decode_raw_from_bam_stream(), RenderEffect::finalize(), NodeCachedReferenceCount::node_unref(), NodeReferenceCount::node_unref(), TransformState::unref(), RenderState::unref(), RenderEffects::unref(), RenderAttrib::unref(), InternalName::unref(), GeomVertexFormat::unref(), and GeomVertexArrayFormat::unref().
bool VirtualFile::was_read_successful | ( | ) | const [virtual, inherited] |
Call this method after a reading the istream returned by open_read_file() to completion.
If it returns true, the file was read completely and without error; if it returns false, there may have been some errors or a truncated file read. This is particularly likely if the stream is a VirtualFileHTTP.
Definition at line 252 of file virtualFile.cxx.
void ReferenceCount::weak_ref | ( | WeakPointerToVoid * | ptv | ) | [inline, inherited] |
Adds the indicated PointerToVoid as a weak reference to this object.
Definition at line 321 of file referenceCount.I.
References WeakReferenceList::add_reference(), and ReferenceCount::get_weak_list().
void ReferenceCount::weak_unref | ( | WeakPointerToVoid * | ptv | ) | [inline, inherited] |
Removes the indicated PointerToVoid as a weak reference to this object.
It must have previously been added via a call to weak_ref().
Definition at line 334 of file referenceCount.I.
References WeakReferenceList::clear_reference(), and ReferenceCount::has_weak_list().