src/libgame/system.h

   1 /***********************************************************
   2 * Artsoft Retro-Game Library                               *
   3 *----------------------------------------------------------*
   4 * (c) 1994-2006 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 #define CREATE_SPECIAL_EDITION          FALSE
  52 #define CREATE_SPECIAL_EDITION_RND_JUE  FALSE
  53
  54 /* default input keys */
  55 #define DEFAULT_KEY_LEFT                KSYM_Left
  56 #define DEFAULT_KEY_RIGHT               KSYM_Right
  57 #define DEFAULT_KEY_UP                  KSYM_Up
  58 #define DEFAULT_KEY_DOWN                KSYM_Down
  59 #if defined(PLATFORM_MACOSX)
  60 #define DEFAULT_KEY_SNAP                KSYM_Control_L
  61 #define DEFAULT_KEY_DROP                KSYM_KP_Enter
  62 #else
  63 #define DEFAULT_KEY_SNAP                KSYM_Control_L
  64 #define DEFAULT_KEY_DROP                KSYM_Control_R
  65 #endif
  66 #define DEFAULT_KEY_OKAY                KSYM_Return
  67 #define DEFAULT_KEY_CANCEL              KSYM_Escape
  68
  69 /* default shortcut keys */
  70 #define DEFAULT_KEY_SAVE_GAME           KSYM_F1
  71 #define DEFAULT_KEY_LOAD_GAME           KSYM_F2
  72 #define DEFAULT_KEY_TOGGLE_PAUSE        KSYM_space
  73 #define DEFAULT_KEY_FOCUS_PLAYER_1      KSYM_F5
  74 #define DEFAULT_KEY_FOCUS_PLAYER_2      KSYM_F6
  75 #define DEFAULT_KEY_FOCUS_PLAYER_3      KSYM_F7
  76 #define DEFAULT_KEY_FOCUS_PLAYER_4      KSYM_F8
  77 #define DEFAULT_KEY_FOCUS_PLAYER_ALL    KSYM_F9
  78
  79 /* values for key_status */
  80 #define KEY_NOT_PRESSED                 FALSE
  81 #define KEY_RELEASED                    FALSE
  82 #define KEY_PRESSED                     TRUE
  83
  84 /* values for button status */
  85 #define MB_NOT_PRESSED                  FALSE
  86 #define MB_NOT_RELEASED                 TRUE
  87 #define MB_RELEASED                     FALSE
  88 #define MB_PRESSED                      TRUE
  89 #define MB_MENU_CHOICE                  FALSE
  90 #define MB_MENU_MARK                    TRUE
  91 #define MB_MENU_INITIALIZE              (-1)
  92 #define MB_MENU_LEAVE                   (-2)
  93 #define MB_LEFTBUTTON                   1
  94 #define MB_MIDDLEBUTTON                 2
  95 #define MB_RIGHTBUTTON                  3
  96 #define MB_WHEEL_UP                     4
  97 #define MB_WHEEL_DOWN                   5
  98 #define MB_WHEEL_LEFT                   6
  99 #define MB_WHEEL_RIGHT                  7
 100 #define IS_WHEEL_BUTTON_VERTICAL(b)     ((b) >= MB_WHEEL_UP &&          \
 101                                          (b) <= MB_WHEEL_DOWN)
 102 #define IS_WHEEL_BUTTON_HORIZONTAL(b)   ((b) >= MB_WHEEL_LEFT &&        \
 103                                          (b) <= MB_WHEEL_RIGHT)
 104 #define IS_WHEEL_BUTTON(b)              ((b) >= MB_WHEEL_UP &&          \
 105                                          (b) <= MB_WHEEL_DOWN)
 106 #define DEFAULT_WHEEL_STEPS             3
 107
 108 /* values for move directions */
 109 #define MV_BIT_LEFT                     0
 110 #define MV_BIT_RIGHT                    1
 111 #define MV_BIT_UP                       2
 112 #define MV_BIT_DOWN                     3
 113
 114 #define NUM_DIRECTIONS                  4
 115
 116 /* diagonal movement directions are used in a different contect than buttons */
 117 #define MV_BIT_UPLEFT                   4
 118 #define MV_BIT_UPRIGHT                  5
 119 #define MV_BIT_DOWNLEFT                 6
 120 #define MV_BIT_DOWNRIGHT                7
 121
 122 #define NUM_DIRECTIONS_FULL             8
 123
 124 /* values for special "button" bitmasks */
 125 #define BUTTON_1                        4
 126 #define BUTTON_2                        5
 127
 128 /* values for special "focus player" bitmasks */
 129 #define BIT_SET_FOCUS                   6
 130
 131 /* values for move directions and special "button" key bitmasks */
 132 #define MV_NONE                 0
 133 #define MV_LEFT                 (1 << MV_BIT_LEFT)
 134 #define MV_RIGHT                (1 << MV_BIT_RIGHT)
 135 #define MV_UP                   (1 << MV_BIT_UP)
 136 #define MV_DOWN                 (1 << MV_BIT_DOWN)
 137
 138 #define MV_UPLEFT               (MV_UP   | MV_LEFT)
 139 #define MV_UPRIGHT              (MV_UP   | MV_RIGHT)
 140 #define MV_DOWNLEFT             (MV_DOWN | MV_LEFT)
 141 #define MV_DOWNRIGHT            (MV_DOWN | MV_RIGHT)
 142
 143 #define MV_HORIZONTAL           (MV_LEFT | MV_RIGHT)
 144 #define MV_VERTICAL             (MV_UP   | MV_DOWN)
 145 #define MV_ALL_DIRECTIONS       (MV_LEFT | MV_RIGHT | MV_UP | MV_DOWN)
 146 #define MV_ANY_DIRECTION        (MV_ALL_DIRECTIONS)
 147 #define MV_NO_DIRECTION         (MV_NONE)
 148
 149 #define KEY_BUTTON_1            (1 << BUTTON_1)
 150 #define KEY_BUTTON_2            (1 << BUTTON_2)
 151 #define KEY_MOTION              (MV_LEFT | MV_RIGHT | MV_UP | MV_DOWN)
 152 #define KEY_BUTTON              (KEY_BUTTON_1 | KEY_BUTTON_2)
 153 #define KEY_ACTION              (KEY_MOTION | KEY_BUTTON)
 154
 155 #define KEY_SET_FOCUS           (1 << BIT_SET_FOCUS)
 156
 157 #define MV_DIR_FROM_BIT(x)      ((x) < NUM_DIRECTIONS ? 1 << (x) :        \
 158                                  (x) == MV_BIT_UPLEFT    ? MV_UPLEFT    : \
 159                                  (x) == MV_BIT_UPRIGHT   ? MV_UPRIGHT   : \
 160                                  (x) == MV_BIT_DOWNLEFT  ? MV_DOWNLEFT  : \
 161                                  (x) == MV_BIT_DOWNRIGHT ? MV_DOWNRIGHT : \
 162                                  MV_NONE)
 163
 164 #define MV_DIR_TO_BIT(x)        ((x) == MV_LEFT      ? MV_BIT_LEFT      : \
 165                                  (x) == MV_RIGHT     ? MV_BIT_RIGHT     : \
 166                                  (x) == MV_UP        ? MV_BIT_UP        : \
 167                                  (x) == MV_DOWN      ? MV_BIT_DOWN      : \
 168                                  (x) == MV_UPLEFT    ? MV_BIT_UPLEFT    : \
 169                                  (x) == MV_UPRIGHT   ? MV_BIT_UPRIGHT   : \
 170                                  (x) == MV_DOWNLEFT  ? MV_BIT_DOWNLEFT  : \
 171                                  (x) == MV_DOWNRIGHT ? MV_BIT_DOWNRIGHT : \
 172                                  MV_BIT_DOWN)
 173
 174 #define MV_DIR_OPPOSITE(x)      ((x) == MV_LEFT      ? MV_RIGHT     : \
 175                                  (x) == MV_RIGHT     ? MV_LEFT      : \
 176                                  (x) == MV_UP        ? MV_DOWN      : \
 177                                  (x) == MV_DOWN      ? MV_UP        : \
 178                                  (x) == MV_UPLEFT    ? MV_DOWNRIGHT : \
 179                                  (x) == MV_UPRIGHT   ? MV_DOWNLEFT  : \
 180                                  (x) == MV_DOWNLEFT  ? MV_UPRIGHT   : \
 181                                  (x) == MV_DOWNRIGHT ? MV_UPLEFT    : \
 182                                  MV_NONE)
 183
 184 /* values for animation mode (frame order and direction) */
 185 #define ANIM_NONE               0
 186 #define ANIM_LOOP               (1 << 0)
 187 #define ANIM_LINEAR             (1 << 1)
 188 #define ANIM_PINGPONG           (1 << 2)
 189 #define ANIM_PINGPONG2          (1 << 3)
 190 #define ANIM_RANDOM             (1 << 4)
 191 #define ANIM_CE_VALUE           (1 << 5)
 192 #define ANIM_CE_SCORE           (1 << 6)
 193 #define ANIM_CE_DELAY           (1 << 7)
 194 #define ANIM_REVERSE            (1 << 8)
 195 #define ANIM_OPAQUE_PLAYER      (1 << 9)
 196
 197 /* values for special (non game element) animation modes */
 198 #define ANIM_HORIZONTAL         (1 << 10)
 199 #define ANIM_VERTICAL           (1 << 11)
 200 #define ANIM_CENTERED           (1 << 12)
 201 #define ANIM_STATIC_PANEL       (1 << 13)
 202
 203 #define ANIM_DEFAULT            ANIM_LOOP
 204
 205 /* values for fade mode */
 206 #define FADE_TYPE_NONE          0
 207 #define FADE_TYPE_FADE_IN       (1 << 0)
 208 #define FADE_TYPE_FADE_OUT      (1 << 1)
 209 #define FADE_TYPE_TRANSFORM     (1 << 2)
 210 #define FADE_TYPE_CROSSFADE     (1 << 3)
 211 #define FADE_TYPE_MELT          (1 << 4)
 212 #define FADE_TYPE_SKIP          (1 << 5)
 213
 214 #define FADE_MODE_NONE          (FADE_TYPE_NONE)
 215 #define FADE_MODE_FADE_IN       (FADE_TYPE_FADE_IN)
 216 #define FADE_MODE_FADE_OUT      (FADE_TYPE_FADE_OUT)
 217 #define FADE_MODE_FADE          (FADE_TYPE_FADE_IN | FADE_TYPE_FADE_OUT)
 218 #define FADE_MODE_TRANSFORM     (FADE_TYPE_TRANSFORM | FADE_TYPE_FADE_IN)
 219 #define FADE_MODE_CROSSFADE     (FADE_MODE_TRANSFORM | FADE_TYPE_CROSSFADE)
 220 #define FADE_MODE_MELT          (FADE_MODE_TRANSFORM | FADE_TYPE_MELT)
 221 #define FADE_MODE_SKIP_FADE_IN  (FADE_TYPE_SKIP | FADE_TYPE_FADE_IN)
 222 #define FADE_MODE_SKIP_FADE_OUT (FADE_TYPE_SKIP | FADE_TYPE_FADE_OUT)
 223
 224 #define FADE_MODE_DEFAULT       FADE_MODE_FADE
 225
 226 /* values for text alignment */
 227 #define ALIGN_LEFT              (1 << 0)
 228 #define ALIGN_RIGHT             (1 << 1)
 229 #define ALIGN_CENTER            (1 << 2)
 230 #define ALIGN_DEFAULT           ALIGN_LEFT
 231
 232 #define VALIGN_TOP              (1 << 0)
 233 #define VALIGN_BOTTOM           (1 << 1)
 234 #define VALIGN_MIDDLE           (1 << 2)
 235 #define VALIGN_DEFAULT          VALIGN_TOP
 236
 237 #define ALIGNED_XPOS(x,w,a)     ((a) == ALIGN_CENTER  ? (x) - (w) / 2 : \
 238                                  (a) == ALIGN_RIGHT   ? (x) - (w) : (x))
 239 #define ALIGNED_YPOS(y,h,v)     ((v) == VALIGN_MIDDLE ? (y) - (h) / 2 : \
 240                                  (v) == VALIGN_BOTTOM ? (y) - (h) : (y))
 241 #define ALIGNED_TEXT_XPOS(p)    ALIGNED_XPOS((p)->x, (p)->width,  (p)->align)
 242 #define ALIGNED_TEXT_YPOS(p)    ALIGNED_YPOS((p)->y, (p)->height, (p)->valign)
 243
 244 /* values for redraw_mask */
 245 #define REDRAW_NONE             (0)
 246 #define REDRAW_ALL              (1 << 0)
 247 #define REDRAW_FIELD            (1 << 1)
 248 #define REDRAW_TILES            (1 << 2)
 249 #define REDRAW_DOOR_1           (1 << 3)
 250 #define REDRAW_VIDEO_1          (1 << 4)
 251 #define REDRAW_VIDEO_2          (1 << 5)
 252 #define REDRAW_VIDEO_3          (1 << 6)
 253 #define REDRAW_MICROLEVEL       (1 << 7)
 254 #define REDRAW_MICROLABEL       (1 << 8)
 255 #define REDRAW_FROM_BACKBUFFER  (1 << 9)
 256 #define REDRAW_DOOR_2           (REDRAW_VIDEO_1 | \
 257                                  REDRAW_VIDEO_2 | \
 258                                  REDRAW_VIDEO_3)
 259 #define REDRAW_DOOR_3           (1 << 10)
 260 #define REDRAW_DOORS            (REDRAW_DOOR_1 | \
 261                                  REDRAW_DOOR_2 | \
 262                                  REDRAW_DOOR_3)
 263 #define REDRAW_MAIN             (REDRAW_FIELD | \
 264                                  REDRAW_TILES | \
 265                                  REDRAW_MICROLEVEL)
 266 #define REDRAW_FPS              (1 << 11)
 267 #define REDRAWTILES_THRESHOLD   (SCR_FIELDX * SCR_FIELDY / 2)
 268
 269 #define IN_GFX_SCREEN(x, y)     (x >= gfx.sx && x < gfx.sx + gfx.sxsize && \
 270                                  y >= gfx.sy && y < gfx.sy + gfx.sysize)
 271 #define IN_GFX_DOOR(x, y)       (x >= gfx.dx && x < gfx.dx + gfx.dxsize && \
 272                                  y >= gfx.dy && y < gfx.dy + gfx.dysize)
 273 #define IN_GFX_VIDEO(x, y)      (x >= gfx.vx && x < gfx.vx + gfx.vxsize && \
 274                                  y >= gfx.vy && y < gfx.vy + gfx.vysize)
 275
 276 /* values for mouse cursor */
 277 #define CURSOR_DEFAULT          0
 278 #define CURSOR_NONE             1
 279 #define CURSOR_PLAYFIELD        2
 280
 281 /* fundamental game speed values */
 282 #define ONE_SECOND_DELAY        1000    /* delay value for one second */
 283 #define GAME_FRAME_DELAY        20      /* frame delay in milliseconds */
 284 #define FFWD_FRAME_DELAY        10      /* 200% speed for fast forward */
 285 #define FRAMES_PER_SECOND       (ONE_SECOND_DELAY / GAME_FRAME_DELAY)
 286
 287 /* maximum playfield size supported by libgame functions */
 288 #define MAX_PLAYFIELD_WIDTH     128
 289 #define MAX_PLAYFIELD_HEIGHT    128
 290
 291 /* maximum number of parallel players supported by libgame functions */
 292 #define MAX_PLAYERS             4
 293
 294 /* maximum allowed length of player name */
 295 #define MAX_PLAYER_NAME_LEN     10
 296
 297 /* default name for empty highscore entry */
 298 #define EMPTY_PLAYER_NAME       "no name"
 299
 300 /* default name for unknown player names */
 301 #define ANONYMOUS_NAME          "anonymous"
 302
 303 /* default for other unknown names */
 304 #define UNKNOWN_NAME            "unknown"
 305
 306 /* default name for new levels */
 307 #define NAMELESS_LEVEL_NAME     "nameless level"
 308
 309 /* default text for non-existant artwork */
 310 #define NOT_AVAILABLE           "(not available)"
 311
 312 /* default value for undefined filename */
 313 #define UNDEFINED_FILENAME      "[NONE]"
 314
 315 /* default value for undefined parameter */
 316 #define ARG_DEFAULT             "[DEFAULT]"
 317
 318 /* default values for undefined configuration file parameters */
 319 #define ARG_UNDEFINED           "-1000000"
 320 #define ARG_UNDEFINED_VALUE     (atoi(ARG_UNDEFINED))
 321
 322 /* definitions for game sub-directories */
 323 #ifndef RO_GAME_DIR
 324 #define RO_GAME_DIR             "."
 325 #endif
 326
 327 #ifndef RW_GAME_DIR
 328 #define RW_GAME_DIR             "."
 329 #endif
 330
 331 #define RO_BASE_PATH            RO_GAME_DIR
 332 #define RW_BASE_PATH            RW_GAME_DIR
 333
 334 /* directory names */
 335 #define GRAPHICS_DIRECTORY      "graphics"
 336 #define SOUNDS_DIRECTORY        "sounds"
 337 #define MUSIC_DIRECTORY         "music"
 338 #define LEVELS_DIRECTORY        "levels"
 339 #define TAPES_DIRECTORY         "tapes"
 340 #define SCORES_DIRECTORY        "scores"
 341 #define DOCS_DIRECTORY          "docs"
 342 #define CACHE_DIRECTORY         "cache"
 343
 344 #if !defined(PLATFORM_MSDOS)
 345 #if CREATE_SPECIAL_EDITION_RND_JUE
 346 #define GFX_CLASSIC_SUBDIR      "jue0"
 347 #define SND_CLASSIC_SUBDIR      "jue0"
 348 #define MUS_CLASSIC_SUBDIR      "jue0"
 349 #else
 350 #define GFX_CLASSIC_SUBDIR      "gfx_classic"
 351 #define SND_CLASSIC_SUBDIR      "snd_classic"
 352 #define MUS_CLASSIC_SUBDIR      "mus_classic"
 353 #endif
 354 #else
 355 #define GFX_CLASSIC_SUBDIR      "gfx_orig"
 356 #define SND_CLASSIC_SUBDIR      "snd_orig"
 357 #define MUS_CLASSIC_SUBDIR      "mus_orig"
 358 #endif
 359
 360 #if CREATE_SPECIAL_EDITION
 361 #define GFX_FALLBACK_FILENAME   "fallback.pcx"
 362 #define SND_FALLBACK_FILENAME   "fallback.wav"
 363 #define MUS_FALLBACK_FILENAME   "fallback.wav"
 364 #endif
 365
 366 /* file names and filename extensions */
 367 #if !defined(PLATFORM_MSDOS)
 368 #define LEVELSETUP_DIRECTORY    "levelsetup"
 369 #define SETUP_FILENAME          "setup.conf"
 370 #define LEVELSETUP_FILENAME     "levelsetup.conf"
 371 #define EDITORSETUP_FILENAME    "editorsetup.conf"
 372 #define EDITORCASCADE_FILENAME  "editorcascade.conf"
 373 #define HELPANIM_FILENAME       "helpanim.conf"
 374 #define HELPTEXT_FILENAME       "helptext.conf"
 375 #define LEVELINFO_FILENAME      "levelinfo.conf"
 376 #define GRAPHICSINFO_FILENAME   "graphicsinfo.conf"
 377 #define SOUNDSINFO_FILENAME     "soundsinfo.conf"
 378 #define MUSICINFO_FILENAME      "musicinfo.conf"
 379 #define ARTWORKINFO_CACHE_FILE  "artworkinfo.cache"
 380 #define LEVELFILE_EXTENSION     "level"
 381 #define TAPEFILE_EXTENSION      "tape"
 382 #define SCOREFILE_EXTENSION     "score"
 383 #else
 384 #define LEVELSETUP_DIRECTORY    "lvlsetup"
 385 #define SETUP_FILENAME          "setup.cnf"
 386 #define LEVELSETUP_FILENAME     "lvlsetup.cnf"
 387 #define EDITORSETUP_FILENAME    "edsetup.cnf"
 388 #define EDITORCASCADE_FILENAME  "edcascad.conf"
 389 #define HELPANIM_FILENAME       "helpanim.cnf"
 390 #define HELPTEXT_FILENAME       "helptext.cnf"
 391 #define LEVELINFO_FILENAME      "lvlinfo.cnf"
 392 #define GRAPHICSINFO_FILENAME   "gfxinfo.cnf"
 393 #define SOUNDSINFO_FILENAME     "sndinfo.cnf"
 394 #define MUSICINFO_FILENAME      "musinfo.cnf"
 395 #define ARTWORKINFO_CACHE_FILE  "artinfo.cac"
 396 #define LEVELFILE_EXTENSION     "lvl"
 397 #define TAPEFILE_EXTENSION      "tap"
 398 #define SCOREFILE_EXTENSION     "sco"
 399 #endif
 400
 401 #define ERROR_BASENAME          "stderr.txt"
 402
 403 #define CHAR_PATH_SEPARATOR_UNIX        '/'
 404 #define CHAR_PATH_SEPARATOR_DOS         '\\'
 405
 406 #define STRING_PATH_SEPARATOR_UNIX      "/"
 407 #define STRING_PATH_SEPARATOR_DOS       "\\"
 408
 409 #define STRING_NEWLINE_UNIX             "\n"
 410 #define STRING_NEWLINE_DOS              "\r\n"
 411
 412 #if defined(PLATFORM_WIN32) || defined(PLATFORM_MSDOS)
 413 #define CHAR_PATH_SEPARATOR     CHAR_PATH_SEPARATOR_DOS
 414 #define STRING_PATH_SEPARATOR   STRING_PATH_SEPARATOR_DOS
 415 #define STRING_NEWLINE          STRING_NEWLINE_DOS
 416 #else
 417 #define CHAR_PATH_SEPARATOR     CHAR_PATH_SEPARATOR_UNIX
 418 #define STRING_PATH_SEPARATOR   STRING_PATH_SEPARATOR_UNIX
 419 #define STRING_NEWLINE          STRING_NEWLINE_UNIX
 420 #endif
 421
 422
 423 /* areas in bitmap PIX_DOOR */
 424 /* meaning in PIX_DB_DOOR: (3 PAGEs)
 425    PAGEX1: 1. buffer for DOOR_1
 426    PAGEX2: 2. buffer for DOOR_1
 427    PAGEX3: buffer for animations
 428 */
 429
 430 /* these values are hard-coded to be able to use them in initialization */
 431 #define DOOR_GFX_PAGE_WIDTH     100     /* should be set to "gfx.dxsize" */
 432 #define DOOR_GFX_PAGE_HEIGHT    280     /* should be set to "gfx.dysize" */
 433
 434 #define DOOR_GFX_PAGESIZE       (DOOR_GFX_PAGE_WIDTH)
 435 #define DOOR_GFX_PAGEX1         (0 * DOOR_GFX_PAGESIZE)
 436 #define DOOR_GFX_PAGEX2         (1 * DOOR_GFX_PAGESIZE)
 437 #define DOOR_GFX_PAGEX3         (2 * DOOR_GFX_PAGESIZE)
 438 #define DOOR_GFX_PAGEX4         (3 * DOOR_GFX_PAGESIZE)
 439 #define DOOR_GFX_PAGEX5         (4 * DOOR_GFX_PAGESIZE)
 440 #define DOOR_GFX_PAGEX6         (5 * DOOR_GFX_PAGESIZE)
 441 #define DOOR_GFX_PAGEX7         (6 * DOOR_GFX_PAGESIZE)
 442 #define DOOR_GFX_PAGEX8         (7 * DOOR_GFX_PAGESIZE)
 443 #define DOOR_GFX_PAGEY1         (0)
 444 #define DOOR_GFX_PAGEY2         (DOOR_GFX_PAGE_HEIGHT)
 445
 446
 447 /* macros for version handling */
 448 #define VERSION_MAJOR(x)        ((x) / 1000000)
 449 #define VERSION_MINOR(x)        (((x) % 1000000) / 10000)
 450 #define VERSION_PATCH(x)        (((x) % 10000) / 100)
 451 #define VERSION_BUILD(x)        ((x) % 100)
 452 #define VERSION_IDENT(a,b,c,d)  ((a) * 1000000 + (b) * 10000 + (c) * 100 + (d))
 453
 454
 455 /* macros for parent/child process identification */
 456 #if defined(PLATFORM_UNIX)
 457 #define IS_PARENT_PROCESS()     (audio.mixer_pid != getpid())
 458 #define IS_CHILD_PROCESS()      (audio.mixer_pid == getpid())
 459 #define HAS_CHILD_PROCESS()     (audio.mixer_pid > 0)
 460 #else
 461 #define IS_PARENT_PROCESS()     TRUE
 462 #define IS_CHILD_PROCESS()      FALSE
 463 #define HAS_CHILD_PROCESS()     FALSE
 464 #endif
 465
 466
 467 /* values for artwork type */
 468 #define ARTWORK_TYPE_GRAPHICS   0
 469 #define ARTWORK_TYPE_SOUNDS     1
 470 #define ARTWORK_TYPE_MUSIC      2
 471
 472 #define NUM_ARTWORK_TYPES       3
 473
 474
 475 /* values for tree type (chosen to match artwork type) */
 476 #define TREE_TYPE_UNDEFINED     -1
 477 #define TREE_TYPE_GRAPHICS_DIR  ARTWORK_TYPE_GRAPHICS
 478 #define TREE_TYPE_SOUNDS_DIR    ARTWORK_TYPE_SOUNDS
 479 #define TREE_TYPE_MUSIC_DIR     ARTWORK_TYPE_MUSIC
 480 #define TREE_TYPE_LEVEL_DIR     3
 481
 482 #define NUM_TREE_TYPES          4
 483
 484 #define INFOTEXT_UNDEFINED      ""
 485 #define INFOTEXT_GRAPHICS_DIR   "Custom Graphics"
 486 #define INFOTEXT_SOUNDS_DIR     "Custom Sounds"
 487 #define INFOTEXT_MUSIC_DIR      "Custom Music"
 488 #define INFOTEXT_LEVEL_DIR      "Level Sets"
 489
 490 #define TREE_INFOTEXT(t)        ((t) == TREE_TYPE_LEVEL_DIR ?           \
 491                                  INFOTEXT_LEVEL_DIR :                   \
 492                                  (t) == TREE_TYPE_GRAPHICS_DIR ?        \
 493                                  INFOTEXT_GRAPHICS_DIR :                \
 494                                  (t) == TREE_TYPE_SOUNDS_DIR ?          \
 495                                  INFOTEXT_SOUNDS_DIR :                  \
 496                                  (t) == TREE_TYPE_MUSIC_DIR ?           \
 497                                  INFOTEXT_MUSIC_DIR :                   \
 498                                  INFOTEXT_UNDEFINED)
 499
 500 /* values for artwork handling */
 501 #define LEVELDIR_ARTWORK_SET_PTR(leveldir, type)                        \
 502                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
 503                                  &(leveldir)->graphics_set :            \
 504                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
 505                                  &(leveldir)->sounds_set :              \
 506                                  &(leveldir)->music_set)
 507
 508 #define LEVELDIR_ARTWORK_SET(leveldir, type)                            \
 509                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
 510                                  (leveldir)->graphics_set :             \
 511                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
 512                                  (leveldir)->sounds_set :               \
 513                                  (leveldir)->music_set)
 514
 515 #define LEVELDIR_ARTWORK_PATH_PTR(leveldir, type)                       \
 516                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
 517                                  &(leveldir)->graphics_path :           \
 518                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
 519                                  &(leveldir)->sounds_path :             \
 520                                  &(leveldir)->music_path)
 521
 522 #define LEVELDIR_ARTWORK_PATH(leveldir, type)                           \
 523                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
 524                                  (leveldir)->graphics_path :            \
 525                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
 526                                  (leveldir)->sounds_path :              \
 527                                  (leveldir)->music_path)
 528
 529 #define SETUP_ARTWORK_SET(setup, type)                                  \
 530                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
 531                                  (setup).graphics_set :                 \
 532                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
 533                                  (setup).sounds_set :                   \
 534                                  (setup).music_set)
 535
 536 #define SETUP_OVERRIDE_ARTWORK(setup, type)                             \
 537                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
 538                                  (setup).override_level_graphics :      \
 539                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
 540                                  (setup).override_level_sounds :        \
 541                                  (setup).override_level_music)
 542
 543 #define ARTWORK_FIRST_NODE(artwork, type)                               \
 544                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
 545                                  (artwork).gfx_first :                  \
 546                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
 547                                  (artwork).snd_first :                  \
 548                                  (artwork).mus_first)
 549
 550 #define ARTWORK_CURRENT_IDENTIFIER_PTR(artwork, type)                   \
 551                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
 552                                  &(artwork).gfx_current_identifier :    \
 553                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
 554                                  &(artwork).snd_current_identifier :    \
 555                                  &(artwork).mus_current_identifier)
 556
 557 #define ARTWORK_CURRENT_IDENTIFIER(artwork, type)                       \
 558                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
 559                                  (artwork).gfx_current_identifier :     \
 560                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
 561                                  (artwork).snd_current_identifier :     \
 562                                  (artwork).mus_current_identifier)
 563
 564 #define ARTWORKINFO_FILENAME(type)                                      \
 565                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
 566                                  GRAPHICSINFO_FILENAME :                \
 567                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
 568                                  SOUNDSINFO_FILENAME :                  \
 569                                  (type) == ARTWORK_TYPE_MUSIC ?         \
 570                                  MUSICINFO_FILENAME : "")
 571
 572 #define ARTWORK_DIRECTORY(type)                                         \
 573                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
 574                                  GRAPHICS_DIRECTORY :                   \
 575                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
 576                                  SOUNDS_DIRECTORY :                     \
 577                                  (type) == ARTWORK_TYPE_MUSIC ?         \
 578                                  MUSIC_DIRECTORY : "")
 579
 580 #define OPTIONS_ARTWORK_DIRECTORY(type)                                 \
 581                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
 582                                  options.graphics_directory :           \
 583                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
 584                                  options.sounds_directory :             \
 585                                  (type) == ARTWORK_TYPE_MUSIC ?         \
 586                                  options.music_directory : "")
 587
 588 #define UPDATE_BUSY_STATE()                     \
 589 {                                               \
 590   if (gfx.draw_busy_anim_function != NULL)      \
 591     gfx.draw_busy_anim_function();              \
 592 }
 593
 594
 595 /* type definitions */
 596 typedef int (*EventFilter)(const Event *);
 597
 598
 599 /* structure definitions */
 600
 601 struct ProgramInfo
 602 {
 603   char *command_basepath;       /* directory that contains the program */
 604   char *command_basename;       /* base filename of the program binary */
 605
 606   char *userdata_subdir;        /* personal user game data directory */
 607   char *userdata_subdir_unix;   /* personal user game data directory (Unix) */
 608   char *userdata_path;          /* resulting full path to game data directory */
 609
 610   char *program_title;
 611   char *window_title;
 612   char *icon_title;
 613
 614   char *x11_icon_filename;
 615   char *x11_iconmask_filename;
 616   char *sdl_icon_filename;
 617   char *msdos_cursor_filename;
 618
 619   char *cookie_prefix;
 620   char *filename_prefix;        /* prefix to cut off from DOS filenames */
 621
 622   char *error_filename;         /* filename where to write error messages to */
 623   FILE *error_file;             /* (used instead of 'stderr' on some systems) */
 624
 625   int version_major;
 626   int version_minor;
 627   int version_patch;
 628
 629   void (*exit_function)(int);
 630 };
 631
 632 struct OptionInfo
 633 {
 634   char *display_name;
 635   char *server_host;
 636   int server_port;
 637
 638   char *ro_base_directory;
 639   char *rw_base_directory;
 640   char *level_directory;
 641   char *graphics_directory;
 642   char *sounds_directory;
 643   char *music_directory;
 644   char *docs_directory;
 645   char *execute_command;
 646
 647   boolean serveronly;
 648   boolean network;
 649   boolean verbose;
 650   boolean debug;
 651 };
 652
 653 struct ScreenModeInfo
 654 {
 655   int width, height;
 656 };
 657
 658 struct VideoSystemInfo
 659 {
 660   int default_depth;
 661   int width, height, depth;
 662
 663   boolean fullscreen_available;
 664   boolean fullscreen_enabled;
 665   struct ScreenModeInfo *fullscreen_modes;
 666   char *fullscreen_mode_current;
 667 };
 668
 669 struct AudioSystemInfo
 670 {
 671   boolean sound_available;
 672   boolean loops_available;
 673   boolean music_available;
 674
 675   boolean sound_enabled;
 676   boolean sound_deactivated;    /* for temporarily disabling sound */
 677
 678   int mixer_pipe[2];
 679   int mixer_pid;
 680   char *device_name;
 681   int device_fd;
 682
 683   int num_channels;
 684   int music_channel;
 685   int first_sound_channel;
 686 };
 687
 688 struct FontBitmapInfo
 689 {
 690   Bitmap *bitmap;
 691
 692   int src_x, src_y;             /* start position of animation frames */
 693   int width, height;            /* width/height of each animation frame */
 694
 695   int draw_xoffset;             /* offset for drawing font characters */
 696   int draw_yoffset;             /* offset for drawing font characters */
 697
 698   int num_chars;
 699   int num_chars_per_line;
 700
 701 #if defined(TARGET_X11_NATIVE_PERFORMANCE_WORKAROUND)
 702   Pixmap *clip_mask;            /* single-char-only clip mask array for X11 */
 703 #endif
 704 };
 705
 706 struct GfxInfo
 707 {
 708   int sx, sy;
 709   int sxsize, sysize;
 710   int real_sx, real_sy;
 711   int full_sxsize, full_sysize;
 712   int scrollbuffer_width, scrollbuffer_height;
 713
 714   int dx, dy;
 715   int dxsize, dysize;
 716
 717   int vx, vy;
 718   int vxsize, vysize;
 719
 720   int draw_deactivation_mask;
 721   int draw_background_mask;
 722
 723   Bitmap *field_save_buffer;
 724
 725   Bitmap *background_bitmap;
 726   int background_bitmap_mask;
 727
 728   int num_fonts;
 729   struct FontBitmapInfo *font_bitmap_info;
 730   int (*select_font_function)(int);
 731   int (*get_font_from_token_function)(char *);
 732
 733   int anim_random_frame;
 734
 735   void (*draw_busy_anim_function)(void);
 736 };
 737
 738 struct JoystickInfo
 739 {
 740   int status;
 741   int fd[MAX_PLAYERS];          /* file descriptor of player's joystick */
 742 };
 743
 744 struct SetupJoystickInfo
 745 {
 746   char *device_name;            /* device name of player's joystick */
 747
 748   int xleft, xmiddle, xright;
 749   int yupper, ymiddle, ylower;
 750   int snap, drop;
 751 };
 752
 753 struct SetupKeyboardInfo
 754 {
 755   Key left, right, up, down;
 756   Key snap, drop;
 757 };
 758
 759 struct SetupInputInfo
 760 {
 761   boolean use_joystick;
 762   struct SetupJoystickInfo joy;
 763   struct SetupKeyboardInfo key;
 764 };
 765
 766 struct SetupEditorInfo
 767 {
 768   boolean el_boulderdash;
 769   boolean el_emerald_mine;
 770   boolean el_emerald_mine_club;
 771   boolean el_more;
 772   boolean el_sokoban;
 773   boolean el_supaplex;
 774   boolean el_diamond_caves;
 775   boolean el_dx_boulderdash;
 776   boolean el_chars;
 777   boolean el_steel_chars;
 778   boolean el_custom;
 779   boolean el_user_defined;
 780   boolean el_dynamic;
 781
 782   boolean el_headlines;
 783
 784   boolean el_by_game;
 785   boolean el_by_type;
 786
 787   boolean show_element_token;
 788 };
 789
 790 struct SetupEditorCascadeInfo
 791 {
 792   boolean el_bd;
 793   boolean el_em;
 794   boolean el_emc;
 795   boolean el_rnd;
 796   boolean el_sb;
 797   boolean el_sp;
 798   boolean el_dc;
 799   boolean el_dx;
 800   boolean el_chars;
 801   boolean el_steel_chars;
 802   boolean el_ce;
 803   boolean el_ge;
 804   boolean el_ref;
 805   boolean el_user;
 806   boolean el_dynamic;
 807 };
 808
 809 struct SetupShortcutInfo
 810 {
 811   Key save_game;
 812   Key load_game;
 813   Key toggle_pause;
 814
 815   Key focus_player[MAX_PLAYERS];
 816   Key focus_player_all;
 817 };
 818
 819 struct SetupSystemInfo
 820 {
 821   char *sdl_videodriver;
 822   char *sdl_audiodriver;
 823   int audio_fragment_size;
 824 };
 825
 826 struct SetupInfo
 827 {
 828   char *player_name;
 829
 830   boolean sound;
 831   boolean sound_loops;
 832   boolean sound_music;
 833   boolean sound_simple;
 834   boolean toons;
 835   boolean double_buffering;
 836   boolean direct_draw;          /* !double_buffering (redundant!) */
 837   boolean scroll_delay;
 838   boolean scroll_delay_value;
 839   boolean soft_scrolling;
 840   boolean fade_screens;
 841   boolean autorecord;
 842   boolean show_titlescreen;
 843   boolean quick_doors;
 844   boolean team_mode;
 845   boolean handicap;
 846   boolean skip_levels;
 847   boolean time_limit;
 848   boolean fullscreen;
 849   char *fullscreen_mode;
 850   boolean ask_on_escape;
 851   boolean ask_on_escape_editor;
 852   boolean quick_switch;
 853   boolean input_on_focus;
 854   boolean prefer_aga_graphics;
 855   int game_frame_delay;
 856
 857   char *graphics_set;
 858   char *sounds_set;
 859   char *music_set;
 860   boolean override_level_graphics;
 861   boolean override_level_sounds;
 862   boolean override_level_music;
 863
 864   struct SetupEditorInfo editor;
 865   struct SetupEditorCascadeInfo editor_cascade;
 866   struct SetupShortcutInfo shortcut;
 867   struct SetupInputInfo input[MAX_PLAYERS];
 868   struct SetupSystemInfo system;
 869   struct OptionInfo options;
 870 };
 871
 872 struct TreeInfo
 873 {
 874   struct TreeInfo **node_top;           /* topmost node in tree */
 875   struct TreeInfo *node_parent;         /* parent level directory info */
 876   struct TreeInfo *node_group;          /* level group sub-directory info */
 877   struct TreeInfo *next;                /* next level series structure node */
 878
 879   int cl_first;         /* internal control field for setup screen */
 880   int cl_cursor;        /* internal control field for setup screen */
 881
 882   int type;             /* type of tree content */
 883
 884   /* fields for "type == TREE_TYPE_LEVEL_DIR" */
 885
 886   char *subdir;         /* tree info sub-directory basename (may be ".") */
 887   char *fullpath;       /* complete path relative to tree base directory */
 888   char *basepath;       /* absolute base path of tree base directory */
 889   char *identifier;     /* identifier string for configuration files */
 890   char *name;           /* tree info name, as displayed in selection menues */
 891   char *name_sorting;   /* optional sorting name for correct name sorting */
 892   char *author;         /* level or artwork author name */
 893   char *year;           /* optional year of creation for levels or artwork */
 894   char *imported_from;  /* optional comment for imported levels or artwork */
 895   char *imported_by;    /* optional comment for imported levels or artwork */
 896   char *tested_by;      /* optional comment to name people who tested a set */
 897
 898   char *graphics_set_ecs; /* special EMC custom graphics set (ECS graphics) */
 899   char *graphics_set_aga; /* special EMC custom graphics set (AGA graphics) */
 900   char *graphics_set;   /* optional custom graphics set (level tree only) */
 901   char *sounds_set;     /* optional custom sounds set (level tree only) */
 902   char *music_set;      /* optional custom music set (level tree only) */
 903   char *graphics_path;  /* path to optional custom graphics set (level only) */
 904   char *sounds_path;    /* path to optional custom sounds set (level only) */
 905   char *music_path;     /* path to optional custom music set (level only) */
 906
 907   char *level_filename; /* filename of level file (for packed level file) */
 908   char *level_filetype; /* type of levels in level directory or level file */
 909
 910   int levels;           /* number of levels in level series */
 911   int first_level;      /* first level number (to allow start with 0 or 1) */
 912   int last_level;       /* last level number (automatically calculated) */
 913   int sort_priority;    /* sort levels by 'sort_priority' and then by name */
 914
 915   boolean latest_engine;/* force level set to use the latest game engine */
 916
 917   boolean level_group;  /* directory contains more level series directories */
 918   boolean parent_link;  /* entry links back to parent directory */
 919   boolean in_user_dir;  /* user defined levels are stored in home directory */
 920   boolean user_defined; /* levels in user directory and marked as "private" */
 921   boolean readonly;     /* readonly levels can not be changed with editor */
 922   boolean handicap;     /* level set has no handicap when set to "false" */
 923   boolean skip_levels;  /* levels can be skipped when set to "true" */
 924
 925   int color;            /* color to use on selection screen for this level */
 926   char *class_desc;     /* description of level series class */
 927   int handicap_level;   /* number of the lowest unsolved level */
 928
 929   char *infotext;       /* optional text to describe the tree type (headline) */
 930 };
 931
 932 typedef struct TreeInfo TreeInfo;
 933 typedef struct TreeInfo LevelDirTree;
 934 typedef struct TreeInfo ArtworkDirTree;
 935 typedef struct TreeInfo GraphicsDirTree;
 936 typedef struct TreeInfo SoundsDirTree;
 937 typedef struct TreeInfo MusicDirTree;
 938
 939 struct ArtworkInfo
 940 {
 941   GraphicsDirTree *gfx_first;
 942   GraphicsDirTree *gfx_current;
 943   SoundsDirTree *snd_first;
 944   SoundsDirTree *snd_current;
 945   MusicDirTree *mus_first;
 946   MusicDirTree *mus_current;
 947
 948   char *gfx_current_identifier;
 949   char *snd_current_identifier;
 950   char *mus_current_identifier;
 951 };
 952
 953 struct ValueTextInfo
 954 {
 955   int value;
 956   char *text;
 957 };
 958
 959 struct ConfigInfo
 960 {
 961   char *token;
 962   char *value;
 963 };
 964
 965 struct ConfigTypeInfo
 966 {
 967   char *token;
 968   char *value;
 969   int type;
 970 };
 971
 972 struct TokenIntPtrInfo
 973 {
 974   char *token;
 975   int *value;
 976 };
 977
 978 struct FileInfo
 979 {
 980   char *token;
 981
 982   char *default_filename;
 983   char *filename;
 984
 985   char **default_parameter;                     /* array of file parameters */
 986   char **parameter;                             /* array of file parameters */
 987
 988   boolean redefined;
 989   boolean fallback_to_default;
 990   boolean default_is_cloned;
 991 };
 992
 993 struct SetupFileList
 994 {
 995   char *token;
 996   char *value;
 997
 998   struct SetupFileList *next;
 999 };
1000
1001 struct ListNodeInfo
1002 {
1003   char *source_filename;                        /* primary key for node list */
1004   int num_references;
1005 };
1006
1007 struct PropertyMapping
1008 {
1009   int base_index;
1010   int ext1_index;
1011   int ext2_index;
1012   int ext3_index;
1013
1014   int artwork_index;
1015 };
1016
1017 struct ArtworkListInfo
1018 {
1019   int type;                                     /* type of artwork */
1020
1021   int num_file_list_entries;
1022   int num_dynamic_file_list_entries;
1023   struct FileInfo *file_list;                   /* static artwork file array */
1024   struct FileInfo *dynamic_file_list;           /* dynamic artwrk file array */
1025
1026   int num_suffix_list_entries;
1027   struct ConfigTypeInfo *suffix_list;           /* parameter suffixes array */
1028
1029   int num_base_prefixes;
1030   int num_ext1_suffixes;
1031   int num_ext2_suffixes;
1032   int num_ext3_suffixes;
1033   char **base_prefixes;                         /* base token prefixes array */
1034   char **ext1_suffixes;                         /* property suffixes array 1 */
1035   char **ext2_suffixes;                         /* property suffixes array 2 */
1036   char **ext3_suffixes;                         /* property suffixes array 3 */
1037
1038   int num_ignore_tokens;
1039   char **ignore_tokens;                         /* file tokens to be ignored */
1040
1041   int num_property_mapping_entries;
1042   struct PropertyMapping *property_mapping;     /* mapping token -> artwork */
1043
1044   int sizeof_artwork_list_entry;
1045
1046   struct ListNodeInfo **artwork_list;           /* static artwork node array */
1047   struct ListNodeInfo **dynamic_artwork_list;   /* dynamic artwrk node array */
1048   struct ListNode *content_list;                /* dynamic artwork node list */
1049
1050   void *(*load_artwork)(char *);                /* constructor function */
1051   void (*free_artwork)(void *);                 /* destructor function */
1052 };
1053
1054 struct XY
1055 {
1056   int x, y;
1057 };
1058
1059 struct Rect
1060 {
1061   int x, y;
1062   int width, height;
1063 };
1064
1065 struct MenuPosInfo
1066 {
1067   int x, y;
1068   int width, height;
1069   int align, valign;
1070 };
1071
1072 struct TextPosInfo
1073 {
1074   int x, y;
1075   int width, height;
1076   int align, valign;
1077   int size;
1078   int font, font_alt;
1079   boolean draw_masked;
1080   int sort_priority;
1081   int id;
1082 };
1083
1084
1085 /* ========================================================================= */
1086 /* exported variables                                                        */
1087 /* ========================================================================= */
1088
1089 extern struct ProgramInfo       program;
1090 extern struct OptionInfo        options;
1091 extern struct VideoSystemInfo   video;
1092 extern struct AudioSystemInfo   audio;
1093 extern struct GfxInfo           gfx;
1094 extern struct AnimInfo          anim;
1095 extern struct ArtworkInfo       artwork;
1096 extern struct JoystickInfo      joystick;
1097 extern struct SetupInfo         setup;
1098
1099 extern LevelDirTree            *leveldir_first_all;
1100 extern LevelDirTree            *leveldir_first;
1101 extern LevelDirTree            *leveldir_current;
1102 extern int                      level_nr;
1103
1104 extern Display                 *display;
1105 extern Visual                  *visual;
1106 extern int                      screen;
1107 extern Colormap                 cmap;
1108
1109 extern DrawWindow              *window;
1110 extern DrawBuffer              *backbuffer;
1111 extern DrawBuffer              *drawto;
1112
1113 extern int                      button_status;
1114 extern boolean                  motion_status;
1115
1116 extern int                      redraw_mask;
1117 extern int                      redraw_tiles;
1118
1119 extern int                      FrameCounter;
1120
1121
1122 /* function definitions */
1123
1124 void InitProgramInfo(char *, char *, char *, char *, char *, char *, char *,
1125                      char *, char *, char *, char *, char *, int);
1126
1127 void InitExitFunction(void (*exit_function)(int));
1128 void InitPlatformDependentStuff(void);
1129 void ClosePlatformDependentStuff(void);
1130
1131 void InitGfxFieldInfo(int, int, int, int, int, int, int, int, Bitmap *);
1132 void InitGfxDoor1Info(int, int, int, int);
1133 void InitGfxDoor2Info(int, int, int, int);
1134 void InitGfxScrollbufferInfo(int, int);
1135 void InitGfxDrawBusyAnimFunction(void (*draw_busy_anim_function)(void));
1136 void SetDrawDeactivationMask(int);
1137 void SetDrawBackgroundMask(int);
1138 void SetWindowBackgroundBitmap(Bitmap *);
1139 void SetMainBackgroundBitmap(Bitmap *);
1140 void SetDoorBackgroundBitmap(Bitmap *);
1141
1142 void InitVideoDisplay(void);
1143 void CloseVideoDisplay(void);
1144 void InitVideoBuffer(int, int, int, boolean);
1145 Bitmap *CreateBitmapStruct(void);
1146 Bitmap *CreateBitmap(int, int, int);
1147 void FreeBitmap(Bitmap *);
1148 void BlitBitmap(Bitmap *, Bitmap *, int, int, int, int, int, int);
1149 void FadeRectangle(Bitmap *bitmap, int, int, int, int, int, int, int,
1150                    void (*draw_border_function)(void));
1151 void FillRectangle(Bitmap *, int, int, int, int, Pixel);
1152 void ClearRectangle(Bitmap *, int, int, int, int);
1153 void ClearRectangleOnBackground(Bitmap *, int, int, int, int);
1154 void SetClipMask(Bitmap *, GC, Pixmap);
1155 void SetClipOrigin(Bitmap *, GC, int, int);
1156 void BlitBitmapMasked(Bitmap *, Bitmap *, int, int, int, int, int, int);
1157 boolean DrawingOnBackground(int, int);
1158 void BlitBitmapOnBackground(Bitmap *, Bitmap *, int, int, int, int, int, int);
1159 void DrawSimpleBlackLine(Bitmap *, int, int, int, int);
1160 void DrawSimpleWhiteLine(Bitmap *, int, int, int, int);
1161 void DrawLines(Bitmap *, struct XY *, int, Pixel);
1162 Pixel GetPixel(Bitmap *, int, int);
1163 Pixel GetPixelFromRGB(Bitmap *, unsigned int,unsigned int,unsigned int);
1164 Pixel GetPixelFromRGBcompact(Bitmap *, unsigned int);
1165
1166 void FlushDisplay(void);
1167 void SyncDisplay(void);
1168 void KeyboardAutoRepeatOn(void);
1169 void KeyboardAutoRepeatOff(void);
1170 boolean PointerInWindow(DrawWindow *);
1171 boolean SetVideoMode(boolean);
1172 boolean ChangeVideoModeIfNeeded(boolean);
1173
1174 Bitmap *LoadImage(char *);
1175 Bitmap *LoadCustomImage(char *);
1176 void ReloadCustomImage(Bitmap *, char *);
1177
1178 Bitmap *ZoomBitmap(Bitmap *, int, int);
1179 void CreateBitmapWithSmallBitmaps(Bitmap *, int);
1180 void ScaleBitmap(Bitmap *, int);
1181
1182 void SetMouseCursor(int);
1183
1184 void OpenAudio(void);
1185 void CloseAudio(void);
1186 void SetAudioMode(boolean);
1187
1188 void InitEventFilter(EventFilter);
1189 boolean PendingEvent(void);
1190 void NextEvent(Event *event);
1191 void PeekEvent(Event *event);
1192 Key GetEventKey(KeyEvent *, boolean);
1193 KeyMod HandleKeyModState(Key, int);
1194 KeyMod GetKeyModState();
1195 KeyMod GetKeyModStateFromEvents();
1196 boolean CheckCloseWindowEvent(ClientMessageEvent *);
1197
1198 void InitJoysticks();
1199 boolean ReadJoystick(int, int *, int *, boolean *, boolean *);
1200
1201 #endif /* SYSTEM_H */