src/libgame/system.h

   1 /***********************************************************
   2 * Artsoft Retro-Game Library                               *
   3 *----------------------------------------------------------*
   4 * (c) 1994-2002 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
  76 /* values for key_status */
  77 #define KEY_NOT_PRESSED                 FALSE
  78 #define KEY_RELEASED                    FALSE
  79 #define KEY_PRESSED                     TRUE
  80
  81 /* values for button status */
  82 #define MB_NOT_PRESSED                  FALSE
  83 #define MB_NOT_RELEASED                 TRUE
  84 #define MB_RELEASED                     FALSE
  85 #define MB_PRESSED                      TRUE
  86 #define MB_MENU_CHOICE                  FALSE
  87 #define MB_MENU_MARK                    TRUE
  88 #define MB_MENU_INITIALIZE              (-1)
  89 #define MB_MENU_LEAVE                   (-2)
  90 #define MB_LEFTBUTTON                   1
  91 #define MB_MIDDLEBUTTON                 2
  92 #define MB_RIGHTBUTTON                  3
  93 #define MB_WHEEL_UP                     4
  94 #define MB_WHEEL_DOWN                   5
  95 #define MB_WHEEL_LEFT                   6
  96 #define MB_WHEEL_RIGHT                  7
  97 #define IS_WHEEL_BUTTON_VERTICAL(b)     ((b) >= MB_WHEEL_UP &&          \
  98                                          (b) <= MB_WHEEL_DOWN)
  99 #define IS_WHEEL_BUTTON_HORIZONTAL(b)   ((b) >= MB_WHEEL_LEFT &&        \
 100                                          (b) <= MB_WHEEL_RIGHT)
 101 #define IS_WHEEL_BUTTON(b)              ((b) >= MB_WHEEL_UP &&          \
 102                                          (b) <= MB_WHEEL_DOWN)
 103 #define DEFAULT_WHEEL_STEPS             3
 104
 105 /* values for move directions */
 106 #define MV_BIT_LEFT                     0
 107 #define MV_BIT_RIGHT                    1
 108 #define MV_BIT_UP                       2
 109 #define MV_BIT_DOWN                     3
 110
 111 #define NUM_DIRECTIONS                  4
 112
 113 /* diagonal movement directions are used in a different contect than buttons */
 114 #define MV_BIT_UPLEFT                   4
 115 #define MV_BIT_UPRIGHT                  5
 116 #define MV_BIT_DOWNLEFT                 6
 117 #define MV_BIT_DOWNRIGHT                7
 118
 119 #define NUM_DIRECTIONS_FULL             8
 120
 121 /* values for special "button" bitmasks */
 122 #define BUTTON_1                        4
 123 #define BUTTON_2                        5
 124
 125 /* values for special "focus player" bitmasks */
 126 #define BIT_SET_FOCUS                   6
 127
 128 /* values for move directions and special "button" key bitmasks */
 129 #define MV_NONE                 0
 130 #define MV_LEFT                 (1 << MV_BIT_LEFT)
 131 #define MV_RIGHT                (1 << MV_BIT_RIGHT)
 132 #define MV_UP                   (1 << MV_BIT_UP)
 133 #define MV_DOWN                 (1 << MV_BIT_DOWN)
 134
 135 #define MV_UPLEFT               (MV_UP   | MV_LEFT)
 136 #define MV_UPRIGHT              (MV_UP   | MV_RIGHT)
 137 #define MV_DOWNLEFT             (MV_DOWN | MV_LEFT)
 138 #define MV_DOWNRIGHT            (MV_DOWN | MV_RIGHT)
 139
 140 #define MV_HORIZONTAL           (MV_LEFT | MV_RIGHT)
 141 #define MV_VERTICAL             (MV_UP   | MV_DOWN)
 142 #define MV_ALL_DIRECTIONS       (MV_LEFT | MV_RIGHT | MV_UP | MV_DOWN)
 143 #define MV_ANY_DIRECTION        (MV_ALL_DIRECTIONS)
 144 #define MV_NO_DIRECTION         (MV_NONE)
 145
 146 #define KEY_BUTTON_1            (1 << BUTTON_1)
 147 #define KEY_BUTTON_2            (1 << BUTTON_2)
 148 #define KEY_MOTION              (MV_LEFT | MV_RIGHT | MV_UP | MV_DOWN)
 149 #define KEY_BUTTON              (KEY_BUTTON_1 | KEY_BUTTON_2)
 150 #define KEY_ACTION              (KEY_MOTION | KEY_BUTTON)
 151
 152 #define KEY_SET_FOCUS           (1 << BIT_SET_FOCUS)
 153
 154 #define MV_DIR_FROM_BIT(x)      ((x) < NUM_DIRECTIONS ? 1 << (x) :        \
 155                                  (x) == MV_BIT_UPLEFT    ? MV_UPLEFT    : \
 156                                  (x) == MV_BIT_UPRIGHT   ? MV_UPRIGHT   : \
 157                                  (x) == MV_BIT_DOWNLEFT  ? MV_DOWNLEFT  : \
 158                                  (x) == MV_BIT_DOWNRIGHT ? MV_DOWNRIGHT : \
 159                                  MV_NONE)
 160
 161 #define MV_DIR_TO_BIT(x)        ((x) == MV_LEFT      ? MV_BIT_LEFT      : \
 162                                  (x) == MV_RIGHT     ? MV_BIT_RIGHT     : \
 163                                  (x) == MV_UP        ? MV_BIT_UP        : \
 164                                  (x) == MV_DOWN      ? MV_BIT_DOWN      : \
 165                                  (x) == MV_UPLEFT    ? MV_BIT_UPLEFT    : \
 166                                  (x) == MV_UPRIGHT   ? MV_BIT_UPRIGHT   : \
 167                                  (x) == MV_DOWNLEFT  ? MV_BIT_DOWNLEFT  : \
 168                                  (x) == MV_DOWNRIGHT ? MV_BIT_DOWNRIGHT : \
 169                                  MV_BIT_DOWN)
 170
 171 #define MV_DIR_OPPOSITE(x)      ((x) == MV_LEFT      ? MV_RIGHT     : \
 172                                  (x) == MV_RIGHT     ? MV_LEFT      : \
 173                                  (x) == MV_UP        ? MV_DOWN      : \
 174                                  (x) == MV_DOWN      ? MV_UP        : \
 175                                  (x) == MV_UPLEFT    ? MV_DOWNRIGHT : \
 176                                  (x) == MV_UPRIGHT   ? MV_DOWNLEFT  : \
 177                                  (x) == MV_DOWNLEFT  ? MV_UPRIGHT   : \
 178                                  (x) == MV_DOWNRIGHT ? MV_UPLEFT    : \
 179                                  MV_NONE)
 180
 181 /* values for animation mode (frame order and direction) */
 182 #define ANIM_NONE               0
 183 #define ANIM_LOOP               (1 << 0)
 184 #define ANIM_LINEAR             (1 << 1)
 185 #define ANIM_PINGPONG           (1 << 2)
 186 #define ANIM_PINGPONG2          (1 << 3)
 187 #define ANIM_RANDOM             (1 << 4)
 188 #define ANIM_CE_VALUE           (1 << 5)
 189 #define ANIM_CE_SCORE           (1 << 6)
 190 #define ANIM_CE_DELAY           (1 << 7)
 191 #define ANIM_REVERSE            (1 << 8)
 192 #define ANIM_OPAQUE_PLAYER      (1 << 9)
 193
 194 /* values for special (non game element) animation modes */
 195 #define ANIM_HORIZONTAL         (1 << 10)
 196 #define ANIM_VERTICAL           (1 << 11)
 197 #define ANIM_STATIC_PANEL       (1 << 12)
 198
 199 #define ANIM_DEFAULT            ANIM_LOOP
 200
 201 /* values for redraw_mask */
 202 #define REDRAW_NONE             (0)
 203 #define REDRAW_ALL              (1 << 0)
 204 #define REDRAW_FIELD            (1 << 1)
 205 #define REDRAW_TILES            (1 << 2)
 206 #define REDRAW_DOOR_1           (1 << 3)
 207 #define REDRAW_VIDEO_1          (1 << 4)
 208 #define REDRAW_VIDEO_2          (1 << 5)
 209 #define REDRAW_VIDEO_3          (1 << 6)
 210 #define REDRAW_MICROLEVEL       (1 << 7)
 211 #define REDRAW_MICROLABEL       (1 << 8)
 212 #define REDRAW_FROM_BACKBUFFER  (1 << 9)
 213 #define REDRAW_DOOR_2           (REDRAW_VIDEO_1 | \
 214                                  REDRAW_VIDEO_2 | \
 215                                  REDRAW_VIDEO_3)
 216 #define REDRAW_DOOR_3           (1 << 10)
 217 #define REDRAW_DOORS            (REDRAW_DOOR_1 | \
 218                                  REDRAW_DOOR_2 | \
 219                                  REDRAW_DOOR_3)
 220 #define REDRAW_MAIN             (REDRAW_FIELD | \
 221                                  REDRAW_TILES | \
 222                                  REDRAW_MICROLEVEL)
 223 #define REDRAW_FPS              (1 << 11)
 224 #define REDRAWTILES_THRESHOLD   (SCR_FIELDX * SCR_FIELDY / 2)
 225
 226 #define FADE_MODE_FADE_IN       0
 227 #define FADE_MODE_FADE_OUT      1
 228 #define FADE_MODE_CROSSFADE     2
 229
 230 #define IN_GFX_SCREEN(x, y)     (x >= gfx.sx && x < gfx.sx + gfx.sxsize && \
 231                                  y >= gfx.sy && y < gfx.sy + gfx.sysize)
 232 #define IN_GFX_DOOR(x, y)       (x >= gfx.dx && x < gfx.dx + gfx.dxsize && \
 233                                  y >= gfx.dy && y < gfx.dy + gfx.dysize)
 234 #define IN_GFX_VIDEO(x, y)      (x >= gfx.vx && x < gfx.vx + gfx.vxsize && \
 235                                  y >= gfx.vy && y < gfx.vy + gfx.vysize)
 236
 237 /* values for mouse cursor */
 238 #define CURSOR_DEFAULT          0
 239 #define CURSOR_PLAYFIELD        1
 240
 241 /* fundamental game speed values */
 242 #define ONE_SECOND_DELAY        1000    /* delay value for one second */
 243 #define GAME_FRAME_DELAY        20      /* frame delay in milliseconds */
 244 #define FFWD_FRAME_DELAY        10      /* 200% speed for fast forward */
 245 #define FRAMES_PER_SECOND       (ONE_SECOND_DELAY / GAME_FRAME_DELAY)
 246
 247 /* maximum playfield size supported by libgame functions */
 248 #define MAX_PLAYFIELD_WIDTH     128
 249 #define MAX_PLAYFIELD_HEIGHT    128
 250
 251 /* maximum number of parallel players supported by libgame functions */
 252 #define MAX_PLAYERS             4
 253
 254 /* maximum allowed length of player name */
 255 #define MAX_PLAYER_NAME_LEN     10
 256
 257 /* default name for empty highscore entry */
 258 #define EMPTY_PLAYER_NAME       "no name"
 259
 260 /* default name for unknown player names */
 261 #define ANONYMOUS_NAME          "anonymous"
 262
 263 /* default for other unknown names */
 264 #define UNKNOWN_NAME            "unknown"
 265
 266 /* default name for new levels */
 267 #define NAMELESS_LEVEL_NAME     "nameless level"
 268
 269 /* default text for non-existant artwork */
 270 #define NOT_AVAILABLE           "(not available)"
 271
 272 /* default value for undefined filename */
 273 #define UNDEFINED_FILENAME      "[NONE]"
 274
 275 /* default value for undefined parameter */
 276 #define ARG_DEFAULT             "[DEFAULT]"
 277
 278 /* default values for undefined configuration file parameters */
 279 #define ARG_UNDEFINED           "-1000000"
 280 #define ARG_UNDEFINED_VALUE     (atoi(ARG_UNDEFINED))
 281
 282 /* definitions for game sub-directories */
 283 #ifndef RO_GAME_DIR
 284 #define RO_GAME_DIR             "."
 285 #endif
 286
 287 #ifndef RW_GAME_DIR
 288 #define RW_GAME_DIR             "."
 289 #endif
 290
 291 #define RO_BASE_PATH            RO_GAME_DIR
 292 #define RW_BASE_PATH            RW_GAME_DIR
 293
 294 /* directory names */
 295 #define GRAPHICS_DIRECTORY      "graphics"
 296 #define SOUNDS_DIRECTORY        "sounds"
 297 #define MUSIC_DIRECTORY         "music"
 298 #define LEVELS_DIRECTORY        "levels"
 299 #define TAPES_DIRECTORY         "tapes"
 300 #define SCORES_DIRECTORY        "scores"
 301 #define DOCS_DIRECTORY          "docs"
 302
 303 #if !defined(PLATFORM_MSDOS)
 304 #define GFX_CLASSIC_SUBDIR      "gfx_classic"
 305 #define SND_CLASSIC_SUBDIR      "snd_classic"
 306 #define MUS_CLASSIC_SUBDIR      "mus_classic"
 307 #else
 308 #define GFX_CLASSIC_SUBDIR      "gfx_orig"
 309 #define SND_CLASSIC_SUBDIR      "snd_orig"
 310 #define MUS_CLASSIC_SUBDIR      "mus_orig"
 311 #endif
 312
 313 /* file names and filename extensions */
 314 #if !defined(PLATFORM_MSDOS)
 315 #define LEVELSETUP_DIRECTORY    "levelsetup"
 316 #define SETUP_FILENAME          "setup.conf"
 317 #define LEVELSETUP_FILENAME     "levelsetup.conf"
 318 #define EDITORSETUP_FILENAME    "editorsetup.conf"
 319 #define EDITORCASCADE_FILENAME  "editorcascade.conf"
 320 #define HELPANIM_FILENAME       "helpanim.conf"
 321 #define HELPTEXT_FILENAME       "helptext.conf"
 322 #define LEVELINFO_FILENAME      "levelinfo.conf"
 323 #define GRAPHICSINFO_FILENAME   "graphicsinfo.conf"
 324 #define SOUNDSINFO_FILENAME     "soundsinfo.conf"
 325 #define MUSICINFO_FILENAME      "musicinfo.conf"
 326 #define LEVELFILE_EXTENSION     "level"
 327 #define TAPEFILE_EXTENSION      "tape"
 328 #define SCOREFILE_EXTENSION     "score"
 329 #else
 330 #define LEVELSETUP_DIRECTORY    "lvlsetup"
 331 #define SETUP_FILENAME          "setup.cnf"
 332 #define LEVELSETUP_FILENAME     "lvlsetup.cnf"
 333 #define EDITORSETUP_FILENAME    "edsetup.cnf"
 334 #define EDITORCASCADE_FILENAME  "edcascad.conf"
 335 #define HELPANIM_FILENAME       "helpanim.cnf"
 336 #define HELPTEXT_FILENAME       "helptext.cnf"
 337 #define LEVELINFO_FILENAME      "lvlinfo.cnf"
 338 #define GRAPHICSINFO_FILENAME   "gfxinfo.cnf"
 339 #define SOUNDSINFO_FILENAME     "sndinfo.cnf"
 340 #define MUSICINFO_FILENAME      "musinfo.cnf"
 341 #define LEVELFILE_EXTENSION     "lvl"
 342 #define TAPEFILE_EXTENSION      "tap"
 343 #define SCOREFILE_EXTENSION     "sco"
 344 #endif
 345
 346 #define ERROR_BASENAME          "stderr.txt"
 347
 348 #define CHAR_PATH_SEPARATOR_UNIX        '/'
 349 #define CHAR_PATH_SEPARATOR_DOS         '\\'
 350
 351 #define STRING_PATH_SEPARATOR_UNIX      "/"
 352 #define STRING_PATH_SEPARATOR_DOS       "\\"
 353
 354 #define STRING_NEWLINE_UNIX             "\n"
 355 #define STRING_NEWLINE_DOS              "\r\n"
 356
 357 #if defined(PLATFORM_WIN32) || defined(PLATFORM_MSDOS)
 358 #define CHAR_PATH_SEPARATOR     CHAR_PATH_SEPARATOR_DOS
 359 #define STRING_PATH_SEPARATOR   STRING_PATH_SEPARATOR_DOS
 360 #define STRING_NEWLINE          STRING_NEWLINE_DOS
 361 #else
 362 #define CHAR_PATH_SEPARATOR     CHAR_PATH_SEPARATOR_UNIX
 363 #define STRING_PATH_SEPARATOR   STRING_PATH_SEPARATOR_UNIX
 364 #define STRING_NEWLINE          STRING_NEWLINE_UNIX
 365 #endif
 366
 367
 368 /* areas in bitmap PIX_DOOR */
 369 /* meaning in PIX_DB_DOOR: (3 PAGEs)
 370    PAGEX1: 1. buffer for DOOR_1
 371    PAGEX2: 2. buffer for DOOR_1
 372    PAGEX3: buffer for animations
 373 */
 374
 375 /* these values are hard-coded to be able to use them in initialization */
 376 #define DOOR_GFX_PAGE_WIDTH     100     /* should be set to "gfx.dxsize" */
 377 #define DOOR_GFX_PAGE_HEIGHT    280     /* should be set to "gfx.dysize" */
 378
 379 #define DOOR_GFX_PAGESIZE       (DOOR_GFX_PAGE_WIDTH)
 380 #define DOOR_GFX_PAGEX1         (0 * DOOR_GFX_PAGESIZE)
 381 #define DOOR_GFX_PAGEX2         (1 * DOOR_GFX_PAGESIZE)
 382 #define DOOR_GFX_PAGEX3         (2 * DOOR_GFX_PAGESIZE)
 383 #define DOOR_GFX_PAGEX4         (3 * DOOR_GFX_PAGESIZE)
 384 #define DOOR_GFX_PAGEX5         (4 * DOOR_GFX_PAGESIZE)
 385 #define DOOR_GFX_PAGEX6         (5 * DOOR_GFX_PAGESIZE)
 386 #define DOOR_GFX_PAGEX7         (6 * DOOR_GFX_PAGESIZE)
 387 #define DOOR_GFX_PAGEX8         (7 * DOOR_GFX_PAGESIZE)
 388 #define DOOR_GFX_PAGEY1         (0)
 389 #define DOOR_GFX_PAGEY2         (DOOR_GFX_PAGE_HEIGHT)
 390
 391
 392 /* macros for version handling */
 393 #define VERSION_MAJOR(x)        ((x) / 1000000)
 394 #define VERSION_MINOR(x)        (((x) % 1000000) / 10000)
 395 #define VERSION_PATCH(x)        (((x) % 10000) / 100)
 396 #define VERSION_BUILD(x)        ((x) % 100)
 397 #define VERSION_IDENT(a,b,c,d)  ((a) * 1000000 + (b) * 10000 + (c) * 100 + (d))
 398
 399
 400 /* macros for parent/child process identification */
 401 #if defined(PLATFORM_UNIX)
 402 #define IS_PARENT_PROCESS()     (audio.mixer_pid != getpid())
 403 #define IS_CHILD_PROCESS()      (audio.mixer_pid == getpid())
 404 #define HAS_CHILD_PROCESS()     (audio.mixer_pid > 0)
 405 #else
 406 #define IS_PARENT_PROCESS()     TRUE
 407 #define IS_CHILD_PROCESS()      FALSE
 408 #define HAS_CHILD_PROCESS()     FALSE
 409 #endif
 410
 411
 412 /* values for artwork type */
 413 #define ARTWORK_TYPE_GRAPHICS   0
 414 #define ARTWORK_TYPE_SOUNDS     1
 415 #define ARTWORK_TYPE_MUSIC      2
 416
 417 #define NUM_ARTWORK_TYPES       3
 418
 419
 420 /* values for tree type (chosen to match artwork type) */
 421 #define TREE_TYPE_UNDEFINED     -1
 422 #define TREE_TYPE_GRAPHICS_DIR  ARTWORK_TYPE_GRAPHICS
 423 #define TREE_TYPE_SOUNDS_DIR    ARTWORK_TYPE_SOUNDS
 424 #define TREE_TYPE_MUSIC_DIR     ARTWORK_TYPE_MUSIC
 425 #define TREE_TYPE_LEVEL_DIR     3
 426
 427 #define NUM_TREE_TYPES          4
 428
 429
 430 /* values for artwork handling */
 431 #define LEVELDIR_ARTWORK_SET_PTR(leveldir, type)                        \
 432                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
 433                                  &(leveldir)->graphics_set :            \
 434                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
 435                                  &(leveldir)->sounds_set :              \
 436                                  &(leveldir)->music_set)
 437
 438 #define LEVELDIR_ARTWORK_SET(leveldir, type)                            \
 439                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
 440                                  (leveldir)->graphics_set :             \
 441                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
 442                                  (leveldir)->sounds_set :               \
 443                                  (leveldir)->music_set)
 444
 445 #define LEVELDIR_ARTWORK_PATH_PTR(leveldir, type)                       \
 446                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
 447                                  &(leveldir)->graphics_path :           \
 448                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
 449                                  &(leveldir)->sounds_path :             \
 450                                  &(leveldir)->music_path)
 451
 452 #define LEVELDIR_ARTWORK_PATH(leveldir, type)                           \
 453                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
 454                                  (leveldir)->graphics_path :            \
 455                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
 456                                  (leveldir)->sounds_path :              \
 457                                  (leveldir)->music_path)
 458
 459 #define SETUP_ARTWORK_SET(setup, type)                                  \
 460                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
 461                                  (setup).graphics_set :                 \
 462                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
 463                                  (setup).sounds_set :                   \
 464                                  (setup).music_set)
 465
 466 #define SETUP_OVERRIDE_ARTWORK(setup, type)                             \
 467                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
 468                                  (setup).override_level_graphics :      \
 469                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
 470                                  (setup).override_level_sounds :        \
 471                                  (setup).override_level_music)
 472
 473 #define ARTWORK_FIRST_NODE(artwork, type)                               \
 474                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
 475                                  (artwork).gfx_first :                  \
 476                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
 477                                  (artwork).snd_first :                  \
 478                                  (artwork).mus_first)
 479
 480 #define ARTWORK_CURRENT_IDENTIFIER_PTR(artwork, type)                   \
 481                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
 482                                  &(artwork).gfx_current_identifier :    \
 483                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
 484                                  &(artwork).snd_current_identifier :    \
 485                                  &(artwork).mus_current_identifier)
 486
 487 #define ARTWORK_CURRENT_IDENTIFIER(artwork, type)                       \
 488                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
 489                                  (artwork).gfx_current_identifier :     \
 490                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
 491                                  (artwork).snd_current_identifier :     \
 492                                  (artwork).mus_current_identifier)
 493
 494 #define ARTWORKINFO_FILENAME(type)                                      \
 495                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
 496                                  GRAPHICSINFO_FILENAME :                \
 497                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
 498                                  SOUNDSINFO_FILENAME :                  \
 499                                  (type) == ARTWORK_TYPE_MUSIC ?         \
 500                                  MUSICINFO_FILENAME : "")
 501
 502 #define ARTWORK_DIRECTORY(type)                                         \
 503                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
 504                                  GRAPHICS_DIRECTORY :                   \
 505                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
 506                                  SOUNDS_DIRECTORY :                     \
 507                                  (type) == ARTWORK_TYPE_MUSIC ?         \
 508                                  MUSIC_DIRECTORY : "")
 509
 510 #define OPTIONS_ARTWORK_DIRECTORY(type)                                 \
 511                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
 512                                  options.graphics_directory :           \
 513                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
 514                                  options.sounds_directory :             \
 515                                  (type) == ARTWORK_TYPE_MUSIC ?         \
 516                                  options.music_directory : "")
 517
 518
 519 /* type definitions */
 520 typedef int (*EventFilter)(const Event *);
 521
 522
 523 /* structure definitions */
 524
 525 struct ProgramInfo
 526 {
 527   char *command_basepath;       /* directory that contains the program */
 528   char *command_basename;       /* base filename of the program binary */
 529   char *userdata_directory;     /* personal user data directory */
 530
 531   char *program_title;
 532   char *window_title;
 533   char *icon_title;
 534
 535   char *x11_icon_filename;
 536   char *x11_iconmask_filename;
 537   char *msdos_cursor_filename;
 538
 539   char *cookie_prefix;
 540   char *filename_prefix;        /* prefix to cut off from DOS filenames */
 541
 542   char *error_filename;         /* filename where to write error messages to */
 543   FILE *error_file;             /* (used instead of 'stderr' on some systems) */
 544
 545   int version_major;
 546   int version_minor;
 547   int version_patch;
 548
 549   void (*exit_function)(int);
 550 };
 551
 552 struct OptionInfo
 553 {
 554   char *display_name;
 555   char *server_host;
 556   int server_port;
 557
 558   char *ro_base_directory;
 559   char *rw_base_directory;
 560   char *level_directory;
 561   char *graphics_directory;
 562   char *sounds_directory;
 563   char *music_directory;
 564   char *docs_directory;
 565   char *execute_command;
 566
 567   boolean serveronly;
 568   boolean network;
 569   boolean verbose;
 570   boolean debug;
 571 };
 572
 573 struct VideoSystemInfo
 574 {
 575   int default_depth;
 576   int width, height, depth;
 577   boolean fullscreen_available;
 578   boolean fullscreen_enabled;
 579 };
 580
 581 struct AudioSystemInfo
 582 {
 583   boolean sound_available;
 584   boolean loops_available;
 585   boolean music_available;
 586
 587   boolean sound_enabled;
 588   boolean sound_deactivated;    /* for temporarily disabling sound */
 589
 590   int mixer_pipe[2];
 591   int mixer_pid;
 592   char *device_name;
 593   int device_fd;
 594
 595   int num_channels;
 596   int music_channel;
 597   int first_sound_channel;
 598 };
 599
 600 struct FontBitmapInfo
 601 {
 602   Bitmap *bitmap;
 603
 604   int src_x, src_y;             /* start position of animation frames */
 605   int width, height;            /* width/height of each animation frame */
 606
 607   int draw_xoffset;             /* offset for drawing font characters */
 608   int draw_yoffset;             /* offset for drawing font characters */
 609
 610   int num_chars;
 611   int num_chars_per_line;
 612
 613 #if defined(TARGET_X11_NATIVE_PERFORMANCE_WORKAROUND)
 614   Pixmap *clip_mask;            /* single-char-only clip mask array for X11 */
 615 #endif
 616 };
 617
 618 struct GfxInfo
 619 {
 620   int sx, sy;
 621   int sxsize, sysize;
 622   int real_sx, real_sy;
 623   int full_sxsize, full_sysize;
 624   int scrollbuffer_width, scrollbuffer_height;
 625
 626   int dx, dy;
 627   int dxsize, dysize;
 628
 629   int vx, vy;
 630   int vxsize, vysize;
 631
 632   int draw_deactivation_mask;
 633   int draw_background_mask;
 634
 635   Bitmap *field_save_buffer;
 636
 637   Bitmap *background_bitmap;
 638   int background_bitmap_mask;
 639
 640   int num_fonts;
 641   struct FontBitmapInfo *font_bitmap_info;
 642   int (*select_font_function)(int);
 643
 644   int anim_random_frame;
 645 };
 646
 647 struct JoystickInfo
 648 {
 649   int status;
 650   int fd[MAX_PLAYERS];          /* file descriptor of player's joystick */
 651 };
 652
 653 struct SetupJoystickInfo
 654 {
 655   char *device_name;            /* device name of player's joystick */
 656
 657   int xleft, xmiddle, xright;
 658   int yupper, ymiddle, ylower;
 659   int snap, drop;
 660 };
 661
 662 struct SetupKeyboardInfo
 663 {
 664   Key left, right, up, down;
 665   Key snap, drop;
 666 };
 667
 668 struct SetupInputInfo
 669 {
 670   boolean use_joystick;
 671   struct SetupJoystickInfo joy;
 672   struct SetupKeyboardInfo key;
 673 };
 674
 675 struct SetupEditorInfo
 676 {
 677   boolean el_boulderdash;
 678   boolean el_emerald_mine;
 679   boolean el_emerald_mine_club;
 680   boolean el_more;
 681   boolean el_sokoban;
 682   boolean el_supaplex;
 683   boolean el_diamond_caves;
 684   boolean el_dx_boulderdash;
 685   boolean el_chars;
 686   boolean el_custom;
 687   boolean el_user_defined;
 688   boolean el_dynamic;
 689
 690   boolean el_headlines;
 691
 692   boolean el_by_game;
 693   boolean el_by_type;
 694
 695   boolean show_element_token;
 696 };
 697
 698 struct SetupEditorCascadeInfo
 699 {
 700   boolean el_bd;
 701   boolean el_em;
 702   boolean el_emc;
 703   boolean el_rnd;
 704   boolean el_sb;
 705   boolean el_sp;
 706   boolean el_dc;
 707   boolean el_dx;
 708   boolean el_chars;
 709   boolean el_ce;
 710   boolean el_ge;
 711   boolean el_ref;
 712   boolean el_user;
 713   boolean el_dynamic;
 714 };
 715
 716 struct SetupShortcutInfo
 717 {
 718   Key save_game;
 719   Key load_game;
 720   Key toggle_pause;
 721
 722   Key focus_player[MAX_PLAYERS];
 723   Key focus_player_all;
 724 };
 725
 726 struct SetupSystemInfo
 727 {
 728   char *sdl_audiodriver;
 729   int audio_fragment_size;
 730 };
 731
 732 struct SetupInfo
 733 {
 734   char *player_name;
 735
 736   boolean sound;
 737   boolean sound_loops;
 738   boolean sound_music;
 739   boolean sound_simple;
 740   boolean toons;
 741   boolean double_buffering;
 742   boolean direct_draw;          /* !double_buffering (redundant!) */
 743   boolean scroll_delay;
 744   boolean soft_scrolling;
 745   boolean fading;
 746   boolean autorecord;
 747   boolean show_titlescreen;
 748   boolean quick_doors;
 749   boolean team_mode;
 750   boolean handicap;
 751   boolean skip_levels;
 752   boolean time_limit;
 753   boolean fullscreen;
 754   boolean ask_on_escape;
 755   boolean ask_on_escape_editor;
 756   boolean quick_switch;
 757   boolean input_on_focus;
 758   boolean prefer_aga_graphics;
 759
 760   char *graphics_set;
 761   char *sounds_set;
 762   char *music_set;
 763   boolean override_level_graphics;
 764   boolean override_level_sounds;
 765   boolean override_level_music;
 766
 767   struct SetupEditorInfo editor;
 768   struct SetupEditorCascadeInfo editor_cascade;
 769   struct SetupShortcutInfo shortcut;
 770   struct SetupInputInfo input[MAX_PLAYERS];
 771   struct SetupSystemInfo system;
 772   struct OptionInfo options;
 773 };
 774
 775 struct TreeInfo
 776 {
 777   struct TreeInfo **node_top;           /* topmost node in tree */
 778   struct TreeInfo *node_parent;         /* parent level directory info */
 779   struct TreeInfo *node_group;          /* level group sub-directory info */
 780   struct TreeInfo *next;                /* next level series structure node */
 781
 782   int cl_first;         /* internal control field for setup screen */
 783   int cl_cursor;        /* internal control field for setup screen */
 784
 785   int type;             /* type of tree content */
 786
 787   /* fields for "type == TREE_TYPE_LEVEL_DIR" */
 788
 789   char *subdir;         /* tree info sub-directory basename (may be ".") */
 790   char *fullpath;       /* complete path relative to tree base directory */
 791   char *basepath;       /* absolute base path of tree base directory */
 792   char *identifier;     /* identifier string for configuration files */
 793   char *name;           /* tree info name, as displayed in selection menues */
 794   char *name_sorting;   /* optional sorting name for correct name sorting */
 795   char *author;         /* level or artwork author name */
 796   char *imported_from;  /* optional comment for imported levels or artwork */
 797   char *imported_by;    /* optional comment for imported levels or artwork */
 798
 799   char *graphics_set_ecs; /* special EMC custom graphics set (ECS graphics) */
 800   char *graphics_set_aga; /* special EMC custom graphics set (AGA graphics) */
 801   char *graphics_set;   /* optional custom graphics set (level tree only) */
 802   char *sounds_set;     /* optional custom sounds set (level tree only) */
 803   char *music_set;      /* optional custom music set (level tree only) */
 804   char *graphics_path;  /* path to optional custom graphics set (level only) */
 805   char *sounds_path;    /* path to optional custom sounds set (level only) */
 806   char *music_path;     /* path to optional custom music set (level only) */
 807
 808   char *level_filename; /* filename of level file (for packed level file) */
 809   char *level_filetype; /* type of levels in level directory or level file */
 810
 811   int levels;           /* number of levels in level series */
 812   int first_level;      /* first level number (to allow start with 0 or 1) */
 813   int last_level;       /* last level number (automatically calculated) */
 814   int sort_priority;    /* sort levels by 'sort_priority' and then by name */
 815
 816   boolean latest_engine;/* force level set to use the latest game engine */
 817
 818   boolean level_group;  /* directory contains more level series directories */
 819   boolean parent_link;  /* entry links back to parent directory */
 820   boolean in_user_dir;  /* user defined levels are stored in home directory */
 821   boolean user_defined; /* levels in user directory and marked as "private" */
 822   boolean readonly;     /* readonly levels can not be changed with editor */
 823   boolean handicap;     /* level set has no handicap when set to "false" */
 824   boolean skip_levels;  /* levels can be skipped when set to "true" */
 825
 826   int color;            /* color to use on selection screen for this level */
 827   char *class_desc;     /* description of level series class */
 828   int handicap_level;   /* number of the lowest unsolved level */
 829 };
 830
 831 typedef struct TreeInfo TreeInfo;
 832 typedef struct TreeInfo LevelDirTree;
 833 typedef struct TreeInfo ArtworkDirTree;
 834 typedef struct TreeInfo GraphicsDirTree;
 835 typedef struct TreeInfo SoundsDirTree;
 836 typedef struct TreeInfo MusicDirTree;
 837
 838 struct ArtworkInfo
 839 {
 840   GraphicsDirTree *gfx_first;
 841   GraphicsDirTree *gfx_current;
 842   SoundsDirTree *snd_first;
 843   SoundsDirTree *snd_current;
 844   MusicDirTree *mus_first;
 845   MusicDirTree *mus_current;
 846
 847   char *gfx_current_identifier;
 848   char *snd_current_identifier;
 849   char *mus_current_identifier;
 850 };
 851
 852 struct ValueTextInfo
 853 {
 854   int value;
 855   char *text;
 856 };
 857
 858 struct ConfigInfo
 859 {
 860   char *token;
 861   char *value;
 862 };
 863
 864 struct ConfigTypeInfo
 865 {
 866   char *token;
 867   char *value;
 868   int type;
 869 };
 870
 871 struct TokenIntPtrInfo
 872 {
 873   char *token;
 874   int *value;
 875 };
 876
 877 struct FileInfo
 878 {
 879   char *token;
 880
 881   char *default_filename;
 882   char *filename;
 883
 884   char **default_parameter;                     /* array of file parameters */
 885   char **parameter;                             /* array of file parameters */
 886
 887   boolean redefined;
 888   boolean fallback_to_default;
 889 };
 890
 891 struct SetupFileList
 892 {
 893   char *token;
 894   char *value;
 895
 896   struct SetupFileList *next;
 897 };
 898
 899 struct ListNodeInfo
 900 {
 901   char *source_filename;                        /* primary key for node list */
 902   int num_references;
 903 };
 904
 905 struct PropertyMapping
 906 {
 907   int base_index;
 908   int ext1_index;
 909   int ext2_index;
 910   int ext3_index;
 911
 912   int artwork_index;
 913 };
 914
 915 struct ArtworkListInfo
 916 {
 917   int type;                                     /* type of artwork */
 918
 919   int num_file_list_entries;
 920   int num_dynamic_file_list_entries;
 921   struct FileInfo *file_list;                   /* static artwork file array */
 922   struct FileInfo *dynamic_file_list;           /* dynamic artwrk file array */
 923
 924   int num_suffix_list_entries;
 925   struct ConfigTypeInfo *suffix_list;           /* parameter suffixes array */
 926
 927   int num_base_prefixes;
 928   int num_ext1_suffixes;
 929   int num_ext2_suffixes;
 930   int num_ext3_suffixes;
 931   char **base_prefixes;                         /* base token prefixes array */
 932   char **ext1_suffixes;                         /* property suffixes array 1 */
 933   char **ext2_suffixes;                         /* property suffixes array 2 */
 934   char **ext3_suffixes;                         /* property suffixes array 3 */
 935
 936   int num_ignore_tokens;
 937   char **ignore_tokens;                         /* file tokens to be ignored */
 938
 939   int num_property_mapping_entries;
 940   struct PropertyMapping *property_mapping;     /* mapping token -> artwork */
 941
 942   int sizeof_artwork_list_entry;
 943
 944   struct ListNodeInfo **artwork_list;           /* static artwork node array */
 945   struct ListNodeInfo **dynamic_artwork_list;   /* dynamic artwrk node array */
 946   struct ListNode *content_list;                /* dynamic artwork node list */
 947
 948   void *(*load_artwork)(char *);                /* constructor function */
 949   void (*free_artwork)(void *);                 /* destructor function */
 950 };
 951
 952
 953 /* ========================================================================= */
 954 /* exported variables                                                        */
 955 /* ========================================================================= */
 956
 957 extern struct ProgramInfo       program;
 958 extern struct OptionInfo        options;
 959 extern struct VideoSystemInfo   video;
 960 extern struct AudioSystemInfo   audio;
 961 extern struct GfxInfo           gfx;
 962 extern struct AnimInfo          anim;
 963 extern struct ArtworkInfo       artwork;
 964 extern struct JoystickInfo      joystick;
 965 extern struct SetupInfo         setup;
 966
 967 extern LevelDirTree            *leveldir_first_all;
 968 extern LevelDirTree            *leveldir_first;
 969 extern LevelDirTree            *leveldir_current;
 970 extern int                      level_nr;
 971
 972 extern Display                 *display;
 973 extern Visual                  *visual;
 974 extern int                      screen;
 975 extern Colormap                 cmap;
 976
 977 extern DrawWindow              *window;
 978 extern DrawBuffer              *backbuffer;
 979 extern DrawBuffer              *drawto;
 980
 981 extern int                      button_status;
 982 extern boolean                  motion_status;
 983
 984 extern int                      redraw_mask;
 985 extern int                      redraw_tiles;
 986
 987 extern int                      FrameCounter;
 988
 989
 990 /* function definitions */
 991
 992 void InitProgramInfo(char *, char *, char *, char *, char *, char *, char *,
 993                      char *, char *, char *, int);
 994
 995 void InitExitFunction(void (*exit_function)(int));
 996 void InitPlatformDependentStuff(void);
 997 void ClosePlatformDependentStuff(void);
 998
 999 void InitGfxFieldInfo(int, int, int, int, int, int, int, int, Bitmap *);
1000 void InitGfxDoor1Info(int, int, int, int);
1001 void InitGfxDoor2Info(int, int, int, int);
1002 void InitGfxScrollbufferInfo(int, int);
1003 void SetDrawDeactivationMask(int);
1004 void SetDrawBackgroundMask(int);
1005 void SetMainBackgroundBitmap(Bitmap *);
1006 void SetDoorBackgroundBitmap(Bitmap *);
1007
1008 void InitVideoDisplay(void);
1009 void CloseVideoDisplay(void);
1010 void InitVideoBuffer(DrawBuffer **,DrawWindow **, int,int,int, boolean);
1011 Bitmap *CreateBitmapStruct(void);
1012 Bitmap *CreateBitmap(int, int, int);
1013 void FreeBitmap(Bitmap *);
1014 void BlitBitmap(Bitmap *, Bitmap *, int, int, int, int, int, int);
1015 void FadeScreen(Bitmap *bitmap, int, int, int);
1016 void FillRectangle(Bitmap *, int, int, int, int, Pixel);
1017 void ClearRectangle(Bitmap *, int, int, int, int);
1018 void ClearRectangleOnBackground(Bitmap *, int, int, int, int);
1019 void SetClipMask(Bitmap *, GC, Pixmap);
1020 void SetClipOrigin(Bitmap *, GC, int, int);
1021 void BlitBitmapMasked(Bitmap *, Bitmap *, int, int, int, int, int, int);
1022 boolean DrawingOnBackground(int, int);
1023 void BlitBitmapOnBackground(Bitmap *, Bitmap *, int, int, int, int, int, int);
1024 void DrawSimpleBlackLine(Bitmap *, int, int, int, int);
1025 void DrawSimpleWhiteLine(Bitmap *, int, int, int, int);
1026 void DrawLines(Bitmap *, struct XY *, int, Pixel);
1027 Pixel GetPixel(Bitmap *, int, int);
1028 Pixel GetPixelFromRGB(Bitmap *, unsigned int,unsigned int,unsigned int);
1029 Pixel GetPixelFromRGBcompact(Bitmap *, unsigned int);
1030
1031 void FlushDisplay(void);
1032 void SyncDisplay(void);
1033 void KeyboardAutoRepeatOn(void);
1034 void KeyboardAutoRepeatOff(void);
1035 boolean PointerInWindow(DrawWindow *);
1036 boolean SetVideoMode(boolean);
1037 boolean ChangeVideoModeIfNeeded(boolean);
1038
1039 Bitmap *LoadImage(char *);
1040 Bitmap *LoadCustomImage(char *);
1041 void ReloadCustomImage(Bitmap *, char *);
1042
1043 Bitmap *ZoomBitmap(Bitmap *, int, int);
1044 void CreateBitmapWithSmallBitmaps(Bitmap *, int);
1045 void ScaleBitmap(Bitmap *, int);
1046
1047 void SetMouseCursor(int);
1048
1049 void OpenAudio(void);
1050 void CloseAudio(void);
1051 void SetAudioMode(boolean);
1052
1053 void InitEventFilter(EventFilter);
1054 boolean PendingEvent(void);
1055 void NextEvent(Event *event);
1056 void PeekEvent(Event *event);
1057 Key GetEventKey(KeyEvent *, boolean);
1058 KeyMod HandleKeyModState(Key, int);
1059 KeyMod GetKeyModState();
1060 boolean CheckCloseWindowEvent(ClientMessageEvent *);
1061
1062 void InitJoysticks();
1063 boolean ReadJoystick(int, int *, int *, boolean *, boolean *);
1064
1065 #endif /* SYSTEM_H */