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