1 /***********************************************************
2 * Artsoft Retro-Game Library *
3 *----------------------------------------------------------*
4 * (c) 1994-2002 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_KEY (1 << 3)
26 #define TYPE_KEY_X11 (1 << 4)
27 #define TYPE_INTEGER (1 << 5)
28 #define TYPE_STRING (1 << 6)
29 #define TYPE_TOKEN (1 << 7)
31 #define TYPE_BOOLEAN_STYLE (TYPE_BOOLEAN | \
35 /* additional values for setup screen */
36 #define TYPE_ENTER_SCREEN (1 << 8)
37 #define TYPE_ENTER_MENU (1 << 9)
38 #define TYPE_LEAVE_MENU (1 << 10)
39 #define TYPE_EMPTY (1 << 11)
40 #define TYPE_KEYTEXT (1 << 12)
42 #define TYPE_GHOSTED (1 << 13)
43 #define TYPE_QUERY (1 << 14)
45 #define TYPE_VALUE (TYPE_BOOLEAN_STYLE | \
52 #define TYPE_SKIP_ENTRY (TYPE_EMPTY | \
56 #define TYPE_ENTER_OR_LEAVE_MENU (TYPE_ENTER_SCREEN | \
60 /* cookie token for file identifier and version number */
61 #define TOKEN_STR_FILE_IDENTIFIER "file_identifier"
70 /* some definitions for list and hash handling */
71 typedef struct SetupFileList SetupFileList;
72 typedef struct hashtable SetupFileHash;
74 #define BEGIN_HASH_ITERATION(hash, itr) \
75 if (hash != NULL && hashtable_count(hash) > 0) \
77 struct hashtable_itr *itr = hashtable_iterator(hash); \
80 #define HASH_ITERATION_TOKEN(itr) ((char *)hashtable_iterator_key(itr))
81 #define HASH_ITERATION_VALUE(itr) ((char *)hashtable_iterator_value(itr))
83 #define END_HASH_ITERATION(hash, itr) \
84 } while (hashtable_iterator_advance(itr)); \
89 /* sort priorities of level series (also used as level series classes) */
90 #define LEVELCLASS_TUTORIAL_START 10
91 #define LEVELCLASS_TUTORIAL_END 99
92 #define LEVELCLASS_CLASSICS_START 100
93 #define LEVELCLASS_CLASSICS_END 199
94 #define LEVELCLASS_CONTRIB_START 200
95 #define LEVELCLASS_CONTRIB_END 299
96 #define LEVELCLASS_PRIVATE_START 300
97 #define LEVELCLASS_PRIVATE_END 399
98 #define LEVELCLASS_BD_START 400
99 #define LEVELCLASS_BD_END 499
100 #define LEVELCLASS_EM_START 500
101 #define LEVELCLASS_EM_END 599
102 #define LEVELCLASS_SP_START 600
103 #define LEVELCLASS_SP_END 699
104 #define LEVELCLASS_DX_START 700
105 #define LEVELCLASS_DX_END 799
106 #define LEVELCLASS_SB_START 800
107 #define LEVELCLASS_SB_END 899
109 #define LEVELCLASS_PREDEFINED_START LEVELCLASS_TUTORIAL_START
110 #define LEVELCLASS_PREDEFINED_END LEVELCLASS_SB_END
112 #define LEVELCLASS_TUTORIAL LEVELCLASS_TUTORIAL_START
113 #define LEVELCLASS_CLASSICS LEVELCLASS_CLASSICS_START
114 #define LEVELCLASS_CONTRIB LEVELCLASS_CONTRIB_START
115 #define LEVELCLASS_PRIVATE LEVELCLASS_PRIVATE_START
116 #define LEVELCLASS_BD LEVELCLASS_BD_START
117 #define LEVELCLASS_EM LEVELCLASS_EM_START
118 #define LEVELCLASS_SP LEVELCLASS_SP_START
119 #define LEVELCLASS_DX LEVELCLASS_DX_START
120 #define LEVELCLASS_SB LEVELCLASS_SB_START
122 #define LEVELCLASS_UNDEFINED 999
124 #define IS_LEVELCLASS_TUTORIAL(p) \
125 ((p)->sort_priority >= LEVELCLASS_TUTORIAL_START && \
126 (p)->sort_priority <= LEVELCLASS_TUTORIAL_END)
127 #define IS_LEVELCLASS_CLASSICS(p) \
128 ((p)->sort_priority >= LEVELCLASS_CLASSICS_START && \
129 (p)->sort_priority <= LEVELCLASS_CLASSICS_END)
130 #define IS_LEVELCLASS_CONTRIB(p) \
131 ((p)->sort_priority >= LEVELCLASS_CONTRIB_START && \
132 (p)->sort_priority <= LEVELCLASS_CONTRIB_END)
133 #define IS_LEVELCLASS_PRIVATE(p) \
134 ((p)->sort_priority >= LEVELCLASS_PRIVATE_START && \
135 (p)->sort_priority <= LEVELCLASS_PRIVATE_END)
136 #define IS_LEVELCLASS_BD(p) \
137 ((p)->sort_priority >= LEVELCLASS_BD_START && \
138 (p)->sort_priority <= LEVELCLASS_BD_END)
139 #define IS_LEVELCLASS_EM(p) \
140 ((p)->sort_priority >= LEVELCLASS_EM_START && \
141 (p)->sort_priority <= LEVELCLASS_EM_END)
142 #define IS_LEVELCLASS_SP(p) \
143 ((p)->sort_priority >= LEVELCLASS_SP_START && \
144 (p)->sort_priority <= LEVELCLASS_SP_END)
145 #define IS_LEVELCLASS_DX(p) \
146 ((p)->sort_priority >= LEVELCLASS_DX_START && \
147 (p)->sort_priority <= LEVELCLASS_DX_END)
148 #define IS_LEVELCLASS_SB(p) \
149 ((p)->sort_priority >= LEVELCLASS_SB_START && \
150 (p)->sort_priority <= LEVELCLASS_SB_END)
151 #define IS_LEVELCLASS_UNDEFINED(p) \
152 ((p)->sort_priority < LEVELCLASS_PREDEFINED_START || \
153 (p)->sort_priority > LEVELCLASS_PREDEFINED_END)
155 #define LEVELCLASS(n) (IS_LEVELCLASS_TUTORIAL(n) ? LEVELCLASS_TUTORIAL : \
156 IS_LEVELCLASS_CLASSICS(n) ? LEVELCLASS_CLASSICS : \
157 IS_LEVELCLASS_CONTRIB(n) ? LEVELCLASS_CONTRIB : \
158 IS_LEVELCLASS_PRIVATE(n) ? LEVELCLASS_PRIVATE : \
159 IS_LEVELCLASS_BD(n) ? LEVELCLASS_BD : \
160 IS_LEVELCLASS_EM(n) ? LEVELCLASS_EM : \
161 IS_LEVELCLASS_SP(n) ? LEVELCLASS_SP : \
162 IS_LEVELCLASS_DX(n) ? LEVELCLASS_DX : \
163 IS_LEVELCLASS_SB(n) ? LEVELCLASS_SB : \
164 LEVELCLASS_UNDEFINED)
166 /* sort priorities of artwork */
167 #define ARTWORKCLASS_CLASSICS_START 100
168 #define ARTWORKCLASS_CLASSICS_END 199
169 #define ARTWORKCLASS_CONTRIB_START 200
170 #define ARTWORKCLASS_CONTRIB_END 299
171 #define ARTWORKCLASS_PRIVATE_START 300
172 #define ARTWORKCLASS_PRIVATE_END 399
173 #define ARTWORKCLASS_LEVEL_START 400
174 #define ARTWORKCLASS_LEVEL_END 499
176 #define ARTWORKCLASS_CLASSICS ARTWORKCLASS_CLASSICS_START
177 #define ARTWORKCLASS_CONTRIB ARTWORKCLASS_CONTRIB_START
178 #define ARTWORKCLASS_PRIVATE ARTWORKCLASS_PRIVATE_START
179 #define ARTWORKCLASS_LEVEL ARTWORKCLASS_LEVEL_START
181 #define ARTWORKCLASS_UNDEFINED 999
183 #define IS_ARTWORKCLASS_CLASSICS(p) \
184 ((p)->sort_priority >= ARTWORKCLASS_CLASSICS_START && \
185 (p)->sort_priority <= ARTWORKCLASS_CLASSICS_END)
186 #define IS_ARTWORKCLASS_CONTRIB(p) \
187 ((p)->sort_priority >= ARTWORKCLASS_CONTRIB_START && \
188 (p)->sort_priority <= ARTWORKCLASS_CONTRIB_END)
189 #define IS_ARTWORKCLASS_PRIVATE(p) \
190 ((p)->sort_priority >= ARTWORKCLASS_PRIVATE_START && \
191 (p)->sort_priority <= ARTWORKCLASS_PRIVATE_END)
192 #define IS_ARTWORKCLASS_LEVEL(p) \
193 ((p)->sort_priority >= ARTWORKCLASS_LEVEL_START && \
194 (p)->sort_priority <= ARTWORKCLASS_LEVEL_END)
196 #define ARTWORKCLASS(n) (IS_ARTWORKCLASS_CLASSICS(n) ? ARTWORKCLASS_CLASSICS :\
197 IS_ARTWORKCLASS_CONTRIB(n) ? ARTWORKCLASS_CONTRIB : \
198 IS_ARTWORKCLASS_PRIVATE(n) ? ARTWORKCLASS_PRIVATE : \
199 IS_ARTWORKCLASS_LEVEL(n) ? ARTWORKCLASS_LEVEL : \
200 ARTWORKCLASS_UNDEFINED)
203 char *setLevelArtworkDir(TreeInfo *);
204 char *getTapeFilename(int);
205 char *getSolutionTapeFilename(int);
206 char *getScoreFilename(int);
207 char *getSetupFilename(void);
208 char *getEditorSetupFilename(void);
209 char *getHelpAnimFilename(void);
210 char *getHelpTextFilename(void);
211 char *getLevelSetInfoFilename(void);
212 char *getImageFilename(char *);
213 char *getCustomImageFilename(char *);
214 char *getCustomSoundFilename(char *);
215 char *getCustomMusicFilename(char *);
216 char *getCustomArtworkFilename(char *, int);
217 char *getCustomArtworkConfigFilename(int);
218 char *getCustomArtworkLevelConfigFilename(int);
219 char *getCustomMusicDirectory(void);
221 void InitTapeDirectory(char *);
222 void InitScoreDirectory(char *);
223 void InitUserLevelDirectory(char *);
224 void InitLevelSetupDirectory(char *);
226 TreeInfo *newTreeInfo();
227 void pushTreeInfo(TreeInfo **, TreeInfo *);
228 int numTreeInfo(TreeInfo *);
229 boolean validLevelSeries(TreeInfo *);
230 TreeInfo *getFirstValidTreeInfoEntry(TreeInfo *);
231 TreeInfo *getTreeInfoFirstGroupEntry(TreeInfo *);
232 int numTreeInfoInGroup(TreeInfo *);
233 int posTreeInfo(TreeInfo *);
234 TreeInfo *getTreeInfoFromPos(TreeInfo *, int);
235 TreeInfo *getTreeInfoFromIdentifier(TreeInfo *, char *);
236 void dumpTreeInfo(TreeInfo *, int);
237 void sortTreeInfo(TreeInfo **,
238 int (*compare_function)(const void *, const void *));
240 char *getUserDataDir(void);
241 char *getCommonDataDir(void);
242 char *getSetupDir(void);
243 char *getCurrentLevelDir(void);
245 void createDirectory(char *, char *, int);
246 void InitUserDataDirectory(void);
247 void SetFilePermissions(char *, int);
249 char *getCookie(char *);
250 int getFileVersionFromCookieString(const char *);
251 boolean checkCookieString(const char *, const char *);
253 char *getFormattedSetupEntry(char *, char *);
255 SetupFileList *newSetupFileList(char *, char *);
256 void freeSetupFileList(SetupFileList *);
257 char *getListEntry(SetupFileList *, char *);
258 SetupFileList *setListEntry(SetupFileList *, char *, char *);
259 SetupFileList *addListEntry(SetupFileList *, char *, char *);
260 SetupFileList *loadSetupFileList(char *);
262 SetupFileHash *newSetupFileHash();
263 void freeSetupFileHash(SetupFileHash *);
264 char *getHashEntry(SetupFileHash *, char *);
265 void setHashEntry(SetupFileHash *, char *, char *);
266 char *removeHashEntry(SetupFileHash *, char *);
267 SetupFileHash *loadSetupFileHash(char *);
268 void checkSetupFileHashIdentifier(SetupFileHash *, char *, char *);
269 void setSetupInfo(struct TokenInfo *, int, char *);
270 char *getSetupValue(int, void *);
271 char *getSetupLine(struct TokenInfo *, char *, int);
273 void LoadLevelInfo(void);
274 void LoadArtworkInfo(void);
275 void LoadLevelArtworkInfo(void);
277 void LoadLevelSetup_LastSeries(void);
278 void SaveLevelSetup_LastSeries(void);
279 void LoadLevelSetup_SeriesInfo(void);
280 void SaveLevelSetup_SeriesInfo(void);