All of UFO's data access is through a hierarchical file system, but the contents of the file system can be transparently merged from several sources. The "base directory" is the path to the directory holding the ufo binary and the game directory (base). The base directory is only used during filesystem initialization. The "game directory" is the first tree on the search path and directory that all generated files (savegames, screenshots, config files) will be saved to. More...

#include "common.h"
#include "qfiles.h"
#include "unzip.h"
#include "../ports/system.h"
#include "../shared/defines.h"
#include "../shared/parse.h"
#include <unistd.h>

Include dependency graph for files.cpp:

Go to the source code of this file.

Data Structures
struct	listBlock_t

Macros
#define	MODS_DIR "mods"
#define	PK3_SEEK_BUFFER_SIZE 65536
#define	MAX_READ 0x10000 /* read in blocks of 64k */
#define	MAX_PACKFILES 1024

Functions
void	FS_CreateOpenPipeFile (const char filename, qFILE f)
const char *	FS_Gamedir (void)
	Called to find where to write a file (savegames, etc).
void	FS_NormPath (char *path)
	Convert operating systems path separators to ufo virtual filesystem separators (/).
int	FS_FileLength (qFILE *f)
	Returns the size of a given file or -1 if no file is opened.
void	FS_CreatePath (const char *path)
	Creates any directories needed to store the given filename.
void	FS_CloseFile (qFILE *f)
	Closes a file handle.
int	FS_OpenFile (const char filename, qFILE file, filemode_t mode)
	Finds and opens the file in the search path.
int	FS_Seek (qFILE *f, long offset, int origin)
	Sets the file position of the given file.
int	FS_CheckFile (const char *fmt,...)
	Just returns the filelength and -1 if the file wasn't found.
int	FS_Read2 (void buffer, int len, qFILE f, bool failOnEmptyRead)
	Read a file into a given buffer in memory.
int	FS_Read (void buffer, int len, qFILE f)
int	FS_LoadFile (const char path, byte *buffer)
	Filenames are relative to the quake search path.
void	FS_FreeFile (void *buffer)
static pack_t *	FS_LoadPackFile (const char *packfile)
	Takes an explicit (not game tree related) path to a pak file. Adding the files at the beginning of the list so they override previous pack files.
void	FS_AddGameDirectory (const char *dir, bool write)
	Adds the directory to the head of the search path.
char **	FS_ListFiles (const char findname, int numfiles, unsigned musthave, unsigned canthave)
	Builds a qsorted filelist.
const char *	FS_NextPath (const char *prevpath)
	Allows enumerating all of the directories in the search path.
static bool	FS_GetHomeDirectory (char *gdir, size_t length)
void	FS_AddHomeAsGameDirectory (const char *dir, bool write)
int	FS_GetModList (linkedList_t **mods)
	Searches and builds a list of mod directories.
void	FS_InitFilesystem (bool writeToHomeDir)
static void	_AddToListBlock (linkedList_t *fl, const char name, bool stripPath)
	Add one name to the filelist.
int	FS_BuildFileList (const char *fileList)
	Build a filelist.
const char *	FS_NextFileFromFileList (const char *files)
	Returns the next file that is found in the virtual filesystem identified by the given file pattern.
const char *	FS_GetFileData (const char *files)
	Returns the buffer of a file.
char *	FS_NextScriptHeader (const char files, const char name, const char *text)
static int	FS_MapDefSort (const void map1, const void map2)
static int	CheckBSPFile (const char *filename)
	Checks for valid BSP-file.
void	FS_GetMaps (bool reset)
	File the fs_maps array with valid maps.
int	FS_Printf (qFILE f, const char msg,...)
	Can print chunks for 1024 chars into a file.
int	FS_Write (const void buffer, int len, qFILE f)
	Properly handles partial writes.
int	FS_WriteFile (const void buffer, size_t len, const char filename)
const char *	FS_GetCwd (void)
	Return current working dir.
bool	FS_FileExists (const char *filename,...)
	Checks whether a file exists (not in virtual filesystem).
void	FS_Shutdown (void)
	Cleanup function.
void	FS_RestartFilesystem (const char *gamedir)
	Restart the filesystem (reload all pk3 files).
void	FS_CopyFile (const char fromOSPath, const char toOSPath)
	Copy a fully specified file from one place to another.
void	FS_RemoveFile (const char *osPath)
bool	FS_RenameFile (const char from, const char to, bool relative)
	Renames a file.

Variables
static int	fs_openedFiles
static filelink_t *	fs_links
static searchpath_t *	fs_searchpaths
static char const *const	pakFileExt []
static listBlock_t *	fs_blocklist = nullptr
char *	fs_maps [MAX_MAPS]
int	fs_numInstalledMaps = -1
static bool	fs_mapsInstalledInit = false

Detailed Description

All of UFO's data access is through a hierarchical file system, but the contents of the file system can be transparently merged from several sources. The "base directory" is the path to the directory holding the ufo binary and the game directory (base). The base directory is only used during filesystem initialization. The "game directory" is the first tree on the search path and directory that all generated files (savegames, screenshots, config files) will be saved to.

Definition in file files.cpp.

Macro Definition Documentation

◆ MAX_PACKFILES

#define MAX_PACKFILES 1024

Definition at line 483 of file files.cpp.

Referenced by FS_AddGameDirectory().

◆ MAX_READ

#define MAX_READ 0x10000 /* read in blocks of 64k */

Definition at line 311 of file files.cpp.

Referenced by FS_Read2().

◆ MODS_DIR

#define MODS_DIR "mods"

Definition at line 45 of file files.cpp.

Referenced by FS_GetModList(), and FS_InitFilesystem().

◆ PK3_SEEK_BUFFER_SIZE

#define PK3_SEEK_BUFFER_SIZE 65536

Definition at line 238 of file files.cpp.

Referenced by FS_Seek().

Function Documentation

◆ _AddToListBlock()

void _AddToListBlock	(	linkedList_t **	fl,
		const char *	name,
		bool	stripPath )

static

Add one name to the filelist.

Note: also checks for duplicates

See also: FS_BuildFileList

Definition at line 941 of file files.cpp.

References Com_SkipPath(), f, LIST_AddStringSorted(), LIST_ContainsString(), and name.

Referenced by FS_BuildFileList().

◆ CheckBSPFile()

int CheckBSPFile ( const char * filename )

static

Checks for valid BSP-file.

Parameters

[in] filename BSP-file to check

Returns: 0 if valid; 1 could not open file; 2 if magic number is bad; 3 if version of bsp-file is bad

Definition at line 1344 of file files.cpp.

References BSPVERSION, Com_sprintf(), FILE_READ, FS_OpenFile(), FS_Read(), i, IDBSPHEADER, LittleLong, MAX_QPATH, and name.

Referenced by FS_GetMaps().

◆ FS_AddGameDirectory()

void FS_AddGameDirectory	(	const char *	dir,
		bool	write )

Adds the directory to the head of the search path.

Note: No ending slash here

Parameters

[in]	dir	The directory name relative to the game dir
[in]	write	Add this directory as writable (config files, save games)

Definition at line 495 of file files.cpp.

References com_fileSysPool, Com_Printf(), Com_sprintf(), searchpath_t::filename, FS_ListFiles(), FS_LoadPackFile(), fs_searchpaths, i, MAX_OSPATH, MAX_PACKFILES, Mem_Free, Mem_PoolAllocType, searchpath_t::next, searchpath_t::pack, pakFileExt, Q_streq, Q_StringSort(), Q_strncpyz(), SFF_HIDDEN, SFF_SUBDIR, SFF_SYSTEM, and searchpath_t::write.

Referenced by FS_AddHomeAsGameDirectory(), FS_InitFilesystem(), FS_Printf(), main(), and TEST_Init().

◆ FS_AddHomeAsGameDirectory()

void FS_AddHomeAsGameDirectory	(	const char *	dir,
		bool	write )

Note: e.g. *nix: Use ~/.ufoai/dir as gamedir

Parameters

[in]	dir	The directory name relative to the game dir
[in]	write	Add this directory as writable (config files, save games)

See also: Sys_GetHomeDirectory

Definition at line 655 of file files.cpp.

References FS_AddGameDirectory(), FS_CreatePath(), FS_GetHomeDirectory(), MAX_OSPATH, Q_strcat(), and va().

Referenced by FS_InitFilesystem(), FS_Printf(), and TEST_Init().

◆ FS_BuildFileList()

int FS_BuildFileList ( const char * fileList )

Build a filelist.

Parameters

[in] fileList e.g. *.cfg to get all config files in the gamedir/ dir

Definition at line 962 of file files.cpp.

References _AddToListBlock(), Com_FilePath(), com_fileSysPool, Com_sprintf(), listBlock_t::files, pack_t::files, findname, fs_blocklist, FS_ListFiles(), FS_NormPath(), fs_searchpaths, i, LIST_Count(), LIST_Delete(), LIST_Foreach, MAX_QPATH, Mem_Free, Mem_PoolAllocType, name, packfile_t::name, listBlock_t::next, pack_t::numfiles, listBlock_t::path, Q_streq, Q_strncpyz(), SFF_HIDDEN, SFF_SYSTEM, and Sys_ListFilteredFiles().

Referenced by CL_ParseMessageIDs(), Com_ParseScripts(), FS_CheckFile(), FS_GetFileData(), FS_NextFileFromFileList(), GAME_GetImportData(), GAME_GetTeamFileName(), GAME_TeamSlotComments_f(), cgame_import_t::int(), M_RandomTrack_f(), MD2Visitor(), PrecalcNormalsAndTangentsBatch(), TEST_F(), TEST_F(), TEST_ParseScript(), and UI_Restart_f().

◆ FS_CheckFile()

int FS_CheckFile	(	const char *	fmt,
			... )

Just returns the filelength and -1 if the file wasn't found.

Note: Won't print any errors

See also: FS_FileExists

Definition at line 298 of file files.cpp.

References FILE_READ, FS_OpenFile(), MAX_QPATH, and Q_vsnprintf().

Referenced by cgame_import_t::__attribute__(), CIN_OpenCinematic(), CL_CheckAndQueueDownload(), CL_ConvertSoundFromEvent(), FS_CheckFile(), GAME_GetImportData(), GAME_TeamGetFreeFilename(), PrecalcNormalsAndTangents(), R_ImageExists(), R_LoadModelAsync(), R_LoadObjSkin(), R_ModelExists(), R_ModLoadAliasMD2Model(), R_ModLoadLevelOfDetailData(), R_ScreenShot(), SV_CheckMap(), SV_NextMapcycle(), TEST_CheckImage(), TEST_CheckModel(), TEST_CheckSound(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), UI_CheckRadarImage(), UI_ListMaps_f(), UI_MapInfoGetNext(), and UI_RegisterFont().

◆ FS_CloseFile()

void FS_CloseFile ( qFILE * f )

Closes a file handle.

See also: FS_OpenFile

Definition at line 137 of file files.cpp.

References f, fs_openedFiles, and unzCloseCurrentFile().

Referenced by ScopedFile::~ScopedFile().

◆ FS_CopyFile()

void FS_CopyFile	(	const char *	fromOSPath,
		const char *	toOSPath )

Copy a fully specified file from one place to another.

Todo: Allow copy of pk3 file content

Definition at line 1654 of file files.cpp.

References com_fileSysPool, Com_Printf(), f, FILE, FS_CreatePath(), fs_searchpaths, len, Mem_Free, Mem_PoolAllocTypeN, SEEK_END, SEEK_SET, Sys_Error(), and Sys_Fopen().

Referenced by FS_FileExists().

◆ FS_CreateOpenPipeFile()

void FS_CreateOpenPipeFile	(	const char *	filename,
		qFILE *	f )

Definition at line 47 of file files.cpp.

References Com_Printf(), f, FS_Gamedir(), fs_openedFiles, fs_searchpaths, OBJZERO, Q_strncpyz(), Sys_Error(), Sys_Mkfifo(), and va().

Referenced by FS_Printf(), and Qcommon_Init().

◆ FS_CreatePath()

void FS_CreatePath ( const char * path )

Creates any directories needed to store the given filename.

See also: Sys_Mkdir

Note: Paths should already be normalized

See also: FS_NormPath

Definition at line 117 of file files.cpp.

References MAX_OSPATH, Q_strncpyz(), and Sys_Mkdir().

Referenced by CL_StartHTTPDownload(), FS_AddHomeAsGameDirectory(), FS_CheckFile(), FS_CopyFile(), and FS_OpenFile().

◆ FS_FileExists()

bool FS_FileExists	(	const char *	filename,
			... )

Checks whether a file exists (not in virtual filesystem).

See also: FS_CheckFile

Parameters

[in] filename Full filesystem path to the file

Definition at line 1583 of file files.cpp.

References MAX_OSPATH, Q_vsnprintf(), and Sys_Access().

Referenced by CL_LanguageTest(), FS_FileExists(), FS_InitFilesystem(), GAME_TeamSlotComments_f(), TEST_F(), and WEB_CGameUpload().

◆ FS_FileLength()

int FS_FileLength ( qFILE * f )

Returns the size of a given file or -1 if no file is opened.

Definition at line 91 of file files.cpp.

References f, SEEK_END, SEEK_SET, Sys_Error(), unz_file_info::uncompressed_size, UNZ_OK, and unzGetCurrentFileInfo().

Referenced by ASE_Load(), FS_OpenFile(), FS_WriteFile(), and GAME_LoadTeam().

◆ FS_FreeFile()

void FS_FreeFile ( void * buffer )

◆ FS_Gamedir()

const char * FS_Gamedir ( void )

Called to find where to write a file (savegames, etc).

Note: We will use the searchpath that isn't a pack and has highest priority

Definition at line 68 of file files.cpp.

References fs_searchpaths.

Referenced by CL_CheckAndQueueDownload(), CL_FinishHTTPDownload(), CL_StartHTTPDownload(), Com_Error(), Com_Quit(), FS_CreateOpenPipeFile(), FS_InitFilesystem(), FS_NextPath(), FS_OpenFile(), FS_Printf(), FS_RenameFile(), FS_WriteFile(), GAME_GetAbsoluteSavePath(), Key_WriteBindings(), R_ScreenShot(), SV_InitGameProgs(), TEST_F(), and WEB_CGameUpload().

◆ FS_GetCwd()

const char * FS_GetCwd ( void )

Return current working dir.

Definition at line 1570 of file files.cpp.

References FS_NormPath(), MAX_OSPATH, Q_strncpyz(), and Sys_Cwd().

Referenced by CL_Init(), CL_LanguageTest(), and FS_ExecAutoexec().

◆ FS_GetFileData()

const char * FS_GetFileData ( const char * files )

Returns the buffer of a file.

Parameters

[in] files If nullptr, reset the filelist If not nullptr it may be something like *.cfg to get a list of all config files in base/. Calling FS_GetFileData("*.cfg"); until it returns nullptr is sufficient to get one buffer after another.

Note: You don't have to free the file buffer on the calling side. This is done in this function, too

Definition at line 1137 of file files.cpp.

References Com_Printf(), linkedList_t::data, listBlock_t::files, fs_blocklist, FS_BuildFileList(), FS_FreeFile(), FS_LoadFile(), MAX_QPATH, linkedList_t::next, listBlock_t::next, listBlock_t::path, Q_streq, and Q_strncpyz().

Referenced by Com_GetScriptChecksum(), and FS_CheckFile().

◆ FS_GetHomeDirectory()

bool FS_GetHomeDirectory	(	char *	gdir,
		size_t	length )

static

Definition at line 631 of file files.cpp.

References Com_Printf(), Com_sprintf(), length, Sys_GetHomeDirectory(), and UFO_VERSION.

Referenced by FS_AddHomeAsGameDirectory(), and FS_GetModList().

◆ FS_GetMaps()

void FS_GetMaps ( bool reset )

File the fs_maps array with valid maps.

Parameters

[in] reset If true the directory is scanned every time for new maps (useful for dedicated servers). If false we only use the maps array (for clients e.g.)

Todo: paths are normalized here?

Definition at line 1375 of file files.cpp.

References CheckBSPFile(), com_fileSysPool, Com_Printf(), Com_SkipPath(), Com_sprintf(), Com_StripExtension(), pack_t::files, findname, FS_ListFiles(), FS_MapDefSort(), fs_maps, fs_mapsInstalledInit, FS_NormPath(), fs_numInstalledMaps, fs_searchpaths, i, MAX_MAPS, MAX_OSPATH, MAX_QPATH, Mem_Free, Mem_PoolAllocTypeN, packfile_t::name, pack_t::numfiles, Q_strncpyz(), SFF_HIDDEN, and SFF_SYSTEM.

Referenced by FS_FileExists(), SV_CompleteMapCommand(), and SV_ListMaps_f().

◆ FS_GetModList()

int FS_GetModList ( linkedList_t ** mods )

Searches and builds a list of mod directories.

Definition at line 669 of file files.cpp.

References BASEDIRNAME, FS_GetHomeDirectory(), FS_ListFiles(), i, LIST_AddString(), MAX_OSPATH, Mem_Free, MODS_DIR, PKGDATADIR, Q_strcat(), SFF_HIDDEN, SFF_SUBDIR, SFF_SYSTEM, and va().

Referenced by CLMN_Mods_f(), and FS_ExecAutoexec().

◆ FS_InitFilesystem()

void FS_InitFilesystem ( bool writeToHomeDir )

See also: FS_Shutdown; FS_RestartFilesystem

Definition at line 890 of file files.cpp.

References BASEDIRNAME, Cbuf_AddText(), Com_Printf(), Com_sprintf(), Cvar_GetString(), FS_AddGameDirectory(), FS_AddHomeAsGameDirectory(), FS_FileExists(), FS_Gamedir(), MAX_QPATH, MODS_DIR, PKGDATADIR, and Q_strvalid.

Referenced by FS_Printf(), main(), Qcommon_Init(), and TEST_Init().

◆ FS_ListFiles()

char ** FS_ListFiles	(	const char *	findname,
		int *	numfiles,
		unsigned	musthave,
		unsigned	canthave )

Builds a qsorted filelist.

See also: Sys_FindFirst; Sys_FindNext; Sys_FindClose

Note: Don't forget to free the filelist array and the file itself

Definition at line 562 of file files.cpp.

References com_fileSysPool, findname, i, MAX_FILES, MAX_OSPATH, Mem_PoolAllocTypeN, Mem_PoolStrDup, OBJZERO, Q_StringSort(), Q_strlwr(), Q_strncpyz(), Sys_FindClose(), Sys_FindFirst(), and Sys_FindNext().

Referenced by FS_AddGameDirectory(), FS_BuildFileList(), FS_CheckFile(), FS_GetMaps(), and FS_GetModList().

◆ FS_LoadFile()

int FS_LoadFile	(	const char *	path,
		byte **	buffer )

Filenames are relative to the quake search path.

Parameters

[in]	buffer	a null buffer will just return the file length without loading
[in]	path

Returns: a -1 length means that the file is not present

See also: FS_Read; FS_OpenFile

Definition at line 384 of file files.cpp.

References com_fileSysPool, FILE_READ, FS_OpenFile(), FS_Read(), len, and Mem_PoolAllocTypeN.

Referenced by Check_InitEntityDefs(), CL_CheckOrDownloadFile(), CL_ReVerifyHTTPQueue(), CL_UfoModuleLoader(), CM_AddMapTile(), Cmd_Exec_f(), FS_FileExists(), FS_GetFileData(), FS_NextScriptHeader(), GAME_GetImportData(), LoadBSPFile(), LoadModel(), LoadScriptFile(), M_Start(), ModelWorker(), ParseUMP(), R_FontAnalyze(), R_LoadMaterials(), R_LoadModel(), R_LoadObjSkin(), R_LoadShader(), R_ModAddMapTile(), R_ModLoadAliasMD2Model(), R_ModLoadAnims(), R_ModLoadLevelOfDetailData(), R_ModLoadMDX(), R_PreprocessShaderR(), readFile(), S_LoadSampleChunk(), SV_InitGameProgs(), SV_LoadModelAABB(), SV_ParseMapcycle(), SV_ParseUMP(), TEST_F(), TEST_F(), TEST_F(), and TEST_F().

◆ FS_LoadPackFile()

pack_t * FS_LoadPackFile ( const char * packfile )

static

Takes an explicit (not game tree related) path to a pak file. Adding the files at the beginning of the list so they override previous pack files.

Parameters

[in] packfile The pack filename

Note: pk3 and zip are valid extensions

Definition at line 422 of file files.cpp.

References com_fileSysPool, Com_GetExtension(), Com_Printf(), unz_file_info::compressed_size, qFILE::f, packfile_t::filelen, pack_t::filename, pack_t::files, gi, pack_t::handle, i, MAX_QPATH, Mem_PoolAllocType, Mem_PoolAllocTypeN, name, pack_t::numfiles, Q_streq, Q_StringSort(), Q_strlwr(), Q_strncpyz(), UNZ_OK, unzGetCurrentFileInfo(), unzGetCurrentFileInfoPosition(), unzGetGlobalInfo(), unzGoToFirstFile(), unzGoToNextFile(), unzOpen(), and qFILE::z.

Referenced by FS_AddGameDirectory().

◆ FS_MapDefSort()

int FS_MapDefSort	(	const void *	map1,
		const void *	map2 )

static

See also: Com_MapDefSort

Definition at line 1320 of file files.cpp.

References Q_StringSort().

Referenced by FS_GetMaps().

◆ FS_NextFileFromFileList()

const char * FS_NextFileFromFileList ( const char * files )

Returns the next file that is found in the virtual filesystem identified by the given file pattern.

Parameters

[in] files The file pattern to search for. This can e.g. be "*.ogg" or "**.ufo" to also include subdirectories.

Returns: The next found filename or NULL if the end of the list was reached.

Note: Keep in mind that the list is cached and also the position in the list is not reset until you explicitly want this by calling this function with a NULL parameter for the pattern.; If you have to rebuild a file list, use FS_BuildFileList manually. Following calls will then use the new file list.

Definition at line 1081 of file files.cpp.

References Com_Printf(), linkedList_t::data, listBlock_t::files, fs_blocklist, FS_BuildFileList(), MAX_QPATH, linkedList_t::next, listBlock_t::next, and listBlock_t::path.

Referenced by Cmd_CompleteExecCommand(), FS_CheckFile(), GAME_GetImportData(), GAME_GetTeamFileName(), GAME_TeamSlotComments_f(), M_CompleteMusic(), M_RandomTrack_f(), MD2Visitor(), PrecalcNormalsAndTangentsBatch(), S_CompleteSounds(), TEST_F(), TEST_F(), and TEST_F().

◆ FS_NextPath()

const char * FS_NextPath ( const char * prevpath )

Allows enumerating all of the directories in the search path.

Note: ignore pk3 here

Definition at line 614 of file files.cpp.

References FS_Gamedir(), fs_searchpaths, and Q_streq.

Referenced by FS_Printf(), GAME_GetCGameAPI(), and SV_GetGameAPI().

◆ FS_NextScriptHeader()

char * FS_NextScriptHeader	(	const char *	files,
		const char **	name,
		const char **	text )

Definition at line 1196 of file files.cpp.

References Com_Parse(), Com_SkipBlock(), linkedList_t::data, listBlock_t::files, fs_blocklist, FS_FreeFile(), FS_LoadFile(), MAX_QPATH, MAX_VAR, name, linkedList_t::next, listBlock_t::next, listBlock_t::path, Q_streq, Q_strncpyz(), and Q_strneq.

Referenced by CL_ParseMessageIDs(), Com_ParseScripts(), FS_CheckFile(), GAME_GetImportData(), TEST_ParseScript(), and UI_Restart_f().

◆ FS_NormPath()

void FS_NormPath ( char * path )

Convert operating systems path separators to ufo virtual filesystem separators (/).

See also: Sys_NormPath

Definition at line 83 of file files.cpp.

References Sys_NormPath().

Referenced by FS_BuildFileList(), FS_ExecAutoexec(), FS_GetCwd(), FS_GetMaps(), main(), and U2M_Parameter().

◆ FS_OpenFile()

int FS_OpenFile	(	const char *	filename,
		qFILE *	file,
		filemode_t	mode )

Finds and opens the file in the search path.

Parameters

[in]	filename
[out]	file	The file pointer
[in]	mode	read, write, append as an enum

Returns: the filesize or -1 in case of an error

Note: Used for streaming data out of either a pak file or a separate file.

Definition at line 162 of file files.cpp.

References Com_Printf(), Com_sprintf(), qFILE::f, FILE_APPEND, FILE_WRITE, packfile_t::filelen, pack_t::filename, qFILE::filepos, pack_t::files, FS_CreatePath(), FS_FileLength(), FS_Gamedir(), fs_links, fs_openedFiles, FS_OpenFile(), fs_searchpaths, pack_t::handle, i, length, MAX_OSPATH, packfile_t::name, qFILE::name, pack_t::numfiles, Q_strcasecmp, Q_strncpyz(), Sys_Error(), Sys_Fopen(), unz_file_info::uncompressed_size, UNZ_OK, unzGetCurrentFileInfo(), unzGetCurrentFileInfoPosition(), unzLocateFile(), unzOpenCurrentFile(), and qFILE::z.

Referenced by ASE_Load(), CheckBSPFile(), CIN_OGM_OpenCinematic(), CIN_ROQ_OpenCinematic(), CL_LogEvent(), Com_MD5File(), Com_SHA1File(), Com_SHA2File(), Com_vPrintf(), Com_WriteConfigToFile(), Con_LoadConsoleHistory(), Con_SaveConsoleHistory(), FS_CheckFile(), FS_FileExists(), FS_LoadFile(), FS_OpenFile(), FS_WriteFile(), GAME_GetImportData(), GAME_LoadTeam(), GAME_TeamSlotComments_f(), GenerateFootstepList(), GenerateMaterialFile(), Key_WriteBindings(), MD2SkinEdit(), MD2SkinNum(), R_ScreenShot(), RT_WriteCSVFiles(), UI_EditorNodeExtract_f(), WEB_CGameDownloadFromUser(), WriteBSPFile(), WriteMapFile(), WriteTGA24(), and WriteToFile().

◆ FS_Printf()

int FS_Printf	(	qFILE *	f,
		const char *	msg,
			... )

Can print chunks for 1024 chars into a file.

Note: The file must already be opened and may not be a zip file handle

Definition at line 1497 of file files.cpp.

References f, len, and Q_vsnprintf().

Referenced by CL_LogEvent(), Cmd_WriteAliases(), Com_WriteConfigToFile(), Cvar_WriteVariables(), GenerateFootstepList(), GenerateMaterialFile(), Key_WriteBindings(), RT_WriteCSVFiles(), UI_EditorNodeExtractNode(), WriteMapBrush(), WriteMapEntities(), and WriteMapFile().

◆ FS_Read()

int FS_Read	(	void *	buffer,
		int	len,
		qFILE *	f )

Definition at line 371 of file files.cpp.

References f, FS_Read2(), and len.

Referenced by ASE_Load(), CheckBSPFile(), CIN_OGM_LoadBlockToSync(), CIN_ROQ_DecodeChunk(), CIN_ROQ_OpenCinematic(), Com_MD5File(), Com_SHA1File(), Com_SHA2File(), FS_FileExists(), FS_LoadFile(), FS_Seek(), GAME_GetImportData(), GAME_LoadTeam(), and GAME_TeamSlotComments_f().

◆ FS_Read2()

int FS_Read2	(	void *	buffer,
		int	len,
		qFILE *	f,
		bool	failOnEmptyRead )

Read a file into a given buffer in memory.

Parameters

[out]	buffer	Pointer to memory where file contents are written to.
[in]	len	The length of the supplied memory area.
[in]	f	The file which is to be read into the memory area.
[in]	failOnEmptyRead	idk Must have something to with certain readstates that can happen with removable media ?

Returns: The length of the file contents successfully read and written to memory.

Note: buffer is not null-terminated at the end of file reading; This function properly handles partial reads so check that the returned length matches len.; Reads in blocks of 64k.

See also: FS_LoadFile; FS_OpenFile

Definition at line 327 of file files.cpp.

References f, len, MAX_READ, Sys_Error(), and unzReadCurrentFile().

Referenced by Com_ReadFromPipe(), FS_FileExists(), and FS_Read().

◆ FS_RemoveFile()

void FS_RemoveFile ( const char * osPath )

See also: FS_CopyFile

Definition at line 1692 of file files.cpp.

References Com_Printf(), fs_searchpaths, Sys_Error(), and Sys_Remove().

Referenced by CL_FinishHTTPDownload(), Com_Error(), Com_Quit(), FS_FileExists(), GAME_GetImportData(), GAME_TeamDelete_f(), Key_WriteBindings(), Sys_Mkfifo(), and cgame_import_t::void().

◆ FS_RenameFile()

bool FS_RenameFile	(	const char *	from,
		const char *	to,
		bool	relative )

Renames a file.

See also: FS_RemoveFile; FS_CopyFile

Parameters

[in]	from	The source filename
[in]	to	The filename we want after the rename
[in]	relative	If relative is true we have to add the FS_Gamedir path for writing

Definition at line 1709 of file files.cpp.

References Com_sprintf(), FS_Gamedir(), fs_searchpaths, MAX_OSPATH, Sys_Error(), and Sys_Rename().

Referenced by CL_FinishHTTPDownload(), and FS_FileExists().

◆ FS_RestartFilesystem()

void FS_RestartFilesystem ( const char * gamedir )

Restart the filesystem (reload all pk3 files).

Note: Call this after you finished a download

See also: FS_Shutdown; FS_InitFilesystem

Definition at line 1643 of file files.cpp.

References Com_Printf().

Referenced by CL_FinishHTTPDownload(), and FS_Printf().

◆ FS_Seek()

int FS_Seek	(	qFILE *	f,
		long	offset,
		int	origin )

Sets the file position of the given file.

Parameters

[in]	f	The opened file handle
[in]	origin	fsOrigin_t
[in]	offset	The offset you want to do the

See also: FS_Read

Definition at line 246 of file files.cpp.

References f, FS_Read(), FS_SEEK_CUR, FS_SEEK_END, FS_SEEK_SET, PK3_SEEK_BUFFER_SIZE, SEEK_CUR, SEEK_END, SEEK_SET, Sys_Error(), unzOpenCurrentFile(), and unzSetCurrentFileInfoPosition().

◆ FS_Shutdown()

void FS_Shutdown ( void )

Cleanup function.

cleanup function

See also: FS_InitFilesystem; FS_RestartFilesystem

Definition at line 1604 of file files.cpp.

References com_fileSysPool, Com_Printf(), fs_blocklist, fs_links, fs_mapsInstalledInit, fs_numInstalledMaps, fs_openedFiles, fs_searchpaths, Mem_Free, Mem_FreePool, searchpath_t::next, and unzClose().

Referenced by FS_CheckFile(), Qcommon_Shutdown(), and TEST_Shutdown().

◆ FS_Write()

int FS_Write	(	const void *	buffer,
		int	len,
		qFILE *	f )

Properly handles partial writes.

Definition at line 1513 of file files.cpp.

References Com_Printf(), f, and len.

Referenced by AddLump(), Com_vPrintf(), Con_SaveConsoleHistory(), FS_WriteFile(), MD2SkinEdit(), MD2SkinNum(), R_WriteCompressedTGA(), WriteBSPFile(), WriteTGA24(), and WriteToFile().

◆ FS_WriteFile()

int FS_WriteFile	(	const void *	buffer,
		size_t	len,
		const char *	filename )

Definition at line 1546 of file files.cpp.

References Com_Printf(), f, FILE_WRITE, FS_FileLength(), FS_Gamedir(), FS_OpenFile(), FS_Write(), len, Sys_Remove(), and va().

Referenced by GAME_GetImportData(), GAME_SaveTeam(), MD2GLCmdsRemove(), MD2SkinFix(), and TEST_F().

Variable Documentation

◆ fs_blocklist

listBlock_t* fs_blocklist = nullptr

static

Definition at line 934 of file files.cpp.

Referenced by FS_BuildFileList(), FS_GetFileData(), FS_NextFileFromFileList(), FS_NextScriptHeader(), and FS_Shutdown().

◆ fs_links

filelink_t* fs_links

static

Definition at line 43 of file files.cpp.

Referenced by FS_OpenFile(), and FS_Shutdown().

◆ fs_maps

char* fs_maps[MAX_MAPS]

Definition at line 1313 of file files.cpp.

Referenced by FS_GetMaps(), SV_CompleteMapCommand(), and SV_ListMaps_f().

◆ fs_mapsInstalledInit

bool fs_mapsInstalledInit = false

static

Definition at line 1315 of file files.cpp.

Referenced by FS_GetMaps(), and FS_Shutdown().

◆ fs_numInstalledMaps

int fs_numInstalledMaps = -1

Definition at line 1314 of file files.cpp.

Referenced by FS_GetMaps(), FS_Shutdown(), SV_CompleteMapCommand(), and SV_ListMaps_f().

◆ fs_openedFiles

int fs_openedFiles

static

counter for opened files - used to check against missing close calls

Definition at line 42 of file files.cpp.

Referenced by FS_CloseFile(), FS_CreateOpenPipeFile(), FS_OpenFile(), and FS_Shutdown().

◆ fs_searchpaths

searchpath_t* fs_searchpaths

static

Definition at line 44 of file files.cpp.

Referenced by FS_AddGameDirectory(), FS_BuildFileList(), FS_CopyFile(), FS_CreateOpenPipeFile(), FS_Gamedir(), FS_GetMaps(), FS_NextPath(), FS_OpenFile(), FS_RemoveFile(), FS_RenameFile(), and FS_Shutdown().

◆ pakFileExt

char const* const pakFileExt[]

static

Initial value:

                                   = {
    "pk3", "zip", nullptr
}

Definition at line 485 of file files.cpp.

Referenced by FS_AddGameDirectory().

Data Structures

Macros

Functions

Variables

Detailed Description

Macro Definition Documentation

◆ MAX_PACKFILES

◆ MAX_READ

◆ MODS_DIR

◆ PK3_SEEK_BUFFER_SIZE

Function Documentation

◆ _AddToListBlock()

◆ CheckBSPFile()

◆ FS_AddGameDirectory()

◆ FS_AddHomeAsGameDirectory()

◆ FS_BuildFileList()

◆ FS_CheckFile()

◆ FS_CloseFile()

◆ FS_CopyFile()

◆ FS_CreateOpenPipeFile()

◆ FS_CreatePath()

◆ FS_FileExists()

◆ FS_FileLength()

◆ FS_FreeFile()

◆ FS_Gamedir()

◆ FS_GetCwd()

◆ FS_GetFileData()

◆ FS_GetHomeDirectory()

◆ FS_GetMaps()

◆ FS_GetModList()

◆ FS_InitFilesystem()

◆ FS_ListFiles()

◆ FS_LoadFile()

◆ FS_LoadPackFile()

◆ FS_MapDefSort()

◆ FS_NextFileFromFileList()

◆ FS_NextPath()

◆ FS_NextScriptHeader()

◆ FS_NormPath()

◆ FS_OpenFile()

◆ FS_Printf()

◆ FS_Read()

◆ FS_Read2()

◆ FS_RemoveFile()

◆ FS_RenameFile()

◆ FS_RestartFilesystem()

◆ FS_Seek()

◆ FS_Shutdown()

◆ FS_Write()

◆ FS_WriteFile()

Variable Documentation

◆ fs_blocklist

◆ fs_links

◆ fs_maps

◆ fs_mapsInstalledInit

◆ fs_numInstalledMaps

◆ fs_openedFiles

◆ fs_searchpaths

◆ pakFileExt