added extracting level and artwork sets from zip files dropped into window
[rocksndiamonds.git] / src / libgame / setup.h
index 61316bbd587940d6864d217c9b44586f5659f797..40e2a9641b33b06b2b96701d205d8a3abf76eca0 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
@@ -18,7 +16,7 @@
 #include "hash.h"
 
 
-/* values for setup file handling */
+// values for setup file handling
 #define TYPE_BOOLEAN                   (1 << 0)
 #define TYPE_SWITCH                    (1 << 1)
 #define TYPE_SWITCH3                   (1 << 2)
 #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 << 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 << 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_PLAYER                    (1 << 10)
+#define TYPE_ELEMENT                   (1 << 11)
+#define TYPE_GRAPHIC                   (1 << 12)
+
+// additional values for setup screen
+#define TYPE_ENTER_SCREEN              (1 << 13)
+#define TYPE_LEAVE_SCREEN              (1 << 14)
+#define TYPE_ENTER_MENU                        (1 << 15)
+#define TYPE_LEAVE_MENU                        (1 << 16)
+#define TYPE_ENTER_LIST                        (1 << 17)
+#define TYPE_LEAVE_LIST                        (1 << 18)
+#define TYPE_TEXT_INPUT                        (1 << 19)
+#define TYPE_EMPTY                     (1 << 20)
+#define TYPE_SKIPPABLE                 (1 << 21)
+#define TYPE_KEYTEXT                   (1 << 22)
+
+#define TYPE_GHOSTED                   (1 << 23)
+#define TYPE_QUERY                     (1 << 24)
+
+// additional values for internal purposes
+#define TYPE_BITFIELD                  (1 << 25)
+#define TYPE_CONTENT                   (1 << 26)
+#define TYPE_ELEMENT_LIST              (1 << 27)
+#define TYPE_CONTENT_LIST              (1 << 28)
+
+// derived values for setup file handling
 #define TYPE_BOOLEAN_STYLE             (TYPE_BOOLEAN | \
                                         TYPE_SWITCH  | \
                                         TYPE_YES_NO  | \
                                         TYPE_ECS_AGA )
 
-/* derived values for setup screen */
+// derived values for setup screen
 #define TYPE_VALUE                     (TYPE_BOOLEAN_STYLE     | \
                                         TYPE_SWITCH3           | \
                                         TYPE_YES_NO_AUTO       | \
                                         TYPE_KEY_X11           | \
                                         TYPE_INTEGER           | \
                                         TYPE_STRING            | \
+                                        TYPE_PLAYER            | \
                                         TYPE_ELEMENT           | \
                                         TYPE_GRAPHIC)
 
 #define TYPE_SKIP_ENTRY                        (TYPE_EMPTY             | \
+                                        TYPE_SKIPPABLE         | \
                                         TYPE_KEY               | \
                                         TYPE_STRING            | \
                                         TYPE_GHOSTED)
@@ -83,9 +86,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;
@@ -93,7 +93,7 @@ struct TokenInfo
   char *text;
 };
 
-/* some definitions for list and hash handling */
+// some definitions for list and hash handling
 typedef struct SetupFileList SetupFileList;
 typedef struct hashtable     SetupFileHash;
 
@@ -112,7 +112,7 @@ typedef struct hashtable     SetupFileHash;
   }                                                            \
 
 
-/* sort priorities of level series (also used as level series classes) */
+// sort priorities of level series (also used as level series classes)
 #define LEVELCLASS_TUTORIAL_START      10
 #define LEVELCLASS_TUTORIAL_END                99
 #define LEVELCLASS_CLASSICS_START      100
@@ -189,7 +189,7 @@ typedef struct hashtable     SetupFileHash;
                         IS_LEVELCLASS_SB(n) ? LEVELCLASS_SB :             \
                         LEVELCLASS_UNDEFINED)
 
-/* sort priorities of artwork */
+// sort priorities of artwork
 #define ARTWORKCLASS_CLASSICS_START    100
 #define ARTWORKCLASS_CLASSICS_END      199
 #define ARTWORKCLASS_CONTRIB_START     200
@@ -226,11 +226,17 @@ typedef struct hashtable     SetupFileHash;
                         ARTWORKCLASS_UNDEFINED)
 
 
+char *getUserGraphicsDir(void);
+char *getUserSoundsDir(void);
+char *getUserMusicDir(void);
 char *setLevelArtworkDir(TreeInfo *);
+char *getProgramMainDataPath(char *, char *);
+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);
@@ -248,9 +254,10 @@ char *getCustomMusicDirectory(void);
 void InitTapeDirectory(char *);
 void InitScoreDirectory(char *);
 void InitUserLevelDirectory(char *);
+void InitNetworkLevelDirectory(char *);
 void InitLevelSetupDirectory(char *);
 
-TreeInfo *newTreeInfo();
+TreeInfo *newTreeInfo(void);
 TreeInfo *newTreeInfo_setDefaults(int);
 void pushTreeInfo(TreeInfo **, TreeInfo *);
 int numTreeInfo(TreeInfo *);
@@ -273,15 +280,17 @@ char *getCommonDataDir(void);
 char *getPersonalDataDir(void);
 char *getUserGameDataDir(void);
 char *getSetupDir(void);
+char *getUserLevelDir(char *);
+char *getNetworkLevelDir(char *);
 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 *);
 
@@ -296,28 +305,37 @@ SetupFileList *setListEntry(SetupFileList *, char *, char *);
 SetupFileList *addListEntry(SetupFileList *, char *, char *);
 SetupFileList *loadSetupFileList(char *);
 
-SetupFileHash *newSetupFileHash();
+SetupFileHash *newSetupFileHash(void);
 void freeSetupFileHash(SetupFileHash *);
 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();
+int GetZipFileTreeType(char *);
+boolean ExtractZipFileIntoDirectory(char *, char *, int);
+
+boolean AdjustGraphicsForEMC(void);
 
 void LoadLevelInfo(void);
 void LoadArtworkInfo(void);
 void LoadLevelArtworkInfo(void);
 
+char *getArtworkIdentifierForUserLevelSet(int);
+TreeInfo *getArtworkTreeInfoForUserLevelSet(int);
+boolean checkIfCustomArtworkExistsForCurrentLevelSet(void);
+void AddUserLevelSetToLevelInfo(char *);
+boolean UpdateUserLevelSet(char *, char *, char *, int);
+boolean CreateUserLevelSet(char *, char *, char *, int, boolean);
+
 void LoadLevelSetup_LastSeries(void);
 void SaveLevelSetup_LastSeries(void);
-void SaveLevelSetup_LastSeries_Deactivate();
+void SaveLevelSetup_LastSeries_Deactivate(void);
 void LoadLevelSetup_SeriesInfo(void);
 void SaveLevelSetup_SeriesInfo(void);
 
@@ -328,4 +346,4 @@ void LevelStats_setSolved(int, int);
 void LevelStats_incPlayed(int);
 void LevelStats_incSolved(int);
 
-#endif /* MISC_H */
+#endif // MISC_H