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_INFO_LINE (1 << 0)
42 #define ERR_WARN (1 << 1)
43 #define ERR_EXIT (1 << 2)
44 #define ERR_HELP (1 << 3)
45 #define ERR_SOUND_SERVER (1 << 4)
46 #define ERR_NETWORK_SERVER (1 << 5)
47 #define ERR_NETWORK_CLIENT (1 << 6)
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 */
92 struct DirectoryEntry *dir_entry;
94 #if defined(PLATFORM_ANDROID)
95 boolean directory_is_asset;
96 SDL_RWops *asset_toc_file;
102 /* function definitions */
104 void fprintf_line(FILE *, char *, int);
105 void printf_line(char *, int);
106 void printf_line_with_prefix(char *, char *, int);
107 char *int2str(int, int);
108 char *i_to_a(unsigned int);
109 int log_2(unsigned int);
111 boolean getTokenValueFromString(char *, char **, char **);
113 void InitCounter(void);
114 unsigned int Counter(void);
115 void Delay(unsigned int);
116 boolean FrameReached(unsigned int *, unsigned int);
117 boolean DelayReached(unsigned int *, unsigned int);
118 void WaitUntilDelayReached(unsigned int *, unsigned int);
120 unsigned int init_random_number(int, int);
121 unsigned int get_random_number(int, int);
123 char *getLoginName(void);
124 char *getRealName(void);
126 time_t getFileTimestampEpochSeconds(char *);
128 char *getBasePath(char *);
129 char *getBaseName(char *);
130 char *getBaseNamePtr(char *);
132 char *getStringCat2WithSeparator(char *, char *, char *);
133 char *getStringCat3WithSeparator(char *, char *, char *, char *);
134 char *getStringCat2(char *, char *);
135 char *getStringCat3(char *, char *, char *);
136 char *getPath2(char *, char *);
137 char *getPath3(char *, char *, char*);
138 char *getStringCopy(char *);
139 char *getStringCopyN(char *, int);
140 char *getStringToLower(char *);
141 void setString(char **, char *);
142 boolean strEqual(char *, char *);
143 boolean strEqualN(char *, char *, int);
144 boolean strPrefix(char *, char *);
145 boolean strSuffix(char *, char *);
146 boolean strPrefixLower(char *, char *);
147 boolean strSuffixLower(char *, char *);
149 void GetOptions(char **, void (*print_usage_function)(void));
151 void SetError(char *, ...);
152 char *GetError(void);
153 void Error(int, char *, ...);
155 void *checked_malloc(unsigned int);
156 void *checked_calloc(unsigned int);
157 void *checked_realloc(void *, unsigned int);
158 void checked_free(void *);
159 void clear_mem(void *, unsigned int);
161 void swap_numbers(int *, int *);
162 void swap_number_pairs(int *, int *, int *, int *);
164 int getFile8BitInteger(FILE *);
165 int putFile8BitInteger(FILE *, int);
166 int getFile16BitInteger(FILE *, int);
167 int putFile16BitInteger(FILE *, int, int);
168 int getFile32BitInteger(FILE *, int);
169 int putFile32BitInteger(FILE *, int, int);
171 boolean getFileChunk(FILE *, char *, int *, int);
172 int putFileChunk(FILE *, char *, int, int);
173 int getFileVersion(FILE *);
174 int putFileVersion(FILE *, int);
176 void ReadBytesFromFile(FILE *, byte *, unsigned int);
177 void WriteBytesToFile(FILE *, byte *, unsigned int);
179 void ReadUnusedBytesFromFile(FILE *, unsigned int);
180 void WriteUnusedBytesToFile(FILE *, unsigned int);
182 #define getFile8Bit(f) getFile8BitInteger(f)
183 #define putFile8Bit(f,x) putFile8BitInteger(f,x)
184 #define getFile16BitBE(f) getFile16BitInteger(f,BYTE_ORDER_BIG_ENDIAN)
185 #define getFile16BitLE(f) getFile16BitInteger(f,BYTE_ORDER_LITTLE_ENDIAN)
186 #define putFile16BitBE(f,x) putFile16BitInteger(f,x,BYTE_ORDER_BIG_ENDIAN)
187 #define putFile16BitLE(f,x) putFile16BitInteger(f,x,BYTE_ORDER_LITTLE_ENDIAN)
188 #define getFile32BitBE(f) getFile32BitInteger(f,BYTE_ORDER_BIG_ENDIAN)
189 #define getFile32BitLE(f) getFile32BitInteger(f,BYTE_ORDER_LITTLE_ENDIAN)
190 #define putFile32BitBE(f,x) putFile32BitInteger(f,x,BYTE_ORDER_BIG_ENDIAN)
191 #define putFile32BitLE(f,x) putFile32BitInteger(f,x,BYTE_ORDER_LITTLE_ENDIAN)
193 #define getFileChunkBE(f,s,x) getFileChunk(f,s,x,BYTE_ORDER_BIG_ENDIAN)
194 #define getFileChunkLE(f,s,x) getFileChunk(f,s,x,BYTE_ORDER_LITTLE_ENDIAN)
195 #define putFileChunkBE(f,s,x) putFileChunk(f,s,x,BYTE_ORDER_BIG_ENDIAN)
196 #define putFileChunkLE(f,s,x) putFileChunk(f,s,x,BYTE_ORDER_LITTLE_ENDIAN)
198 char *getKeyNameFromKey(Key);
199 char *getX11KeyNameFromKey(Key);
200 Key getKeyFromKeyName(char *);
201 Key getKeyFromX11KeyName(char *);
202 char getCharFromKey(Key);
203 char getValidConfigValueChar(char);
205 int get_integer_from_string(char *);
206 boolean get_boolean_from_string(char *);
207 int get_switch3_from_string(char *);
209 ListNode *newListNode(void);
210 void addNodeToList(ListNode **, char *, void *);
211 void deleteNodeFromList(ListNode **, char *, void (*function)(void *));
212 ListNode *getNodeFromKey(ListNode *, char *);
213 int getNumNodes(ListNode *);
215 struct Directory *openDirectory(char *);
216 int closeDirectory(struct Directory *);
217 struct DirectoryEntry *readDirectory(struct Directory *);
218 void freeDirectoryEntry(struct DirectoryEntry *);
220 boolean fileExists(char *);
221 boolean FileIsGraphic(char *);
222 boolean FileIsSound(char *);
223 boolean FileIsMusic(char *);
224 boolean FileIsArtworkType(char *, int);
226 char *get_mapped_token(char *);
228 int get_parameter_value(char *, char *, int);
230 struct ScreenModeInfo *get_screen_mode_from_string(char *);
231 void get_aspect_ratio_from_screen_mode(struct ScreenModeInfo *, int *x, int *y);
233 struct FileInfo *getFileListFromConfigList(struct ConfigInfo *,
234 struct ConfigTypeInfo *,
236 void LoadArtworkConfig(struct ArtworkListInfo *);
237 void ReloadCustomArtworkList(struct ArtworkListInfo *);
238 void FreeCustomArtworkLists(struct ArtworkListInfo *);
240 char *getErrorFilename(char *);
241 void openErrorFile();
242 void closeErrorFile();
243 void dumpErrorFile();
244 void NotifyUserAboutErrorFile();
246 void debug_print_timestamp(int, char *);