-/***********************************************************
-* 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
+// https://www.artsoft.org/
+// ----------------------------------------------------------------------------
+// setup.h
+// ============================================================================
#ifndef SETUP_H
#define SETUP_H
#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_HEADLINE (1 << 23)
+
+#define TYPE_GHOSTED (1 << 24)
+#define TYPE_QUERY (1 << 25)
+
+// additional values for internal purposes
+#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_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_HEADLINE | \
TYPE_GHOSTED)
#define TYPE_ENTER (TYPE_ENTER_SCREEN | \
#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;
char *text;
};
-/* some definitions for list and hash handling */
+// some definitions for list and hash handling
typedef struct SetupFileList SetupFileList;
typedef struct hashtable SetupFileHash;
} \
-/* sort priorities of level series (also used as level series classes) */
+// 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
#define LEVELCLASS_CLASSICS_START 100
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
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 *getUserMusicDir(void);
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 *);
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 *);
-TreeInfo *newTreeInfo();
+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 updateUserGameDataDir(void);
-
-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 *);
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 *);
+int hash_keys_are_equal(void *, void *);
+
+int GetZipFileTreeType(char *);
+char *ExtractZipFileIntoDirectory(char *, char *, int);
-boolean AdjustGraphicsForEMC();
+boolean AdjustGraphicsForEMC(void);
+boolean AdjustSoundsForEMC(void);
+
+void SetCurrentArtwork(int);
+void ChangeCurrentArtworkIfNeeded(int);
void LoadLevelInfo(void);
void LoadArtworkInfo(void);
void LoadLevelArtworkInfo(void);
+char *getArtworkIdentifierForUserLevelSet(int);
+TreeInfo *getArtworkTreeInfoForUserLevelSet(int);
+boolean checkIfCustomArtworkExistsForCurrentLevelSet(void);
+void AddUserLevelSetToLevelInfo(char *);
+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);
void LoadLevelSetup_SeriesInfo(void);
void SaveLevelSetup_SeriesInfo(void);
-#endif /* MISC_H */
+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);
+
+void LoadUserSetup(void);
+void SaveUserSetup(void);
+
+#endif // MISC_H
projects / rocksndiamonds.git / blobdiff