src/libgame/misc.h

   1 /***********************************************************
   2 * Artsoft Retro-Game Library                               *
   3 *----------------------------------------------------------*
   4 * (c) 1994-2006 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 #define RANDOM_ENGINE                   0
  31 #define RANDOM_SIMPLE                   1
  32
  33 #define InitEngineRandom(seed)          init_random_number(RANDOM_ENGINE, seed)
  34 #define InitSimpleRandom(seed)          init_random_number(RANDOM_SIMPLE, seed)
  35 #define GetEngineRandom(max)            get_random_number(RANDOM_ENGINE, max)
  36 #define GetSimpleRandom(max)            get_random_number(RANDOM_SIMPLE, max)
  37
  38 /* values for Error() */
  39 #define ERR_INFO                        0
  40 #define ERR_INFO_LINE                   (1 << 0)
  41 #define ERR_WARN                        (1 << 1)
  42 #define ERR_EXIT                        (1 << 2)
  43 #define ERR_HELP                        (1 << 3)
  44 #define ERR_SOUND_SERVER                (1 << 4)
  45 #define ERR_NETWORK_SERVER              (1 << 5)
  46 #define ERR_NETWORK_CLIENT              (1 << 6)
  47 #define ERR_FROM_SERVER                 (ERR_SOUND_SERVER | ERR_NETWORK_SERVER)
  48 #define ERR_EXIT_HELP                   (ERR_EXIT | ERR_HELP)
  49 #define ERR_EXIT_SOUND_SERVER           (ERR_EXIT | ERR_SOUND_SERVER)
  50 #define ERR_EXIT_NETWORK_SERVER         (ERR_EXIT | ERR_NETWORK_SERVER)
  51 #define ERR_EXIT_NETWORK_CLIENT         (ERR_EXIT | ERR_NETWORK_CLIENT)
  52
  53 /* values for getFile...() and putFile...() */
  54 #define BYTE_ORDER_BIG_ENDIAN           0
  55 #define BYTE_ORDER_LITTLE_ENDIAN        1
  56
  57 /* values for cursor bitmap creation */
  58 #define BIT_ORDER_MSB                   0
  59 #define BIT_ORDER_LSB                   1
  60
  61 /* values for createDirectory() */
  62 #define PERMS_PRIVATE                   0
  63 #define PERMS_PUBLIC                    1
  64
  65 /* values for general file handling stuff */
  66 #define MAX_FILENAME_LEN                256
  67 #define MAX_LINE_LEN                    1024
  68
  69 /* values for general username handling stuff */
  70 #define MAX_USERNAME_LEN                1024
  71
  72
  73 void fprintf_line(FILE *, char *, int);
  74 void printf_line(char *, int);
  75 void printf_line_with_prefix(char *, char *, int);
  76 char *int2str(int, int);
  77 char *i_to_a(unsigned int);
  78 int log_2(unsigned int);
  79
  80 boolean getTokenValueFromString(char *, char **, char **);
  81
  82 void InitCounter(void);
  83 unsigned long Counter(void);
  84 void Delay(unsigned long);
  85 boolean FrameReached(unsigned long *, unsigned long);
  86 boolean DelayReached(unsigned long *, unsigned long);
  87 void WaitUntilDelayReached(unsigned long *, unsigned long);
  88
  89 unsigned int init_random_number(int, long);
  90 unsigned int get_random_number(int, int);
  91
  92 char *getLoginName(void);
  93 char *getRealName(void);
  94
  95 char *getBasePath(char *);
  96 char *getBaseName(char *);
  97 char *getBaseNamePtr(char *);
  98
  99 char *getStringCat2WithSeparator(char *, char *, char *);
 100 char *getStringCat3WithSeparator(char *, char *, char *, char *);
 101 char *getStringCat2(char *, char *);
 102 char *getStringCat3(char *, char *, char *);
 103 char *getPath2(char *, char *);
 104 char *getPath3(char *, char *, char*);
 105 char *getStringCopy(char *);
 106 char *getStringCopyN(char *, int);
 107 char *getStringToLower(char *);
 108 void setString(char **, char *);
 109 boolean strEqual(char *, char *);
 110 boolean strEqualN(char *, char *, int);
 111 boolean strPrefix(char *, char *);
 112 boolean strSuffix(char *, char *);
 113
 114 void GetOptions(char **, void (*print_usage_function)(void));
 115
 116 void SetError(char *, ...);
 117 char *GetError(void);
 118 void Error(int, char *, ...);
 119
 120 void *checked_malloc(unsigned long);
 121 void *checked_calloc(unsigned long);
 122 void *checked_realloc(void *, unsigned long);
 123 void checked_free(void *);
 124 void clear_mem(void *, unsigned long);
 125
 126 void swap_numbers(int *, int *);
 127 void swap_number_pairs(int *, int *, int *, int *);
 128
 129 int getFile8BitInteger(FILE *);
 130 int putFile8BitInteger(FILE *, int);
 131 int getFile16BitInteger(FILE *, int);
 132 int putFile16BitInteger(FILE *, int, int);
 133 int getFile32BitInteger(FILE *, int);
 134 int putFile32BitInteger(FILE *, int, int);
 135
 136 boolean getFileChunk(FILE *, char *, int *, int);
 137 int putFileChunk(FILE *, char *, int, int);
 138 int getFileVersion(FILE *);
 139 int putFileVersion(FILE *, int);
 140
 141 void ReadBytesFromFile(FILE *, byte *, unsigned long);
 142 void WriteBytesToFile(FILE *, byte *, unsigned long);
 143
 144 void ReadUnusedBytesFromFile(FILE *, unsigned long);
 145 void WriteUnusedBytesToFile(FILE *, unsigned long);
 146
 147 #define getFile8Bit(f)        getFile8BitInteger(f)
 148 #define putFile8Bit(f,x)      putFile8BitInteger(f,x)
 149 #define getFile16BitBE(f)     getFile16BitInteger(f,BYTE_ORDER_BIG_ENDIAN)
 150 #define getFile16BitLE(f)     getFile16BitInteger(f,BYTE_ORDER_LITTLE_ENDIAN)
 151 #define putFile16BitBE(f,x)   putFile16BitInteger(f,x,BYTE_ORDER_BIG_ENDIAN)
 152 #define putFile16BitLE(f,x)   putFile16BitInteger(f,x,BYTE_ORDER_LITTLE_ENDIAN)
 153 #define getFile32BitBE(f)     getFile32BitInteger(f,BYTE_ORDER_BIG_ENDIAN)
 154 #define getFile32BitLE(f)     getFile32BitInteger(f,BYTE_ORDER_LITTLE_ENDIAN)
 155 #define putFile32BitBE(f,x)   putFile32BitInteger(f,x,BYTE_ORDER_BIG_ENDIAN)
 156 #define putFile32BitLE(f,x)   putFile32BitInteger(f,x,BYTE_ORDER_LITTLE_ENDIAN)
 157
 158 #define getFileChunkBE(f,s,x) getFileChunk(f,s,x,BYTE_ORDER_BIG_ENDIAN)
 159 #define getFileChunkLE(f,s,x) getFileChunk(f,s,x,BYTE_ORDER_LITTLE_ENDIAN)
 160 #define putFileChunkBE(f,s,x) putFileChunk(f,s,x,BYTE_ORDER_BIG_ENDIAN)
 161 #define putFileChunkLE(f,s,x) putFileChunk(f,s,x,BYTE_ORDER_LITTLE_ENDIAN)
 162
 163 char *getKeyNameFromKey(Key);
 164 char *getX11KeyNameFromKey(Key);
 165 Key getKeyFromKeyName(char *);
 166 Key getKeyFromX11KeyName(char *);
 167 char getCharFromKey(Key);
 168 char getValidConfigValueChar(char);
 169
 170 int get_integer_from_string(char *);
 171 boolean get_boolean_from_string(char *);
 172 int get_switch3_from_string(char *);
 173
 174 ListNode *newListNode(void);
 175 void addNodeToList(ListNode **, char *, void *);
 176 void deleteNodeFromList(ListNode **, char *, void (*function)(void *));
 177 ListNode *getNodeFromKey(ListNode *, char *);
 178 int getNumNodes(ListNode *);
 179
 180 boolean fileExists(char *);
 181 boolean FileIsGraphic(char *);
 182 boolean FileIsSound(char *);
 183 boolean FileIsMusic(char *);
 184 boolean FileIsArtworkType(char *, int);
 185
 186 char *get_mapped_token(char *);
 187
 188 int get_parameter_value(char *, char *, int);
 189
 190 struct ScreenModeInfo *get_screen_mode_from_string(char *);
 191 void get_aspect_ratio_from_screen_mode(struct ScreenModeInfo *, int *x, int *y);
 192
 193 struct FileInfo *getFileListFromConfigList(struct ConfigInfo *,
 194                                            struct ConfigTypeInfo *,
 195                                            char **, int);
 196 void LoadArtworkConfig(struct ArtworkListInfo *);
 197 void ReloadCustomArtworkList(struct ArtworkListInfo *);
 198 void FreeCustomArtworkLists(struct ArtworkListInfo *);
 199
 200 char *getErrorFilename(char *);
 201 void openErrorFile();
 202 void closeErrorFile();
 203 void dumpErrorFile();
 204 void NotifyUserAboutErrorFile();
 205
 206 void debug_print_timestamp(int, char *);
 207
 208 #endif /* MISC_H */