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
  26 //
  27 // DLL management
  28 //
  29
  30 // Win32 specific
  31 #ifdef WIN32
  32 # include <windows.h>
  33 typedef HMODULE dllhandle_t;
  34
  35 // Other platforms
  36 #else
  37   typedef void* dllhandle_t;
  38 #endif
  39
  40 typedef struct dllfunction_s
  41 {
  42         const char *name;
  43         void **funcvariable;
  44 }
  45 dllfunction_t;
  46
  47 /*! Loads a library.
  48  * \param dllnames a NULL terminated array of possible names for the DLL you want to load.
  49  * \param handle
  50  * \param fcts
  51  */
  52 qboolean Sys_LoadLibrary (const char** dllnames, dllhandle_t* handle, const dllfunction_t *fcts);
  53 void Sys_UnloadLibrary (dllhandle_t* handle);
  54 void* Sys_GetProcAddress (dllhandle_t handle, const char* name);
  55
  56 /// called early in Host_Init
  57 void Sys_InitConsole (void);
  58 /// called after command system is initialized but before first Con_Print
  59 void Sys_Init_Commands (void);
  60
  61
  62 /// \returns current timestamp
  63 char *Sys_TimeString(const char *timeformat);
  64
  65 //
  66 // system IO interface (these are the sys functions that need to be implemented in a new driver atm)
  67 //
  68
  69 /// an error will cause the entire program to exit
  70 void Sys_Error (const char *error, ...) DP_FUNC_PRINTF(1);
  71
  72 /// (may) output text to terminal which launched program
  73 void Sys_PrintToTerminal(const char *text);
  74
  75 /// INFO: This is only called by Host_Shutdown so we dont need testing for recursion
  76 void Sys_Shutdown (void);
  77 void Sys_Quit (int returnvalue);
  78
  79 /*! on some build/platform combinations (such as Linux gcc with the -pg
  80  * profiling option) this can turn on/off profiling, used primarily to limit
  81  * profiling to certain areas of the code, such as ingame performance without
  82  * regard for loading/shutdown performance (-profilegameonly on commandline)
  83  */
  84 void Sys_AllowProfiling (qboolean enable);
  85
  86 double Sys_DoubleTime (void);
  87
  88 char *Sys_ConsoleInput (void);
  89
  90 /// called to yield for a little bit so as not to hog cpu when paused or debugging
  91 void Sys_Sleep(int microseconds);
  92
  93 /// Perform Key_Event () callbacks until the input que is empty
  94 void Sys_SendKeyEvents (void);
  95
  96 char *Sys_GetClipboardData (void);
  97
  98 #endif
  99