src/libgame/setup.h

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