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)
39 #define ERR_DEBUG (1 << 0)
40 #define ERR_INFO (1 << 1)
41 #define ERR_INFO_LINE (1 << 2)
42 #define ERR_WARN (1 << 3)
43 #define ERR_EXIT (1 << 4)
44 #define ERR_HELP (1 << 5)
45 #define ERR_SOUND_SERVER (1 << 6)
46 #define ERR_NETWORK_SERVER (1 << 7)
47 #define ERR_NETWORK_CLIENT (1 << 8)
48 #define ERR_FROM_SERVER (ERR_SOUND_SERVER | ERR_NETWORK_SERVER)
49 #define ERR_EXIT_HELP (ERR_EXIT | ERR_HELP)
50 #define ERR_EXIT_SOUND_SERVER (ERR_EXIT | ERR_SOUND_SERVER)
51 #define ERR_EXIT_NETWORK_SERVER (ERR_EXIT | ERR_NETWORK_SERVER)
52 #define ERR_EXIT_NETWORK_CLIENT (ERR_EXIT | ERR_NETWORK_CLIENT)
54 // values for getFile...() and putFile...()
55 #define BYTE_ORDER_BIG_ENDIAN 0
56 #define BYTE_ORDER_LITTLE_ENDIAN 1
58 // values for cursor bitmap creation
59 #define BIT_ORDER_MSB 0
60 #define BIT_ORDER_LSB 1
62 // values for createDirectory()
63 #define PERMS_PRIVATE 0
64 #define PERMS_PUBLIC 1
66 // values for general file handling stuff
67 #define MAX_FILENAME_LEN 256
68 #define MAX_LINE_LEN 1024
70 // values for general username handling stuff
71 #define MAX_USERNAME_LEN 1024
73 #if defined(PLATFORM_ANDROID)
74 // values for Android asset handling
75 #define ASSET_TOC_BASENAME ".toc"
79 // structure definitions
87 #if defined(PLATFORM_ANDROID)
88 boolean file_is_asset;
89 SDL_RWops *asset_file;
104 DirectoryEntry *dir_entry;
106 #if defined(PLATFORM_ANDROID)
107 boolean directory_is_asset;
108 SDL_RWops *asset_toc_file;
114 // function definitions
116 void fprintf_line(FILE *, char *, int);
117 void fprintf_line_with_prefix(FILE *, char *, char *, int);
118 void printf_line(char *, int);
119 void printf_line_with_prefix(char *, char *, int);
121 void Print(char *, ...);
122 void PrintNoLog(char *, ...);
123 void PrintLine(char *, int);
124 void PrintLineWithPrefix(char *, char *, int);
126 void Debug(char *, char *, ...);
127 void Info(char *, ...);
128 void Warn(char *, ...);
130 char *int2str(int, int);
131 char *i_to_a(unsigned int);
132 int log_2(unsigned int);
134 boolean getTokenValueFromString(char *, char **, char **);
136 void InitCounter(void);
137 unsigned int Counter(void);
138 void Delay(unsigned int);
139 boolean DelayReachedExt(unsigned int *, unsigned int, unsigned int);
140 boolean FrameReached(unsigned int *, unsigned int);
141 boolean DelayReached(unsigned int *, unsigned int);
142 void ResetDelayCounterExt(unsigned int *, unsigned int);
143 void ResetFrameCounter(unsigned int *);
144 void ResetDelayCounter(unsigned int *);
145 int WaitUntilDelayReached(unsigned int *, unsigned int);
146 void SkipUntilDelayReached(unsigned int *, unsigned int, int *, int);
148 unsigned int init_random_number(int, int);
149 unsigned int get_random_number(int, int);
151 char *getLoginName(void);
152 char *getRealName(void);
154 time_t getFileTimestampEpochSeconds(char *);
156 char *getBasePath(char *);
157 char *getBaseName(char *);
158 char *getBaseNamePtr(char *);
159 char *getBaseNameNoSuffix(char *);
161 char *getStringCat2WithSeparator(char *, char *, char *);
162 char *getStringCat3WithSeparator(char *, char *, char *, char *);
163 char *getStringCat2(char *, char *);
164 char *getStringCat3(char *, char *, char *);
165 char *getPath2(char *, char *);
166 char *getPath3(char *, char *, char*);
167 char *getImg2(char *, char *);
168 char *getImg3(char *, char *, char*);
169 char *getStringCopy(const char *);
170 char *getStringCopyN(const char *, int);
171 char *getStringCopyNStatic(const char *, int);
172 char *getStringToLower(const char *);
173 void setString(char **, char *);
174 boolean strEqual(char *, char *);
175 boolean strEqualN(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 SetError(char *, ...);
186 char *GetError(void);
187 void Error(int, char *, ...);
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 *getKeyNameFromKey(Key);
233 char *getX11KeyNameFromKey(Key);
234 Key getKeyFromKeyName(char *);
235 Key getKeyFromX11KeyName(char *);
236 char getCharFromKey(Key);
237 char getValidConfigValueChar(char);
239 int get_integer_from_string(char *);
240 boolean get_boolean_from_string(char *);
241 int get_switch3_from_string(char *);
242 int get_player_nr_from_string(char *);
244 ListNode *newListNode(void);
245 void addNodeToList(ListNode **, char *, void *);
246 void deleteNodeFromList(ListNode **, char *, void (*function)(void *));
247 ListNode *getNodeFromKey(ListNode *, char *);
248 int getNumNodes(ListNode *);
250 File *openFile(char *, char *);
251 int closeFile(File *);
252 int checkEndOfFile(File *);
253 size_t readFile(File *, void *, size_t, size_t);
254 size_t writeFile(File *, void *, size_t, size_t);
255 int seekFile(File *, long, int);
256 int getByteFromFile(File *);
257 char *getStringFromFile(File *, char *, int);
258 int copyFile(char *, char *);
260 Directory *openDirectory(char *);
261 int closeDirectory(Directory *);
262 DirectoryEntry *readDirectory(Directory *);
263 void freeDirectoryEntry(DirectoryEntry *);
265 boolean directoryExists(char *);
266 boolean fileExists(char *);
267 boolean FileIsGraphic(char *);
268 boolean FileIsSound(char *);
269 boolean FileIsMusic(char *);
270 boolean FileIsArtworkType(char *, int);
272 char *get_mapped_token(char *);
274 struct FileInfo *getFileListFromConfigList(struct ConfigInfo *,
275 struct ConfigTypeInfo *,
277 void LoadArtworkConfig(struct ArtworkListInfo *);
278 void ReloadCustomArtworkList(struct ArtworkListInfo *);
279 void FreeCustomArtworkLists(struct ArtworkListInfo *);
281 char *getLogFilename(char *);
282 void OpenLogFiles(void);
283 void CloseLogFiles(void);
284 void DumpLogFile(int);
286 void NotifyUserAboutErrorFile(void);
289 void debug_print_timestamp(int, char *);
291 void print_timestamp_init(char *);
292 void print_timestamp_time(char *);
293 void print_timestamp_done(char *);