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