X-Git-Url: https://git.artsoft.org/?p=rocksndiamonds.git;a=blobdiff_plain;f=src%2Flibgame%2Fsetup.h;h=a60585993513299d880294c761173fd9bc3fc496;hp=006a713ad56055f26b2fb1e64a3852f0097c0478;hb=7270af24b41bc33fbb89a97227a7696e343eacbb;hpb=c2a639c0b2c1a9a2bd14de86932a47429ae918a4 diff --git a/src/libgame/setup.h b/src/libgame/setup.h index 006a713a..a6058599 100644 --- a/src/libgame/setup.h +++ b/src/libgame/setup.h @@ -1,15 +1,13 @@ -/*********************************************************** -* 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 @@ -18,45 +16,75 @@ #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_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_TOKEN (1 << 7) - +#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_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_GHOSTED (1 << 23) +#define TYPE_QUERY (1 << 24) + +// 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) + +// 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 << 8) -#define TYPE_LEAVE_MENU (1 << 9) -#define TYPE_EMPTY (1 << 10) -#define TYPE_KEYTEXT (1 << 11) - -#define TYPE_GHOSTED (1 << 12) -#define TYPE_QUERY (1 << 13) + 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_TOKEN) + TYPE_PLAYER | \ + TYPE_ELEMENT | \ + TYPE_GRAPHIC) #define TYPE_SKIP_ENTRY (TYPE_EMPTY | \ + TYPE_SKIPPABLE | \ TYPE_KEY | \ - TYPE_STRING) + TYPE_STRING | \ + TYPE_GHOSTED) + +#define TYPE_ENTER (TYPE_ENTER_SCREEN | \ + TYPE_ENTER_MENU | \ + TYPE_ENTER_LIST) -#define TYPE_ENTER_OR_LEAVE_MENU (TYPE_ENTER_MENU | \ - TYPE_LEAVE_MENU) +#define TYPE_LEAVE (TYPE_LEAVE_SCREEN | \ + TYPE_LEAVE_MENU | \ + TYPE_LEAVE_LIST) -/* cookie token for file identifier and version number */ -#define TOKEN_STR_FILE_IDENTIFIER "file_identifier" +#define TYPE_ENTER_OR_LEAVE (TYPE_ENTER | TYPE_LEAVE) struct TokenInfo { @@ -65,7 +93,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; @@ -84,7 +112,7 @@ typedef struct hashtable SetupFileHash; } \ -/* sort priorities of level series (also used as level series classes) */ +// 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 @@ -101,9 +129,11 @@ typedef struct hashtable SetupFileHash; #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_DX_END +#define LEVELCLASS_PREDEFINED_END LEVELCLASS_SB_END #define LEVELCLASS_TUTORIAL LEVELCLASS_TUTORIAL_START #define LEVELCLASS_CLASSICS LEVELCLASS_CLASSICS_START @@ -113,6 +143,7 @@ typedef struct hashtable SetupFileHash; #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 @@ -140,6 +171,9 @@ typedef struct hashtable SetupFileHash; #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) @@ -152,9 +186,10 @@ typedef struct hashtable SetupFileHash; 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 */ +// sort priorities of artwork #define ARTWORKCLASS_CLASSICS_START 100 #define ARTWORKCLASS_CLASSICS_END 199 #define ARTWORKCLASS_CONTRIB_START 200 @@ -191,14 +226,22 @@ typedef struct hashtable SetupFileHash; ARTWORKCLASS_UNDEFINED) +char *getUserGraphicsDir(void); +char *getUserSoundsDir(void); +char *getUserMusicDir(void); char *setLevelArtworkDir(TreeInfo *); -char *getLevelFilename(int); +char *getProgramMainDataPath(char *, char *); +char *getProgramConfigFilename(char *); char *getTapeFilename(int); +char *getSolutionTapeFilename(int); char *getScoreFilename(int); char *getSetupFilename(void); +char *getDefaultSetupFilename(void); char *getEditorSetupFilename(void); -char *getDemoAnimInfoFilename(void); -char *getDemoAnimTextFilename(void); +char *getHelpAnimFilename(void); +char *getHelpTextFilename(void); +char *getLevelSetInfoFilename(void); +char *getLevelSetTitleMessageFilename(int, boolean); char *getImageFilename(char *); char *getCustomImageFilename(char *); char *getCustomSoundFilename(char *); @@ -211,9 +254,11 @@ char *getCustomMusicDirectory(void); void InitTapeDirectory(char *); void InitScoreDirectory(char *); void InitUserLevelDirectory(char *); +void InitNetworkLevelDirectory(char *); void InitLevelSetupDirectory(char *); -TreeInfo *newTreeInfo(); +TreeInfo *newTreeInfo(void); +TreeInfo *newTreeInfo_setDefaults(int); void pushTreeInfo(TreeInfo **, TreeInfo *); int numTreeInfo(TreeInfo *); boolean validLevelSeries(TreeInfo *); @@ -224,22 +269,36 @@ 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 *getLevelDirFromTreeInfo(TreeInfo *); +char *getUserLevelDir(char *); +char *getNetworkLevelDir(char *); +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 *); +boolean getTokenValueFromSetupLine(char *, char **, char **); + SetupFileList *newSetupFileList(char *, char *); void freeSetupFileList(SetupFileList *); char *getListEntry(SetupFileList *, char *); @@ -247,23 +306,46 @@ 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 *); +char *removeHashEntry(SetupFileHash *, char *); SetupFileHash *loadSetupFileHash(char *); -void checkSetupFileHashIdentifier(SetupFileHash *, 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 GetZipFileTreeType(char *); +char *ExtractZipFileIntoDirectory(char *, char *, int); + +boolean AdjustGraphicsForEMC(void); + 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 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); + +#endif // MISC_H