src/libgame/system.h

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