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