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 /* the additional 'b' is needed for Win32 to open files in binary mode */
  32 #define MODE_READ               "rb"
  33 #define MODE_WRITE              "wb"
  34 #define MODE_APPEND             "ab"
  35
  36 #define DEFAULT_DEPTH           0
  37
  38 #define FULLSCREEN_NOT_AVAILABLE FALSE
  39 #define FULLSCREEN_AVAILABLE     TRUE
  40
  41 /* default input keys */
  42 #define DEFAULT_KEY_LEFT        KSYM_Left
  43 #define DEFAULT_KEY_RIGHT       KSYM_Right
  44 #define DEFAULT_KEY_UP          KSYM_Up
  45 #define DEFAULT_KEY_DOWN        KSYM_Down
  46 #define DEFAULT_KEY_SNAP        KSYM_Shift_L
  47 #define DEFAULT_KEY_BOMB        KSYM_Shift_R
  48 #define DEFAULT_KEY_OKAY        KSYM_Return
  49 #define DEFAULT_KEY_CANCEL      KSYM_Escape
  50
  51 /* values for move directions */
  52 #define MV_NO_MOVING            0
  53 #define MV_LEFT                 (1 << 0)
  54 #define MV_RIGHT                (1 << 1)
  55 #define MV_UP                   (1 << 2)
  56 #define MV_DOWN                 (1 << 3)
  57
  58 /* values for button status */
  59 #define MB_NOT_PRESSED          FALSE
  60 #define MB_NOT_RELEASED         TRUE
  61 #define MB_RELEASED             FALSE
  62 #define MB_PRESSED              TRUE
  63 #define MB_MENU_CHOICE          FALSE
  64 #define MB_MENU_MARK            TRUE
  65 #define MB_MENU_INITIALIZE      (-1)
  66 #define MB_LEFTBUTTON           1
  67 #define MB_MIDDLEBUTTON         2
  68 #define MB_RIGHTBUTTON          3
  69
  70 /* values for redraw_mask */
  71 #define REDRAW_NONE             (0)
  72 #define REDRAW_ALL              (1 << 0)
  73 #define REDRAW_FIELD            (1 << 1)
  74 #define REDRAW_TILES            (1 << 2)
  75 #define REDRAW_DOOR_1           (1 << 3)
  76 #define REDRAW_VIDEO_1          (1 << 4)
  77 #define REDRAW_VIDEO_2          (1 << 5)
  78 #define REDRAW_VIDEO_3          (1 << 6)
  79 #define REDRAW_MICROLEVEL       (1 << 7)
  80 #define REDRAW_MICROLABEL       (1 << 8)
  81 #define REDRAW_FROM_BACKBUFFER  (1 << 9)
  82 #define REDRAW_DOOR_2           (REDRAW_VIDEO_1 | \
  83                                  REDRAW_VIDEO_2 | \
  84                                  REDRAW_VIDEO_3)
  85 #define REDRAW_DOOR_3           (1 << 10)
  86 #define REDRAW_DOORS            (REDRAW_DOOR_1 | \
  87                                  REDRAW_DOOR_2 | \
  88                                  REDRAW_DOOR_3)
  89 #define REDRAW_MAIN             (REDRAW_FIELD | \
  90                                  REDRAW_TILES | \
  91                                  REDRAW_MICROLEVEL)
  92 #define REDRAW_FPS              (1 << 11)
  93 #define REDRAWTILES_THRESHOLD   (SCR_FIELDX * SCR_FIELDY / 2)
  94
  95 /* maximum number of parallel players supported by libgame functions */
  96 #define MAX_PLAYERS             4
  97
  98 /* maximum allowed length of player name */
  99 #define MAX_PLAYER_NAME_LEN     10
 100
 101 /* default name for empty highscore entry */
 102 #define EMPTY_PLAYER_NAME       "no name"
 103
 104 /* default name for unknown player names */
 105 #define ANONYMOUS_NAME          "anonymous"
 106
 107 /* default name for new levels */
 108 #define NAMELESS_LEVEL_NAME     "nameless level"
 109
 110 /* definitions for game sub-directories */
 111 #ifndef RO_GAME_DIR
 112 #define RO_GAME_DIR             "."
 113 #endif
 114
 115 #ifndef RW_GAME_DIR
 116 #define RW_GAME_DIR             "."
 117 #endif
 118
 119 #define RO_BASE_PATH            RO_GAME_DIR
 120 #define RW_BASE_PATH            RW_GAME_DIR
 121
 122 #define GRAPHICS_DIRECTORY      "graphics"
 123 #define MUSIC_DIRECTORY         "music"
 124 #define SOUNDS_DIRECTORY        "sounds"
 125 #define LEVELS_DIRECTORY        "levels"
 126 #define TAPES_DIRECTORY         "tapes"
 127 #define SCORES_DIRECTORY        "scores"
 128
 129 /* areas in bitmap PIX_DOOR */
 130 /* meaning in PIX_DB_DOOR: (3 PAGEs)
 131    PAGEX1: 1. buffer for DOOR_1
 132    PAGEX2: 2. buffer for DOOR_1
 133    PAGEX3: buffer for animations
 134 */
 135
 136 #define DOOR_GFX_PAGESIZE       (gfx.dxsize)
 137 #define DOOR_GFX_PAGEX1         (0 * DOOR_GFX_PAGESIZE)
 138 #define DOOR_GFX_PAGEX2         (1 * DOOR_GFX_PAGESIZE)
 139 #define DOOR_GFX_PAGEX3         (2 * DOOR_GFX_PAGESIZE)
 140 #define DOOR_GFX_PAGEX4         (3 * DOOR_GFX_PAGESIZE)
 141 #define DOOR_GFX_PAGEX5         (4 * DOOR_GFX_PAGESIZE)
 142 #define DOOR_GFX_PAGEX6         (5 * DOOR_GFX_PAGESIZE)
 143 #define DOOR_GFX_PAGEX7         (6 * DOOR_GFX_PAGESIZE)
 144 #define DOOR_GFX_PAGEX8         (7 * DOOR_GFX_PAGESIZE)
 145 #define DOOR_GFX_PAGEY1         (0)
 146 #define DOOR_GFX_PAGEY2         (gfx.dysize)
 147
 148 /* functions for version handling */
 149 #define VERSION_IDENT(x,y,z)    ((x) * 10000 + (y) * 100 + (z))
 150 #define VERSION_MAJOR(x)        ((x) / 10000)
 151 #define VERSION_MINOR(x)        (((x) % 10000) / 100)
 152 #define VERSION_PATCH(x)        ((x) % 100)
 153
 154
 155 /* type definitions */
 156 typedef int (*EventFilter)(const Event *);
 157
 158
 159 /* structure definitions */
 160
 161 struct ProgramInfo
 162 {
 163   char *command_basename;
 164   char *userdata_directory;
 165
 166   char *program_title;
 167   char *window_title;
 168   char *icon_title;
 169
 170   char *x11_icon_filename;
 171   char *x11_iconmask_filename;
 172   char *msdos_pointer_filename;
 173
 174   char *cookie_prefix;
 175
 176   int version_major;
 177   int version_minor;
 178   int version_patch;
 179
 180   void (*exit_function)(int);
 181 };
 182
 183 struct OptionInfo
 184 {
 185   char *display_name;
 186   char *server_host;
 187   int server_port;
 188   char *ro_base_directory;
 189   char *rw_base_directory;
 190   char *level_directory;
 191   char *graphics_directory;
 192   char *sounds_directory;
 193   char *music_directory;
 194   boolean serveronly;
 195   boolean network;
 196   boolean verbose;
 197   boolean debug;
 198 };
 199
 200 struct VideoSystemInfo
 201 {
 202   int default_depth;
 203   int width, height, depth;
 204   boolean fullscreen_available;
 205   boolean fullscreen_enabled;
 206 };
 207
 208 struct AudioSystemInfo
 209 {
 210   boolean sound_available;
 211   boolean music_available;
 212   boolean loops_available;
 213   boolean mods_available;
 214   boolean sound_enabled;
 215
 216   int soundserver_pipe[2];
 217   int soundserver_pid;
 218   char *device_name;
 219   int device_fd;
 220
 221   int channels;
 222   int music_channel;
 223   int music_nr;
 224 };
 225
 226 struct GfxInfo
 227 {
 228   int sx, sy;
 229   int sxsize, sysize;
 230   int real_sx, real_sy;
 231   int full_sxsize, full_sysize;
 232   int scrollbuffer_width, scrollbuffer_height;
 233
 234   int dx, dy;
 235   int dxsize, dysize;
 236
 237   int vx, vy;
 238   int vxsize, vysize;
 239 };
 240
 241 struct JoystickInfo
 242 {
 243   int status;
 244   int fd[MAX_PLAYERS];          /* file descriptor of player's joystick */
 245 };
 246
 247 struct SetupJoystickInfo
 248 {
 249   char *device_name;            /* device name of player's joystick */
 250
 251   int xleft, xmiddle, xright;
 252   int yupper, ymiddle, ylower;
 253   int snap;
 254   int bomb;
 255 };
 256
 257 struct SetupKeyboardInfo
 258 {
 259   Key left;
 260   Key right;
 261   Key up;
 262   Key down;
 263   Key snap;
 264   Key bomb;
 265 };
 266
 267 struct SetupInputInfo
 268 {
 269   boolean use_joystick;
 270   struct SetupJoystickInfo joy;
 271   struct SetupKeyboardInfo key;
 272 };
 273
 274 struct SetupInfo
 275 {
 276   char *player_name;
 277
 278   boolean sound;
 279   boolean sound_loops;
 280   boolean sound_music;
 281   boolean sound_simple;
 282   boolean toons;
 283   boolean double_buffering;
 284   boolean direct_draw;          /* !double_buffering (redundant!) */
 285   boolean scroll_delay;
 286   boolean soft_scrolling;
 287   boolean fading;
 288   boolean autorecord;
 289   boolean quick_doors;
 290   boolean team_mode;
 291   boolean handicap;
 292   boolean time_limit;
 293   boolean fullscreen;
 294
 295   struct SetupInputInfo input[MAX_PLAYERS];
 296 };
 297
 298 struct LevelDirInfo
 299 {
 300   char *filename;       /* level series single directory name */
 301   char *fullpath;       /* complete path relative to level directory */
 302   char *basepath;       /* absolute base path of level directory */
 303   char *name;           /* level series name, as displayed on main screen */
 304   char *name_short;     /* optional short name for level selection screen */
 305   char *name_sorting;   /* optional sorting name for correct level sorting */
 306   char *author;         /* level series author name levels without author */
 307   char *imported_from;  /* optional comment for imported level series */
 308   int levels;           /* number of levels in level series */
 309   int first_level;      /* first level number (to allow start with 0 or 1) */
 310   int last_level;       /* last level number (automatically calculated) */
 311   int sort_priority;    /* sort levels by 'sort_priority' and then by name */
 312   boolean level_group;  /* directory contains more level series directories */
 313   boolean parent_link;  /* entry links back to parent directory */
 314   boolean user_defined; /* user defined levels are stored in home directory */
 315   boolean readonly;     /* readonly levels can not be changed with editor */
 316   int color;            /* color to use on selection screen for this level */
 317   char *class_desc;     /* description of level series class */
 318   int handicap_level;   /* number of the lowest unsolved level */
 319   int cl_first;         /* internal control field for "choose level" screen */
 320   int cl_cursor;        /* internal control field for "choose level" screen */
 321
 322   struct LevelDirInfo *node_parent;     /* parent level directory info */
 323   struct LevelDirInfo *node_group;      /* level group sub-directory info */
 324   struct LevelDirInfo *next;            /* next level series structure node */
 325 };
 326
 327
 328 /* ========================================================================= */
 329 /* exported variables                                                        */
 330 /* ========================================================================= */
 331
 332 extern struct ProgramInfo       program;
 333 extern struct OptionInfo        options;
 334 extern struct VideoSystemInfo   video;
 335 extern struct AudioSystemInfo   audio;
 336 extern struct GfxInfo           gfx;
 337 extern struct JoystickInfo      joystick;
 338 extern struct SetupInfo         setup;
 339
 340 extern struct LevelDirInfo     *leveldir_first;
 341 extern struct LevelDirInfo     *leveldir_current;
 342 extern int                      level_nr;
 343
 344 extern Display                 *display;
 345 extern Visual                  *visual;
 346 extern int                      screen;
 347 extern Colormap                 cmap;
 348
 349 extern DrawWindow              *window;
 350 extern DrawBuffer              *backbuffer;
 351 extern DrawBuffer              *drawto;
 352
 353 extern int                      button_status;
 354 extern boolean                  motion_status;
 355
 356 extern int                      redraw_mask;
 357 extern int                      redraw_tiles;
 358
 359 extern int                      FrameCounter;
 360
 361
 362 /* function definitions */
 363
 364 void InitCommandName(char *);
 365 void InitExitFunction(void (*exit_function)(int));
 366 void InitPlatformDependantStuff(void);
 367 void ClosePlatformDependantStuff(void);
 368
 369 void InitProgramInfo(char *, char *, char *, char *, char *, char *, char *,
 370                      char *, int);
 371
 372 void InitGfxFieldInfo(int, int, int, int, int, int, int, int);
 373 void InitGfxDoor1Info(int, int, int, int);
 374 void InitGfxDoor2Info(int, int, int, int);
 375 void InitGfxScrollbufferInfo(int, int);
 376
 377 inline void InitVideoDisplay(void);
 378 inline void CloseVideoDisplay(void);
 379 inline void InitVideoBuffer(DrawBuffer **,DrawWindow **, int,int,int, boolean);
 380 inline Bitmap *CreateBitmapStruct(void);
 381 inline Bitmap *CreateBitmap(int, int, int);
 382 inline void FreeBitmap(Bitmap *);
 383 inline void BlitBitmap(Bitmap *, Bitmap *, int, int, int, int, int, int);
 384 inline void ClearRectangle(Bitmap *, int, int, int, int);
 385 inline void SetClipMask(Bitmap *, GC, Pixmap);
 386 inline void SetClipOrigin(Bitmap *, GC, int, int);
 387 inline void BlitBitmapMasked(Bitmap *, Bitmap *, int, int, int, int, int, int);
 388 inline void DrawSimpleWhiteLine(Bitmap *, int, int, int, int);
 389 inline void DrawLines(Bitmap *, struct XY *, int, Pixel);
 390 inline Pixel GetPixel(Bitmap *, int, int);
 391 inline Pixel GetPixelFromRGB(Bitmap *, unsigned int,unsigned int,unsigned int);
 392 inline Pixel GetPixelFromRGBcompact(Bitmap *, unsigned int);
 393
 394 inline void FlushDisplay(void);
 395 inline void SyncDisplay(void);
 396 inline void KeyboardAutoRepeatOn(void);
 397 inline void KeyboardAutoRepeatOff(void);
 398 inline boolean PointerInWindow(DrawWindow *);
 399 inline boolean SetVideoMode(boolean);
 400 inline boolean ChangeVideoModeIfNeeded(boolean);
 401
 402 Bitmap *LoadImage(char *);
 403
 404 inline void OpenAudio(void);
 405 inline void CloseAudio(void);
 406 inline void SetAudioMode(boolean);
 407
 408 inline void InitEventFilter(EventFilter);
 409 inline boolean PendingEvent(void);
 410 inline void NextEvent(Event *event);
 411 inline Key GetEventKey(KeyEvent *, boolean);
 412 inline boolean CheckCloseWindowEvent(ClientMessageEvent *);
 413
 414 inline void InitJoysticks();
 415 inline boolean ReadJoystick(int, int *, int *, boolean *, boolean *);
 416
 417 #endif /* SYSTEM_H */