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
  21 #if defined(PLATFORM_MACOSX)
  22 #include "macosx.h"
  23 #elif defined(PLATFORM_WIN32)
  24 #include "windows.h"
  25 #elif defined(PLATFORM_MSDOS)
  26 #include "msdos.h"
  27 #endif
  28
  29 #if defined(TARGET_SDL)
  30 #include "sdl.h"
  31 #elif defined(TARGET_X11)
  32 #include "x11.h"
  33 #endif
  34
  35
  36 /* the additional 'b' is needed for Win32 to open files in binary mode */
  37 #define MODE_READ               "rb"
  38 #define MODE_WRITE              "wb"
  39 #define MODE_APPEND             "ab"
  40
  41 #define DEFAULT_DEPTH           0
  42
  43 #define BLIT_OPAQUE             0
  44 #define BLIT_MASKED             1
  45 #define BLIT_INVERSE            2
  46 #define BLIT_ON_BACKGROUND      3
  47
  48 #define FULLSCREEN_NOT_AVAILABLE FALSE
  49 #define FULLSCREEN_AVAILABLE     TRUE
  50
  51 /* default input keys */
  52 #define DEFAULT_KEY_LEFT        KSYM_Left
  53 #define DEFAULT_KEY_RIGHT       KSYM_Right
  54 #define DEFAULT_KEY_UP          KSYM_Up
  55 #define DEFAULT_KEY_DOWN        KSYM_Down
  56 #if defined(PLATFORM_MACOSX)
  57 #define DEFAULT_KEY_SNAP        KSYM_Control_L
  58 #define DEFAULT_KEY_DROP        KSYM_KP_Enter
  59 #else
  60 #define DEFAULT_KEY_SNAP        KSYM_Control_L
  61 #define DEFAULT_KEY_DROP        KSYM_Control_R
  62 #endif
  63 #define DEFAULT_KEY_OKAY        KSYM_Return
  64 #define DEFAULT_KEY_CANCEL      KSYM_Escape
  65
  66 /* default shortcut keys */
  67 #define DEFAULT_KEY_SAVE_GAME   KSYM_F1
  68 #define DEFAULT_KEY_LOAD_GAME   KSYM_F2
  69 #define DEFAULT_KEY_TOGGLE_PAUSE KSYM_space
  70
  71 /* values for key_status */
  72 #define KEY_NOT_PRESSED         FALSE
  73 #define KEY_RELEASED            FALSE
  74 #define KEY_PRESSED             TRUE
  75
  76 /* values for button status */
  77 #define MB_NOT_PRESSED          FALSE
  78 #define MB_NOT_RELEASED         TRUE
  79 #define MB_RELEASED             FALSE
  80 #define MB_PRESSED              TRUE
  81 #define MB_MENU_CHOICE          FALSE
  82 #define MB_MENU_MARK            TRUE
  83 #define MB_MENU_INITIALIZE      (-1)
  84 #define MB_MENU_LEAVE           (-2)
  85 #define MB_LEFTBUTTON           1
  86 #define MB_MIDDLEBUTTON         2
  87 #define MB_RIGHTBUTTON          3
  88
  89
  90 /* values for move directions */
  91 #define MV_BIT_LEFT             0
  92 #define MV_BIT_RIGHT            1
  93 #define MV_BIT_UP               2
  94 #define MV_BIT_DOWN             3
  95
  96 #define NUM_DIRECTIONS          4
  97
  98 /* values for special "button" bitmasks */
  99 #define BUTTON_1                4
 100 #define BUTTON_2                5
 101
 102 /* values for move directions and special "button" key bitmasks */
 103 #define MV_NONE                 0
 104 #define MV_LEFT                 (1 << MV_BIT_LEFT)
 105 #define MV_RIGHT                (1 << MV_BIT_RIGHT)
 106 #define MV_UP                   (1 << MV_BIT_UP)
 107 #define MV_DOWN                 (1 << MV_BIT_DOWN)
 108
 109 #define MV_HORIZONTAL           (MV_LEFT | MV_RIGHT)
 110 #define MV_VERTICAL             (MV_UP   | MV_DOWN)
 111 #define MV_ALL_DIRECTIONS       (MV_LEFT | MV_RIGHT | MV_UP | MV_DOWN)
 112 #define MV_ANY_DIRECTION        (MV_ALL_DIRECTIONS)
 113 #define MV_NO_DIRECTION         (MV_NONE)
 114
 115 #define KEY_BUTTON_1            (1 << BUTTON_1)
 116 #define KEY_BUTTON_2            (1 << BUTTON_2)
 117 #define KEY_MOTION              (MV_LEFT | MV_RIGHT | MV_UP | MV_DOWN)
 118 #define KEY_BUTTON              (KEY_BUTTON_1 | KEY_BUTTON_2)
 119 #define KEY_ACTION              (KEY_MOTION | KEY_BUTTON)
 120
 121 #define MV_DIR_BIT(x)           ((x) == MV_LEFT  ? MV_BIT_LEFT  :       \
 122                                  (x) == MV_RIGHT ? MV_BIT_RIGHT :       \
 123                                  (x) == MV_UP    ? MV_BIT_UP    : MV_BIT_DOWN)
 124
 125 #define MV_DIR_OPPOSITE(x)      ((x) == MV_LEFT  ? MV_RIGHT :           \
 126                                  (x) == MV_RIGHT ? MV_LEFT  :           \
 127                                  (x) == MV_UP    ? MV_DOWN  :           \
 128                                  (x) == MV_DOWN  ? MV_UP    : MV_NONE)
 129
 130
 131 /* values for animation mode (frame order and direction) */
 132 #define ANIM_NONE               0
 133 #define ANIM_LOOP               (1 << 0)
 134 #define ANIM_LINEAR             (1 << 1)
 135 #define ANIM_PINGPONG           (1 << 2)
 136 #define ANIM_PINGPONG2          (1 << 3)
 137 #define ANIM_RANDOM             (1 << 4)
 138 #define ANIM_CE_VALUE           (1 << 5)
 139 #define ANIM_CE_SCORE           (1 << 6)
 140 #define ANIM_REVERSE            (1 << 7)
 141
 142 /* values for special (non game element) animation modes */
 143 #define ANIM_HORIZONTAL         (1 << 8)
 144 #define ANIM_VERTICAL           (1 << 9)
 145
 146 #define ANIM_DEFAULT            ANIM_LOOP
 147
 148 /* values for redraw_mask */
 149 #define REDRAW_NONE             (0)
 150 #define REDRAW_ALL              (1 << 0)
 151 #define REDRAW_FIELD            (1 << 1)
 152 #define REDRAW_TILES            (1 << 2)
 153 #define REDRAW_DOOR_1           (1 << 3)
 154 #define REDRAW_VIDEO_1          (1 << 4)
 155 #define REDRAW_VIDEO_2          (1 << 5)
 156 #define REDRAW_VIDEO_3          (1 << 6)
 157 #define REDRAW_MICROLEVEL       (1 << 7)
 158 #define REDRAW_MICROLABEL       (1 << 8)
 159 #define REDRAW_FROM_BACKBUFFER  (1 << 9)
 160 #define REDRAW_DOOR_2           (REDRAW_VIDEO_1 | \
 161                                  REDRAW_VIDEO_2 | \
 162                                  REDRAW_VIDEO_3)
 163 #define REDRAW_DOOR_3           (1 << 10)
 164 #define REDRAW_DOORS            (REDRAW_DOOR_1 | \
 165                                  REDRAW_DOOR_2 | \
 166                                  REDRAW_DOOR_3)
 167 #define REDRAW_MAIN             (REDRAW_FIELD | \
 168                                  REDRAW_TILES | \
 169                                  REDRAW_MICROLEVEL)
 170 #define REDRAW_FPS              (1 << 11)
 171 #define REDRAWTILES_THRESHOLD   (SCR_FIELDX * SCR_FIELDY / 2)
 172
 173 #define IN_GFX_SCREEN(x, y)     (x >= gfx.sx && x < gfx.sx + gfx.sxsize && \
 174                                  y >= gfx.sy && y < gfx.sy + gfx.sysize)
 175 #define IN_GFX_DOOR(x, y)       (x >= gfx.dx && x < gfx.dx + gfx.dxsize && \
 176                                  y >= gfx.dy && y < gfx.dy + gfx.dysize)
 177 #define IN_GFX_VIDEO(x, y)      (x >= gfx.vx && x < gfx.vx + gfx.vxsize && \
 178                                  y >= gfx.vy && y < gfx.vy + gfx.vysize)
 179
 180 /* values for mouse cursor */
 181 #define CURSOR_DEFAULT          0
 182 #define CURSOR_PLAYFIELD        1
 183
 184
 185 /* maximum number of parallel players supported by libgame functions */
 186 #define MAX_PLAYERS             4
 187
 188 /* maximum allowed length of player name */
 189 #define MAX_PLAYER_NAME_LEN     10
 190
 191 /* default name for empty highscore entry */
 192 #define EMPTY_PLAYER_NAME       "no name"
 193
 194 /* default name for unknown player names */
 195 #define ANONYMOUS_NAME          "anonymous"
 196
 197 /* default for other unknown names */
 198 #define UNKNOWN_NAME            "unknown"
 199
 200 /* default name for new levels */
 201 #define NAMELESS_LEVEL_NAME     "nameless level"
 202
 203 /* default text for non-existant artwork */
 204 #define NOT_AVAILABLE           "(not available)"
 205
 206 /* default value for undefined filename */
 207 #define UNDEFINED_FILENAME      "[NONE]"
 208
 209 /* default value for undefined parameter */
 210 #define ARG_DEFAULT             "[DEFAULT]"
 211
 212 /* default values for undefined configuration file parameters */
 213 #define ARG_UNDEFINED           "-1000000"
 214 #define ARG_UNDEFINED_VALUE     (atoi(ARG_UNDEFINED))
 215
 216 /* definitions for game sub-directories */
 217 #ifndef RO_GAME_DIR
 218 #define RO_GAME_DIR             "."
 219 #endif
 220
 221 #ifndef RW_GAME_DIR
 222 #define RW_GAME_DIR             "."
 223 #endif
 224
 225 #define RO_BASE_PATH            RO_GAME_DIR
 226 #define RW_BASE_PATH            RW_GAME_DIR
 227
 228 /* directory names */
 229 #define GRAPHICS_DIRECTORY      "graphics"
 230 #define SOUNDS_DIRECTORY        "sounds"
 231 #define MUSIC_DIRECTORY         "music"
 232 #define LEVELS_DIRECTORY        "levels"
 233 #define TAPES_DIRECTORY         "tapes"
 234 #define SCORES_DIRECTORY        "scores"
 235 #define DOCS_DIRECTORY          "docs"
 236
 237 #if !defined(PLATFORM_MSDOS)
 238 #define GFX_CLASSIC_SUBDIR      "gfx_classic"
 239 #define SND_CLASSIC_SUBDIR      "snd_classic"
 240 #define MUS_CLASSIC_SUBDIR      "mus_classic"
 241 #else
 242 #define GFX_CLASSIC_SUBDIR      "gfx_orig"
 243 #define SND_CLASSIC_SUBDIR      "snd_orig"
 244 #define MUS_CLASSIC_SUBDIR      "mus_orig"
 245 #endif
 246
 247 /* file names and filename extensions */
 248 #if !defined(PLATFORM_MSDOS)
 249 #define LEVELSETUP_DIRECTORY    "levelsetup"
 250 #define SETUP_FILENAME          "setup.conf"
 251 #define LEVELSETUP_FILENAME     "levelsetup.conf"
 252 #define EDITORSETUP_FILENAME    "editorsetup.conf"
 253 #define EDITORCASCADE_FILENAME  "editorcascade.conf"
 254 #define HELPANIM_FILENAME       "helpanim.conf"
 255 #define HELPTEXT_FILENAME       "helptext.conf"
 256 #define LEVELINFO_FILENAME      "levelinfo.conf"
 257 #define GRAPHICSINFO_FILENAME   "graphicsinfo.conf"
 258 #define SOUNDSINFO_FILENAME     "soundsinfo.conf"
 259 #define MUSICINFO_FILENAME      "musicinfo.conf"
 260 #define LEVELFILE_EXTENSION     "level"
 261 #define TAPEFILE_EXTENSION      "tape"
 262 #define SCOREFILE_EXTENSION     "score"
 263 #else
 264 #define LEVELSETUP_DIRECTORY    "lvlsetup"
 265 #define SETUP_FILENAME          "setup.cnf"
 266 #define LEVELSETUP_FILENAME     "lvlsetup.cnf"
 267 #define EDITORSETUP_FILENAME    "edsetup.cnf"
 268 #define EDITORCASCADE_FILENAME  "edcascad.conf"
 269 #define HELPANIM_FILENAME       "helpanim.cnf"
 270 #define HELPTEXT_FILENAME       "helptext.cnf"
 271 #define LEVELINFO_FILENAME      "lvlinfo.cnf"
 272 #define GRAPHICSINFO_FILENAME   "gfxinfo.cnf"
 273 #define SOUNDSINFO_FILENAME     "sndinfo.cnf"
 274 #define MUSICINFO_FILENAME      "musinfo.cnf"
 275 #define LEVELFILE_EXTENSION     "lvl"
 276 #define TAPEFILE_EXTENSION      "tap"
 277 #define SCOREFILE_EXTENSION     "sco"
 278 #endif
 279
 280
 281 /* areas in bitmap PIX_DOOR */
 282 /* meaning in PIX_DB_DOOR: (3 PAGEs)
 283    PAGEX1: 1. buffer for DOOR_1
 284    PAGEX2: 2. buffer for DOOR_1
 285    PAGEX3: buffer for animations
 286 */
 287
 288 /* these values are hard-coded to be able to use them in initialization */
 289 #define DOOR_GFX_PAGE_WIDTH     100     /* should be set to "gfx.dxsize" */
 290 #define DOOR_GFX_PAGE_HEIGHT    280     /* should be set to "gfx.dysize" */
 291
 292 #define DOOR_GFX_PAGESIZE       (DOOR_GFX_PAGE_WIDTH)
 293 #define DOOR_GFX_PAGEX1         (0 * DOOR_GFX_PAGESIZE)
 294 #define DOOR_GFX_PAGEX2         (1 * DOOR_GFX_PAGESIZE)
 295 #define DOOR_GFX_PAGEX3         (2 * DOOR_GFX_PAGESIZE)
 296 #define DOOR_GFX_PAGEX4         (3 * DOOR_GFX_PAGESIZE)
 297 #define DOOR_GFX_PAGEX5         (4 * DOOR_GFX_PAGESIZE)
 298 #define DOOR_GFX_PAGEX6         (5 * DOOR_GFX_PAGESIZE)
 299 #define DOOR_GFX_PAGEX7         (6 * DOOR_GFX_PAGESIZE)
 300 #define DOOR_GFX_PAGEX8         (7 * DOOR_GFX_PAGESIZE)
 301 #define DOOR_GFX_PAGEY1         (0)
 302 #define DOOR_GFX_PAGEY2         (DOOR_GFX_PAGE_HEIGHT)
 303
 304
 305 /* macros for version handling */
 306 #define VERSION_MAJOR(x)        ((x) / 1000000)
 307 #define VERSION_MINOR(x)        (((x) % 1000000) / 10000)
 308 #define VERSION_PATCH(x)        (((x) % 10000) / 100)
 309 #define VERSION_BUILD(x)        ((x) % 100)
 310 #define VERSION_IDENT(a,b,c,d)  ((a) * 1000000 + (b) * 10000 + (c) * 100 + (d))
 311
 312
 313 /* macros for parent/child process identification */
 314 #if defined(PLATFORM_UNIX)
 315 #define IS_PARENT_PROCESS()     (audio.mixer_pid != getpid())
 316 #define IS_CHILD_PROCESS()      (audio.mixer_pid == getpid())
 317 #define HAS_CHILD_PROCESS()     (audio.mixer_pid > 0)
 318 #else
 319 #define IS_PARENT_PROCESS()     TRUE
 320 #define IS_CHILD_PROCESS()      FALSE
 321 #define HAS_CHILD_PROCESS()     FALSE
 322 #endif
 323
 324
 325 /* values for artwork type */
 326 #define ARTWORK_TYPE_GRAPHICS   0
 327 #define ARTWORK_TYPE_SOUNDS     1
 328 #define ARTWORK_TYPE_MUSIC      2
 329
 330 #define NUM_ARTWORK_TYPES       3
 331
 332
 333 /* values for tree type (chosen to match artwork type) */
 334 #define TREE_TYPE_UNDEFINED     -1
 335 #define TREE_TYPE_GRAPHICS_DIR  ARTWORK_TYPE_GRAPHICS
 336 #define TREE_TYPE_SOUNDS_DIR    ARTWORK_TYPE_SOUNDS
 337 #define TREE_TYPE_MUSIC_DIR     ARTWORK_TYPE_MUSIC
 338 #define TREE_TYPE_LEVEL_DIR     3
 339
 340 #define NUM_TREE_TYPES          4
 341
 342
 343 /* values for artwork handling */
 344 #define LEVELDIR_ARTWORK_SET_PTR(leveldir, type)                        \
 345                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
 346                                  &(leveldir)->graphics_set :            \
 347                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
 348                                  &(leveldir)->sounds_set :              \
 349                                  &(leveldir)->music_set)
 350
 351 #define LEVELDIR_ARTWORK_SET(leveldir, type)                            \
 352                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
 353                                  (leveldir)->graphics_set :             \
 354                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
 355                                  (leveldir)->sounds_set :               \
 356                                  (leveldir)->music_set)
 357
 358 #define LEVELDIR_ARTWORK_PATH_PTR(leveldir, type)                       \
 359                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
 360                                  &(leveldir)->graphics_path :           \
 361                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
 362                                  &(leveldir)->sounds_path :             \
 363                                  &(leveldir)->music_path)
 364
 365 #define LEVELDIR_ARTWORK_PATH(leveldir, type)                           \
 366                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
 367                                  (leveldir)->graphics_path :            \
 368                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
 369                                  (leveldir)->sounds_path :              \
 370                                  (leveldir)->music_path)
 371
 372 #define SETUP_ARTWORK_SET(setup, type)                                  \
 373                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
 374                                  (setup).graphics_set :                 \
 375                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
 376                                  (setup).sounds_set :                   \
 377                                  (setup).music_set)
 378
 379 #define SETUP_OVERRIDE_ARTWORK(setup, type)                             \
 380                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
 381                                  (setup).override_level_graphics :      \
 382                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
 383                                  (setup).override_level_sounds :        \
 384                                  (setup).override_level_music)
 385
 386 #define ARTWORK_FIRST_NODE(artwork, type)                               \
 387                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
 388                                  (artwork).gfx_first :  \
 389                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
 390                                  (artwork).snd_first :  \
 391                                  (artwork).mus_first)
 392
 393 #define ARTWORK_CURRENT_IDENTIFIER_PTR(artwork, type)                   \
 394                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
 395                                  &(artwork).gfx_current_identifier :    \
 396                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
 397                                  &(artwork).snd_current_identifier :    \
 398                                  &(artwork).mus_current_identifier)
 399
 400 #define ARTWORK_CURRENT_IDENTIFIER(artwork, type)                       \
 401                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
 402                                  (artwork).gfx_current_identifier :     \
 403                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
 404                                  (artwork).snd_current_identifier :     \
 405                                  (artwork).mus_current_identifier)
 406
 407 #define ARTWORKINFO_FILENAME(type)                                      \
 408                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
 409                                  GRAPHICSINFO_FILENAME :                \
 410                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
 411                                  SOUNDSINFO_FILENAME :                  \
 412                                  (type) == ARTWORK_TYPE_MUSIC ?         \
 413                                  MUSICINFO_FILENAME : "")
 414
 415 #define ARTWORK_DIRECTORY(type)                                         \
 416                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
 417                                  GRAPHICS_DIRECTORY :                   \
 418                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
 419                                  SOUNDS_DIRECTORY :                     \
 420                                  (type) == ARTWORK_TYPE_MUSIC ?         \
 421                                  MUSIC_DIRECTORY : "")
 422
 423 #define OPTIONS_ARTWORK_DIRECTORY(type)                                 \
 424                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
 425                                  options.graphics_directory :           \
 426                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
 427                                  options.sounds_directory :             \
 428                                  (type) == ARTWORK_TYPE_MUSIC ?         \
 429                                  options.music_directory : "")
 430
 431
 432 /* type definitions */
 433 typedef int (*EventFilter)(const Event *);
 434
 435
 436 /* structure definitions */
 437
 438 struct ProgramInfo
 439 {
 440   char *command_basepath;       /* directory that contains the program */
 441   char *command_basename;       /* base filename of the program binary */
 442   char *userdata_directory;     /* personal user data directory */
 443
 444   char *program_title;
 445   char *window_title;
 446   char *icon_title;
 447
 448   char *x11_icon_filename;
 449   char *x11_iconmask_filename;
 450   char *msdos_cursor_filename;
 451
 452   char *cookie_prefix;
 453   char *filename_prefix;        /* prefix to cut off from DOS filenames */
 454
 455   int version_major;
 456   int version_minor;
 457   int version_patch;
 458
 459   void (*exit_function)(int);
 460 };
 461
 462 struct OptionInfo
 463 {
 464   char *display_name;
 465   char *server_host;
 466   int server_port;
 467
 468   char *ro_base_directory;
 469   char *rw_base_directory;
 470   char *level_directory;
 471   char *graphics_directory;
 472   char *sounds_directory;
 473   char *music_directory;
 474   char *docs_directory;
 475   char *execute_command;
 476
 477   boolean serveronly;
 478   boolean network;
 479   boolean verbose;
 480   boolean debug;
 481 };
 482
 483 struct VideoSystemInfo
 484 {
 485   int default_depth;
 486   int width, height, depth;
 487   boolean fullscreen_available;
 488   boolean fullscreen_enabled;
 489 };
 490
 491 struct AudioSystemInfo
 492 {
 493   boolean sound_available;
 494   boolean loops_available;
 495   boolean music_available;
 496
 497   boolean sound_enabled;
 498   boolean sound_deactivated;    /* for temporarily disabling sound */
 499
 500   int mixer_pipe[2];
 501   int mixer_pid;
 502   char *device_name;
 503   int device_fd;
 504
 505   int num_channels;
 506   int music_channel;
 507   int first_sound_channel;
 508 };
 509
 510 struct FontBitmapInfo
 511 {
 512   Bitmap *bitmap;
 513   int src_x, src_y;             /* start position of animation frames */
 514   int width, height;            /* width/height of each animation frame */
 515   int draw_x, draw_y;           /* offset for drawing font characters */
 516   int num_chars;
 517   int num_chars_per_line;
 518
 519 #if defined(TARGET_X11_NATIVE_PERFORMANCE_WORKAROUND)
 520   Pixmap *clip_mask;            /* single-char-only clip mask array for X11 */
 521 #endif
 522 };
 523
 524 struct GfxInfo
 525 {
 526   int sx, sy;
 527   int sxsize, sysize;
 528   int real_sx, real_sy;
 529   int full_sxsize, full_sysize;
 530   int scrollbuffer_width, scrollbuffer_height;
 531
 532   int dx, dy;
 533   int dxsize, dysize;
 534
 535   int vx, vy;
 536   int vxsize, vysize;
 537
 538   int draw_deactivation_mask;
 539   int draw_background_mask;
 540
 541   Bitmap *field_save_buffer;
 542
 543   Bitmap *background_bitmap;
 544   int background_bitmap_mask;
 545
 546   int num_fonts;
 547   struct FontBitmapInfo *font_bitmap_info;
 548   int (*select_font_function)(int);
 549
 550   int anim_random_frame;
 551 };
 552
 553 struct JoystickInfo
 554 {
 555   int status;
 556   int fd[MAX_PLAYERS];          /* file descriptor of player's joystick */
 557 };
 558
 559 struct SetupJoystickInfo
 560 {
 561   char *device_name;            /* device name of player's joystick */
 562
 563   int xleft, xmiddle, xright;
 564   int yupper, ymiddle, ylower;
 565   int snap, drop;
 566 };
 567
 568 struct SetupKeyboardInfo
 569 {
 570   Key left, right, up, down;
 571   Key snap, drop;
 572 };
 573
 574 struct SetupInputInfo
 575 {
 576   boolean use_joystick;
 577   struct SetupJoystickInfo joy;
 578   struct SetupKeyboardInfo key;
 579 };
 580
 581 struct SetupEditorInfo
 582 {
 583   boolean el_boulderdash;
 584   boolean el_emerald_mine;
 585   boolean el_emerald_mine_club;
 586   boolean el_more;
 587   boolean el_sokoban;
 588   boolean el_supaplex;
 589   boolean el_diamond_caves;
 590   boolean el_dx_boulderdash;
 591   boolean el_chars;
 592   boolean el_custom;
 593   boolean el_user_defined;
 594   boolean el_dynamic;
 595
 596   boolean el_headlines;
 597 };
 598
 599 struct SetupEditorCascadeInfo
 600 {
 601   boolean el_bd;
 602   boolean el_em;
 603   boolean el_emc;
 604   boolean el_rnd;
 605   boolean el_sb;
 606   boolean el_sp;
 607   boolean el_dc;
 608   boolean el_dx;
 609   boolean el_chars;
 610   boolean el_ce;
 611   boolean el_ge;
 612   boolean el_user;
 613   boolean el_generic;
 614   boolean el_dynamic;
 615 };
 616
 617 struct SetupShortcutInfo
 618 {
 619   Key save_game;
 620   Key load_game;
 621   Key toggle_pause;
 622 };
 623
 624 struct SetupSystemInfo
 625 {
 626   char *sdl_audiodriver;
 627   int audio_fragment_size;
 628 };
 629
 630 struct SetupInfo
 631 {
 632   char *player_name;
 633
 634   boolean sound;
 635   boolean sound_loops;
 636   boolean sound_music;
 637   boolean sound_simple;
 638   boolean toons;
 639   boolean double_buffering;
 640   boolean direct_draw;          /* !double_buffering (redundant!) */
 641   boolean scroll_delay;
 642   boolean soft_scrolling;
 643   boolean fading;
 644   boolean autorecord;
 645   boolean quick_doors;
 646   boolean team_mode;
 647   boolean handicap;
 648   boolean skip_levels;
 649   boolean time_limit;
 650   boolean fullscreen;
 651   boolean ask_on_escape;
 652
 653   char *graphics_set;
 654   char *sounds_set;
 655   char *music_set;
 656   boolean override_level_graphics;
 657   boolean override_level_sounds;
 658   boolean override_level_music;
 659
 660   struct SetupEditorInfo editor;
 661   struct SetupEditorCascadeInfo editor_cascade;
 662   struct SetupShortcutInfo shortcut;
 663   struct SetupInputInfo input[MAX_PLAYERS];
 664   struct SetupSystemInfo system;
 665   struct OptionInfo options;
 666 };
 667
 668 struct TreeInfo
 669 {
 670   struct TreeInfo **node_top;           /* topmost node in tree */
 671   struct TreeInfo *node_parent;         /* parent level directory info */
 672   struct TreeInfo *node_group;          /* level group sub-directory info */
 673   struct TreeInfo *next;                /* next level series structure node */
 674
 675   int cl_first;         /* internal control field for setup screen */
 676   int cl_cursor;        /* internal control field for setup screen */
 677
 678   int type;             /* type of tree content */
 679
 680   /* fields for "type == TREE_TYPE_LEVEL_DIR" */
 681
 682   char *subdir;         /* tree info sub-directory basename (may be ".") */
 683   char *fullpath;       /* complete path relative to tree base directory */
 684   char *basepath;       /* absolute base path of tree base directory */
 685   char *identifier;     /* identifier string for configuration files */
 686   char *name;           /* tree info name, as displayed in selection menues */
 687   char *name_sorting;   /* optional sorting name for correct name sorting */
 688   char *author;         /* level or artwork author name */
 689   char *imported_from;  /* optional comment for imported levels or artwork */
 690   char *imported_by;    /* optional comment for imported levels or artwork */
 691
 692   char *graphics_set;   /* optional custom graphics set (level tree only) */
 693   char *sounds_set;     /* optional custom sounds set (level tree only) */
 694   char *music_set;      /* optional custom music set (level tree only) */
 695   char *graphics_path;  /* path to optional custom graphics set (level only) */
 696   char *sounds_path;    /* path to optional custom sounds set (level only) */
 697   char *music_path;     /* path to optional custom music set (level only) */
 698
 699   char *level_filename; /* filename of level file (for packed level file) */
 700   char *level_filetype; /* type of levels in level directory or level file */
 701
 702   int levels;           /* number of levels in level series */
 703   int first_level;      /* first level number (to allow start with 0 or 1) */
 704   int last_level;       /* last level number (automatically calculated) */
 705   int sort_priority;    /* sort levels by 'sort_priority' and then by name */
 706
 707   boolean latest_engine;/* force level set to use the latest game engine */
 708
 709   boolean level_group;  /* directory contains more level series directories */
 710   boolean parent_link;  /* entry links back to parent directory */
 711   boolean in_user_dir;  /* user defined levels are stored in home directory */
 712   boolean user_defined; /* levels in user directory and marked as "private" */
 713   boolean readonly;     /* readonly levels can not be changed with editor */
 714   boolean handicap;     /* level set has no handicap when set to "false" */
 715   boolean skip_levels;  /* levels can be skipped when set to "true" */
 716
 717   int color;            /* color to use on selection screen for this level */
 718   char *class_desc;     /* description of level series class */
 719   int handicap_level;   /* number of the lowest unsolved level */
 720 };
 721
 722 typedef struct TreeInfo TreeInfo;
 723 typedef struct TreeInfo LevelDirTree;
 724 typedef struct TreeInfo ArtworkDirTree;
 725 typedef struct TreeInfo GraphicsDirTree;
 726 typedef struct TreeInfo SoundsDirTree;
 727 typedef struct TreeInfo MusicDirTree;
 728
 729 struct ArtworkInfo
 730 {
 731   GraphicsDirTree *gfx_first;
 732   GraphicsDirTree *gfx_current;
 733   SoundsDirTree *snd_first;
 734   SoundsDirTree *snd_current;
 735   MusicDirTree *mus_first;
 736   MusicDirTree *mus_current;
 737
 738   char *gfx_current_identifier;
 739   char *snd_current_identifier;
 740   char *mus_current_identifier;
 741 };
 742
 743 struct ValueTextInfo
 744 {
 745   int value;
 746   char *text;
 747 };
 748
 749 struct ConfigInfo
 750 {
 751   char *token;
 752   char *value;
 753 };
 754
 755 struct ConfigTypeInfo
 756 {
 757   char *token;
 758   char *value;
 759   int type;
 760 };
 761
 762 struct TokenIntPtrInfo
 763 {
 764   char *token;
 765   int *value;
 766 };
 767
 768 struct FileInfo
 769 {
 770   char *token;
 771
 772   char *default_filename;
 773   char *filename;
 774
 775   char **default_parameter;                     /* array of file parameters */
 776   char **parameter;                             /* array of file parameters */
 777
 778   boolean redefined;
 779   boolean fallback_to_default;
 780 };
 781
 782 struct SetupFileList
 783 {
 784   char *token;
 785   char *value;
 786
 787   struct SetupFileList *next;
 788 };
 789
 790 struct ListNodeInfo
 791 {
 792   char *source_filename;                        /* primary key for node list */
 793   int num_references;
 794 };
 795
 796 struct PropertyMapping
 797 {
 798   int base_index;
 799   int ext1_index;
 800   int ext2_index;
 801   int ext3_index;
 802
 803   int artwork_index;
 804 };
 805
 806 struct ArtworkListInfo
 807 {
 808   int type;                                     /* type of artwork */
 809
 810   int num_file_list_entries;
 811   int num_dynamic_file_list_entries;
 812   struct FileInfo *file_list;                   /* static artwork file array */
 813   struct FileInfo *dynamic_file_list;           /* dynamic artwrk file array */
 814
 815   int num_suffix_list_entries;
 816   struct ConfigTypeInfo *suffix_list;           /* parameter suffixes array */
 817
 818   int num_base_prefixes;
 819   int num_ext1_suffixes;
 820   int num_ext2_suffixes;
 821   int num_ext3_suffixes;
 822   char **base_prefixes;                         /* base token prefixes array */
 823   char **ext1_suffixes;                         /* property suffixes array 1 */
 824   char **ext2_suffixes;                         /* property suffixes array 2 */
 825   char **ext3_suffixes;                         /* property suffixes array 3 */
 826
 827   int num_ignore_tokens;
 828   char **ignore_tokens;                         /* file tokens to be ignored */
 829
 830   int num_property_mapping_entries;
 831   struct PropertyMapping *property_mapping;     /* mapping token -> artwork */
 832
 833   int sizeof_artwork_list_entry;
 834
 835   struct ListNodeInfo **artwork_list;           /* static artwork node array */
 836   struct ListNodeInfo **dynamic_artwork_list;   /* dynamic artwrk node array */
 837   struct ListNode *content_list;                /* dynamic artwork node list */
 838
 839   void *(*load_artwork)(char *);                /* constructor function */
 840   void (*free_artwork)(void *);                 /* destructor function */
 841 };
 842
 843
 844 /* ========================================================================= */
 845 /* exported variables                                                        */
 846 /* ========================================================================= */
 847
 848 extern struct ProgramInfo       program;
 849 extern struct OptionInfo        options;
 850 extern struct VideoSystemInfo   video;
 851 extern struct AudioSystemInfo   audio;
 852 extern struct GfxInfo           gfx;
 853 extern struct AnimInfo          anim;
 854 extern struct ArtworkInfo       artwork;
 855 extern struct JoystickInfo      joystick;
 856 extern struct SetupInfo         setup;
 857
 858 extern LevelDirTree            *leveldir_first;
 859 extern LevelDirTree            *leveldir_current;
 860 extern int                      level_nr;
 861
 862 extern Display                 *display;
 863 extern Visual                  *visual;
 864 extern int                      screen;
 865 extern Colormap                 cmap;
 866
 867 extern DrawWindow              *window;
 868 extern DrawBuffer              *backbuffer;
 869 extern DrawBuffer              *drawto;
 870
 871 extern int                      button_status;
 872 extern boolean                  motion_status;
 873
 874 extern int                      redraw_mask;
 875 extern int                      redraw_tiles;
 876
 877 extern int                      FrameCounter;
 878
 879
 880 /* function definitions */
 881
 882 void InitProgramInfo(char *, char *, char *, char *, char *, char *, char *,
 883                      char *, char *, char *, int);
 884
 885 void InitExitFunction(void (*exit_function)(int));
 886 void InitPlatformDependentStuff(void);
 887 void ClosePlatformDependentStuff(void);
 888
 889 void InitGfxFieldInfo(int, int, int, int, int, int, int, int, Bitmap *);
 890 void InitGfxDoor1Info(int, int, int, int);
 891 void InitGfxDoor2Info(int, int, int, int);
 892 void InitGfxScrollbufferInfo(int, int);
 893 void SetDrawDeactivationMask(int);
 894 void SetDrawBackgroundMask(int);
 895 void SetMainBackgroundBitmap(Bitmap *);
 896 void SetDoorBackgroundBitmap(Bitmap *);
 897
 898 inline void InitVideoDisplay(void);
 899 inline void CloseVideoDisplay(void);
 900 inline void InitVideoBuffer(DrawBuffer **,DrawWindow **, int,int,int, boolean);
 901 inline Bitmap *CreateBitmapStruct(void);
 902 inline Bitmap *CreateBitmap(int, int, int);
 903 inline void FreeBitmap(Bitmap *);
 904 inline void BlitBitmap(Bitmap *, Bitmap *, int, int, int, int, int, int);
 905 inline void FillRectangle(Bitmap *, int, int, int, int, Pixel);
 906 inline void ClearRectangle(Bitmap *, int, int, int, int);
 907 inline void ClearRectangleOnBackground(Bitmap *, int, int, int, int);
 908 inline void SetClipMask(Bitmap *, GC, Pixmap);
 909 inline void SetClipOrigin(Bitmap *, GC, int, int);
 910 inline void BlitBitmapMasked(Bitmap *, Bitmap *, int, int, int, int, int, int);
 911 inline boolean DrawingOnBackground(int, int);
 912 inline void BlitBitmapOnBackground(Bitmap *, Bitmap *, int, int, int, int, int,
 913                                    int);
 914 inline void DrawSimpleBlackLine(Bitmap *, int, int, int, int);
 915 inline void DrawSimpleWhiteLine(Bitmap *, int, int, int, int);
 916 inline void DrawLines(Bitmap *, struct XY *, int, Pixel);
 917 inline Pixel GetPixel(Bitmap *, int, int);
 918 inline Pixel GetPixelFromRGB(Bitmap *, unsigned int,unsigned int,unsigned int);
 919 inline Pixel GetPixelFromRGBcompact(Bitmap *, unsigned int);
 920
 921 inline void FlushDisplay(void);
 922 inline void SyncDisplay(void);
 923 inline void KeyboardAutoRepeatOn(void);
 924 inline void KeyboardAutoRepeatOff(void);
 925 inline boolean PointerInWindow(DrawWindow *);
 926 inline boolean SetVideoMode(boolean);
 927 inline boolean ChangeVideoModeIfNeeded(boolean);
 928
 929 Bitmap *LoadImage(char *);
 930 Bitmap *LoadCustomImage(char *);
 931 void ReloadCustomImage(Bitmap *, char *);
 932
 933 Bitmap *ZoomBitmap(Bitmap *, int, int);
 934 void CreateBitmapWithSmallBitmaps(Bitmap *, int);
 935
 936 void SetMouseCursor(int);
 937
 938 inline void OpenAudio(void);
 939 inline void CloseAudio(void);
 940 inline void SetAudioMode(boolean);
 941
 942 inline void InitEventFilter(EventFilter);
 943 inline boolean PendingEvent(void);
 944 inline void NextEvent(Event *event);
 945 inline void PeekEvent(Event *event);
 946 inline Key GetEventKey(KeyEvent *, boolean);
 947 inline KeyMod HandleKeyModState(Key, int);
 948 inline KeyMod GetKeyModState();
 949 inline boolean CheckCloseWindowEvent(ClientMessageEvent *);
 950
 951 inline void InitJoysticks();
 952 inline boolean ReadJoystick(int, int *, int *, boolean *, boolean *);
 953
 954 #endif /* SYSTEM_H */