src/libgame/setup.h

   1 // ============================================================================
   2 // Artsoft Retro-Game Library
   3 // ----------------------------------------------------------------------------
   4 // (c) 1995-2014 by Artsoft Entertainment
   5 //                  Holger Schemel
   6 //                  info@artsoft.org
   7 //                  http://www.artsoft.org/
   8 // ----------------------------------------------------------------------------
   9 // setup.h
  10 // ============================================================================
  11
  12 #ifndef SETUP_H
  13 #define SETUP_H
  14
  15 #include "system.h"
  16 #include "hash.h"
  17
  18
  19 // values for setup file handling
  20 #define TYPE_BOOLEAN                    (1 << 0)
  21 #define TYPE_SWITCH                     (1 << 1)
  22 #define TYPE_SWITCH3                    (1 << 2)
  23 #define TYPE_YES_NO                     (1 << 3)
  24 #define TYPE_YES_NO_AUTO                (1 << 4)
  25 #define TYPE_ECS_AGA                    (1 << 5)
  26 #define TYPE_KEY                        (1 << 6)
  27 #define TYPE_KEY_X11                    (1 << 7)
  28 #define TYPE_INTEGER                    (1 << 8)
  29 #define TYPE_STRING                     (1 << 9)
  30 #define TYPE_PLAYER                     (1 << 10)
  31 #define TYPE_ELEMENT                    (1 << 11)
  32 #define TYPE_GRAPHIC                    (1 << 12)
  33
  34 // additional values for setup screen
  35 #define TYPE_ENTER_SCREEN               (1 << 13)
  36 #define TYPE_LEAVE_SCREEN               (1 << 14)
  37 #define TYPE_ENTER_MENU                 (1 << 15)
  38 #define TYPE_LEAVE_MENU                 (1 << 16)
  39 #define TYPE_ENTER_LIST                 (1 << 17)
  40 #define TYPE_LEAVE_LIST                 (1 << 18)
  41 #define TYPE_TEXT_INPUT                 (1 << 19)
  42 #define TYPE_EMPTY                      (1 << 20)
  43 #define TYPE_SKIPPABLE                  (1 << 21)
  44 #define TYPE_KEYTEXT                    (1 << 22)
  45
  46 #define TYPE_GHOSTED                    (1 << 23)
  47 #define TYPE_QUERY                      (1 << 24)
  48
  49 // additional values for internal purposes
  50 #define TYPE_BITFIELD                   (1 << 25)
  51 #define TYPE_CONTENT                    (1 << 26)
  52 #define TYPE_ELEMENT_LIST               (1 << 27)
  53 #define TYPE_CONTENT_LIST               (1 << 28)
  54
  55 // derived values for setup file handling
  56 #define TYPE_BOOLEAN_STYLE              (TYPE_BOOLEAN | \
  57                                          TYPE_SWITCH  | \
  58                                          TYPE_YES_NO  | \
  59                                          TYPE_ECS_AGA )
  60
  61 // derived values for setup screen
  62 #define TYPE_VALUE                      (TYPE_BOOLEAN_STYLE     | \
  63                                          TYPE_SWITCH3           | \
  64                                          TYPE_YES_NO_AUTO       | \
  65                                          TYPE_KEY               | \
  66                                          TYPE_KEY_X11           | \
  67                                          TYPE_INTEGER           | \
  68                                          TYPE_STRING            | \
  69                                          TYPE_PLAYER            | \
  70                                          TYPE_ELEMENT           | \
  71                                          TYPE_GRAPHIC)
  72
  73 #define TYPE_SKIP_ENTRY                 (TYPE_EMPTY             | \
  74                                          TYPE_SKIPPABLE         | \
  75                                          TYPE_KEY               | \
  76                                          TYPE_STRING            | \
  77                                          TYPE_GHOSTED)
  78
  79 #define TYPE_ENTER                      (TYPE_ENTER_SCREEN      | \
  80                                          TYPE_ENTER_MENU        | \
  81                                          TYPE_ENTER_LIST)
  82
  83 #define TYPE_LEAVE                      (TYPE_LEAVE_SCREEN      | \
  84                                          TYPE_LEAVE_MENU        | \
  85                                          TYPE_LEAVE_LIST)
  86
  87 #define TYPE_ENTER_OR_LEAVE             (TYPE_ENTER | TYPE_LEAVE)
  88
  89 struct TokenInfo
  90 {
  91   int type;
  92   void *value;
  93   char *text;
  94 };
  95
  96 // some definitions for list and hash handling
  97 typedef struct SetupFileList SetupFileList;
  98 typedef struct hashtable     SetupFileHash;
  99
 100 #define BEGIN_HASH_ITERATION(hash, itr)                         \
 101   if (hash != NULL && hashtable_count(hash) > 0)                \
 102   {                                                             \
 103     struct hashtable_itr *itr = hashtable_iterator(hash);       \
 104     do {                                                        \
 105
 106 #define HASH_ITERATION_TOKEN(itr)       ((char *)hashtable_iterator_key(itr))
 107 #define HASH_ITERATION_VALUE(itr)       ((char *)hashtable_iterator_value(itr))
 108
 109 #define END_HASH_ITERATION(hash, itr)                           \
 110     } while (hashtable_iterator_advance(itr));                  \
 111     free(itr);                                                  \
 112   }                                                             \
 113
 114
 115 // sort priorities of level series (also used as level series classes)
 116 #define LEVELCLASS_TUTORIAL_START       10
 117 #define LEVELCLASS_TUTORIAL_END         99
 118 #define LEVELCLASS_CLASSICS_START       100
 119 #define LEVELCLASS_CLASSICS_END         199
 120 #define LEVELCLASS_CONTRIB_START        200
 121 #define LEVELCLASS_CONTRIB_END          299
 122 #define LEVELCLASS_PRIVATE_START        300
 123 #define LEVELCLASS_PRIVATE_END          399
 124 #define LEVELCLASS_BD_START             400
 125 #define LEVELCLASS_BD_END               499
 126 #define LEVELCLASS_EM_START             500
 127 #define LEVELCLASS_EM_END               599
 128 #define LEVELCLASS_SP_START             600
 129 #define LEVELCLASS_SP_END               699
 130 #define LEVELCLASS_DX_START             700
 131 #define LEVELCLASS_DX_END               799
 132 #define LEVELCLASS_SB_START             800
 133 #define LEVELCLASS_SB_END               899
 134
 135 #define LEVELCLASS_PREDEFINED_START     LEVELCLASS_TUTORIAL_START
 136 #define LEVELCLASS_PREDEFINED_END       LEVELCLASS_SB_END
 137
 138 #define LEVELCLASS_TUTORIAL             LEVELCLASS_TUTORIAL_START
 139 #define LEVELCLASS_CLASSICS             LEVELCLASS_CLASSICS_START
 140 #define LEVELCLASS_CONTRIB              LEVELCLASS_CONTRIB_START
 141 #define LEVELCLASS_PRIVATE              LEVELCLASS_PRIVATE_START
 142 #define LEVELCLASS_BD                   LEVELCLASS_BD_START
 143 #define LEVELCLASS_EM                   LEVELCLASS_EM_START
 144 #define LEVELCLASS_SP                   LEVELCLASS_SP_START
 145 #define LEVELCLASS_DX                   LEVELCLASS_DX_START
 146 #define LEVELCLASS_SB                   LEVELCLASS_SB_START
 147
 148 #define LEVELCLASS_UNDEFINED            999
 149
 150 #define IS_LEVELCLASS_TUTORIAL(p)                                       \
 151         ((p)->sort_priority >= LEVELCLASS_TUTORIAL_START &&             \
 152          (p)->sort_priority <= LEVELCLASS_TUTORIAL_END)
 153 #define IS_LEVELCLASS_CLASSICS(p)                                       \
 154         ((p)->sort_priority >= LEVELCLASS_CLASSICS_START &&             \
 155          (p)->sort_priority <= LEVELCLASS_CLASSICS_END)
 156 #define IS_LEVELCLASS_CONTRIB(p)                                        \
 157         ((p)->sort_priority >= LEVELCLASS_CONTRIB_START &&              \
 158          (p)->sort_priority <= LEVELCLASS_CONTRIB_END)
 159 #define IS_LEVELCLASS_PRIVATE(p)                                        \
 160         ((p)->sort_priority >= LEVELCLASS_PRIVATE_START &&              \
 161          (p)->sort_priority <= LEVELCLASS_PRIVATE_END)
 162 #define IS_LEVELCLASS_BD(p)                                             \
 163         ((p)->sort_priority >= LEVELCLASS_BD_START &&                   \
 164          (p)->sort_priority <= LEVELCLASS_BD_END)
 165 #define IS_LEVELCLASS_EM(p)                                             \
 166         ((p)->sort_priority >= LEVELCLASS_EM_START &&                   \
 167          (p)->sort_priority <= LEVELCLASS_EM_END)
 168 #define IS_LEVELCLASS_SP(p)                                             \
 169         ((p)->sort_priority >= LEVELCLASS_SP_START &&                   \
 170          (p)->sort_priority <= LEVELCLASS_SP_END)
 171 #define IS_LEVELCLASS_DX(p)                                             \
 172         ((p)->sort_priority >= LEVELCLASS_DX_START &&                   \
 173          (p)->sort_priority <= LEVELCLASS_DX_END)
 174 #define IS_LEVELCLASS_SB(p)                                             \
 175         ((p)->sort_priority >= LEVELCLASS_SB_START &&                   \
 176          (p)->sort_priority <= LEVELCLASS_SB_END)
 177 #define IS_LEVELCLASS_UNDEFINED(p)                                      \
 178         ((p)->sort_priority < LEVELCLASS_PREDEFINED_START ||            \
 179          (p)->sort_priority > LEVELCLASS_PREDEFINED_END)
 180
 181 #define LEVELCLASS(n)   (IS_LEVELCLASS_TUTORIAL(n) ? LEVELCLASS_TUTORIAL : \
 182                          IS_LEVELCLASS_CLASSICS(n) ? LEVELCLASS_CLASSICS : \
 183                          IS_LEVELCLASS_CONTRIB(n) ? LEVELCLASS_CONTRIB :   \
 184                          IS_LEVELCLASS_PRIVATE(n) ? LEVELCLASS_PRIVATE :   \
 185                          IS_LEVELCLASS_BD(n) ? LEVELCLASS_BD :             \
 186                          IS_LEVELCLASS_EM(n) ? LEVELCLASS_EM :             \
 187                          IS_LEVELCLASS_SP(n) ? LEVELCLASS_SP :             \
 188                          IS_LEVELCLASS_DX(n) ? LEVELCLASS_DX :             \
 189                          IS_LEVELCLASS_SB(n) ? LEVELCLASS_SB :             \
 190                          LEVELCLASS_UNDEFINED)
 191
 192 // sort priorities of artwork
 193 #define ARTWORKCLASS_CLASSICS_START     100
 194 #define ARTWORKCLASS_CLASSICS_END       199
 195 #define ARTWORKCLASS_CONTRIB_START      200
 196 #define ARTWORKCLASS_CONTRIB_END        299
 197 #define ARTWORKCLASS_PRIVATE_START      300
 198 #define ARTWORKCLASS_PRIVATE_END        399
 199 #define ARTWORKCLASS_LEVEL_START        400
 200 #define ARTWORKCLASS_LEVEL_END          499
 201
 202 #define ARTWORKCLASS_CLASSICS           ARTWORKCLASS_CLASSICS_START
 203 #define ARTWORKCLASS_CONTRIB            ARTWORKCLASS_CONTRIB_START
 204 #define ARTWORKCLASS_PRIVATE            ARTWORKCLASS_PRIVATE_START
 205 #define ARTWORKCLASS_LEVEL              ARTWORKCLASS_LEVEL_START
 206
 207 #define ARTWORKCLASS_UNDEFINED          999
 208
 209 #define IS_ARTWORKCLASS_CLASSICS(p)                                     \
 210         ((p)->sort_priority >= ARTWORKCLASS_CLASSICS_START &&           \
 211          (p)->sort_priority <= ARTWORKCLASS_CLASSICS_END)
 212 #define IS_ARTWORKCLASS_CONTRIB(p)                                      \
 213         ((p)->sort_priority >= ARTWORKCLASS_CONTRIB_START &&            \
 214          (p)->sort_priority <= ARTWORKCLASS_CONTRIB_END)
 215 #define IS_ARTWORKCLASS_PRIVATE(p)                                      \
 216         ((p)->sort_priority >= ARTWORKCLASS_PRIVATE_START &&            \
 217          (p)->sort_priority <= ARTWORKCLASS_PRIVATE_END)
 218 #define IS_ARTWORKCLASS_LEVEL(p)                                        \
 219         ((p)->sort_priority >= ARTWORKCLASS_LEVEL_START &&              \
 220          (p)->sort_priority <= ARTWORKCLASS_LEVEL_END)
 221
 222 #define ARTWORKCLASS(n) (IS_ARTWORKCLASS_CLASSICS(n) ? ARTWORKCLASS_CLASSICS :\
 223                          IS_ARTWORKCLASS_CONTRIB(n) ? ARTWORKCLASS_CONTRIB :  \
 224                          IS_ARTWORKCLASS_PRIVATE(n) ? ARTWORKCLASS_PRIVATE :  \
 225                          IS_ARTWORKCLASS_LEVEL(n) ? ARTWORKCLASS_LEVEL :      \
 226                          ARTWORKCLASS_UNDEFINED)
 227
 228
 229 char *getUserGraphicsDir(void);
 230 char *getUserSoundsDir(void);
 231 char *getUserMusicDir(void);
 232 char *setLevelArtworkDir(TreeInfo *);
 233 char *getProgramMainDataPath(char *, char *);
 234 char *getProgramConfigFilename(char *);
 235 char *getTapeFilename(int);
 236 char *getSolutionTapeFilename(int);
 237 char *getScoreFilename(int);
 238 char *getSetupFilename(void);
 239 char *getDefaultSetupFilename(void);
 240 char *getEditorSetupFilename(void);
 241 char *getHelpAnimFilename(void);
 242 char *getHelpTextFilename(void);
 243 char *getLevelSetInfoFilename(void);
 244 char *getLevelSetTitleMessageFilename(int, boolean);
 245 char *getImageFilename(char *);
 246 char *getCustomImageFilename(char *);
 247 char *getCustomSoundFilename(char *);
 248 char *getCustomMusicFilename(char *);
 249 char *getCustomArtworkFilename(char *, int);
 250 char *getCustomArtworkConfigFilename(int);
 251 char *getCustomArtworkLevelConfigFilename(int);
 252 char *getCustomMusicDirectory(void);
 253
 254 void InitTapeDirectory(char *);
 255 void InitScoreDirectory(char *);
 256 void InitUserLevelDirectory(char *);
 257 void InitNetworkLevelDirectory(char *);
 258 void InitLevelSetupDirectory(char *);
 259
 260 TreeInfo *newTreeInfo(void);
 261 TreeInfo *newTreeInfo_setDefaults(int);
 262 void pushTreeInfo(TreeInfo **, TreeInfo *);
 263 int numTreeInfo(TreeInfo *);
 264 boolean validLevelSeries(TreeInfo *);
 265 TreeInfo *getFirstValidTreeInfoEntry(TreeInfo *);
 266 TreeInfo *getTreeInfoFirstGroupEntry(TreeInfo *);
 267 int numTreeInfoInGroup(TreeInfo *);
 268 int posTreeInfo(TreeInfo *);
 269 TreeInfo *getTreeInfoFromPos(TreeInfo *, int);
 270 TreeInfo *getTreeInfoFromIdentifier(TreeInfo *, char *);
 271 void dumpTreeInfo(TreeInfo *, int);
 272 void sortTreeInfoBySortFunction(TreeInfo **,
 273                                 int (*compare_function)(const void *,
 274                                                         const void *));
 275 void sortTreeInfo(TreeInfo **);
 276 void freeTreeInfo(TreeInfo *);
 277
 278 char *getHomeDir(void);
 279 char *getCommonDataDir(void);
 280 char *getPersonalDataDir(void);
 281 char *getUserGameDataDir(void);
 282 char *getSetupDir(void);
 283 char *getUserLevelDir(char *);
 284 char *getNetworkLevelDir(char *);
 285 char *getCurrentLevelDir(void);
 286 char *getNewUserLevelSubdir(void);
 287
 288 void createDirectory(char *, char *, int);
 289 void InitUserDataDirectory(void);
 290 void SetFilePermissions(char *, int);
 291
 292 char *getCookie(char *);
 293 void fprintFileHeader(FILE *, char *);
 294 int getFileVersionFromCookieString(const char *);
 295 boolean checkCookieString(const char *, const char *);
 296
 297 char *getFormattedSetupEntry(char *, char *);
 298
 299 boolean getTokenValueFromSetupLine(char *, char **, char **);
 300
 301 SetupFileList *newSetupFileList(char *, char *);
 302 void freeSetupFileList(SetupFileList *);
 303 char *getListEntry(SetupFileList *, char *);
 304 SetupFileList *setListEntry(SetupFileList *, char *, char *);
 305 SetupFileList *addListEntry(SetupFileList *, char *, char *);
 306 SetupFileList *loadSetupFileList(char *);
 307
 308 SetupFileHash *newSetupFileHash(void);
 309 void freeSetupFileHash(SetupFileHash *);
 310 char *getHashEntry(SetupFileHash *, char *);
 311 void setHashEntry(SetupFileHash *, char *, char *);
 312 char *removeHashEntry(SetupFileHash *, char *);
 313 SetupFileHash *loadSetupFileHash(char *);
 314 void setSetupInfo(struct TokenInfo *, int, char *);
 315 char *getSetupValue(int, void *);
 316 char *getSetupLine(struct TokenInfo *, char *, int);
 317
 318 unsigned int get_hash_from_key(void *);
 319
 320 int GetZipFileTreeType(char *);
 321 char *ExtractZipFileIntoDirectory(char *, char *, int);
 322
 323 boolean AdjustGraphicsForEMC(void);
 324
 325 void LoadLevelInfo(void);
 326 void LoadArtworkInfo(void);
 327 void LoadLevelArtworkInfo(void);
 328
 329 char *getArtworkIdentifierForUserLevelSet(int);
 330 TreeInfo *getArtworkTreeInfoForUserLevelSet(int);
 331 boolean checkIfCustomArtworkExistsForCurrentLevelSet(void);
 332 void AddUserLevelSetToLevelInfo(char *);
 333 void AddUserArtworkSetToArtworkInfo(char *, int);
 334 void AddUserTreeSetToTreeInfo(char *, int);
 335 boolean UpdateUserLevelSet(char *, char *, char *, int);
 336 boolean CreateUserLevelSet(char *, char *, char *, int, boolean);
 337
 338 void LoadLevelSetup_LastSeries(void);
 339 void SaveLevelSetup_LastSeries(void);
 340 void SaveLevelSetup_LastSeries_Deactivate(void);
 341 void LoadLevelSetup_SeriesInfo(void);
 342 void SaveLevelSetup_SeriesInfo(void);
 343
 344 int LevelStats_getPlayed(int);
 345 int LevelStats_getSolved(int);
 346 void LevelStats_setPlayed(int, int);
 347 void LevelStats_setSolved(int, int);
 348 void LevelStats_incPlayed(int);
 349 void LevelStats_incSolved(int);
 350
 351 #endif // MISC_H