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_ELEMENT (1 << 8)
31 #define TYPE_GRAPHIC (1 << 9)
33 /* additional values for setup screen */
34 #define TYPE_ENTER_SCREEN (1 << 10)
35 #define TYPE_LEAVE_SCREEN (1 << 11)
36 #define TYPE_ENTER_MENU (1 << 12)
37 #define TYPE_LEAVE_MENU (1 << 13)
38 #define TYPE_ENTER_LIST (1 << 14)
39 #define TYPE_LEAVE_LIST (1 << 15)
40 #define TYPE_EMPTY (1 << 16)
41 #define TYPE_KEYTEXT (1 << 17)
43 #define TYPE_GHOSTED (1 << 18)
44 #define TYPE_QUERY (1 << 19)
46 /* additional values for internal purposes */
47 #define TYPE_BITFIELD (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 | \
67 #define TYPE_SKIP_ENTRY (TYPE_EMPTY | \
72 #define TYPE_ENTER (TYPE_ENTER_SCREEN | \
76 #define TYPE_LEAVE (TYPE_LEAVE_SCREEN | \
80 #define TYPE_ENTER_OR_LEAVE (TYPE_ENTER | TYPE_LEAVE)
82 /* cookie token for file identifier and version number */
83 #define TOKEN_STR_FILE_IDENTIFIER "file_identifier"
92 /* some definitions for list and hash handling */
93 typedef struct SetupFileList SetupFileList;
94 typedef struct hashtable SetupFileHash;
96 #define BEGIN_HASH_ITERATION(hash, itr) \
97 if (hash != NULL && hashtable_count(hash) > 0) \
99 struct hashtable_itr *itr = hashtable_iterator(hash); \
102 #define HASH_ITERATION_TOKEN(itr) ((char *)hashtable_iterator_key(itr))
103 #define HASH_ITERATION_VALUE(itr) ((char *)hashtable_iterator_value(itr))
105 #define END_HASH_ITERATION(hash, itr) \
106 } while (hashtable_iterator_advance(itr)); \
111 /* sort priorities of level series (also used as level series classes) */
112 #define LEVELCLASS_TUTORIAL_START 10
113 #define LEVELCLASS_TUTORIAL_END 99
114 #define LEVELCLASS_CLASSICS_START 100
115 #define LEVELCLASS_CLASSICS_END 199
116 #define LEVELCLASS_CONTRIB_START 200
117 #define LEVELCLASS_CONTRIB_END 299
118 #define LEVELCLASS_PRIVATE_START 300
119 #define LEVELCLASS_PRIVATE_END 399
120 #define LEVELCLASS_BD_START 400
121 #define LEVELCLASS_BD_END 499
122 #define LEVELCLASS_EM_START 500
123 #define LEVELCLASS_EM_END 599
124 #define LEVELCLASS_SP_START 600
125 #define LEVELCLASS_SP_END 699
126 #define LEVELCLASS_DX_START 700
127 #define LEVELCLASS_DX_END 799
128 #define LEVELCLASS_SB_START 800
129 #define LEVELCLASS_SB_END 899
131 #define LEVELCLASS_PREDEFINED_START LEVELCLASS_TUTORIAL_START
132 #define LEVELCLASS_PREDEFINED_END LEVELCLASS_SB_END
134 #define LEVELCLASS_TUTORIAL LEVELCLASS_TUTORIAL_START
135 #define LEVELCLASS_CLASSICS LEVELCLASS_CLASSICS_START
136 #define LEVELCLASS_CONTRIB LEVELCLASS_CONTRIB_START
137 #define LEVELCLASS_PRIVATE LEVELCLASS_PRIVATE_START
138 #define LEVELCLASS_BD LEVELCLASS_BD_START
139 #define LEVELCLASS_EM LEVELCLASS_EM_START
140 #define LEVELCLASS_SP LEVELCLASS_SP_START
141 #define LEVELCLASS_DX LEVELCLASS_DX_START
142 #define LEVELCLASS_SB LEVELCLASS_SB_START
144 #define LEVELCLASS_UNDEFINED 999
146 #define IS_LEVELCLASS_TUTORIAL(p) \
147 ((p)->sort_priority >= LEVELCLASS_TUTORIAL_START && \
148 (p)->sort_priority <= LEVELCLASS_TUTORIAL_END)
149 #define IS_LEVELCLASS_CLASSICS(p) \
150 ((p)->sort_priority >= LEVELCLASS_CLASSICS_START && \
151 (p)->sort_priority <= LEVELCLASS_CLASSICS_END)
152 #define IS_LEVELCLASS_CONTRIB(p) \
153 ((p)->sort_priority >= LEVELCLASS_CONTRIB_START && \
154 (p)->sort_priority <= LEVELCLASS_CONTRIB_END)
155 #define IS_LEVELCLASS_PRIVATE(p) \
156 ((p)->sort_priority >= LEVELCLASS_PRIVATE_START && \
157 (p)->sort_priority <= LEVELCLASS_PRIVATE_END)
158 #define IS_LEVELCLASS_BD(p) \
159 ((p)->sort_priority >= LEVELCLASS_BD_START && \
160 (p)->sort_priority <= LEVELCLASS_BD_END)
161 #define IS_LEVELCLASS_EM(p) \
162 ((p)->sort_priority >= LEVELCLASS_EM_START && \
163 (p)->sort_priority <= LEVELCLASS_EM_END)
164 #define IS_LEVELCLASS_SP(p) \
165 ((p)->sort_priority >= LEVELCLASS_SP_START && \
166 (p)->sort_priority <= LEVELCLASS_SP_END)
167 #define IS_LEVELCLASS_DX(p) \
168 ((p)->sort_priority >= LEVELCLASS_DX_START && \
169 (p)->sort_priority <= LEVELCLASS_DX_END)
170 #define IS_LEVELCLASS_SB(p) \
171 ((p)->sort_priority >= LEVELCLASS_SB_START && \
172 (p)->sort_priority <= LEVELCLASS_SB_END)
173 #define IS_LEVELCLASS_UNDEFINED(p) \
174 ((p)->sort_priority < LEVELCLASS_PREDEFINED_START || \
175 (p)->sort_priority > LEVELCLASS_PREDEFINED_END)
177 #define LEVELCLASS(n) (IS_LEVELCLASS_TUTORIAL(n) ? LEVELCLASS_TUTORIAL : \
178 IS_LEVELCLASS_CLASSICS(n) ? LEVELCLASS_CLASSICS : \
179 IS_LEVELCLASS_CONTRIB(n) ? LEVELCLASS_CONTRIB : \
180 IS_LEVELCLASS_PRIVATE(n) ? LEVELCLASS_PRIVATE : \
181 IS_LEVELCLASS_BD(n) ? LEVELCLASS_BD : \
182 IS_LEVELCLASS_EM(n) ? LEVELCLASS_EM : \
183 IS_LEVELCLASS_SP(n) ? LEVELCLASS_SP : \
184 IS_LEVELCLASS_DX(n) ? LEVELCLASS_DX : \
185 IS_LEVELCLASS_SB(n) ? LEVELCLASS_SB : \
186 LEVELCLASS_UNDEFINED)
188 /* sort priorities of artwork */
189 #define ARTWORKCLASS_CLASSICS_START 100
190 #define ARTWORKCLASS_CLASSICS_END 199
191 #define ARTWORKCLASS_CONTRIB_START 200
192 #define ARTWORKCLASS_CONTRIB_END 299
193 #define ARTWORKCLASS_PRIVATE_START 300
194 #define ARTWORKCLASS_PRIVATE_END 399
195 #define ARTWORKCLASS_LEVEL_START 400
196 #define ARTWORKCLASS_LEVEL_END 499
198 #define ARTWORKCLASS_CLASSICS ARTWORKCLASS_CLASSICS_START
199 #define ARTWORKCLASS_CONTRIB ARTWORKCLASS_CONTRIB_START
200 #define ARTWORKCLASS_PRIVATE ARTWORKCLASS_PRIVATE_START
201 #define ARTWORKCLASS_LEVEL ARTWORKCLASS_LEVEL_START
203 #define ARTWORKCLASS_UNDEFINED 999
205 #define IS_ARTWORKCLASS_CLASSICS(p) \
206 ((p)->sort_priority >= ARTWORKCLASS_CLASSICS_START && \
207 (p)->sort_priority <= ARTWORKCLASS_CLASSICS_END)
208 #define IS_ARTWORKCLASS_CONTRIB(p) \
209 ((p)->sort_priority >= ARTWORKCLASS_CONTRIB_START && \
210 (p)->sort_priority <= ARTWORKCLASS_CONTRIB_END)
211 #define IS_ARTWORKCLASS_PRIVATE(p) \
212 ((p)->sort_priority >= ARTWORKCLASS_PRIVATE_START && \
213 (p)->sort_priority <= ARTWORKCLASS_PRIVATE_END)
214 #define IS_ARTWORKCLASS_LEVEL(p) \
215 ((p)->sort_priority >= ARTWORKCLASS_LEVEL_START && \
216 (p)->sort_priority <= ARTWORKCLASS_LEVEL_END)
218 #define ARTWORKCLASS(n) (IS_ARTWORKCLASS_CLASSICS(n) ? ARTWORKCLASS_CLASSICS :\
219 IS_ARTWORKCLASS_CONTRIB(n) ? ARTWORKCLASS_CONTRIB : \
220 IS_ARTWORKCLASS_PRIVATE(n) ? ARTWORKCLASS_PRIVATE : \
221 IS_ARTWORKCLASS_LEVEL(n) ? ARTWORKCLASS_LEVEL : \
222 ARTWORKCLASS_UNDEFINED)
225 char *setLevelArtworkDir(TreeInfo *);
226 char *getTapeFilename(int);
227 char *getSolutionTapeFilename(int);
228 char *getScoreFilename(int);
229 char *getSetupFilename(void);
230 char *getEditorSetupFilename(void);
231 char *getHelpAnimFilename(void);
232 char *getHelpTextFilename(void);
233 char *getLevelSetInfoFilename(void);
234 char *getLevelSetTitleMessageFilename(int, boolean);
235 char *getImageFilename(char *);
236 char *getCustomImageFilename(char *);
237 char *getCustomSoundFilename(char *);
238 char *getCustomMusicFilename(char *);
239 char *getCustomArtworkFilename(char *, int);
240 char *getCustomArtworkConfigFilename(int);
241 char *getCustomArtworkLevelConfigFilename(int);
242 char *getCustomMusicDirectory(void);
244 void InitTapeDirectory(char *);
245 void InitScoreDirectory(char *);
246 void InitUserLevelDirectory(char *);
247 void InitLevelSetupDirectory(char *);
249 TreeInfo *newTreeInfo();
250 TreeInfo *newTreeInfo_setDefaults(int);
251 void pushTreeInfo(TreeInfo **, TreeInfo *);
252 int numTreeInfo(TreeInfo *);
253 boolean validLevelSeries(TreeInfo *);
254 TreeInfo *getFirstValidTreeInfoEntry(TreeInfo *);
255 TreeInfo *getTreeInfoFirstGroupEntry(TreeInfo *);
256 int numTreeInfoInGroup(TreeInfo *);
257 int posTreeInfo(TreeInfo *);
258 TreeInfo *getTreeInfoFromPos(TreeInfo *, int);
259 TreeInfo *getTreeInfoFromIdentifier(TreeInfo *, char *);
260 void dumpTreeInfo(TreeInfo *, int);
261 void sortTreeInfoBySortFunction(TreeInfo **,
262 int (*compare_function)(const void *,
264 void sortTreeInfo(TreeInfo **);
266 char *getHomeDir(void);
267 char *getCommonDataDir(void);
268 char *getPersonalDataDir(void);
269 char *getUserGameDataDir(void);
270 char *getSetupDir(void);
271 char *getCurrentLevelDir(void);
273 void updateUserGameDataDir(void);
275 void createDirectory(char *, char *, int);
276 void InitUserDataDirectory(void);
277 void SetFilePermissions(char *, int);
279 char *getCookie(char *);
280 int getFileVersionFromCookieString(const char *);
281 boolean checkCookieString(const char *, const char *);
283 char *getFormattedSetupEntry(char *, char *);
285 boolean getTokenValueFromSetupLine(char *, char **, char **);
287 SetupFileList *newSetupFileList(char *, char *);
288 void freeSetupFileList(SetupFileList *);
289 char *getListEntry(SetupFileList *, char *);
290 SetupFileList *setListEntry(SetupFileList *, char *, char *);
291 SetupFileList *addListEntry(SetupFileList *, char *, char *);
292 SetupFileList *loadSetupFileList(char *);
294 SetupFileHash *newSetupFileHash();
295 void freeSetupFileHash(SetupFileHash *);
296 char *getHashEntry(SetupFileHash *, char *);
297 void setHashEntry(SetupFileHash *, char *, char *);
298 char *removeHashEntry(SetupFileHash *, char *);
299 SetupFileHash *loadSetupFileHash(char *);
300 void checkSetupFileHashIdentifier(SetupFileHash *, char *, char *);
301 void setSetupInfo(struct TokenInfo *, int, char *);
302 char *getSetupValue(int, void *);
303 char *getSetupLine(struct TokenInfo *, char *, int);
305 boolean AdjustGraphicsForEMC();
307 void LoadLevelInfo(void);
308 void LoadArtworkInfo(void);
309 void LoadLevelArtworkInfo(void);
311 void LoadLevelSetup_LastSeries(void);
312 void SaveLevelSetup_LastSeries(void);
313 void LoadLevelSetup_SeriesInfo(void);
314 void SaveLevelSetup_SeriesInfo(void);