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 //                  http://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 printf_line(char *, int);
 118 void printf_line_with_prefix(char *, char *, int);
 119 char *int2str(int, int);
 120 char *i_to_a(unsigned int);
 121 int log_2(unsigned int);
 122
 123 boolean getTokenValueFromString(char *, char **, char **);
 124
 125 void InitCounter(void);
 126 unsigned int Counter(void);
 127 void Delay(unsigned int);
 128 boolean FrameReached(unsigned int *, unsigned int);
 129 boolean DelayReached(unsigned int *, unsigned int);
 130 void WaitUntilDelayReached(unsigned int *, unsigned int);
 131
 132 unsigned int init_random_number(int, int);
 133 unsigned int get_random_number(int, int);
 134
 135 char *getLoginName(void);
 136 char *getRealName(void);
 137
 138 time_t getFileTimestampEpochSeconds(char *);
 139
 140 char *getBasePath(char *);
 141 char *getBaseName(char *);
 142 char *getBaseNamePtr(char *);
 143
 144 char *getStringCat2WithSeparator(char *, char *, char *);
 145 char *getStringCat3WithSeparator(char *, char *, char *, char *);
 146 char *getStringCat2(char *, char *);
 147 char *getStringCat3(char *, char *, char *);
 148 char *getPath2(char *, char *);
 149 char *getPath3(char *, char *, char*);
 150 char *getStringCopy(const char *);
 151 char *getStringCopyN(const char *, int);
 152 char *getStringCopyNStatic(const char *, int);
 153 char *getStringToLower(const char *);
 154 void setString(char **, char *);
 155 boolean strEqual(char *, char *);
 156 boolean strEqualN(char *, char *, int);
 157 boolean strPrefix(char *, char *);
 158 boolean strSuffix(char *, char *);
 159 boolean strPrefixLower(char *, char *);
 160 boolean strSuffixLower(char *, char *);
 161
 162 void GetOptions(char **,
 163                 void (*print_usage_function)(void),
 164                 void (*print_version_function)(void));
 165
 166 void SetError(char *, ...);
 167 char *GetError(void);
 168 void Error(int, char *, ...);
 169
 170 void *checked_malloc(unsigned int);
 171 void *checked_calloc(unsigned int);
 172 void *checked_realloc(void *, unsigned int);
 173 void checked_free(void *);
 174 void clear_mem(void *, unsigned int);
 175
 176 void swap_numbers(int *, int *);
 177 void swap_number_pairs(int *, int *, int *, int *);
 178
 179 int getFile8BitInteger(File *);
 180 int putFile8BitInteger(FILE *, int);
 181 int getFile16BitInteger(File *, int);
 182 int putFile16BitInteger(FILE *, int, int);
 183 int getFile32BitInteger(File *, int);
 184 int putFile32BitInteger(FILE *, int, int);
 185
 186 boolean getFileChunk(File *, char *, int *, int);
 187 int putFileChunk(FILE *, char *, int, int);
 188 int getFileVersion(File *);
 189 int putFileVersion(FILE *, int);
 190
 191 void ReadBytesFromFile(File *, byte *, unsigned int);
 192 void WriteBytesToFile(FILE *, byte *, unsigned int);
 193
 194 void ReadUnusedBytesFromFile(File *, unsigned int);
 195 void WriteUnusedBytesToFile(FILE *, unsigned int);
 196
 197 #define getFile8Bit(f)        getFile8BitInteger(f)
 198 #define putFile8Bit(f,x)      putFile8BitInteger(f,x)
 199 #define getFile16BitBE(f)     getFile16BitInteger(f,BYTE_ORDER_BIG_ENDIAN)
 200 #define getFile16BitLE(f)     getFile16BitInteger(f,BYTE_ORDER_LITTLE_ENDIAN)
 201 #define putFile16BitBE(f,x)   putFile16BitInteger(f,x,BYTE_ORDER_BIG_ENDIAN)
 202 #define putFile16BitLE(f,x)   putFile16BitInteger(f,x,BYTE_ORDER_LITTLE_ENDIAN)
 203 #define getFile32BitBE(f)     getFile32BitInteger(f,BYTE_ORDER_BIG_ENDIAN)
 204 #define getFile32BitLE(f)     getFile32BitInteger(f,BYTE_ORDER_LITTLE_ENDIAN)
 205 #define putFile32BitBE(f,x)   putFile32BitInteger(f,x,BYTE_ORDER_BIG_ENDIAN)
 206 #define putFile32BitLE(f,x)   putFile32BitInteger(f,x,BYTE_ORDER_LITTLE_ENDIAN)
 207
 208 #define getFileChunkBE(f,s,x) getFileChunk(f,s,x,BYTE_ORDER_BIG_ENDIAN)
 209 #define getFileChunkLE(f,s,x) getFileChunk(f,s,x,BYTE_ORDER_LITTLE_ENDIAN)
 210 #define putFileChunkBE(f,s,x) putFileChunk(f,s,x,BYTE_ORDER_BIG_ENDIAN)
 211 #define putFileChunkLE(f,s,x) putFileChunk(f,s,x,BYTE_ORDER_LITTLE_ENDIAN)
 212
 213 char *getKeyNameFromKey(Key);
 214 char *getX11KeyNameFromKey(Key);
 215 Key getKeyFromKeyName(char *);
 216 Key getKeyFromX11KeyName(char *);
 217 char getCharFromKey(Key);
 218 char getValidConfigValueChar(char);
 219
 220 int get_integer_from_string(char *);
 221 boolean get_boolean_from_string(char *);
 222 int get_switch3_from_string(char *);
 223
 224 ListNode *newListNode(void);
 225 void addNodeToList(ListNode **, char *, void *);
 226 void deleteNodeFromList(ListNode **, char *, void (*function)(void *));
 227 ListNode *getNodeFromKey(ListNode *, char *);
 228 int getNumNodes(ListNode *);
 229
 230 File *openFile(char *, char *);
 231 int closeFile(File *);
 232 int checkEndOfFile(File *);
 233 size_t readFile(File *, void *, size_t, size_t);
 234 int seekFile(File *, long, int);
 235 int getByteFromFile(File *);
 236 char *getStringFromFile(File *, char *, int);
 237
 238 Directory *openDirectory(char *);
 239 int closeDirectory(Directory *);
 240 DirectoryEntry *readDirectory(Directory *);
 241 void freeDirectoryEntry(DirectoryEntry *);
 242
 243 boolean directoryExists(char *);
 244 boolean fileExists(char *);
 245 boolean FileIsGraphic(char *);
 246 boolean FileIsSound(char *);
 247 boolean FileIsMusic(char *);
 248 boolean FileIsArtworkType(char *, int);
 249
 250 char *get_mapped_token(char *);
 251
 252 int get_parameter_value(char *, char *, int);
 253
 254 struct ScreenModeInfo *get_screen_mode_from_string(char *);
 255 void get_aspect_ratio_from_screen_mode(struct ScreenModeInfo *, int *x, int *y);
 256
 257 struct FileInfo *getFileListFromConfigList(struct ConfigInfo *,
 258                                            struct ConfigTypeInfo *,
 259                                            char **, int);
 260 void LoadArtworkConfig(struct ArtworkListInfo *);
 261 void ReloadCustomArtworkList(struct ArtworkListInfo *);
 262 void FreeCustomArtworkLists(struct ArtworkListInfo *);
 263
 264 char *getErrorFilename(char *);
 265 void openErrorFile();
 266 void closeErrorFile();
 267 void dumpErrorFile();
 268 void NotifyUserAboutErrorFile();
 269
 270 #if DEBUG
 271 void debug_print_timestamp(int, char *);
 272 #endif
 273 void print_timestamp_init(char *);
 274 void print_timestamp_time(char *);
 275 void print_timestamp_done(char *);
 276
 277
 278 #endif /* MISC_H */