UFO: Alien Invasion
Loading...
Searching...
No Matches
system.h File Reference

System specific stuff. More...

#include "../shared/cxx.h"
#include "../common/list.h"
#include <stdio.h>
Include dependency graph for system.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions

void Sys_Init (void)
void Sys_NormPath (char *path)
 Normalize path (remove all \ ).
void Sys_Sleep (int milliseconds)
 Calls the win32 sleep function.
const char * Sys_GetCurrentUser (void)
 Get current user.
int Sys_Setenv (const char *name, const char *value)
 set/unset environment variables (empty value removes it)
void Sys_InitSignals (void)
const char * Sys_SetLocale (const char *localeID)
const char * Sys_GetLocale (void)
const char * Sys_ConsoleInput (void)
 Handles input for the console window.
void Sys_ConsoleOutput (const char *string)
void Sys_Error (const char *error,...) __attribute__((noreturn
void format (__printf__, 1, 2)))
void Sys_Quit (void)
char * Sys_GetHomeDirectory (void)
 Returns the home environment variable (which hold the path of the user's homedir).
void Sys_ConsoleShutdown (void)
 Shutdown the console.
void Sys_ConsoleInit (void)
 Initialize the console input (tty mode if possible).
void Sys_ShowConsole (bool show)
char * Sys_FindFirst (const char *path, unsigned musthave, unsigned canthave)
 Opens the directory and returns the first file that matches our searchrules.
char * Sys_FindNext (unsigned musthave, unsigned canthave)
 Returns the next file of the already opened directory (Sys_FindFirst) that matches our search mask.
void Sys_FindClose (void)
 Closes the find handle.
void Sys_ListFilteredFiles (const char *basedir, const char *subdirs, const char *filter, linkedList_t **list)
void Sys_Mkdir (const char *path)
void Sys_Mkfifo (const char *ospath, struct qFILE_s *f)
char * Sys_Cwd (void)
 Get current working dir.
void Sys_SetAffinityAndPriority (void)
int Sys_Milliseconds (void)
void Sys_Backtrace (void)
 On platforms supporting it, print a backtrace.
void Sys_Breakpoint (void)
void Sys_OpenURL (const char *url)
FILE * Sys_Fopen (const char *filename, const char *mode)
int Sys_Remove (const char *filename)
int Sys_Rename (const char *oldname, const char *newname)
int Sys_Access (const char *filename, int mode)

Detailed Description

System specific stuff.

Definition in file system.h.

Function Documentation

◆ format()

void format ( __printf__ ,
1 ,
2  )

References __attribute__, format(), Sys_ConsoleInit(), Sys_ConsoleShutdown(), Sys_FindClose(), Sys_FindFirst(), Sys_FindNext(), Sys_GetHomeDirectory(), Sys_ListFilteredFiles(), Sys_Mkdir(), Sys_Quit(), and Sys_ShowConsole().

◆ Sys_Access()

int Sys_Access ( const char * filename,
int mode )

Definition at line 255 of file unix_files.cpp.

References lengthof, MAX_OSPATH, and Sys_Utf8ToUtf16().

Referenced by FS_FileExists(), and Sys_SetAffinityAndPriority().

◆ Sys_Backtrace()

void Sys_Backtrace ( void )

On platforms supporting it, print a backtrace.

Note
For windows this is not handled here - see Sys_BacktraceInit

Definition at line 102 of file android_system.cpp.

References androidDumpBacktrace(), BUILDSTRING, Com_BreakIntoDebugger(), CPUSTRING, FILE, i, Sys_Fopen(), and UFO_VERSION.

Referenced by Com_Error(), Com_SetValue(), Com_ValueToStr(), Sys_Error(), and Sys_SetAffinityAndPriority().

◆ Sys_Breakpoint()

void Sys_Breakpoint ( void )

Definition at line 84 of file unix_shared.cpp.

Referenced by Com_BreakIntoDebugger(), and Sys_SetAffinityAndPriority().

◆ Sys_ConsoleInit()

void Sys_ConsoleInit ( void )

Initialize the console input (tty mode if possible).

Definition at line 43 of file android_console.cpp.

References Com_Printf(), CONSOLE_WINDOW_CLASS_NAME, CONSOLE_WINDOW_NAME, CONSOLE_WINDOW_STYLE, global_hInstance, MAXCMDLINE, stdinActive, Sys_BacktraceInit(), sys_console, Sys_ConsoleEditProc(), Sys_ConsoleProc(), Sys_IsATTY(), Sys_ShowConsole(), Sys_TTYConsoleHistoryClear(), Sys_TTYConsoleSigCont(), TTY_eof, TTY_erase, TTY_tc, ttyConsoleActivated, and ttyConsoleHistory.

Referenced by format(), main(), SDL_main(), Sys_TTYConsoleSigCont(), and WinMain().

◆ Sys_ConsoleInput()

const char * Sys_ConsoleInput ( void )

Handles input for the console window.

Returns
nullptr if there is no input in the input box

Definition at line 47 of file android_console.cpp.

References Com_ConsoleCompleteCommand(), CON_FlushIn(), key, len, MAXCMDLINE, Q_strncpyz(), stdinActive, sys_console, Sys_ConsoleLoop(), Sys_ShowConsole(), Sys_TTYConsoleHistoryAdd(), Sys_TTYConsoleHistoryClear(), Sys_TTYConsoleHistoryNext(), Sys_TTYConsoleHistoryPrevious(), Sys_TTYDeleteCharacter(), TTY_erase, ttyConsoleActivated, and ttyConsoleHistory.

Referenced by SV_Frame().

◆ Sys_ConsoleOutput()

void Sys_ConsoleOutput ( const char * string)

Definition at line 52 of file android_console.cpp.

References len, MAX_OUTPUT, MAX_PRINTMSG, and sys_console.

Referenced by Com_vPrintf(), and Sys_Error().

◆ Sys_ConsoleShutdown()

void Sys_ConsoleShutdown ( void )

Shutdown the console.

Note
Never exit without calling this, or your terminal will be left in a pretty bad state

Definition at line 36 of file android_console.cpp.

References CONSOLE_WINDOW_CLASS_NAME, global_hInstance, Sys_BacktraceShutdown(), sys_console, Sys_TTYDeleteCharacter(), TTY_tc, and ttyConsoleActivated.

Referenced by format(), Sys_Error(), and Sys_Quit().

◆ Sys_Cwd()

char * Sys_Cwd ( void )

Get current working dir.

Returns
nullptr if getcwd failed

Definition at line 197 of file unix_files.cpp.

References lengthof, MAX_OSPATH, and Sys_Utf16ToUtf8().

Referenced by FS_GetCwd(), and Sys_Mkfifo().

◆ Sys_Error()

void Sys_Error ( const char * error,
... )

◆ Sys_FindClose()

void Sys_FindClose ( void )

Closes the find handle.

Note
Call this before calling a new Sys_FindFirst
See also
Sys_FindNext
Sys_FindFirst

Definition at line 142 of file unix_files.cpp.

References fdir, and findhandle.

Referenced by format(), and FS_ListFiles().

◆ Sys_FindFirst()

char * Sys_FindFirst ( const char * path,
unsigned musthave,
unsigned canthave )

Opens the directory and returns the first file that matches our searchrules.

See also
Sys_FindNext
Sys_FindClose

Definition at line 87 of file unix_files.cpp.

References Com_FilePath(), Com_Filter(), Com_sprintf(), CompareAttributes(), CompareAttributes(), fdir, findbase, findhandle, findname, findpath, findpattern, lengthof, Q_streq, Q_strncpyz(), Sys_Error(), Sys_Utf16ToUtf8(), Sys_Utf8ToUtf16(), and wfindpath.

Referenced by format(), and FS_ListFiles().

◆ Sys_FindNext()

char * Sys_FindNext ( unsigned musthave,
unsigned canthave )

Returns the next file of the already opened directory (Sys_FindFirst) that matches our search mask.

See also
Sys_FindClose
Sys_FindFirst
static var findpattern
Sys_FindFirst
Sys_FindClose

Definition at line 125 of file unix_files.cpp.

References Com_Filter(), Com_sprintf(), CompareAttributes(), CompareAttributes(), fdir, findbase, findhandle, findname, findpath, findpattern, Q_streq, and Sys_Utf16ToUtf8().

Referenced by format(), and FS_ListFiles().

◆ Sys_Fopen()

FILE * Sys_Fopen ( const char * filename,
const char * mode )

Definition at line 240 of file unix_files.cpp.

References FILE, lengthof, MAX_OSPATH, MAX_VAR, and Sys_Utf8ToUtf16().

Referenced by CL_CheckAndQueueDownload(), CL_StartHTTPDownload(), fopen_file_func(), FS_CopyFile(), FS_OpenFile(), main(), SV_InitGameProgs(), Sys_Backtrace(), Sys_Mkfifo(), and Sys_SetAffinityAndPriority().

◆ Sys_GetCurrentUser()

const char * Sys_GetCurrentUser ( void )

Get current user.

Definition at line 44 of file android_system.cpp.

References lengthof, MAX_VAR, Q_strncpyz(), Sys_Utf16ToUtf8(), and user.

Referenced by CL_InitLocal(), and WEB_InitStartup().

◆ Sys_GetHomeDirectory()

char * Sys_GetHomeDirectory ( void )

Returns the home environment variable (which hold the path of the user's homedir).

Returns the home environment variable (which hold the path of the user's homedir).

Note
Forced for Windows Vista
Use the cvar fs_usehomedir if you want to use the homedir for other Windows versions, too

Definition at line 45 of file unix_files.cpp.

References Com_Printf(), Q_strcat(), Sys_Utf16ToUtf8(), and Sys_Utf8ToUtf16().

Referenced by format(), and FS_GetHomeDirectory().

◆ Sys_GetLocale()

const char * Sys_GetLocale ( void )

Definition at line 156 of file win_shared.cpp.

Referenced by CL_LanguageInit().

◆ Sys_Init()

void Sys_Init ( void )

Definition at line 39 of file android_main.cpp.

References Com_Printf(), CVAR_ARCHIVE, Cvar_Get(), CVAR_SERVERINFO, sys_affinity, Sys_Error(), sys_os, and sys_priority.

Referenced by Qcommon_Init().

◆ Sys_InitSignals()

void Sys_InitSignals ( void )

Definition at line 182 of file unix_shared.cpp.

Referenced by main(), and Qcommon_Init().

◆ Sys_ListFilteredFiles()

void Sys_ListFilteredFiles ( const char * basedir,
const char * subdirs,
const char * filter,
linkedList_t ** list )

Definition at line 151 of file unix_files.cpp.

References Com_Filter(), Com_sprintf(), findhandle, findname, lengthof, LIST_AddString(), MAX_OSPATH, Q_strcasecmp, Sys_ListFilteredFiles(), Sys_Utf16ToUtf8(), Sys_Utf8ToUtf16(), and wfindpath.

Referenced by format(), FS_BuildFileList(), and Sys_ListFilteredFiles().

◆ Sys_Milliseconds()

int Sys_Milliseconds ( void )

Definition at line 41 of file unix_shared.cpp.

Referenced by CL_Frame(), CL_InitLocal(), Qcommon_Frame(), Schedule_Timer(), SCR_TimeRefresh_f(), CampaignTest::SetUpTestCase(), SV_InitGameProgs(), SVC_BucketForAddress(), SVC_RateLimit(), Sys_SetAffinityAndPriority(), TEST_F(), TEST_F(), RandomMapAssemblyTest::testAssembly(), GameTest::testCountSpawnpointsForMapInMultiplayerMode(), GameTest::testCountSpawnpointsForMapInSingleplayerMode(), and tick_timer().

◆ Sys_Mkdir()

void Sys_Mkdir ( const char * path)

Definition at line 208 of file unix_files.cpp.

References Com_Printf(), lengthof, MAX_OSPATH, and Sys_Utf8ToUtf16().

Referenced by format(), and FS_CreatePath().

◆ Sys_Mkfifo()

void Sys_Mkfifo ( const char * ospath,
struct qFILE_s * f )

References f, Sys_Cwd(), and Sys_Mkfifo().

Referenced by FS_CreateOpenPipeFile(), and Sys_Mkfifo().

◆ Sys_NormPath()

void Sys_NormPath ( char * path)

Normalize path (remove all \ ).

Definition at line 50 of file unix_files.cpp.

Referenced by FS_NormPath().

◆ Sys_OpenURL()

void Sys_OpenURL ( const char * url)

Definition at line 196 of file unix_shared.cpp.

References Com_sprintf().

Referenced by CL_OpenURL_f(), and Sys_SetAffinityAndPriority().

◆ Sys_Quit()

void Sys_Quit ( void )
See also
Qcommon_Shutdown

Definition at line 86 of file android_system.cpp.

References CL_Shutdown(), Mem_Shutdown(), Qcommon_Shutdown(), and Sys_ConsoleShutdown().

Referenced by Com_Quit(), format(), Sys_ConsoleLoop(), and Sys_ConsoleProc().

◆ Sys_Remove()

int Sys_Remove ( const char * filename)

Definition at line 245 of file unix_files.cpp.

References lengthof, MAX_OSPATH, and Sys_Utf8ToUtf16().

Referenced by CL_HTTP_Cleanup(), FS_RemoveFile(), FS_WriteFile(), and Sys_SetAffinityAndPriority().

◆ Sys_Rename()

int Sys_Rename ( const char * oldname,
const char * newname )

Definition at line 250 of file unix_files.cpp.

References lengthof, MAX_OSPATH, and Sys_Utf8ToUtf16().

Referenced by FS_RenameFile(), and Sys_SetAffinityAndPriority().

◆ Sys_SetAffinityAndPriority()

void Sys_SetAffinityAndPriority ( void )

References FILE, Sys_Access(), Sys_Backtrace(), Sys_Breakpoint(), Sys_Fopen(), Sys_Milliseconds(), Sys_OpenURL(), Sys_Remove(), Sys_Rename(), and Sys_SetAffinityAndPriority().

Referenced by CL_Frame(), and Sys_SetAffinityAndPriority().

◆ Sys_Setenv()

int Sys_Setenv ( const char * name,
const char * value )

set/unset environment variables (empty value removes it)

Returns
nonzero if succeeds
Note
gettext FAQ recommends using both functions to set environment variable(s), so we do

Definition at line 60 of file unix_shared.cpp.

References name.

Referenced by CL_Env_f(), CL_LanguageTest(), Rimp_Init(), and Sys_SetLocale().

◆ Sys_SetLocale()

const char * Sys_SetLocale ( const char * localeID)

Definition at line 147 of file win_shared.cpp.

References Sys_Setenv().

Referenced by CL_LanguageTryToSet().

◆ Sys_ShowConsole()

void Sys_ShowConsole ( bool show)

Definition at line 32 of file android_console.cpp.

References sys_console, Sys_TTYConsoleHide(), Sys_TTYConsoleShow(), and ttyConsoleActivated.

Referenced by format(), Qcommon_Init(), Sys_ConsoleInit(), Sys_ConsoleInput(), and Sys_Error().

◆ Sys_Sleep()

void Sys_Sleep ( int milliseconds)

Calls the win32 sleep function.

Definition at line 68 of file unix_shared.cpp.

References long().

Referenced by M_MusicStreamCallback(), NET_Wait(), R_RenderFrame(), R_RunThread(), and Sys_Error().