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"
58 /* structures for setup file handling */
63 struct SetupFileList *next;
73 /* sort priorities of level series (also used as level series classes) */
74 #define LEVELCLASS_TUTORIAL_START 10
75 #define LEVELCLASS_TUTORIAL_END 99
76 #define LEVELCLASS_CLASSICS_START 100
77 #define LEVELCLASS_CLASSICS_END 199
78 #define LEVELCLASS_CONTRIBUTION_START 200
79 #define LEVELCLASS_CONTRIBUTION_END 299
80 #define LEVELCLASS_USER_START 300
81 #define LEVELCLASS_USER_END 399
82 #define LEVELCLASS_BD_START 400
83 #define LEVELCLASS_BD_END 499
84 #define LEVELCLASS_EM_START 500
85 #define LEVELCLASS_EM_END 599
86 #define LEVELCLASS_SP_START 600
87 #define LEVELCLASS_SP_END 699
88 #define LEVELCLASS_DX_START 700
89 #define LEVELCLASS_DX_END 799
91 #define LEVELCLASS_TUTORIAL LEVELCLASS_TUTORIAL_START
92 #define LEVELCLASS_CLASSICS LEVELCLASS_CLASSICS_START
93 #define LEVELCLASS_CONTRIBUTION LEVELCLASS_CONTRIBUTION_START
94 #define LEVELCLASS_USER LEVELCLASS_USER_START
95 #define LEVELCLASS_BD LEVELCLASS_BD_START
96 #define LEVELCLASS_EM LEVELCLASS_EM_START
97 #define LEVELCLASS_SP LEVELCLASS_SP_START
98 #define LEVELCLASS_DX LEVELCLASS_DX_START
100 #define LEVELCLASS_UNDEFINED 999
102 #define IS_LEVELCLASS_TUTORIAL(p) \
103 ((p)->sort_priority >= LEVELCLASS_TUTORIAL_START && \
104 (p)->sort_priority <= LEVELCLASS_TUTORIAL_END)
105 #define IS_LEVELCLASS_CLASSICS(p) \
106 ((p)->sort_priority >= LEVELCLASS_CLASSICS_START && \
107 (p)->sort_priority <= LEVELCLASS_CLASSICS_END)
108 #define IS_LEVELCLASS_CONTRIBUTION(p) \
109 ((p)->sort_priority >= LEVELCLASS_CONTRIBUTION_START && \
110 (p)->sort_priority <= LEVELCLASS_CONTRIBUTION_END)
111 #define IS_LEVELCLASS_USER(p) \
112 ((p)->sort_priority >= LEVELCLASS_USER_START && \
113 (p)->sort_priority <= LEVELCLASS_USER_END)
114 #define IS_LEVELCLASS_BD(p) \
115 ((p)->sort_priority >= LEVELCLASS_BD_START && \
116 (p)->sort_priority <= LEVELCLASS_BD_END)
117 #define IS_LEVELCLASS_EM(p) \
118 ((p)->sort_priority >= LEVELCLASS_EM_START && \
119 (p)->sort_priority <= LEVELCLASS_EM_END)
120 #define IS_LEVELCLASS_SP(p) \
121 ((p)->sort_priority >= LEVELCLASS_SP_START && \
122 (p)->sort_priority <= LEVELCLASS_SP_END)
123 #define IS_LEVELCLASS_DX(p) \
124 ((p)->sort_priority >= LEVELCLASS_DX_START && \
125 (p)->sort_priority <= LEVELCLASS_DX_END)
127 #define LEVELCLASS(n) (IS_LEVELCLASS_TUTORIAL(n) ? LEVELCLASS_TUTORIAL : \
128 IS_LEVELCLASS_CLASSICS(n) ? LEVELCLASS_CLASSICS : \
129 IS_LEVELCLASS_CONTRIBUTION(n) ? LEVELCLASS_CONTRIBUTION : \
130 IS_LEVELCLASS_USER(n) ? LEVELCLASS_USER : \
131 IS_LEVELCLASS_BD(n) ? LEVELCLASS_BD : \
132 IS_LEVELCLASS_EM(n) ? LEVELCLASS_EM : \
133 IS_LEVELCLASS_SP(n) ? LEVELCLASS_SP : \
134 IS_LEVELCLASS_DX(n) ? LEVELCLASS_DX : \
135 LEVELCLASS_UNDEFINED)
138 char *getLevelFilename(int);
139 char *getTapeFilename(int);
140 char *getScoreFilename(int);
141 char *getSetupFilename(void);
142 char *getImageFilename(char *);
143 char *getCustomImageFilename(char *);
144 char *getCustomSoundFilename(char *);
145 char *getCustomSoundConfigFilename(void);
146 char *getCustomMusicDirectory(void);
148 void InitTapeDirectory(char *);
149 void InitScoreDirectory(char *);
150 void InitUserLevelDirectory(char *);
151 void InitLevelSetupDirectory(char *);
153 void ReadChunk_VERS(FILE *, int *, int *);
154 void WriteChunk_VERS(FILE *, int, int);
156 TreeInfo *newTreeInfo();
157 void pushTreeInfo(TreeInfo **, TreeInfo *);
158 int numTreeInfo(TreeInfo *);
159 boolean validLevelSeries(TreeInfo *);
160 TreeInfo *getFirstValidTreeInfoEntry(TreeInfo *);
161 TreeInfo *getTreeInfoFirstGroupEntry(TreeInfo *);
162 int numTreeInfoInGroup(TreeInfo *);
163 int posTreeInfo(TreeInfo *);
164 TreeInfo *getTreeInfoFromPos(TreeInfo *, int);
165 TreeInfo *getTreeInfoFromFilename(TreeInfo *, char *);
166 void dumpTreeInfo(TreeInfo *, int);
167 void sortTreeInfo(TreeInfo **,
168 int (*compare_function)(const void *, const void *));
170 char *getUserDataDir(void);
171 char *getSetupDir(void);
172 void createDirectory(char *, char *, int);
173 void InitUserDataDirectory(void);
174 void SetFilePermissions(char *, int);
176 char *getCookie(char *);
177 int getFileVersionFromCookieString(const char *);
178 boolean checkCookieString(const char *, const char *);
180 char *getFormattedSetupEntry(char *, char *);
181 void freeSetupFileList(struct SetupFileList *);
182 char *getTokenValue(struct SetupFileList *, char *);
183 struct SetupFileList *loadSetupFileList(char *);
184 void checkSetupFileListIdentifier(struct SetupFileList *, char *);
185 void setSetupInfo(struct TokenInfo *, int, char *);
186 char *getSetupValue(int, void *);
187 char *getSetupLine(struct TokenInfo *, char *, int);
189 void LoadLevelInfo(void);
190 void LoadArtworkInfo(void);
191 void LoadLevelArtworkInfo(void);
193 void LoadLevelSetup_LastSeries(void);
194 void SaveLevelSetup_LastSeries(void);
195 void LoadLevelSetup_SeriesInfo(void);
196 void SaveLevelSetup_SeriesInfo(void);