VSFileSystem Namespace Reference

Classes
class	VSFile

Typedefs
typedef vsUMap< string, VSError >	FileLookupCache

Enumerations
enum	VSError {   Shared, Ok, SocketError, FileNotFound,   LocalPermissionDenied, RemotePermissionDenied, DownloadInterrupted, IncompleteWrite,   IncompleteRead, EndOfFile, IsDirectory, BadFormat,   Unspecified }
enum	VSFileMode { ReadOnly, ReadWrite, CreateWrite }
enum	VSFileType {   UniverseFile, SystemFile, CockpitFile, UnitFile,   UnitSaveFile, TextureFile, SoundFile, PythonFile,   MeshFile, CommFile, AiFile, SaveFile,   AnimFile, VideoFile, VSSpriteFile, MissionFile,   MusicFile, AccountFile, ZoneBuffer, JPEGBuffer,   UnknownFile }
enum	VSVolumeType { VSFSNone, VSFSSplit, VSFSBig }
enum	VSVolumeFormat { vfmtUNK, vfmtVSR, vfmtPK3 }

Functions
void	ChangeToProgramDirectory (char *argv0)
VSError	CachedFileLookup (FileLookupCache &cache, const string &file, VSFileType type)
void	DisplayType (VSFileSystem::VSFileType type)
void	DisplayType (VSFileSystem::VSFileType type, std::ostream &ostr)
int	GetReadBytes (char *fmt, va_list ap)
string	HOMESUBDIR (".vegastrike")
std::string	GetHashName (const std::string &name)
std::string	GetHashName (const std::string &name, const Vector &scale, int faction)
std::string	GetSharedMeshHashName (const std::string &name, const Vector &scale, int faction)
std::string	GetSharedTextureHashName (const std::string &name)
std::string	GetSharedSoundHashName (const std::string &name)
std::string	MakeSharedPathReturnHome (const std::string &newpath)
std::string	MakeSharedPath (const std::string &s)
std::string	MakeSharedStarSysPath (const std::string &s)
std::string	GetCorrectStarSysPath (const std::string &name, bool &autogenerated)
FILE *	vs_open (const char *filename, const char *mode)
size_t	vs_read (void *ptr, size_t size, size_t nmemb, FILE *fp)
size_t	vs_write (const void *ptr, size_t size, size_t nmemb, FILE *fp)
void	vs_close (FILE *fp)
int	vs_fprintf (FILE *fp, const char *format,...)
void	vs_dprintf (char level, const char *format,...)
int	vs_fseek (FILE *fp, long offset, int whence)
long	vs_ftell (FILE *fp)
void	vs_rewind (FILE *fp)
bool	vs_feof (FILE *fp)
long	vs_getsize (FILE *fp)
void	InitHomeDirectory ()
void	InitDataDirectory ()
void	LoadConfig (string subdir)
void	InitMods ()
void	InitPaths (string conf, string subdir)
void	CreateDirectoryAbs (const char *filename)
void	CreateDirectoryAbs (const string &filename)
void	CreateDirectoryHome (const char *filename)
void	CreateDirectoryHome (const string &filename)
void	CreateDirectoryData (const char *filename)
void	CreateDirectoryData (const string &filename)
bool	DirectoryExists (const char *filename)
bool	DirectoryExists (const string &filename)
int	FileExists (const string &root, const char *filename, VSFileType type, bool lookinvolume)
int	FileExists (const string &root, const string &filename, VSFileType type, bool lookinvolume)
int	FileExistsData (const char *filename, VSFileType type)
int	FileExistsData (const string &filename, VSFileType type)
int	FileExistsHome (const char *filename, VSFileType type)
int	FileExistsHome (const string &filename, VSFileType type)
VSError	GetError (const char *str)
VSError	LookForFile (const string &file, VSFileType type, VSFileMode mode)
VSError	LookForFile (VSFile &f, VSFileType type, VSFileMode mode)
template<class A >
int	vs_fscanf (FILE *fp, const char *format, A *a)
template<class A , class B >
int	vs_fscanf (FILE *fp, const char *format, A *a, B *b)
template<class A , class B , class C >
int	vs_fscanf (FILE *fp, const char *format, A *a, B *b, C *c)
template<class A , class B , class C , class D >
int	vs_fscanf (FILE *fp, const char *format, A *a, B *b, C *c, D *d)
template<class A , class B , class C , class D , class E >
int	vs_fscanf (FILE *fp, const char *format, A *a, B *b, C *c, D *d, E *e)
template<class A , class B , class C , class D , class E , class F >
int	vs_fscanf (FILE *fp, const char *format, A *a, B *b, C *c, D *d, E *e, F *f)
string	GetHashName (const std::string &name, const class Vector &scale, int faction)
string	GetSharedMeshHashName (const std::string &, const class Vector &scale, int faction)

Variables
std::string	vegastrike_cwd
bool	use_volumes
string	volume_format
enum VSVolumeFormat	q_volume_format
vector< vector< string > >	SubDirectories
vector< string >	Directories
vector< string >	Rootdir
string	sharedtextures
string	sharedunits
string	sharedsounds
string	sharedmeshes
string	sharedsectors
string	sharedcockpits
string	shareduniverse
string	aidir
string	sharedanims
string	sharedvideos
string	sharedsprites
string	savedunitpath
string	modname
string	moddir
string	datadir
string	homedir
string	config_file
string	weapon_list
string	universe_name
vector< string >	current_path
vector< string >	current_directory
vector< string >	current_subdirectory
vector< VSFileType >	current_type
vector< std::string >	savedpwd
vector< std::string >	curdir
vector< std::vector < std::string > >	savedcurdir
vector< int >	UseVolumes
string	failed
vsUMap< string, CPK3 * >	pk3_opened_files
string	HOMESUBDIR

Typedef Documentation

typedef vsUMap< string, VSError > VSFileSystem::FileLookupCache

Definition at line 82 of file vsfilesystem.h.

Enumeration Type Documentation

enum VSFileSystem::VSError

Enumerator
Shared
Ok
SocketError
FileNotFound
LocalPermissionDenied
RemotePermissionDenied
DownloadInterrupted
IncompleteWrite
IncompleteRead
EndOfFile
IsDirectory
BadFormat
Unspecified

Definition at line 36 of file vsfilesystem.h.

enum VSFileSystem::VSFileMode

Enumerator
ReadOnly
ReadWrite
CreateWrite

Definition at line 43 of file vsfilesystem.h.

enum VSFileSystem::VSFileType

Enumerator
UniverseFile
SystemFile
CockpitFile
UnitFile
UnitSaveFile
TextureFile
SoundFile
PythonFile
MeshFile
CommFile
AiFile
SaveFile
AnimFile
VideoFile
VSSpriteFile
MissionFile
MusicFile
AccountFile
ZoneBuffer
JPEGBuffer
UnknownFile

Definition at line 46 of file vsfilesystem.h.

enum VSFileSystem::VSVolumeFormat

Enumerator
vfmtUNK
vfmtVSR
vfmtPK3

Definition at line 75 of file vsfilesystem.h.

enum VSFileSystem::VSVolumeType

Enumerator
VSFSNone
VSFSSplit
VSFSBig

Definition at line 74 of file vsfilesystem.h.

Function Documentation

VSError VSFileSystem::CachedFileLookup	(	FileLookupCache &	cache,
		const string &	file,
		VSFileType	type
	)

Definition at line 194 of file vsfilesystem.cpp.

void VSFileSystem::ChangeToProgramDirectory

(

char *

argv0)

Definition at line 136 of file vsfilesystem.cpp.

void VSFileSystem::CreateDirectoryAbs

(

const char *

filename)

Definition at line 962 of file vsfilesystem.cpp.

void VSFileSystem::CreateDirectoryAbs

(

const string &

filename)

Definition at line 979 of file vsfilesystem.cpp.

void VSFileSystem::CreateDirectoryData

(

const char *

filename)

Definition at line 991 of file vsfilesystem.cpp.

void VSFileSystem::CreateDirectoryData

(

const string &

filename)

Definition at line 995 of file vsfilesystem.cpp.

void VSFileSystem::CreateDirectoryHome

(

const char *

filename)

Definition at line 983 of file vsfilesystem.cpp.

void VSFileSystem::CreateDirectoryHome

(

const string &

filename)

Definition at line 987 of file vsfilesystem.cpp.

bool VSFileSystem::DirectoryExists

(

const char *

filename)

Definition at line 1001 of file vsfilesystem.cpp.

bool VSFileSystem::DirectoryExists

(

const string &

filename)

Definition at line 1010 of file vsfilesystem.cpp.

void VSFileSystem::DisplayType

(

VSFileSystem::VSFileType

type)

Definition at line 205 of file vsfilesystem.cpp.

void VSFileSystem::DisplayType	(	VSFileSystem::VSFileType	type,
		std::ostream &	ostr
	)

Definition at line 213 of file vsfilesystem.cpp.

int VSFileSystem::FileExists	(	const string &	root,
		const char *	filename,
		VSFileType	type,
		bool	lookinvolume
	)

Definition at line 1017 of file vsfilesystem.cpp.

int VSFileSystem::FileExists	(	const string &	root,
		const string &	filename,
		VSFileType	type,
		bool	lookinvolume
	)

Definition at line 1127 of file vsfilesystem.cpp.

int VSFileSystem::FileExistsData	(	const char *	filename,
		VSFileType	type
	)

Definition at line 1132 of file vsfilesystem.cpp.

int VSFileSystem::FileExistsData	(	const string &	filename,
		VSFileType	type
	)

Definition at line 1136 of file vsfilesystem.cpp.

int VSFileSystem::FileExistsHome	(	const char *	filename,
		VSFileType	type
	)

Definition at line 1141 of file vsfilesystem.cpp.

int VSFileSystem::FileExistsHome	(	const string &	filename,
		VSFileType	type
	)

Definition at line 1145 of file vsfilesystem.cpp.

string VSFileSystem::GetCorrectStarSysPath	(	const std::string &	name,
		bool &	autogenerated
	)

Definition at line 371 of file vsfilesystem.cpp.

VSError VSFileSystem::GetError

(

const char *

str)

Definition at line 1150 of file vsfilesystem.cpp.

string VSFileSystem::GetHashName	(	const std::string &	name,
		const class Vector &	scale,
		int	faction
	)

string VSFileSystem::GetHashName

(

const std::string &

name)

Definition at line 328 of file vsfilesystem.cpp.

std::string VSFileSystem::GetHashName	(	const std::string &	name,
		const Vector &	scale,
		int	faction
	)

Definition at line 334 of file vsfilesystem.cpp.

int VSFileSystem::GetReadBytes	(	char *	fmt,
		va_list	ap
	)

Definition at line 243 of file vsfilesystem.cpp.

string VSFileSystem::GetSharedMeshHashName	(	const std::string &	,
		const class Vector &	scale,
		int	faction
	)

std::string VSFileSystem::GetSharedMeshHashName	(	const std::string &	name,
		const Vector &	scale,
		int	faction
	)

Definition at line 343 of file vsfilesystem.cpp.

string VSFileSystem::GetSharedSoundHashName

(

const std::string &

name)

Definition at line 351 of file vsfilesystem.cpp.

string VSFileSystem::GetSharedTextureHashName

(

const std::string &

name)

Definition at line 347 of file vsfilesystem.cpp.

string VSFileSystem::HOMESUBDIR

(

".vegastrike"

)

void VSFileSystem::InitDataDirectory

(

)

Definition at line 552 of file vsfilesystem.cpp.

void VSFileSystem::InitHomeDirectory

(

)

Definition at line 531 of file vsfilesystem.cpp.

void VSFileSystem::InitMods

(

)

Definition at line 725 of file vsfilesystem.cpp.

void VSFileSystem::InitPaths	(	string	conf,
		string	subdir
	)

Definition at line 782 of file vsfilesystem.cpp.

void VSFileSystem::LoadConfig

(

string

subdir)

Definition at line 644 of file vsfilesystem.cpp.

VSError VSFileSystem::LookForFile	(	const string &	file,
		VSFileType	type,
		VSFileMode	mode
	)

Definition at line 1170 of file vsfilesystem.cpp.

VSError VSFileSystem::LookForFile	(	VSFile &	f,
		VSFileType	type,
		VSFileMode	mode
	)

Definition at line 1178 of file vsfilesystem.cpp.

string VSFileSystem::MakeSharedPath

(

const std::string &

s)

Definition at line 361 of file vsfilesystem.cpp.

std::string VSFileSystem::MakeSharedPathReturnHome

(

const std::string &

newpath)

Definition at line 356 of file vsfilesystem.cpp.

string VSFileSystem::MakeSharedStarSysPath

(

const std::string &

s)

Definition at line 366 of file vsfilesystem.cpp.

void VSFileSystem::vs_close

(

FILE *

fp)

Definition at line 454 of file vsfilesystem.cpp.

void VSFileSystem::vs_dprintf	(	char	level,
		const char *	format,
			...
	)

Definition at line 472 of file vsfilesystem.cpp.

bool VSFileSystem::vs_feof

(

FILE *

fp)

Definition at line 509 of file vsfilesystem.cpp.

int VSFileSystem::vs_fprintf	(	FILE *	fp,
		const char *	format,
			...
	)

Definition at line 461 of file vsfilesystem.cpp.

template<class A >

int VSFileSystem::vs_fscanf	(	FILE *	fp,
		const char *	format,
		A *	a
	)

Definition at line 159 of file vsfilesystem.h.

template<class A , class B >

int VSFileSystem::vs_fscanf	(	FILE *	fp,
		const char *	format,
		A *	a,
		B *	b
	)

Definition at line 164 of file vsfilesystem.h.

template<class A , class B , class C >

int VSFileSystem::vs_fscanf	(	FILE *	fp,
		const char *	format,
		A *	a,
		B *	b,
		C *	c
	)

Definition at line 169 of file vsfilesystem.h.

template<class A , class B , class C , class D >

int VSFileSystem::vs_fscanf	(	FILE *	fp,
		const char *	format,
		A *	a,
		B *	b,
		C *	c,
		D *	d
	)

Definition at line 174 of file vsfilesystem.h.

template<class A , class B , class C , class D , class E >

int VSFileSystem::vs_fscanf	(	FILE *	fp,
		const char *	format,
		A *	a,
		B *	b,
		C *	c,
		D *	d,
		E *	e
	)

Definition at line 179 of file vsfilesystem.h.

template<class A , class B , class C , class D , class E , class F >

int VSFileSystem::vs_fscanf	(	FILE *	fp,
		const char *	format,
		A *	a,
		B *	b,
		C *	c,
		D *	d,
		E *	e,
		F *	f
	)

Definition at line 184 of file vsfilesystem.h.

int VSFileSystem::vs_fseek	(	FILE *	fp,
		long	offset,
		int	whence
	)

Definition at line 494 of file vsfilesystem.cpp.

long VSFileSystem::vs_ftell

(

FILE *

fp)

Definition at line 499 of file vsfilesystem.cpp.

long VSFileSystem::vs_getsize

(

FILE *

fp)

Definition at line 514 of file vsfilesystem.cpp.

FILE * VSFileSystem::vs_open	(	const char *	filename,
		const char *	mode
	)

Definition at line 397 of file vsfilesystem.cpp.

size_t VSFileSystem::vs_read	(	void *	ptr,
		size_t	size,
		size_t	nmemb,
		FILE *	fp
	)

Definition at line 438 of file vsfilesystem.cpp.

void VSFileSystem::vs_rewind

(

FILE *

fp)

Definition at line 504 of file vsfilesystem.cpp.

size_t VSFileSystem::vs_write	(	const void *	ptr,
		size_t	size,
		size_t	nmemb,
		FILE *	fp
	)

Definition at line 446 of file vsfilesystem.cpp.

Variable Documentation

string VSFileSystem::aidir

Definition at line 291 of file vsfilesystem.cpp.

string VSFileSystem::config_file

Definition at line 301 of file vsfilesystem.cpp.

vector< std::string > VSFileSystem::curdir

Definition at line 312 of file vsfilesystem.cpp.

vector< string > VSFileSystem::current_directory

Definition at line 306 of file vsfilesystem.cpp.

vector< string > VSFileSystem::current_path

Definition at line 305 of file vsfilesystem.cpp.

vector< string > VSFileSystem::current_subdirectory

Definition at line 307 of file vsfilesystem.cpp.

vector< VSFileType > VSFileSystem::current_type

Definition at line 308 of file vsfilesystem.cpp.

string VSFileSystem::datadir

Definition at line 298 of file vsfilesystem.cpp.

vector< string > VSFileSystem::Directories

Definition at line 282 of file vsfilesystem.cpp.

string VSFileSystem::failed

Definition at line 317 of file vsfilesystem.cpp.

string VSFileSystem::homedir

Definition at line 299 of file vsfilesystem.cpp.

string VSFileSystem::HOMESUBDIR

string VSFileSystem::moddir

Definition at line 297 of file vsfilesystem.cpp.

string VSFileSystem::modname

Definition at line 296 of file vsfilesystem.cpp.

vsUMap< string, CPK3 * > VSFileSystem::pk3_opened_files

Definition at line 320 of file vsfilesystem.cpp.

enum VSVolumeFormat VSFileSystem::q_volume_format

Definition at line 279 of file vsfilesystem.cpp.

vector< string > VSFileSystem::Rootdir

Definition at line 283 of file vsfilesystem.cpp.

vector< std::vector< std::string > > VSFileSystem::savedcurdir

Definition at line 313 of file vsfilesystem.cpp.

vector< std::string > VSFileSystem::savedpwd

Definition at line 311 of file vsfilesystem.cpp.

string VSFileSystem::savedunitpath

Definition at line 295 of file vsfilesystem.cpp.

string VSFileSystem::sharedanims

Definition at line 292 of file vsfilesystem.cpp.

string VSFileSystem::sharedcockpits

Definition at line 289 of file vsfilesystem.cpp.

string VSFileSystem::sharedmeshes

Definition at line 287 of file vsfilesystem.cpp.

string VSFileSystem::sharedsectors

Definition at line 288 of file vsfilesystem.cpp.

string VSFileSystem::sharedsounds

Definition at line 286 of file vsfilesystem.cpp.

string VSFileSystem::sharedsprites

Definition at line 294 of file vsfilesystem.cpp.

string VSFileSystem::sharedtextures

Definition at line 284 of file vsfilesystem.cpp.

string VSFileSystem::sharedunits

Definition at line 285 of file vsfilesystem.cpp.

string VSFileSystem::shareduniverse

Definition at line 290 of file vsfilesystem.cpp.

string VSFileSystem::sharedvideos

Definition at line 293 of file vsfilesystem.cpp.

vector< vector< string > > VSFileSystem::SubDirectories

Definition at line 281 of file vsfilesystem.cpp.

string VSFileSystem::universe_name

Definition at line 303 of file vsfilesystem.cpp.

bool VSFileSystem::use_volumes

Definition at line 277 of file vsfilesystem.cpp.

vector< int > VSFileSystem::UseVolumes

Definition at line 315 of file vsfilesystem.cpp.

std::string VSFileSystem::vegastrike_cwd

Definition at line 134 of file vsfilesystem.cpp.

string VSFileSystem::volume_format

Definition at line 278 of file vsfilesystem.cpp.

string VSFileSystem::weapon_list

Definition at line 302 of file vsfilesystem.cpp.