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