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