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