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
  51 #define TYPE_ENTER_OR_LEAVE_MENU        (TYPE_ENTER_MENU | \
  52                                          TYPE_LEAVE_MENU)
  53
  54 /* cookie token for file identifier and version number */
  55 #define TOKEN_STR_FILE_IDENTIFIER       "file_identifier"
  56
  57 /* structures for setup file handling */
  58 struct SetupFileList
  59 {
  60   char *token;
  61   char *value;
  62   struct SetupFileList *next;
  63 };
  64
  65 struct TokenInfo
  66 {
  67   int type;
  68   void *value;
  69   char *text;
  70 };
  71
  72 /* sort priorities of level series (also used as level series classes) */
  73 #define LEVELCLASS_TUTORIAL_START       10
  74 #define LEVELCLASS_TUTORIAL_END         99
  75 #define LEVELCLASS_CLASSICS_START       100
  76 #define LEVELCLASS_CLASSICS_END         199
  77 #define LEVELCLASS_CONTRIBUTION_START   200
  78 #define LEVELCLASS_CONTRIBUTION_END     299
  79 #define LEVELCLASS_USER_START           300
  80 #define LEVELCLASS_USER_END             399
  81 #define LEVELCLASS_BD_START             400
  82 #define LEVELCLASS_BD_END               499
  83 #define LEVELCLASS_EM_START             500
  84 #define LEVELCLASS_EM_END               599
  85 #define LEVELCLASS_SP_START             600
  86 #define LEVELCLASS_SP_END               699
  87 #define LEVELCLASS_DX_START             700
  88 #define LEVELCLASS_DX_END               799
  89
  90 #define LEVELCLASS_TUTORIAL             LEVELCLASS_TUTORIAL_START
  91 #define LEVELCLASS_CLASSICS             LEVELCLASS_CLASSICS_START
  92 #define LEVELCLASS_CONTRIBUTION         LEVELCLASS_CONTRIBUTION_START
  93 #define LEVELCLASS_USER                 LEVELCLASS_USER_START
  94 #define LEVELCLASS_BD                   LEVELCLASS_BD_START
  95 #define LEVELCLASS_EM                   LEVELCLASS_EM_START
  96 #define LEVELCLASS_SP                   LEVELCLASS_SP_START
  97 #define LEVELCLASS_DX                   LEVELCLASS_DX_START
  98
  99 #define LEVELCLASS_UNDEFINED            999
 100
 101 #define IS_LEVELCLASS_TUTORIAL(p) \
 102         ((p)->sort_priority >= LEVELCLASS_TUTORIAL_START && \
 103          (p)->sort_priority <= LEVELCLASS_TUTORIAL_END)
 104 #define IS_LEVELCLASS_CLASSICS(p) \
 105         ((p)->sort_priority >= LEVELCLASS_CLASSICS_START && \
 106          (p)->sort_priority <= LEVELCLASS_CLASSICS_END)
 107 #define IS_LEVELCLASS_CONTRIBUTION(p) \
 108         ((p)->sort_priority >= LEVELCLASS_CONTRIBUTION_START && \
 109          (p)->sort_priority <= LEVELCLASS_CONTRIBUTION_END)
 110 #define IS_LEVELCLASS_USER(p) \
 111         ((p)->sort_priority >= LEVELCLASS_USER_START && \
 112          (p)->sort_priority <= LEVELCLASS_USER_END)
 113 #define IS_LEVELCLASS_BD(p) \
 114         ((p)->sort_priority >= LEVELCLASS_BD_START && \
 115          (p)->sort_priority <= LEVELCLASS_BD_END)
 116 #define IS_LEVELCLASS_EM(p) \
 117         ((p)->sort_priority >= LEVELCLASS_EM_START && \
 118          (p)->sort_priority <= LEVELCLASS_EM_END)
 119 #define IS_LEVELCLASS_SP(p) \
 120         ((p)->sort_priority >= LEVELCLASS_SP_START && \
 121          (p)->sort_priority <= LEVELCLASS_SP_END)
 122 #define IS_LEVELCLASS_DX(p) \
 123         ((p)->sort_priority >= LEVELCLASS_DX_START && \
 124          (p)->sort_priority <= LEVELCLASS_DX_END)
 125
 126 #define LEVELCLASS(n)   (IS_LEVELCLASS_TUTORIAL(n) ? LEVELCLASS_TUTORIAL : \
 127                          IS_LEVELCLASS_CLASSICS(n) ? LEVELCLASS_CLASSICS : \
 128                          IS_LEVELCLASS_CONTRIBUTION(n) ? LEVELCLASS_CONTRIBUTION : \
 129                          IS_LEVELCLASS_USER(n) ? LEVELCLASS_USER : \
 130                          IS_LEVELCLASS_BD(n) ? LEVELCLASS_BD : \
 131                          IS_LEVELCLASS_EM(n) ? LEVELCLASS_EM : \
 132                          IS_LEVELCLASS_SP(n) ? LEVELCLASS_SP : \
 133                          IS_LEVELCLASS_DX(n) ? LEVELCLASS_DX : \
 134                          LEVELCLASS_UNDEFINED)
 135
 136
 137 char *getLevelFilename(int);
 138 char *getTapeFilename(int);
 139 char *getScoreFilename(int);
 140 char *getSetupFilename(void);
 141 char *getImageFilename(char *);
 142 char *getCustomImageFilename(char *);
 143
 144 void InitTapeDirectory(char *);
 145 void InitScoreDirectory(char *);
 146 void InitUserLevelDirectory(char *);
 147 void InitLevelSetupDirectory(char *);
 148
 149 void ReadChunk_VERS(FILE *, int *, int *);
 150 void WriteChunk_VERS(FILE *, int, int);
 151
 152 TreeInfo *newTreeInfo();
 153 void pushTreeInfo(TreeInfo **, TreeInfo *);
 154 int numTreeInfo(TreeInfo *);
 155 boolean validLevelSeries(TreeInfo *);
 156 TreeInfo *getFirstValidLevelSeries(TreeInfo *);
 157 TreeInfo *getTreeInfoFirstGroupEntry(TreeInfo *);
 158 int numTreeInfoInGroup(TreeInfo *);
 159 int posTreeInfo(TreeInfo *);
 160 TreeInfo *getTreeInfoFromPos(TreeInfo *, int);
 161 TreeInfo *getTreeInfoFromFilename(char *);
 162 void dumpTreeInfo(TreeInfo *, int);
 163 void sortTreeInfo(TreeInfo **,
 164                   int (*compare_function)(const void *, const void *));
 165
 166 char *getUserDataDir(void);
 167 char *getSetupDir(void);
 168 void createDirectory(char *, char *, int);
 169 void InitUserDataDirectory(void);
 170 void SetFilePermissions(char *, int);
 171
 172 char *getCookie(char *);
 173 int getFileVersionFromCookieString(const char *);
 174 boolean checkCookieString(const char *, const char *);
 175
 176 char *getFormattedSetupEntry(char *, char *);
 177 void freeSetupFileList(struct SetupFileList *);
 178 char *getTokenValue(struct SetupFileList *, char *);
 179 struct SetupFileList *loadSetupFileList(char *);
 180 void checkSetupFileListIdentifier(struct SetupFileList *, char *);
 181 void setSetupInfo(struct TokenInfo *, int, char *);
 182 char *getSetupValue(int, void *);
 183 char *getSetupLine(struct TokenInfo *, char *, int);
 184
 185 void LoadLevelInfo(void);
 186 void LoadArtworkInfo(void);
 187 void LoadLevelSetup_LastSeries(void);
 188 void SaveLevelSetup_LastSeries(void);
 189 void LoadLevelSetup_SeriesInfo(void);
 190 void SaveLevelSetup_SeriesInfo(void);
 191
 192 #endif /* MISC_H */