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