src/libgame/misc.h

   1 // ============================================================================
   2 // Artsoft Retro-Game Library
   3 // ----------------------------------------------------------------------------
   4 // (c) 1995-2014 by Artsoft Entertainment
   5 //                  Holger Schemel
   6 //                  info@artsoft.org
   7 //                  https://www.artsoft.org/
   8 // ----------------------------------------------------------------------------
   9 // misc.h
  10 // ============================================================================
  11
  12 #ifndef MISC_H
  13 #define MISC_H
  14
  15 #include <stdlib.h>
  16 #include <stdio.h>
  17 #include <dirent.h>
  18
  19 #include "system.h"
  20
  21
  22 // values for InitCounter() and Counter()
  23 #define INIT_COUNTER                    0
  24 #define READ_COUNTER                    1
  25
  26 // values for InitRND()
  27 #define NEW_RANDOMIZE                   0
  28
  29 #define RANDOM_ENGINE                   0
  30 #define RANDOM_SIMPLE                   1
  31
  32 #define InitEngineRandom(seed)          init_random_number(RANDOM_ENGINE, seed)
  33 #define InitSimpleRandom(seed)          init_random_number(RANDOM_SIMPLE, seed)
  34 #define GetEngineRandom(max)            get_random_number(RANDOM_ENGINE, max)
  35 #define GetSimpleRandom(max)            get_random_number(RANDOM_SIMPLE, max)
  36
  37 // values for Error()
  38 #define ERR_UNKNOWN                     0
  39 #define ERR_DEBUG                       (1 << 0)
  40 #define ERR_INFO                        (1 << 1)
  41 #define ERR_INFO_LINE                   (1 << 2)
  42 #define ERR_WARN                        (1 << 3)
  43 #define ERR_EXIT                        (1 << 4)
  44 #define ERR_HELP                        (1 << 5)
  45 #define ERR_SOUND_SERVER                (1 << 6)
  46 #define ERR_NETWORK_SERVER              (1 << 7)
  47 #define ERR_NETWORK_CLIENT              (1 << 8)
  48 #define ERR_FROM_SERVER                 (ERR_SOUND_SERVER | ERR_NETWORK_SERVER)
  49 #define ERR_EXIT_HELP                   (ERR_EXIT | ERR_HELP)
  50 #define ERR_EXIT_SOUND_SERVER           (ERR_EXIT | ERR_SOUND_SERVER)
  51 #define ERR_EXIT_NETWORK_SERVER         (ERR_EXIT | ERR_NETWORK_SERVER)
  52 #define ERR_EXIT_NETWORK_CLIENT         (ERR_EXIT | ERR_NETWORK_CLIENT)
  53
  54 // values for getFile...() and putFile...()
  55 #define BYTE_ORDER_BIG_ENDIAN           0
  56 #define BYTE_ORDER_LITTLE_ENDIAN        1
  57
  58 // values for cursor bitmap creation
  59 #define BIT_ORDER_MSB                   0
  60 #define BIT_ORDER_LSB                   1
  61
  62 // values for createDirectory()
  63 #define PERMS_PRIVATE                   0
  64 #define PERMS_PUBLIC                    1
  65
  66 // values for general file handling stuff
  67 #define MAX_FILENAME_LEN                256
  68 #define MAX_LINE_LEN                    1024
  69
  70 // values for general username handling stuff
  71 #define MAX_USERNAME_LEN                1024
  72
  73 #if defined(PLATFORM_ANDROID)
  74 // values for Android asset handling
  75 #define ASSET_TOC_BASENAME              ".toc"
  76 #endif
  77
  78
  79 // structure definitions
  80
  81 typedef struct
  82 {
  83   char *filename;
  84   FILE *file;
  85   boolean end_of_file;
  86
  87 #if defined(PLATFORM_ANDROID)
  88   boolean file_is_asset;
  89   SDL_RWops *asset_file;
  90 #endif
  91 } File;
  92
  93 typedef struct
  94 {
  95   boolean is_directory;
  96   char *basename;
  97   char *filename;
  98 } DirectoryEntry;
  99
 100 typedef struct
 101 {
 102   char *filename;
 103   DIR *dir;
 104   DirectoryEntry *dir_entry;
 105
 106 #if defined(PLATFORM_ANDROID)
 107   boolean directory_is_asset;
 108   SDL_RWops *asset_toc_file;
 109   char *current_entry;
 110 #endif
 111 } Directory;
 112
 113
 114 // function definitions
 115
 116 void fprintf_line(FILE *, char *, int);
 117 void fprintf_line_with_prefix(FILE *, char *, char *, int);
 118 void printf_line(char *, int);
 119 void printf_line_with_prefix(char *, char *, int);
 120
 121 void Print(char *, ...);
 122 void PrintNoLog(char *, ...);
 123 void PrintLine(char *, int);
 124 void PrintLineWithPrefix(char *, char *, int);
 125
 126 void Debug(char *, char *, ...);
 127 void Info(char *, ...);
 128 void Warn(char *, ...);
 129 void Fail(char *, ...);
 130 void FailWithHelp(char *, ...);
 131
 132 char *int2str(int, int);
 133 char *i_to_a(unsigned int);
 134 int log_2(unsigned int);
 135
 136 boolean getTokenValueFromString(char *, char **, char **);
 137
 138 void InitCounter(void);
 139 unsigned int Counter(void);
 140 void Delay(unsigned int);
 141 boolean DelayReachedExt(unsigned int *, unsigned int, unsigned int);
 142 boolean FrameReached(unsigned int *, unsigned int);
 143 boolean DelayReached(unsigned int *, unsigned int);
 144 void ResetDelayCounterExt(unsigned int *, unsigned int);
 145 void ResetFrameCounter(unsigned int *);
 146 void ResetDelayCounter(unsigned int *);
 147 int WaitUntilDelayReached(unsigned int *, unsigned int);
 148 void SkipUntilDelayReached(unsigned int *, unsigned int, int *, int);
 149
 150 unsigned int init_random_number(int, int);
 151 unsigned int get_random_number(int, int);
 152
 153 char *getLoginName(void);
 154 char *getRealName(void);
 155
 156 time_t getFileTimestampEpochSeconds(char *);
 157
 158 char *getBasePath(char *);
 159 char *getBaseName(char *);
 160 char *getBaseNamePtr(char *);
 161 char *getBaseNameNoSuffix(char *);
 162
 163 char *getStringCat2WithSeparator(char *, char *, char *);
 164 char *getStringCat3WithSeparator(char *, char *, char *, char *);
 165 char *getStringCat2(char *, char *);
 166 char *getStringCat3(char *, char *, char *);
 167 char *getPath2(char *, char *);
 168 char *getPath3(char *, char *, char*);
 169 char *getImg2(char *, char *);
 170 char *getImg3(char *, char *, char*);
 171 char *getStringCopy(const char *);
 172 char *getStringCopyN(const char *, int);
 173 char *getStringCopyNStatic(const char *, int);
 174 char *getStringToLower(const char *);
 175 void setString(char **, char *);
 176 boolean strEqual(char *, char *);
 177 boolean strEqualN(char *, char *, int);
 178 boolean strPrefix(char *, char *);
 179 boolean strSuffix(char *, char *);
 180 boolean strPrefixLower(char *, char *);
 181 boolean strSuffixLower(char *, char *);
 182
 183 void GetOptions(int, char **,
 184                 void (*print_usage_function)(void),
 185                 void (*print_version_function)(void));
 186
 187 void SetError(char *, ...);
 188 char *GetError(void);
 189 void Error(int, char *, ...);
 190
 191 void *checked_malloc(unsigned int);
 192 void *checked_calloc(unsigned int);
 193 void *checked_realloc(void *, unsigned int);
 194 void checked_free(void *);
 195 void clear_mem(void *, unsigned int);
 196
 197 void swap_numbers(int *, int *);
 198 void swap_number_pairs(int *, int *, int *, int *);
 199
 200 int getFile8BitInteger(File *);
 201 int putFile8BitInteger(FILE *, int);
 202 int getFile16BitInteger(File *, int);
 203 int putFile16BitInteger(FILE *, int, int);
 204 int getFile32BitInteger(File *, int);
 205 int putFile32BitInteger(FILE *, int, int);
 206
 207 boolean getFileChunk(File *, char *, int *, int);
 208 int putFileChunk(FILE *, char *, int, int);
 209 int getFileVersion(File *);
 210 int putFileVersion(FILE *, int);
 211
 212 void ReadBytesFromFile(File *, byte *, unsigned int);
 213 void WriteBytesToFile(FILE *, byte *, unsigned int);
 214
 215 void ReadUnusedBytesFromFile(File *, unsigned int);
 216 void WriteUnusedBytesToFile(FILE *, unsigned int);
 217
 218 #define getFile8Bit(f)        getFile8BitInteger(f)
 219 #define putFile8Bit(f,x)      putFile8BitInteger(f,x)
 220 #define getFile16BitBE(f)     getFile16BitInteger(f,BYTE_ORDER_BIG_ENDIAN)
 221 #define getFile16BitLE(f)     getFile16BitInteger(f,BYTE_ORDER_LITTLE_ENDIAN)
 222 #define putFile16BitBE(f,x)   putFile16BitInteger(f,x,BYTE_ORDER_BIG_ENDIAN)
 223 #define putFile16BitLE(f,x)   putFile16BitInteger(f,x,BYTE_ORDER_LITTLE_ENDIAN)
 224 #define getFile32BitBE(f)     getFile32BitInteger(f,BYTE_ORDER_BIG_ENDIAN)
 225 #define getFile32BitLE(f)     getFile32BitInteger(f,BYTE_ORDER_LITTLE_ENDIAN)
 226 #define putFile32BitBE(f,x)   putFile32BitInteger(f,x,BYTE_ORDER_BIG_ENDIAN)
 227 #define putFile32BitLE(f,x)   putFile32BitInteger(f,x,BYTE_ORDER_LITTLE_ENDIAN)
 228
 229 #define getFileChunkBE(f,s,x) getFileChunk(f,s,x,BYTE_ORDER_BIG_ENDIAN)
 230 #define getFileChunkLE(f,s,x) getFileChunk(f,s,x,BYTE_ORDER_LITTLE_ENDIAN)
 231 #define putFileChunkBE(f,s,x) putFileChunk(f,s,x,BYTE_ORDER_BIG_ENDIAN)
 232 #define putFileChunkLE(f,s,x) putFileChunk(f,s,x,BYTE_ORDER_LITTLE_ENDIAN)
 233
 234 char *getKeyNameFromKey(Key);
 235 char *getX11KeyNameFromKey(Key);
 236 Key getKeyFromKeyName(char *);
 237 Key getKeyFromX11KeyName(char *);
 238 char getCharFromKey(Key);
 239 char getValidConfigValueChar(char);
 240
 241 int get_integer_from_string(char *);
 242 boolean get_boolean_from_string(char *);
 243 int get_switch3_from_string(char *);
 244 int get_player_nr_from_string(char *);
 245
 246 ListNode *newListNode(void);
 247 void addNodeToList(ListNode **, char *, void *);
 248 void deleteNodeFromList(ListNode **, char *, void (*function)(void *));
 249 ListNode *getNodeFromKey(ListNode *, char *);
 250 int getNumNodes(ListNode *);
 251
 252 File *openFile(char *, char *);
 253 int closeFile(File *);
 254 int checkEndOfFile(File *);
 255 size_t readFile(File *, void *, size_t, size_t);
 256 size_t writeFile(File *, void *, size_t, size_t);
 257 int seekFile(File *, long, int);
 258 int getByteFromFile(File *);
 259 char *getStringFromFile(File *, char *, int);
 260 int copyFile(char *, char *);
 261
 262 Directory *openDirectory(char *);
 263 int closeDirectory(Directory *);
 264 DirectoryEntry *readDirectory(Directory *);
 265 void freeDirectoryEntry(DirectoryEntry *);
 266
 267 boolean directoryExists(char *);
 268 boolean fileExists(char *);
 269 boolean FileIsGraphic(char *);
 270 boolean FileIsSound(char *);
 271 boolean FileIsMusic(char *);
 272 boolean FileIsArtworkType(char *, int);
 273
 274 char *get_mapped_token(char *);
 275
 276 struct FileInfo *getFileListFromConfigList(struct ConfigInfo *,
 277                                            struct ConfigTypeInfo *,
 278                                            char **, int);
 279 void LoadArtworkConfig(struct ArtworkListInfo *);
 280 void ReloadCustomArtworkList(struct ArtworkListInfo *);
 281 void FreeCustomArtworkLists(struct ArtworkListInfo *);
 282
 283 char *getLogFilename(char *);
 284 void OpenLogFiles(void);
 285 void CloseLogFiles(void);
 286 void DumpLogFile(int);
 287
 288 void NotifyUserAboutErrorFile(void);
 289
 290 #if DEBUG
 291 void debug_print_timestamp(int, char *);
 292 #endif
 293 void print_timestamp_init(char *);
 294 void print_timestamp_time(char *);
 295 void print_timestamp_done(char *);
 296
 297
 298 #endif // MISC_H