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 //                  https://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_SWITCH_3_STATES            (1 << 2)
  23 #define TYPE_YES_NO                     (1 << 3)
  24 #define TYPE_YES_NO_AUTO                (1 << 4)
  25 #define TYPE_YES_NO_ASK                 (1 << 5)
  26 #define TYPE_ECS_AGA                    (1 << 6)
  27 #define TYPE_KEY                        (1 << 7)
  28 #define TYPE_KEY_X11                    (1 << 8)
  29 #define TYPE_INTEGER                    (1 << 9)
  30 #define TYPE_STRING                     (1 << 10)
  31 #define TYPE_PLAYER                     (1 << 11)
  32 #define TYPE_ELEMENT                    (1 << 12)
  33 #define TYPE_GRAPHIC                    (1 << 13)
  34
  35 // additional values for setup screen
  36 #define TYPE_ENTER_SCREEN               (1 << 14)
  37 #define TYPE_LEAVE_SCREEN               (1 << 15)
  38 #define TYPE_ENTER_MENU                 (1 << 16)
  39 #define TYPE_LEAVE_MENU                 (1 << 17)
  40 #define TYPE_ENTER_LIST                 (1 << 18)
  41 #define TYPE_LEAVE_LIST                 (1 << 19)
  42 #define TYPE_TEXT_INPUT                 (1 << 20)
  43 #define TYPE_EMPTY                      (1 << 21)
  44 #define TYPE_SKIPPABLE                  (1 << 22)
  45 #define TYPE_KEYTEXT                    (1 << 23)
  46 #define TYPE_HEADLINE                   (1 << 24)
  47
  48 #define TYPE_GHOSTED                    (1 << 25)
  49 #define TYPE_QUERY                      (1 << 26)
  50
  51 // additional values for internal purposes
  52 #define TYPE_BITFIELD                   (1 << 27)
  53 #define TYPE_CONTENT                    (1 << 28)
  54 #define TYPE_ELEMENT_LIST               (1 << 29)
  55 #define TYPE_CONTENT_LIST               (1 << 30)
  56
  57 // derived values for setup file handling
  58 #define TYPE_BOOLEAN_STYLE              (TYPE_BOOLEAN | \
  59                                          TYPE_SWITCH  | \
  60                                          TYPE_YES_NO  | \
  61                                          TYPE_ECS_AGA )
  62
  63 // derived values for setup screen
  64 #define TYPE_VALUE                      (TYPE_BOOLEAN_STYLE     | \
  65                                          TYPE_SWITCH_3_STATES   | \
  66                                          TYPE_YES_NO_AUTO       | \
  67                                          TYPE_YES_NO_ASK        | \
  68                                          TYPE_KEY               | \
  69                                          TYPE_KEY_X11           | \
  70                                          TYPE_INTEGER           | \
  71                                          TYPE_STRING            | \
  72                                          TYPE_PLAYER            | \
  73                                          TYPE_ELEMENT           | \
  74                                          TYPE_GRAPHIC)
  75
  76 #define TYPE_SKIP_ENTRY                 (TYPE_EMPTY             | \
  77                                          TYPE_SKIPPABLE         | \
  78                                          TYPE_KEY               | \
  79                                          TYPE_STRING            | \
  80                                          TYPE_HEADLINE          | \
  81                                          TYPE_GHOSTED)
  82
  83 #define TYPE_ENTER                      (TYPE_ENTER_SCREEN      | \
  84                                          TYPE_ENTER_MENU        | \
  85                                          TYPE_ENTER_LIST)
  86
  87 #define TYPE_LEAVE                      (TYPE_LEAVE_SCREEN      | \
  88                                          TYPE_LEAVE_MENU        | \
  89                                          TYPE_LEAVE_LIST)
  90
  91 #define TYPE_ENTER_OR_LEAVE             (TYPE_ENTER | TYPE_LEAVE)
  92
  93 struct TokenInfo
  94 {
  95   int type;
  96   void *value;
  97   char *text;
  98 };
  99
 100 // some definitions for list and hash handling
 101 typedef struct SetupFileList SetupFileList;
 102 typedef struct hashtable     SetupFileHash;
 103
 104 #define BEGIN_HASH_ITERATION(hash, itr)                         \
 105   if (hash != NULL && hashtable_count(hash) > 0)                \
 106   {                                                             \
 107     struct hashtable_itr *itr = hashtable_iterator(hash);       \
 108     do {                                                        \
 109
 110 #define HASH_ITERATION_TOKEN(itr)       ((char *)hashtable_iterator_key(itr))
 111 #define HASH_ITERATION_VALUE(itr)       ((char *)hashtable_iterator_value(itr))
 112
 113 #define END_HASH_ITERATION(hash, itr)                           \
 114     } while (hashtable_iterator_advance(itr));                  \
 115     free(itr);                                                  \
 116   }                                                             \
 117
 118
 119 // sort priorities of special tree entries
 120 #define LEVELCLASS_TOP                  0
 121 #define LEVELCLASS_PARENT               1
 122 #define LEVELCLASS_LAST_PLAYED_LEVEL    2
 123
 124 // sort priorities of level series (also used as level series classes)
 125 #define LEVELCLASS_TUTORIAL_START       10
 126 #define LEVELCLASS_TUTORIAL_END         99
 127 #define LEVELCLASS_CLASSICS_START       100
 128 #define LEVELCLASS_CLASSICS_END         199
 129 #define LEVELCLASS_CONTRIB_START        200
 130 #define LEVELCLASS_CONTRIB_END          299
 131 #define LEVELCLASS_PRIVATE_START        300
 132 #define LEVELCLASS_PRIVATE_END          399
 133 #define LEVELCLASS_BD_START             400
 134 #define LEVELCLASS_BD_END               499
 135 #define LEVELCLASS_EM_START             500
 136 #define LEVELCLASS_EM_END               599
 137 #define LEVELCLASS_SP_START             600
 138 #define LEVELCLASS_SP_END               699
 139 #define LEVELCLASS_DX_START             700
 140 #define LEVELCLASS_DX_END               799
 141 #define LEVELCLASS_SB_START             800
 142 #define LEVELCLASS_SB_END               899
 143
 144 #define LEVELCLASS_PREDEFINED_START     LEVELCLASS_TUTORIAL_START
 145 #define LEVELCLASS_PREDEFINED_END       LEVELCLASS_SB_END
 146
 147 #define LEVELCLASS_TUTORIAL             LEVELCLASS_TUTORIAL_START
 148 #define LEVELCLASS_CLASSICS             LEVELCLASS_CLASSICS_START
 149 #define LEVELCLASS_CONTRIB              LEVELCLASS_CONTRIB_START
 150 #define LEVELCLASS_PRIVATE              LEVELCLASS_PRIVATE_START
 151 #define LEVELCLASS_BD                   LEVELCLASS_BD_START
 152 #define LEVELCLASS_EM                   LEVELCLASS_EM_START
 153 #define LEVELCLASS_SP                   LEVELCLASS_SP_START
 154 #define LEVELCLASS_DX                   LEVELCLASS_DX_START
 155 #define LEVELCLASS_SB                   LEVELCLASS_SB_START
 156
 157 #define LEVELCLASS_UNDEFINED            999
 158
 159 #define IS_LEVELCLASS_TUTORIAL(p)                                       \
 160         ((p)->sort_priority >= LEVELCLASS_TUTORIAL_START &&             \
 161          (p)->sort_priority <= LEVELCLASS_TUTORIAL_END)
 162 #define IS_LEVELCLASS_CLASSICS(p)                                       \
 163         ((p)->sort_priority >= LEVELCLASS_CLASSICS_START &&             \
 164          (p)->sort_priority <= LEVELCLASS_CLASSICS_END)
 165 #define IS_LEVELCLASS_CONTRIB(p)                                        \
 166         ((p)->sort_priority >= LEVELCLASS_CONTRIB_START &&              \
 167          (p)->sort_priority <= LEVELCLASS_CONTRIB_END)
 168 #define IS_LEVELCLASS_PRIVATE(p)                                        \
 169         ((p)->sort_priority >= LEVELCLASS_PRIVATE_START &&              \
 170          (p)->sort_priority <= LEVELCLASS_PRIVATE_END)
 171 #define IS_LEVELCLASS_BD(p)                                             \
 172         ((p)->sort_priority >= LEVELCLASS_BD_START &&                   \
 173          (p)->sort_priority <= LEVELCLASS_BD_END)
 174 #define IS_LEVELCLASS_EM(p)                                             \
 175         ((p)->sort_priority >= LEVELCLASS_EM_START &&                   \
 176          (p)->sort_priority <= LEVELCLASS_EM_END)
 177 #define IS_LEVELCLASS_SP(p)                                             \
 178         ((p)->sort_priority >= LEVELCLASS_SP_START &&                   \
 179          (p)->sort_priority <= LEVELCLASS_SP_END)
 180 #define IS_LEVELCLASS_DX(p)                                             \
 181         ((p)->sort_priority >= LEVELCLASS_DX_START &&                   \
 182          (p)->sort_priority <= LEVELCLASS_DX_END)
 183 #define IS_LEVELCLASS_SB(p)                                             \
 184         ((p)->sort_priority >= LEVELCLASS_SB_START &&                   \
 185          (p)->sort_priority <= LEVELCLASS_SB_END)
 186 #define IS_LEVELCLASS_UNDEFINED(p)                                      \
 187         ((p)->sort_priority < LEVELCLASS_PREDEFINED_START ||            \
 188          (p)->sort_priority > LEVELCLASS_PREDEFINED_END)
 189
 190 #define LEVELCLASS(n)   (IS_LEVELCLASS_TUTORIAL(n) ? LEVELCLASS_TUTORIAL : \
 191                          IS_LEVELCLASS_CLASSICS(n) ? LEVELCLASS_CLASSICS : \
 192                          IS_LEVELCLASS_CONTRIB(n) ? LEVELCLASS_CONTRIB :   \
 193                          IS_LEVELCLASS_PRIVATE(n) ? LEVELCLASS_PRIVATE :   \
 194                          IS_LEVELCLASS_BD(n) ? LEVELCLASS_BD :             \
 195                          IS_LEVELCLASS_EM(n) ? LEVELCLASS_EM :             \
 196                          IS_LEVELCLASS_SP(n) ? LEVELCLASS_SP :             \
 197                          IS_LEVELCLASS_DX(n) ? LEVELCLASS_DX :             \
 198                          IS_LEVELCLASS_SB(n) ? LEVELCLASS_SB :             \
 199                          LEVELCLASS_UNDEFINED)
 200
 201 // sort priorities of artwork
 202 #define ARTWORKCLASS_CLASSICS_START     100
 203 #define ARTWORKCLASS_CLASSICS_END       199
 204 #define ARTWORKCLASS_CONTRIB_START      200
 205 #define ARTWORKCLASS_CONTRIB_END        299
 206 #define ARTWORKCLASS_PRIVATE_START      300
 207 #define ARTWORKCLASS_PRIVATE_END        399
 208 #define ARTWORKCLASS_LEVEL_START        400
 209 #define ARTWORKCLASS_LEVEL_END          499
 210
 211 #define ARTWORKCLASS_CLASSICS           ARTWORKCLASS_CLASSICS_START
 212 #define ARTWORKCLASS_CONTRIB            ARTWORKCLASS_CONTRIB_START
 213 #define ARTWORKCLASS_PRIVATE            ARTWORKCLASS_PRIVATE_START
 214 #define ARTWORKCLASS_LEVEL              ARTWORKCLASS_LEVEL_START
 215
 216 #define ARTWORKCLASS_UNDEFINED          999
 217
 218 #define IS_ARTWORKCLASS_CLASSICS(p)                                     \
 219         ((p)->sort_priority >= ARTWORKCLASS_CLASSICS_START &&           \
 220          (p)->sort_priority <= ARTWORKCLASS_CLASSICS_END)
 221 #define IS_ARTWORKCLASS_CONTRIB(p)                                      \
 222         ((p)->sort_priority >= ARTWORKCLASS_CONTRIB_START &&            \
 223          (p)->sort_priority <= ARTWORKCLASS_CONTRIB_END)
 224 #define IS_ARTWORKCLASS_PRIVATE(p)                                      \
 225         ((p)->sort_priority >= ARTWORKCLASS_PRIVATE_START &&            \
 226          (p)->sort_priority <= ARTWORKCLASS_PRIVATE_END)
 227 #define IS_ARTWORKCLASS_LEVEL(p)                                        \
 228         ((p)->sort_priority >= ARTWORKCLASS_LEVEL_START &&              \
 229          (p)->sort_priority <= ARTWORKCLASS_LEVEL_END)
 230
 231 #define ARTWORKCLASS(n) (IS_ARTWORKCLASS_CLASSICS(n) ? ARTWORKCLASS_CLASSICS :\
 232                          IS_ARTWORKCLASS_CONTRIB(n) ? ARTWORKCLASS_CONTRIB :  \
 233                          IS_ARTWORKCLASS_PRIVATE(n) ? ARTWORKCLASS_PRIVATE :  \
 234                          IS_ARTWORKCLASS_LEVEL(n) ? ARTWORKCLASS_LEVEL :      \
 235                          ARTWORKCLASS_UNDEFINED)
 236
 237 #define TREE_SORTING_DIR(ti)                                            \
 238         (((ti)->parent_link                                ? 0 :        \
 239           (ti)->in_user_dir                                ? 4 * 200 :  \
 240           (ti)->sort_priority >= LEVELCLASS_CLASSICS_START ? 3 * 200 +  \
 241           (ti)->sort_priority % 100 :                                   \
 242           (ti)->sort_priority >= LEVELCLASS_TUTORIAL_START ? 2 * 200 +  \
 243           (ti)->sort_priority % 100 :                                   \
 244           1 * 200) +                                                    \
 245          ((ti)->level_group ? 0 : 100))
 246
 247 #define TREE_COLOR_DIR(ti, active)                                      \
 248         ((active)                       ? FC_YELLOW :                   \
 249          TREE_SORTING(ti) / 200 == 4    ? FC_GREEN :                    \
 250          TREE_SORTING(ti) / 200 == 2    ? FC_BLUE :                     \
 251          FC_RED)
 252
 253 #define TREE_SORTING(ti)                                                \
 254         (TREE_TYPE_IS_DIR((ti)->type) ? TREE_SORTING_DIR(ti) :          \
 255          (ti)->sort_priority)
 256
 257 #define TREE_COLOR(ti, active)                                          \
 258         (TREE_TYPE_IS_DIR((ti)->type) ? TREE_COLOR_DIR(ti, active) :    \
 259          (ti)->color)
 260
 261
 262 char *getUserGraphicsDir(void);
 263 char *getUserSoundsDir(void);
 264 char *getUserMusicDir(void);
 265 char *setLevelArtworkDir(TreeInfo *);
 266 char *getProgramMainDataPath(char *, char *);
 267 char *getProgramConfigFilename(char *);
 268 char *getTapeFilename(int);
 269 char *getTemporaryTapeFilename(void);
 270 char *getDefaultSolutionTapeFilename(int);
 271 char *getSokobanSolutionTapeFilename(int);
 272 char *getSolutionTapeFilename(int);
 273 char *getScoreFilename(int);
 274 char *getScoreCacheFilename(int);
 275 char *getScoreTapeBasename(char *);
 276 char *getScoreTapeFilename(char *, int);
 277 char *getScoreCacheTapeFilename(char *, int);
 278 char *getSetupFilename(void);
 279 char *getDefaultSetupFilename(void);
 280 char *getPlatformSetupFilename(void);
 281 char *getEditorSetupFilename(void);
 282 char *getHelpAnimFilename(void);
 283 char *getHelpTextFilename(void);
 284 char *getLevelSetInfoFilename(int);
 285 char *getLevelSetTitleMessageFilename(int, boolean);
 286 char *getCreditsFilename(int, boolean);
 287 char *getProgramInfoFilename(int);
 288 char *getImageFilename(char *);
 289 char *getCustomImageFilename(char *);
 290 char *getCustomSoundFilename(char *);
 291 char *getCustomMusicFilename(char *);
 292 char *getCustomArtworkFilename(char *, int);
 293 char *getCustomArtworkConfigFilename(int);
 294 char *getCustomArtworkLevelConfigFilename(int);
 295 char *getCustomMusicDirectory(void);
 296 char *getCustomMusicDirectory_NoConf(void);
 297
 298 void MarkTapeDirectoryUploadsAsComplete(char *);
 299 void MarkTapeDirectoryUploadsAsIncomplete(char *);
 300 boolean CheckTapeDirectoryUploadsComplete(char *);
 301
 302 void InitMissingFileHash(void);
 303 void InitTapeDirectory(char *);
 304 void InitScoreDirectory(char *);
 305 void InitScoreCacheDirectory(char *);
 306 void InitScoreTapeDirectory(char *, int);
 307 void InitScoreCacheTapeDirectory(char *, int);
 308 void InitUserLevelDirectory(char *);
 309 void InitNetworkLevelDirectory(char *);
 310 void InitLevelSetupDirectory(char *);
 311
 312 TreeInfo *newTreeInfo(void);
 313 TreeInfo *newTreeInfo_setDefaults(int);
 314 void pushTreeInfo(TreeInfo **, TreeInfo *);
 315 void removeTreeInfo(TreeInfo **);
 316 int numTreeInfo(TreeInfo *);
 317 boolean validLevelSeries(TreeInfo *);
 318 TreeInfo *getValidLevelSeries(TreeInfo *, TreeInfo *);
 319 TreeInfo *getFirstValidTreeInfoEntry(TreeInfo *);
 320 TreeInfo *getNextValidTreeInfoEntry(TreeInfo *);
 321 TreeInfo *getTreeInfoFirstGroupEntry(TreeInfo *);
 322 int numTreeInfoInGroup(TreeInfo *);
 323 int getPosFromTreeInfo(TreeInfo *);
 324 TreeInfo *getTreeInfoFromPos(TreeInfo *, int);
 325 TreeInfo *getTreeInfoFromIdentifier(TreeInfo *, char *);
 326 int dumpTreeInfo(TreeInfo *, int);
 327 void sortTreeInfoBySortFunction(TreeInfo **,
 328                                 int (*compare_function)(const void *,
 329                                                         const void *));
 330 void sortTreeInfo(TreeInfo **);
 331 void freeTreeInfo(TreeInfo *);
 332 TreeInfo *addTopTreeInfoNode(TreeInfo *);
 333
 334 char *getHomeDir(void);
 335 char *getPersonalDataDir(void);
 336 char *getMainUserGameDataDir(void);
 337 char *getUserGameDataDir(void);
 338 char *getSetupDir(void);
 339 char *getLevelDirFromTreeInfo(TreeInfo *);
 340 char *getUserLevelDir(char *);
 341 char *getNetworkLevelDir(char *);
 342 char *getCurrentLevelDir(void);
 343 char *getNewUserLevelSubdir(void);
 344 char *getTapeDir(char *);
 345
 346 void createDirectory(char *, char *);
 347 void InitMainUserDataDirectory(void);
 348 void InitUserDataDirectory(void);
 349 void SetFilePermissions(char *, int);
 350
 351 void fprintFileHeader(FILE *, char *);
 352 int getFileVersionFromCookieString(const char *);
 353 boolean checkCookieString(const char *, const char *);
 354
 355 char *getFormattedSetupEntry(char *, char *);
 356
 357 boolean getTokenValueFromSetupLine(char *, char **, char **);
 358
 359 SetupFileList *newSetupFileList(char *, char *);
 360 void freeSetupFileList(SetupFileList *);
 361 char *getListEntry(SetupFileList *, char *);
 362 SetupFileList *setListEntry(SetupFileList *, char *, char *);
 363 SetupFileList *addListEntry(SetupFileList *, char *, char *);
 364 SetupFileList *loadSetupFileList(char *);
 365
 366 SetupFileHash *newSetupFileHash(void);
 367 void freeSetupFileHash(SetupFileHash *);
 368 char *getHashEntry(SetupFileHash *, char *);
 369 void setHashEntry(SetupFileHash *, char *, char *);
 370 void removeHashEntry(SetupFileHash *, char *);
 371 SetupFileHash *loadSetupFileHash(char *);
 372 void setSetupInfo(struct TokenInfo *, int, char *);
 373 char *getSetupValue(int, void *);
 374 char *getSetupLine(struct TokenInfo *, char *, int);
 375
 376 unsigned int get_hash_from_string(void *);
 377 unsigned int get_hash_from_integer(void *);
 378 int hash_key_strings_are_equal(void *, void *);
 379 int hash_key_integers_are_equal(void *, void *);
 380
 381 int GetZipFileTreeType(char *);
 382 char *ExtractZipFileIntoDirectory(char *, char *, int);
 383
 384 boolean AdjustGraphicsForEMC(void);
 385 boolean AdjustSoundsForEMC(void);
 386
 387 void SetCurrentArtwork(int);
 388 void ChangeCurrentArtworkIfNeeded(int);
 389
 390 void LoadLevelInfo(void);
 391 void LoadArtworkInfo(void);
 392 void LoadLevelArtworkInfo(void);
 393
 394 char *getArtworkIdentifierForUserLevelSet(int);
 395 TreeInfo *getArtworkTreeInfoForUserLevelSet(int);
 396 boolean checkIfCustomArtworkExistsForCurrentLevelSet(void);
 397 void AddUserLevelSetToLevelInfo(char *);
 398 void AddTreeSetToTreeInfo(TreeInfo *, char *, char *, int);
 399 boolean UpdateUserLevelSet(char *, char *, char *, int);
 400 boolean CreateUserLevelSet(char *, char *, char *, int, boolean);
 401
 402 void UpdateLastPlayedLevels_TreeInfo(void);
 403 void StoreLastPlayedLevels(TreeInfo *);
 404 void ForcedStoreLastPlayedLevels(TreeInfo *);
 405 void RestoreLastPlayedLevels(TreeInfo **);
 406 boolean CheckLastPlayedLevels(void);
 407
 408 void LoadLevelSetup_LastSeries(void);
 409 void SaveLevelSetup_LastSeries(void);
 410 void SaveLevelSetup_LastSeries_Deactivate(void);
 411 void LoadLevelSetup_SeriesInfo(void);
 412 void SaveLevelSetup_SeriesInfo(void);
 413
 414 int LevelStats_getPlayed(int);
 415 int LevelStats_getSolved(int);
 416 void LevelStats_setPlayed(int, int);
 417 void LevelStats_setSolved(int, int);
 418 void LevelStats_incPlayed(int);
 419 void LevelStats_incSolved(int);
 420
 421 void LoadUserSetup(void);
 422 void SaveUserSetup(void);
 423
 424 #endif // MISC_H