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