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_BOMB        KSYM_KP_Enter
  59 #else
  60 #define DEFAULT_KEY_SNAP        KSYM_Shift_L
  61 #define DEFAULT_KEY_BOMB        KSYM_Shift_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
  71 /* values for key_status */
  72 #define KEY_NOT_PRESSED         FALSE
  73 #define KEY_RELEASED            FALSE
  74 #define KEY_PRESSED             TRUE
  75
  76 /* values for button status */
  77 #define MB_NOT_PRESSED          FALSE
  78 #define MB_NOT_RELEASED         TRUE
  79 #define MB_RELEASED             FALSE
  80 #define MB_PRESSED              TRUE
  81 #define MB_MENU_CHOICE          FALSE
  82 #define MB_MENU_MARK            TRUE
  83 #define MB_MENU_INITIALIZE      (-1)
  84 #define MB_MENU_LEAVE           (-2)
  85 #define MB_LEFTBUTTON           1
  86 #define MB_MIDDLEBUTTON         2
  87 #define MB_RIGHTBUTTON          3
  88
  89
  90 /* values for move directions */
  91 #define MV_BIT_LEFT             0
  92 #define MV_BIT_RIGHT            1
  93 #define MV_BIT_UP               2
  94 #define MV_BIT_DOWN             3
  95
  96 #define NUM_DIRECTIONS          4
  97
  98 /* values for special "button" bitmasks */
  99 #define BUTTON_1                4
 100 #define BUTTON_2                5
 101
 102 /* values for move direction and special "button" key bitmasks */
 103 #define MV_NO_MOVING            0
 104 #define MV_LEFT                 (1 << MV_BIT_LEFT)
 105 #define MV_RIGHT                (1 << MV_BIT_RIGHT)
 106 #define MV_UP                   (1 << MV_BIT_UP)
 107 #define MV_DOWN                 (1 << MV_BIT_DOWN)
 108
 109 #define KEY_BUTTON_1            (1 << BUTTON_1)
 110 #define KEY_BUTTON_2            (1 << BUTTON_2)
 111 #define KEY_MOTION              (MV_LEFT | MV_RIGHT | MV_UP | MV_DOWN)
 112 #define KEY_BUTTON              (KEY_BUTTON_1 | KEY_BUTTON_2)
 113 #define KEY_ACTION              (KEY_MOTION | KEY_BUTTON)
 114
 115 #define MV_DIR_BIT(x)           ((x) == MV_LEFT  ? MV_BIT_LEFT  :       \
 116                                  (x) == MV_RIGHT ? MV_BIT_RIGHT :       \
 117                                  (x) == MV_UP    ? MV_BIT_UP    : MV_BIT_DOWN)
 118
 119
 120 /* values for animation mode (frame order and direction) */
 121 #define ANIM_NONE               0
 122 #define ANIM_LOOP               (1 << 0)
 123 #define ANIM_LINEAR             (1 << 1)
 124 #define ANIM_PINGPONG           (1 << 2)
 125 #define ANIM_PINGPONG2          (1 << 3)
 126 #define ANIM_RANDOM             (1 << 4)
 127 #define ANIM_REVERSE            (1 << 5)
 128
 129 /* values for special (non game element) animation modes */
 130 #define ANIM_HORIZONTAL         (1 << 6)
 131 #define ANIM_VERTICAL           (1 << 7)
 132
 133 #define ANIM_DEFAULT            ANIM_LOOP
 134
 135 /* values for redraw_mask */
 136 #define REDRAW_NONE             (0)
 137 #define REDRAW_ALL              (1 << 0)
 138 #define REDRAW_FIELD            (1 << 1)
 139 #define REDRAW_TILES            (1 << 2)
 140 #define REDRAW_DOOR_1           (1 << 3)
 141 #define REDRAW_VIDEO_1          (1 << 4)
 142 #define REDRAW_VIDEO_2          (1 << 5)
 143 #define REDRAW_VIDEO_3          (1 << 6)
 144 #define REDRAW_MICROLEVEL       (1 << 7)
 145 #define REDRAW_MICROLABEL       (1 << 8)
 146 #define REDRAW_FROM_BACKBUFFER  (1 << 9)
 147 #define REDRAW_DOOR_2           (REDRAW_VIDEO_1 | \
 148                                  REDRAW_VIDEO_2 | \
 149                                  REDRAW_VIDEO_3)
 150 #define REDRAW_DOOR_3           (1 << 10)
 151 #define REDRAW_DOORS            (REDRAW_DOOR_1 | \
 152                                  REDRAW_DOOR_2 | \
 153                                  REDRAW_DOOR_3)
 154 #define REDRAW_MAIN             (REDRAW_FIELD | \
 155                                  REDRAW_TILES | \
 156                                  REDRAW_MICROLEVEL)
 157 #define REDRAW_FPS              (1 << 11)
 158 #define REDRAWTILES_THRESHOLD   (SCR_FIELDX * SCR_FIELDY / 2)
 159
 160
 161 /* values for mouse cursor */
 162 #define CURSOR_DEFAULT          0
 163 #define CURSOR_PLAYFIELD        1
 164
 165
 166 /* maximum number of parallel players supported by libgame functions */
 167 #define MAX_PLAYERS             4
 168
 169 /* maximum allowed length of player name */
 170 #define MAX_PLAYER_NAME_LEN     10
 171
 172 /* default name for empty highscore entry */
 173 #define EMPTY_PLAYER_NAME       "no name"
 174
 175 /* default name for unknown player names */
 176 #define ANONYMOUS_NAME          "anonymous"
 177
 178 /* default name for new levels */
 179 #define NAMELESS_LEVEL_NAME     "nameless level"
 180
 181 /* default text for non-existant artwork */
 182 #define NOT_AVAILABLE           "(not available)"
 183
 184 /* default value for undefined filename */
 185 #define UNDEFINED_FILENAME      "[NONE]"
 186
 187 /* default value for undefined parameter */
 188 #define ARG_DEFAULT             "[DEFAULT]"
 189
 190 /* default values for undefined configuration file parameters */
 191 #define ARG_UNDEFINED           "-1000000"
 192 #define ARG_UNDEFINED_VALUE     (atoi(ARG_UNDEFINED))
 193
 194 /* definitions for game sub-directories */
 195 #ifndef RO_GAME_DIR
 196 #define RO_GAME_DIR             "."
 197 #endif
 198
 199 #ifndef RW_GAME_DIR
 200 #define RW_GAME_DIR             "."
 201 #endif
 202
 203 #define RO_BASE_PATH            RO_GAME_DIR
 204 #define RW_BASE_PATH            RW_GAME_DIR
 205
 206 /* directory names */
 207 #define GRAPHICS_DIRECTORY      "graphics"
 208 #define SOUNDS_DIRECTORY        "sounds"
 209 #define MUSIC_DIRECTORY         "music"
 210 #define LEVELS_DIRECTORY        "levels"
 211 #define TAPES_DIRECTORY         "tapes"
 212 #define SCORES_DIRECTORY        "scores"
 213 #define DOCS_DIRECTORY          "docs"
 214
 215 #if !defined(PLATFORM_MSDOS)
 216 #define GFX_CLASSIC_SUBDIR      "gfx_classic"
 217 #define SND_CLASSIC_SUBDIR      "snd_classic"
 218 #define MUS_CLASSIC_SUBDIR      "mus_classic"
 219 #else
 220 #define GFX_CLASSIC_SUBDIR      "gfx_orig"
 221 #define SND_CLASSIC_SUBDIR      "snd_orig"
 222 #define MUS_CLASSIC_SUBDIR      "mus_orig"
 223 #endif
 224
 225 /* file names and filename extensions */
 226 #if !defined(PLATFORM_MSDOS)
 227 #define LEVELSETUP_DIRECTORY    "levelsetup"
 228 #define SETUP_FILENAME          "setup.conf"
 229 #define LEVELSETUP_FILENAME     "levelsetup.conf"
 230 #define EDITORSETUP_FILENAME    "editorsetup.conf"
 231 #define LEVELINFO_FILENAME      "levelinfo.conf"
 232 #define GRAPHICSINFO_FILENAME   "graphicsinfo.conf"
 233 #define SOUNDSINFO_FILENAME     "soundsinfo.conf"
 234 #define MUSICINFO_FILENAME      "musicinfo.conf"
 235 #define LEVELFILE_EXTENSION     "level"
 236 #define TAPEFILE_EXTENSION      "tape"
 237 #define SCOREFILE_EXTENSION     "score"
 238 #else
 239 #define LEVELSETUP_DIRECTORY    "lvlsetup"
 240 #define SETUP_FILENAME          "setup.cnf"
 241 #define LEVELSETUP_FILENAME     "lvlsetup.cnf"
 242 #define EDITORSETUP_FILENAME    "edsetup.conf"
 243 #define LEVELINFO_FILENAME      "lvlinfo.cnf"
 244 #define GRAPHICSINFO_FILENAME   "gfxinfo.cnf"
 245 #define SOUNDSINFO_FILENAME     "sndinfo.cnf"
 246 #define MUSICINFO_FILENAME      "musinfo.cnf"
 247 #define LEVELFILE_EXTENSION     "lvl"
 248 #define TAPEFILE_EXTENSION      "tap"
 249 #define SCOREFILE_EXTENSION     "sco"
 250 #endif
 251
 252
 253 /* areas in bitmap PIX_DOOR */
 254 /* meaning in PIX_DB_DOOR: (3 PAGEs)
 255    PAGEX1: 1. buffer for DOOR_1
 256    PAGEX2: 2. buffer for DOOR_1
 257    PAGEX3: buffer for animations
 258 */
 259
 260 #define DOOR_GFX_PAGESIZE       (gfx.dxsize)
 261 #define DOOR_GFX_PAGEX1         (0 * DOOR_GFX_PAGESIZE)
 262 #define DOOR_GFX_PAGEX2         (1 * DOOR_GFX_PAGESIZE)
 263 #define DOOR_GFX_PAGEX3         (2 * DOOR_GFX_PAGESIZE)
 264 #define DOOR_GFX_PAGEX4         (3 * DOOR_GFX_PAGESIZE)
 265 #define DOOR_GFX_PAGEX5         (4 * DOOR_GFX_PAGESIZE)
 266 #define DOOR_GFX_PAGEX6         (5 * DOOR_GFX_PAGESIZE)
 267 #define DOOR_GFX_PAGEX7         (6 * DOOR_GFX_PAGESIZE)
 268 #define DOOR_GFX_PAGEX8         (7 * DOOR_GFX_PAGESIZE)
 269 #define DOOR_GFX_PAGEY1         (0)
 270 #define DOOR_GFX_PAGEY2         (gfx.dysize)
 271
 272
 273 /* macros for version handling */
 274 #define VERSION_MAJOR(x)        ((x) / 1000000)
 275 #define VERSION_MINOR(x)        (((x) % 1000000) / 10000)
 276 #define VERSION_PATCH(x)        (((x) % 10000) / 100)
 277 #define VERSION_BUILD(x)        ((x) % 100)
 278 #define VERSION_IDENT(a,b,c,d)  ((a) * 1000000 + (b) * 10000 + (c) * 100 + (d))
 279
 280
 281 /* macros for parent/child process identification */
 282 #if defined(PLATFORM_UNIX)
 283 #define IS_PARENT_PROCESS()     (audio.mixer_pid != getpid())
 284 #define IS_CHILD_PROCESS()      (audio.mixer_pid == getpid())
 285 #define HAS_CHILD_PROCESS()     (audio.mixer_pid > 0)
 286 #else
 287 #define IS_PARENT_PROCESS()     TRUE
 288 #define IS_CHILD_PROCESS()      FALSE
 289 #define HAS_CHILD_PROCESS()     FALSE
 290 #endif
 291
 292
 293 /* values for artwork type */
 294 #define ARTWORK_TYPE_GRAPHICS   0
 295 #define ARTWORK_TYPE_SOUNDS     1
 296 #define ARTWORK_TYPE_MUSIC      2
 297
 298 #define NUM_ARTWORK_TYPES       3
 299
 300
 301 /* values for tree type (chosen to match artwork type) */
 302 #define TREE_TYPE_UNDEFINED     -1
 303 #define TREE_TYPE_GRAPHICS_DIR  ARTWORK_TYPE_GRAPHICS
 304 #define TREE_TYPE_SOUNDS_DIR    ARTWORK_TYPE_SOUNDS
 305 #define TREE_TYPE_MUSIC_DIR     ARTWORK_TYPE_MUSIC
 306 #define TREE_TYPE_LEVEL_DIR     3
 307
 308 #define NUM_TREE_TYPES          4
 309
 310
 311 /* values for artwork handling */
 312 #define LEVELDIR_ARTWORK_SET(leveldir, type)                            \
 313                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
 314                                  (leveldir)->graphics_set :             \
 315                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
 316                                  (leveldir)->sounds_set :               \
 317                                  (leveldir)->music_set)
 318
 319 #define LEVELDIR_ARTWORK_PATH(leveldir, type)                           \
 320                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
 321                                  (leveldir)->graphics_path :            \
 322                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
 323                                  (leveldir)->sounds_path :              \
 324                                  (leveldir)->music_path)
 325
 326 #define SETUP_ARTWORK_SET(setup, type)                                  \
 327                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
 328                                  (setup).graphics_set :                 \
 329                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
 330                                  (setup).sounds_set :                   \
 331                                  (setup).music_set)
 332
 333 #define SETUP_OVERRIDE_ARTWORK(setup, type)                             \
 334                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
 335                                  (setup).override_level_graphics :      \
 336                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
 337                                  (setup).override_level_sounds :        \
 338                                  (setup).override_level_music)
 339
 340 #define ARTWORK_FIRST_NODE(artwork, type)                               \
 341                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
 342                                  (artwork).gfx_first :  \
 343                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
 344                                  (artwork).snd_first :  \
 345                                  (artwork).mus_first)
 346
 347 #define ARTWORK_CURRENT_IDENTIFIER(artwork, type)                       \
 348                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
 349                                  (artwork).gfx_current_identifier :     \
 350                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
 351                                  (artwork).snd_current_identifier :     \
 352                                  (artwork).mus_current_identifier)
 353
 354 #define ARTWORKINFO_FILENAME(type)                                      \
 355                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
 356                                  GRAPHICSINFO_FILENAME :                \
 357                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
 358                                  SOUNDSINFO_FILENAME :                  \
 359                                  (type) == ARTWORK_TYPE_MUSIC ?         \
 360                                  MUSICINFO_FILENAME : "")
 361
 362 #define ARTWORK_DIRECTORY(type)                                         \
 363                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
 364                                  GRAPHICS_DIRECTORY :                   \
 365                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
 366                                  SOUNDS_DIRECTORY :                     \
 367                                  (type) == ARTWORK_TYPE_MUSIC ?         \
 368                                  MUSIC_DIRECTORY : "")
 369
 370 #define OPTIONS_ARTWORK_DIRECTORY(type)                                 \
 371                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
 372                                  options.graphics_directory :           \
 373                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
 374                                  options.sounds_directory :             \
 375                                  (type) == ARTWORK_TYPE_MUSIC ?         \
 376                                  options.music_directory : "")
 377
 378
 379 /* type definitions */
 380 typedef int (*EventFilter)(const Event *);
 381
 382
 383 /* structure definitions */
 384
 385 struct ProgramInfo
 386 {
 387   char *command_basename;
 388   char *userdata_directory;
 389
 390   char *program_title;
 391   char *window_title;
 392   char *icon_title;
 393
 394   char *x11_icon_filename;
 395   char *x11_iconmask_filename;
 396   char *msdos_cursor_filename;
 397
 398   char *cookie_prefix;
 399   char *filename_prefix;        /* prefix to cut off from DOS filenames */
 400
 401   int version_major;
 402   int version_minor;
 403   int version_patch;
 404
 405   void (*exit_function)(int);
 406 };
 407
 408 struct OptionInfo
 409 {
 410   char *display_name;
 411   char *server_host;
 412   int server_port;
 413
 414   char *ro_base_directory;
 415   char *rw_base_directory;
 416   char *level_directory;
 417   char *graphics_directory;
 418   char *sounds_directory;
 419   char *music_directory;
 420   char *docs_directory;
 421   char *execute_command;
 422
 423   boolean serveronly;
 424   boolean network;
 425   boolean verbose;
 426   boolean debug;
 427 };
 428
 429 struct VideoSystemInfo
 430 {
 431   int default_depth;
 432   int width, height, depth;
 433   boolean fullscreen_available;
 434   boolean fullscreen_enabled;
 435 };
 436
 437 struct AudioSystemInfo
 438 {
 439   boolean sound_available;
 440   boolean loops_available;
 441   boolean music_available;
 442
 443   boolean sound_enabled;
 444   boolean sound_deactivated;    /* for temporarily disabling sound */
 445
 446   int mixer_pipe[2];
 447   int mixer_pid;
 448   char *device_name;
 449   int device_fd;
 450
 451   int num_channels;
 452   int music_channel;
 453   int first_sound_channel;
 454 };
 455
 456 struct FontBitmapInfo
 457 {
 458   Bitmap *bitmap;
 459   int src_x, src_y;             /* start position of animation frames */
 460   int width, height;            /* width/height of each animation frame */
 461   int draw_x, draw_y;           /* offset for drawing font characters */
 462   int num_chars;
 463   int num_chars_per_line;
 464
 465 #if defined(TARGET_X11_NATIVE_PERFORMANCE_WORKAROUND)
 466   Pixmap *clip_mask;            /* single-char-only clip mask array for X11 */
 467 #endif
 468 };
 469
 470 struct GfxInfo
 471 {
 472   int sx, sy;
 473   int sxsize, sysize;
 474   int real_sx, real_sy;
 475   int full_sxsize, full_sysize;
 476   int scrollbuffer_width, scrollbuffer_height;
 477
 478   int dx, dy;
 479   int dxsize, dysize;
 480
 481   int vx, vy;
 482   int vxsize, vysize;
 483
 484   int draw_deactivation_mask;
 485   int draw_background_mask;
 486
 487   Bitmap *field_save_buffer;
 488
 489   Bitmap *background_bitmap;
 490   int background_bitmap_mask;
 491
 492   int num_fonts;
 493   struct FontBitmapInfo *font_bitmap_info;
 494   int (*select_font_function)(int);
 495
 496   int anim_random_frame;
 497 };
 498
 499 struct JoystickInfo
 500 {
 501   int status;
 502   int fd[MAX_PLAYERS];          /* file descriptor of player's joystick */
 503 };
 504
 505 struct SetupJoystickInfo
 506 {
 507   char *device_name;            /* device name of player's joystick */
 508
 509   int xleft, xmiddle, xright;
 510   int yupper, ymiddle, ylower;
 511   int snap;
 512   int bomb;
 513 };
 514
 515 struct SetupKeyboardInfo
 516 {
 517   Key left;
 518   Key right;
 519   Key up;
 520   Key down;
 521   Key snap;
 522   Key bomb;
 523 };
 524
 525 struct SetupInputInfo
 526 {
 527   boolean use_joystick;
 528   struct SetupJoystickInfo joy;
 529   struct SetupKeyboardInfo key;
 530 };
 531
 532 struct SetupEditorInfo
 533 {
 534   boolean el_boulderdash;
 535   boolean el_emerald_mine;
 536   boolean el_more;
 537   boolean el_sokoban;
 538   boolean el_supaplex;
 539   boolean el_diamond_caves;
 540   boolean el_dx_boulderdash;
 541   boolean el_chars;
 542   boolean el_custom;
 543   boolean el_custom_more;
 544   boolean el_user_defined;
 545
 546   boolean el_headlines;
 547 };
 548
 549 struct SetupShortcutInfo
 550 {
 551   Key save_game;
 552   Key load_game;
 553   Key toggle_pause;
 554 };
 555
 556 struct SetupSystemInfo
 557 {
 558   char *sdl_audiodriver;
 559   int audio_fragment_size;
 560 };
 561
 562 struct SetupInfo
 563 {
 564   char *player_name;
 565
 566   boolean sound;
 567   boolean sound_loops;
 568   boolean sound_music;
 569   boolean sound_simple;
 570   boolean toons;
 571   boolean double_buffering;
 572   boolean direct_draw;          /* !double_buffering (redundant!) */
 573   boolean scroll_delay;
 574   boolean soft_scrolling;
 575   boolean fading;
 576   boolean autorecord;
 577   boolean quick_doors;
 578   boolean team_mode;
 579   boolean handicap;
 580   boolean time_limit;
 581   boolean fullscreen;
 582   boolean ask_on_escape;
 583
 584   char *graphics_set;
 585   char *sounds_set;
 586   char *music_set;
 587   boolean override_level_graphics;
 588   boolean override_level_sounds;
 589   boolean override_level_music;
 590
 591   struct SetupEditorInfo editor;
 592   struct SetupShortcutInfo shortcut;
 593   struct SetupInputInfo input[MAX_PLAYERS];
 594   struct SetupSystemInfo system;
 595   struct OptionInfo options;
 596 };
 597
 598 struct TreeInfo
 599 {
 600   struct TreeInfo **node_top;           /* topmost node in tree */
 601   struct TreeInfo *node_parent;         /* parent level directory info */
 602   struct TreeInfo *node_group;          /* level group sub-directory info */
 603   struct TreeInfo *next;                /* next level series structure node */
 604
 605   int cl_first;         /* internal control field for setup screen */
 606   int cl_cursor;        /* internal control field for setup screen */
 607
 608   int type;             /* type of tree content */
 609
 610   /* fields for "type == TREE_TYPE_LEVEL_DIR" */
 611
 612   char *filename;       /* tree info sub-directory basename (may be ".") */
 613   char *fullpath;       /* complete path relative to tree base directory */
 614   char *basepath;       /* absolute base path of tree base directory */
 615   char *identifier;     /* identifier string for configuration files */
 616   char *name;           /* tree info name, as displayed in selection menues */
 617   char *name_sorting;   /* optional sorting name for correct name sorting */
 618   char *author;         /* level or artwork author name */
 619   char *imported_from;  /* optional comment for imported levels or artwork */
 620
 621   char *graphics_set;   /* optional custom graphics set (level tree only) */
 622   char *sounds_set;     /* optional custom sounds set (level tree only) */
 623   char *music_set;      /* optional custom music set (level tree only) */
 624   char *graphics_path;  /* path to optional custom graphics set (level only) */
 625   char *sounds_path;    /* path to optional custom sounds set (level only) */
 626   char *music_path;     /* path to optional custom music set (level only) */
 627
 628   int levels;           /* number of levels in level series */
 629   int first_level;      /* first level number (to allow start with 0 or 1) */
 630   int last_level;       /* last level number (automatically calculated) */
 631   int sort_priority;    /* sort levels by 'sort_priority' and then by name */
 632
 633   boolean latest_engine;/* force level set to use the latest game engine */
 634
 635   boolean level_group;  /* directory contains more level series directories */
 636   boolean parent_link;  /* entry links back to parent directory */
 637   boolean user_defined; /* user defined levels are stored in home directory */
 638   boolean readonly;     /* readonly levels can not be changed with editor */
 639
 640   int color;            /* color to use on selection screen for this level */
 641   char *class_desc;     /* description of level series class */
 642   int handicap_level;   /* number of the lowest unsolved level */
 643 };
 644
 645 typedef struct TreeInfo TreeInfo;
 646 typedef struct TreeInfo LevelDirTree;
 647 typedef struct TreeInfo ArtworkDirTree;
 648 typedef struct TreeInfo GraphicsDirTree;
 649 typedef struct TreeInfo SoundsDirTree;
 650 typedef struct TreeInfo MusicDirTree;
 651
 652 struct ArtworkInfo
 653 {
 654   GraphicsDirTree *gfx_first;
 655   GraphicsDirTree *gfx_current;
 656   SoundsDirTree *snd_first;
 657   SoundsDirTree *snd_current;
 658   MusicDirTree *mus_first;
 659   MusicDirTree *mus_current;
 660
 661   char *gfx_current_identifier;
 662   char *snd_current_identifier;
 663   char *mus_current_identifier;
 664 };
 665
 666 struct ValueTextInfo
 667 {
 668   int value;
 669   char *text;
 670 };
 671
 672 struct ConfigInfo
 673 {
 674   char *token;
 675   char *value;
 676   int type;
 677 };
 678
 679 struct TokenIntPtrInfo
 680 {
 681   char *token;
 682   int *value;
 683 };
 684
 685 struct FileInfo
 686 {
 687   char *token;
 688
 689   char *default_filename;
 690   char *filename;
 691
 692   char **default_parameter;                     /* array of file parameters */
 693   char **parameter;                             /* array of file parameters */
 694
 695   boolean redefined;
 696 };
 697
 698 struct SetupFileList
 699 {
 700   char *token;
 701   char *value;
 702
 703   struct SetupFileList *next;
 704 };
 705
 706 struct ListNodeInfo
 707 {
 708   char *source_filename;                        /* primary key for node list */
 709   int num_references;
 710 };
 711
 712 struct PropertyMapping
 713 {
 714   int base_index;
 715   int ext1_index;
 716   int ext2_index;
 717   int ext3_index;
 718
 719   int artwork_index;
 720 };
 721
 722 struct ArtworkListInfo
 723 {
 724   int type;                                     /* type of artwork */
 725
 726   int num_file_list_entries;
 727   int num_dynamic_file_list_entries;
 728   struct FileInfo *file_list;                   /* static artwork file array */
 729   struct FileInfo *dynamic_file_list;           /* dynamic artwrk file array */
 730
 731   int num_suffix_list_entries;
 732   struct ConfigInfo *suffix_list;               /* parameter suffixes array */
 733
 734   int num_base_prefixes;
 735   int num_ext1_suffixes;
 736   int num_ext2_suffixes;
 737   int num_ext3_suffixes;
 738   char **base_prefixes;                         /* base token prefixes array */
 739   char **ext1_suffixes;                         /* property suffixes array 1 */
 740   char **ext2_suffixes;                         /* property suffixes array 2 */
 741   char **ext3_suffixes;                         /* property suffixes array 3 */
 742
 743   int num_ignore_tokens;
 744   char **ignore_tokens;                         /* file tokens to be ignored */
 745
 746   int num_property_mapping_entries;
 747   struct PropertyMapping *property_mapping;     /* mapping token -> artwork */
 748
 749   int sizeof_artwork_list_entry;
 750
 751   struct ListNodeInfo **artwork_list;           /* static artwork node array */
 752   struct ListNodeInfo **dynamic_artwork_list;   /* dynamic artwrk node array */
 753   struct ListNode *content_list;                /* dynamic artwork node list */
 754
 755   void *(*load_artwork)(char *);                /* constructor function */
 756   void (*free_artwork)(void *);                 /* destructor function */
 757 };
 758
 759
 760 /* ========================================================================= */
 761 /* exported variables                                                        */
 762 /* ========================================================================= */
 763
 764 extern struct ProgramInfo       program;
 765 extern struct OptionInfo        options;
 766 extern struct VideoSystemInfo   video;
 767 extern struct AudioSystemInfo   audio;
 768 extern struct GfxInfo           gfx;
 769 extern struct AnimInfo          anim;
 770 extern struct ArtworkInfo       artwork;
 771 extern struct JoystickInfo      joystick;
 772 extern struct SetupInfo         setup;
 773
 774 extern LevelDirTree            *leveldir_first;
 775 extern LevelDirTree            *leveldir_current;
 776 extern int                      level_nr;
 777
 778 extern Display                 *display;
 779 extern Visual                  *visual;
 780 extern int                      screen;
 781 extern Colormap                 cmap;
 782
 783 extern DrawWindow              *window;
 784 extern DrawBuffer              *backbuffer;
 785 extern DrawBuffer              *drawto;
 786
 787 extern int                      button_status;
 788 extern boolean                  motion_status;
 789
 790 extern int                      redraw_mask;
 791 extern int                      redraw_tiles;
 792
 793 extern int                      FrameCounter;
 794
 795
 796 /* function definitions */
 797
 798 void InitProgramInfo(char *, char *, char *, char *, char *, char *, char *,
 799                      char *, char *, char *, int);
 800
 801 void InitExitFunction(void (*exit_function)(int));
 802 void InitPlatformDependentStuff(void);
 803 void ClosePlatformDependentStuff(void);
 804
 805 void InitGfxFieldInfo(int, int, int, int, int, int, int, int, Bitmap *);
 806 void InitGfxDoor1Info(int, int, int, int);
 807 void InitGfxDoor2Info(int, int, int, int);
 808 void InitGfxScrollbufferInfo(int, int);
 809 void SetDrawDeactivationMask(int);
 810 void SetDrawBackgroundMask(int);
 811 void SetMainBackgroundBitmap(Bitmap *);
 812 void SetDoorBackgroundBitmap(Bitmap *);
 813
 814 inline void InitVideoDisplay(void);
 815 inline void CloseVideoDisplay(void);
 816 inline void InitVideoBuffer(DrawBuffer **,DrawWindow **, int,int,int, boolean);
 817 inline Bitmap *CreateBitmapStruct(void);
 818 inline Bitmap *CreateBitmap(int, int, int);
 819 inline void FreeBitmap(Bitmap *);
 820 inline void BlitBitmap(Bitmap *, Bitmap *, int, int, int, int, int, int);
 821 inline void FillRectangle(Bitmap *, int, int, int, int, Pixel);
 822 inline void ClearRectangle(Bitmap *, int, int, int, int);
 823 inline void ClearRectangleOnBackground(Bitmap *, int, int, int, int);
 824 inline void SetClipMask(Bitmap *, GC, Pixmap);
 825 inline void SetClipOrigin(Bitmap *, GC, int, int);
 826 inline void BlitBitmapMasked(Bitmap *, Bitmap *, int, int, int, int, int, int);
 827 inline boolean DrawingOnBackground(int, int);
 828 inline void BlitBitmapOnBackground(Bitmap *, Bitmap *, int, int, int, int, int,
 829                                    int);
 830 inline void DrawSimpleWhiteLine(Bitmap *, int, int, int, int);
 831 inline void DrawLines(Bitmap *, struct XY *, int, Pixel);
 832 inline Pixel GetPixel(Bitmap *, int, int);
 833 inline Pixel GetPixelFromRGB(Bitmap *, unsigned int,unsigned int,unsigned int);
 834 inline Pixel GetPixelFromRGBcompact(Bitmap *, unsigned int);
 835
 836 inline void FlushDisplay(void);
 837 inline void SyncDisplay(void);
 838 inline void KeyboardAutoRepeatOn(void);
 839 inline void KeyboardAutoRepeatOff(void);
 840 inline boolean PointerInWindow(DrawWindow *);
 841 inline boolean SetVideoMode(boolean);
 842 inline boolean ChangeVideoModeIfNeeded(boolean);
 843
 844 Bitmap *LoadImage(char *);
 845 Bitmap *LoadCustomImage(char *);
 846 void ReloadCustomImage(Bitmap *, char *);
 847
 848 Bitmap *ZoomBitmap(Bitmap *, int, int);
 849 void CreateBitmapWithSmallBitmaps(Bitmap *);
 850
 851 void SetMouseCursor(int);
 852
 853 inline void OpenAudio(void);
 854 inline void CloseAudio(void);
 855 inline void SetAudioMode(boolean);
 856
 857 inline void InitEventFilter(EventFilter);
 858 inline boolean PendingEvent(void);
 859 inline void NextEvent(Event *event);
 860 inline Key GetEventKey(KeyEvent *, boolean);
 861 inline KeyMod HandleKeyModState(Key, int);
 862 inline KeyMod GetKeyModState();
 863 inline boolean CheckCloseWindowEvent(ClientMessageEvent *);
 864
 865 inline void InitJoysticks();
 866 inline boolean ReadJoystick(int, int *, int *, boolean *, boolean *);
 867
 868 #endif /* SYSTEM_H */