X-Git-Url: https://git.artsoft.org/?p=rocksndiamonds.git;a=blobdiff_plain;f=src%2Flibgame%2Fsetup.h;h=59700cf9cf70011ed01b71ed1e224d313ccc85e6;hp=8dbd1694133a0fa4b56506b049ae972fed5f201d;hb=HEAD;hpb=d0c3964b020fd888d52b219b75d9c436ee5c5213 diff --git a/src/libgame/setup.h b/src/libgame/setup.h index 8dbd1694..59700cf9 100644 --- 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 // ============================================================================ @@ -16,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) @@ -27,35 +27,39 @@ #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 | \ @@ -63,12 +67,15 @@ 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 | \ @@ -88,7 +95,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; @@ -107,7 +114,12 @@ 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 @@ -184,7 +196,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 @@ -220,19 +232,57 @@ 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); +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 *); @@ -241,42 +291,61 @@ 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 *); -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 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 *); @@ -292,7 +361,7 @@ 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 *); @@ -303,19 +372,38 @@ 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); -boolean UpdateUserLevelSet(char *, char *, char *, int, int); -boolean CreateUserLevelSet(char *, char *, char *, int, int); +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 SaveLevelSetup_LastSeries_Deactivate(void); void LoadLevelSetup_SeriesInfo(void); void SaveLevelSetup_SeriesInfo(void); @@ -326,4 +414,7 @@ void LevelStats_setSolved(int, int); void LevelStats_incPlayed(int); void LevelStats_incSolved(int); -#endif /* MISC_H */ +void LoadUserSetup(void); +void SaveUserSetup(void); + +#endif // MISC_H