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