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