src/libgame/system.h

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