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