doom3-gpl
Doom 3 GPL source release
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | List of all members
idFileSystem Class Referenceabstract

#include <FileSystem.h>

Inheritance diagram for idFileSystem:
idFileSystemLocal

Public Member Functions

virtual ~idFileSystem ()
 
virtual void Init (void)=0
 
virtual void Restart (void)=0
 
virtual void Shutdown (bool reloading)=0
 
virtual bool IsInitialized (void) const =0
 
virtual bool PerformingCopyFiles (void) const =0
 
virtual idModListListMods (void)=0
 
virtual void FreeModList (idModList *modList)=0
 
virtual idFileListListFiles (const char *relativePath, const char *extension, bool sort=false, bool fullRelativePath=false, const char *gamedir=NULL)=0
 
virtual idFileListListFilesTree (const char *relativePath, const char *extension, bool sort=false, const char *gamedir=NULL)=0
 
virtual void FreeFileList (idFileList *fileList)=0
 
virtual const char * OSPathToRelativePath (const char *OSPath)=0
 
virtual const char * RelativePathToOSPath (const char *relativePath, const char *basePath="fs_devpath")=0
 
virtual const char * BuildOSPath (const char *base, const char *game, const char *relativePath)=0
 
virtual void CreateOSPath (const char *OSPath)=0
 
virtual bool FileIsInPAK (const char *relativePath)=0
 
virtual void UpdatePureServerChecksums (void)=0
 
virtual bool UpdateGamePakChecksums (void)=0
 
virtual fsPureReply_t SetPureServerChecksums (const int pureChecksums[MAX_PURE_PAKS], int gamePakChecksum, int missingChecksums[MAX_PURE_PAKS], int *missingGamePakChecksum)=0
 
virtual void GetPureServerChecksums (int checksums[MAX_PURE_PAKS], int OS, int *gamePakChecksum)=0
 
virtual void SetRestartChecksums (const int pureChecksums[MAX_PURE_PAKS], int gamePakChecksum)=0
 
virtual void ClearPureChecksums (void)=0
 
virtual int GetOSMask (void)=0
 
virtual int ReadFile (const char *relativePath, void **buffer, ID_TIME_T *timestamp=NULL)=0
 
virtual void FreeFile (void *buffer)=0
 
virtual int WriteFile (const char *relativePath, const void *buffer, int size, const char *basePath="fs_savepath")=0
 
virtual void RemoveFile (const char *relativePath)=0
 
virtual idFileOpenFileRead (const char *relativePath, bool allowCopyFiles=true, const char *gamedir=NULL)=0
 
virtual idFileOpenFileWrite (const char *relativePath, const char *basePath="fs_savepath")=0
 
virtual idFileOpenFileAppend (const char *filename, bool sync=false, const char *basePath="fs_basepath")=0
 
virtual idFileOpenFileByMode (const char *relativePath, fsMode_t mode)=0
 
virtual idFileOpenExplicitFileRead (const char *OSPath)=0
 
virtual idFileOpenExplicitFileWrite (const char *OSPath)=0
 
virtual void CloseFile (idFile *f)=0
 
virtual void BackgroundDownload (backgroundDownload_t *bgl)=0
 
virtual void ResetReadCount (void)=0
 
virtual int GetReadCount (void)=0
 
virtual void AddToReadCount (int c)=0
 
virtual void FindDLL (const char *basename, char dllPath[MAX_OSPATH], bool updateChecksum)=0
 
virtual void ClearDirCache (void)=0
 
virtual bool HasD3XP (void)=0
 
virtual bool RunningD3XP (void)=0
 
virtual void CopyFile (const char *fromOSPath, const char *toOSPath)=0
 
virtual int ValidateDownloadPakForChecksum (int checksum, char path[MAX_STRING_CHARS], bool isGamePak)=0
 
virtual idFileMakeTemporaryFile (void)=0
 
virtual int AddZipFile (const char *path)=0
 
virtual findFile_t FindFile (const char *path, bool scheduleAddons=false)=0
 
virtual int GetNumMaps ()=0
 
virtual const idDictGetMapDecl (int i)=0
 
virtual void FindMapScreenshot (const char *path, char *buf, int len)=0
 
virtual bool FilenameCompare (const char *s1, const char *s2) const =0
 

Detailed Description

Definition at line 148 of file FileSystem.h.

Constructor & Destructor Documentation

virtual idFileSystem::~idFileSystem ( )
inlinevirtual

Definition at line 150 of file FileSystem.h.

Member Function Documentation

virtual void idFileSystem::AddToReadCount ( int  c)
pure virtual

Implemented in idFileSystemLocal.

virtual int idFileSystem::AddZipFile ( const char *  path)
pure virtual

Implemented in idFileSystemLocal.

virtual void idFileSystem::BackgroundDownload ( backgroundDownload_t bgl)
pure virtual

Implemented in idFileSystemLocal.

virtual const char* idFileSystem::BuildOSPath ( const char *  base,
const char *  game,
const char *  relativePath 
)
pure virtual

Implemented in idFileSystemLocal.

virtual void idFileSystem::ClearDirCache ( void  )
pure virtual

Implemented in idFileSystemLocal.

virtual void idFileSystem::ClearPureChecksums ( void  )
pure virtual

Implemented in idFileSystemLocal.

virtual void idFileSystem::CloseFile ( idFile f)
pure virtual

Implemented in idFileSystemLocal.

virtual void idFileSystem::CopyFile ( const char *  fromOSPath,
const char *  toOSPath 
)
pure virtual

Implemented in idFileSystemLocal.

virtual void idFileSystem::CreateOSPath ( const char *  OSPath)
pure virtual

Implemented in idFileSystemLocal.

virtual bool idFileSystem::FileIsInPAK ( const char *  relativePath)
pure virtual

Implemented in idFileSystemLocal.

virtual bool idFileSystem::FilenameCompare ( const char *  s1,
const char *  s2 
) const
pure virtual

Implemented in idFileSystemLocal.

virtual void idFileSystem::FindDLL ( const char *  basename,
char  dllPath[MAX_OSPATH],
bool  updateChecksum 
)
pure virtual

Implemented in idFileSystemLocal.

virtual findFile_t idFileSystem::FindFile ( const char *  path,
bool  scheduleAddons = false 
)
pure virtual

Implemented in idFileSystemLocal.

virtual void idFileSystem::FindMapScreenshot ( const char *  path,
char *  buf,
int  len 
)
pure virtual

Implemented in idFileSystemLocal.

virtual void idFileSystem::FreeFile ( void buffer)
pure virtual

Implemented in idFileSystemLocal.

virtual void idFileSystem::FreeFileList ( idFileList fileList)
pure virtual

Implemented in idFileSystemLocal.

virtual void idFileSystem::FreeModList ( idModList modList)
pure virtual

Implemented in idFileSystemLocal.

virtual const idDict* idFileSystem::GetMapDecl ( int  i)
pure virtual

Implemented in idFileSystemLocal.

virtual int idFileSystem::GetNumMaps ( )
pure virtual

Implemented in idFileSystemLocal.

virtual int idFileSystem::GetOSMask ( void  )
pure virtual

Implemented in idFileSystemLocal.

virtual void idFileSystem::GetPureServerChecksums ( int  checksums[MAX_PURE_PAKS],
int  OS,
int gamePakChecksum 
)
pure virtual

Implemented in idFileSystemLocal.

virtual int idFileSystem::GetReadCount ( void  )
pure virtual

Implemented in idFileSystemLocal.

virtual bool idFileSystem::HasD3XP ( void  )
pure virtual

Implemented in idFileSystemLocal.

virtual void idFileSystem::Init ( void  )
pure virtual

Implemented in idFileSystemLocal.

virtual bool idFileSystem::IsInitialized ( void  ) const
pure virtual

Implemented in idFileSystemLocal.

virtual idFileList* idFileSystem::ListFiles ( const char *  relativePath,
const char *  extension,
bool  sort = false,
bool  fullRelativePath = false,
const char *  gamedir = NULL 
)
pure virtual

Implemented in idFileSystemLocal.

virtual idFileList* idFileSystem::ListFilesTree ( const char *  relativePath,
const char *  extension,
bool  sort = false,
const char *  gamedir = NULL 
)
pure virtual

Implemented in idFileSystemLocal.

virtual idModList* idFileSystem::ListMods ( void  )
pure virtual

Implemented in idFileSystemLocal.

virtual idFile* idFileSystem::MakeTemporaryFile ( void  )
pure virtual

Implemented in idFileSystemLocal.

virtual idFile* idFileSystem::OpenExplicitFileRead ( const char *  OSPath)
pure virtual

Implemented in idFileSystemLocal.

virtual idFile* idFileSystem::OpenExplicitFileWrite ( const char *  OSPath)
pure virtual

Implemented in idFileSystemLocal.

virtual idFile* idFileSystem::OpenFileAppend ( const char *  filename,
bool  sync = false,
const char *  basePath = "fs_basepath" 
)
pure virtual

Implemented in idFileSystemLocal.

virtual idFile* idFileSystem::OpenFileByMode ( const char *  relativePath,
fsMode_t  mode 
)
pure virtual

Implemented in idFileSystemLocal.

virtual idFile* idFileSystem::OpenFileRead ( const char *  relativePath,
bool  allowCopyFiles = true,
const char *  gamedir = NULL 
)
pure virtual

Implemented in idFileSystemLocal.

virtual idFile* idFileSystem::OpenFileWrite ( const char *  relativePath,
const char *  basePath = "fs_savepath" 
)
pure virtual

Implemented in idFileSystemLocal.

virtual const char* idFileSystem::OSPathToRelativePath ( const char *  OSPath)
pure virtual

Implemented in idFileSystemLocal.

virtual bool idFileSystem::PerformingCopyFiles ( void  ) const
pure virtual

Implemented in idFileSystemLocal.

virtual int idFileSystem::ReadFile ( const char *  relativePath,
void **  buffer,
ID_TIME_T *  timestamp = NULL 
)
pure virtual

Implemented in idFileSystemLocal.

virtual const char* idFileSystem::RelativePathToOSPath ( const char *  relativePath,
const char *  basePath = "fs_devpath" 
)
pure virtual

Implemented in idFileSystemLocal.

virtual void idFileSystem::RemoveFile ( const char *  relativePath)
pure virtual

Implemented in idFileSystemLocal.

virtual void idFileSystem::ResetReadCount ( void  )
pure virtual

Implemented in idFileSystemLocal.

virtual void idFileSystem::Restart ( void  )
pure virtual

Implemented in idFileSystemLocal.

virtual bool idFileSystem::RunningD3XP ( void  )
pure virtual

Implemented in idFileSystemLocal.

virtual fsPureReply_t idFileSystem::SetPureServerChecksums ( const int  pureChecksums[MAX_PURE_PAKS],
int  gamePakChecksum,
int  missingChecksums[MAX_PURE_PAKS],
int missingGamePakChecksum 
)
pure virtual

Implemented in idFileSystemLocal.

virtual void idFileSystem::SetRestartChecksums ( const int  pureChecksums[MAX_PURE_PAKS],
int  gamePakChecksum 
)
pure virtual

Implemented in idFileSystemLocal.

virtual void idFileSystem::Shutdown ( bool  reloading)
pure virtual

Implemented in idFileSystemLocal.

virtual bool idFileSystem::UpdateGamePakChecksums ( void  )
pure virtual

Implemented in idFileSystemLocal.

virtual void idFileSystem::UpdatePureServerChecksums ( void  )
pure virtual

Implemented in idFileSystemLocal.

virtual int idFileSystem::ValidateDownloadPakForChecksum ( int  checksum,
char  path[MAX_STRING_CHARS],
bool  isGamePak 
)
pure virtual

Implemented in idFileSystemLocal.

virtual int idFileSystem::WriteFile ( const char *  relativePath,
const void buffer,
int  size,
const char *  basePath = "fs_savepath" 
)
pure virtual

Implemented in idFileSystemLocal.


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