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