#include <WWFILE.H>

Inherited by GameFileClass, RAMFileClass, RawFileClass, RawFileClass, and ResourceFileClass.

Public Types
enum	{ READ = 1 , WRITE = 2 , PRINTF_BUFFER_SIZE = 1024 }

enum	{ READ = 1 , WRITE = 2 , PRINTF_BUFFER_SIZE = 1024 }

Public Member Functions
virtual	~FileClass (void)

virtual char const *	File_Name (void) const =0

virtual char const *	Set_Name (char const *filename)=0

virtual int	Create (void)=0

virtual int	Delete (void)=0

virtual bool	Is_Available (int forced=false)=0

virtual bool	Is_Open (void) const =0

virtual int	Open (char const *filename, int rights=READ)=0

virtual int	Open (int rights=READ)=0

virtual int	Read (void *buffer, int size)=0

virtual int	Seek (int pos, int dir=SEEK_CUR)=0

virtual int	Tell (void)

virtual int	Size (void)=0

virtual int	Write (void const *buffer, int size)=0

virtual void	Close (void)=0

virtual unsigned long	Get_Date_Time (void)

virtual bool	Set_Date_Time (unsigned long)

virtual void *	Get_File_Handle (void)

	operator char const * ()

int	Printf (char *str,...)

int	Printf (char buffer, int bufferSize, char str,...)

int	Printf_Indented (unsigned depth, char *str,...)

virtual	~FileClass (void)

virtual char const *	File_Name (void) const =0

virtual char const *	Set_Name (char const *filename)=0

virtual int	Create (void)=0

virtual int	Delete (void)=0

virtual bool	Is_Available (int forced=false)=0

virtual bool	Is_Open (void) const =0

virtual int	Open (char const *filename, int rights=READ)=0

virtual int	Open (int rights=READ)=0

virtual int	Read (void *buffer, int size)=0

virtual int	Seek (int pos, int dir=SEEK_CUR)=0

virtual int	Tell (void)

virtual int	Size (void)=0

virtual int	Write (void const *buffer, int size)=0

virtual void	Close (void)=0

virtual unsigned long	Get_Date_Time (void)

virtual bool	Set_Date_Time (unsigned long)

virtual void	Error (int error, int canretry=false, char const *filename=NULL)=0

virtual void *	Get_File_Handle (void)

	operator char const * ()

int	Printf (char *str,...)

int	Printf (char buffer, int bufferSize, char str,...)

int	Printf_Indented (unsigned depth, char *str,...)

Detailed Description

Definition at line 65 of file WWFILE.H.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Enumerator
READ
WRITE
PRINTF_BUFFER_SIZE

Definition at line 69 of file wwfile.h.

◆ anonymous enum

anonymous enum

Enumerator
READ
WRITE
PRINTF_BUFFER_SIZE

Definition at line 69 of file WWFILE.H.

Constructor & Destructor Documentation

◆ ~FileClass() [1/2]

virtual FileClass::~FileClass ( void )

inlinevirtual

Definition at line 76 of file WWFILE.H.

◆ ~FileClass() [2/2]

virtual FileClass::~FileClass ( void )

inlinevirtual

Definition at line 76 of file wwfile.h.

Member Function Documentation

◆ Close() [1/2]

virtual void FileClass::Close ( void )

pure virtual

Implemented in BufferedFileClass, BufferIOFileClass, GameFileClass, RAMFileClass, RawFileClass, RawFileClass, and ResourceFileClass.

◆ Close() [2/2]

virtual void FileClass::Close ( void )

pure virtual

Implemented in BufferedFileClass, BufferIOFileClass, GameFileClass, RAMFileClass, RawFileClass, RawFileClass, and ResourceFileClass.

◆ Create() [1/2]

virtual int FileClass::Create ( void )

pure virtual

Implemented in GameFileClass, RAMFileClass, RawFileClass, RawFileClass, and ResourceFileClass.

◆ Create() [2/2]

virtual int FileClass::Create ( void )

pure virtual

Implemented in GameFileClass, RAMFileClass, RawFileClass, RawFileClass, and ResourceFileClass.

◆ Delete() [1/2]

virtual int FileClass::Delete ( void )

pure virtual

Implemented in GameFileClass, RAMFileClass, RawFileClass, RawFileClass, and ResourceFileClass.

◆ Delete() [2/2]

virtual int FileClass::Delete ( void )

pure virtual

Implemented in GameFileClass, RAMFileClass, RawFileClass, RawFileClass, and ResourceFileClass.

◆ Error()

virtual void FileClass::Error	(	int	error,
		int	canretry = false,
		char const *	filename = NULL )

pure virtual

Implemented in RAMFileClass, RawFileClass, RawFileClass, and ResourceFileClass.

◆ File_Name() [1/2]

virtual char const * FileClass::File_Name ( void ) const

pure virtual

Implemented in GameFileClass, RAMFileClass, RawFileClass, RawFileClass, and ResourceFileClass.

◆ File_Name() [2/2]

virtual char const * FileClass::File_Name ( void ) const

pure virtual

Implemented in GameFileClass, RAMFileClass, RawFileClass, RawFileClass, and ResourceFileClass.

◆ Get_Date_Time() [1/2]

virtual unsigned long FileClass::Get_Date_Time ( void )

inlinevirtual

Reimplemented in RAMFileClass, RawFileClass, RawFileClass, and TagBlockFile.

Definition at line 91 of file WWFILE.H.

◆ Get_Date_Time() [2/2]

virtual unsigned long FileClass::Get_Date_Time ( void )

inlinevirtual

Reimplemented in RAMFileClass, RawFileClass, RawFileClass, and TagBlockFile.

Definition at line 91 of file wwfile.h.

◆ Get_File_Handle() [1/2]

virtual void * FileClass::Get_File_Handle ( void )

inlinevirtual

Reimplemented in RawFileClass, and RawFileClass.

Definition at line 94 of file WWFILE.H.

◆ Get_File_Handle() [2/2]

virtual void * FileClass::Get_File_Handle ( void )

inlinevirtual

Reimplemented in RawFileClass, and RawFileClass.

Definition at line 94 of file wwfile.h.

◆ Is_Available() [1/2]

virtual bool FileClass::Is_Available ( int forced = false )

pure virtual

Implemented in BufferIOFileClass, GameFileClass, RAMFileClass, RawFileClass, RawFileClass, and ResourceFileClass.

◆ Is_Available() [2/2]

virtual bool FileClass::Is_Available ( int forced = false )

pure virtual

Implemented in BufferIOFileClass, GameFileClass, RAMFileClass, RawFileClass, RawFileClass, and ResourceFileClass.

◆ Is_Open() [1/2]

virtual bool FileClass::Is_Open ( void ) const

pure virtual

Implemented in BufferIOFileClass, GameFileClass, RAMFileClass, RawFileClass, RawFileClass, and ResourceFileClass.

◆ Is_Open() [2/2]

virtual bool FileClass::Is_Open ( void ) const

pure virtual

Implemented in BufferIOFileClass, GameFileClass, RAMFileClass, RawFileClass, RawFileClass, and ResourceFileClass.

◆ Open() [1/4]

virtual int FileClass::Open	(	char const *	filename,
		int	rights = READ )

pure virtual

Implemented in BufferIOFileClass, GameFileClass, RAMFileClass, RawFileClass, RawFileClass, and ResourceFileClass.

◆ Open() [2/4]

virtual int FileClass::Open	(	char const *	filename,
		int	rights = READ )

pure virtual

Implemented in BufferIOFileClass, GameFileClass, RAMFileClass, RawFileClass, RawFileClass, and ResourceFileClass.

◆ Open() [3/4]

virtual int FileClass::Open ( int rights = READ )

pure virtual

Implemented in BufferIOFileClass, GameFileClass, RAMFileClass, RawFileClass, RawFileClass, and ResourceFileClass.

◆ Open() [4/4]

virtual int FileClass::Open ( int rights = READ )

pure virtual

Implemented in BufferIOFileClass, GameFileClass, RAMFileClass, RawFileClass, RawFileClass, and ResourceFileClass.

◆ operator char const *() [1/2]

FileClass::operator char const * ( )

inline

Definition at line 97 of file WWFILE.H.

◆ operator char const *() [2/2]

FileClass::operator char const * ( )

inline

Definition at line 96 of file wwfile.h.

◆ Printf() [1/4]

int FileClass::Printf	(	char *	buffer,
		int	bufferSize,
		char *	str,
			... )

Definition at line 54 of file wwfile.cpp.

◆ Printf() [2/4]

int FileClass::Printf	(	char *	buffer,
		int	bufferSize,
		char *	str,
			... )

◆ Printf() [3/4]

int FileClass::Printf	(	char *	str,
			... )

Definition at line 44 of file wwfile.cpp.

◆ Printf() [4/4]

int FileClass::Printf	(	char *	str,
			... )

◆ Printf_Indented() [1/2]

int FileClass::Printf_Indented	(	unsigned	depth,
		char *	str,
			... )

Definition at line 63 of file wwfile.cpp.

◆ Printf_Indented() [2/2]

int FileClass::Printf_Indented	(	unsigned	depth,
		char *	str,
			... )

◆ Read() [1/2]

virtual int FileClass::Read	(	void *	buffer,
		int	size )

pure virtual

Implemented in BufferedFileClass, BufferIOFileClass, GameFileClass, RAMFileClass, RawFileClass, RawFileClass, and ResourceFileClass.

◆ Read() [2/2]

virtual int FileClass::Read	(	void *	buffer,
		int	size )

pure virtual

Implemented in BufferedFileClass, BufferIOFileClass, GameFileClass, RAMFileClass, RawFileClass, RawFileClass, and ResourceFileClass.

◆ Seek() [1/2]

virtual int FileClass::Seek	(	int	pos,
		int	dir = SEEK_CUR )

pure virtual

Implemented in BufferedFileClass, BufferIOFileClass, GameFileClass, RAMFileClass, RawFileClass, RawFileClass, and ResourceFileClass.

◆ Seek() [2/2]

virtual int FileClass::Seek	(	int	pos,
		int	dir = SEEK_CUR )

pure virtual

Implemented in BufferedFileClass, BufferIOFileClass, GameFileClass, RAMFileClass, RawFileClass, RawFileClass, and ResourceFileClass.

◆ Set_Date_Time() [1/2]

virtual bool FileClass::Set_Date_Time ( unsigned long )

inlinevirtual

Reimplemented in RAMFileClass, RawFileClass, and RawFileClass.

Definition at line 92 of file WWFILE.H.

◆ Set_Date_Time() [2/2]

virtual bool FileClass::Set_Date_Time ( unsigned long )

inlinevirtual

Reimplemented in RAMFileClass, RawFileClass, and RawFileClass.

Definition at line 92 of file wwfile.h.

◆ Set_Name() [1/2]

virtual char const * FileClass::Set_Name ( char const * filename )

pure virtual

Implemented in BufferIOFileClass, GameFileClass, RAMFileClass, RawFileClass, RawFileClass, ResourceFileClass, and WBGameFileClass.

◆ Set_Name() [2/2]

virtual char const * FileClass::Set_Name ( char const * filename )

pure virtual

Implemented in BufferIOFileClass, GameFileClass, RAMFileClass, RawFileClass, RawFileClass, ResourceFileClass, and WBGameFileClass.

◆ Size() [1/2]

virtual int FileClass::Size ( void )

pure virtual

Implemented in BufferIOFileClass, GameFileClass, RAMFileClass, RawFileClass, RawFileClass, and ResourceFileClass.

◆ Size() [2/2]

virtual int FileClass::Size ( void )

pure virtual

Implemented in BufferIOFileClass, GameFileClass, RAMFileClass, RawFileClass, RawFileClass, and ResourceFileClass.

◆ Tell() [1/2]

virtual int FileClass::Tell ( void )

inlinevirtual

Definition at line 87 of file WWFILE.H.

◆ Tell() [2/2]

virtual int FileClass::Tell ( void )

inlinevirtual

Definition at line 87 of file wwfile.h.

◆ Write() [1/2]

virtual int FileClass::Write	(	void const *	buffer,
		int	size )

pure virtual

Implemented in BufferedFileClass, BufferIOFileClass, GameFileClass, RAMFileClass, RawFileClass, RawFileClass, and ResourceFileClass.

◆ Write() [2/2]

virtual int FileClass::Write	(	void const *	buffer,
		int	size )

pure virtual

Implemented in BufferedFileClass, BufferIOFileClass, GameFileClass, RAMFileClass, RawFileClass, RawFileClass, and ResourceFileClass.

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

Code/Libraries/Source/WWVegas/WWLib/WWFILE.H
Code/Tools/WW3D/pluglib/wwfile.h
Code/Libraries/Source/WWVegas/WWLib/wwfile.cpp

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

◆ anonymous enum

◆ anonymous enum

Constructor & Destructor Documentation

◆ ~FileClass() [1/2]

◆ ~FileClass() [2/2]

Member Function Documentation

◆ Close() [1/2]

◆ Close() [2/2]

◆ Create() [1/2]

◆ Create() [2/2]

◆ Delete() [1/2]

◆ Delete() [2/2]

◆ Error()

◆ File_Name() [1/2]

◆ File_Name() [2/2]

◆ Get_Date_Time() [1/2]

◆ Get_Date_Time() [2/2]

◆ Get_File_Handle() [1/2]

◆ Get_File_Handle() [2/2]

◆ Is_Available() [1/2]

◆ Is_Available() [2/2]

◆ Is_Open() [1/2]

◆ Is_Open() [2/2]

◆ Open() [1/4]

◆ Open() [2/4]

◆ Open() [3/4]

◆ Open() [4/4]

◆ operator char const *() [1/2]

◆ operator char const *() [2/2]

◆ Printf() [1/4]

◆ Printf() [2/4]

◆ Printf() [3/4]

◆ Printf() [4/4]

◆ Printf_Indented() [1/2]

◆ Printf_Indented() [2/2]

◆ Read() [1/2]

◆ Read() [2/2]

◆ Seek() [1/2]

◆ Seek() [2/2]

◆ Set_Date_Time() [1/2]

◆ Set_Date_Time() [2/2]

◆ Set_Name() [1/2]

◆ Set_Name() [2/2]

◆ Size() [1/2]

◆ Size() [2/2]

◆ Tell() [1/2]

◆ Tell() [2/2]

◆ Write() [1/2]

◆ Write() [2/2]