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 #define RANDOM_BETTER                   2
  32
  33 #define InitEngineRandom(seed)          init_random_number(RANDOM_ENGINE, seed)
  34 #define InitSimpleRandom(seed)          init_random_number(RANDOM_SIMPLE, seed)
  35 #define InitBetterRandom(seed)          init_random_number(RANDOM_BETTER, seed)
  36 #define GetEngineRandom(max)            get_random_number(RANDOM_ENGINE, max)
  37 #define GetSimpleRandom(max)            get_random_number(RANDOM_SIMPLE, max)
  38 #define GetBetterRandom(max)            get_random_number(RANDOM_BETTER, max)
  39
  40 // values for getFile...() and putFile...()
  41 #define BYTE_ORDER_BIG_ENDIAN           0
  42 #define BYTE_ORDER_LITTLE_ENDIAN        1
  43
  44 // values for cursor bitmap creation
  45 #define BIT_ORDER_MSB                   0
  46 #define BIT_ORDER_LSB                   1
  47
  48 // values for createDirectory()
  49 #define PERMS_PRIVATE                   0
  50 #define PERMS_PUBLIC                    1
  51
  52 // values for general file handling stuff
  53 #define MAX_FILENAME_LEN                256
  54 #define MAX_LINE_LEN                    1024
  55
  56 // values for general username handling stuff
  57 #define MAX_USERNAME_LEN                1024
  58
  59 #if defined(PLATFORM_ANDROID)
  60 // values for Android asset handling
  61 #define ASSET_TOC_BASENAME              ".toc"
  62 #endif
  63
  64
  65 // structure definitions
  66
  67 typedef struct
  68 {
  69   char *filename;
  70   FILE *file;
  71   boolean end_of_file;
  72
  73 #if defined(PLATFORM_ANDROID)
  74   boolean file_is_asset;
  75   SDL_RWops *asset_file;
  76 #endif
  77 } File;
  78
  79 typedef struct
  80 {
  81   boolean is_directory;
  82   char *basename;
  83   char *filename;
  84 } DirectoryEntry;
  85
  86 typedef struct
  87 {
  88   char *filename;
  89   DIR *dir;
  90   DirectoryEntry *dir_entry;
  91
  92 #if defined(PLATFORM_ANDROID)
  93   boolean directory_is_asset;
  94   SDL_RWops *asset_toc_file;
  95   char *current_entry;
  96 #endif
  97 } Directory;
  98
  99
 100 // function definitions
 101
 102 void fprintf_line(FILE *, char *, int);
 103 void fprintf_line_with_prefix(FILE *, char *, char *, int);
 104 void printf_line(char *, int);
 105 void printf_line_with_prefix(char *, char *, int);
 106
 107 void Print(char *, ...);
 108 void PrintNoLog(char *, ...);
 109 void PrintLine(char *, int);
 110 void PrintLineWithPrefix(char *, char *, int);
 111
 112 void DebugContinued(char *, char *, ...);
 113 void Debug(char *, char *, ...);
 114 void Info(char *, ...);
 115 void Warn(char *, ...);
 116 void Error(char *, ...);
 117 void Fail(char *, ...);
 118 void FailWithHelp(char *, ...);
 119
 120 char *int2str(int, int);
 121 char *i_to_a(unsigned int);
 122 int log_2(unsigned int);
 123
 124 boolean getTokenValueFromString(char *, char **, char **);
 125
 126 char *getUUIDExt(unsigned int (*function)(int));
 127 char *getUUID(void);
 128
 129 void InitCounter(void);
 130 unsigned int Counter(void);
 131 void Delay(unsigned int);
 132 boolean DelayReachedExt(unsigned int *, unsigned int, unsigned int);
 133 boolean FrameReached(unsigned int *, unsigned int);
 134 boolean DelayReached(unsigned int *, unsigned int);
 135 void ResetDelayCounterExt(unsigned int *, unsigned int);
 136 void ResetFrameCounter(unsigned int *);
 137 void ResetDelayCounter(unsigned int *);
 138 int WaitUntilDelayReached(unsigned int *, unsigned int);
 139 void SkipUntilDelayReached(unsigned int *, unsigned int, int *, int);
 140
 141 unsigned int init_random_number(int, int);
 142 unsigned int get_random_number(int, int);
 143
 144 #if defined(PLATFORM_UNIX)
 145 char *getUnixLoginName(void);
 146 char *getUnixRealName(void);
 147 char *getUnixHomeDir(void);
 148 #endif
 149
 150 char *getLoginName(void);
 151 char *getRealName(void);
 152 char *getFixedUserName(char *);
 153 char *getDefaultUserName(int);
 154
 155 char *getTimestampFromEpoch(time_t);
 156 char *getCurrentTimestamp(void);
 157
 158 time_t getFileTimestampEpochSeconds(char *);
 159
 160 char *getBasePath(char *);
 161 char *getBaseName(char *);
 162 char *getBaseNamePtr(char *);
 163 char *getBaseNameNoSuffix(char *);
 164
 165 char *getStringCat2WithSeparator(char *, char *, char *);
 166 char *getStringCat3WithSeparator(char *, char *, char *, char *);
 167 char *getStringCat2(char *, char *);
 168 char *getStringCat3(char *, char *, char *);
 169 char *getPath2(char *, char *);
 170 char *getPath3(char *, char *, char*);
 171 char *getImg2(char *, char *);
 172 char *getImg3(char *, char *, char*);
 173 char *getStringCopy(const char *);
 174 char *getStringCopyN(const char *, int);
 175 char *getStringCopyNStatic(const char *, int);
 176 char *getStringToLower(const char *);
 177 void setString(char **, char *);
 178 boolean strEqual(char *, char *);
 179 boolean strEqualN(char *, char *, int);
 180 boolean strEqualCase(char *, char *);
 181 boolean strEqualCaseN(char *, char *, int);
 182 boolean strPrefix(char *, char *);
 183 boolean strSuffix(char *, char *);
 184 boolean strPrefixLower(char *, char *);
 185 boolean strSuffixLower(char *, char *);
 186
 187 void GetOptions(int, char **,
 188                 void (*print_usage_function)(void),
 189                 void (*print_version_function)(void));
 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 *getUTF8FromLatin1(char *);
 235 char *getLatin1FromUTF8(char *);
 236 char *getEscapedJSON(char *);
 237
 238 char *getKeyNameFromKey(Key);
 239 char *getX11KeyNameFromKey(Key);
 240 Key getKeyFromKeyName(char *);
 241 Key getKeyFromX11KeyName(char *);
 242 char getCharFromKey(Key);
 243 char getValidConfigValueChar(char);
 244
 245 int get_integer_from_string(char *);
 246 boolean get_boolean_from_string(char *);
 247 int get_switch3_from_string(char *);
 248 int get_player_nr_from_string(char *);
 249
 250 ListNode *newListNode(void);
 251 void addNodeToList(ListNode **, char *, void *);
 252 void deleteNodeFromList(ListNode **, char *, void (*function)(void *));
 253 ListNode *getNodeFromKey(ListNode *, char *);
 254 int getNumNodes(ListNode *);
 255
 256 File *openFile(char *, char *);
 257 int closeFile(File *);
 258 int checkEndOfFile(File *);
 259 size_t readFile(File *, void *, size_t, size_t);
 260 size_t writeFile(File *, void *, size_t, size_t);
 261 int seekFile(File *, long, int);
 262 int getByteFromFile(File *);
 263 char *getStringFromFile(File *, char *, int);
 264 int copyFile(char *, char *);
 265 boolean touchFile(char *);
 266
 267 Directory *openDirectory(char *);
 268 int closeDirectory(Directory *);
 269 DirectoryEntry *readDirectory(Directory *);
 270 void freeDirectoryEntry(DirectoryEntry *);
 271
 272 boolean directoryExists(char *);
 273 boolean fileExists(char *);
 274 boolean FileIsGraphic(char *);
 275 boolean FileIsSound(char *);
 276 boolean FileIsMusic(char *);
 277 boolean FileIsArtworkType(char *, int);
 278
 279 char *get_mapped_token(char *);
 280
 281 struct FileInfo *getFileListFromConfigList(struct ConfigInfo *,
 282                                            struct ConfigTypeInfo *,
 283                                            char **, int);
 284 void LoadArtworkConfig(struct ArtworkListInfo *);
 285 void ReloadCustomArtworkList(struct ArtworkListInfo *);
 286 void FreeCustomArtworkLists(struct ArtworkListInfo *);
 287
 288 char *getLogFilename(char *);
 289 void OpenLogFiles(void);
 290 void CloseLogFiles(void);
 291 void DumpLogFile(int);
 292
 293 void NotifyUserAboutErrorFile(void);
 294
 295 #if DEBUG
 296 void debug_print_timestamp(int, char *);
 297 #endif
 298 void print_timestamp_init(char *);
 299 void print_timestamp_time(char *);
 300 void print_timestamp_done(char *);
 301
 302
 303 #endif // MISC_H