rnd-20061230-1-src
[rocksndiamonds.git] / src / libgame / setup.h
index ab46527686333faf1190cb5be99b16d7505be880..6dc15e9cdf4c767d54058745fa7e819d8695598a 100644 (file)
@@ -1,7 +1,7 @@
 /***********************************************************
 * Artsoft Retro-Game Library                               *
 *----------------------------------------------------------*
-* (c) 1994-2002 Artsoft Entertainment                      *
+* (c) 1994-2006 Artsoft Entertainment                      *
 *               Holger Schemel                             *
 *               Detmolder Strasse 189                      *
 *               33604 Bielefeld                            *
 
 /* additional values for setup screen */
 #define TYPE_ENTER_SCREEN              (1 << 9)
-#define TYPE_ENTER_MENU                        (1 << 10)
-#define TYPE_LEAVE_MENU                        (1 << 11)
-#define TYPE_EMPTY                     (1 << 12)
-#define TYPE_KEYTEXT                   (1 << 13)
+#define TYPE_LEAVE_SCREEN              (1 << 10)
+#define TYPE_ENTER_MENU                        (1 << 11)
+#define TYPE_LEAVE_MENU                        (1 << 12)
+#define TYPE_ENTER_LIST                        (1 << 13)
+#define TYPE_LEAVE_LIST                        (1 << 14)
+#define TYPE_EMPTY                     (1 << 15)
+#define TYPE_KEYTEXT                   (1 << 16)
 
-#define TYPE_GHOSTED                   (1 << 14)
-#define TYPE_QUERY                     (1 << 15)
+#define TYPE_GHOSTED                   (1 << 17)
+#define TYPE_QUERY                     (1 << 18)
 
 /* additional values for internal purposes */
-#define TYPE_BITFIELD                  (1 << 16)
-#define TYPE_ELEMENT                   (1 << 17)
-#define TYPE_CONTENT                   (1 << 18)
-#define TYPE_ELEMENT_LIST              (1 << 19)
-#define TYPE_CONTENT_LIST              (1 << 20)
+#define TYPE_BITFIELD                  (1 << 19)
+#define TYPE_ELEMENT                   (1 << 20)
+#define TYPE_CONTENT                   (1 << 21)
+#define TYPE_ELEMENT_LIST              (1 << 22)
+#define TYPE_CONTENT_LIST              (1 << 23)
 
 /* derived values for setup file handling */
 #define TYPE_BOOLEAN_STYLE             (TYPE_BOOLEAN | \
 
 #define TYPE_SKIP_ENTRY                        (TYPE_EMPTY             | \
                                         TYPE_KEY               | \
-                                        TYPE_STRING)
+                                        TYPE_STRING            | \
+                                        TYPE_GHOSTED)
 
-#define TYPE_ENTER_OR_LEAVE_MENU       (TYPE_ENTER_SCREEN      | \
+#define TYPE_ENTER                     (TYPE_ENTER_SCREEN      | \
                                         TYPE_ENTER_MENU        | \
-                                        TYPE_LEAVE_MENU)
+                                        TYPE_ENTER_LIST)
+
+#define TYPE_LEAVE                     (TYPE_LEAVE_SCREEN      | \
+                                        TYPE_LEAVE_MENU        | \
+                                        TYPE_LEAVE_LIST)
+
+#define TYPE_ENTER_OR_LEAVE            (TYPE_ENTER | TYPE_LEAVE)
 
 /* cookie token for file identifier and version number */
 #define TOKEN_STR_FILE_IDENTIFIER      "file_identifier"
@@ -220,6 +230,7 @@ char *getEditorSetupFilename(void);
 char *getHelpAnimFilename(void);
 char *getHelpTextFilename(void);
 char *getLevelSetInfoFilename(void);
+char *getLevelSetMessageFilename(void);
 char *getImageFilename(char *);
 char *getCustomImageFilename(char *);
 char *getCustomSoundFilename(char *);
@@ -235,6 +246,7 @@ void InitUserLevelDirectory(char *);
 void InitLevelSetupDirectory(char *);
 
 TreeInfo *newTreeInfo();
+TreeInfo *newTreeInfo_setDefaults(int);
 void pushTreeInfo(TreeInfo **, TreeInfo *);
 int numTreeInfo(TreeInfo *);
 boolean validLevelSeries(TreeInfo *);
@@ -245,14 +257,20 @@ 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 *));
+void sortTreeInfoBySortFunction(TreeInfo **,
+                               int (*compare_function)(const void *,
+                                                       const void *));
+void sortTreeInfo(TreeInfo **);
 
-char *getUserDataDir(void);
+char *getHomeDir(void);
 char *getCommonDataDir(void);
+char *getPersonalDataDir(void);
+char *getUserGameDataDir(void);
 char *getSetupDir(void);
 char *getCurrentLevelDir(void);
 
+void updateUserGameDataDir(void);
+
 void createDirectory(char *, char *, int);
 void InitUserDataDirectory(void);
 void SetFilePermissions(char *, int);