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

#include "virtualFile.h"

Inheritance diagram for VirtualFile:

Public Member Functions
virtual bool	atomic_compare_and_exchange_contents (string &orig_contents, const string &old_contents, const string &new_contents)
	See Filename::atomic_compare_and_exchange_contents().
virtual bool	atomic_read_contents (string &contents) const
	See Filename::atomic_read_contents().
virtual void	close_read_file (istream *stream) const
	Closes a file opened by a previous call to open_read_file().
virtual void	close_read_write_file (iostream *stream)
	Closes a file opened by a previous call to open_read_write_file().
virtual void	close_write_file (ostream *stream)
	Closes a file opened by a previous call to open_write_file().
virtual bool	copy_file (VirtualFile *new_file)
	Attempts to copy the contents of this file to the indicated file.
virtual bool	delete_file ()
	Attempts to delete this file or directory.
virtual TypeHandle	force_init_type ()
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 =0
virtual Filename	get_filename () const =0
const Filename &	get_original_filename () const
	Returns the original filename as it was used to locate this VirtualFile.
virtual bool	get_system_info (SubfileInfo &info)
	Populates the SubfileInfo structure with the data representing where the file actually resides on disk, if this is knowable.
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
virtual bool	has_file () const
	Returns true if this file exists, false otherwise.
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.
virtual bool	is_writable () const
	Returns true if this file may be written to, which implies write_file() may be called (unless it is a directory instead of a regular file).
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 ostream *	open_append_file ()
	Works like open_write_file(), but the file is opened in append mode.
virtual iostream *	open_read_append_file ()
	Works like open_read_write_file(), but the file is opened in append mode.
virtual istream *	open_read_file (bool auto_unwrap) const
	Opens the file for reading.
virtual iostream *	open_read_write_file (bool truncate)
	Opens the file for writing.
virtual ostream *	open_write_file (bool auto_wrap, bool truncate)
	Opens the file for writing.
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.
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.
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.
virtual bool	rename_file (VirtualFile *new_file)
	Attempts to move or rename this file or directory.
void	set_original_filename (const Filename &filename)
	Stores the original filename that was used to locate this VirtualFile.
virtual bool	was_read_successful () const
	Call this method after a reading the istream returned by open_read_file() to completion.
bool	write_file (const string &data, bool auto_wrap)
	Writes the entire contents of the file as a string, if it is writable.
virtual bool	write_file (const unsigned char *data, size_t data_size, bool auto_wrap)
	Writes the indicated data to the file, if it is writable.
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
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.
Friends
class	VirtualFileComposite

Detailed Description

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

Definition at line 37 of file virtualFile.h.

Member Function Documentation

bool VirtualFile::atomic_compare_and_exchange_contents	(	string &	orig_contents,
		const string &	old_contents,
		const string &	new_contents
	)		`[virtual]`

See Filename::atomic_compare_and_exchange_contents().

Reimplemented in VirtualFileSimple.

Definition at line 406 of file virtualFile.cxx.

bool VirtualFile::atomic_read_contents ( string & contents ) const [virtual]

See Filename::atomic_read_contents().

Reimplemented in VirtualFileSimple.

Definition at line 418 of file virtualFile.cxx.

void VirtualFile::close_read_file ( istream * stream ) const [virtual]

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.

Reimplemented in VirtualFileSimple.

Definition at line 242 of file virtualFile.cxx.

void VirtualFile::close_read_write_file ( iostream * stream ) [virtual]

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.

Reimplemented in VirtualFileSimple.

Definition at line 337 of file virtualFile.cxx.

void VirtualFile::close_write_file ( ostream * stream ) [virtual]

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.

Reimplemented in VirtualFileSimple.

Definition at line 297 of file virtualFile.cxx.

Referenced by VirtualFileSimple::copy_file().

bool VirtualFile::copy_file ( VirtualFile * new_file ) [virtual]

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

Returns true on success, false on failure.

Reimplemented in VirtualFileSimple.

Definition at line 111 of file virtualFile.cxx.

bool VirtualFile::delete_file ( ) [virtual]

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

Reimplemented in VirtualFileSimple.

Definition at line 77 of file virtualFile.cxx.

Referenced by VirtualFileSimple::copy_file(), and VirtualFileSimple::rename_file().

off_t VirtualFile::get_file_size ( 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.

Reimplemented in VirtualFileSimple.

Definition at line 351 of file virtualFile.cxx.

References get_file_size().

off_t VirtualFile::get_file_size ( ) const [virtual]

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

Reimplemented in VirtualFileSimple.

Definition at line 362 of file virtualFile.cxx.

Referenced by get_file_size().

const Filename & VirtualFile::get_original_filename ( ) const [inline]

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.

bool VirtualFile::get_system_info ( SubfileInfo & info ) [virtual]

Populates the SubfileInfo structure with the data representing where the file actually resides on disk, if this is knowable.

Returns true if the file might reside on disk, and the info is populated, or false if it does not (or it is not known where the file resides), in which case the info is meaningless.

Reimplemented in VirtualFileSimple.

Definition at line 396 of file virtualFile.cxx.

time_t VirtualFile::get_timestamp ( ) 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.

Reimplemented in VirtualFileSimple.

Definition at line 381 of file virtualFile.cxx.

bool VirtualFile::has_file ( ) const [virtual]

Returns true if this file exists, false otherwise.

Reimplemented in VirtualFileSimple, and VirtualFileComposite.

Definition at line 30 of file virtualFile.cxx.

static void VirtualFile::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 TypedReferenceCount.

Reimplemented in VirtualFileSimple, and VirtualFileComposite.

Definition at line 111 of file virtualFile.h.

References TypedReferenceCount::init_type().

Referenced by VirtualFileComposite::init_type(), and VirtualFileSimple::init_type().

bool VirtualFile::is_directory ( ) const [virtual]

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

Reimplemented in VirtualFileSimple, and VirtualFileComposite.

Definition at line 41 of file virtualFile.cxx.

Referenced by VirtualFileComposite::add_component(), ls(), ls_all(), and VirtualFileSimple::rename_file().

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 52 of file virtualFile.cxx.

bool VirtualFile::is_writable ( ) const [virtual]

Returns true if this file may be written to, which implies write_file() may be called (unless it is a directory instead of a regular file).

Reimplemented in VirtualFileSimple.

Definition at line 64 of file virtualFile.cxx.

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

If the file represents a directory, lists its contents.

Definition at line 186 of file virtualFile.cxx.

References Filename::get_basename(), and is_directory().

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 211 of file virtualFile.cxx.

References is_directory().

ostream * VirtualFile::open_append_file ( ) [virtual]

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

Reimplemented in VirtualFileSimple.

Definition at line 283 of file virtualFile.cxx.

Referenced by VirtualFileSystem::open_append_file().

iostream * VirtualFile::open_read_append_file ( ) [virtual]

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

Reimplemented in VirtualFileSimple.

Definition at line 323 of file virtualFile.cxx.

Referenced by VirtualFileSystem::open_read_append_file().

istream * VirtualFile::open_read_file ( bool auto_unwrap ) 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 228 of file virtualFile.cxx.

Referenced by VirtualFileSystem::open_read_file().

iostream * VirtualFile::open_read_write_file ( bool truncate ) [virtual]

Opens the file for writing.

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

Reimplemented in VirtualFileSimple.

Definition at line 310 of file virtualFile.cxx.

Referenced by VirtualFileSystem::open_read_write_file().

ostream * VirtualFile::open_write_file	(	bool	auto_wrap,
		bool	truncate
	)		`[virtual]`

Opens the file for writing.

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

Reimplemented in VirtualFileSimple.

Definition at line 270 of file virtualFile.cxx.

Referenced by VirtualFileSimple::copy_file(), and VirtualFileSystem::open_write_file().

string VirtualFile::read_file ( bool auto_unwrap ) const [inline]

Returns the entire contents of the file as a string.

Definition at line 43 of file virtualFile.I.

Referenced by read_file().

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

Returns true on success, false otherwise.

Definition at line 430 of file virtualFile.cxx.

References read_file().

bool VirtualFile::read_file	(	pvector< unsigned char > &	result,
		bool	auto_unwrap
	)		const `[virtual]`

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 453 of file virtualFile.cxx.

bool VirtualFile::rename_file ( VirtualFile * new_file ) [virtual]

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

Reimplemented in VirtualFileSimple.

Definition at line 99 of file virtualFile.cxx.

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 VirtualFileSimple, and VirtualFileComposite.

Definition at line 528 of file virtualFile.cxx.

void VirtualFile::set_original_filename ( const Filename & filename ) [inline]

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 69 of file virtualFile.I.

bool VirtualFile::simple_read_file	(	istream *	in,
		pvector< unsigned char > &	result
	)		`[static]`

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 477 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]`

As in simple_read_file() with two parameters, above, but only reads up to max_bytes bytes from the file.

Definition at line 500 of file virtualFile.cxx.

bool VirtualFile::was_read_successful ( ) const [virtual]

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 257 of file virtualFile.cxx.

bool VirtualFile::write_file	(	const string &	data,
		bool	auto_wrap
	)		`[inline]`

Writes the entire contents of the file as a string, if it is writable.

Definition at line 56 of file virtualFile.I.

bool VirtualFile::write_file	(	const unsigned char *	data,
		size_t	data_size,
		bool	auto_wrap
	)		`[virtual]`

Writes the indicated data to the file, if it is writable.

Returns true on success, false otherwise.

Reimplemented in VirtualFileSimple.

Definition at line 464 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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Friends

Detailed Description

Member Function Documentation