src/libgame/misc.h

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