removed unused option to set first level of user level sets not to be '1'
[rocksndiamonds.git] / src / libgame / setup.h
index 38a53e816045656664f519183b81b533501508f9..f7b7892859c813c1d01d4f1b44ec8ac9a72a6488 100644 (file)
@@ -1,15 +1,13 @@
-/***********************************************************
-* Artsoft Retro-Game Library                               *
-*----------------------------------------------------------*
-* (c) 1994-2006 Artsoft Entertainment                      *
-*               Holger Schemel                             *
-*               Detmolder Strasse 189                      *
-*               33604 Bielefeld                            *
-*               Germany                                    *
-*               e-mail: info@artsoft.org                   *
-*----------------------------------------------------------*
-* setup.h                                                  *
-***********************************************************/
+// ============================================================================
+// Artsoft Retro-Game Library
+// ----------------------------------------------------------------------------
+// (c) 1995-2014 by Artsoft Entertainment
+//                         Holger Schemel
+//                 info@artsoft.org
+//                 http://www.artsoft.org/
+// ----------------------------------------------------------------------------
+// setup.h
+// ============================================================================
 
 #ifndef SETUP_H
 #define SETUP_H
 /* values for setup file handling */
 #define TYPE_BOOLEAN                   (1 << 0)
 #define TYPE_SWITCH                    (1 << 1)
-#define TYPE_YES_NO                    (1 << 2)
-#define TYPE_ECS_AGA                   (1 << 3)
-#define TYPE_KEY                       (1 << 4)
-#define TYPE_KEY_X11                   (1 << 5)
-#define TYPE_INTEGER                   (1 << 6)
-#define TYPE_STRING                    (1 << 7)
-#define TYPE_TOKEN                     (1 << 8)
+#define TYPE_SWITCH3                   (1 << 2)
+#define TYPE_YES_NO                    (1 << 3)
+#define TYPE_YES_NO_AUTO               (1 << 4)
+#define TYPE_ECS_AGA                   (1 << 5)
+#define TYPE_KEY                       (1 << 6)
+#define TYPE_KEY_X11                   (1 << 7)
+#define TYPE_INTEGER                   (1 << 8)
+#define TYPE_STRING                    (1 << 9)
+#define TYPE_ELEMENT                   (1 << 10)
+#define TYPE_GRAPHIC                   (1 << 11)
 
 /* additional values for setup screen */
-#define TYPE_ENTER_SCREEN              (1 << 9)
-#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 << 17)
-#define TYPE_QUERY                     (1 << 18)
+#define TYPE_ENTER_SCREEN              (1 << 12)
+#define TYPE_LEAVE_SCREEN              (1 << 13)
+#define TYPE_ENTER_MENU                        (1 << 14)
+#define TYPE_LEAVE_MENU                        (1 << 15)
+#define TYPE_ENTER_LIST                        (1 << 16)
+#define TYPE_LEAVE_LIST                        (1 << 17)
+#define TYPE_EMPTY                     (1 << 18)
+#define TYPE_KEYTEXT                   (1 << 19)
+
+#define TYPE_GHOSTED                   (1 << 20)
+#define TYPE_QUERY                     (1 << 21)
 
 /* additional values for internal purposes */
-#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)
+#define TYPE_BITFIELD                  (1 << 22)
+#define TYPE_CONTENT                   (1 << 23)
+#define TYPE_ELEMENT_LIST              (1 << 24)
+#define TYPE_CONTENT_LIST              (1 << 25)
 
 /* derived values for setup file handling */
 #define TYPE_BOOLEAN_STYLE             (TYPE_BOOLEAN | \
 
 /* derived values for setup screen */
 #define TYPE_VALUE                     (TYPE_BOOLEAN_STYLE     | \
+                                        TYPE_SWITCH3           | \
+                                        TYPE_YES_NO_AUTO       | \
                                         TYPE_KEY               | \
                                         TYPE_KEY_X11           | \
                                         TYPE_INTEGER           | \
                                         TYPE_STRING            | \
-                                        TYPE_TOKEN)
+                                        TYPE_ELEMENT           | \
+                                        TYPE_GRAPHIC)
 
 #define TYPE_SKIP_ENTRY                        (TYPE_EMPTY             | \
                                         TYPE_KEY               | \
@@ -78,9 +81,6 @@
 
 #define TYPE_ENTER_OR_LEAVE            (TYPE_ENTER | TYPE_LEAVE)
 
-/* cookie token for file identifier and version number */
-#define TOKEN_STR_FILE_IDENTIFIER      "file_identifier"
-
 struct TokenInfo
 {
   int type;
@@ -222,10 +222,12 @@ typedef struct hashtable     SetupFileHash;
 
 
 char *setLevelArtworkDir(TreeInfo *);
+char *getProgramConfigFilename(char *);
 char *getTapeFilename(int);
 char *getSolutionTapeFilename(int);
 char *getScoreFilename(int);
 char *getSetupFilename(void);
+char *getDefaultSetupFilename(void);
 char *getEditorSetupFilename(void);
 char *getHelpAnimFilename(void);
 char *getHelpTextFilename(void);
@@ -261,6 +263,7 @@ void sortTreeInfoBySortFunction(TreeInfo **,
                                int (*compare_function)(const void *,
                                                        const void *));
 void sortTreeInfo(TreeInfo **);
+void freeTreeInfo(TreeInfo *);
 
 char *getHomeDir(void);
 char *getCommonDataDir(void);
@@ -268,19 +271,21 @@ char *getPersonalDataDir(void);
 char *getUserGameDataDir(void);
 char *getSetupDir(void);
 char *getCurrentLevelDir(void);
-
-void updateUserGameDataDir(void);
+char *getNewUserLevelSubdir(void);
 
 void createDirectory(char *, char *, int);
 void InitUserDataDirectory(void);
 void SetFilePermissions(char *, int);
 
 char *getCookie(char *);
+void fprintFileHeader(FILE *, char *);
 int getFileVersionFromCookieString(const char *);
 boolean checkCookieString(const char *, const char *);
 
 char *getFormattedSetupEntry(char *, char *);
 
+boolean getTokenValueFromSetupLine(char *, char **, char **);
+
 SetupFileList *newSetupFileList(char *, char *);
 void freeSetupFileList(SetupFileList *);
 char *getListEntry(SetupFileList *, char *);
@@ -294,20 +299,33 @@ char *getHashEntry(SetupFileHash *, char *);
 void setHashEntry(SetupFileHash *, char *, char *);
 char *removeHashEntry(SetupFileHash *, char *);
 SetupFileHash *loadSetupFileHash(char *);
-void checkSetupFileHashIdentifier(SetupFileHash *, char *, char *);
 void setSetupInfo(struct TokenInfo *, int, char *);
 char *getSetupValue(int, void *);
 char *getSetupLine(struct TokenInfo *, char *, int);
 
+unsigned int get_hash_from_key(void *);
+
 boolean AdjustGraphicsForEMC();
 
 void LoadLevelInfo(void);
 void LoadArtworkInfo(void);
 void LoadLevelArtworkInfo(void);
 
+void AddUserLevelSetToLevelInfo(char *);
+boolean UpdateUserLevelSet(char *, char *, char *, int);
+boolean CreateUserLevelSet(char *, char *, char *, int);
+
 void LoadLevelSetup_LastSeries(void);
 void SaveLevelSetup_LastSeries(void);
+void SaveLevelSetup_LastSeries_Deactivate();
 void LoadLevelSetup_SeriesInfo(void);
 void SaveLevelSetup_SeriesInfo(void);
 
+int LevelStats_getPlayed(int);
+int LevelStats_getSolved(int);
+void LevelStats_setPlayed(int, int);
+void LevelStats_setSolved(int, int);
+void LevelStats_incPlayed(int);
+void LevelStats_incSolved(int);
+
 #endif /* MISC_H */