src/libgame/misc.h

   1 /***********************************************************
   2 * Artsoft Retro-Game Library                               *
   3 *----------------------------------------------------------*
   4 * (c) 1994-2001 Artsoft Entertainment                      *
   5 *               Holger Schemel                             *
   6 *               Detmolder Strasse 189                      *
   7 *               33604 Bielefeld                            *
   8 *               Germany                                    *
   9 *               e-mail: info@artsoft.org                   *
  10 *----------------------------------------------------------*
  11 * misc.h                                                   *
  12 ***********************************************************/
  13
  14 #ifndef MISC_H
  15 #define MISC_H
  16
  17 #include <stdlib.h>
  18 #include <stdio.h>
  19
  20 #include "system.h"
  21
  22
  23 /* values for InitCounter() and Counter() */
  24 #define INIT_COUNTER                    0
  25 #define READ_COUNTER                    1
  26
  27 /* values for InitRND() */
  28 #define NEW_RANDOMIZE                   -1
  29
  30 /* values for Error() */
  31 #define ERR_RETURN                      0
  32 #define ERR_WARN                        (1 << 0)
  33 #define ERR_EXIT                        (1 << 1)
  34 #define ERR_HELP                        (1 << 2)
  35 #define ERR_SOUND_SERVER                (1 << 3)
  36 #define ERR_NETWORK_SERVER              (1 << 4)
  37 #define ERR_NETWORK_CLIENT              (1 << 5)
  38 #define ERR_FROM_SERVER                 (ERR_SOUND_SERVER | ERR_NETWORK_SERVER)
  39 #define ERR_EXIT_HELP                   (ERR_EXIT | ERR_HELP)
  40 #define ERR_EXIT_SOUND_SERVER           (ERR_EXIT | ERR_SOUND_SERVER)
  41 #define ERR_EXIT_NETWORK_SERVER         (ERR_EXIT | ERR_NETWORK_SERVER)
  42 #define ERR_EXIT_NETWORK_CLIENT         (ERR_EXIT | ERR_NETWORK_CLIENT)
  43
  44 /* values for getFile...() and putFile...() */
  45 #define BYTE_ORDER_BIG_ENDIAN           0
  46 #define BYTE_ORDER_LITTLE_ENDIAN        1
  47
  48 void InitCounter(void);
  49 unsigned long Counter(void);
  50 void Delay(unsigned long);
  51 boolean FrameReached(unsigned long *, unsigned long);
  52 boolean DelayReached(unsigned long *, unsigned long);
  53 void WaitUntilDelayReached(unsigned long *, unsigned long);
  54 char *int2str(int, int);
  55 unsigned int SimpleRND(unsigned int);
  56 unsigned int RND(unsigned int);
  57 unsigned int InitRND(long);
  58 char *getLoginName(void);
  59 char *getRealName(void);
  60 char *getHomeDir(void);
  61 char *getPath2(char *, char *);
  62 char *getPath3(char *, char *, char*);
  63 char *getStringCopy(char *);
  64 char *getStringToLower(char *);
  65 void GetOptions(char **);
  66 void Error(int, char *, ...);
  67 void *checked_malloc(unsigned long);
  68 void *checked_calloc(unsigned long);
  69 void *checked_realloc(void *, unsigned long);
  70 short getFile16BitInteger(FILE *, int);
  71 void putFile16BitInteger(FILE *, short, int);
  72 int getFile32BitInteger(FILE *, int);
  73 void putFile32BitInteger(FILE *, int, int);
  74 boolean getFileChunk(FILE *, char *, int *, int);
  75 void putFileChunk(FILE *, char *, int, int);
  76 char *getKeyNameFromKey(Key);
  77 char *getX11KeyNameFromKey(Key);
  78 Key getKeyFromX11KeyName(char *);
  79 char getCharFromKey(Key);
  80 char *getJoyNameFromJoySymbol(int);
  81 int getJoySymbolFromJoyName(char *);
  82 int getJoystickNrFromDeviceName(char *);
  83
  84 struct LevelDirInfo *newLevelDirInfo();
  85 void pushLevelDirInfo(struct LevelDirInfo **, struct LevelDirInfo *);
  86 int numLevelDirInfo(struct LevelDirInfo *);
  87 boolean validLevelSeries(struct LevelDirInfo *);
  88 struct LevelDirInfo *getFirstValidLevelSeries(struct LevelDirInfo *);
  89 struct LevelDirInfo *getLevelDirInfoFirstGroupEntry(struct LevelDirInfo *);
  90 int numLevelDirInfoInGroup(struct LevelDirInfo *);
  91 int posLevelDirInfo(struct LevelDirInfo *);
  92 struct LevelDirInfo *getLevelDirInfoFromPos(struct LevelDirInfo *, int);
  93 struct LevelDirInfo *getLevelDirInfoFromFilename(char *);
  94 void dumpLevelDirInfo(struct LevelDirInfo *, int);
  95 void sortLevelDirInfo(struct LevelDirInfo **,
  96                       int (*compare_function)(const void *, const void *));
  97
  98 inline void swap_numbers(int *, int *);
  99 inline void swap_number_pairs(int *, int *, int *, int *);
 100
 101 char *getUserDataDir(void);
 102 void createDirectory(char *, char *);
 103 void InitUserDataDirectory(void);
 104 void SetFilePermissions_Level(char *);
 105 void SetFilePermissions_Tape(char *);
 106 void SetFilePermissions_Score(char *);
 107 void SetFilePermissions_Setup(char *);
 108
 109 #if !defined(PLATFORM_UNIX)
 110 void initErrorFile();
 111 FILE *openErrorFile();
 112 void dumpErrorFile();
 113 #endif
 114
 115 void debug_print_timestamp(int, char *);
 116
 117 #endif /* MISC_H */