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_MENU (1 << 8)
37 #define TYPE_LEAVE_MENU (1 << 9)
38 #define TYPE_EMPTY (1 << 10)
39 #define TYPE_KEYTEXT (1 << 11)
41 #define TYPE_GHOSTED (1 << 12)
42 #define TYPE_QUERY (1 << 13)
44 #define TYPE_VALUE (TYPE_BOOLEAN_STYLE | \
51 #define TYPE_SKIP_ENTRY (TYPE_EMPTY | \
55 #define TYPE_ENTER_OR_LEAVE_MENU (TYPE_ENTER_MENU | \
58 /* cookie token for file identifier and version number */
59 #define TOKEN_STR_FILE_IDENTIFIER "file_identifier"
68 /* some definitions for list and hash handling */
69 typedef struct SetupFileList SetupFileList;
70 typedef struct hashtable SetupFileHash;
72 #define BEGIN_HASH_ITERATION(hash, itr) \
73 if (hash != NULL && hashtable_count(hash) > 0) \
75 struct hashtable_itr *itr = hashtable_iterator(hash); \
78 #define HASH_ITERATION_TOKEN(itr) ((char *)hashtable_iterator_key(itr))
79 #define HASH_ITERATION_VALUE(itr) ((char *)hashtable_iterator_value(itr))
81 #define END_HASH_ITERATION(hash, itr) \
82 } while (hashtable_iterator_advance(itr)); \
87 /* sort priorities of level series (also used as level series classes) */
88 #define LEVELCLASS_TUTORIAL_START 10
89 #define LEVELCLASS_TUTORIAL_END 99
90 #define LEVELCLASS_CLASSICS_START 100
91 #define LEVELCLASS_CLASSICS_END 199
92 #define LEVELCLASS_CONTRIB_START 200
93 #define LEVELCLASS_CONTRIB_END 299
94 #define LEVELCLASS_PRIVATE_START 300
95 #define LEVELCLASS_PRIVATE_END 399
96 #define LEVELCLASS_BD_START 400
97 #define LEVELCLASS_BD_END 499
98 #define LEVELCLASS_EM_START 500
99 #define LEVELCLASS_EM_END 599
100 #define LEVELCLASS_SP_START 600
101 #define LEVELCLASS_SP_END 699
102 #define LEVELCLASS_DX_START 700
103 #define LEVELCLASS_DX_END 799
105 #define LEVELCLASS_PREDEFINED_START LEVELCLASS_TUTORIAL_START
106 #define LEVELCLASS_PREDEFINED_END LEVELCLASS_DX_END
108 #define LEVELCLASS_TUTORIAL LEVELCLASS_TUTORIAL_START
109 #define LEVELCLASS_CLASSICS LEVELCLASS_CLASSICS_START
110 #define LEVELCLASS_CONTRIB LEVELCLASS_CONTRIB_START
111 #define LEVELCLASS_PRIVATE LEVELCLASS_PRIVATE_START
112 #define LEVELCLASS_BD LEVELCLASS_BD_START
113 #define LEVELCLASS_EM LEVELCLASS_EM_START
114 #define LEVELCLASS_SP LEVELCLASS_SP_START
115 #define LEVELCLASS_DX LEVELCLASS_DX_START
117 #define LEVELCLASS_UNDEFINED 999
119 #define IS_LEVELCLASS_TUTORIAL(p) \
120 ((p)->sort_priority >= LEVELCLASS_TUTORIAL_START && \
121 (p)->sort_priority <= LEVELCLASS_TUTORIAL_END)
122 #define IS_LEVELCLASS_CLASSICS(p) \
123 ((p)->sort_priority >= LEVELCLASS_CLASSICS_START && \
124 (p)->sort_priority <= LEVELCLASS_CLASSICS_END)
125 #define IS_LEVELCLASS_CONTRIB(p) \
126 ((p)->sort_priority >= LEVELCLASS_CONTRIB_START && \
127 (p)->sort_priority <= LEVELCLASS_CONTRIB_END)
128 #define IS_LEVELCLASS_PRIVATE(p) \
129 ((p)->sort_priority >= LEVELCLASS_PRIVATE_START && \
130 (p)->sort_priority <= LEVELCLASS_PRIVATE_END)
131 #define IS_LEVELCLASS_BD(p) \
132 ((p)->sort_priority >= LEVELCLASS_BD_START && \
133 (p)->sort_priority <= LEVELCLASS_BD_END)
134 #define IS_LEVELCLASS_EM(p) \
135 ((p)->sort_priority >= LEVELCLASS_EM_START && \
136 (p)->sort_priority <= LEVELCLASS_EM_END)
137 #define IS_LEVELCLASS_SP(p) \
138 ((p)->sort_priority >= LEVELCLASS_SP_START && \
139 (p)->sort_priority <= LEVELCLASS_SP_END)
140 #define IS_LEVELCLASS_DX(p) \
141 ((p)->sort_priority >= LEVELCLASS_DX_START && \
142 (p)->sort_priority <= LEVELCLASS_DX_END)
143 #define IS_LEVELCLASS_UNDEFINED(p) \
144 ((p)->sort_priority < LEVELCLASS_PREDEFINED_START || \
145 (p)->sort_priority > LEVELCLASS_PREDEFINED_END)
147 #define LEVELCLASS(n) (IS_LEVELCLASS_TUTORIAL(n) ? LEVELCLASS_TUTORIAL : \
148 IS_LEVELCLASS_CLASSICS(n) ? LEVELCLASS_CLASSICS : \
149 IS_LEVELCLASS_CONTRIB(n) ? LEVELCLASS_CONTRIB : \
150 IS_LEVELCLASS_PRIVATE(n) ? LEVELCLASS_PRIVATE : \
151 IS_LEVELCLASS_BD(n) ? LEVELCLASS_BD : \
152 IS_LEVELCLASS_EM(n) ? LEVELCLASS_EM : \
153 IS_LEVELCLASS_SP(n) ? LEVELCLASS_SP : \
154 IS_LEVELCLASS_DX(n) ? LEVELCLASS_DX : \
155 LEVELCLASS_UNDEFINED)
157 /* sort priorities of artwork */
158 #define ARTWORKCLASS_CLASSICS_START 100
159 #define ARTWORKCLASS_CLASSICS_END 199
160 #define ARTWORKCLASS_CONTRIB_START 200
161 #define ARTWORKCLASS_CONTRIB_END 299
162 #define ARTWORKCLASS_PRIVATE_START 300
163 #define ARTWORKCLASS_PRIVATE_END 399
164 #define ARTWORKCLASS_LEVEL_START 400
165 #define ARTWORKCLASS_LEVEL_END 499
167 #define ARTWORKCLASS_CLASSICS ARTWORKCLASS_CLASSICS_START
168 #define ARTWORKCLASS_CONTRIB ARTWORKCLASS_CONTRIB_START
169 #define ARTWORKCLASS_PRIVATE ARTWORKCLASS_PRIVATE_START
170 #define ARTWORKCLASS_LEVEL ARTWORKCLASS_LEVEL_START
172 #define ARTWORKCLASS_UNDEFINED 999
174 #define IS_ARTWORKCLASS_CLASSICS(p) \
175 ((p)->sort_priority >= ARTWORKCLASS_CLASSICS_START && \
176 (p)->sort_priority <= ARTWORKCLASS_CLASSICS_END)
177 #define IS_ARTWORKCLASS_CONTRIB(p) \
178 ((p)->sort_priority >= ARTWORKCLASS_CONTRIB_START && \
179 (p)->sort_priority <= ARTWORKCLASS_CONTRIB_END)
180 #define IS_ARTWORKCLASS_PRIVATE(p) \
181 ((p)->sort_priority >= ARTWORKCLASS_PRIVATE_START && \
182 (p)->sort_priority <= ARTWORKCLASS_PRIVATE_END)
183 #define IS_ARTWORKCLASS_LEVEL(p) \
184 ((p)->sort_priority >= ARTWORKCLASS_LEVEL_START && \
185 (p)->sort_priority <= ARTWORKCLASS_LEVEL_END)
187 #define ARTWORKCLASS(n) (IS_ARTWORKCLASS_CLASSICS(n) ? ARTWORKCLASS_CLASSICS :\
188 IS_ARTWORKCLASS_CONTRIB(n) ? ARTWORKCLASS_CONTRIB : \
189 IS_ARTWORKCLASS_PRIVATE(n) ? ARTWORKCLASS_PRIVATE : \
190 IS_ARTWORKCLASS_LEVEL(n) ? ARTWORKCLASS_LEVEL : \
191 ARTWORKCLASS_UNDEFINED)
194 char *setLevelArtworkDir(TreeInfo *);
195 char *getLevelFilename(int);
196 char *getTapeFilename(int);
197 char *getScoreFilename(int);
198 char *getSetupFilename(void);
199 char *getImageFilename(char *);
200 char *getCustomImageFilename(char *);
201 char *getCustomSoundFilename(char *);
202 char *getCustomArtworkFilename(char *, int);
203 char *getCustomArtworkConfigFilename(int);
204 char *getCustomArtworkLevelConfigFilename(int);
205 char *getCustomMusicDirectory(void);
207 void InitTapeDirectory(char *);
208 void InitScoreDirectory(char *);
209 void InitUserLevelDirectory(char *);
210 void InitLevelSetupDirectory(char *);
212 TreeInfo *newTreeInfo();
213 void pushTreeInfo(TreeInfo **, TreeInfo *);
214 int numTreeInfo(TreeInfo *);
215 boolean validLevelSeries(TreeInfo *);
216 TreeInfo *getFirstValidTreeInfoEntry(TreeInfo *);
217 TreeInfo *getTreeInfoFirstGroupEntry(TreeInfo *);
218 int numTreeInfoInGroup(TreeInfo *);
219 int posTreeInfo(TreeInfo *);
220 TreeInfo *getTreeInfoFromPos(TreeInfo *, int);
221 TreeInfo *getTreeInfoFromIdentifier(TreeInfo *, char *);
222 void dumpTreeInfo(TreeInfo *, int);
223 void sortTreeInfo(TreeInfo **,
224 int (*compare_function)(const void *, const void *));
226 char *getUserDataDir(void);
227 char *getCommonDataDir(void);
228 char *getSetupDir(void);
229 void createDirectory(char *, char *, int);
230 void InitUserDataDirectory(void);
231 void SetFilePermissions(char *, int);
233 char *getCookie(char *);
234 int getFileVersionFromCookieString(const char *);
235 boolean checkCookieString(const char *, const char *);
237 char *getFormattedSetupEntry(char *, char *);
239 SetupFileList *newSetupFileList(char *, char *);
240 void freeSetupFileList(SetupFileList *);
241 char *getListEntry(SetupFileList *, char *);
242 SetupFileList *setListEntry(SetupFileList *, char *, char *);
243 SetupFileList *loadSetupFileList(char *);
245 SetupFileHash *newSetupFileHash();
246 void freeSetupFileHash(SetupFileHash *);
247 char *getHashEntry(SetupFileHash *, char *);
248 void setHashEntry(SetupFileHash *, char *, char *);
249 SetupFileHash *loadSetupFileHash(char *);
250 void checkSetupFileHashIdentifier(SetupFileHash *, char *);
251 void setSetupInfo(struct TokenInfo *, int, char *);
252 char *getSetupValue(int, void *);
253 char *getSetupLine(struct TokenInfo *, char *, int);
255 void LoadLevelInfo(void);
256 void LoadArtworkInfo(void);
257 void LoadLevelArtworkInfo(void);
259 void LoadLevelSetup_LastSeries(void);
260 void SaveLevelSetup_LastSeries(void);
261 void LoadLevelSetup_SeriesInfo(void);
262 void SaveLevelSetup_SeriesInfo(void);