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