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_INTEGER (1 << 4)
26 #define TYPE_STRING (1 << 5)
28 #define TYPE_BOOLEAN_STYLE (TYPE_BOOLEAN | \
32 /* additional values for setup screen */
33 #define TYPE_ENTER_MENU (1 << 6)
34 #define TYPE_LEAVE_MENU (1 << 7)
35 #define TYPE_EMPTY (1 << 8)
36 #define TYPE_GHOSTED (1 << 9)
38 #define TYPE_ENTER_OR_LEAVE_MENU (TYPE_ENTER_MENU | TYPE_LEAVE_MENU)
40 /* cookie token for file identifier and version number */
41 #define TOKEN_STR_FILE_IDENTIFIER "file_identifier"
43 /* structures for setup file handling */
48 struct SetupFileList *next;
58 /* sort priorities of level series (also used as level series classes) */
59 #define LEVELCLASS_TUTORIAL_START 10
60 #define LEVELCLASS_TUTORIAL_END 99
61 #define LEVELCLASS_CLASSICS_START 100
62 #define LEVELCLASS_CLASSICS_END 199
63 #define LEVELCLASS_CONTRIBUTION_START 200
64 #define LEVELCLASS_CONTRIBUTION_END 299
65 #define LEVELCLASS_USER_START 300
66 #define LEVELCLASS_USER_END 399
67 #define LEVELCLASS_BD_START 400
68 #define LEVELCLASS_BD_END 499
69 #define LEVELCLASS_EM_START 500
70 #define LEVELCLASS_EM_END 599
71 #define LEVELCLASS_SP_START 600
72 #define LEVELCLASS_SP_END 699
73 #define LEVELCLASS_DX_START 700
74 #define LEVELCLASS_DX_END 799
76 #define LEVELCLASS_TUTORIAL LEVELCLASS_TUTORIAL_START
77 #define LEVELCLASS_CLASSICS LEVELCLASS_CLASSICS_START
78 #define LEVELCLASS_CONTRIBUTION LEVELCLASS_CONTRIBUTION_START
79 #define LEVELCLASS_USER LEVELCLASS_USER_START
80 #define LEVELCLASS_BD LEVELCLASS_BD_START
81 #define LEVELCLASS_EM LEVELCLASS_EM_START
82 #define LEVELCLASS_SP LEVELCLASS_SP_START
83 #define LEVELCLASS_DX LEVELCLASS_DX_START
85 #define LEVELCLASS_UNDEFINED 999
87 #define IS_LEVELCLASS_TUTORIAL(p) \
88 ((p)->sort_priority >= LEVELCLASS_TUTORIAL_START && \
89 (p)->sort_priority <= LEVELCLASS_TUTORIAL_END)
90 #define IS_LEVELCLASS_CLASSICS(p) \
91 ((p)->sort_priority >= LEVELCLASS_CLASSICS_START && \
92 (p)->sort_priority <= LEVELCLASS_CLASSICS_END)
93 #define IS_LEVELCLASS_CONTRIBUTION(p) \
94 ((p)->sort_priority >= LEVELCLASS_CONTRIBUTION_START && \
95 (p)->sort_priority <= LEVELCLASS_CONTRIBUTION_END)
96 #define IS_LEVELCLASS_USER(p) \
97 ((p)->sort_priority >= LEVELCLASS_USER_START && \
98 (p)->sort_priority <= LEVELCLASS_USER_END)
99 #define IS_LEVELCLASS_BD(p) \
100 ((p)->sort_priority >= LEVELCLASS_BD_START && \
101 (p)->sort_priority <= LEVELCLASS_BD_END)
102 #define IS_LEVELCLASS_EM(p) \
103 ((p)->sort_priority >= LEVELCLASS_EM_START && \
104 (p)->sort_priority <= LEVELCLASS_EM_END)
105 #define IS_LEVELCLASS_SP(p) \
106 ((p)->sort_priority >= LEVELCLASS_SP_START && \
107 (p)->sort_priority <= LEVELCLASS_SP_END)
108 #define IS_LEVELCLASS_DX(p) \
109 ((p)->sort_priority >= LEVELCLASS_DX_START && \
110 (p)->sort_priority <= LEVELCLASS_DX_END)
112 #define LEVELCLASS(n) (IS_LEVELCLASS_TUTORIAL(n) ? LEVELCLASS_TUTORIAL : \
113 IS_LEVELCLASS_CLASSICS(n) ? LEVELCLASS_CLASSICS : \
114 IS_LEVELCLASS_CONTRIBUTION(n) ? LEVELCLASS_CONTRIBUTION : \
115 IS_LEVELCLASS_USER(n) ? LEVELCLASS_USER : \
116 IS_LEVELCLASS_BD(n) ? LEVELCLASS_BD : \
117 IS_LEVELCLASS_EM(n) ? LEVELCLASS_EM : \
118 IS_LEVELCLASS_SP(n) ? LEVELCLASS_SP : \
119 IS_LEVELCLASS_DX(n) ? LEVELCLASS_DX : \
120 LEVELCLASS_UNDEFINED)
123 char *getLevelFilename(int);
124 char *getTapeFilename(int);
125 char *getScoreFilename(int);
126 char *getSetupFilename(void);
127 char *getImageFilename(char *);
128 char *getCustomImageFilename(char *);
130 void InitTapeDirectory(char *);
131 void InitScoreDirectory(char *);
132 void InitUserLevelDirectory(char *);
133 void InitLevelSetupDirectory(char *);
135 void ReadChunk_VERS(FILE *, int *, int *);
136 void WriteChunk_VERS(FILE *, int, int);
138 struct LevelDirInfo *newLevelDirInfo();
139 void pushLevelDirInfo(struct LevelDirInfo **, struct LevelDirInfo *);
140 int numLevelDirInfo(struct LevelDirInfo *);
141 boolean validLevelSeries(struct LevelDirInfo *);
142 struct LevelDirInfo *getFirstValidLevelSeries(struct LevelDirInfo *);
143 struct LevelDirInfo *getLevelDirInfoFirstGroupEntry(struct LevelDirInfo *);
144 int numLevelDirInfoInGroup(struct LevelDirInfo *);
145 int posLevelDirInfo(struct LevelDirInfo *);
146 struct LevelDirInfo *getLevelDirInfoFromPos(struct LevelDirInfo *, int);
147 struct LevelDirInfo *getLevelDirInfoFromFilename(char *);
148 void dumpLevelDirInfo(struct LevelDirInfo *, int);
149 void sortLevelDirInfo(struct LevelDirInfo **,
150 int (*compare_function)(const void *, const void *));
152 char *getUserDataDir(void);
153 char *getSetupDir(void);
154 void createDirectory(char *, char *, int);
155 void InitUserDataDirectory(void);
156 void SetFilePermissions(char *, int);
158 char *getCookie(char *);
159 int getFileVersionFromCookieString(const char *);
160 boolean checkCookieString(const char *, const char *);
162 char *getFormattedSetupEntry(char *, char *);
163 void freeSetupFileList(struct SetupFileList *);
164 char *getTokenValue(struct SetupFileList *, char *);
165 struct SetupFileList *loadSetupFileList(char *);
166 void checkSetupFileListIdentifier(struct SetupFileList *, char *);
167 void setSetupInfo(struct TokenInfo *, int, char *);
168 char *getSetupValue(int, void *);
169 char *getSetupLine(struct TokenInfo *, char *, int);
171 void LoadLevelInfo(void);
172 void LoadLevelSetup_LastSeries(void);
173 void SaveLevelSetup_LastSeries(void);
174 void LoadLevelSetup_SeriesInfo(void);
175 void SaveLevelSetup_SeriesInfo(void);