1 // ============================================================================
2 // Artsoft Retro-Game Library
3 // ----------------------------------------------------------------------------
4 // (c) 1995-2014 by Artsoft Entertainment
7 // https://www.artsoft.org/
8 // ----------------------------------------------------------------------------
10 // ============================================================================
22 // values for InitCounter() and Counter()
23 #define INIT_COUNTER 0
24 #define READ_COUNTER 1
26 // values for InitRND()
27 #define NEW_RANDOMIZE 0
29 #define RANDOM_ENGINE 0
30 #define RANDOM_SIMPLE 1
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)
37 // values for getFile...() and putFile...()
38 #define BYTE_ORDER_BIG_ENDIAN 0
39 #define BYTE_ORDER_LITTLE_ENDIAN 1
41 // values for cursor bitmap creation
42 #define BIT_ORDER_MSB 0
43 #define BIT_ORDER_LSB 1
45 // values for createDirectory()
46 #define PERMS_PRIVATE 0
47 #define PERMS_PUBLIC 1
49 // values for general file handling stuff
50 #define MAX_FILENAME_LEN 256
51 #define MAX_LINE_LEN 1024
53 // values for general username handling stuff
54 #define MAX_USERNAME_LEN 1024
56 #if defined(PLATFORM_ANDROID)
57 // values for Android asset handling
58 #define ASSET_TOC_BASENAME ".toc"
62 // structure definitions
70 #if defined(PLATFORM_ANDROID)
71 boolean file_is_asset;
72 SDL_RWops *asset_file;
87 DirectoryEntry *dir_entry;
89 #if defined(PLATFORM_ANDROID)
90 boolean directory_is_asset;
91 SDL_RWops *asset_toc_file;
97 // function definitions
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);
104 void Print(char *, ...);
105 void PrintNoLog(char *, ...);
106 void PrintLine(char *, int);
107 void PrintLineWithPrefix(char *, char *, int);
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 *, ...);
117 char *int2str(int, int);
118 char *i_to_a(unsigned int);
119 int log_2(unsigned int);
121 boolean getTokenValueFromString(char *, char **, char **);
123 char *GetPlayerUUID(void);
124 char *GetSystemUUID(void);
125 void SetSystemUUID(char *);
127 void InitCounter(void);
128 unsigned int Counter(void);
129 void Delay(unsigned int);
130 boolean DelayReachedExt(unsigned int *, unsigned int, unsigned int);
131 boolean FrameReached(unsigned int *, unsigned int);
132 boolean DelayReached(unsigned int *, unsigned int);
133 void ResetDelayCounterExt(unsigned int *, unsigned int);
134 void ResetFrameCounter(unsigned int *);
135 void ResetDelayCounter(unsigned int *);
136 int WaitUntilDelayReached(unsigned int *, unsigned int);
137 void SkipUntilDelayReached(unsigned int *, unsigned int, int *, int);
139 unsigned int init_random_number(int, int);
140 unsigned int get_random_number(int, int);
142 #if defined(PLATFORM_UNIX)
143 char *getUnixLoginName(void);
144 char *getUnixRealName(void);
145 char *getUnixHomeDir(void);
148 char *getLoginName(void);
149 char *getRealName(void);
150 char *getFixedUserName(char *);
151 char *getDefaultUserName(int);
153 char *getTimestampFromEpoch(time_t);
154 char *getCurrentTimestamp(void);
156 time_t getFileTimestampEpochSeconds(char *);
158 char *getBasePath(char *);
159 char *getBaseName(char *);
160 char *getBaseNamePtr(char *);
161 char *getBaseNameNoSuffix(char *);
163 char *getStringCat2WithSeparator(char *, char *, char *);
164 char *getStringCat3WithSeparator(char *, char *, char *, char *);
165 char *getStringCat2(char *, char *);
166 char *getStringCat3(char *, char *, char *);
167 char *getPath2(char *, char *);
168 char *getPath3(char *, char *, char*);
169 char *getImg2(char *, char *);
170 char *getImg3(char *, char *, char*);
171 char *getStringCopy(const char *);
172 char *getStringCopyN(const char *, int);
173 char *getStringCopyNStatic(const char *, int);
174 char *getStringToLower(const char *);
175 void setString(char **, char *);
176 boolean strEqual(char *, char *);
177 boolean strEqualN(char *, char *, int);
178 boolean strEqualCase(char *, char *);
179 boolean strEqualCaseN(char *, char *, int);
180 boolean strPrefix(char *, char *);
181 boolean strSuffix(char *, char *);
182 boolean strPrefixLower(char *, char *);
183 boolean strSuffixLower(char *, char *);
185 void GetOptions(int, char **,
186 void (*print_usage_function)(void),
187 void (*print_version_function)(void));
189 void *checked_malloc(unsigned int);
190 void *checked_calloc(unsigned int);
191 void *checked_realloc(void *, unsigned int);
192 void checked_free(void *);
193 void clear_mem(void *, unsigned int);
195 void swap_numbers(int *, int *);
196 void swap_number_pairs(int *, int *, int *, int *);
198 int getFile8BitInteger(File *);
199 int putFile8BitInteger(FILE *, int);
200 int getFile16BitInteger(File *, int);
201 int putFile16BitInteger(FILE *, int, int);
202 int getFile32BitInteger(File *, int);
203 int putFile32BitInteger(FILE *, int, int);
205 boolean getFileChunk(File *, char *, int *, int);
206 int putFileChunk(FILE *, char *, int, int);
207 int getFileVersion(File *);
208 int putFileVersion(FILE *, int);
210 void ReadBytesFromFile(File *, byte *, unsigned int);
211 void WriteBytesToFile(FILE *, byte *, unsigned int);
213 void ReadUnusedBytesFromFile(File *, unsigned int);
214 void WriteUnusedBytesToFile(FILE *, unsigned int);
216 #define getFile8Bit(f) getFile8BitInteger(f)
217 #define putFile8Bit(f,x) putFile8BitInteger(f,x)
218 #define getFile16BitBE(f) getFile16BitInteger(f,BYTE_ORDER_BIG_ENDIAN)
219 #define getFile16BitLE(f) getFile16BitInteger(f,BYTE_ORDER_LITTLE_ENDIAN)
220 #define putFile16BitBE(f,x) putFile16BitInteger(f,x,BYTE_ORDER_BIG_ENDIAN)
221 #define putFile16BitLE(f,x) putFile16BitInteger(f,x,BYTE_ORDER_LITTLE_ENDIAN)
222 #define getFile32BitBE(f) getFile32BitInteger(f,BYTE_ORDER_BIG_ENDIAN)
223 #define getFile32BitLE(f) getFile32BitInteger(f,BYTE_ORDER_LITTLE_ENDIAN)
224 #define putFile32BitBE(f,x) putFile32BitInteger(f,x,BYTE_ORDER_BIG_ENDIAN)
225 #define putFile32BitLE(f,x) putFile32BitInteger(f,x,BYTE_ORDER_LITTLE_ENDIAN)
227 #define getFileChunkBE(f,s,x) getFileChunk(f,s,x,BYTE_ORDER_BIG_ENDIAN)
228 #define getFileChunkLE(f,s,x) getFileChunk(f,s,x,BYTE_ORDER_LITTLE_ENDIAN)
229 #define putFileChunkBE(f,s,x) putFileChunk(f,s,x,BYTE_ORDER_BIG_ENDIAN)
230 #define putFileChunkLE(f,s,x) putFileChunk(f,s,x,BYTE_ORDER_LITTLE_ENDIAN)
232 char *getUTF8FromLatin1(char *);
233 char *getLatin1FromUTF8(char *);
234 char *getEscapedJSON(char *);
236 char *getKeyNameFromKey(Key);
237 char *getX11KeyNameFromKey(Key);
238 Key getKeyFromKeyName(char *);
239 Key getKeyFromX11KeyName(char *);
240 char getCharFromKey(Key);
241 char getValidConfigValueChar(char);
243 int get_integer_from_string(char *);
244 boolean get_boolean_from_string(char *);
245 int get_switch3_from_string(char *);
246 int get_player_nr_from_string(char *);
248 ListNode *newListNode(void);
249 void addNodeToList(ListNode **, char *, void *);
250 void deleteNodeFromList(ListNode **, char *, void (*function)(void *));
251 ListNode *getNodeFromKey(ListNode *, char *);
252 int getNumNodes(ListNode *);
254 File *openFile(char *, char *);
255 int closeFile(File *);
256 int checkEndOfFile(File *);
257 size_t readFile(File *, void *, size_t, size_t);
258 size_t writeFile(File *, void *, size_t, size_t);
259 int seekFile(File *, long, int);
260 int getByteFromFile(File *);
261 char *getStringFromFile(File *, char *, int);
262 int copyFile(char *, char *);
264 Directory *openDirectory(char *);
265 int closeDirectory(Directory *);
266 DirectoryEntry *readDirectory(Directory *);
267 void freeDirectoryEntry(DirectoryEntry *);
269 boolean directoryExists(char *);
270 boolean fileExists(char *);
271 boolean FileIsGraphic(char *);
272 boolean FileIsSound(char *);
273 boolean FileIsMusic(char *);
274 boolean FileIsArtworkType(char *, int);
276 char *get_mapped_token(char *);
278 struct FileInfo *getFileListFromConfigList(struct ConfigInfo *,
279 struct ConfigTypeInfo *,
281 void LoadArtworkConfig(struct ArtworkListInfo *);
282 void ReloadCustomArtworkList(struct ArtworkListInfo *);
283 void FreeCustomArtworkLists(struct ArtworkListInfo *);
285 char *getLogFilename(char *);
286 void OpenLogFiles(void);
287 void CloseLogFiles(void);
288 void DumpLogFile(int);
290 void NotifyUserAboutErrorFile(void);
293 void debug_print_timestamp(int, char *);
295 void print_timestamp_init(char *);
296 void print_timestamp_time(char *);
297 void print_timestamp_done(char *);