1 // ============================================================================
2 // Artsoft Retro-Game Library
3 // ----------------------------------------------------------------------------
4 // (c) 1995-2014 by Artsoft Entertainment
7 // https://www.artsoft.org/
8 // ----------------------------------------------------------------------------
10 // ============================================================================
19 // values for setup file handling
20 #define TYPE_BOOLEAN (1 << 0)
21 #define TYPE_SWITCH (1 << 1)
22 #define TYPE_SWITCH3 (1 << 2)
23 #define TYPE_YES_NO (1 << 3)
24 #define TYPE_YES_NO_AUTO (1 << 4)
25 #define TYPE_ECS_AGA (1 << 5)
26 #define TYPE_KEY (1 << 6)
27 #define TYPE_KEY_X11 (1 << 7)
28 #define TYPE_INTEGER (1 << 8)
29 #define TYPE_STRING (1 << 9)
30 #define TYPE_PLAYER (1 << 10)
31 #define TYPE_ELEMENT (1 << 11)
32 #define TYPE_GRAPHIC (1 << 12)
34 // additional values for setup screen
35 #define TYPE_ENTER_SCREEN (1 << 13)
36 #define TYPE_LEAVE_SCREEN (1 << 14)
37 #define TYPE_ENTER_MENU (1 << 15)
38 #define TYPE_LEAVE_MENU (1 << 16)
39 #define TYPE_ENTER_LIST (1 << 17)
40 #define TYPE_LEAVE_LIST (1 << 18)
41 #define TYPE_TEXT_INPUT (1 << 19)
42 #define TYPE_EMPTY (1 << 20)
43 #define TYPE_SKIPPABLE (1 << 21)
44 #define TYPE_KEYTEXT (1 << 22)
45 #define TYPE_HEADLINE (1 << 23)
47 #define TYPE_GHOSTED (1 << 24)
48 #define TYPE_QUERY (1 << 25)
50 // additional values for internal purposes
51 #define TYPE_BITFIELD (1 << 26)
52 #define TYPE_CONTENT (1 << 27)
53 #define TYPE_ELEMENT_LIST (1 << 28)
54 #define TYPE_CONTENT_LIST (1 << 29)
56 // derived values for setup file handling
57 #define TYPE_BOOLEAN_STYLE (TYPE_BOOLEAN | \
62 // derived values for setup screen
63 #define TYPE_VALUE (TYPE_BOOLEAN_STYLE | \
74 #define TYPE_SKIP_ENTRY (TYPE_EMPTY | \
81 #define TYPE_ENTER (TYPE_ENTER_SCREEN | \
85 #define TYPE_LEAVE (TYPE_LEAVE_SCREEN | \
89 #define TYPE_ENTER_OR_LEAVE (TYPE_ENTER | TYPE_LEAVE)
98 // some definitions for list and hash handling
99 typedef struct SetupFileList SetupFileList;
100 typedef struct hashtable SetupFileHash;
102 #define BEGIN_HASH_ITERATION(hash, itr) \
103 if (hash != NULL && hashtable_count(hash) > 0) \
105 struct hashtable_itr *itr = hashtable_iterator(hash); \
108 #define HASH_ITERATION_TOKEN(itr) ((char *)hashtable_iterator_key(itr))
109 #define HASH_ITERATION_VALUE(itr) ((char *)hashtable_iterator_value(itr))
111 #define END_HASH_ITERATION(hash, itr) \
112 } while (hashtable_iterator_advance(itr)); \
117 // sort priorities of level series (also used as level series classes)
118 #define LEVELCLASS_TUTORIAL_START 10
119 #define LEVELCLASS_TUTORIAL_END 99
120 #define LEVELCLASS_CLASSICS_START 100
121 #define LEVELCLASS_CLASSICS_END 199
122 #define LEVELCLASS_CONTRIB_START 200
123 #define LEVELCLASS_CONTRIB_END 299
124 #define LEVELCLASS_PRIVATE_START 300
125 #define LEVELCLASS_PRIVATE_END 399
126 #define LEVELCLASS_BD_START 400
127 #define LEVELCLASS_BD_END 499
128 #define LEVELCLASS_EM_START 500
129 #define LEVELCLASS_EM_END 599
130 #define LEVELCLASS_SP_START 600
131 #define LEVELCLASS_SP_END 699
132 #define LEVELCLASS_DX_START 700
133 #define LEVELCLASS_DX_END 799
134 #define LEVELCLASS_SB_START 800
135 #define LEVELCLASS_SB_END 899
137 #define LEVELCLASS_PREDEFINED_START LEVELCLASS_TUTORIAL_START
138 #define LEVELCLASS_PREDEFINED_END LEVELCLASS_SB_END
140 #define LEVELCLASS_TUTORIAL LEVELCLASS_TUTORIAL_START
141 #define LEVELCLASS_CLASSICS LEVELCLASS_CLASSICS_START
142 #define LEVELCLASS_CONTRIB LEVELCLASS_CONTRIB_START
143 #define LEVELCLASS_PRIVATE LEVELCLASS_PRIVATE_START
144 #define LEVELCLASS_BD LEVELCLASS_BD_START
145 #define LEVELCLASS_EM LEVELCLASS_EM_START
146 #define LEVELCLASS_SP LEVELCLASS_SP_START
147 #define LEVELCLASS_DX LEVELCLASS_DX_START
148 #define LEVELCLASS_SB LEVELCLASS_SB_START
150 #define LEVELCLASS_UNDEFINED 999
152 #define IS_LEVELCLASS_TUTORIAL(p) \
153 ((p)->sort_priority >= LEVELCLASS_TUTORIAL_START && \
154 (p)->sort_priority <= LEVELCLASS_TUTORIAL_END)
155 #define IS_LEVELCLASS_CLASSICS(p) \
156 ((p)->sort_priority >= LEVELCLASS_CLASSICS_START && \
157 (p)->sort_priority <= LEVELCLASS_CLASSICS_END)
158 #define IS_LEVELCLASS_CONTRIB(p) \
159 ((p)->sort_priority >= LEVELCLASS_CONTRIB_START && \
160 (p)->sort_priority <= LEVELCLASS_CONTRIB_END)
161 #define IS_LEVELCLASS_PRIVATE(p) \
162 ((p)->sort_priority >= LEVELCLASS_PRIVATE_START && \
163 (p)->sort_priority <= LEVELCLASS_PRIVATE_END)
164 #define IS_LEVELCLASS_BD(p) \
165 ((p)->sort_priority >= LEVELCLASS_BD_START && \
166 (p)->sort_priority <= LEVELCLASS_BD_END)
167 #define IS_LEVELCLASS_EM(p) \
168 ((p)->sort_priority >= LEVELCLASS_EM_START && \
169 (p)->sort_priority <= LEVELCLASS_EM_END)
170 #define IS_LEVELCLASS_SP(p) \
171 ((p)->sort_priority >= LEVELCLASS_SP_START && \
172 (p)->sort_priority <= LEVELCLASS_SP_END)
173 #define IS_LEVELCLASS_DX(p) \
174 ((p)->sort_priority >= LEVELCLASS_DX_START && \
175 (p)->sort_priority <= LEVELCLASS_DX_END)
176 #define IS_LEVELCLASS_SB(p) \
177 ((p)->sort_priority >= LEVELCLASS_SB_START && \
178 (p)->sort_priority <= LEVELCLASS_SB_END)
179 #define IS_LEVELCLASS_UNDEFINED(p) \
180 ((p)->sort_priority < LEVELCLASS_PREDEFINED_START || \
181 (p)->sort_priority > LEVELCLASS_PREDEFINED_END)
183 #define LEVELCLASS(n) (IS_LEVELCLASS_TUTORIAL(n) ? LEVELCLASS_TUTORIAL : \
184 IS_LEVELCLASS_CLASSICS(n) ? LEVELCLASS_CLASSICS : \
185 IS_LEVELCLASS_CONTRIB(n) ? LEVELCLASS_CONTRIB : \
186 IS_LEVELCLASS_PRIVATE(n) ? LEVELCLASS_PRIVATE : \
187 IS_LEVELCLASS_BD(n) ? LEVELCLASS_BD : \
188 IS_LEVELCLASS_EM(n) ? LEVELCLASS_EM : \
189 IS_LEVELCLASS_SP(n) ? LEVELCLASS_SP : \
190 IS_LEVELCLASS_DX(n) ? LEVELCLASS_DX : \
191 IS_LEVELCLASS_SB(n) ? LEVELCLASS_SB : \
192 LEVELCLASS_UNDEFINED)
194 // sort priorities of artwork
195 #define ARTWORKCLASS_CLASSICS_START 100
196 #define ARTWORKCLASS_CLASSICS_END 199
197 #define ARTWORKCLASS_CONTRIB_START 200
198 #define ARTWORKCLASS_CONTRIB_END 299
199 #define ARTWORKCLASS_PRIVATE_START 300
200 #define ARTWORKCLASS_PRIVATE_END 399
201 #define ARTWORKCLASS_LEVEL_START 400
202 #define ARTWORKCLASS_LEVEL_END 499
204 #define ARTWORKCLASS_CLASSICS ARTWORKCLASS_CLASSICS_START
205 #define ARTWORKCLASS_CONTRIB ARTWORKCLASS_CONTRIB_START
206 #define ARTWORKCLASS_PRIVATE ARTWORKCLASS_PRIVATE_START
207 #define ARTWORKCLASS_LEVEL ARTWORKCLASS_LEVEL_START
209 #define ARTWORKCLASS_UNDEFINED 999
211 #define IS_ARTWORKCLASS_CLASSICS(p) \
212 ((p)->sort_priority >= ARTWORKCLASS_CLASSICS_START && \
213 (p)->sort_priority <= ARTWORKCLASS_CLASSICS_END)
214 #define IS_ARTWORKCLASS_CONTRIB(p) \
215 ((p)->sort_priority >= ARTWORKCLASS_CONTRIB_START && \
216 (p)->sort_priority <= ARTWORKCLASS_CONTRIB_END)
217 #define IS_ARTWORKCLASS_PRIVATE(p) \
218 ((p)->sort_priority >= ARTWORKCLASS_PRIVATE_START && \
219 (p)->sort_priority <= ARTWORKCLASS_PRIVATE_END)
220 #define IS_ARTWORKCLASS_LEVEL(p) \
221 ((p)->sort_priority >= ARTWORKCLASS_LEVEL_START && \
222 (p)->sort_priority <= ARTWORKCLASS_LEVEL_END)
224 #define ARTWORKCLASS(n) (IS_ARTWORKCLASS_CLASSICS(n) ? ARTWORKCLASS_CLASSICS :\
225 IS_ARTWORKCLASS_CONTRIB(n) ? ARTWORKCLASS_CONTRIB : \
226 IS_ARTWORKCLASS_PRIVATE(n) ? ARTWORKCLASS_PRIVATE : \
227 IS_ARTWORKCLASS_LEVEL(n) ? ARTWORKCLASS_LEVEL : \
228 ARTWORKCLASS_UNDEFINED)
230 #define TREE_SORTING_DIR(ti) \
231 (((ti)->parent_link ? 0 : \
232 (ti)->in_user_dir ? 8 : \
233 (ti)->sort_priority >= LEVELCLASS_CLASSICS_START ? 6 : \
234 (ti)->sort_priority >= LEVELCLASS_TUTORIAL_START ? 4 : \
236 ((ti)->level_group ? 0 : 1))
238 #define TREE_COLOR_DIR(ti, active) \
239 ((active) ? FC_YELLOW : \
240 TREE_SORTING(ti) / 2 == 4 ? FC_GREEN : \
241 TREE_SORTING(ti) / 2 == 2 ? FC_BLUE : \
244 #define TREE_SORTING(ti) \
245 (TREE_TYPE_IS_DIR((ti)->type) ? TREE_SORTING_DIR(ti) : \
248 #define TREE_COLOR(ti, active) \
249 (TREE_TYPE_IS_DIR((ti)->type) ? TREE_COLOR_DIR(ti, active) : \
253 char *getUserGraphicsDir(void);
254 char *getUserSoundsDir(void);
255 char *getUserMusicDir(void);
256 char *setLevelArtworkDir(TreeInfo *);
257 char *getProgramMainDataPath(char *, char *);
258 char *getProgramConfigFilename(char *);
259 char *getTapeFilename(int);
260 char *getSolutionTapeFilename(int);
261 char *getScoreFilename(int);
262 char *getSetupFilename(void);
263 char *getDefaultSetupFilename(void);
264 char *getEditorSetupFilename(void);
265 char *getHelpAnimFilename(void);
266 char *getHelpTextFilename(void);
267 char *getLevelSetInfoFilename(void);
268 char *getLevelSetTitleMessageFilename(int, boolean);
269 char *getImageFilename(char *);
270 char *getCustomImageFilename(char *);
271 char *getCustomSoundFilename(char *);
272 char *getCustomMusicFilename(char *);
273 char *getCustomArtworkFilename(char *, int);
274 char *getCustomArtworkConfigFilename(int);
275 char *getCustomArtworkLevelConfigFilename(int);
276 char *getCustomMusicDirectory(void);
278 void InitTapeDirectory(char *);
279 void InitScoreDirectory(char *);
280 void InitUserLevelDirectory(char *);
281 void InitNetworkLevelDirectory(char *);
282 void InitLevelSetupDirectory(char *);
284 TreeInfo *newTreeInfo(void);
285 TreeInfo *newTreeInfo_setDefaults(int);
286 void pushTreeInfo(TreeInfo **, TreeInfo *);
287 void removeTreeInfo(TreeInfo **);
288 int numTreeInfo(TreeInfo *);
289 boolean validLevelSeries(TreeInfo *);
290 TreeInfo *getFirstValidTreeInfoEntry(TreeInfo *);
291 TreeInfo *getTreeInfoFirstGroupEntry(TreeInfo *);
292 int numTreeInfoInGroup(TreeInfo *);
293 int getPosFromTreeInfo(TreeInfo *);
294 TreeInfo *getTreeInfoFromPos(TreeInfo *, int);
295 TreeInfo *getTreeInfoFromIdentifier(TreeInfo *, char *);
296 void dumpTreeInfo(TreeInfo *, int);
297 void sortTreeInfoBySortFunction(TreeInfo **,
298 int (*compare_function)(const void *,
300 void sortTreeInfo(TreeInfo **);
301 void freeTreeInfo(TreeInfo *);
303 char *getHomeDir(void);
304 char *getCommonDataDir(void);
305 char *getPersonalDataDir(void);
306 char *getMainUserGameDataDir(void);
307 char *getUserGameDataDir(void);
308 char *getSetupDir(void);
309 char *getLevelDirFromTreeInfo(TreeInfo *);
310 char *getUserLevelDir(char *);
311 char *getNetworkLevelDir(char *);
312 char *getCurrentLevelDir(void);
313 char *getNewUserLevelSubdir(void);
315 void createDirectory(char *, char *, int);
316 void InitMainUserDataDirectory(void);
317 void InitUserDataDirectory(void);
318 void SetFilePermissions(char *, int);
320 char *getCookie(char *);
321 void fprintFileHeader(FILE *, char *);
322 int getFileVersionFromCookieString(const char *);
323 boolean checkCookieString(const char *, const char *);
325 char *getFormattedSetupEntry(char *, char *);
327 boolean getTokenValueFromSetupLine(char *, char **, char **);
329 SetupFileList *newSetupFileList(char *, char *);
330 void freeSetupFileList(SetupFileList *);
331 char *getListEntry(SetupFileList *, char *);
332 SetupFileList *setListEntry(SetupFileList *, char *, char *);
333 SetupFileList *addListEntry(SetupFileList *, char *, char *);
334 SetupFileList *loadSetupFileList(char *);
336 SetupFileHash *newSetupFileHash(void);
337 void freeSetupFileHash(SetupFileHash *);
338 char *getHashEntry(SetupFileHash *, char *);
339 void setHashEntry(SetupFileHash *, char *, char *);
340 char *removeHashEntry(SetupFileHash *, char *);
341 SetupFileHash *loadSetupFileHash(char *);
342 void setSetupInfo(struct TokenInfo *, int, char *);
343 char *getSetupValue(int, void *);
344 char *getSetupLine(struct TokenInfo *, char *, int);
346 unsigned int get_hash_from_key(void *);
348 int GetZipFileTreeType(char *);
349 char *ExtractZipFileIntoDirectory(char *, char *, int);
351 boolean AdjustGraphicsForEMC(void);
352 boolean AdjustSoundsForEMC(void);
354 void SetCurrentArtwork(int);
355 void ChangeCurrentArtworkIfNeeded(int);
357 void LoadLevelInfo(void);
358 void LoadArtworkInfo(void);
359 void LoadLevelArtworkInfo(void);
361 char *getArtworkIdentifierForUserLevelSet(int);
362 TreeInfo *getArtworkTreeInfoForUserLevelSet(int);
363 boolean checkIfCustomArtworkExistsForCurrentLevelSet(void);
364 void AddUserLevelSetToLevelInfo(char *);
365 void AddTreeSetToTreeInfo(TreeInfo *, char *, char *, int);
366 boolean UpdateUserLevelSet(char *, char *, char *, int);
367 boolean CreateUserLevelSet(char *, char *, char *, int, boolean);
369 void UpdateLastPlayedLevels_TreeInfo(void);
371 void LoadLevelSetup_LastSeries(void);
372 void SaveLevelSetup_LastSeries(void);
373 void SaveLevelSetup_LastSeries_Deactivate(void);
374 void LoadLevelSetup_SeriesInfo(void);
375 void SaveLevelSetup_SeriesInfo(void);
377 int LevelStats_getPlayed(int);
378 int LevelStats_getSolved(int);
379 void LevelStats_setPlayed(int, int);
380 void LevelStats_setSolved(int, int);
381 void LevelStats_incPlayed(int);
382 void LevelStats_incSolved(int);
384 void LoadUserSetup(void);
385 void SaveUserSetup(void);