sys.h

   1 /*
   2 Copyright (C) 1996-1997 Id Software, Inc.
   3
   4 This program is free software; you can redistribute it and/or
   5 modify it under the terms of the GNU General Public License
   6 as published by the Free Software Foundation; either version 2
   7 of the License, or (at your option) any later version.
   8
   9 This program is distributed in the hope that it will be useful,
  10 but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  12
  13 See the GNU General Public License for more details.
  14
  15 You should have received a copy of the GNU General Public License
  16 along with this program; if not, write to the Free Software
  17 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  18
  19 */
  20 // sys.h -- non-portable functions
  21
  22 #ifndef SYS_H
  23 #define SYS_H
  24
  25 typedef struct sys_s
  26 {
  27         int argc;
  28         const char **argv;
  29         int selffd;
  30         int outfd;
  31         int nicelevel;
  32         qboolean nicepossible;
  33         qboolean isnice;
  34 } sys_t;
  35
  36 extern sys_t sys;
  37
  38 extern cvar_t sys_usenoclockbutbenchmark;
  39
  40 //
  41 // DLL management
  42 //
  43
  44 // Win32 specific
  45 #ifdef WIN32
  46 # include <windows.h>
  47 typedef HMODULE dllhandle_t;
  48
  49 // Other platforms
  50 #else
  51   typedef void* dllhandle_t;
  52 #endif
  53
  54 typedef struct dllfunction_s
  55 {
  56         const char *name;
  57         void **funcvariable;
  58 }
  59 dllfunction_t;
  60
  61 /*! Loads a library.
  62  * \param dllnames a NULL terminated array of possible names for the DLL you want to load.
  63  * \param handle
  64  * \param fcts
  65  */
  66 qboolean Sys_LoadLibrary (const char** dllnames, dllhandle_t* handle, const dllfunction_t *fcts);
  67 void Sys_UnloadLibrary (dllhandle_t* handle);
  68 void* Sys_GetProcAddress (dllhandle_t handle, const char* name);
  69
  70 int Sys_CheckParm (const char *parm);
  71
  72 /// called early in Host_Init
  73 void Sys_InitConsole (void);
  74 /// called after command system is initialized but before first Con_Print
  75 void Sys_Init_Commands (void);
  76
  77
  78 /// \returns current timestamp
  79 char *Sys_TimeString(const char *timeformat);
  80
  81 //
  82 // system IO interface (these are the sys functions that need to be implemented in a new driver atm)
  83 //
  84
  85 /// an error will cause the entire program to exit
  86 void Sys_Error (const char *error, ...) DP_FUNC_PRINTF(1) DP_FUNC_NORETURN;
  87
  88 /// (may) output text to terminal which launched program
  89 void Sys_PrintToTerminal(const char *text);
  90 void Sys_PrintfToTerminal(const char *fmt, ...);
  91
  92 /// INFO: This is only called by Host_Shutdown so we dont need testing for recursion
  93 void Sys_Shutdown (void);
  94 void Sys_Quit (int returnvalue);
  95
  96 /*! on some build/platform combinations (such as Linux gcc with the -pg
  97  * profiling option) this can turn on/off profiling, used primarily to limit
  98  * profiling to certain areas of the code, such as ingame performance without
  99  * regard for loading/shutdown performance (-profilegameonly on commandline)
 100  */
 101 #ifdef __cplusplus
 102 extern "C"
 103 #endif
 104 void Sys_AllowProfiling (qboolean enable);
 105
 106 typedef struct sys_cleantime_s
 107 {
 108         double dirtytime; // last value gotten from Sys_DirtyTime()
 109         double cleantime; // sanitized linearly increasing time since app start
 110 }
 111 sys_cleantime_t;
 112
 113 double Sys_DirtyTime(void);
 114
 115 void Sys_ProvideSelfFD (void);
 116
 117 char *Sys_ConsoleInput (void);
 118
 119 /// called to yield for a little bit so as not to hog cpu when paused or debugging
 120 void Sys_Sleep(int microseconds);
 121
 122 /// Perform Key_Event () callbacks until the input que is empty
 123 void Sys_SendKeyEvents (void);
 124
 125 char *Sys_GetClipboardData (void);
 126
 127 extern qboolean sys_supportsdlgetticks;
 128 unsigned int Sys_SDL_GetTicks (void); // wrapper to call SDL_GetTicks
 129 void Sys_SDL_Delay (unsigned int milliseconds); // wrapper to call SDL_Delay
 130
 131 /// called to set process priority for dedicated servers
 132 void Sys_InitProcessNice (void);
 133 void Sys_MakeProcessNice (void);
 134 void Sys_MakeProcessMean (void);
 135
 136 #endif
 137