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 Debug(char *, char *, ...);
110 void Info(char *, ...);
111 void Warn(char *, ...);
112 void Error(char *, ...);
113 void Fail(char *, ...);
114 void FailWithHelp(char *, ...);
116 char *int2str(int, int);
117 char *i_to_a(unsigned int);
118 int log_2(unsigned int);
120 boolean getTokenValueFromString(char *, char **, char **);
122 void InitCounter(void);
123 unsigned int Counter(void);
124 void Delay(unsigned int);
125 boolean DelayReachedExt(unsigned int *, unsigned int, unsigned int);
126 boolean FrameReached(unsigned int *, unsigned int);
127 boolean DelayReached(unsigned int *, unsigned int);
128 void ResetDelayCounterExt(unsigned int *, unsigned int);
129 void ResetFrameCounter(unsigned int *);
130 void ResetDelayCounter(unsigned int *);
131 int WaitUntilDelayReached(unsigned int *, unsigned int);
132 void SkipUntilDelayReached(unsigned int *, unsigned int, int *, int);
134 unsigned int init_random_number(int, int);
135 unsigned int get_random_number(int, int);
137 char *getLoginName(void);
138 char *getRealName(void);
140 time_t getFileTimestampEpochSeconds(char *);
142 char *getBasePath(char *);
143 char *getBaseName(char *);
144 char *getBaseNamePtr(char *);
145 char *getBaseNameNoSuffix(char *);
147 char *getStringCat2WithSeparator(char *, char *, char *);
148 char *getStringCat3WithSeparator(char *, char *, char *, char *);
149 char *getStringCat2(char *, char *);
150 char *getStringCat3(char *, char *, char *);
151 char *getPath2(char *, char *);
152 char *getPath3(char *, char *, char*);
153 char *getImg2(char *, char *);
154 char *getImg3(char *, char *, char*);
155 char *getStringCopy(const char *);
156 char *getStringCopyN(const char *, int);
157 char *getStringCopyNStatic(const char *, int);
158 char *getStringToLower(const char *);
159 void setString(char **, char *);
160 boolean strEqual(char *, char *);
161 boolean strEqualN(char *, char *, int);
162 boolean strPrefix(char *, char *);
163 boolean strSuffix(char *, char *);
164 boolean strPrefixLower(char *, char *);
165 boolean strSuffixLower(char *, char *);
167 void GetOptions(int, char **,
168 void (*print_usage_function)(void),
169 void (*print_version_function)(void));
171 void *checked_malloc(unsigned int);
172 void *checked_calloc(unsigned int);
173 void *checked_realloc(void *, unsigned int);
174 void checked_free(void *);
175 void clear_mem(void *, unsigned int);
177 void swap_numbers(int *, int *);
178 void swap_number_pairs(int *, int *, int *, int *);
180 int getFile8BitInteger(File *);
181 int putFile8BitInteger(FILE *, int);
182 int getFile16BitInteger(File *, int);
183 int putFile16BitInteger(FILE *, int, int);
184 int getFile32BitInteger(File *, int);
185 int putFile32BitInteger(FILE *, int, int);
187 boolean getFileChunk(File *, char *, int *, int);
188 int putFileChunk(FILE *, char *, int, int);
189 int getFileVersion(File *);
190 int putFileVersion(FILE *, int);
192 void ReadBytesFromFile(File *, byte *, unsigned int);
193 void WriteBytesToFile(FILE *, byte *, unsigned int);
195 void ReadUnusedBytesFromFile(File *, unsigned int);
196 void WriteUnusedBytesToFile(FILE *, unsigned int);
198 #define getFile8Bit(f) getFile8BitInteger(f)
199 #define putFile8Bit(f,x) putFile8BitInteger(f,x)
200 #define getFile16BitBE(f) getFile16BitInteger(f,BYTE_ORDER_BIG_ENDIAN)
201 #define getFile16BitLE(f) getFile16BitInteger(f,BYTE_ORDER_LITTLE_ENDIAN)
202 #define putFile16BitBE(f,x) putFile16BitInteger(f,x,BYTE_ORDER_BIG_ENDIAN)
203 #define putFile16BitLE(f,x) putFile16BitInteger(f,x,BYTE_ORDER_LITTLE_ENDIAN)
204 #define getFile32BitBE(f) getFile32BitInteger(f,BYTE_ORDER_BIG_ENDIAN)
205 #define getFile32BitLE(f) getFile32BitInteger(f,BYTE_ORDER_LITTLE_ENDIAN)
206 #define putFile32BitBE(f,x) putFile32BitInteger(f,x,BYTE_ORDER_BIG_ENDIAN)
207 #define putFile32BitLE(f,x) putFile32BitInteger(f,x,BYTE_ORDER_LITTLE_ENDIAN)
209 #define getFileChunkBE(f,s,x) getFileChunk(f,s,x,BYTE_ORDER_BIG_ENDIAN)
210 #define getFileChunkLE(f,s,x) getFileChunk(f,s,x,BYTE_ORDER_LITTLE_ENDIAN)
211 #define putFileChunkBE(f,s,x) putFileChunk(f,s,x,BYTE_ORDER_BIG_ENDIAN)
212 #define putFileChunkLE(f,s,x) putFileChunk(f,s,x,BYTE_ORDER_LITTLE_ENDIAN)
214 char *getKeyNameFromKey(Key);
215 char *getX11KeyNameFromKey(Key);
216 Key getKeyFromKeyName(char *);
217 Key getKeyFromX11KeyName(char *);
218 char getCharFromKey(Key);
219 char getValidConfigValueChar(char);
221 int get_integer_from_string(char *);
222 boolean get_boolean_from_string(char *);
223 int get_switch3_from_string(char *);
224 int get_player_nr_from_string(char *);
226 ListNode *newListNode(void);
227 void addNodeToList(ListNode **, char *, void *);
228 void deleteNodeFromList(ListNode **, char *, void (*function)(void *));
229 ListNode *getNodeFromKey(ListNode *, char *);
230 int getNumNodes(ListNode *);
232 File *openFile(char *, char *);
233 int closeFile(File *);
234 int checkEndOfFile(File *);
235 size_t readFile(File *, void *, size_t, size_t);
236 size_t writeFile(File *, void *, size_t, size_t);
237 int seekFile(File *, long, int);
238 int getByteFromFile(File *);
239 char *getStringFromFile(File *, char *, int);
240 int copyFile(char *, char *);
242 Directory *openDirectory(char *);
243 int closeDirectory(Directory *);
244 DirectoryEntry *readDirectory(Directory *);
245 void freeDirectoryEntry(DirectoryEntry *);
247 boolean directoryExists(char *);
248 boolean fileExists(char *);
249 boolean FileIsGraphic(char *);
250 boolean FileIsSound(char *);
251 boolean FileIsMusic(char *);
252 boolean FileIsArtworkType(char *, int);
254 char *get_mapped_token(char *);
256 struct FileInfo *getFileListFromConfigList(struct ConfigInfo *,
257 struct ConfigTypeInfo *,
259 void LoadArtworkConfig(struct ArtworkListInfo *);
260 void ReloadCustomArtworkList(struct ArtworkListInfo *);
261 void FreeCustomArtworkLists(struct ArtworkListInfo *);
263 char *getLogFilename(char *);
264 void OpenLogFiles(void);
265 void CloseLogFiles(void);
266 void DumpLogFile(int);
268 void NotifyUserAboutErrorFile(void);
271 void debug_print_timestamp(int, char *);
273 void print_timestamp_init(char *);
274 void print_timestamp_time(char *);
275 void print_timestamp_done(char *);