src/libgame/system.h

   1 /***********************************************************
   2 * Artsoft Retro-Game Library                               *
   3 *----------------------------------------------------------*
   4 * (c) 1994-2001 Artsoft Entertainment                      *
   5 *               Holger Schemel                             *
   6 *               Detmolder Strasse 189                      *
   7 *               33604 Bielefeld                            *
   8 *               Germany                                    *
   9 *               e-mail: info@artsoft.org                   *
  10 *----------------------------------------------------------*
  11 * system.h                                                 *
  12 ***********************************************************/
  13
  14 #ifndef SYSTEM_H
  15 #define SYSTEM_H
  16
  17 #include "platform.h"
  18 #include "types.h"
  19
  20 #if defined(PLATFORM_MSDOS)
  21 #include "msdos.h"
  22 #endif
  23
  24 #if defined(TARGET_SDL)
  25 #include "sdl.h"
  26 #elif defined(TARGET_X11)
  27 #include "x11.h"
  28 #endif
  29
  30
  31 /* contant definitions */
  32
  33 /* the additional 'b' is needed for Win32 to open files in binary mode */
  34 #define MODE_READ               "rb"
  35 #define MODE_WRITE              "wb"
  36 #define MODE_APPEND             "ab"
  37
  38 #define DEFAULT_DEPTH           0
  39
  40 #define FULLSCREEN_NOT_AVAILABLE FALSE
  41 #define FULLSCREEN_AVAILABLE     TRUE
  42
  43 /* values for button_status */
  44 #define MB_NOT_PRESSED          FALSE
  45 #define MB_NOT_RELEASED         TRUE
  46 #define MB_RELEASED             FALSE
  47 #define MB_PRESSED              TRUE
  48 #define MB_MENU_CHOICE          FALSE
  49 #define MB_MENU_MARK            TRUE
  50 #define MB_MENU_INITIALIZE      (-1)
  51 #define MB_LEFTBUTTON           1
  52 #define MB_MIDDLEBUTTON         2
  53 #define MB_RIGHTBUTTON          3
  54
  55 /* values for redraw_mask */
  56 #define REDRAW_NONE             (0)
  57 #define REDRAW_ALL              (1 << 0)
  58 #define REDRAW_FIELD            (1 << 1)
  59 #define REDRAW_TILES            (1 << 2)
  60 #define REDRAW_DOOR_1           (1 << 3)
  61 #define REDRAW_VIDEO_1          (1 << 4)
  62 #define REDRAW_VIDEO_2          (1 << 5)
  63 #define REDRAW_VIDEO_3          (1 << 6)
  64 #define REDRAW_MICROLEVEL       (1 << 7)
  65 #define REDRAW_MICROLABEL       (1 << 8)
  66 #define REDRAW_FROM_BACKBUFFER  (1 << 9)
  67 #define REDRAW_DOOR_2           (REDRAW_VIDEO_1 | \
  68                                  REDRAW_VIDEO_2 | \
  69                                  REDRAW_VIDEO_3)
  70 #define REDRAW_DOOR_3           (1 << 10)
  71 #define REDRAW_DOORS            (REDRAW_DOOR_1 | \
  72                                  REDRAW_DOOR_2 | \
  73                                  REDRAW_DOOR_3)
  74 #define REDRAW_MAIN             (REDRAW_FIELD | \
  75                                  REDRAW_TILES | \
  76                                  REDRAW_MICROLEVEL)
  77 #define REDRAW_FPS              (1 << 11)
  78 #define REDRAWTILES_THRESHOLD   (SCR_FIELDX * SCR_FIELDY / 2)
  79
  80
  81 /* default name for empty highscore entry */
  82 #define EMPTY_PLAYER_NAME       "no name"
  83
  84 /* default name for unknown player names */
  85 #define ANONYMOUS_NAME          "anonymous"
  86
  87 /* default name for new levels */
  88 #define NAMELESS_LEVEL_NAME     "nameless level"
  89
  90 /* definitions for game sub-directories */
  91 #ifndef RO_GAME_DIR
  92 #define RO_GAME_DIR             "."
  93 #endif
  94
  95 #ifndef RW_GAME_DIR
  96 #define RW_GAME_DIR             "."
  97 #endif
  98
  99 #define RO_BASE_PATH            RO_GAME_DIR
 100 #define RW_BASE_PATH            RW_GAME_DIR
 101
 102 #define GRAPHICS_DIRECTORY      "graphics"
 103 #define MUSIC_DIRECTORY         "music"
 104 #define SOUNDS_DIRECTORY        "sounds"
 105 #define LEVELS_DIRECTORY        "levels"
 106 #define TAPES_DIRECTORY         "tapes"
 107 #define SCORES_DIRECTORY        "scores"
 108
 109 /* areas in bitmap PIX_DOOR */
 110 /* meaning in PIX_DB_DOOR: (3 PAGEs)
 111    PAGEX1: 1. buffer for DOOR_1
 112    PAGEX2: 2. buffer for DOOR_1
 113    PAGEX3: buffer for animations
 114 */
 115
 116 #define DOOR_GFX_PAGESIZE       (gfx.dxsize)
 117 #define DOOR_GFX_PAGEX1         (0 * DOOR_GFX_PAGESIZE)
 118 #define DOOR_GFX_PAGEX2         (1 * DOOR_GFX_PAGESIZE)
 119 #define DOOR_GFX_PAGEX3         (2 * DOOR_GFX_PAGESIZE)
 120 #define DOOR_GFX_PAGEX4         (3 * DOOR_GFX_PAGESIZE)
 121 #define DOOR_GFX_PAGEX5         (4 * DOOR_GFX_PAGESIZE)
 122 #define DOOR_GFX_PAGEX6         (5 * DOOR_GFX_PAGESIZE)
 123 #define DOOR_GFX_PAGEX7         (6 * DOOR_GFX_PAGESIZE)
 124 #define DOOR_GFX_PAGEX8         (7 * DOOR_GFX_PAGESIZE)
 125 #define DOOR_GFX_PAGEY1         (0)
 126 #define DOOR_GFX_PAGEY2         (gfx.dysize)
 127
 128
 129 /* type definitions */
 130
 131 typedef int (*EventFilter)(const Event *);
 132
 133
 134 /* structure definitions */
 135
 136 struct ProgramInfo
 137 {
 138   char *command_basename;
 139   char *userdata_directory;
 140
 141   char *program_title;
 142   char *window_title;
 143   char *icon_title;
 144   char *x11_icon_filename;
 145   char *x11_iconmask_filename;
 146   char *msdos_pointer_filename;
 147
 148   void (*exit_function)(int);
 149 };
 150
 151 struct OptionInfo
 152 {
 153   char *display_name;
 154   char *server_host;
 155   int server_port;
 156   char *ro_base_directory;
 157   char *rw_base_directory;
 158   char *level_directory;
 159   char *graphics_directory;
 160   boolean serveronly;
 161   boolean network;
 162   boolean verbose;
 163   boolean debug;
 164 };
 165
 166 struct VideoSystemInfo
 167 {
 168   int default_depth;
 169   int width, height, depth;
 170   boolean fullscreen_available;
 171   boolean fullscreen_enabled;
 172 };
 173
 174 struct AudioSystemInfo
 175 {
 176   boolean sound_available;
 177   boolean music_available;
 178   boolean loops_available;
 179   boolean mods_available;
 180   boolean sound_enabled;
 181
 182   int soundserver_pipe[2];
 183   int soundserver_pid;
 184   char *device_name;
 185   int device_fd;
 186
 187   int channels;
 188   int music_channel;
 189   int music_nr;
 190 };
 191
 192 struct GfxInfo
 193 {
 194   int sx, sy;
 195   int sxsize, sysize;
 196   int real_sx, real_sy;
 197   int full_sxsize, full_sysize;
 198   int scrollbuffer_width, scrollbuffer_height;
 199
 200   int dx, dy;
 201   int dxsize, dysize;
 202
 203   int vx, vy;
 204   int vxsize, vysize;
 205 };
 206
 207 struct LevelDirInfo
 208 {
 209   char *filename;       /* level series single directory name */
 210   char *fullpath;       /* complete path relative to level directory */
 211   char *basepath;       /* absolute base path of level directory */
 212   char *name;           /* level series name, as displayed on main screen */
 213   char *name_short;     /* optional short name for level selection screen */
 214   char *name_sorting;   /* optional sorting name for correct level sorting */
 215   char *author;         /* level series author name levels without author */
 216   char *imported_from;  /* optional comment for imported level series */
 217   int levels;           /* number of levels in level series */
 218   int first_level;      /* first level number (to allow start with 0 or 1) */
 219   int last_level;       /* last level number (automatically calculated) */
 220   int sort_priority;    /* sort levels by 'sort_priority' and then by name */
 221   boolean level_group;  /* directory contains more level series directories */
 222   boolean parent_link;  /* entry links back to parent directory */
 223   boolean user_defined; /* user defined levels are stored in home directory */
 224   boolean readonly;     /* readonly levels can not be changed with editor */
 225   int color;            /* color to use on selection screen for this level */
 226   char *class_desc;     /* description of level series class */
 227   int handicap_level;   /* number of the lowest unsolved level */
 228   int cl_first;         /* internal control field for "choose level" screen */
 229   int cl_cursor;        /* internal control field for "choose level" screen */
 230
 231   struct LevelDirInfo *node_parent;     /* parent level directory info */
 232   struct LevelDirInfo *node_group;      /* level group sub-directory info */
 233   struct LevelDirInfo *next;            /* next level series structure node */
 234 };
 235
 236
 237 /* ========================================================================= */
 238 /* exported variables                                                        */
 239 /* ========================================================================= */
 240
 241 extern struct ProgramInfo       program;
 242 extern struct OptionInfo        options;
 243 extern struct VideoSystemInfo   video;
 244 extern struct AudioSystemInfo   audio;
 245 extern struct GfxInfo           gfx;
 246
 247 extern struct LevelDirInfo     *leveldir_first;
 248 extern struct LevelDirInfo     *leveldir_current;
 249
 250 extern Display         *display;
 251 extern Visual          *visual;
 252 extern int              screen;
 253 extern Colormap         cmap;
 254
 255 extern DrawWindow      *window;
 256 extern DrawBuffer      *backbuffer;
 257 extern DrawBuffer      *drawto;
 258
 259 extern int              button_status;
 260 extern boolean          motion_status;
 261
 262 extern int              redraw_mask;
 263 extern int              redraw_tiles;
 264
 265 extern int              FrameCounter;
 266
 267
 268 /* function definitions */
 269
 270 void InitCommandName(char *);
 271 void InitExitFunction(void (*exit_function)(int));
 272 void InitPlatformDependantStuff(void);
 273 void ClosePlatformDependantStuff(void);
 274
 275 void InitProgramInfo(char *, char *, char *, char *, char *, char *, char *);
 276
 277 void InitGfxFieldInfo(int, int, int, int, int, int, int, int);
 278 void InitGfxDoor1Info(int, int, int, int);
 279 void InitGfxDoor2Info(int, int, int, int);
 280 void InitGfxScrollbufferInfo(int, int);
 281
 282 inline void InitVideoDisplay(void);
 283 inline void CloseVideoDisplay(void);
 284 inline void InitVideoBuffer(DrawBuffer **,DrawWindow **, int,int,int, boolean);
 285 inline Bitmap *CreateBitmapStruct(void);
 286 inline Bitmap *CreateBitmap(int, int, int);
 287 inline void FreeBitmap(Bitmap *);
 288 inline void BlitBitmap(Bitmap *, Bitmap *, int, int, int, int, int, int);
 289 inline void ClearRectangle(Bitmap *, int, int, int, int);
 290 inline void SetClipMask(Bitmap *, GC, Pixmap);
 291 inline void SetClipOrigin(Bitmap *, GC, int, int);
 292 inline void BlitBitmapMasked(Bitmap *, Bitmap *, int, int, int, int, int, int);
 293 inline void DrawSimpleWhiteLine(Bitmap *, int, int, int, int);
 294 inline void DrawLines(Bitmap *, struct XY *, int, Pixel);
 295 inline Pixel GetPixel(Bitmap *, int, int);
 296 inline Pixel GetPixelFromRGB(Bitmap *, unsigned int,unsigned int,unsigned int);
 297 inline Pixel GetPixelFromRGBcompact(Bitmap *, unsigned int);
 298
 299 inline void FlushDisplay(void);
 300 inline void SyncDisplay(void);
 301 inline void KeyboardAutoRepeatOn(void);
 302 inline void KeyboardAutoRepeatOff(void);
 303 inline boolean PointerInWindow(DrawWindow *);
 304 inline boolean SetVideoMode(boolean);
 305 inline boolean ChangeVideoModeIfNeeded(boolean);
 306
 307 Bitmap *LoadImage(char *);
 308
 309 inline void OpenAudio(void);
 310 inline void CloseAudio(void);
 311 inline void SetAudioMode(boolean);
 312
 313 inline void InitEventFilter(EventFilter);
 314 inline boolean PendingEvent(void);
 315 inline void NextEvent(Event *event);
 316 inline Key GetEventKey(KeyEvent *, boolean);
 317 inline boolean CheckCloseWindowEvent(ClientMessageEvent *);
 318
 319 #endif /* SYSTEM_H */