X-Git-Url: https://git.artsoft.org/?p=rocksndiamonds.git;a=blobdiff_plain;f=src%2Flibgame%2Fsetup.h;h=f7b7892859c813c1d01d4f1b44ec8ac9a72a6488;hp=618e7cb0a2f343a521851c610156ac5f52be2c73;hb=05818ea4267c3e2a196071d17d8735d6f6fe65c9;hpb=ea933dd51bfca7ddcc6b75465476cce57afd1682 diff --git a/src/libgame/setup.h b/src/libgame/setup.h index 618e7cb0..f7b78928 100644 --- a/src/libgame/setup.h +++ b/src/libgame/setup.h @@ -1,59 +1,85 @@ -/*********************************************************** -* Artsoft Retro-Game Library * -*----------------------------------------------------------* -* (c) 1994-2002 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 #include "system.h" +#include "hash.h" /* values for setup file handling */ #define TYPE_BOOLEAN (1 << 0) #define TYPE_SWITCH (1 << 1) -#define TYPE_YES_NO (1 << 2) -#define TYPE_KEY (1 << 3) -#define TYPE_KEY_X11 (1 << 4) -#define TYPE_INTEGER (1 << 5) -#define TYPE_STRING (1 << 6) +#define TYPE_SWITCH3 (1 << 2) +#define TYPE_YES_NO (1 << 3) +#define TYPE_YES_NO_AUTO (1 << 4) +#define TYPE_ECS_AGA (1 << 5) +#define TYPE_KEY (1 << 6) +#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_BOOLEAN_STYLE (TYPE_BOOLEAN | \ TYPE_SWITCH | \ - TYPE_YES_NO) - -/* additional values for setup screen */ -#define TYPE_ENTER_MENU (1 << 7) -#define TYPE_LEAVE_MENU (1 << 8) -#define TYPE_EMPTY (1 << 9) -#define TYPE_KEYTEXT (1 << 10) - -#define TYPE_GHOSTED (1 << 11) -#define TYPE_QUERY (1 << 12) - -#define TYPE_VALUE (TYPE_BOOLEAN_STYLE | \ - TYPE_KEY | \ - TYPE_KEY_X11 | \ - TYPE_INTEGER | \ - TYPE_STRING) - -#define TYPE_SKIP_ENTRY (TYPE_EMPTY | \ - TYPE_KEY | \ - TYPE_STRING) - -#define TYPE_ENTER_OR_LEAVE_MENU (TYPE_ENTER_MENU | \ - TYPE_LEAVE_MENU) - -/* cookie token for file identifier and version number */ -#define TOKEN_STR_FILE_IDENTIFIER "file_identifier" + TYPE_YES_NO | \ + TYPE_ECS_AGA ) + +/* derived values for setup screen */ +#define TYPE_VALUE (TYPE_BOOLEAN_STYLE | \ + TYPE_SWITCH3 | \ + TYPE_YES_NO_AUTO | \ + TYPE_KEY | \ + TYPE_KEY_X11 | \ + TYPE_INTEGER | \ + TYPE_STRING | \ + TYPE_ELEMENT | \ + TYPE_GRAPHIC) + +#define TYPE_SKIP_ENTRY (TYPE_EMPTY | \ + TYPE_KEY | \ + TYPE_STRING | \ + TYPE_GHOSTED) + +#define TYPE_ENTER (TYPE_ENTER_SCREEN | \ + TYPE_ENTER_MENU | \ + TYPE_ENTER_LIST) + +#define TYPE_LEAVE (TYPE_LEAVE_SCREEN | \ + TYPE_LEAVE_MENU | \ + TYPE_LEAVE_LIST) + +#define TYPE_ENTER_OR_LEAVE (TYPE_ENTER | TYPE_LEAVE) struct TokenInfo { @@ -62,15 +88,34 @@ struct TokenInfo char *text; }; +/* some definitions for list and hash handling */ +typedef struct SetupFileList SetupFileList; +typedef struct hashtable SetupFileHash; + +#define BEGIN_HASH_ITERATION(hash, itr) \ + if (hash != NULL && hashtable_count(hash) > 0) \ + { \ + struct hashtable_itr *itr = hashtable_iterator(hash); \ + do { \ + +#define HASH_ITERATION_TOKEN(itr) ((char *)hashtable_iterator_key(itr)) +#define HASH_ITERATION_VALUE(itr) ((char *)hashtable_iterator_value(itr)) + +#define END_HASH_ITERATION(hash, itr) \ + } while (hashtable_iterator_advance(itr)); \ + free(itr); \ + } \ + + /* 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 #define LEVELCLASS_CLASSICS_END 199 -#define LEVELCLASS_CONTRIBUTION_START 200 -#define LEVELCLASS_CONTRIBUTION_END 299 -#define LEVELCLASS_USER_START 300 -#define LEVELCLASS_USER_END 399 +#define LEVELCLASS_CONTRIB_START 200 +#define LEVELCLASS_CONTRIB_END 299 +#define LEVELCLASS_PRIVATE_START 300 +#define LEVELCLASS_PRIVATE_END 399 #define LEVELCLASS_BD_START 400 #define LEVELCLASS_BD_END 499 #define LEVELCLASS_EM_START 500 @@ -79,100 +124,122 @@ struct TokenInfo #define LEVELCLASS_SP_END 699 #define LEVELCLASS_DX_START 700 #define LEVELCLASS_DX_END 799 +#define LEVELCLASS_SB_START 800 +#define LEVELCLASS_SB_END 899 + +#define LEVELCLASS_PREDEFINED_START LEVELCLASS_TUTORIAL_START +#define LEVELCLASS_PREDEFINED_END LEVELCLASS_SB_END #define LEVELCLASS_TUTORIAL LEVELCLASS_TUTORIAL_START #define LEVELCLASS_CLASSICS LEVELCLASS_CLASSICS_START -#define LEVELCLASS_CONTRIBUTION LEVELCLASS_CONTRIBUTION_START -#define LEVELCLASS_USER LEVELCLASS_USER_START +#define LEVELCLASS_CONTRIB LEVELCLASS_CONTRIB_START +#define LEVELCLASS_PRIVATE LEVELCLASS_PRIVATE_START #define LEVELCLASS_BD LEVELCLASS_BD_START #define LEVELCLASS_EM LEVELCLASS_EM_START #define LEVELCLASS_SP LEVELCLASS_SP_START #define LEVELCLASS_DX LEVELCLASS_DX_START +#define LEVELCLASS_SB LEVELCLASS_SB_START #define LEVELCLASS_UNDEFINED 999 -#define IS_LEVELCLASS_TUTORIAL(p) \ - ((p)->sort_priority >= LEVELCLASS_TUTORIAL_START && \ +#define IS_LEVELCLASS_TUTORIAL(p) \ + ((p)->sort_priority >= LEVELCLASS_TUTORIAL_START && \ (p)->sort_priority <= LEVELCLASS_TUTORIAL_END) -#define IS_LEVELCLASS_CLASSICS(p) \ - ((p)->sort_priority >= LEVELCLASS_CLASSICS_START && \ +#define IS_LEVELCLASS_CLASSICS(p) \ + ((p)->sort_priority >= LEVELCLASS_CLASSICS_START && \ (p)->sort_priority <= LEVELCLASS_CLASSICS_END) -#define IS_LEVELCLASS_CONTRIBUTION(p) \ - ((p)->sort_priority >= LEVELCLASS_CONTRIBUTION_START && \ - (p)->sort_priority <= LEVELCLASS_CONTRIBUTION_END) -#define IS_LEVELCLASS_USER(p) \ - ((p)->sort_priority >= LEVELCLASS_USER_START && \ - (p)->sort_priority <= LEVELCLASS_USER_END) -#define IS_LEVELCLASS_BD(p) \ - ((p)->sort_priority >= LEVELCLASS_BD_START && \ +#define IS_LEVELCLASS_CONTRIB(p) \ + ((p)->sort_priority >= LEVELCLASS_CONTRIB_START && \ + (p)->sort_priority <= LEVELCLASS_CONTRIB_END) +#define IS_LEVELCLASS_PRIVATE(p) \ + ((p)->sort_priority >= LEVELCLASS_PRIVATE_START && \ + (p)->sort_priority <= LEVELCLASS_PRIVATE_END) +#define IS_LEVELCLASS_BD(p) \ + ((p)->sort_priority >= LEVELCLASS_BD_START && \ (p)->sort_priority <= LEVELCLASS_BD_END) -#define IS_LEVELCLASS_EM(p) \ - ((p)->sort_priority >= LEVELCLASS_EM_START && \ +#define IS_LEVELCLASS_EM(p) \ + ((p)->sort_priority >= LEVELCLASS_EM_START && \ (p)->sort_priority <= LEVELCLASS_EM_END) -#define IS_LEVELCLASS_SP(p) \ - ((p)->sort_priority >= LEVELCLASS_SP_START && \ +#define IS_LEVELCLASS_SP(p) \ + ((p)->sort_priority >= LEVELCLASS_SP_START && \ (p)->sort_priority <= LEVELCLASS_SP_END) -#define IS_LEVELCLASS_DX(p) \ - ((p)->sort_priority >= LEVELCLASS_DX_START && \ +#define IS_LEVELCLASS_DX(p) \ + ((p)->sort_priority >= LEVELCLASS_DX_START && \ (p)->sort_priority <= LEVELCLASS_DX_END) +#define IS_LEVELCLASS_SB(p) \ + ((p)->sort_priority >= LEVELCLASS_SB_START && \ + (p)->sort_priority <= LEVELCLASS_SB_END) +#define IS_LEVELCLASS_UNDEFINED(p) \ + ((p)->sort_priority < LEVELCLASS_PREDEFINED_START || \ + (p)->sort_priority > LEVELCLASS_PREDEFINED_END) #define LEVELCLASS(n) (IS_LEVELCLASS_TUTORIAL(n) ? LEVELCLASS_TUTORIAL : \ IS_LEVELCLASS_CLASSICS(n) ? LEVELCLASS_CLASSICS : \ - IS_LEVELCLASS_CONTRIBUTION(n) ? LEVELCLASS_CONTRIBUTION : \ - IS_LEVELCLASS_USER(n) ? LEVELCLASS_USER : \ - IS_LEVELCLASS_BD(n) ? LEVELCLASS_BD : \ - IS_LEVELCLASS_EM(n) ? LEVELCLASS_EM : \ - IS_LEVELCLASS_SP(n) ? LEVELCLASS_SP : \ - IS_LEVELCLASS_DX(n) ? LEVELCLASS_DX : \ + IS_LEVELCLASS_CONTRIB(n) ? LEVELCLASS_CONTRIB : \ + IS_LEVELCLASS_PRIVATE(n) ? LEVELCLASS_PRIVATE : \ + IS_LEVELCLASS_BD(n) ? LEVELCLASS_BD : \ + IS_LEVELCLASS_EM(n) ? LEVELCLASS_EM : \ + IS_LEVELCLASS_SP(n) ? LEVELCLASS_SP : \ + IS_LEVELCLASS_DX(n) ? LEVELCLASS_DX : \ + IS_LEVELCLASS_SB(n) ? LEVELCLASS_SB : \ LEVELCLASS_UNDEFINED) /* sort priorities of artwork */ #define ARTWORKCLASS_CLASSICS_START 100 #define ARTWORKCLASS_CLASSICS_END 199 -#define ARTWORKCLASS_CONTRIBUTION_START 200 -#define ARTWORKCLASS_CONTRIBUTION_END 299 -#define ARTWORKCLASS_LEVEL_START 300 -#define ARTWORKCLASS_LEVEL_END 399 -#define ARTWORKCLASS_USER_START 400 -#define ARTWORKCLASS_USER_END 499 +#define ARTWORKCLASS_CONTRIB_START 200 +#define ARTWORKCLASS_CONTRIB_END 299 +#define ARTWORKCLASS_PRIVATE_START 300 +#define ARTWORKCLASS_PRIVATE_END 399 +#define ARTWORKCLASS_LEVEL_START 400 +#define ARTWORKCLASS_LEVEL_END 499 #define ARTWORKCLASS_CLASSICS ARTWORKCLASS_CLASSICS_START -#define ARTWORKCLASS_CONTRIBUTION ARTWORKCLASS_CONTRIBUTION_START +#define ARTWORKCLASS_CONTRIB ARTWORKCLASS_CONTRIB_START +#define ARTWORKCLASS_PRIVATE ARTWORKCLASS_PRIVATE_START #define ARTWORKCLASS_LEVEL ARTWORKCLASS_LEVEL_START -#define ARTWORKCLASS_USER ARTWORKCLASS_USER_START #define ARTWORKCLASS_UNDEFINED 999 -#define IS_ARTWORKCLASS_CLASSICS(p) \ - ((p)->sort_priority >= ARTWORKCLASS_CLASSICS_START && \ +#define IS_ARTWORKCLASS_CLASSICS(p) \ + ((p)->sort_priority >= ARTWORKCLASS_CLASSICS_START && \ (p)->sort_priority <= ARTWORKCLASS_CLASSICS_END) -#define IS_ARTWORKCLASS_CONTRIBUTION(p) \ - ((p)->sort_priority >= ARTWORKCLASS_CONTRIBUTION_START && \ - (p)->sort_priority <= ARTWORKCLASS_CONTRIBUTION_END) -#define IS_ARTWORKCLASS_LEVEL(p) \ - ((p)->sort_priority >= ARTWORKCLASS_LEVEL_START && \ +#define IS_ARTWORKCLASS_CONTRIB(p) \ + ((p)->sort_priority >= ARTWORKCLASS_CONTRIB_START && \ + (p)->sort_priority <= ARTWORKCLASS_CONTRIB_END) +#define IS_ARTWORKCLASS_PRIVATE(p) \ + ((p)->sort_priority >= ARTWORKCLASS_PRIVATE_START && \ + (p)->sort_priority <= ARTWORKCLASS_PRIVATE_END) +#define IS_ARTWORKCLASS_LEVEL(p) \ + ((p)->sort_priority >= ARTWORKCLASS_LEVEL_START && \ (p)->sort_priority <= ARTWORKCLASS_LEVEL_END) -#define IS_ARTWORKCLASS_USER(p) \ - ((p)->sort_priority >= ARTWORKCLASS_USER_START && \ - (p)->sort_priority <= ARTWORKCLASS_USER_END) #define ARTWORKCLASS(n) (IS_ARTWORKCLASS_CLASSICS(n) ? ARTWORKCLASS_CLASSICS :\ - IS_ARTWORKCLASS_CONTRIBUTION(n) ? ARTWORKCLASS_CONTRIBUTION : \ - IS_ARTWORKCLASS_LEVEL(n) ? ARTWORKCLASS_LEVEL : \ - IS_ARTWORKCLASS_USER(n) ? ARTWORKCLASS_USER : \ + IS_ARTWORKCLASS_CONTRIB(n) ? ARTWORKCLASS_CONTRIB : \ + IS_ARTWORKCLASS_PRIVATE(n) ? ARTWORKCLASS_PRIVATE : \ + IS_ARTWORKCLASS_LEVEL(n) ? ARTWORKCLASS_LEVEL : \ ARTWORKCLASS_UNDEFINED) -void setLevelArtworkDir(TreeInfo *); -char *getLevelFilename(int); +char *setLevelArtworkDir(TreeInfo *); +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); +char *getLevelSetInfoFilename(void); +char *getLevelSetTitleMessageFilename(int, boolean); char *getImageFilename(char *); char *getCustomImageFilename(char *); char *getCustomSoundFilename(char *); +char *getCustomMusicFilename(char *); char *getCustomArtworkFilename(char *, int); char *getCustomArtworkConfigFilename(int); +char *getCustomArtworkLevelConfigFilename(int); char *getCustomMusicDirectory(void); void InitTapeDirectory(char *); @@ -181,6 +248,7 @@ void InitUserLevelDirectory(char *); void InitLevelSetupDirectory(char *); TreeInfo *newTreeInfo(); +TreeInfo *newTreeInfo_setDefaults(int); void pushTreeInfo(TreeInfo **, TreeInfo *); int numTreeInfo(TreeInfo *); boolean validLevelSeries(TreeInfo *); @@ -191,38 +259,73 @@ int posTreeInfo(TreeInfo *); TreeInfo *getTreeInfoFromPos(TreeInfo *, int); TreeInfo *getTreeInfoFromIdentifier(TreeInfo *, char *); void dumpTreeInfo(TreeInfo *, int); -void sortTreeInfo(TreeInfo **, - int (*compare_function)(const void *, const void *)); +void sortTreeInfoBySortFunction(TreeInfo **, + int (*compare_function)(const void *, + const void *)); +void sortTreeInfo(TreeInfo **); +void freeTreeInfo(TreeInfo *); -char *getUserDataDir(void); +char *getHomeDir(void); char *getCommonDataDir(void); +char *getPersonalDataDir(void); +char *getUserGameDataDir(void); char *getSetupDir(void); +char *getCurrentLevelDir(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 *); char *getFormattedSetupEntry(char *, char *); -void freeSetupFileList(struct SetupFileList *); -struct SetupFileList *newSetupFileList(char *, char *); -char *getTokenValue(struct SetupFileList *, char *); -void setTokenValue(struct SetupFileList *, char *, char *); -struct SetupFileList *loadSetupFileList(char *); -void checkSetupFileListIdentifier(struct SetupFileList *, char *); + +boolean getTokenValueFromSetupLine(char *, char **, char **); + +SetupFileList *newSetupFileList(char *, char *); +void freeSetupFileList(SetupFileList *); +char *getListEntry(SetupFileList *, char *); +SetupFileList *setListEntry(SetupFileList *, char *, char *); +SetupFileList *addListEntry(SetupFileList *, char *, char *); +SetupFileList *loadSetupFileList(char *); + +SetupFileHash *newSetupFileHash(); +void freeSetupFileHash(SetupFileHash *); +char *getHashEntry(SetupFileHash *, char *); +void setHashEntry(SetupFileHash *, char *, char *); +char *removeHashEntry(SetupFileHash *, char *); +SetupFileHash *loadSetupFileHash(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(); + void LoadLevelInfo(void); void LoadArtworkInfo(void); void LoadLevelArtworkInfo(void); +void AddUserLevelSetToLevelInfo(char *); +boolean UpdateUserLevelSet(char *, char *, char *, int); +boolean CreateUserLevelSet(char *, char *, char *, int); + void LoadLevelSetup_LastSeries(void); void SaveLevelSetup_LastSeries(void); +void SaveLevelSetup_LastSeries_Deactivate(); void LoadLevelSetup_SeriesInfo(void); void SaveLevelSetup_SeriesInfo(void); +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); + #endif /* MISC_H */