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