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