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 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);
135 unsigned int init_random_number(int, int);
136 unsigned int get_random_number(int, int);
138 #if defined(PLATFORM_UNIX)
139 char *getUnixLoginName(void);
140 char *getUnixRealName(void);
141 char *getUnixHomeDir(void);
144 char *getLoginName(void);
145 char *getRealName(void);
146 char *getFixedUserName(char *);
147 char *getDefaultUserName(int);
149 char *getTimestampFromEpoch(time_t);
150 char *getCurrentTimestamp(void);
152 time_t getFileTimestampEpochSeconds(char *);
154 char *getBasePath(char *);
155 char *getBaseName(char *);
156 char *getBaseNamePtr(char *);
157 char *getBaseNameNoSuffix(char *);
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 *);
181 void GetOptions(int, char **,
182 void (*print_usage_function)(void),
183 void (*print_version_function)(void));
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);
191 void swap_numbers(int *, int *);
192 void swap_number_pairs(int *, int *, int *, int *);
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);
201 boolean getFileChunk(File *, char *, int *, int);
202 int putFileChunk(FILE *, char *, int, int);
203 int getFileVersion(File *);
204 int putFileVersion(FILE *, int);
206 void ReadBytesFromFile(File *, byte *, unsigned int);
207 void WriteBytesToFile(FILE *, byte *, unsigned int);
209 void ReadUnusedBytesFromFile(File *, unsigned int);
210 void WriteUnusedBytesToFile(FILE *, unsigned int);
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)
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)
228 char *getUTF8FromLatin1(char *);
229 char *getLatin1FromUTF8(char *);
231 char *getKeyNameFromKey(Key);
232 char *getX11KeyNameFromKey(Key);
233 Key getKeyFromKeyName(char *);
234 Key getKeyFromX11KeyName(char *);
235 char getCharFromKey(Key);
236 char getValidConfigValueChar(char);
238 int get_integer_from_string(char *);
239 boolean get_boolean_from_string(char *);
240 int get_switch3_from_string(char *);
241 int get_player_nr_from_string(char *);
243 ListNode *newListNode(void);
244 void addNodeToList(ListNode **, char *, void *);
245 void deleteNodeFromList(ListNode **, char *, void (*function)(void *));
246 ListNode *getNodeFromKey(ListNode *, char *);
247 int getNumNodes(ListNode *);
249 File *openFile(char *, char *);
250 int closeFile(File *);
251 int checkEndOfFile(File *);
252 size_t readFile(File *, void *, size_t, size_t);
253 size_t writeFile(File *, void *, size_t, size_t);
254 int seekFile(File *, long, int);
255 int getByteFromFile(File *);
256 char *getStringFromFile(File *, char *, int);
257 int copyFile(char *, char *);
259 Directory *openDirectory(char *);
260 int closeDirectory(Directory *);
261 DirectoryEntry *readDirectory(Directory *);
262 void freeDirectoryEntry(DirectoryEntry *);
264 boolean directoryExists(char *);
265 boolean fileExists(char *);
266 boolean FileIsGraphic(char *);
267 boolean FileIsSound(char *);
268 boolean FileIsMusic(char *);
269 boolean FileIsArtworkType(char *, int);
271 char *get_mapped_token(char *);
273 struct FileInfo *getFileListFromConfigList(struct ConfigInfo *,
274 struct ConfigTypeInfo *,
276 void LoadArtworkConfig(struct ArtworkListInfo *);
277 void ReloadCustomArtworkList(struct ArtworkListInfo *);
278 void FreeCustomArtworkLists(struct ArtworkListInfo *);
280 char *getLogFilename(char *);
281 void OpenLogFiles(void);
282 void CloseLogFiles(void);
283 void DumpLogFile(int);
285 void NotifyUserAboutErrorFile(void);
288 void debug_print_timestamp(int, char *);
290 void print_timestamp_init(char *);
291 void print_timestamp_time(char *);
292 void print_timestamp_done(char *);