src/libgame/system.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 * 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 #if defined(PLATFORM_MACOSX)
  31 /* some symbols are already defined on Mac OS X */
  32 #define Delay Delay_internal
  33 #define DrawLine DrawLine_internal
  34 #define DrawText DrawText_internal
  35 #define GetPixel GetPixel_internal
  36 #endif
  37
  38
  39 /* the additional 'b' is needed for Win32 to open files in binary mode */
  40 #define MODE_READ               "rb"
  41 #define MODE_WRITE              "wb"
  42 #define MODE_APPEND             "ab"
  43
  44 #define DEFAULT_DEPTH           0
  45
  46 #define FULLSCREEN_NOT_AVAILABLE FALSE
  47 #define FULLSCREEN_AVAILABLE     TRUE
  48
  49 /* default input keys */
  50 #define DEFAULT_KEY_LEFT        KSYM_Left
  51 #define DEFAULT_KEY_RIGHT       KSYM_Right
  52 #define DEFAULT_KEY_UP          KSYM_Up
  53 #define DEFAULT_KEY_DOWN        KSYM_Down
  54 #if defined(PLATFORM_MACOSX)
  55 #define DEFAULT_KEY_SNAP        KSYM_Control_L
  56 #define DEFAULT_KEY_BOMB        KSYM_KP_Enter
  57 #else
  58 #define DEFAULT_KEY_SNAP        KSYM_Shift_L
  59 #define DEFAULT_KEY_BOMB        KSYM_Shift_R
  60 #endif
  61 #define DEFAULT_KEY_OKAY        KSYM_Return
  62 #define DEFAULT_KEY_CANCEL      KSYM_Escape
  63
  64 /* default shortcut keys */
  65 #define DEFAULT_KEY_SAVE_GAME   KSYM_F1
  66 #define DEFAULT_KEY_LOAD_GAME   KSYM_F2
  67 #define DEFAULT_KEY_TOGGLE_PAUSE KSYM_space
  68
  69 /* values for move directions and special "button" keys */
  70 #define MV_BIT_LEFT             0
  71 #define MV_BIT_RIGHT            1
  72 #define MV_BIT_UP               2
  73 #define MV_BIT_DOWN             3
  74 #define NUM_MV_DIRECTIONS       4
  75
  76 #define MV_NO_MOVING            0
  77 #define MV_LEFT                 (1 << MV_BIT_LEFT)
  78 #define MV_RIGHT                (1 << MV_BIT_RIGHT)
  79 #define MV_UP                   (1 << MV_BIT_UP)
  80 #define MV_DOWN                 (1 << MV_BIT_DOWN)
  81 #define KEY_BUTTON_1            (1 << 4)
  82 #define KEY_BUTTON_2            (1 << 5)
  83 #define KEY_MOTION              (MV_LEFT | MV_RIGHT | MV_UP | MV_DOWN)
  84 #define KEY_BUTTON              (KEY_BUTTON_1 | KEY_BUTTON_2)
  85 #define KEY_ACTION              (KEY_MOTION | KEY_BUTTON)
  86
  87 #define MV_DIR_BIT(x)           ((x) == MV_LEFT  ? MV_BIT_LEFT  :       \
  88                                  (x) == MV_RIGHT ? MV_BIT_RIGHT :       \
  89                                  (x) == MV_UP    ? MV_BIT_UP    : MV_BIT_DOWN)
  90
  91 /* values for button status */
  92 #define MB_NOT_PRESSED          FALSE
  93 #define MB_NOT_RELEASED         TRUE
  94 #define MB_RELEASED             FALSE
  95 #define MB_PRESSED              TRUE
  96 #define MB_MENU_CHOICE          FALSE
  97 #define MB_MENU_MARK            TRUE
  98 #define MB_MENU_INITIALIZE      (-1)
  99 #define MB_MENU_LEAVE           (-2)
 100 #define MB_LEFTBUTTON           1
 101 #define MB_MIDDLEBUTTON         2
 102 #define MB_RIGHTBUTTON          3
 103
 104 /* values for redraw_mask */
 105 #define REDRAW_NONE             (0)
 106 #define REDRAW_ALL              (1 << 0)
 107 #define REDRAW_FIELD            (1 << 1)
 108 #define REDRAW_TILES            (1 << 2)
 109 #define REDRAW_DOOR_1           (1 << 3)
 110 #define REDRAW_VIDEO_1          (1 << 4)
 111 #define REDRAW_VIDEO_2          (1 << 5)
 112 #define REDRAW_VIDEO_3          (1 << 6)
 113 #define REDRAW_MICROLEVEL       (1 << 7)
 114 #define REDRAW_MICROLABEL       (1 << 8)
 115 #define REDRAW_FROM_BACKBUFFER  (1 << 9)
 116 #define REDRAW_DOOR_2           (REDRAW_VIDEO_1 | \
 117                                  REDRAW_VIDEO_2 | \
 118                                  REDRAW_VIDEO_3)
 119 #define REDRAW_DOOR_3           (1 << 10)
 120 #define REDRAW_DOORS            (REDRAW_DOOR_1 | \
 121                                  REDRAW_DOOR_2 | \
 122                                  REDRAW_DOOR_3)
 123 #define REDRAW_MAIN             (REDRAW_FIELD | \
 124                                  REDRAW_TILES | \
 125                                  REDRAW_MICROLEVEL)
 126 #define REDRAW_FPS              (1 << 11)
 127 #define REDRAWTILES_THRESHOLD   (SCR_FIELDX * SCR_FIELDY / 2)
 128
 129 /* maximum number of parallel players supported by libgame functions */
 130 #define MAX_PLAYERS             4
 131
 132 /* maximum allowed length of player name */
 133 #define MAX_PLAYER_NAME_LEN     10
 134
 135 /* default name for empty highscore entry */
 136 #define EMPTY_PLAYER_NAME       "no name"
 137
 138 /* default name for unknown player names */
 139 #define ANONYMOUS_NAME          "anonymous"
 140
 141 /* default text for non-existant artwork */
 142 #define NOT_AVAILABLE           "(not available)"
 143
 144 /* default value for undefined filename */
 145 #define UNDEFINED_FILENAME      "[NONE]"
 146
 147 /* default name for new levels */
 148 #define NAMELESS_LEVEL_NAME     "nameless level"
 149
 150 /* definitions for game sub-directories */
 151 #ifndef RO_GAME_DIR
 152 #define RO_GAME_DIR             "."
 153 #endif
 154
 155 #ifndef RW_GAME_DIR
 156 #define RW_GAME_DIR             "."
 157 #endif
 158
 159 #define RO_BASE_PATH            RO_GAME_DIR
 160 #define RW_BASE_PATH            RW_GAME_DIR
 161
 162 #define GRAPHICS_DIRECTORY      "graphics"
 163 #define SOUNDS_DIRECTORY        "sounds"
 164 #define MUSIC_DIRECTORY         "music"
 165 #define LEVELS_DIRECTORY        "levels"
 166 #define TAPES_DIRECTORY         "tapes"
 167 #define SCORES_DIRECTORY        "scores"
 168
 169 #if !defined(PLATFORM_MSDOS)
 170 #define GRAPHICS_SUBDIR         "gfx_classic"
 171 #define SOUNDS_SUBDIR           "snd_classic"
 172 #define MUSIC_SUBDIR            "mus_classic"
 173 #else
 174 #define GRAPHICS_SUBDIR         "gfx_orig"
 175 #define SOUNDS_SUBDIR           "snd_orig"
 176 #define MUSIC_SUBDIR            "mus_orig"
 177 #endif
 178
 179 /* areas in bitmap PIX_DOOR */
 180 /* meaning in PIX_DB_DOOR: (3 PAGEs)
 181    PAGEX1: 1. buffer for DOOR_1
 182    PAGEX2: 2. buffer for DOOR_1
 183    PAGEX3: buffer for animations
 184 */
 185
 186 #define DOOR_GFX_PAGESIZE       (gfx.dxsize)
 187 #define DOOR_GFX_PAGEX1         (0 * DOOR_GFX_PAGESIZE)
 188 #define DOOR_GFX_PAGEX2         (1 * DOOR_GFX_PAGESIZE)
 189 #define DOOR_GFX_PAGEX3         (2 * DOOR_GFX_PAGESIZE)
 190 #define DOOR_GFX_PAGEX4         (3 * DOOR_GFX_PAGESIZE)
 191 #define DOOR_GFX_PAGEX5         (4 * DOOR_GFX_PAGESIZE)
 192 #define DOOR_GFX_PAGEX6         (5 * DOOR_GFX_PAGESIZE)
 193 #define DOOR_GFX_PAGEX7         (6 * DOOR_GFX_PAGESIZE)
 194 #define DOOR_GFX_PAGEX8         (7 * DOOR_GFX_PAGESIZE)
 195 #define DOOR_GFX_PAGEY1         (0)
 196 #define DOOR_GFX_PAGEY2         (gfx.dysize)
 197
 198 /* functions for version handling */
 199 #define VERSION_IDENT(x,y,z)    ((x) * 10000 + (y) * 100 + (z))
 200 #define VERSION_MAJOR(x)        ((x) / 10000)
 201 #define VERSION_MINOR(x)        (((x) % 10000) / 100)
 202 #define VERSION_PATCH(x)        ((x) % 100)
 203
 204 /* functions for parent/child process identification */
 205 #define IS_PARENT_PROCESS(pid)  ((pid) > 0)
 206 #define IS_CHILD_PROCESS(pid)   ((pid) == 0)
 207
 208
 209 /* type definitions */
 210 typedef int (*EventFilter)(const Event *);
 211
 212
 213 /* structure definitions */
 214
 215 struct ProgramInfo
 216 {
 217   char *command_basename;
 218   char *userdata_directory;
 219
 220   char *program_title;
 221   char *window_title;
 222   char *icon_title;
 223
 224   char *x11_icon_filename;
 225   char *x11_iconmask_filename;
 226   char *msdos_pointer_filename;
 227
 228   char *cookie_prefix;
 229   char *filename_prefix;        /* prefix to cut off from DOS filenames */
 230
 231   int version_major;
 232   int version_minor;
 233   int version_patch;
 234
 235   void (*exit_function)(int);
 236 };
 237
 238 struct OptionInfo
 239 {
 240   char *display_name;
 241   char *server_host;
 242   int server_port;
 243
 244   char *ro_base_directory;
 245   char *rw_base_directory;
 246   char *level_directory;
 247   char *graphics_directory;
 248   char *sounds_directory;
 249   char *music_directory;
 250   char *execute_command;
 251
 252   boolean serveronly;
 253   boolean network;
 254   boolean verbose;
 255   boolean debug;
 256 };
 257
 258 struct VideoSystemInfo
 259 {
 260   int default_depth;
 261   int width, height, depth;
 262   boolean fullscreen_available;
 263   boolean fullscreen_enabled;
 264 };
 265
 266 struct AudioSystemInfo
 267 {
 268   boolean sound_available;
 269   boolean loops_available;
 270   boolean music_available;
 271
 272   boolean sound_enabled;
 273   boolean sound_deactivated;    /* for temporarily disabling sound */
 274
 275   int mixer_pipe[2];
 276   int mixer_pid;
 277   char *device_name;
 278   int device_fd;
 279
 280   int num_channels;
 281   int music_channel;
 282   int first_sound_channel;
 283 };
 284
 285 struct GfxInfo
 286 {
 287   int sx, sy;
 288   int sxsize, sysize;
 289   int real_sx, real_sy;
 290   int full_sxsize, full_sysize;
 291   int scrollbuffer_width, scrollbuffer_height;
 292
 293   int dx, dy;
 294   int dxsize, dysize;
 295
 296   int vx, vy;
 297   int vxsize, vysize;
 298
 299   boolean draw_deactivation_mask;
 300
 301   Bitmap *background_bitmap;
 302 };
 303
 304 struct FontInfo
 305 {
 306   Bitmap *bitmap_initial;
 307   Bitmap *bitmap_big;
 308   Bitmap *bitmap_medium;
 309   Bitmap *bitmap_small;
 310   Bitmap *bitmap_tile;
 311 };
 312
 313 struct JoystickInfo
 314 {
 315   int status;
 316   int fd[MAX_PLAYERS];          /* file descriptor of player's joystick */
 317 };
 318
 319 struct SetupJoystickInfo
 320 {
 321   char *device_name;            /* device name of player's joystick */
 322
 323   int xleft, xmiddle, xright;
 324   int yupper, ymiddle, ylower;
 325   int snap;
 326   int bomb;
 327 };
 328
 329 struct SetupKeyboardInfo
 330 {
 331   Key left;
 332   Key right;
 333   Key up;
 334   Key down;
 335   Key snap;
 336   Key bomb;
 337 };
 338
 339 struct SetupInputInfo
 340 {
 341   boolean use_joystick;
 342   struct SetupJoystickInfo joy;
 343   struct SetupKeyboardInfo key;
 344 };
 345
 346 struct SetupEditorInfo
 347 {
 348   boolean el_boulderdash;
 349   boolean el_emerald_mine;
 350   boolean el_more;
 351   boolean el_sokoban;
 352   boolean el_supaplex;
 353   boolean el_diamond_caves;
 354   boolean el_dx_boulderdash;
 355   boolean el_chars;
 356   boolean el_custom;
 357 };
 358
 359 struct SetupShortcutInfo
 360 {
 361   Key save_game;
 362   Key load_game;
 363   Key toggle_pause;
 364 };
 365
 366 struct SetupInfo
 367 {
 368   char *player_name;
 369
 370   boolean sound;
 371   boolean sound_loops;
 372   boolean sound_music;
 373   boolean sound_simple;
 374   boolean toons;
 375   boolean double_buffering;
 376   boolean direct_draw;          /* !double_buffering (redundant!) */
 377   boolean scroll_delay;
 378   boolean soft_scrolling;
 379   boolean fading;
 380   boolean autorecord;
 381   boolean quick_doors;
 382   boolean team_mode;
 383   boolean handicap;
 384   boolean time_limit;
 385   boolean fullscreen;
 386   boolean ask_on_escape;
 387
 388   char *graphics_set;
 389   char *sounds_set;
 390   char *music_set;
 391   boolean override_level_graphics;
 392   boolean override_level_sounds;
 393   boolean override_level_music;
 394
 395   struct SetupEditorInfo editor;
 396   struct SetupShortcutInfo shortcut;
 397   struct SetupInputInfo input[MAX_PLAYERS];
 398 };
 399
 400 #define TREE_TYPE_GENERIC               0
 401 #define TREE_TYPE_GRAPHICS_DIR          1
 402 #define TREE_TYPE_SOUNDS_DIR            2
 403 #define TREE_TYPE_MUSIC_DIR             3
 404 #define TREE_TYPE_LEVEL_DIR             4
 405
 406 #define ARTWORK_TYPE_GRAPHICS           TREE_TYPE_GRAPHICS_DIR
 407 #define ARTWORK_TYPE_SOUNDS             TREE_TYPE_SOUNDS_DIR
 408 #define ARTWORK_TYPE_MUSIC              TREE_TYPE_MUSIC_DIR
 409
 410 struct TreeInfo
 411 {
 412   struct TreeInfo **node_top;           /* topmost node in tree */
 413   struct TreeInfo *node_parent;         /* parent level directory info */
 414   struct TreeInfo *node_group;          /* level group sub-directory info */
 415   struct TreeInfo *next;                /* next level series structure node */
 416
 417   int cl_first;         /* internal control field for setup screen */
 418   int cl_cursor;        /* internal control field for setup screen */
 419
 420   int type;             /* type of tree content */
 421
 422   /* fields for "type == TREE_TYPE_LEVEL_DIR" */
 423
 424   char *filename;       /* tree info sub-directory basename (may be ".") */
 425   char *fullpath;       /* complete path relative to tree base directory */
 426   char *basepath;       /* absolute base path of tree base directory */
 427   char *identifier;     /* identifier string for configuration files */
 428   char *name;           /* tree info name, as displayed in selection menues */
 429   char *name_sorting;   /* optional sorting name for correct name sorting */
 430   char *author;         /* level or artwork author name */
 431   char *imported_from;  /* optional comment for imported levels or artwork */
 432
 433   char *graphics_set;   /* optional custom graphics set (level tree only) */
 434   char *sounds_set;     /* optional custom sounds set (level tree only) */
 435   char *music_set;      /* optional custom music set (level tree only) */
 436   char *graphics_path;  /* path to optional custom graphics set (level only) */
 437   char *sounds_path;    /* path to optional custom sounds set (level only) */
 438   char *music_path;     /* path to optional custom music set (level only) */
 439
 440   int levels;           /* number of levels in level series */
 441   int first_level;      /* first level number (to allow start with 0 or 1) */
 442   int last_level;       /* last level number (automatically calculated) */
 443   int sort_priority;    /* sort levels by 'sort_priority' and then by name */
 444
 445   boolean level_group;  /* directory contains more level series directories */
 446   boolean parent_link;  /* entry links back to parent directory */
 447   boolean user_defined; /* user defined levels are stored in home directory */
 448   boolean readonly;     /* readonly levels can not be changed with editor */
 449
 450   int color;            /* color to use on selection screen for this level */
 451   char *class_desc;     /* description of level series class */
 452   int handicap_level;   /* number of the lowest unsolved level */
 453 };
 454
 455 typedef struct TreeInfo TreeInfo;
 456 typedef struct TreeInfo LevelDirTree;
 457 typedef struct TreeInfo ArtworkDirTree;
 458 typedef struct TreeInfo GraphicsDirTree;
 459 typedef struct TreeInfo SoundsDirTree;
 460 typedef struct TreeInfo MusicDirTree;
 461
 462 struct ArtworkInfo
 463 {
 464   GraphicsDirTree *gfx_first;
 465   GraphicsDirTree *gfx_current;
 466   SoundsDirTree *snd_first;
 467   SoundsDirTree *snd_current;
 468   MusicDirTree *mus_first;
 469   MusicDirTree *mus_current;
 470
 471   char *gfx_current_identifier;
 472   char *snd_current_identifier;
 473   char *mus_current_identifier;
 474 };
 475
 476 struct ConfigInfo
 477 {
 478   char *token;
 479   char *value;
 480 };
 481
 482 struct FileInfo
 483 {
 484   char *token;
 485
 486   char *default_filename;
 487   char *filename;
 488
 489   int *default_parameter;                       /* array of file parameters */
 490   int *parameter;                               /* array of file parameters */
 491 };
 492
 493 struct ListNodeInfo
 494 {
 495   char *source_filename;                        /* primary key for node list */
 496   int num_references;
 497 };
 498
 499 struct ArtworkListInfo
 500 {
 501   int type;                                     /* type of artwork */
 502
 503   int num_file_list_entries;
 504   int num_suffix_list_entries;
 505
 506   struct FileInfo *file_list;                   /* static artwork file array */
 507   struct ConfigInfo *suffix_list;               /* parameter suffixes array */
 508
 509   struct ListNodeInfo **artwork_list;           /* static artwork node array */
 510
 511   struct ListNode *content_list;                /* dynamic artwork node list */
 512
 513   void *(*load_artwork)(char *);                /* constructor function */
 514   void (*free_artwork)(void *);                 /* destructor function */
 515 };
 516
 517
 518 /* ========================================================================= */
 519 /* exported variables                                                        */
 520 /* ========================================================================= */
 521
 522 extern struct ProgramInfo       program;
 523 extern struct OptionInfo        options;
 524 extern struct VideoSystemInfo   video;
 525 extern struct AudioSystemInfo   audio;
 526 extern struct GfxInfo           gfx;
 527 extern struct FontInfo          font;
 528 extern struct ArtworkInfo       artwork;
 529 extern struct JoystickInfo      joystick;
 530 extern struct SetupInfo         setup;
 531
 532 extern LevelDirTree            *leveldir_first;
 533 extern LevelDirTree            *leveldir_current;
 534 extern int                      level_nr;
 535
 536 extern Display                 *display;
 537 extern Visual                  *visual;
 538 extern int                      screen;
 539 extern Colormap                 cmap;
 540
 541 extern DrawWindow              *window;
 542 extern DrawBuffer              *backbuffer;
 543 extern DrawBuffer              *drawto;
 544
 545 extern int                      button_status;
 546 extern boolean                  motion_status;
 547
 548 extern int                      redraw_mask;
 549 extern int                      redraw_tiles;
 550
 551 extern int                      FrameCounter;
 552
 553
 554 /* function definitions */
 555
 556 void InitCommandName(char *);
 557 void InitExitFunction(void (*exit_function)(int));
 558 void InitPlatformDependantStuff(void);
 559 void ClosePlatformDependantStuff(void);
 560
 561 void InitProgramInfo(char *, char *, char *, char *, char *, char *, char *,
 562                      char *, char *, int);
 563
 564 void InitGfxFieldInfo(int, int, int, int, int, int, int, int);
 565 void InitGfxDoor1Info(int, int, int, int);
 566 void InitGfxDoor2Info(int, int, int, int);
 567 void InitGfxScrollbufferInfo(int, int);
 568 void SetDrawDeactivationMask(int );
 569 void SetBackgroundBitmap(Bitmap *);
 570
 571 inline void InitVideoDisplay(void);
 572 inline void CloseVideoDisplay(void);
 573 inline void InitVideoBuffer(DrawBuffer **,DrawWindow **, int,int,int, boolean);
 574 inline Bitmap *CreateBitmapStruct(void);
 575 inline Bitmap *CreateBitmap(int, int, int);
 576 inline void FreeBitmap(Bitmap *);
 577 inline void BlitBitmap(Bitmap *, Bitmap *, int, int, int, int, int, int);
 578 inline void ClearRectangle(Bitmap *, int, int, int, int);
 579 inline void ClearRectangleOnBackground(Bitmap *, int, int, int, int);
 580 inline void SetClipMask(Bitmap *, GC, Pixmap);
 581 inline void SetClipOrigin(Bitmap *, GC, int, int);
 582 inline void BlitBitmapMasked(Bitmap *, Bitmap *, int, int, int, int, int, int);
 583 inline boolean DrawingOnBackground(int, int);
 584 inline void BlitBitmapOnBackground(Bitmap *, Bitmap *, int, int, int, int, int,
 585                                    int);
 586 inline void DrawSimpleWhiteLine(Bitmap *, int, int, int, int);
 587 inline void DrawLines(Bitmap *, struct XY *, int, Pixel);
 588 inline Pixel GetPixel(Bitmap *, int, int);
 589 inline Pixel GetPixelFromRGB(Bitmap *, unsigned int,unsigned int,unsigned int);
 590 inline Pixel GetPixelFromRGBcompact(Bitmap *, unsigned int);
 591
 592 inline void FlushDisplay(void);
 593 inline void SyncDisplay(void);
 594 inline void KeyboardAutoRepeatOn(void);
 595 inline void KeyboardAutoRepeatOff(void);
 596 inline boolean PointerInWindow(DrawWindow *);
 597 inline boolean SetVideoMode(boolean);
 598 inline boolean ChangeVideoModeIfNeeded(boolean);
 599
 600 Bitmap *LoadImage(char *);
 601 Bitmap *LoadCustomImage(char *);
 602 void ReloadCustomImage(Bitmap *, char *);
 603
 604 inline void OpenAudio(void);
 605 inline void CloseAudio(void);
 606 inline void SetAudioMode(boolean);
 607
 608 inline void InitEventFilter(EventFilter);
 609 inline boolean PendingEvent(void);
 610 inline void NextEvent(Event *event);
 611 inline Key GetEventKey(KeyEvent *, boolean);
 612 inline boolean CheckCloseWindowEvent(ClientMessageEvent *);
 613
 614 inline void InitJoysticks();
 615 inline boolean ReadJoystick(int, int *, int *, boolean *, boolean *);
 616
 617 #endif /* SYSTEM_H */