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 /* sort priorities of level series (also used as level series classes) */
  21 #define LEVELCLASS_TUTORIAL_START       10
  22 #define LEVELCLASS_TUTORIAL_END         99
  23 #define LEVELCLASS_CLASSICS_START       100
  24 #define LEVELCLASS_CLASSICS_END         199
  25 #define LEVELCLASS_CONTRIBUTION_START   200
  26 #define LEVELCLASS_CONTRIBUTION_END     299
  27 #define LEVELCLASS_USER_START           300
  28 #define LEVELCLASS_USER_END             399
  29 #define LEVELCLASS_BD_START             400
  30 #define LEVELCLASS_BD_END               499
  31 #define LEVELCLASS_EM_START             500
  32 #define LEVELCLASS_EM_END               599
  33 #define LEVELCLASS_SP_START             600
  34 #define LEVELCLASS_SP_END               699
  35 #define LEVELCLASS_DX_START             700
  36 #define LEVELCLASS_DX_END               799
  37
  38 #define LEVELCLASS_TUTORIAL             LEVELCLASS_TUTORIAL_START
  39 #define LEVELCLASS_CLASSICS             LEVELCLASS_CLASSICS_START
  40 #define LEVELCLASS_CONTRIBUTION         LEVELCLASS_CONTRIBUTION_START
  41 #define LEVELCLASS_USER                 LEVELCLASS_USER_START
  42 #define LEVELCLASS_BD                   LEVELCLASS_BD_START
  43 #define LEVELCLASS_EM                   LEVELCLASS_EM_START
  44 #define LEVELCLASS_SP                   LEVELCLASS_SP_START
  45 #define LEVELCLASS_DX                   LEVELCLASS_DX_START
  46
  47 #define LEVELCLASS_UNDEFINED            999
  48
  49 #define IS_LEVELCLASS_TUTORIAL(p) \
  50         ((p)->sort_priority >= LEVELCLASS_TUTORIAL_START && \
  51          (p)->sort_priority <= LEVELCLASS_TUTORIAL_END)
  52 #define IS_LEVELCLASS_CLASSICS(p) \
  53         ((p)->sort_priority >= LEVELCLASS_CLASSICS_START && \
  54          (p)->sort_priority <= LEVELCLASS_CLASSICS_END)
  55 #define IS_LEVELCLASS_CONTRIBUTION(p) \
  56         ((p)->sort_priority >= LEVELCLASS_CONTRIBUTION_START && \
  57          (p)->sort_priority <= LEVELCLASS_CONTRIBUTION_END)
  58 #define IS_LEVELCLASS_USER(p) \
  59         ((p)->sort_priority >= LEVELCLASS_USER_START && \
  60          (p)->sort_priority <= LEVELCLASS_USER_END)
  61 #define IS_LEVELCLASS_BD(p) \
  62         ((p)->sort_priority >= LEVELCLASS_BD_START && \
  63          (p)->sort_priority <= LEVELCLASS_BD_END)
  64 #define IS_LEVELCLASS_EM(p) \
  65         ((p)->sort_priority >= LEVELCLASS_EM_START && \
  66          (p)->sort_priority <= LEVELCLASS_EM_END)
  67 #define IS_LEVELCLASS_SP(p) \
  68         ((p)->sort_priority >= LEVELCLASS_SP_START && \
  69          (p)->sort_priority <= LEVELCLASS_SP_END)
  70 #define IS_LEVELCLASS_DX(p) \
  71         ((p)->sort_priority >= LEVELCLASS_DX_START && \
  72          (p)->sort_priority <= LEVELCLASS_DX_END)
  73
  74 #define LEVELCLASS(n)   (IS_LEVELCLASS_TUTORIAL(n) ? LEVELCLASS_TUTORIAL : \
  75                          IS_LEVELCLASS_CLASSICS(n) ? LEVELCLASS_CLASSICS : \
  76                          IS_LEVELCLASS_CONTRIBUTION(n) ? LEVELCLASS_CONTRIBUTION : \
  77                          IS_LEVELCLASS_USER(n) ? LEVELCLASS_USER : \
  78                          IS_LEVELCLASS_BD(n) ? LEVELCLASS_BD : \
  79                          IS_LEVELCLASS_EM(n) ? LEVELCLASS_EM : \
  80                          IS_LEVELCLASS_SP(n) ? LEVELCLASS_SP : \
  81                          IS_LEVELCLASS_DX(n) ? LEVELCLASS_DX : \
  82                          LEVELCLASS_UNDEFINED)
  83
  84
  85 char *getLevelFilename(int);
  86 char *getTapeFilename(int);
  87 char *getScoreFilename(int);
  88 void InitTapeDirectory(char *);
  89 void InitScoreDirectory(char *);
  90 void InitUserLevelDirectory(char *);
  91 void InitLevelSetupDirectory(char *);
  92
  93 void ReadChunk_VERS(FILE *, int *, int *);
  94 void WriteChunk_VERS(FILE *, int, int);
  95
  96 struct LevelDirInfo *newLevelDirInfo();
  97 void pushLevelDirInfo(struct LevelDirInfo **, struct LevelDirInfo *);
  98 int numLevelDirInfo(struct LevelDirInfo *);
  99 boolean validLevelSeries(struct LevelDirInfo *);
 100 struct LevelDirInfo *getFirstValidLevelSeries(struct LevelDirInfo *);
 101 struct LevelDirInfo *getLevelDirInfoFirstGroupEntry(struct LevelDirInfo *);
 102 int numLevelDirInfoInGroup(struct LevelDirInfo *);
 103 int posLevelDirInfo(struct LevelDirInfo *);
 104 struct LevelDirInfo *getLevelDirInfoFromPos(struct LevelDirInfo *, int);
 105 struct LevelDirInfo *getLevelDirInfoFromFilename(char *);
 106 void dumpLevelDirInfo(struct LevelDirInfo *, int);
 107 void sortLevelDirInfo(struct LevelDirInfo **,
 108                       int (*compare_function)(const void *, const void *));
 109
 110 char *getUserDataDir(void);
 111 char *getSetupDir(void);
 112 void createDirectory(char *, char *, int);
 113 void InitUserDataDirectory(void);
 114 void SetFilePermissions(char *, int);
 115 int getFileVersionFromCookieString(const char *);
 116 boolean checkCookieString(const char *, const char *);
 117
 118 void LoadLevelInfo(void);
 119 void LoadSetup(void);
 120 void SaveSetup(void);
 121 void LoadLevelSetup_LastSeries(void);
 122 void SaveLevelSetup_LastSeries(void);
 123 void LoadLevelSetup_SeriesInfo(void);
 124 void SaveLevelSetup_SeriesInfo(void);
 125
 126 #endif /* MISC_H */