renamed variable
[rocksndiamonds.git] / src / libgame / misc.h
1 // ============================================================================
2 // Artsoft Retro-Game Library
3 // ----------------------------------------------------------------------------
4 // (c) 1995-2014 by Artsoft Entertainment
5 //                  Holger Schemel
6 //                  info@artsoft.org
7 //                  https://www.artsoft.org/
8 // ----------------------------------------------------------------------------
9 // misc.h
10 // ============================================================================
11
12 #ifndef MISC_H
13 #define MISC_H
14
15 #include <stdlib.h>
16 #include <stdio.h>
17 #include <dirent.h>
18
19 #include "system.h"
20
21
22 // values for InitCounter() and Counter()
23 #define INIT_COUNTER                    0
24 #define READ_COUNTER                    1
25
26 // values for InitRND()
27 #define NEW_RANDOMIZE                   0
28
29 #define RANDOM_ENGINE                   0
30 #define RANDOM_SIMPLE                   1
31 #define RANDOM_BETTER                   2
32
33 #define InitEngineRandom(seed)          init_random_number(RANDOM_ENGINE, seed)
34 #define InitSimpleRandom(seed)          init_random_number(RANDOM_SIMPLE, seed)
35 #define InitBetterRandom(seed)          init_random_number(RANDOM_BETTER, seed)
36 #define GetEngineRandom(max)            get_random_number(RANDOM_ENGINE, max)
37 #define GetSimpleRandom(max)            get_random_number(RANDOM_SIMPLE, max)
38 #define GetBetterRandom(max)            get_random_number(RANDOM_BETTER, max)
39
40 // values for getFile...() and putFile...()
41 #define BYTE_ORDER_BIG_ENDIAN           0
42 #define BYTE_ORDER_LITTLE_ENDIAN        1
43
44 // values for cursor bitmap creation
45 #define BIT_ORDER_MSB                   0
46 #define BIT_ORDER_LSB                   1
47
48 // values for character encoding
49 #define TEXT_ENCODING_UNKNOWN           0
50 #define TEXT_ENCODING_ASCII             1
51 #define TEXT_ENCODING_UTF_8             2
52
53 // values for createDirectory()
54 #define PERMS_PRIVATE                   0
55 #define PERMS_PUBLIC                    1
56
57 // values for general file handling stuff
58 #define MAX_FILENAME_LEN                256
59 #define MAX_LINE_LEN                    1024
60
61 // values for general username handling stuff
62 #define MAX_USERNAME_LEN                1024
63
64 #if defined(PLATFORM_ANDROID)
65 // values for Android asset handling
66 #define ASSET_TOC_BASENAME              ".toc"
67 #endif
68
69
70 // structure definitions
71
72 typedef struct
73 {
74   char *filename;
75   FILE *file;
76   boolean end_of_file;
77
78 #if defined(PLATFORM_ANDROID)
79   boolean file_is_asset;
80   SDL_RWops *asset_file;
81 #endif
82 } File;
83
84 typedef struct
85 {
86   boolean is_directory;
87   char *basename;
88   char *filename;
89 } DirectoryEntry;
90
91 typedef struct
92 {
93   char *filename;
94   DIR *dir;
95   DirectoryEntry *dir_entry;
96
97 #if defined(PLATFORM_ANDROID)
98   boolean directory_is_asset;
99   SDL_RWops *asset_toc_file;
100   char *current_entry;
101 #endif
102 } Directory;
103
104
105 // function definitions
106
107 void fprintf_line(FILE *, char *, int);
108 void fprintf_line_with_prefix(FILE *, char *, char *, int);
109 void printf_line(char *, int);
110 void printf_line_with_prefix(char *, char *, int);
111
112 void Print(char *, ...);
113 void PrintNoLog(char *, ...);
114 void PrintLine(char *, int);
115 void PrintLineWithPrefix(char *, char *, int);
116
117 void DebugContinued(char *, char *, ...);
118 void Debug(char *, char *, ...);
119 void Info(char *, ...);
120 void Warn(char *, ...);
121 void Error(char *, ...);
122 void Fail(char *, ...);
123 void FailWithHelp(char *, ...);
124
125 char *int2str(int, int);
126 char *i_to_a(unsigned int);
127 int log_2(unsigned int);
128
129 boolean getTokenValueFromString(char *, char **, char **);
130
131 char *getUUIDExt(unsigned int (*function)(int));
132 char *getUUID(void);
133
134 void InitCounter(void);
135 unsigned int Counter(void);
136 void Delay(unsigned int);
137 boolean DelayReachedExt(unsigned int *, unsigned int, unsigned int);
138 boolean FrameReached(unsigned int *, unsigned int);
139 boolean DelayReached(unsigned int *, unsigned int);
140 void ResetDelayCounterExt(unsigned int *, unsigned int);
141 void ResetFrameCounter(unsigned int *);
142 void ResetDelayCounter(unsigned int *);
143 int WaitUntilDelayReached(unsigned int *, unsigned int);
144 void SkipUntilDelayReached(unsigned int *, unsigned int, int *, int);
145
146 unsigned int init_random_number(int, int);
147 unsigned int get_random_number(int, int);
148
149 #if defined(PLATFORM_UNIX)
150 char *getUnixLoginName(void);
151 char *getUnixRealName(void);
152 char *getUnixHomeDir(void);
153 #endif
154
155 char *getLoginName(void);
156 char *getRealName(void);
157 char *getFixedUserName(char *);
158 char *getDefaultUserName(int);
159
160 char *getTimestampFromEpoch(time_t);
161 char *getCurrentTimestamp(void);
162
163 time_t getFileTimestampEpochSeconds(char *);
164
165 char *getBasePath(char *);
166 char *getBaseName(char *);
167 char *getBaseNamePtr(char *);
168 char *getBaseNameNoSuffix(char *);
169
170 char *getStringCat2WithSeparator(char *, char *, char *);
171 char *getStringCat3WithSeparator(char *, char *, char *, char *);
172 char *getStringCat2(char *, char *);
173 char *getStringCat3(char *, char *, char *);
174 char *getPath2(char *, char *);
175 char *getPath3(char *, char *, char*);
176 char *getImg2(char *, char *);
177 char *getImg3(char *, char *, char*);
178 char *getStringCopy(const char *);
179 char *getStringCopyN(const char *, int);
180 char *getStringCopyNStatic(const char *, int);
181 char *getStringToLower(const char *);
182 void setString(char **, char *);
183 boolean strEqual(char *, char *);
184 boolean strEqualN(char *, char *, int);
185 boolean strEqualCase(char *, char *);
186 boolean strEqualCaseN(char *, char *, int);
187 boolean strPrefix(char *, char *);
188 boolean strSuffix(char *, char *);
189 boolean strPrefixLower(char *, char *);
190 boolean strSuffixLower(char *, char *);
191 boolean isURL(char *);
192
193 void GetOptions(int, char **,
194                 void (*print_usage_function)(void),
195                 void (*print_version_function)(void));
196
197 void *checked_malloc(unsigned int);
198 void *checked_calloc(unsigned int);
199 void *checked_realloc(void *, unsigned int);
200 void checked_free(void *);
201 void clear_mem(void *, unsigned int);
202
203 void swap_numbers(int *, int *);
204 void swap_number_pairs(int *, int *, int *, int *);
205
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);
212
213 boolean getFileChunk(File *, char *, int *, int);
214 int putFileChunk(FILE *, char *, int, int);
215 int getFileVersion(File *);
216 int putFileVersion(FILE *, int);
217
218 void ReadBytesFromFile(File *, byte *, unsigned int);
219 void WriteBytesToFile(FILE *, byte *, unsigned int);
220
221 void ReadUnusedBytesFromFile(File *, unsigned int);
222 void WriteUnusedBytesToFile(FILE *, unsigned int);
223
224 #define getFile8Bit(f)        getFile8BitInteger(f)
225 #define putFile8Bit(f,x)      putFile8BitInteger(f,x)
226 #define getFile16BitBE(f)     getFile16BitInteger(f,BYTE_ORDER_BIG_ENDIAN)
227 #define getFile16BitLE(f)     getFile16BitInteger(f,BYTE_ORDER_LITTLE_ENDIAN)
228 #define putFile16BitBE(f,x)   putFile16BitInteger(f,x,BYTE_ORDER_BIG_ENDIAN)
229 #define putFile16BitLE(f,x)   putFile16BitInteger(f,x,BYTE_ORDER_LITTLE_ENDIAN)
230 #define getFile32BitBE(f)     getFile32BitInteger(f,BYTE_ORDER_BIG_ENDIAN)
231 #define getFile32BitLE(f)     getFile32BitInteger(f,BYTE_ORDER_LITTLE_ENDIAN)
232 #define putFile32BitBE(f,x)   putFile32BitInteger(f,x,BYTE_ORDER_BIG_ENDIAN)
233 #define putFile32BitLE(f,x)   putFile32BitInteger(f,x,BYTE_ORDER_LITTLE_ENDIAN)
234
235 #define getFileChunkBE(f,s,x) getFileChunk(f,s,x,BYTE_ORDER_BIG_ENDIAN)
236 #define getFileChunkLE(f,s,x) getFileChunk(f,s,x,BYTE_ORDER_LITTLE_ENDIAN)
237 #define putFileChunkBE(f,s,x) putFileChunk(f,s,x,BYTE_ORDER_BIG_ENDIAN)
238 #define putFileChunkLE(f,s,x) putFileChunk(f,s,x,BYTE_ORDER_LITTLE_ENDIAN)
239
240 char *getUTF8FromLatin1(char *);
241 char *getLatin1FromUTF8(char *);
242 int getTextEncoding(char *);
243
244 char *getEscapedJSON(char *);
245
246 char *getKeyNameFromKey(Key);
247 char *getX11KeyNameFromKey(Key);
248 Key getKeyFromKeyName(char *);
249 Key getKeyFromX11KeyName(char *);
250 char getCharFromKey(Key);
251 char getValidConfigValueChar(char);
252
253 int get_integer_from_string(char *);
254 boolean get_boolean_from_string(char *);
255 int get_switch3_from_string(char *);
256 int get_player_nr_from_string(char *);
257
258 ListNode *newListNode(void);
259 void addNodeToList(ListNode **, char *, void *);
260 void deleteNodeFromList(ListNode **, char *, void (*function)(void *));
261 ListNode *getNodeFromKey(ListNode *, char *);
262 int getNumNodes(ListNode *);
263
264 File *openFile(char *, char *);
265 int closeFile(File *);
266 int checkEndOfFile(File *);
267 size_t readFile(File *, void *, size_t, size_t);
268 size_t writeFile(File *, void *, size_t, size_t);
269 int seekFile(File *, long, int);
270 int getByteFromFile(File *);
271 char *getStringFromFile(File *, char *, int);
272 int copyFile(char *, char *);
273 boolean touchFile(char *);
274
275 Directory *openDirectory(char *);
276 int closeDirectory(Directory *);
277 DirectoryEntry *readDirectory(Directory *);
278 void freeDirectoryEntry(DirectoryEntry *);
279
280 boolean directoryExists(char *);
281 boolean fileExists(char *);
282 boolean FileIsGraphic(char *);
283 boolean FileIsSound(char *);
284 boolean FileIsMusic(char *);
285 boolean FileIsArtworkType(char *, int);
286
287 char *get_mapped_token(char *);
288
289 struct FileInfo *getFileListFromConfigList(struct ConfigInfo *,
290                                            struct ConfigTypeInfo *,
291                                            char **, int);
292 void LoadArtworkConfig(struct ArtworkListInfo *);
293 void ReloadCustomArtworkList(struct ArtworkListInfo *);
294 void FreeCustomArtworkLists(struct ArtworkListInfo *);
295
296 char *getLogFilename(char *);
297 void OpenLogFiles(void);
298 void CloseLogFiles(void);
299 void DumpLogFile(int);
300
301 void NotifyUserAboutErrorFile(void);
302
303 #if DEBUG
304 void debug_print_timestamp(int, char *);
305 #endif
306 void print_timestamp_init(char *);
307 void print_timestamp_time(char *);
308 void print_timestamp_done(char *);
309
310
311 #endif // MISC_H