projects / rocksndiamonds.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
added optional button to restart game (door, panel and touch variants)
[rocksndiamonds.git] / src / libgame / setup.h
diff --git a/src/libgame/setup.h b/src/libgame/setup.h
index 7740c2cb628318750bec61959cc9d1e17b404638..59700cf9cf70011ed01b71ed1e224d313ccc85e6 100644 (file)
--- a/src/libgame/setup.h
+++ b/src/libgame/setup.h
@@ -4,7 +4,7 @@
 // (c) 1995-2014 by Artsoft Entertainment
 //                         Holger Schemel
 //                 info@artsoft.org
-//                 http://www.artsoft.org/
+//                 https://www.artsoft.org/
 // ----------------------------------------------------------------------------
 // setup.h
 // ============================================================================
@@ -42,15 +42,16 @@
 #define TYPE_EMPTY                     (1 << 20)
 #define TYPE_SKIPPABLE                 (1 << 21)
 #define TYPE_KEYTEXT                   (1 << 22)
+#define TYPE_HEADLINE                  (1 << 23)
 
-#define TYPE_GHOSTED                   (1 << 23)
-#define TYPE_QUERY                     (1 << 24)
+#define TYPE_GHOSTED                   (1 << 24)
+#define TYPE_QUERY                     (1 << 25)
 
 // 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)
+#define TYPE_BITFIELD                  (1 << 26)
+#define TYPE_CONTENT                   (1 << 27)
+#define TYPE_ELEMENT_LIST              (1 << 28)
+#define TYPE_CONTENT_LIST              (1 << 29)
 
 // derived values for setup file handling
 #define TYPE_BOOLEAN_STYLE             (TYPE_BOOLEAN | \
@@ -74,6 +75,7 @@
                                         TYPE_SKIPPABLE         | \
                                         TYPE_KEY               | \
                                         TYPE_STRING            | \
+                                        TYPE_HEADLINE          | \
                                         TYPE_GHOSTED)
 
 #define TYPE_ENTER                     (TYPE_ENTER_SCREEN      | \
@@ -112,6 +114,11 @@ typedef struct hashtable     SetupFileHash;
   }                                                            \
 
 
+// sort priorities of special tree entries
+#define LEVELCLASS_TOP                 0
+#define LEVELCLASS_PARENT              1
+#define LEVELCLASS_LAST_PLAYED_LEVEL   2
+
 // sort priorities of level series (also used as level series classes)
 #define LEVELCLASS_TUTORIAL_START      10
 #define LEVELCLASS_TUTORIAL_END                99
@@ -225,6 +232,30 @@ typedef struct hashtable     SetupFileHash;
                         IS_ARTWORKCLASS_LEVEL(n) ? ARTWORKCLASS_LEVEL :      \
                         ARTWORKCLASS_UNDEFINED)
 
+#define TREE_SORTING_DIR(ti)                                           \
+       (((ti)->parent_link                                ? 0 :        \
+         (ti)->in_user_dir                                ? 4 * 200 :  \
+         (ti)->sort_priority >= LEVELCLASS_CLASSICS_START ? 3 * 200 +  \
+         (ti)->sort_priority % 100 :                                   \
+         (ti)->sort_priority >= LEVELCLASS_TUTORIAL_START ? 2 * 200 +  \
+         (ti)->sort_priority % 100 :                                   \
+         1 * 200) +                                                    \
+        ((ti)->level_group ? 0 : 100))
+
+#define TREE_COLOR_DIR(ti, active)                                     \
+       ((active)                       ? FC_YELLOW :                   \
+        TREE_SORTING(ti) / 200 == 4    ? FC_GREEN :                    \
+        TREE_SORTING(ti) / 200 == 2    ? FC_BLUE :                     \
+        FC_RED)
+
+#define TREE_SORTING(ti)                                               \
+       (TREE_TYPE_IS_DIR((ti)->type) ? TREE_SORTING_DIR(ti) :          \
+        (ti)->sort_priority)
+
+#define TREE_COLOR(ti, active)                                         \
+       (TREE_TYPE_IS_DIR((ti)->type) ? TREE_COLOR_DIR(ti, active) :    \
+        (ti)->color)
+
 
 char *getUserGraphicsDir(void);
 char *getUserSoundsDir(void);
@@ -233,15 +264,25 @@ char *setLevelArtworkDir(TreeInfo *);
 char *getProgramMainDataPath(char *, char *);
 char *getProgramConfigFilename(char *);
 char *getTapeFilename(int);
+char *getTemporaryTapeFilename(void);
+char *getDefaultSolutionTapeFilename(int);
+char *getSokobanSolutionTapeFilename(int);
 char *getSolutionTapeFilename(int);
 char *getScoreFilename(int);
+char *getScoreCacheFilename(int);
+char *getScoreTapeBasename(char *);
+char *getScoreTapeFilename(char *, int);
+char *getScoreCacheTapeFilename(char *, int);
 char *getSetupFilename(void);
 char *getDefaultSetupFilename(void);
+char *getPlatformSetupFilename(void);
 char *getEditorSetupFilename(void);
 char *getHelpAnimFilename(void);
 char *getHelpTextFilename(void);
-char *getLevelSetInfoFilename(void);
+char *getLevelSetInfoFilename(int);
 char *getLevelSetTitleMessageFilename(int, boolean);
+char *getCreditsFilename(int, boolean);
+char *getProgramInfoFilename(int);
 char *getImageFilename(char *);
 char *getCustomImageFilename(char *);
 char *getCustomSoundFilename(char *);
@@ -250,9 +291,18 @@ char *getCustomArtworkFilename(char *, int);
 char *getCustomArtworkConfigFilename(int);
 char *getCustomArtworkLevelConfigFilename(int);
 char *getCustomMusicDirectory(void);
+char *getCustomMusicDirectory_NoConf(void);
 
+void MarkTapeDirectoryUploadsAsComplete(char *);
+void MarkTapeDirectoryUploadsAsIncomplete(char *);
+boolean CheckTapeDirectoryUploadsComplete(char *);
+
+void InitMissingFileHash(void);
 void InitTapeDirectory(char *);
 void InitScoreDirectory(char *);
+void InitScoreCacheDirectory(char *);
+void InitScoreTapeDirectory(char *, int);
+void InitScoreCacheTapeDirectory(char *, int);
 void InitUserLevelDirectory(char *);
 void InitNetworkLevelDirectory(char *);
 void InitLevelSetupDirectory(char *);
@@ -260,36 +310,42 @@ void InitLevelSetupDirectory(char *);
 TreeInfo *newTreeInfo(void);
 TreeInfo *newTreeInfo_setDefaults(int);
 void pushTreeInfo(TreeInfo **, TreeInfo *);
+void removeTreeInfo(TreeInfo **);
 int numTreeInfo(TreeInfo *);
 boolean validLevelSeries(TreeInfo *);
+TreeInfo *getValidLevelSeries(TreeInfo *, TreeInfo *);
 TreeInfo *getFirstValidTreeInfoEntry(TreeInfo *);
+TreeInfo *getNextValidTreeInfoEntry(TreeInfo *);
 TreeInfo *getTreeInfoFirstGroupEntry(TreeInfo *);
 int numTreeInfoInGroup(TreeInfo *);
-int posTreeInfo(TreeInfo *);
+int getPosFromTreeInfo(TreeInfo *);
 TreeInfo *getTreeInfoFromPos(TreeInfo *, int);
 TreeInfo *getTreeInfoFromIdentifier(TreeInfo *, char *);
-void dumpTreeInfo(TreeInfo *, int);
+int dumpTreeInfo(TreeInfo *, int);
 void sortTreeInfoBySortFunction(TreeInfo **,
                                int (*compare_function)(const void *,
                                                        const void *));
 void sortTreeInfo(TreeInfo **);
 void freeTreeInfo(TreeInfo *);
+TreeInfo *addTopTreeInfoNode(TreeInfo *);
 
 char *getHomeDir(void);
-char *getCommonDataDir(void);
 char *getPersonalDataDir(void);
+char *getMainUserGameDataDir(void);
 char *getUserGameDataDir(void);
 char *getSetupDir(void);
+char *getLevelDirFromTreeInfo(TreeInfo *);
 char *getUserLevelDir(char *);
 char *getNetworkLevelDir(char *);
 char *getCurrentLevelDir(void);
 char *getNewUserLevelSubdir(void);
+char *getTapeDir(char *);
 
-void createDirectory(char *, char *, int);
+void createDirectory(char *, char *);
+void InitMainUserDataDirectory(void);
 void InitUserDataDirectory(void);
 void SetFilePermissions(char *, int);
 
-char *getCookie(char *);
 void fprintFileHeader(FILE *, char *);
 int getFileVersionFromCookieString(const char *);
 boolean checkCookieString(const char *, const char *);
@@ -316,11 +372,16 @@ char *getSetupValue(int, void *);
 char *getSetupLine(struct TokenInfo *, char *, int);
 
 unsigned int get_hash_from_key(void *);
+int hash_keys_are_equal(void *, void *);
 
 int GetZipFileTreeType(char *);
 char *ExtractZipFileIntoDirectory(char *, char *, int);
 
 boolean AdjustGraphicsForEMC(void);
+boolean AdjustSoundsForEMC(void);
+
+void SetCurrentArtwork(int);
+void ChangeCurrentArtworkIfNeeded(int);
 
 void LoadLevelInfo(void);
 void LoadArtworkInfo(void);
@@ -330,11 +391,16 @@ char *getArtworkIdentifierForUserLevelSet(int);
 TreeInfo *getArtworkTreeInfoForUserLevelSet(int);
 boolean checkIfCustomArtworkExistsForCurrentLevelSet(void);
 void AddUserLevelSetToLevelInfo(char *);
-void AddUserArtworkSetToArtworkInfo(char *, int);
-void AddUserTreeSetToTreeInfo(char *, int);
+void AddTreeSetToTreeInfo(TreeInfo *, char *, char *, int);
 boolean UpdateUserLevelSet(char *, char *, char *, int);
 boolean CreateUserLevelSet(char *, char *, char *, int, boolean);
 
+void UpdateLastPlayedLevels_TreeInfo(void);
+void StoreLastPlayedLevels(TreeInfo *);
+void ForcedStoreLastPlayedLevels(TreeInfo *);
+void RestoreLastPlayedLevels(TreeInfo **);
+boolean CheckLastPlayedLevels(void);
+
 void LoadLevelSetup_LastSeries(void);
 void SaveLevelSetup_LastSeries(void);
 void SaveLevelSetup_LastSeries_Deactivate(void);
@@ -348,4 +414,7 @@ void LevelStats_setSolved(int, int);
 void LevelStats_incPlayed(int);
 void LevelStats_incSolved(int);
 
+void LoadUserSetup(void);
+void SaveUserSetup(void);
+
 #endif // MISC_H
Rocks'n'Diamonds