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