rnd-20030730-2-src
[rocksndiamonds.git] / src / libgame / setup.h
index d702ef1f461ea619a94a5f21d54c1c3538365d56..30952c650e9b963aa26b0d658003d56599d79af9 100644 (file)
 #define SETUP_H
 
 #include "system.h"
+#include "hash.h"
 
 
 /* values for setup file handling */
-#define TYPE_BOOLEAN                   1
-#define TYPE_SWITCH                    2
-#define TYPE_KEY                       3
-#define TYPE_INTEGER                   4
-#define TYPE_STRING                    5
+#define TYPE_BOOLEAN                   (1 << 0)
+#define TYPE_SWITCH                    (1 << 1)
+#define TYPE_YES_NO                    (1 << 2)
+#define TYPE_KEY                       (1 << 3)
+#define TYPE_KEY_X11                   (1 << 4)
+#define TYPE_INTEGER                   (1 << 5)
+#define TYPE_STRING                    (1 << 6)
+#define TYPE_TOKEN                     (1 << 7)
 
-#define TOKEN_STR_FILE_IDENTIFIER      "file_identifier"
+#define TYPE_BOOLEAN_STYLE             (TYPE_BOOLEAN | \
+                                        TYPE_SWITCH  | \
+                                        TYPE_YES_NO)
 
-/* structures for setup file handling */
-struct SetupFileList
-{
-  char *token;
-  char *value;
-  struct SetupFileList *next;
-};
+/* additional values for setup screen */
+#define TYPE_ENTER_MENU                        (1 << 8)
+#define TYPE_LEAVE_MENU                        (1 << 9)
+#define TYPE_EMPTY                     (1 << 10)
+#define TYPE_KEYTEXT                   (1 << 11)
+
+#define TYPE_GHOSTED                   (1 << 12)
+#define TYPE_QUERY                     (1 << 13)
+
+#define TYPE_VALUE                     (TYPE_BOOLEAN_STYLE     | \
+                                        TYPE_KEY               | \
+                                        TYPE_KEY_X11           | \
+                                        TYPE_INTEGER           | \
+                                        TYPE_STRING            | \
+                                        TYPE_TOKEN)
+
+#define TYPE_SKIP_ENTRY                        (TYPE_EMPTY             | \
+                                        TYPE_KEY               | \
+                                        TYPE_STRING)
+
+#define TYPE_ENTER_OR_LEAVE_MENU       (TYPE_ENTER_MENU        | \
+                                        TYPE_LEAVE_MENU)
+
+/* cookie token for file identifier and version number */
+#define TOKEN_STR_FILE_IDENTIFIER      "file_identifier"
 
 struct TokenInfo
 {
@@ -41,6 +65,25 @@ struct TokenInfo
   char *text;
 };
 
+/* some definitions for list and hash handling */
+typedef struct SetupFileList SetupFileList;
+typedef struct hashtable SetupFileHash;
+
+#define BEGIN_HASH_ITERATION(hash, itr)                                \
+  if (hash != NULL && hashtable_count(hash) > 0)               \
+  {                                                            \
+    struct hashtable_itr *itr = hashtable_iterator(hash);      \
+    do {                                                       \
+
+#define HASH_ITERATION_TOKEN(itr)      ((char *)hashtable_iterator_key(itr))
+#define HASH_ITERATION_VALUE(itr)      ((char *)hashtable_iterator_value(itr))
+
+#define END_HASH_ITERATION(hash, itr)                          \
+    } while (hashtable_iterator_advance(itr));                 \
+    free(itr);                                                 \
+  }                                                            \
+
+
 /* sort priorities of level series (also used as level series classes) */
 #define LEVELCLASS_TUTORIAL_START      10
 #define LEVELCLASS_TUTORIAL_END                99
@@ -105,36 +148,77 @@ struct TokenInfo
                         IS_LEVELCLASS_DX(n) ? LEVELCLASS_DX : \
                         LEVELCLASS_UNDEFINED)
 
+/* sort priorities of artwork */
+#define ARTWORKCLASS_CLASSICS_START    100
+#define ARTWORKCLASS_CLASSICS_END      199
+#define ARTWORKCLASS_CONTRIBUTION_START        200
+#define ARTWORKCLASS_CONTRIBUTION_END  299
+#define ARTWORKCLASS_LEVEL_START       300
+#define ARTWORKCLASS_LEVEL_END         399
+#define ARTWORKCLASS_USER_START                400
+#define ARTWORKCLASS_USER_END          499
+
+#define ARTWORKCLASS_CLASSICS          ARTWORKCLASS_CLASSICS_START
+#define ARTWORKCLASS_CONTRIBUTION      ARTWORKCLASS_CONTRIBUTION_START
+#define ARTWORKCLASS_LEVEL             ARTWORKCLASS_LEVEL_START
+#define ARTWORKCLASS_USER              ARTWORKCLASS_USER_START
+
+#define ARTWORKCLASS_UNDEFINED         999
+
+#define IS_ARTWORKCLASS_CLASSICS(p) \
+       ((p)->sort_priority >= ARTWORKCLASS_CLASSICS_START && \
+        (p)->sort_priority <= ARTWORKCLASS_CLASSICS_END)
+#define IS_ARTWORKCLASS_CONTRIBUTION(p) \
+       ((p)->sort_priority >= ARTWORKCLASS_CONTRIBUTION_START && \
+        (p)->sort_priority <= ARTWORKCLASS_CONTRIBUTION_END)
+#define IS_ARTWORKCLASS_LEVEL(p) \
+       ((p)->sort_priority >= ARTWORKCLASS_LEVEL_START && \
+        (p)->sort_priority <= ARTWORKCLASS_LEVEL_END)
+#define IS_ARTWORKCLASS_USER(p) \
+       ((p)->sort_priority >= ARTWORKCLASS_USER_START && \
+        (p)->sort_priority <= ARTWORKCLASS_USER_END)
 
+#define ARTWORKCLASS(n)        (IS_ARTWORKCLASS_CLASSICS(n) ? ARTWORKCLASS_CLASSICS :\
+                        IS_ARTWORKCLASS_CONTRIBUTION(n) ? ARTWORKCLASS_CONTRIBUTION : \
+                        IS_ARTWORKCLASS_LEVEL(n) ? ARTWORKCLASS_LEVEL : \
+                        IS_ARTWORKCLASS_USER(n) ? ARTWORKCLASS_USER : \
+                        ARTWORKCLASS_UNDEFINED)
+
+
+void setLevelArtworkDir(TreeInfo *);
 char *getLevelFilename(int);
 char *getTapeFilename(int);
 char *getScoreFilename(int);
 char *getSetupFilename(void);
 char *getImageFilename(char *);
+char *getCustomImageFilename(char *);
+char *getCustomSoundFilename(char *);
+char *getCustomArtworkFilename(char *, int);
+char *getCustomArtworkConfigFilename(int);
+char *getCustomArtworkLevelConfigFilename(int);
+char *getCustomMusicDirectory(void);
 
 void InitTapeDirectory(char *);
 void InitScoreDirectory(char *);
 void InitUserLevelDirectory(char *);
 void InitLevelSetupDirectory(char *);
 
-void ReadChunk_VERS(FILE *, int *, int *);
-void WriteChunk_VERS(FILE *, int, int);
-
-struct LevelDirInfo *newLevelDirInfo();
-void pushLevelDirInfo(struct LevelDirInfo **, struct LevelDirInfo *);
-int numLevelDirInfo(struct LevelDirInfo *);
-boolean validLevelSeries(struct LevelDirInfo *);
-struct LevelDirInfo *getFirstValidLevelSeries(struct LevelDirInfo *);
-struct LevelDirInfo *getLevelDirInfoFirstGroupEntry(struct LevelDirInfo *);
-int numLevelDirInfoInGroup(struct LevelDirInfo *);
-int posLevelDirInfo(struct LevelDirInfo *);
-struct LevelDirInfo *getLevelDirInfoFromPos(struct LevelDirInfo *, int);
-struct LevelDirInfo *getLevelDirInfoFromFilename(char *);
-void dumpLevelDirInfo(struct LevelDirInfo *, int);
-void sortLevelDirInfo(struct LevelDirInfo **,
-                     int (*compare_function)(const void *, const void *));
+TreeInfo *newTreeInfo();
+void pushTreeInfo(TreeInfo **, TreeInfo *);
+int numTreeInfo(TreeInfo *);
+boolean validLevelSeries(TreeInfo *);
+TreeInfo *getFirstValidTreeInfoEntry(TreeInfo *);
+TreeInfo *getTreeInfoFirstGroupEntry(TreeInfo *);
+int numTreeInfoInGroup(TreeInfo *);
+int posTreeInfo(TreeInfo *);
+TreeInfo *getTreeInfoFromPos(TreeInfo *, int);
+TreeInfo *getTreeInfoFromIdentifier(TreeInfo *, char *);
+void dumpTreeInfo(TreeInfo *, int);
+void sortTreeInfo(TreeInfo **,
+                 int (*compare_function)(const void *, const void *));
 
 char *getUserDataDir(void);
+char *getCommonDataDir(void);
 char *getSetupDir(void);
 void createDirectory(char *, char *, int);
 void InitUserDataDirectory(void);
@@ -145,14 +229,27 @@ int getFileVersionFromCookieString(const char *);
 boolean checkCookieString(const char *, const char *);
 
 char *getFormattedSetupEntry(char *, char *);
+
+struct SetupFileList *newSetupFileList(char *, char *);
 void freeSetupFileList(struct SetupFileList *);
-char *getTokenValue(struct SetupFileList *, char *);
-struct SetupFileList *loadSetupFileList(char *);
-void checkSetupFileListIdentifier(struct SetupFileList *, char *);
+char *getListEntry(struct SetupFileList *, char *);
+void setListEntry(struct SetupFileList *, char *, char *);
+SetupFileList *loadSetupFileList(char *);
+
+SetupFileHash *newSetupFileHash();
+void freeSetupFileHash(SetupFileHash *);
+char *getHashEntry(SetupFileHash *, char *);
+void setHashEntry(SetupFileHash *, char *, char *);
+SetupFileHash *loadSetupFileHash(char *);
+void checkSetupFileHashIdentifier(SetupFileHash *, char *);
 void setSetupInfo(struct TokenInfo *, int, char *);
+char *getSetupValue(int, void *);
 char *getSetupLine(struct TokenInfo *, char *, int);
 
 void LoadLevelInfo(void);
+void LoadArtworkInfo(void);
+void LoadLevelArtworkInfo(void);
+
 void LoadLevelSetup_LastSeries(void);
 void SaveLevelSetup_LastSeries(void);
 void LoadLevelSetup_SeriesInfo(void);