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