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 ***********************************************************/
21 /* values for setup file handling */
22 #define TYPE_BOOLEAN (1 << 0)
23 #define TYPE_SWITCH (1 << 1)
24 #define TYPE_YES_NO (1 << 2)
25 #define TYPE_ECS_AGA (1 << 3)
26 #define TYPE_KEY (1 << 4)
27 #define TYPE_KEY_X11 (1 << 5)
28 #define TYPE_INTEGER (1 << 6)
29 #define TYPE_STRING (1 << 7)
30 #define TYPE_TOKEN (1 << 8)
32 /* additional values for setup screen */
33 #define TYPE_ENTER_SCREEN (1 << 9)
34 #define TYPE_LEAVE_SCREEN (1 << 10)
35 #define TYPE_ENTER_MENU (1 << 11)
36 #define TYPE_LEAVE_MENU (1 << 12)
37 #define TYPE_ENTER_LIST (1 << 13)
38 #define TYPE_LEAVE_LIST (1 << 14)
39 #define TYPE_EMPTY (1 << 15)
40 #define TYPE_KEYTEXT (1 << 16)
42 #define TYPE_GHOSTED (1 << 17)
43 #define TYPE_QUERY (1 << 18)
45 /* additional values for internal purposes */
46 #define TYPE_BITFIELD (1 << 19)
47 #define TYPE_ELEMENT (1 << 20)
48 #define TYPE_CONTENT (1 << 21)
49 #define TYPE_ELEMENT_LIST (1 << 22)
50 #define TYPE_CONTENT_LIST (1 << 23)
52 /* derived values for setup file handling */
53 #define TYPE_BOOLEAN_STYLE (TYPE_BOOLEAN | \
58 /* derived values for setup screen */
59 #define TYPE_VALUE (TYPE_BOOLEAN_STYLE | \
66 #define TYPE_SKIP_ENTRY (TYPE_EMPTY | \
71 #define TYPE_ENTER (TYPE_ENTER_SCREEN | \
75 #define TYPE_LEAVE (TYPE_LEAVE_SCREEN | \
79 #define TYPE_ENTER_OR_LEAVE (TYPE_ENTER | TYPE_LEAVE)
81 /* cookie token for file identifier and version number */
82 #define TOKEN_STR_FILE_IDENTIFIER "file_identifier"
91 /* some definitions for list and hash handling */
92 typedef struct SetupFileList SetupFileList;
93 typedef struct hashtable SetupFileHash;
95 #define BEGIN_HASH_ITERATION(hash, itr) \
96 if (hash != NULL && hashtable_count(hash) > 0) \
98 struct hashtable_itr *itr = hashtable_iterator(hash); \
101 #define HASH_ITERATION_TOKEN(itr) ((char *)hashtable_iterator_key(itr))
102 #define HASH_ITERATION_VALUE(itr) ((char *)hashtable_iterator_value(itr))
104 #define END_HASH_ITERATION(hash, itr) \
105 } while (hashtable_iterator_advance(itr)); \
110 /* sort priorities of level series (also used as level series classes) */
111 #define LEVELCLASS_TUTORIAL_START 10
112 #define LEVELCLASS_TUTORIAL_END 99
113 #define LEVELCLASS_CLASSICS_START 100
114 #define LEVELCLASS_CLASSICS_END 199
115 #define LEVELCLASS_CONTRIB_START 200
116 #define LEVELCLASS_CONTRIB_END 299
117 #define LEVELCLASS_PRIVATE_START 300
118 #define LEVELCLASS_PRIVATE_END 399
119 #define LEVELCLASS_BD_START 400
120 #define LEVELCLASS_BD_END 499
121 #define LEVELCLASS_EM_START 500
122 #define LEVELCLASS_EM_END 599
123 #define LEVELCLASS_SP_START 600
124 #define LEVELCLASS_SP_END 699
125 #define LEVELCLASS_DX_START 700
126 #define LEVELCLASS_DX_END 799
127 #define LEVELCLASS_SB_START 800
128 #define LEVELCLASS_SB_END 899
130 #define LEVELCLASS_PREDEFINED_START LEVELCLASS_TUTORIAL_START
131 #define LEVELCLASS_PREDEFINED_END LEVELCLASS_SB_END
133 #define LEVELCLASS_TUTORIAL LEVELCLASS_TUTORIAL_START
134 #define LEVELCLASS_CLASSICS LEVELCLASS_CLASSICS_START
135 #define LEVELCLASS_CONTRIB LEVELCLASS_CONTRIB_START
136 #define LEVELCLASS_PRIVATE LEVELCLASS_PRIVATE_START
137 #define LEVELCLASS_BD LEVELCLASS_BD_START
138 #define LEVELCLASS_EM LEVELCLASS_EM_START
139 #define LEVELCLASS_SP LEVELCLASS_SP_START
140 #define LEVELCLASS_DX LEVELCLASS_DX_START
141 #define LEVELCLASS_SB LEVELCLASS_SB_START
143 #define LEVELCLASS_UNDEFINED 999
145 #define IS_LEVELCLASS_TUTORIAL(p) \
146 ((p)->sort_priority >= LEVELCLASS_TUTORIAL_START && \
147 (p)->sort_priority <= LEVELCLASS_TUTORIAL_END)
148 #define IS_LEVELCLASS_CLASSICS(p) \
149 ((p)->sort_priority >= LEVELCLASS_CLASSICS_START && \
150 (p)->sort_priority <= LEVELCLASS_CLASSICS_END)
151 #define IS_LEVELCLASS_CONTRIB(p) \
152 ((p)->sort_priority >= LEVELCLASS_CONTRIB_START && \
153 (p)->sort_priority <= LEVELCLASS_CONTRIB_END)
154 #define IS_LEVELCLASS_PRIVATE(p) \
155 ((p)->sort_priority >= LEVELCLASS_PRIVATE_START && \
156 (p)->sort_priority <= LEVELCLASS_PRIVATE_END)
157 #define IS_LEVELCLASS_BD(p) \
158 ((p)->sort_priority >= LEVELCLASS_BD_START && \
159 (p)->sort_priority <= LEVELCLASS_BD_END)
160 #define IS_LEVELCLASS_EM(p) \
161 ((p)->sort_priority >= LEVELCLASS_EM_START && \
162 (p)->sort_priority <= LEVELCLASS_EM_END)
163 #define IS_LEVELCLASS_SP(p) \
164 ((p)->sort_priority >= LEVELCLASS_SP_START && \
165 (p)->sort_priority <= LEVELCLASS_SP_END)
166 #define IS_LEVELCLASS_DX(p) \
167 ((p)->sort_priority >= LEVELCLASS_DX_START && \
168 (p)->sort_priority <= LEVELCLASS_DX_END)
169 #define IS_LEVELCLASS_SB(p) \
170 ((p)->sort_priority >= LEVELCLASS_SB_START && \
171 (p)->sort_priority <= LEVELCLASS_SB_END)
172 #define IS_LEVELCLASS_UNDEFINED(p) \
173 ((p)->sort_priority < LEVELCLASS_PREDEFINED_START || \
174 (p)->sort_priority > LEVELCLASS_PREDEFINED_END)
176 #define LEVELCLASS(n) (IS_LEVELCLASS_TUTORIAL(n) ? LEVELCLASS_TUTORIAL : \
177 IS_LEVELCLASS_CLASSICS(n) ? LEVELCLASS_CLASSICS : \
178 IS_LEVELCLASS_CONTRIB(n) ? LEVELCLASS_CONTRIB : \
179 IS_LEVELCLASS_PRIVATE(n) ? LEVELCLASS_PRIVATE : \
180 IS_LEVELCLASS_BD(n) ? LEVELCLASS_BD : \
181 IS_LEVELCLASS_EM(n) ? LEVELCLASS_EM : \
182 IS_LEVELCLASS_SP(n) ? LEVELCLASS_SP : \
183 IS_LEVELCLASS_DX(n) ? LEVELCLASS_DX : \
184 IS_LEVELCLASS_SB(n) ? LEVELCLASS_SB : \
185 LEVELCLASS_UNDEFINED)
187 /* sort priorities of artwork */
188 #define ARTWORKCLASS_CLASSICS_START 100
189 #define ARTWORKCLASS_CLASSICS_END 199
190 #define ARTWORKCLASS_CONTRIB_START 200
191 #define ARTWORKCLASS_CONTRIB_END 299
192 #define ARTWORKCLASS_PRIVATE_START 300
193 #define ARTWORKCLASS_PRIVATE_END 399
194 #define ARTWORKCLASS_LEVEL_START 400
195 #define ARTWORKCLASS_LEVEL_END 499
197 #define ARTWORKCLASS_CLASSICS ARTWORKCLASS_CLASSICS_START
198 #define ARTWORKCLASS_CONTRIB ARTWORKCLASS_CONTRIB_START
199 #define ARTWORKCLASS_PRIVATE ARTWORKCLASS_PRIVATE_START
200 #define ARTWORKCLASS_LEVEL ARTWORKCLASS_LEVEL_START
202 #define ARTWORKCLASS_UNDEFINED 999
204 #define IS_ARTWORKCLASS_CLASSICS(p) \
205 ((p)->sort_priority >= ARTWORKCLASS_CLASSICS_START && \
206 (p)->sort_priority <= ARTWORKCLASS_CLASSICS_END)
207 #define IS_ARTWORKCLASS_CONTRIB(p) \
208 ((p)->sort_priority >= ARTWORKCLASS_CONTRIB_START && \
209 (p)->sort_priority <= ARTWORKCLASS_CONTRIB_END)
210 #define IS_ARTWORKCLASS_PRIVATE(p) \
211 ((p)->sort_priority >= ARTWORKCLASS_PRIVATE_START && \
212 (p)->sort_priority <= ARTWORKCLASS_PRIVATE_END)
213 #define IS_ARTWORKCLASS_LEVEL(p) \
214 ((p)->sort_priority >= ARTWORKCLASS_LEVEL_START && \
215 (p)->sort_priority <= ARTWORKCLASS_LEVEL_END)
217 #define ARTWORKCLASS(n) (IS_ARTWORKCLASS_CLASSICS(n) ? ARTWORKCLASS_CLASSICS :\
218 IS_ARTWORKCLASS_CONTRIB(n) ? ARTWORKCLASS_CONTRIB : \
219 IS_ARTWORKCLASS_PRIVATE(n) ? ARTWORKCLASS_PRIVATE : \
220 IS_ARTWORKCLASS_LEVEL(n) ? ARTWORKCLASS_LEVEL : \
221 ARTWORKCLASS_UNDEFINED)
224 char *setLevelArtworkDir(TreeInfo *);
225 char *getTapeFilename(int);
226 char *getSolutionTapeFilename(int);
227 char *getScoreFilename(int);
228 char *getSetupFilename(void);
229 char *getEditorSetupFilename(void);
230 char *getHelpAnimFilename(void);
231 char *getHelpTextFilename(void);
232 char *getLevelSetInfoFilename(void);
233 char *getLevelSetTitleMessageFilename(int, boolean);
234 char *getImageFilename(char *);
235 char *getCustomImageFilename(char *);
236 char *getCustomSoundFilename(char *);
237 char *getCustomMusicFilename(char *);
238 char *getCustomArtworkFilename(char *, int);
239 char *getCustomArtworkConfigFilename(int);
240 char *getCustomArtworkLevelConfigFilename(int);
241 char *getCustomMusicDirectory(void);
243 void InitTapeDirectory(char *);
244 void InitScoreDirectory(char *);
245 void InitUserLevelDirectory(char *);
246 void InitLevelSetupDirectory(char *);
248 TreeInfo *newTreeInfo();
249 TreeInfo *newTreeInfo_setDefaults(int);
250 void pushTreeInfo(TreeInfo **, TreeInfo *);
251 int numTreeInfo(TreeInfo *);
252 boolean validLevelSeries(TreeInfo *);
253 TreeInfo *getFirstValidTreeInfoEntry(TreeInfo *);
254 TreeInfo *getTreeInfoFirstGroupEntry(TreeInfo *);
255 int numTreeInfoInGroup(TreeInfo *);
256 int posTreeInfo(TreeInfo *);
257 TreeInfo *getTreeInfoFromPos(TreeInfo *, int);
258 TreeInfo *getTreeInfoFromIdentifier(TreeInfo *, char *);
259 void dumpTreeInfo(TreeInfo *, int);
260 void sortTreeInfoBySortFunction(TreeInfo **,
261 int (*compare_function)(const void *,
263 void sortTreeInfo(TreeInfo **);
265 char *getHomeDir(void);
266 char *getCommonDataDir(void);
267 char *getPersonalDataDir(void);
268 char *getUserGameDataDir(void);
269 char *getSetupDir(void);
270 char *getCurrentLevelDir(void);
272 void updateUserGameDataDir(void);
274 void createDirectory(char *, char *, int);
275 void InitUserDataDirectory(void);
276 void SetFilePermissions(char *, int);
278 char *getCookie(char *);
279 int getFileVersionFromCookieString(const char *);
280 boolean checkCookieString(const char *, const char *);
282 char *getFormattedSetupEntry(char *, char *);
284 boolean getTokenValueFromSetupLine(char *, char **, char **);
286 SetupFileList *newSetupFileList(char *, char *);
287 void freeSetupFileList(SetupFileList *);
288 char *getListEntry(SetupFileList *, char *);
289 SetupFileList *setListEntry(SetupFileList *, char *, char *);
290 SetupFileList *addListEntry(SetupFileList *, char *, char *);
291 SetupFileList *loadSetupFileList(char *);
293 SetupFileHash *newSetupFileHash();
294 void freeSetupFileHash(SetupFileHash *);
295 char *getHashEntry(SetupFileHash *, char *);
296 void setHashEntry(SetupFileHash *, char *, char *);
297 char *removeHashEntry(SetupFileHash *, char *);
298 SetupFileHash *loadSetupFileHash(char *);
299 void checkSetupFileHashIdentifier(SetupFileHash *, char *, char *);
300 void setSetupInfo(struct TokenInfo *, int, char *);
301 char *getSetupValue(int, void *);
302 char *getSetupLine(struct TokenInfo *, char *, int);
304 boolean AdjustGraphicsForEMC();
306 void LoadLevelInfo(void);
307 void LoadArtworkInfo(void);
308 void LoadLevelArtworkInfo(void);
310 void LoadLevelSetup_LastSeries(void);
311 void SaveLevelSetup_LastSeries(void);
312 void LoadLevelSetup_SeriesInfo(void);
313 void SaveLevelSetup_SeriesInfo(void);