// (c) 1995-2014 by Artsoft Entertainment
// Holger Schemel
// info@artsoft.org
-// http://www.artsoft.org/
+// https://www.artsoft.org/
// ----------------------------------------------------------------------------
// setup.h
// ============================================================================
#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 | \
TYPE_SKIPPABLE | \
TYPE_KEY | \
TYPE_STRING | \
+ TYPE_HEADLINE | \
TYPE_GHOSTED)
#define TYPE_ENTER (TYPE_ENTER_SCREEN | \
} \
+// 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
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);
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 *getSetupFilename(void);
char *getDefaultSetupFilename(void);
char *getEditorSetupFilename(void);
char *getHelpTextFilename(void);
char *getLevelSetInfoFilename(void);
char *getLevelSetTitleMessageFilename(int, boolean);
+char *getCreditsFilename(int, boolean);
+char *getProgramInfoFilename(int);
char *getImageFilename(char *);
char *getCustomImageFilename(char *);
char *getCustomSoundFilename(char *);
char *getCustomArtworkLevelConfigFilename(int);
char *getCustomMusicDirectory(void);
+void MarkTapeDirectoryUploadsAsComplete(char *);
+void MarkTapeDirectoryUploadsAsIncomplete(char *);
+boolean CheckTapeDirectoryUploadsComplete(char *);
+
void InitTapeDirectory(char *);
void InitScoreDirectory(char *);
+void InitScoreCacheDirectory(char *);
+void InitScoreTapeDirectory(char *, int);
void InitUserLevelDirectory(char *);
void InitNetworkLevelDirectory(char *);
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 InitMainUserDataDirectory(void);
void InitUserDataDirectory(void);
void SetFilePermissions(char *, int);
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);
TreeInfo *getArtworkTreeInfoForUserLevelSet(int);
boolean checkIfCustomArtworkExistsForCurrentLevelSet(void);
void AddUserLevelSetToLevelInfo(char *);
-void AddUserArtworkSetToArtworkInfo(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 RestoreLastPlayedLevels(TreeInfo **);
+
void LoadLevelSetup_LastSeries(void);
void SaveLevelSetup_LastSeries(void);
void SaveLevelSetup_LastSeries_Deactivate(void);
void LevelStats_incPlayed(int);
void LevelStats_incSolved(int);
+void LoadUserSetup(void);
+void SaveUserSetup(void);
+
#endif // MISC_H