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