src/libgame/system.h

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