1 /***********************************************************
2 * Artsoft Retro-Game Library *
3 *----------------------------------------------------------*
4 * (c) 1994-2006 Artsoft Entertainment *
6 * Detmolder Strasse 189 *
9 * e-mail: info@artsoft.org *
10 *----------------------------------------------------------*
12 ***********************************************************/
24 /* values for InitCounter() and Counter() */
25 #define INIT_COUNTER 0
26 #define READ_COUNTER 1
28 /* values for InitRND() */
29 #define NEW_RANDOMIZE 0
31 #define RANDOM_ENGINE 0
32 #define RANDOM_SIMPLE 1
34 #define InitEngineRandom(seed) init_random_number(RANDOM_ENGINE, seed)
35 #define InitSimpleRandom(seed) init_random_number(RANDOM_SIMPLE, seed)
36 #define GetEngineRandom(max) get_random_number(RANDOM_ENGINE, max)
37 #define GetSimpleRandom(max) get_random_number(RANDOM_SIMPLE, max)
39 /* values for Error() */
41 #define ERR_DEBUG (1 << 0)
42 #define ERR_INFO (1 << 1)
43 #define ERR_INFO_LINE (1 << 2)
44 #define ERR_WARN (1 << 3)
45 #define ERR_EXIT (1 << 4)
46 #define ERR_HELP (1 << 5)
47 #define ERR_SOUND_SERVER (1 << 6)
48 #define ERR_NETWORK_SERVER (1 << 7)
49 #define ERR_NETWORK_CLIENT (1 << 8)
50 #define ERR_FROM_SERVER (ERR_SOUND_SERVER | ERR_NETWORK_SERVER)
51 #define ERR_EXIT_HELP (ERR_EXIT | ERR_HELP)
52 #define ERR_EXIT_SOUND_SERVER (ERR_EXIT | ERR_SOUND_SERVER)
53 #define ERR_EXIT_NETWORK_SERVER (ERR_EXIT | ERR_NETWORK_SERVER)
54 #define ERR_EXIT_NETWORK_CLIENT (ERR_EXIT | ERR_NETWORK_CLIENT)
56 #define ERR_ERROR (ERR_UNKNOWN)
57 #define ERR_FATAL (ERR_EXIT)
58 #define ERR_VERBOSE (ERR_INFO)
61 /* values for getFile...() and putFile...() */
62 #define BYTE_ORDER_BIG_ENDIAN 0
63 #define BYTE_ORDER_LITTLE_ENDIAN 1
65 /* values for cursor bitmap creation */
66 #define BIT_ORDER_MSB 0
67 #define BIT_ORDER_LSB 1
69 /* values for createDirectory() */
70 #define PERMS_PRIVATE 0
71 #define PERMS_PUBLIC 1
73 /* values for general file handling stuff */
74 #define MAX_FILENAME_LEN 256
75 #define MAX_LINE_LEN 1024
77 /* values for general username handling stuff */
78 #define MAX_USERNAME_LEN 1024
80 #if defined(PLATFORM_ANDROID)
81 /* values for Android asset handling */
82 #define ASSET_TOC_BASENAME ".toc"
86 /* structure definitions */
94 #if defined(PLATFORM_ANDROID)
95 boolean file_is_asset;
96 SDL_RWops *asset_file;
102 boolean is_directory;
111 DirectoryEntry *dir_entry;
113 #if defined(PLATFORM_ANDROID)
114 boolean directory_is_asset;
115 SDL_RWops *asset_toc_file;
121 /* function definitions */
123 void fprintf_line(FILE *, char *, int);
124 void printf_line(char *, int);
125 void printf_line_with_prefix(char *, char *, int);
126 char *int2str(int, int);
127 char *i_to_a(unsigned int);
128 int log_2(unsigned int);
130 boolean getTokenValueFromString(char *, char **, char **);
132 void InitCounter(void);
133 unsigned int Counter(void);
134 void Delay(unsigned int);
135 boolean FrameReached(unsigned int *, unsigned int);
136 boolean DelayReached(unsigned int *, unsigned int);
137 void WaitUntilDelayReached(unsigned int *, unsigned int);
139 unsigned int init_random_number(int, int);
140 unsigned int get_random_number(int, int);
142 char *getLoginName(void);
143 char *getRealName(void);
145 time_t getFileTimestampEpochSeconds(char *);
147 char *getBasePath(char *);
148 char *getBaseName(char *);
149 char *getBaseNamePtr(char *);
151 char *getStringCat2WithSeparator(char *, char *, char *);
152 char *getStringCat3WithSeparator(char *, char *, char *, char *);
153 char *getStringCat2(char *, char *);
154 char *getStringCat3(char *, char *, char *);
155 char *getPath2(char *, char *);
156 char *getPath3(char *, char *, char*);
157 char *getStringCopy(const char *);
158 char *getStringCopyN(const char *, int);
159 char *getStringCopyNStatic(const char *, int);
160 char *getStringToLower(const char *);
161 void setString(char **, char *);
162 boolean strEqual(char *, char *);
163 boolean strEqualN(char *, char *, int);
164 boolean strPrefix(char *, char *);
165 boolean strSuffix(char *, char *);
166 boolean strPrefixLower(char *, char *);
167 boolean strSuffixLower(char *, char *);
169 void GetOptions(char **, void (*print_usage_function)(void));
171 void SetError(char *, ...);
172 char *GetError(void);
173 void Error(int, char *, ...);
175 void *checked_malloc(unsigned int);
176 void *checked_calloc(unsigned int);
177 void *checked_realloc(void *, unsigned int);
178 void checked_free(void *);
179 void clear_mem(void *, unsigned int);
181 void swap_numbers(int *, int *);
182 void swap_number_pairs(int *, int *, int *, int *);
186 int getFile8BitInteger(File *);
187 int putFile8BitInteger(FILE *, int);
188 int getFile16BitInteger(File *, int);
189 int putFile16BitInteger(FILE *, int, int);
190 int getFile32BitInteger(File *, int);
191 int putFile32BitInteger(FILE *, int, int);
193 boolean getFileChunk(File *, char *, int *, int);
194 int putFileChunk(FILE *, char *, int, int);
195 int getFileVersion(File *);
196 int putFileVersion(FILE *, int);
198 void ReadBytesFromFile(File *, byte *, unsigned int);
199 void WriteBytesToFile(FILE *, byte *, unsigned int);
201 void ReadUnusedBytesFromFile(File *, unsigned int);
202 void WriteUnusedBytesToFile(FILE *, unsigned int);
206 int getFile8BitInteger(FILE *);
207 int putFile8BitInteger(FILE *, int);
208 int getFile16BitInteger(FILE *, int);
209 int putFile16BitInteger(FILE *, int, int);
210 int getFile32BitInteger(FILE *, int);
211 int putFile32BitInteger(FILE *, int, int);
213 boolean getFileChunk(FILE *, char *, int *, int);
214 int putFileChunk(FILE *, char *, int, int);
215 int getFileVersion(FILE *);
216 int putFileVersion(FILE *, int);
218 void ReadBytesFromFile(FILE *, byte *, unsigned int);
219 void WriteBytesToFile(FILE *, byte *, unsigned int);
221 void ReadUnusedBytesFromFile(FILE *, unsigned int);
222 void WriteUnusedBytesToFile(FILE *, unsigned int);
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)
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)
242 char *getKeyNameFromKey(Key);
243 char *getX11KeyNameFromKey(Key);
244 Key getKeyFromKeyName(char *);
245 Key getKeyFromX11KeyName(char *);
246 char getCharFromKey(Key);
247 char getValidConfigValueChar(char);
249 int get_integer_from_string(char *);
250 boolean get_boolean_from_string(char *);
251 int get_switch3_from_string(char *);
253 ListNode *newListNode(void);
254 void addNodeToList(ListNode **, char *, void *);
255 void deleteNodeFromList(ListNode **, char *, void (*function)(void *));
256 ListNode *getNodeFromKey(ListNode *, char *);
257 int getNumNodes(ListNode *);
259 File *openFile(char *, char *);
260 int closeFile(File *);
261 int checkEndOfFile(File *);
262 size_t readFile(File *, void *, size_t, size_t);
263 int seekFile(File *, long, int);
264 int getByteFromFile(File *);
265 char *getStringFromFile(File *, char *, int);
267 Directory *openDirectory(char *);
268 int closeDirectory(Directory *);
269 DirectoryEntry *readDirectory(Directory *);
270 void freeDirectoryEntry(DirectoryEntry *);
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);
279 char *get_mapped_token(char *);
281 int get_parameter_value(char *, char *, int);
283 struct ScreenModeInfo *get_screen_mode_from_string(char *);
284 void get_aspect_ratio_from_screen_mode(struct ScreenModeInfo *, int *x, int *y);
286 struct FileInfo *getFileListFromConfigList(struct ConfigInfo *,
287 struct ConfigTypeInfo *,
289 void LoadArtworkConfig(struct ArtworkListInfo *);
290 void ReloadCustomArtworkList(struct ArtworkListInfo *);
291 void FreeCustomArtworkLists(struct ArtworkListInfo *);
293 char *getErrorFilename(char *);
294 void openErrorFile();
295 void closeErrorFile();
296 void dumpErrorFile();
297 void NotifyUserAboutErrorFile();
300 void debug_print_timestamp(int, char *);
302 void print_timestamp_init(char *);
303 void print_timestamp_time(char *);
304 void print_timestamp_done(char *);