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 LEVELINFO_FILENAME      "levelinfo.conf"
 231 #define GRAPHICSINFO_FILENAME   "graphicsinfo.conf"
 232 #define SOUNDSINFO_FILENAME     "soundsinfo.conf"
 233 #define MUSICINFO_FILENAME      "musicinfo.conf"
 234 #define LEVELFILE_EXTENSION     "level"
 235 #define TAPEFILE_EXTENSION      "tape"
 236 #define SCOREFILE_EXTENSION     "score"
 237 #else
 238 #define LEVELSETUP_DIRECTORY    "lvlsetup"
 239 #define SETUP_FILENAME          "setup.cnf"
 240 #define LEVELSETUP_FILENAME     "lvlsetup.cnf"
 241 #define LEVELINFO_FILENAME      "lvlinfo.cnf"
 242 #define GRAPHICSINFO_FILENAME   "gfxinfo.cnf"
 243 #define SOUNDSINFO_FILENAME     "sndinfo.cnf"
 244 #define MUSICINFO_FILENAME      "musinfo.cnf"
 245 #define LEVELFILE_EXTENSION     "lvl"
 246 #define TAPEFILE_EXTENSION      "tap"
 247 #define SCOREFILE_EXTENSION     "sco"
 248 #endif
 249
 250
 251 /* areas in bitmap PIX_DOOR */
 252 /* meaning in PIX_DB_DOOR: (3 PAGEs)
 253    PAGEX1: 1. buffer for DOOR_1
 254    PAGEX2: 2. buffer for DOOR_1
 255    PAGEX3: buffer for animations
 256 */
 257
 258 #define DOOR_GFX_PAGESIZE       (gfx.dxsize)
 259 #define DOOR_GFX_PAGEX1         (0 * DOOR_GFX_PAGESIZE)
 260 #define DOOR_GFX_PAGEX2         (1 * DOOR_GFX_PAGESIZE)
 261 #define DOOR_GFX_PAGEX3         (2 * DOOR_GFX_PAGESIZE)
 262 #define DOOR_GFX_PAGEX4         (3 * DOOR_GFX_PAGESIZE)
 263 #define DOOR_GFX_PAGEX5         (4 * DOOR_GFX_PAGESIZE)
 264 #define DOOR_GFX_PAGEX6         (5 * DOOR_GFX_PAGESIZE)
 265 #define DOOR_GFX_PAGEX7         (6 * DOOR_GFX_PAGESIZE)
 266 #define DOOR_GFX_PAGEX8         (7 * DOOR_GFX_PAGESIZE)
 267 #define DOOR_GFX_PAGEY1         (0)
 268 #define DOOR_GFX_PAGEY2         (gfx.dysize)
 269
 270
 271 /* macros for version handling */
 272 #define VERSION_IDENT(x,y,z)    ((x) * 1000000 + (y) * 10000 + (z) * 100)
 273 #define RELEASE_IDENT(x,y,z,r)  (VERSION_IDENT(x,y,z) + (r))
 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_RELEASE(x)      ((x) % 100)
 278
 279
 280 /* macros for parent/child process identification */
 281 #if defined(PLATFORM_UNIX)
 282 #define IS_PARENT_PROCESS()     (audio.mixer_pid != getpid())
 283 #define IS_CHILD_PROCESS()      (audio.mixer_pid == getpid())
 284 #define HAS_CHILD_PROCESS()     (audio.mixer_pid > 0)
 285 #else
 286 #define IS_PARENT_PROCESS()     TRUE
 287 #define IS_CHILD_PROCESS()      FALSE
 288 #define HAS_CHILD_PROCESS()     FALSE
 289 #endif
 290
 291
 292 /* values for artwork type */
 293 #define ARTWORK_TYPE_GRAPHICS   0
 294 #define ARTWORK_TYPE_SOUNDS     1
 295 #define ARTWORK_TYPE_MUSIC      2
 296
 297 #define NUM_ARTWORK_TYPES       3
 298
 299
 300 /* values for tree type (chosen to match artwork type) */
 301 #define TREE_TYPE_UNDEFINED     -1
 302 #define TREE_TYPE_GRAPHICS_DIR  ARTWORK_TYPE_GRAPHICS
 303 #define TREE_TYPE_SOUNDS_DIR    ARTWORK_TYPE_SOUNDS
 304 #define TREE_TYPE_MUSIC_DIR     ARTWORK_TYPE_MUSIC
 305 #define TREE_TYPE_LEVEL_DIR     3
 306
 307 #define NUM_TREE_TYPES          4
 308
 309
 310 /* values for artwork handling */
 311 #define LEVELDIR_ARTWORK_SET(leveldir, type)                            \
 312                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
 313                                  (leveldir)->graphics_set :             \
 314                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
 315                                  (leveldir)->sounds_set :               \
 316                                  (leveldir)->music_set)
 317
 318 #define LEVELDIR_ARTWORK_PATH(leveldir, type)                           \
 319                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
 320                                  (leveldir)->graphics_path :            \
 321                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
 322                                  (leveldir)->sounds_path :              \
 323                                  (leveldir)->music_path)
 324
 325 #define SETUP_ARTWORK_SET(setup, type)                                  \
 326                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
 327                                  (setup).graphics_set :                 \
 328                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
 329                                  (setup).sounds_set :                   \
 330                                  (setup).music_set)
 331
 332 #define SETUP_OVERRIDE_ARTWORK(setup, type)                             \
 333                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
 334                                  (setup).override_level_graphics :      \
 335                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
 336                                  (setup).override_level_sounds :        \
 337                                  (setup).override_level_music)
 338
 339 #define ARTWORK_FIRST_NODE(artwork, type)                               \
 340                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
 341                                  (artwork).gfx_first :  \
 342                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
 343                                  (artwork).snd_first :  \
 344                                  (artwork).mus_first)
 345
 346 #define ARTWORK_CURRENT_IDENTIFIER(artwork, type)                       \
 347                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
 348                                  (artwork).gfx_current_identifier :     \
 349                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
 350                                  (artwork).snd_current_identifier :     \
 351                                  (artwork).mus_current_identifier)
 352
 353 #define ARTWORKINFO_FILENAME(type)                                      \
 354                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
 355                                  GRAPHICSINFO_FILENAME :                \
 356                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
 357                                  SOUNDSINFO_FILENAME :                  \
 358                                  (type) == ARTWORK_TYPE_MUSIC ?         \
 359                                  MUSICINFO_FILENAME : "")
 360
 361 #define ARTWORK_DIRECTORY(type)                                         \
 362                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
 363                                  GRAPHICS_DIRECTORY :                   \
 364                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
 365                                  SOUNDS_DIRECTORY :                     \
 366                                  (type) == ARTWORK_TYPE_MUSIC ?         \
 367                                  MUSIC_DIRECTORY : "")
 368
 369 #define OPTIONS_ARTWORK_DIRECTORY(type)                                 \
 370                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
 371                                  options.graphics_directory :           \
 372                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
 373                                  options.sounds_directory :             \
 374                                  (type) == ARTWORK_TYPE_MUSIC ?         \
 375                                  options.music_directory : "")
 376
 377
 378 /* type definitions */
 379 typedef int (*EventFilter)(const Event *);
 380
 381
 382 /* structure definitions */
 383
 384 struct ProgramInfo
 385 {
 386   char *command_basename;
 387   char *userdata_directory;
 388
 389   char *program_title;
 390   char *window_title;
 391   char *icon_title;
 392
 393   char *x11_icon_filename;
 394   char *x11_iconmask_filename;
 395   char *msdos_cursor_filename;
 396
 397   char *cookie_prefix;
 398   char *filename_prefix;        /* prefix to cut off from DOS filenames */
 399
 400   int version_major;
 401   int version_minor;
 402   int version_patch;
 403
 404   void (*exit_function)(int);
 405 };
 406
 407 struct OptionInfo
 408 {
 409   char *display_name;
 410   char *server_host;
 411   int server_port;
 412
 413   char *ro_base_directory;
 414   char *rw_base_directory;
 415   char *level_directory;
 416   char *graphics_directory;
 417   char *sounds_directory;
 418   char *music_directory;
 419   char *docs_directory;
 420   char *execute_command;
 421
 422   boolean serveronly;
 423   boolean network;
 424   boolean verbose;
 425   boolean debug;
 426 };
 427
 428 struct VideoSystemInfo
 429 {
 430   int default_depth;
 431   int width, height, depth;
 432   boolean fullscreen_available;
 433   boolean fullscreen_enabled;
 434 };
 435
 436 struct AudioSystemInfo
 437 {
 438   boolean sound_available;
 439   boolean loops_available;
 440   boolean music_available;
 441
 442   boolean sound_enabled;
 443   boolean sound_deactivated;    /* for temporarily disabling sound */
 444
 445   int mixer_pipe[2];
 446   int mixer_pid;
 447   char *device_name;
 448   int device_fd;
 449
 450   int num_channels;
 451   int music_channel;
 452   int first_sound_channel;
 453 };
 454
 455 struct FontBitmapInfo
 456 {
 457   Bitmap *bitmap;
 458   int src_x, src_y;             /* start position of animation frames */
 459   int width, height;            /* width/height of each animation frame */
 460   int draw_x, draw_y;           /* offset for drawing font characters */
 461   int num_chars;
 462   int num_chars_per_line;
 463
 464 #if defined(TARGET_X11_NATIVE_PERFORMANCE_WORKAROUND)
 465   Pixmap *clip_mask;            /* single-char-only clip mask array for X11 */
 466 #endif
 467 };
 468
 469 struct GfxInfo
 470 {
 471   int sx, sy;
 472   int sxsize, sysize;
 473   int real_sx, real_sy;
 474   int full_sxsize, full_sysize;
 475   int scrollbuffer_width, scrollbuffer_height;
 476
 477   int dx, dy;
 478   int dxsize, dysize;
 479
 480   int vx, vy;
 481   int vxsize, vysize;
 482
 483   int draw_deactivation_mask;
 484   int draw_background_mask;
 485
 486   Bitmap *field_save_buffer;
 487
 488   Bitmap *background_bitmap;
 489   int background_bitmap_mask;
 490
 491   int num_fonts;
 492   struct FontBitmapInfo *font_bitmap_info;
 493   int (*select_font_function)(int);
 494
 495   int anim_random_frame;
 496 };
 497
 498 struct JoystickInfo
 499 {
 500   int status;
 501   int fd[MAX_PLAYERS];          /* file descriptor of player's joystick */
 502 };
 503
 504 struct SetupJoystickInfo
 505 {
 506   char *device_name;            /* device name of player's joystick */
 507
 508   int xleft, xmiddle, xright;
 509   int yupper, ymiddle, ylower;
 510   int snap;
 511   int bomb;
 512 };
 513
 514 struct SetupKeyboardInfo
 515 {
 516   Key left;
 517   Key right;
 518   Key up;
 519   Key down;
 520   Key snap;
 521   Key bomb;
 522 };
 523
 524 struct SetupInputInfo
 525 {
 526   boolean use_joystick;
 527   struct SetupJoystickInfo joy;
 528   struct SetupKeyboardInfo key;
 529 };
 530
 531 struct SetupEditorInfo
 532 {
 533   boolean el_boulderdash;
 534   boolean el_emerald_mine;
 535   boolean el_more;
 536   boolean el_sokoban;
 537   boolean el_supaplex;
 538   boolean el_diamond_caves;
 539   boolean el_dx_boulderdash;
 540   boolean el_chars;
 541   boolean el_custom;
 542   boolean el_custom_more;
 543
 544   boolean el_headlines;
 545 };
 546
 547 struct SetupShortcutInfo
 548 {
 549   Key save_game;
 550   Key load_game;
 551   Key toggle_pause;
 552 };
 553
 554 struct SetupSystemInfo
 555 {
 556   char *sdl_audiodriver;
 557   int audio_fragment_size;
 558 };
 559
 560 struct SetupInfo
 561 {
 562   char *player_name;
 563
 564   boolean sound;
 565   boolean sound_loops;
 566   boolean sound_music;
 567   boolean sound_simple;
 568   boolean toons;
 569   boolean double_buffering;
 570   boolean direct_draw;          /* !double_buffering (redundant!) */
 571   boolean scroll_delay;
 572   boolean soft_scrolling;
 573   boolean fading;
 574   boolean autorecord;
 575   boolean quick_doors;
 576   boolean team_mode;
 577   boolean handicap;
 578   boolean time_limit;
 579   boolean fullscreen;
 580   boolean ask_on_escape;
 581
 582   char *graphics_set;
 583   char *sounds_set;
 584   char *music_set;
 585   boolean override_level_graphics;
 586   boolean override_level_sounds;
 587   boolean override_level_music;
 588
 589   struct SetupEditorInfo editor;
 590   struct SetupShortcutInfo shortcut;
 591   struct SetupInputInfo input[MAX_PLAYERS];
 592   struct SetupSystemInfo system;
 593   struct OptionInfo options;
 594 };
 595
 596 struct TreeInfo
 597 {
 598   struct TreeInfo **node_top;           /* topmost node in tree */
 599   struct TreeInfo *node_parent;         /* parent level directory info */
 600   struct TreeInfo *node_group;          /* level group sub-directory info */
 601   struct TreeInfo *next;                /* next level series structure node */
 602
 603   int cl_first;         /* internal control field for setup screen */
 604   int cl_cursor;        /* internal control field for setup screen */
 605
 606   int type;             /* type of tree content */
 607
 608   /* fields for "type == TREE_TYPE_LEVEL_DIR" */
 609
 610   char *filename;       /* tree info sub-directory basename (may be ".") */
 611   char *fullpath;       /* complete path relative to tree base directory */
 612   char *basepath;       /* absolute base path of tree base directory */
 613   char *identifier;     /* identifier string for configuration files */
 614   char *name;           /* tree info name, as displayed in selection menues */
 615   char *name_sorting;   /* optional sorting name for correct name sorting */
 616   char *author;         /* level or artwork author name */
 617   char *imported_from;  /* optional comment for imported levels or artwork */
 618
 619   char *graphics_set;   /* optional custom graphics set (level tree only) */
 620   char *sounds_set;     /* optional custom sounds set (level tree only) */
 621   char *music_set;      /* optional custom music set (level tree only) */
 622   char *graphics_path;  /* path to optional custom graphics set (level only) */
 623   char *sounds_path;    /* path to optional custom sounds set (level only) */
 624   char *music_path;     /* path to optional custom music set (level only) */
 625
 626   int levels;           /* number of levels in level series */
 627   int first_level;      /* first level number (to allow start with 0 or 1) */
 628   int last_level;       /* last level number (automatically calculated) */
 629   int sort_priority;    /* sort levels by 'sort_priority' and then by name */
 630
 631   boolean latest_engine;/* force level set to use the latest game engine */
 632
 633   boolean level_group;  /* directory contains more level series directories */
 634   boolean parent_link;  /* entry links back to parent directory */
 635   boolean user_defined; /* user defined levels are stored in home directory */
 636   boolean readonly;     /* readonly levels can not be changed with editor */
 637
 638   int color;            /* color to use on selection screen for this level */
 639   char *class_desc;     /* description of level series class */
 640   int handicap_level;   /* number of the lowest unsolved level */
 641 };
 642
 643 typedef struct TreeInfo TreeInfo;
 644 typedef struct TreeInfo LevelDirTree;
 645 typedef struct TreeInfo ArtworkDirTree;
 646 typedef struct TreeInfo GraphicsDirTree;
 647 typedef struct TreeInfo SoundsDirTree;
 648 typedef struct TreeInfo MusicDirTree;
 649
 650 struct ArtworkInfo
 651 {
 652   GraphicsDirTree *gfx_first;
 653   GraphicsDirTree *gfx_current;
 654   SoundsDirTree *snd_first;
 655   SoundsDirTree *snd_current;
 656   MusicDirTree *mus_first;
 657   MusicDirTree *mus_current;
 658
 659   char *gfx_current_identifier;
 660   char *snd_current_identifier;
 661   char *mus_current_identifier;
 662 };
 663
 664 struct ValueTextInfo
 665 {
 666   int value;
 667   char *text;
 668 };
 669
 670 struct ConfigInfo
 671 {
 672   char *token;
 673   char *value;
 674   int type;
 675 };
 676
 677 struct TokenIntPtrInfo
 678 {
 679   char *token;
 680   int *value;
 681 };
 682
 683 struct FileInfo
 684 {
 685   char *token;
 686
 687   char *default_filename;
 688   char *filename;
 689
 690   char **default_parameter;                     /* array of file parameters */
 691   char **parameter;                             /* array of file parameters */
 692
 693   boolean redefined;
 694 };
 695
 696 struct SetupFileList
 697 {
 698   char *token;
 699   char *value;
 700
 701   struct SetupFileList *next;
 702 };
 703
 704 struct ListNodeInfo
 705 {
 706   char *source_filename;                        /* primary key for node list */
 707   int num_references;
 708 };
 709
 710 struct PropertyMapping
 711 {
 712   int base_index;
 713   int ext1_index;
 714   int ext2_index;
 715   int ext3_index;
 716
 717   int artwork_index;
 718 };
 719
 720 struct ArtworkListInfo
 721 {
 722   int type;                                     /* type of artwork */
 723
 724   int num_file_list_entries;
 725   int num_dynamic_file_list_entries;
 726   struct FileInfo *file_list;                   /* static artwork file array */
 727   struct FileInfo *dynamic_file_list;           /* dynamic artwrk file array */
 728
 729   int num_suffix_list_entries;
 730   struct ConfigInfo *suffix_list;               /* parameter suffixes array */
 731
 732   int num_base_prefixes;
 733   int num_ext1_suffixes;
 734   int num_ext2_suffixes;
 735   int num_ext3_suffixes;
 736   char **base_prefixes;                         /* base token prefixes array */
 737   char **ext1_suffixes;                         /* property suffixes array 1 */
 738   char **ext2_suffixes;                         /* property suffixes array 2 */
 739   char **ext3_suffixes;                         /* property suffixes array 3 */
 740
 741   int num_ignore_tokens;
 742   char **ignore_tokens;                         /* file tokens to be ignored */
 743
 744   int num_property_mapping_entries;
 745   struct PropertyMapping *property_mapping;     /* mapping token -> artwork */
 746
 747   int sizeof_artwork_list_entry;
 748
 749   struct ListNodeInfo **artwork_list;           /* static artwork node array */
 750   struct ListNodeInfo **dynamic_artwork_list;   /* dynamic artwrk node array */
 751   struct ListNode *content_list;                /* dynamic artwork node list */
 752
 753   void *(*load_artwork)(char *);                /* constructor function */
 754   void (*free_artwork)(void *);                 /* destructor function */
 755 };
 756
 757
 758 /* ========================================================================= */
 759 /* exported variables                                                        */
 760 /* ========================================================================= */
 761
 762 extern struct ProgramInfo       program;
 763 extern struct OptionInfo        options;
 764 extern struct VideoSystemInfo   video;
 765 extern struct AudioSystemInfo   audio;
 766 extern struct GfxInfo           gfx;
 767 extern struct AnimInfo          anim;
 768 extern struct ArtworkInfo       artwork;
 769 extern struct JoystickInfo      joystick;
 770 extern struct SetupInfo         setup;
 771
 772 extern LevelDirTree            *leveldir_first;
 773 extern LevelDirTree            *leveldir_current;
 774 extern int                      level_nr;
 775
 776 extern Display                 *display;
 777 extern Visual                  *visual;
 778 extern int                      screen;
 779 extern Colormap                 cmap;
 780
 781 extern DrawWindow              *window;
 782 extern DrawBuffer              *backbuffer;
 783 extern DrawBuffer              *drawto;
 784
 785 extern int                      button_status;
 786 extern boolean                  motion_status;
 787
 788 extern int                      redraw_mask;
 789 extern int                      redraw_tiles;
 790
 791 extern int                      FrameCounter;
 792
 793
 794 /* function definitions */
 795
 796 void InitProgramInfo(char *, char *, char *, char *, char *, char *, char *,
 797                      char *, char *, char *, int);
 798
 799 void InitExitFunction(void (*exit_function)(int));
 800 void InitPlatformDependentStuff(void);
 801 void ClosePlatformDependentStuff(void);
 802
 803 void InitGfxFieldInfo(int, int, int, int, int, int, int, int, Bitmap *);
 804 void InitGfxDoor1Info(int, int, int, int);
 805 void InitGfxDoor2Info(int, int, int, int);
 806 void InitGfxScrollbufferInfo(int, int);
 807 void SetDrawDeactivationMask(int);
 808 void SetDrawBackgroundMask(int);
 809 void SetMainBackgroundBitmap(Bitmap *);
 810 void SetDoorBackgroundBitmap(Bitmap *);
 811
 812 inline void InitVideoDisplay(void);
 813 inline void CloseVideoDisplay(void);
 814 inline void InitVideoBuffer(DrawBuffer **,DrawWindow **, int,int,int, boolean);
 815 inline Bitmap *CreateBitmapStruct(void);
 816 inline Bitmap *CreateBitmap(int, int, int);
 817 inline void FreeBitmap(Bitmap *);
 818 inline void BlitBitmap(Bitmap *, Bitmap *, int, int, int, int, int, int);
 819 inline void FillRectangle(Bitmap *, int, int, int, int, Pixel);
 820 inline void ClearRectangle(Bitmap *, int, int, int, int);
 821 inline void ClearRectangleOnBackground(Bitmap *, int, int, int, int);
 822 inline void SetClipMask(Bitmap *, GC, Pixmap);
 823 inline void SetClipOrigin(Bitmap *, GC, int, int);
 824 inline void BlitBitmapMasked(Bitmap *, Bitmap *, int, int, int, int, int, int);
 825 inline boolean DrawingOnBackground(int, int);
 826 inline void BlitBitmapOnBackground(Bitmap *, Bitmap *, int, int, int, int, int,
 827                                    int);
 828 inline void DrawSimpleWhiteLine(Bitmap *, int, int, int, int);
 829 inline void DrawLines(Bitmap *, struct XY *, int, Pixel);
 830 inline Pixel GetPixel(Bitmap *, int, int);
 831 inline Pixel GetPixelFromRGB(Bitmap *, unsigned int,unsigned int,unsigned int);
 832 inline Pixel GetPixelFromRGBcompact(Bitmap *, unsigned int);
 833
 834 inline void FlushDisplay(void);
 835 inline void SyncDisplay(void);
 836 inline void KeyboardAutoRepeatOn(void);
 837 inline void KeyboardAutoRepeatOff(void);
 838 inline boolean PointerInWindow(DrawWindow *);
 839 inline boolean SetVideoMode(boolean);
 840 inline boolean ChangeVideoModeIfNeeded(boolean);
 841
 842 Bitmap *LoadImage(char *);
 843 Bitmap *LoadCustomImage(char *);
 844 void ReloadCustomImage(Bitmap *, char *);
 845
 846 Bitmap *ZoomBitmap(Bitmap *, int, int);
 847 void CreateBitmapWithSmallBitmaps(Bitmap *);
 848
 849 void SetMouseCursor(int);
 850
 851 inline void OpenAudio(void);
 852 inline void CloseAudio(void);
 853 inline void SetAudioMode(boolean);
 854
 855 inline void InitEventFilter(EventFilter);
 856 inline boolean PendingEvent(void);
 857 inline void NextEvent(Event *event);
 858 inline Key GetEventKey(KeyEvent *, boolean);
 859 inline KeyMod HandleKeyModState(Key, int);
 860 inline KeyMod GetKeyModState();
 861 inline boolean CheckCloseWindowEvent(ClientMessageEvent *);
 862
 863 inline void InitJoysticks();
 864 inline boolean ReadJoystick(int, int *, int *, boolean *, boolean *);
 865
 866 #endif /* SYSTEM_H */