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 ***********************************************************/
20 /* values for setup file handling */
21 #define TYPE_BOOLEAN (1 << 0)
22 #define TYPE_SWITCH (1 << 1)
23 #define TYPE_YES_NO (1 << 2)
24 #define TYPE_KEY (1 << 3)
25 #define TYPE_KEY_X11 (1 << 4)
26 #define TYPE_INTEGER (1 << 5)
27 #define TYPE_STRING (1 << 6)
29 #define TYPE_BOOLEAN_STYLE (TYPE_BOOLEAN | \
33 /* additional values for setup screen */
34 #define TYPE_ENTER_MENU (1 << 7)
35 #define TYPE_LEAVE_MENU (1 << 8)
36 #define TYPE_EMPTY (1 << 9)
37 #define TYPE_KEYTEXT (1 << 10)
39 #define TYPE_GHOSTED (1 << 11)
40 #define TYPE_QUERY (1 << 12)
42 #define TYPE_VALUE (TYPE_BOOLEAN_STYLE | \
48 #define TYPE_SKIP_ENTRY (TYPE_EMPTY | \
52 #define TYPE_ENTER_OR_LEAVE_MENU (TYPE_ENTER_MENU | \
55 /* cookie token for file identifier and version number */
56 #define TOKEN_STR_FILE_IDENTIFIER "file_identifier"
65 /* sort priorities of level series (also used as level series classes) */
66 #define LEVELCLASS_TUTORIAL_START 10
67 #define LEVELCLASS_TUTORIAL_END 99
68 #define LEVELCLASS_CLASSICS_START 100
69 #define LEVELCLASS_CLASSICS_END 199
70 #define LEVELCLASS_CONTRIBUTION_START 200
71 #define LEVELCLASS_CONTRIBUTION_END 299
72 #define LEVELCLASS_USER_START 300
73 #define LEVELCLASS_USER_END 399
74 #define LEVELCLASS_BD_START 400
75 #define LEVELCLASS_BD_END 499
76 #define LEVELCLASS_EM_START 500
77 #define LEVELCLASS_EM_END 599
78 #define LEVELCLASS_SP_START 600
79 #define LEVELCLASS_SP_END 699
80 #define LEVELCLASS_DX_START 700
81 #define LEVELCLASS_DX_END 799
83 #define LEVELCLASS_TUTORIAL LEVELCLASS_TUTORIAL_START
84 #define LEVELCLASS_CLASSICS LEVELCLASS_CLASSICS_START
85 #define LEVELCLASS_CONTRIBUTION LEVELCLASS_CONTRIBUTION_START
86 #define LEVELCLASS_USER LEVELCLASS_USER_START
87 #define LEVELCLASS_BD LEVELCLASS_BD_START
88 #define LEVELCLASS_EM LEVELCLASS_EM_START
89 #define LEVELCLASS_SP LEVELCLASS_SP_START
90 #define LEVELCLASS_DX LEVELCLASS_DX_START
92 #define LEVELCLASS_UNDEFINED 999
94 #define IS_LEVELCLASS_TUTORIAL(p) \
95 ((p)->sort_priority >= LEVELCLASS_TUTORIAL_START && \
96 (p)->sort_priority <= LEVELCLASS_TUTORIAL_END)
97 #define IS_LEVELCLASS_CLASSICS(p) \
98 ((p)->sort_priority >= LEVELCLASS_CLASSICS_START && \
99 (p)->sort_priority <= LEVELCLASS_CLASSICS_END)
100 #define IS_LEVELCLASS_CONTRIBUTION(p) \
101 ((p)->sort_priority >= LEVELCLASS_CONTRIBUTION_START && \
102 (p)->sort_priority <= LEVELCLASS_CONTRIBUTION_END)
103 #define IS_LEVELCLASS_USER(p) \
104 ((p)->sort_priority >= LEVELCLASS_USER_START && \
105 (p)->sort_priority <= LEVELCLASS_USER_END)
106 #define IS_LEVELCLASS_BD(p) \
107 ((p)->sort_priority >= LEVELCLASS_BD_START && \
108 (p)->sort_priority <= LEVELCLASS_BD_END)
109 #define IS_LEVELCLASS_EM(p) \
110 ((p)->sort_priority >= LEVELCLASS_EM_START && \
111 (p)->sort_priority <= LEVELCLASS_EM_END)
112 #define IS_LEVELCLASS_SP(p) \
113 ((p)->sort_priority >= LEVELCLASS_SP_START && \
114 (p)->sort_priority <= LEVELCLASS_SP_END)
115 #define IS_LEVELCLASS_DX(p) \
116 ((p)->sort_priority >= LEVELCLASS_DX_START && \
117 (p)->sort_priority <= LEVELCLASS_DX_END)
119 #define LEVELCLASS(n) (IS_LEVELCLASS_TUTORIAL(n) ? LEVELCLASS_TUTORIAL : \
120 IS_LEVELCLASS_CLASSICS(n) ? LEVELCLASS_CLASSICS : \
121 IS_LEVELCLASS_CONTRIBUTION(n) ? LEVELCLASS_CONTRIBUTION : \
122 IS_LEVELCLASS_USER(n) ? LEVELCLASS_USER : \
123 IS_LEVELCLASS_BD(n) ? LEVELCLASS_BD : \
124 IS_LEVELCLASS_EM(n) ? LEVELCLASS_EM : \
125 IS_LEVELCLASS_SP(n) ? LEVELCLASS_SP : \
126 IS_LEVELCLASS_DX(n) ? LEVELCLASS_DX : \
127 LEVELCLASS_UNDEFINED)
129 /* sort priorities of artwork */
130 #define ARTWORKCLASS_CLASSICS_START 100
131 #define ARTWORKCLASS_CLASSICS_END 199
132 #define ARTWORKCLASS_CONTRIBUTION_START 200
133 #define ARTWORKCLASS_CONTRIBUTION_END 299
134 #define ARTWORKCLASS_LEVEL_START 300
135 #define ARTWORKCLASS_LEVEL_END 399
136 #define ARTWORKCLASS_USER_START 400
137 #define ARTWORKCLASS_USER_END 499
139 #define ARTWORKCLASS_CLASSICS ARTWORKCLASS_CLASSICS_START
140 #define ARTWORKCLASS_CONTRIBUTION ARTWORKCLASS_CONTRIBUTION_START
141 #define ARTWORKCLASS_LEVEL ARTWORKCLASS_LEVEL_START
142 #define ARTWORKCLASS_USER ARTWORKCLASS_USER_START
144 #define ARTWORKCLASS_UNDEFINED 999
146 #define IS_ARTWORKCLASS_CLASSICS(p) \
147 ((p)->sort_priority >= ARTWORKCLASS_CLASSICS_START && \
148 (p)->sort_priority <= ARTWORKCLASS_CLASSICS_END)
149 #define IS_ARTWORKCLASS_CONTRIBUTION(p) \
150 ((p)->sort_priority >= ARTWORKCLASS_CONTRIBUTION_START && \
151 (p)->sort_priority <= ARTWORKCLASS_CONTRIBUTION_END)
152 #define IS_ARTWORKCLASS_LEVEL(p) \
153 ((p)->sort_priority >= ARTWORKCLASS_LEVEL_START && \
154 (p)->sort_priority <= ARTWORKCLASS_LEVEL_END)
155 #define IS_ARTWORKCLASS_USER(p) \
156 ((p)->sort_priority >= ARTWORKCLASS_USER_START && \
157 (p)->sort_priority <= ARTWORKCLASS_USER_END)
159 #define ARTWORKCLASS(n) (IS_ARTWORKCLASS_CLASSICS(n) ? ARTWORKCLASS_CLASSICS :\
160 IS_ARTWORKCLASS_CONTRIBUTION(n) ? ARTWORKCLASS_CONTRIBUTION : \
161 IS_ARTWORKCLASS_LEVEL(n) ? ARTWORKCLASS_LEVEL : \
162 IS_ARTWORKCLASS_USER(n) ? ARTWORKCLASS_USER : \
163 ARTWORKCLASS_UNDEFINED)
166 void setLevelArtworkDir(TreeInfo *);
167 char *getLevelFilename(int);
168 char *getTapeFilename(int);
169 char *getScoreFilename(int);
170 char *getSetupFilename(void);
171 char *getImageFilename(char *);
172 char *getCustomImageFilename(char *);
173 char *getCustomSoundFilename(char *);
174 char *getCustomArtworkFilename(char *, int);
175 char *getCustomArtworkConfigFilename(int);
176 char *getCustomMusicDirectory(void);
178 void InitTapeDirectory(char *);
179 void InitScoreDirectory(char *);
180 void InitUserLevelDirectory(char *);
181 void InitLevelSetupDirectory(char *);
183 TreeInfo *newTreeInfo();
184 void pushTreeInfo(TreeInfo **, TreeInfo *);
185 int numTreeInfo(TreeInfo *);
186 boolean validLevelSeries(TreeInfo *);
187 TreeInfo *getFirstValidTreeInfoEntry(TreeInfo *);
188 TreeInfo *getTreeInfoFirstGroupEntry(TreeInfo *);
189 int numTreeInfoInGroup(TreeInfo *);
190 int posTreeInfo(TreeInfo *);
191 TreeInfo *getTreeInfoFromPos(TreeInfo *, int);
192 TreeInfo *getTreeInfoFromIdentifier(TreeInfo *, char *);
193 void dumpTreeInfo(TreeInfo *, int);
194 void sortTreeInfo(TreeInfo **,
195 int (*compare_function)(const void *, const void *));
197 char *getUserDataDir(void);
198 char *getSetupDir(void);
199 void createDirectory(char *, char *, int);
200 void InitUserDataDirectory(void);
201 void SetFilePermissions(char *, int);
203 char *getCookie(char *);
204 int getFileVersionFromCookieString(const char *);
205 boolean checkCookieString(const char *, const char *);
207 char *getFormattedSetupEntry(char *, char *);
208 void freeSetupFileList(struct SetupFileList *);
209 char *getTokenValue(struct SetupFileList *, char *);
210 void setTokenValue(struct SetupFileList *, char *, char *);
211 struct SetupFileList *loadSetupFileList(char *);
212 void checkSetupFileListIdentifier(struct SetupFileList *, char *);
213 void setSetupInfo(struct TokenInfo *, int, char *);
214 char *getSetupValue(int, void *);
215 char *getSetupLine(struct TokenInfo *, char *, int);
217 void LoadLevelInfo(void);
218 void LoadArtworkInfo(void);
219 void LoadLevelArtworkInfo(void);
221 void LoadLevelSetup_LastSeries(void);
222 void SaveLevelSetup_LastSeries(void);
223 void LoadLevelSetup_SeriesInfo(void);
224 void SaveLevelSetup_SeriesInfo(void);