src/libgame/system.h

   1 // ============================================================================
   2 // Artsoft Retro-Game Library
   3 // ----------------------------------------------------------------------------
   4 // (c) 1995-2014 by Artsoft Entertainment
   5 //                  Holger Schemel
   6 //                  info@artsoft.org
   7 //                  http://www.artsoft.org/
   8 // ----------------------------------------------------------------------------
   9 // system.h
  10 // ============================================================================
  11
  12 #ifndef SYSTEM_H
  13 #define SYSTEM_H
  14
  15 #include "platform.h"
  16 #include "types.h"
  17
  18
  19 #if defined(PLATFORM_MACOSX)
  20 #include "macosx.h"
  21 #elif defined(PLATFORM_WIN32)
  22 #include "windows.h"
  23 #elif defined(PLATFORM_ANDROID)
  24 #include "android.h"
  25 #endif
  26
  27 #include "sdl.h"
  28
  29
  30 /* the additional 'b' is needed for Win32 to open files in binary mode */
  31 #define MODE_READ                       "rb"
  32 #define MODE_WRITE                      "wb"
  33 #define MODE_APPEND                     "ab"
  34
  35 #define DEFAULT_DEPTH                   0
  36
  37 #define BLIT_OPAQUE                     0
  38 #define BLIT_MASKED                     1
  39 #define BLIT_INVERSE                    2
  40 #define BLIT_ON_BACKGROUND              3
  41
  42 /* values for fullscreen status */
  43 #define FULLSCREEN_NOT_AVAILABLE        FALSE
  44 #define FULLSCREEN_AVAILABLE            TRUE
  45
  46 /* values for window scaling */
  47 #define WINDOW_SCALING_NOT_AVAILABLE    FALSE
  48 #define WINDOW_SCALING_AVAILABLE        TRUE
  49
  50 #define MIN_WINDOW_SCALING_PERCENT      30
  51 #define STD_WINDOW_SCALING_PERCENT      100
  52 #define MAX_WINDOW_SCALING_PERCENT      400
  53 #define STEP_WINDOW_SCALING_PERCENT     10
  54
  55 /* values for window scaling quality */
  56 #define SCALING_QUALITY_NEAREST         "nearest"
  57 #define SCALING_QUALITY_LINEAR          "linear"
  58 #define SCALING_QUALITY_BEST            "best"
  59
  60 #define SCALING_QUALITY_DEFAULT         SCALING_QUALITY_LINEAR
  61
  62 /* values for screen rendering mode */
  63 #define STR_SPECIAL_RENDERING_OFF       "stream_texture_only"
  64 #define STR_SPECIAL_RENDERING_BITMAP    "bitmap_and_stream_texture"
  65 #define STR_SPECIAL_RENDERING_TARGET    "target_texture_only"
  66 #define STR_SPECIAL_RENDERING_DOUBLE    "stream_and_target_texture"
  67
  68 #if defined(TARGET_SDL2)
  69 #define STR_SPECIAL_RENDERING_DEFAULT   STR_SPECIAL_RENDERING_DOUBLE
  70 #else
  71 #define STR_SPECIAL_RENDERING_DEFAULT   STR_SPECIAL_RENDERING_BITMAP
  72 #endif
  73
  74 #define SPECIAL_RENDERING_OFF           0
  75 #define SPECIAL_RENDERING_BITMAP        1
  76 #define SPECIAL_RENDERING_TARGET        2
  77 #define SPECIAL_RENDERING_DOUBLE        3
  78
  79 #if defined(TARGET_SDL2)
  80 #define SPECIAL_RENDERING_DEFAULT       SPECIAL_RENDERING_DOUBLE
  81 #else
  82 #define SPECIAL_RENDERING_DEFAULT       SPECIAL_RENDERING_BITMAP
  83 #endif
  84
  85 /* values for vertical screen retrace synchronization (vsync) */
  86 #define STR_VSYNC_MODE_OFF              "off"
  87 #define STR_VSYNC_MODE_NORMAL           "normal"
  88 #define STR_VSYNC_MODE_ADAPTIVE         "adaptive"
  89
  90 #define STR_VSYNC_MODE_DEFAULT          STR_VSYNC_MODE_OFF
  91
  92 #define VSYNC_MODE_OFF                  0
  93 #define VSYNC_MODE_NORMAL               1
  94 #define VSYNC_MODE_ADAPTIVE             -1
  95
  96 #define VSYNC_MODE_DEFAULT              VSYNC_MODE_OFF
  97
  98 /* values for network server settings */
  99 #define STR_NETWORK_AUTO_DETECT         "auto_detect_network_server"
 100 #define STR_NETWORK_AUTO_DETECT_SETUP   "(auto detect network server)"
 101
 102 /* values for touch control */
 103 #define TOUCH_CONTROL_OFF               "off"
 104 #define TOUCH_CONTROL_VIRTUAL_BUTTONS   "virtual_buttons"
 105 #define TOUCH_CONTROL_WIPE_GESTURES     "wipe_gestures"
 106 #define TOUCH_CONTROL_FOLLOW_FINGER     "follow_finger"
 107
 108 #if defined(PLATFORM_ANDROID)
 109 #define TOUCH_CONTROL_DEFAULT           TOUCH_CONTROL_VIRTUAL_BUTTONS
 110 #else
 111 #define TOUCH_CONTROL_DEFAULT           TOUCH_CONTROL_OFF
 112 #endif
 113
 114 #define TOUCH_MOVE_DISTANCE_DEFAULT     2
 115 #define TOUCH_DROP_DISTANCE_DEFAULT     5
 116 #define TOUCH_TRANSPARENCY_DEFAULT      50
 117
 118 #define ALPHA_FROM_TRANSPARENCY(x)      ((100 - x) * SDL_ALPHA_OPAQUE / 100)
 119 #define ALPHA_FADING_STEPSIZE(x)        ((x) / 25)
 120
 121 /* values for special settings for mobile devices */
 122 #if defined(PLATFORM_ANDROID)
 123 #define USE_TOUCH_INPUT_OVERLAY
 124 #define USE_COMPLETE_DISPLAY
 125 #define HAS_SCREEN_KEYBOARD
 126 #define SCREEN_KEYBOARD_POS(h)          ((h) / 2)
 127 #endif
 128
 129 /* default input keys */
 130 #define DEFAULT_KEY_LEFT                KSYM_Left
 131 #define DEFAULT_KEY_RIGHT               KSYM_Right
 132 #define DEFAULT_KEY_UP                  KSYM_Up
 133 #define DEFAULT_KEY_DOWN                KSYM_Down
 134 #if defined(PLATFORM_MACOSX)
 135 #define DEFAULT_KEY_SNAP                KSYM_Control_L
 136 #define DEFAULT_KEY_DROP                KSYM_KP_Enter
 137 #else
 138 #define DEFAULT_KEY_SNAP                KSYM_Control_L
 139 #define DEFAULT_KEY_DROP                KSYM_Control_R
 140 #endif
 141 #define DEFAULT_KEY_OKAY                KSYM_Return
 142 #define DEFAULT_KEY_CANCEL              KSYM_Escape
 143
 144 /* default shortcut keys */
 145 #define DEFAULT_KEY_SAVE_GAME           KSYM_F1
 146 #define DEFAULT_KEY_LOAD_GAME           KSYM_F2
 147 #define DEFAULT_KEY_TOGGLE_PAUSE        KSYM_space
 148 #define DEFAULT_KEY_FOCUS_PLAYER_1      KSYM_F5
 149 #define DEFAULT_KEY_FOCUS_PLAYER_2      KSYM_F6
 150 #define DEFAULT_KEY_FOCUS_PLAYER_3      KSYM_F7
 151 #define DEFAULT_KEY_FOCUS_PLAYER_4      KSYM_F8
 152 #define DEFAULT_KEY_FOCUS_PLAYER_ALL    KSYM_F9
 153 #define DEFAULT_KEY_TAPE_EJECT          KSYM_UNDEFINED
 154 #define DEFAULT_KEY_TAPE_EXTRA          KSYM_UNDEFINED
 155 #define DEFAULT_KEY_TAPE_STOP           KSYM_UNDEFINED
 156 #define DEFAULT_KEY_TAPE_PAUSE          KSYM_UNDEFINED
 157 #define DEFAULT_KEY_TAPE_RECORD         KSYM_UNDEFINED
 158 #define DEFAULT_KEY_TAPE_PLAY           KSYM_UNDEFINED
 159 #define DEFAULT_KEY_SOUND_SIMPLE        KSYM_UNDEFINED
 160 #define DEFAULT_KEY_SOUND_LOOPS         KSYM_UNDEFINED
 161 #define DEFAULT_KEY_SOUND_MUSIC         KSYM_UNDEFINED
 162 #define DEFAULT_KEY_SNAP_LEFT           KSYM_UNDEFINED
 163 #define DEFAULT_KEY_SNAP_RIGHT          KSYM_UNDEFINED
 164 #define DEFAULT_KEY_SNAP_UP             KSYM_UNDEFINED
 165 #define DEFAULT_KEY_SNAP_DOWN           KSYM_UNDEFINED
 166
 167 /* default debug setup keys and values */
 168 #define DEFAULT_FRAME_DELAY_0           20              // 100 % speed
 169 #define DEFAULT_FRAME_DELAY_1           500             // 4 % speed
 170 #define DEFAULT_FRAME_DELAY_2           250             // 8 % speed
 171 #define DEFAULT_FRAME_DELAY_3           125             // 16 % speed
 172 #define DEFAULT_FRAME_DELAY_4           60              // 33 % speed
 173 #define DEFAULT_FRAME_DELAY_5           40              // 50 % speed
 174 #define DEFAULT_FRAME_DELAY_6           30              // 66 % speed
 175 #define DEFAULT_FRAME_DELAY_7           10              // 200 % speed
 176 #define DEFAULT_FRAME_DELAY_8           5               // 400 % speed
 177 #define DEFAULT_FRAME_DELAY_9           0               // maximum speed
 178
 179 #define DEFAULT_KEY_FRAME_DELAY_0       KSYM_0
 180 #define DEFAULT_KEY_FRAME_DELAY_1       KSYM_1
 181 #define DEFAULT_KEY_FRAME_DELAY_2       KSYM_2
 182 #define DEFAULT_KEY_FRAME_DELAY_3       KSYM_3
 183 #define DEFAULT_KEY_FRAME_DELAY_4       KSYM_4
 184 #define DEFAULT_KEY_FRAME_DELAY_5       KSYM_5
 185 #define DEFAULT_KEY_FRAME_DELAY_6       KSYM_6
 186 #define DEFAULT_KEY_FRAME_DELAY_7       KSYM_7
 187 #define DEFAULT_KEY_FRAME_DELAY_8       KSYM_8
 188 #define DEFAULT_KEY_FRAME_DELAY_9       KSYM_9
 189
 190 #define NUM_DEBUG_FRAME_DELAY_KEYS      10
 191
 192 #define DEFAULT_FRAME_DELAY_USE_MOD_KEY FALSE
 193 #define DEFAULT_FRAME_DELAY_GAME_ONLY   TRUE
 194
 195 /* values for key_status */
 196 #define KEY_NOT_PRESSED                 FALSE
 197 #define KEY_RELEASED                    FALSE
 198 #define KEY_PRESSED                     TRUE
 199
 200 /* values for button status */
 201 #define MB_NOT_PRESSED                  FALSE
 202 #define MB_NOT_RELEASED                 TRUE
 203 #define MB_RELEASED                     FALSE
 204 #define MB_PRESSED                      TRUE
 205 #define MB_MENU_CHOICE                  FALSE
 206 #define MB_MENU_MARK                    TRUE
 207 #define MB_MENU_INITIALIZE              (-1)
 208 #define MB_MENU_LEAVE                   (-2)
 209 #define MB_LEFTBUTTON                   1
 210 #define MB_MIDDLEBUTTON                 2
 211 #define MB_RIGHTBUTTON                  3
 212 #define MB_WHEEL_UP                     4
 213 #define MB_WHEEL_DOWN                   5
 214 #define MB_WHEEL_LEFT                   6
 215 #define MB_WHEEL_RIGHT                  7
 216 #define IS_WHEEL_BUTTON_VERTICAL(b)     ((b) == MB_WHEEL_UP ||          \
 217                                          (b) == MB_WHEEL_DOWN)
 218 #define IS_WHEEL_BUTTON_HORIZONTAL(b)   ((b) == MB_WHEEL_LEFT ||        \
 219                                          (b) == MB_WHEEL_RIGHT)
 220 #define IS_WHEEL_BUTTON(b)              (IS_WHEEL_BUTTON_VERTICAL(b) || \
 221                                          IS_WHEEL_BUTTON_HORIZONTAL(b))
 222 #define DEFAULT_WHEEL_STEPS             3
 223
 224 #define BUTTON_STEPSIZE(b)              ((b) == MB_LEFTBUTTON   ?  1 :  \
 225                                          (b) == MB_MIDDLEBUTTON ?  5 :  \
 226                                          (b) == MB_RIGHTBUTTON  ? 10 : 1)
 227
 228 /* values for move directions */
 229 #define MV_BIT_LEFT                     0
 230 #define MV_BIT_RIGHT                    1
 231 #define MV_BIT_UP                       2
 232 #define MV_BIT_DOWN                     3
 233
 234 #define NUM_DIRECTIONS                  4
 235
 236 /* diagonal movement directions are used in a different contect than buttons */
 237 #define MV_BIT_UPLEFT                   4
 238 #define MV_BIT_UPRIGHT                  5
 239 #define MV_BIT_DOWNLEFT                 6
 240 #define MV_BIT_DOWNRIGHT                7
 241
 242 #define NUM_DIRECTIONS_FULL             8
 243
 244 /* values for special "button" bitmasks */
 245 #define BUTTON_1                        4
 246 #define BUTTON_2                        5
 247
 248 #define NUM_PLAYER_ACTIONS              6
 249
 250 /* values for special "focus player" bitmasks */
 251 #define BIT_SET_FOCUS                   6
 252
 253 /* values for drawing stages for global animations */
 254 #define DRAW_GLOBAL_ANIM_STAGE_1        1
 255 #define DRAW_GLOBAL_ANIM_STAGE_2        2
 256
 257 /* values for drawing target (various functions) */
 258 #define DRAW_TO_BACKBUFFER              0
 259 #define DRAW_TO_FIELDBUFFER             1
 260 #define DRAW_TO_SCREEN                  2
 261 #define DRAW_TO_FADE_SOURCE             3
 262 #define DRAW_TO_FADE_TARGET             4
 263
 264 /* values for move directions and special "button" key bitmasks */
 265 #define MV_NONE                 0
 266 #define MV_LEFT                 (1 << MV_BIT_LEFT)
 267 #define MV_RIGHT                (1 << MV_BIT_RIGHT)
 268 #define MV_UP                   (1 << MV_BIT_UP)
 269 #define MV_DOWN                 (1 << MV_BIT_DOWN)
 270
 271 #define MV_UPLEFT               (MV_UP   | MV_LEFT)
 272 #define MV_UPRIGHT              (MV_UP   | MV_RIGHT)
 273 #define MV_DOWNLEFT             (MV_DOWN | MV_LEFT)
 274 #define MV_DOWNRIGHT            (MV_DOWN | MV_RIGHT)
 275
 276 #define MV_HORIZONTAL           (MV_LEFT | MV_RIGHT)
 277 #define MV_VERTICAL             (MV_UP   | MV_DOWN)
 278 #define MV_ALL_DIRECTIONS       (MV_LEFT | MV_RIGHT | MV_UP | MV_DOWN)
 279 #define MV_ANY_DIRECTION        (MV_ALL_DIRECTIONS)
 280 #define MV_NO_DIRECTION         (MV_NONE)
 281
 282 #define KEY_BUTTON_1            (1 << BUTTON_1)
 283 #define KEY_BUTTON_2            (1 << BUTTON_2)
 284 #define KEY_BUTTON_SNAP         KEY_BUTTON_1
 285 #define KEY_BUTTON_DROP         KEY_BUTTON_2
 286 #define KEY_MOTION              (MV_LEFT | MV_RIGHT | MV_UP | MV_DOWN)
 287 #define KEY_BUTTON              (KEY_BUTTON_1 | KEY_BUTTON_2)
 288 #define KEY_ACTION              (KEY_MOTION | KEY_BUTTON)
 289
 290 #define KEY_SET_FOCUS           (1 << BIT_SET_FOCUS)
 291
 292 #define MV_DIR_FROM_BIT(x)      ((x) < NUM_DIRECTIONS ? 1 << (x) :        \
 293                                  (x) == MV_BIT_UPLEFT    ? MV_UPLEFT    : \
 294                                  (x) == MV_BIT_UPRIGHT   ? MV_UPRIGHT   : \
 295                                  (x) == MV_BIT_DOWNLEFT  ? MV_DOWNLEFT  : \
 296                                  (x) == MV_BIT_DOWNRIGHT ? MV_DOWNRIGHT : \
 297                                  MV_NONE)
 298
 299 #define MV_DIR_TO_BIT(x)        ((x) == MV_LEFT      ? MV_BIT_LEFT      : \
 300                                  (x) == MV_RIGHT     ? MV_BIT_RIGHT     : \
 301                                  (x) == MV_UP        ? MV_BIT_UP        : \
 302                                  (x) == MV_DOWN      ? MV_BIT_DOWN      : \
 303                                  (x) == MV_UPLEFT    ? MV_BIT_UPLEFT    : \
 304                                  (x) == MV_UPRIGHT   ? MV_BIT_UPRIGHT   : \
 305                                  (x) == MV_DOWNLEFT  ? MV_BIT_DOWNLEFT  : \
 306                                  (x) == MV_DOWNRIGHT ? MV_BIT_DOWNRIGHT : \
 307                                  MV_BIT_DOWN)
 308
 309 #define MV_DIR_OPPOSITE(x)      ((x) == MV_LEFT      ? MV_RIGHT     : \
 310                                  (x) == MV_RIGHT     ? MV_LEFT      : \
 311                                  (x) == MV_UP        ? MV_DOWN      : \
 312                                  (x) == MV_DOWN      ? MV_UP        : \
 313                                  (x) == MV_UPLEFT    ? MV_DOWNRIGHT : \
 314                                  (x) == MV_UPRIGHT   ? MV_DOWNLEFT  : \
 315                                  (x) == MV_DOWNLEFT  ? MV_UPRIGHT   : \
 316                                  (x) == MV_DOWNRIGHT ? MV_UPLEFT    : \
 317                                  MV_NONE)
 318
 319 /* values for animation mode (frame order and direction) */
 320 /* (stored in level files -- never change existing values) */
 321 #define ANIM_NONE               0
 322 #define ANIM_LOOP               (1 << 0)
 323 #define ANIM_LINEAR             (1 << 1)
 324 #define ANIM_PINGPONG           (1 << 2)
 325 #define ANIM_PINGPONG2          (1 << 3)
 326 #define ANIM_RANDOM             (1 << 4)
 327 #define ANIM_CE_VALUE           (1 << 5)
 328 #define ANIM_CE_SCORE           (1 << 6)
 329 #define ANIM_CE_DELAY           (1 << 7)
 330 #define ANIM_REVERSE            (1 << 8)
 331 #define ANIM_OPAQUE_PLAYER      (1 << 9)
 332
 333 /* values for special (non game element) animation modes */
 334 /* (not stored in level files -- can be changed, if needed) */
 335 #define ANIM_HORIZONTAL         (1 << 10)
 336 #define ANIM_VERTICAL           (1 << 11)
 337 #define ANIM_CENTERED           (1 << 12)
 338 #define ANIM_STATIC_PANEL       (1 << 13)
 339 #define ANIM_ALL                (1 << 14)
 340 #define ANIM_ONCE               (1 << 15)
 341
 342 #define ANIM_DEFAULT            ANIM_LOOP
 343
 344 /* values for special drawing styles (currently only for crumbled graphics) */
 345 #define STYLE_NONE              0
 346 #define STYLE_ACCURATE_BORDERS  (1 << 0)
 347 #define STYLE_INNER_CORNERS     (1 << 1)
 348 #define STYLE_REVERSE           (1 << 2)
 349
 350 /* values for special event handling style (used for global animation) */
 351 #define STYLE_PASSTHROUGH       (1 << 3)
 352 #define STYLE_MULTIPLE_ACTIONS  (1 << 4)
 353
 354 #define STYLE_DEFAULT           STYLE_NONE
 355
 356 /* values for special global animation events */
 357 #define ANIM_EVENT_NONE         0
 358 #define ANIM_EVENT_SELF         (1 << 16)
 359 #define ANIM_EVENT_ANY          (1 << 17)
 360
 361 #define ANIM_EVENT_ANIM_BIT     0
 362 #define ANIM_EVENT_PART_BIT     8
 363
 364 #define ANIM_EVENT_ANIM_MASK    (0xff << ANIM_EVENT_ANIM_BIT)
 365 #define ANIM_EVENT_PART_MASK    (0xff << ANIM_EVENT_PART_BIT)
 366
 367 #define ANIM_EVENT_DEFAULT      ANIM_EVENT_NONE
 368
 369 /* values for special global animation event actions */
 370 #define ANIM_EVENT_ACTION_NONE  -1
 371
 372 /* values for fade mode */
 373 #define FADE_TYPE_NONE          0
 374 #define FADE_TYPE_FADE_IN       (1 << 0)
 375 #define FADE_TYPE_FADE_OUT      (1 << 1)
 376 #define FADE_TYPE_TRANSFORM     (1 << 2)
 377 #define FADE_TYPE_CROSSFADE     (1 << 3)
 378 #define FADE_TYPE_MELT          (1 << 4)
 379 #define FADE_TYPE_CURTAIN       (1 << 5)
 380 #define FADE_TYPE_SKIP          (1 << 6)
 381
 382 #define FADE_MODE_NONE          (FADE_TYPE_NONE)
 383 #define FADE_MODE_FADE_IN       (FADE_TYPE_FADE_IN)
 384 #define FADE_MODE_FADE_OUT      (FADE_TYPE_FADE_OUT)
 385 #define FADE_MODE_FADE          (FADE_TYPE_FADE_IN | FADE_TYPE_FADE_OUT)
 386 #define FADE_MODE_TRANSFORM     (FADE_TYPE_TRANSFORM | FADE_TYPE_FADE_IN)
 387 #define FADE_MODE_CROSSFADE     (FADE_MODE_TRANSFORM | FADE_TYPE_CROSSFADE)
 388 #define FADE_MODE_MELT          (FADE_MODE_TRANSFORM | FADE_TYPE_MELT)
 389 #define FADE_MODE_CURTAIN       (FADE_MODE_TRANSFORM | FADE_TYPE_CURTAIN)
 390 #define FADE_MODE_SKIP_FADE_IN  (FADE_TYPE_SKIP | FADE_TYPE_FADE_IN)
 391 #define FADE_MODE_SKIP_FADE_OUT (FADE_TYPE_SKIP | FADE_TYPE_FADE_OUT)
 392
 393 #define FADE_MODE_DEFAULT       FADE_MODE_FADE
 394
 395 /* values for toon positions */
 396 #define POS_UNDEFINED           -1
 397 #define POS_LEFT                0
 398 #define POS_RIGHT               1
 399 #define POS_TOP                 2
 400 #define POS_UPPER               3
 401 #define POS_MIDDLE              4
 402 #define POS_LOWER               5
 403 #define POS_BOTTOM              6
 404 #define POS_ANY                 7
 405 #define POS_LAST                8
 406
 407 /* values for text alignment */
 408 #define ALIGN_LEFT              (1 << 0)
 409 #define ALIGN_RIGHT             (1 << 1)
 410 #define ALIGN_CENTER            (1 << 2)
 411 #define ALIGN_DEFAULT           ALIGN_LEFT
 412
 413 #define VALIGN_TOP              (1 << 0)
 414 #define VALIGN_BOTTOM           (1 << 1)
 415 #define VALIGN_MIDDLE           (1 << 2)
 416 #define VALIGN_DEFAULT          VALIGN_TOP
 417
 418 #define ALIGNED_XPOS(x,w,a)     ((a) == ALIGN_CENTER  ? (x) - (w) / 2 : \
 419                                  (a) == ALIGN_RIGHT   ? (x) - (w) : (x))
 420 #define ALIGNED_YPOS(y,h,v)     ((v) == VALIGN_MIDDLE ? (y) - (h) / 2 : \
 421                                  (v) == VALIGN_BOTTOM ? (y) - (h) : (y))
 422 #define ALIGNED_TEXT_XPOS(p)    ALIGNED_XPOS((p)->x, (p)->width,  (p)->align)
 423 #define ALIGNED_TEXT_YPOS(p)    ALIGNED_YPOS((p)->y, (p)->height, (p)->valign)
 424
 425 /* values for redraw_mask */
 426 #define REDRAW_NONE             (0)
 427 #define REDRAW_ALL              (1 << 0)
 428 #define REDRAW_FIELD            (1 << 1)
 429 #define REDRAW_DOOR_1           (1 << 2)
 430 #define REDRAW_DOOR_2           (1 << 3)
 431 #define REDRAW_DOOR_3           (1 << 4)
 432 #define REDRAW_FPS              (1 << 5)
 433
 434 #define REDRAW_DOORS            (REDRAW_DOOR_1 | \
 435                                  REDRAW_DOOR_2 | \
 436                                  REDRAW_DOOR_3)
 437
 438 #define IN_GFX_FIELD_PLAY(x, y) (x >= gfx.sx && x < gfx.sx + gfx.sxsize && \
 439                                  y >= gfx.sy && y < gfx.sy + gfx.sysize)
 440 #define IN_GFX_FIELD_FULL(x, y) (x >= gfx.real_sx && \
 441                                  x <  gfx.real_sx + gfx.full_sxsize && \
 442                                  y >= gfx.real_sy && \
 443                                  y <  gfx.real_sy + gfx.full_sysize)
 444 #define IN_GFX_DOOR_1(x, y)     (x >= gfx.dx && x < gfx.dx + gfx.dxsize && \
 445                                  y >= gfx.dy && y < gfx.dy + gfx.dysize)
 446 #define IN_GFX_DOOR_2(x, y)     (x >= gfx.vx && x < gfx.vx + gfx.vxsize && \
 447                                  y >= gfx.vy && y < gfx.vy + gfx.vysize)
 448 #define IN_GFX_DOOR_3(x, y)     (x >= gfx.ex && x < gfx.ex + gfx.exsize && \
 449                                  y >= gfx.ey && y < gfx.ey + gfx.eysize)
 450
 451 /* values for mouse cursor */
 452 #define CURSOR_DEFAULT          0
 453 #define CURSOR_NONE             1
 454 #define CURSOR_PLAYFIELD        2
 455
 456 /* fundamental game speed values */
 457 #define ONE_SECOND_DELAY        1000    /* delay value for one second */
 458 #define MENU_FRAME_DELAY        20      /* frame delay in milliseconds */
 459 #define GAME_FRAME_DELAY        20      /* frame delay in milliseconds */
 460 #define FFWD_FRAME_DELAY        10      /* 200% speed for fast forward */
 461 #define FRAMES_PER_SECOND       (ONE_SECOND_DELAY / GAME_FRAME_DELAY)
 462 #define FRAMES_PER_SECOND_SP    35
 463
 464 /* maximum playfield size supported by libgame functions */
 465 #define MAX_PLAYFIELD_WIDTH     128
 466 #define MAX_PLAYFIELD_HEIGHT    128
 467
 468 /* maximum number of parallel players supported by libgame functions */
 469 #define MAX_PLAYERS             4
 470
 471 /* maximum allowed length of player name */
 472 #define MAX_PLAYER_NAME_LEN     10
 473
 474 /* maximum number of levels in a level set */
 475 #define MAX_LEVELS              1000
 476
 477 /* maximum number of global animation and parts */
 478 #define MAX_GLOBAL_ANIMS                32
 479 #define MAX_GLOBAL_ANIM_PARTS           32
 480
 481 /* minimum/maximum/default x/y grid size for virtual buttons */
 482 #define MIN_GRID_XSIZE                  3
 483 #define MIN_GRID_YSIZE                  3
 484 #define MAX_GRID_XSIZE                  32
 485 #define MAX_GRID_YSIZE                  32
 486 #define GRID_REAL_WIDTH                 MAX(1, MAX(video.screen_width,  \
 487                                                    video.screen_height))
 488 #define GRID_REAL_HEIGHT                MAX(1, MIN(video.screen_width,  \
 489                                                    video.screen_height))
 490 #define DEFAULT_GRID_XSIZE_0            18
 491 #define DEFAULT_GRID_YSIZE_0            MIN(MAX(MIN_GRID_YSIZE,         \
 492                                                 DEFAULT_GRID_XSIZE_0 *  \
 493                                                 GRID_REAL_HEIGHT /      \
 494                                                 GRID_REAL_WIDTH),       \
 495                                             MAX_GRID_YSIZE)
 496 #define DEFAULT_GRID_XSIZE_1            13
 497 #define DEFAULT_GRID_YSIZE_1            MIN(MAX(MIN_GRID_YSIZE,         \
 498                                                 DEFAULT_GRID_XSIZE_1 *  \
 499                                                 GRID_REAL_WIDTH /       \
 500                                                 GRID_REAL_HEIGHT),      \
 501                                             MAX_GRID_YSIZE)
 502
 503 #define DEFAULT_GRID_XSIZE(n)           ((n) == 0 ? DEFAULT_GRID_XSIZE_0 : \
 504                                          DEFAULT_GRID_XSIZE_1)
 505 #define DEFAULT_GRID_YSIZE(n)           ((n) == 0 ? DEFAULT_GRID_YSIZE_0 : \
 506                                          DEFAULT_GRID_YSIZE_1)
 507
 508 #define GRID_ACTIVE_NR()                (video.screen_width >   \
 509                                          video.screen_height ? 0 : 1)
 510
 511 /* values for grid button characters for virtual buttons */
 512 #define CHAR_GRID_BUTTON_NONE           ' '
 513 #define CHAR_GRID_BUTTON_LEFT           '<'
 514 #define CHAR_GRID_BUTTON_RIGHT          '>'
 515 #define CHAR_GRID_BUTTON_UP             '^'
 516 #define CHAR_GRID_BUTTON_DOWN           'v'
 517 #define CHAR_GRID_BUTTON_SNAP           '1'
 518 #define CHAR_GRID_BUTTON_DROP           '2'
 519
 520 #define GET_ACTION_FROM_GRID_BUTTON(c)  ((c) == CHAR_GRID_BUTTON_LEFT ?  \
 521                                          JOY_LEFT :                      \
 522                                          (c) == CHAR_GRID_BUTTON_RIGHT ? \
 523                                          JOY_RIGHT :                     \
 524                                          (c) == CHAR_GRID_BUTTON_UP ?    \
 525                                          JOY_UP :                        \
 526                                          (c) == CHAR_GRID_BUTTON_DOWN ?  \
 527                                          JOY_DOWN :                      \
 528                                          (c) == CHAR_GRID_BUTTON_SNAP ?  \
 529                                          JOY_BUTTON_1 :                  \
 530                                          (c) == CHAR_GRID_BUTTON_DROP ?  \
 531                                          JOY_BUTTON_2 :                  \
 532                                          JOY_NO_ACTION)
 533
 534 /* default name for empty highscore entry */
 535 #define EMPTY_PLAYER_NAME       "no name"
 536
 537 /* default name for unknown player names */
 538 #define ANONYMOUS_NAME          "anonymous"
 539
 540 /* default for other unknown names */
 541 #define UNKNOWN_NAME            "unknown"
 542
 543 /* default name for new levels */
 544 #define NAMELESS_LEVEL_NAME     "nameless level"
 545
 546 /* default text for non-existant artwork */
 547 #define NOT_AVAILABLE           "(not available)"
 548
 549 /* default value for undefined filename */
 550 #define UNDEFINED_FILENAME      "[NONE]"
 551
 552 /* default value for undefined levelset */
 553 #define UNDEFINED_LEVELSET      "[NONE]"
 554
 555 /* default value for undefined parameter */
 556 #define ARG_DEFAULT             "[DEFAULT]"
 557
 558 /* default values for undefined configuration file parameters */
 559 #define ARG_UNDEFINED           "-1000000"
 560 #define ARG_UNDEFINED_VALUE     (-1000000)
 561
 562 /* default value for off-screen positions */
 563 #define POS_OFFSCREEN           (-1000000)
 564
 565 /* definitions for game sub-directories */
 566 #ifndef RO_GAME_DIR
 567 #define RO_GAME_DIR             "."
 568 #endif
 569
 570 #ifndef RW_GAME_DIR
 571 #define RW_GAME_DIR             "."
 572 #endif
 573
 574 #define RO_BASE_PATH            RO_GAME_DIR
 575 #define RW_BASE_PATH            RW_GAME_DIR
 576
 577 /* directory names */
 578 #define GRAPHICS_DIRECTORY      "graphics"
 579 #define SOUNDS_DIRECTORY        "sounds"
 580 #define MUSIC_DIRECTORY         "music"
 581 #define LEVELS_DIRECTORY        "levels"
 582 #define TAPES_DIRECTORY         "tapes"
 583 #define SCORES_DIRECTORY        "scores"
 584 #define DOCS_DIRECTORY          "docs"
 585 #define CACHE_DIRECTORY         "cache"
 586 #define CONF_DIRECTORY          "conf"
 587 #define NETWORK_DIRECTORY       "network"
 588
 589 #define GFX_CLASSIC_SUBDIR      "gfx_classic"
 590 #define SND_CLASSIC_SUBDIR      "snd_classic"
 591 #define MUS_CLASSIC_SUBDIR      "mus_classic"
 592
 593 #define GFX_DEFAULT_SUBDIR      (setup.internal.default_graphics_set)
 594 #define SND_DEFAULT_SUBDIR      (setup.internal.default_sounds_set)
 595 #define MUS_DEFAULT_SUBDIR      (setup.internal.default_music_set)
 596
 597 #define GFX_FALLBACK_FILENAME   (setup.internal.fallback_graphics_file)
 598 #define SND_FALLBACK_FILENAME   (setup.internal.fallback_sounds_file)
 599 #define MUS_FALLBACK_FILENAME   (setup.internal.fallback_music_file)
 600
 601 #define DEFAULT_LEVELSET        (setup.internal.default_level_series)
 602
 603 /* file names and filename extensions */
 604 #define LEVELSETUP_DIRECTORY    "levelsetup"
 605 #define SETUP_FILENAME          "setup.conf"
 606 #define AUTOSETUP_FILENAME      "autosetup.conf"
 607 #define LEVELSETUP_FILENAME     "levelsetup.conf"
 608 #define EDITORSETUP_FILENAME    "editorsetup.conf"
 609 #define EDITORCASCADE_FILENAME  "editorcascade.conf"
 610 #define HELPANIM_FILENAME       "helpanim.conf"
 611 #define HELPTEXT_FILENAME       "helptext.conf"
 612 #define LEVELINFO_FILENAME      "levelinfo.conf"
 613 #define GRAPHICSINFO_FILENAME   "graphicsinfo.conf"
 614 #define SOUNDSINFO_FILENAME     "soundsinfo.conf"
 615 #define MUSICINFO_FILENAME      "musicinfo.conf"
 616 #define ARTWORKINFO_CACHE_FILE  "artworkinfo.cache"
 617 #define LEVELTEMPLATE_FILENAME  "template.level"
 618 #define LEVELFILE_EXTENSION     "level"
 619 #define TAPEFILE_EXTENSION      "tape"
 620 #define SCOREFILE_EXTENSION     "score"
 621
 622 #define GAMECONTROLLER_BASENAME "gamecontrollerdb.txt"
 623
 624 #define LOG_OUT_BASENAME        "stdout.txt"
 625 #define LOG_ERR_BASENAME        "stderr.txt"
 626
 627 #define LOG_OUT_ID              0
 628 #define LOG_ERR_ID              1
 629 #define NUM_LOGS                2
 630
 631 #define STRING_PARENT_DIRECTORY         ".."
 632 #define STRING_TOP_DIRECTORY            "/"
 633
 634 #define CHAR_PATH_SEPARATOR_UNIX        '/'
 635 #define CHAR_PATH_SEPARATOR_DOS         '\\'
 636
 637 #define STRING_PATH_SEPARATOR_UNIX      "/"
 638 #define STRING_PATH_SEPARATOR_DOS       "\\"
 639
 640 #define STRING_NEWLINE_UNIX             "\n"
 641 #define STRING_NEWLINE_DOS              "\r\n"
 642
 643 #if defined(PLATFORM_WIN32)
 644 #define CHAR_PATH_SEPARATOR     CHAR_PATH_SEPARATOR_DOS
 645 #define STRING_PATH_SEPARATOR   STRING_PATH_SEPARATOR_DOS
 646 #define STRING_NEWLINE          STRING_NEWLINE_DOS
 647 #else
 648 #define CHAR_PATH_SEPARATOR     CHAR_PATH_SEPARATOR_UNIX
 649 #define STRING_PATH_SEPARATOR   STRING_PATH_SEPARATOR_UNIX
 650 #define STRING_NEWLINE          STRING_NEWLINE_UNIX
 651 #endif
 652
 653
 654 /* areas in bitmap PIX_DOOR */
 655 /* meaning in PIX_DB_DOOR: (3 PAGEs)
 656    PAGEX1: 1. buffer for DOOR_1
 657    PAGEX2: 2. buffer for DOOR_1
 658    PAGEX3: buffer for animations
 659 */
 660
 661 /* these values are hard-coded to be able to use them in initialization */
 662 #define DOOR_GFX_PAGE_WIDTH     100     /* should be set to "gfx.dxsize" */
 663 #define DOOR_GFX_PAGE_HEIGHT    280     /* should be set to "gfx.dysize" */
 664
 665 #define DOOR_GFX_PAGESIZE       (DOOR_GFX_PAGE_WIDTH)
 666 #define DOOR_GFX_PAGEX1         (0 * DOOR_GFX_PAGESIZE)
 667 #define DOOR_GFX_PAGEX2         (1 * DOOR_GFX_PAGESIZE)
 668 #define DOOR_GFX_PAGEX3         (2 * DOOR_GFX_PAGESIZE)
 669 #define DOOR_GFX_PAGEX4         (3 * DOOR_GFX_PAGESIZE)
 670 #define DOOR_GFX_PAGEX5         (4 * DOOR_GFX_PAGESIZE)
 671 #define DOOR_GFX_PAGEX6         (5 * DOOR_GFX_PAGESIZE)
 672 #define DOOR_GFX_PAGEX7         (6 * DOOR_GFX_PAGESIZE)
 673 #define DOOR_GFX_PAGEX8         (7 * DOOR_GFX_PAGESIZE)
 674 #define DOOR_GFX_PAGEY1         (0)
 675 #define DOOR_GFX_PAGEY2         (DOOR_GFX_PAGE_HEIGHT)
 676
 677
 678 /* macros for version handling */
 679 #define VERSION_PART_1(x)       ((x) / 1000000)
 680 #define VERSION_PART_2(x)       (((x) % 1000000) / 10000)
 681 #define VERSION_PART_3(x)       (((x) % 10000) / 100)
 682 #define VERSION_PART_4(x)       ((x) % 100)
 683
 684 #define VERSION_SUPER(x)        VERSION_PART_1(x)
 685 #define VERSION_MAJOR(x)        VERSION_PART_2(x)
 686 #define VERSION_MINOR(x)        VERSION_PART_3(x)
 687 #define VERSION_PATCH(x)        VERSION_PART_4(x)
 688 #define VERSION_IDENT(a,b,c,d)  ((a) * 1000000 + (b) * 10000 + (c) * 100 + (d))
 689
 690
 691 /* macros for parent/child process identification */
 692 #if defined(PLATFORM_UNIX)
 693 #define IS_PARENT_PROCESS()     (audio.mixer_pid != getpid())
 694 #define IS_CHILD_PROCESS()      (audio.mixer_pid == getpid())
 695 #define HAS_CHILD_PROCESS()     (audio.mixer_pid > 0)
 696 #else
 697 #define IS_PARENT_PROCESS()     TRUE
 698 #define IS_CHILD_PROCESS()      FALSE
 699 #define HAS_CHILD_PROCESS()     FALSE
 700 #endif
 701
 702
 703 /* values for artwork type */
 704 #define ARTWORK_TYPE_GRAPHICS   0
 705 #define ARTWORK_TYPE_SOUNDS     1
 706 #define ARTWORK_TYPE_MUSIC      2
 707
 708 #define NUM_ARTWORK_TYPES       3
 709
 710
 711 /* values for tree type (chosen to match artwork type) */
 712 #define TREE_TYPE_UNDEFINED     -1
 713 #define TREE_TYPE_GRAPHICS_DIR  ARTWORK_TYPE_GRAPHICS
 714 #define TREE_TYPE_SOUNDS_DIR    ARTWORK_TYPE_SOUNDS
 715 #define TREE_TYPE_MUSIC_DIR     ARTWORK_TYPE_MUSIC
 716 #define TREE_TYPE_LEVEL_DIR     3
 717 #define TREE_TYPE_LEVEL_NR      4
 718
 719 #define NUM_TREE_TYPES          5
 720
 721 #define INFOTEXT_UNDEFINED      ""
 722 #define INFOTEXT_GRAPHICS_DIR   "Custom Graphics"
 723 #define INFOTEXT_SOUNDS_DIR     "Custom Sounds"
 724 #define INFOTEXT_MUSIC_DIR      "Custom Music"
 725 #define INFOTEXT_LEVEL_DIR      "Level Sets"
 726 #define INFOTEXT_LEVEL_NR       "Levels"
 727
 728 #define TREE_INFOTEXT(t)        ((t) == TREE_TYPE_LEVEL_NR ?            \
 729                                  INFOTEXT_LEVEL_NR :                    \
 730                                  (t) == TREE_TYPE_LEVEL_DIR ?           \
 731                                  INFOTEXT_LEVEL_DIR :                   \
 732                                  (t) == TREE_TYPE_GRAPHICS_DIR ?        \
 733                                  INFOTEXT_GRAPHICS_DIR :                \
 734                                  (t) == TREE_TYPE_SOUNDS_DIR ?          \
 735                                  INFOTEXT_SOUNDS_DIR :                  \
 736                                  (t) == TREE_TYPE_MUSIC_DIR ?           \
 737                                  INFOTEXT_MUSIC_DIR :                   \
 738                                  INFOTEXT_UNDEFINED)
 739
 740 /* values for artwork handling */
 741 #define LEVELDIR_ARTWORK_SET_PTR(leveldir, type)                        \
 742                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
 743                                  &(leveldir)->graphics_set :            \
 744                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
 745                                  &(leveldir)->sounds_set :              \
 746                                  &(leveldir)->music_set)
 747
 748 #define LEVELDIR_ARTWORK_SET(leveldir, type)                            \
 749                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
 750                                  (leveldir)->graphics_set :             \
 751                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
 752                                  (leveldir)->sounds_set :               \
 753                                  (leveldir)->music_set)
 754
 755 #define LEVELDIR_ARTWORK_PATH_PTR(leveldir, type)                       \
 756                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
 757                                  &(leveldir)->graphics_path :           \
 758                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
 759                                  &(leveldir)->sounds_path :             \
 760                                  &(leveldir)->music_path)
 761
 762 #define LEVELDIR_ARTWORK_PATH(leveldir, type)                           \
 763                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
 764                                  (leveldir)->graphics_path :            \
 765                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
 766                                  (leveldir)->sounds_path :              \
 767                                  (leveldir)->music_path)
 768
 769 #define SETUP_ARTWORK_SET(setup, type)                                  \
 770                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
 771                                  (setup).graphics_set :                 \
 772                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
 773                                  (setup).sounds_set :                   \
 774                                  (setup).music_set)
 775
 776 #define SETUP_OVERRIDE_ARTWORK(setup, type)                             \
 777                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
 778                                  (setup).override_level_graphics :      \
 779                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
 780                                  (setup).override_level_sounds :        \
 781                                  (setup).override_level_music)
 782
 783 #define GFX_OVERRIDE_ARTWORK(type)                                      \
 784                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
 785                                  gfx.override_level_graphics :          \
 786                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
 787                                  gfx.override_level_sounds :            \
 788                                  gfx.override_level_music)
 789
 790 #define ARTWORK_FIRST_NODE(artwork, type)                               \
 791                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
 792                                  (artwork).gfx_first :                  \
 793                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
 794                                  (artwork).snd_first :                  \
 795                                  (artwork).mus_first)
 796
 797 #define ARTWORK_CURRENT_IDENTIFIER_PTR(artwork, type)                   \
 798                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
 799                                  &(artwork).gfx_current_identifier :    \
 800                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
 801                                  &(artwork).snd_current_identifier :    \
 802                                  &(artwork).mus_current_identifier)
 803
 804 #define ARTWORK_CURRENT_IDENTIFIER(artwork, type)                       \
 805                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
 806                                  (artwork).gfx_current_identifier :     \
 807                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
 808                                  (artwork).snd_current_identifier :     \
 809                                  (artwork).mus_current_identifier)
 810
 811 #define ARTWORKINFO_FILENAME(type)                                      \
 812                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
 813                                  GRAPHICSINFO_FILENAME :                \
 814                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
 815                                  SOUNDSINFO_FILENAME :                  \
 816                                  (type) == ARTWORK_TYPE_MUSIC ?         \
 817                                  MUSICINFO_FILENAME : "")
 818
 819 #define ARTWORK_DIRECTORY(type)                                         \
 820                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
 821                                  GRAPHICS_DIRECTORY :                   \
 822                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
 823                                  SOUNDS_DIRECTORY :                     \
 824                                  (type) == ARTWORK_TYPE_MUSIC ?         \
 825                                  MUSIC_DIRECTORY : "")
 826
 827 #define OPTIONS_ARTWORK_DIRECTORY(type)                                 \
 828                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
 829                                  options.graphics_directory :           \
 830                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
 831                                  options.sounds_directory :             \
 832                                  (type) == ARTWORK_TYPE_MUSIC ?         \
 833                                  options.music_directory : "")
 834
 835 #define UPDATE_BUSY_STATE()                     \
 836 {                                               \
 837   if (gfx.draw_busy_anim_function != NULL)      \
 838     gfx.draw_busy_anim_function();              \
 839 }
 840
 841
 842 /* structure definitions */
 843
 844 struct ProgramInfo
 845 {
 846   char *command_basepath;       /* path to the program binary */
 847   char *command_basename;       /* base filename of the program binary */
 848
 849   char *config_filename;        /* optional global program config filename */
 850
 851   char *maindata_path;          /* main game data (installation) directory */
 852
 853   char *userdata_subdir;        /* personal user game data directory */
 854   char *userdata_path;          /* resulting full path to game data directory */
 855
 856   char *program_title;
 857   char *window_title;
 858   char *icon_title;
 859
 860   char *icon_filename;
 861
 862   char *cookie_prefix;
 863
 864   char *log_filename[NUM_LOGS];         /* log filenames for out/err messages */
 865   FILE *log_file[NUM_LOGS];             /* log file handles for out/err files */
 866   FILE *log_file_default[NUM_LOGS];     /* default log file handles (out/err) */
 867
 868   int version_super;
 869   int version_major;
 870   int version_minor;
 871   int version_patch;
 872   int version_ident;
 873
 874   char *version_string;
 875
 876   char *(*window_title_function)(void);
 877   void (*exit_message_function)(char *, va_list);
 878   void (*exit_function)(int);
 879
 880   boolean global_scores;
 881   boolean many_scores_per_name;
 882
 883   boolean headless;
 884 };
 885
 886 struct NetworkInfo
 887 {
 888   boolean enabled;
 889   boolean connected;
 890   boolean serveronly;
 891
 892   char *server_host;
 893   int server_port;
 894
 895 };
 896
 897 struct OptionInfo
 898 {
 899   char *server_host;
 900   int server_port;
 901
 902   char *ro_base_directory;
 903   char *rw_base_directory;
 904   char *level_directory;
 905   char *graphics_directory;
 906   char *sounds_directory;
 907   char *music_directory;
 908   char *docs_directory;
 909   char *conf_directory;
 910
 911   char *execute_command;
 912
 913   char *special_flags;
 914
 915   boolean mytapes;
 916   boolean serveronly;
 917   boolean network;
 918   boolean verbose;
 919   boolean debug;
 920 };
 921
 922 struct VideoSystemInfo
 923 {
 924   int default_depth;
 925   int width, height, depth;
 926   int window_width, window_height;
 927   int display_width, display_height;
 928   int screen_width, screen_height;
 929   int screen_xoffset, screen_yoffset;
 930
 931   boolean fullscreen_available;
 932   boolean fullscreen_enabled;
 933   boolean fullscreen_initial;
 934
 935   boolean window_scaling_available;
 936   int window_scaling_percent;
 937   char *window_scaling_quality;
 938   int screen_rendering_mode;
 939   int vsync_mode;
 940
 941   unsigned int frame_delay;
 942   unsigned int frame_delay_value;
 943
 944   boolean shifted_up;
 945   int shifted_up_pos;
 946   int shifted_up_pos_last;
 947   unsigned int shifted_up_delay;
 948   unsigned int shifted_up_delay_value;
 949
 950   boolean initialized;
 951 };
 952
 953 struct AudioSystemInfo
 954 {
 955   boolean sound_available;
 956   boolean loops_available;
 957   boolean music_available;
 958
 959   boolean sound_enabled;
 960   boolean sound_deactivated;    /* for temporarily disabling sound */
 961
 962   int mixer_pipe[2];
 963   int mixer_pid;
 964   char *device_name;
 965   int device_fd;
 966
 967   int num_channels;
 968   int music_channel;
 969   int first_sound_channel;
 970 };
 971
 972 struct FontBitmapInfo
 973 {
 974   Bitmap *bitmap;
 975
 976   int src_x, src_y;             /* start position of font characters */
 977   int width, height;            /* width / height of font characters */
 978
 979   int offset_x;                 /* offset to next font character */
 980   int offset_y;                 /* offset to next font character */
 981
 982   int draw_xoffset;             /* offset for drawing font characters */
 983   int draw_yoffset;             /* offset for drawing font characters */
 984
 985   int num_chars;
 986   int num_chars_per_line;
 987 };
 988
 989 struct GfxInfo
 990 {
 991   int sx, sy;
 992   int sxsize, sysize;
 993   int real_sx, real_sy;
 994   int full_sxsize, full_sysize;
 995   int scrollbuffer_width, scrollbuffer_height;
 996
 997   int game_tile_size, standard_tile_size;
 998
 999   int dx, dy;
1000   int dxsize, dysize;
1001
1002   int vx, vy;
1003   int vxsize, vysize;
1004
1005   int ex, ey;
1006   int exsize, eysize;
1007
1008   int win_xsize, win_ysize;
1009
1010   int draw_deactivation_mask;
1011   int draw_background_mask;
1012
1013   Bitmap *field_save_buffer;
1014
1015   Bitmap *background_bitmap;
1016   int background_bitmap_mask;
1017
1018   Bitmap *fade_bitmap_backup;
1019   Bitmap *fade_bitmap_source;
1020   Bitmap *fade_bitmap_target;
1021   Bitmap *fade_bitmap_black;
1022
1023   int fade_border_source_status;
1024   int fade_border_target_status;
1025   Bitmap *masked_border_bitmap_ptr;
1026
1027   Bitmap *final_screen_bitmap;
1028
1029   boolean clipping_enabled;
1030   int clip_x, clip_y;
1031   int clip_width, clip_height;
1032
1033   boolean override_level_graphics;
1034   boolean override_level_sounds;
1035   boolean override_level_music;
1036
1037   boolean draw_init_text;
1038
1039   int num_fonts;
1040   struct FontBitmapInfo *font_bitmap_info;
1041   int (*select_font_function)(int);
1042   int (*get_font_from_token_function)(char *);
1043
1044   int anim_random_frame;
1045
1046   void (*draw_busy_anim_function)(void);
1047   void (*draw_global_anim_function)(int, int);
1048   void (*draw_global_border_function)(int);
1049   void (*draw_tile_cursor_function)(int);
1050
1051   int cursor_mode;
1052 };
1053
1054 struct TileCursorInfo
1055 {
1056   boolean enabled;              /* tile cursor generally enabled or disabled */
1057   boolean active;               /* tile cursor activated (depending on game) */
1058   boolean moving;               /* tile cursor moving to target position */
1059
1060   int xpos, ypos;               /* tile cursor level playfield position */
1061   int x, y;                     /* tile cursor current screen position */
1062   int target_x, target_y;       /* tile cursor target screen position */
1063
1064   int sx, sy;                   /* tile cursor screen start position */
1065 };
1066
1067 struct OverlayInfo
1068 {
1069   boolean enabled;              /* overlay generally enabled or disabled */
1070   boolean active;               /* overlay activated (depending on game mode) */
1071
1072   boolean show_grid;
1073
1074   int grid_xsize;
1075   int grid_ysize;
1076
1077   char grid_button[MAX_GRID_XSIZE][MAX_GRID_YSIZE];
1078   char grid_button_highlight;
1079
1080   int grid_button_action;
1081 };
1082
1083 struct JoystickInfo
1084 {
1085   int status;
1086   int nr[MAX_PLAYERS];          /* joystick number for each player */
1087 };
1088
1089 struct SetupJoystickInfo
1090 {
1091   char *device_name;            /* device name of player's joystick */
1092
1093   int xleft, xmiddle, xright;
1094   int yupper, ymiddle, ylower;
1095   int snap, drop;
1096 };
1097
1098 struct SetupKeyboardInfo
1099 {
1100   Key left, right, up, down;
1101   Key snap, drop;
1102 };
1103
1104 struct SetupTouchInfo
1105 {
1106   char *control_type;
1107   int move_distance;
1108   int drop_distance;
1109
1110   int grid_xsize[2];
1111   int grid_ysize[2];
1112
1113   char grid_button[2][MAX_GRID_XSIZE][MAX_GRID_YSIZE];
1114
1115   int transparency;             /* in percent (0 == opaque, 100 == invisible) */
1116   boolean draw_outlined;
1117   boolean draw_pressed;
1118
1119   boolean grid_initialized;
1120 };
1121
1122 struct SetupInputInfo
1123 {
1124   boolean use_joystick;
1125   struct SetupJoystickInfo joy;
1126   struct SetupKeyboardInfo key;
1127 };
1128
1129 struct SetupEditorInfo
1130 {
1131   boolean el_boulderdash;
1132   boolean el_emerald_mine;
1133   boolean el_emerald_mine_club;
1134   boolean el_more;
1135   boolean el_sokoban;
1136   boolean el_supaplex;
1137   boolean el_diamond_caves;
1138   boolean el_dx_boulderdash;
1139
1140   boolean el_mirror_magic;
1141   boolean el_deflektor;
1142
1143   boolean el_chars;
1144   boolean el_steel_chars;
1145
1146   boolean el_classic;
1147   boolean el_custom;
1148   boolean el_user_defined;
1149   boolean el_dynamic;
1150
1151   boolean el_headlines;
1152
1153   boolean el_by_game;
1154   boolean el_by_type;
1155
1156   boolean show_element_token;
1157
1158   boolean use_template_for_new_levels;
1159 };
1160
1161 struct SetupAutoSetupInfo
1162 {
1163   int editor_zoom_tilesize;
1164 };
1165
1166 struct SetupEditorCascadeInfo
1167 {
1168   boolean el_bd;
1169   boolean el_em;
1170   boolean el_emc;
1171   boolean el_rnd;
1172   boolean el_sb;
1173   boolean el_sp;
1174   boolean el_dc;
1175   boolean el_dx;
1176   boolean el_mm;
1177   boolean el_df;
1178   boolean el_chars;
1179   boolean el_steel_chars;
1180   boolean el_ce;
1181   boolean el_ge;
1182   boolean el_ref;
1183   boolean el_user;
1184   boolean el_dynamic;
1185 };
1186
1187 struct SetupShortcutInfo
1188 {
1189   Key save_game;
1190   Key load_game;
1191   Key toggle_pause;
1192
1193   Key focus_player[MAX_PLAYERS];
1194   Key focus_player_all;
1195
1196   Key tape_eject;
1197   Key tape_extra;
1198   Key tape_stop;
1199   Key tape_pause;
1200   Key tape_record;
1201   Key tape_play;
1202
1203   Key sound_simple;
1204   Key sound_loops;
1205   Key sound_music;
1206
1207   Key snap_left;
1208   Key snap_right;
1209   Key snap_up;
1210   Key snap_down;
1211 };
1212
1213 struct SetupSystemInfo
1214 {
1215   char *sdl_videodriver;
1216   char *sdl_audiodriver;
1217   int audio_fragment_size;
1218 };
1219
1220 struct SetupInternalInfo
1221 {
1222   char *program_title;
1223   char *program_version;
1224   char *program_author;
1225   char *program_email;
1226   char *program_website;
1227   char *program_copyright;
1228   char *program_company;
1229
1230   char *program_icon_file;
1231
1232   char *default_graphics_set;
1233   char *default_sounds_set;
1234   char *default_music_set;
1235
1236   char *fallback_graphics_file;
1237   char *fallback_sounds_file;
1238   char *fallback_music_file;
1239
1240   char *default_level_series;
1241
1242   int default_window_width;
1243   int default_window_height;
1244
1245   boolean choose_from_top_leveldir;
1246   boolean show_scaling_in_title;
1247 };
1248
1249 struct SetupDebugInfo
1250 {
1251   int frame_delay[10];
1252   Key frame_delay_key[10];
1253   boolean frame_delay_use_mod_key;
1254   boolean frame_delay_game_only;
1255   boolean show_frames_per_second;
1256 };
1257
1258 struct SetupInfo
1259 {
1260   char *player_name;
1261
1262   boolean sound;
1263   boolean sound_loops;
1264   boolean sound_music;
1265   boolean sound_simple;
1266   boolean toons;
1267   boolean scroll_delay;
1268   boolean scroll_delay_value;
1269   char *engine_snapshot_mode;
1270   int engine_snapshot_memory;
1271   boolean fade_screens;
1272   boolean autorecord;
1273   boolean show_titlescreen;
1274   boolean quick_doors;
1275   boolean team_mode;
1276   boolean handicap;
1277   boolean skip_levels;
1278   boolean increment_levels;
1279   boolean auto_play_next_level;
1280   boolean skip_scores_after_game;
1281   boolean time_limit;
1282   boolean fullscreen;
1283   int window_scaling_percent;
1284   char *window_scaling_quality;
1285   char *screen_rendering_mode;
1286   char *vsync_mode;
1287   boolean ask_on_escape;
1288   boolean ask_on_escape_editor;
1289   boolean quick_switch;
1290   boolean input_on_focus;
1291   boolean prefer_aga_graphics;
1292   int game_frame_delay;
1293   boolean sp_show_border_elements;
1294   boolean small_game_graphics;
1295   boolean show_snapshot_buttons;
1296
1297   char *graphics_set;
1298   char *sounds_set;
1299   char *music_set;
1300   int override_level_graphics;          /* not boolean -- can also be "AUTO" */
1301   int override_level_sounds;            /* not boolean -- can also be "AUTO" */
1302   int override_level_music;             /* not boolean -- can also be "AUTO" */
1303
1304   int volume_simple;
1305   int volume_loops;
1306   int volume_music;
1307
1308   boolean network_mode;
1309   int network_player_nr;
1310   char *network_server_hostname;
1311
1312   struct SetupAutoSetupInfo auto_setup;
1313   struct SetupEditorInfo editor;
1314   struct SetupEditorCascadeInfo editor_cascade;
1315   struct SetupShortcutInfo shortcut;
1316   struct SetupInputInfo input[MAX_PLAYERS];
1317   struct SetupTouchInfo touch;
1318   struct SetupSystemInfo system;
1319   struct SetupInternalInfo internal;
1320   struct SetupDebugInfo debug;
1321
1322   struct OptionInfo options;
1323 };
1324
1325 struct TreeInfo
1326 {
1327   struct TreeInfo **node_top;           /* topmost node in tree */
1328   struct TreeInfo *node_parent;         /* parent level directory info */
1329   struct TreeInfo *node_group;          /* level group sub-directory info */
1330   struct TreeInfo *next;                /* next level series structure node */
1331
1332   int cl_first;         /* internal control field for setup screen */
1333   int cl_cursor;        /* internal control field for setup screen */
1334
1335   int type;             /* type of tree content */
1336
1337   /* fields for "type == TREE_TYPE_LEVEL_DIR" */
1338
1339   char *subdir;         /* tree info sub-directory basename (may be ".") */
1340   char *fullpath;       /* complete path relative to tree base directory */
1341   char *basepath;       /* absolute base path of tree base directory */
1342   char *identifier;     /* identifier string for configuration files */
1343   char *name;           /* tree info name, as displayed in selection menues */
1344   char *name_sorting;   /* optional sorting name for correct name sorting */
1345   char *author;         /* level or artwork author name */
1346   char *year;           /* optional year of creation for levels or artwork */
1347
1348   char *program_title;     /* optional alternative text for program title */
1349   char *program_copyright; /* optional alternative text for program copyright */
1350   char *program_company;   /* optional alternative text for program company */
1351
1352   char *imported_from;  /* optional comment for imported levels or artwork */
1353   char *imported_by;    /* optional comment for imported levels or artwork */
1354   char *tested_by;      /* optional comment to name people who tested a set */
1355
1356   char *graphics_set_ecs; /* special EMC custom graphics set (ECS graphics) */
1357   char *graphics_set_aga; /* special EMC custom graphics set (AGA graphics) */
1358   char *graphics_set;   /* optional custom graphics set (level tree only) */
1359   char *sounds_set;     /* optional custom sounds set (level tree only) */
1360   char *music_set;      /* optional custom music set (level tree only) */
1361   char *graphics_path;  /* path to optional custom graphics set (level only) */
1362   char *sounds_path;    /* path to optional custom sounds set (level only) */
1363   char *music_path;     /* path to optional custom music set (level only) */
1364
1365   char *level_filename; /* filename of level file (for packed level file) */
1366   char *level_filetype; /* type of levels in level directory or level file */
1367
1368   char *special_flags;  /* flags for special actions performed on level file */
1369
1370   int levels;           /* number of levels in level series */
1371   int first_level;      /* first level number (to allow start with 0 or 1) */
1372   int last_level;       /* last level number (automatically calculated) */
1373   int sort_priority;    /* sort levels by 'sort_priority' and then by name */
1374
1375   boolean latest_engine;/* force level set to use the latest game engine */
1376
1377   boolean level_group;  /* directory contains more level series directories */
1378   boolean parent_link;  /* entry links back to parent directory */
1379   boolean in_user_dir;  /* user defined levels are stored in home directory */
1380   boolean user_defined; /* levels in user directory and marked as "private" */
1381   boolean readonly;     /* readonly levels can not be changed with editor */
1382   boolean handicap;     /* level set has no handicap when set to "false" */
1383   boolean skip_levels;  /* levels can be skipped when set to "true" */
1384
1385   int color;            /* color to use on selection screen for this level */
1386   char *class_desc;     /* description of level series class */
1387   int handicap_level;   /* number of the lowest unsolved level */
1388
1389   char *infotext;       /* optional text to describe the tree type (headline) */
1390 };
1391
1392 typedef struct TreeInfo TreeInfo;
1393 typedef struct TreeInfo LevelDirTree;
1394 typedef struct TreeInfo ArtworkDirTree;
1395 typedef struct TreeInfo GraphicsDirTree;
1396 typedef struct TreeInfo SoundsDirTree;
1397 typedef struct TreeInfo MusicDirTree;
1398
1399 struct ArtworkInfo
1400 {
1401   GraphicsDirTree *gfx_first;
1402   GraphicsDirTree *gfx_current;
1403   SoundsDirTree *snd_first;
1404   SoundsDirTree *snd_current;
1405   MusicDirTree *mus_first;
1406   MusicDirTree *mus_current;
1407
1408   char *gfx_current_identifier;
1409   char *snd_current_identifier;
1410   char *mus_current_identifier;
1411 };
1412
1413 struct ValueTextInfo
1414 {
1415   int value;
1416   char *text;
1417 };
1418
1419 struct ConfigInfo
1420 {
1421   char *token;
1422   char *value;
1423 };
1424
1425 struct ConfigTypeInfo
1426 {
1427   char *token;
1428   char *value;
1429   int type;
1430 };
1431
1432 struct TokenIntPtrInfo
1433 {
1434   char *token;
1435   int *value;
1436 };
1437
1438 struct FileInfo
1439 {
1440   char *token;
1441
1442   char *default_filename;
1443   char *filename;
1444
1445   char **default_parameter;                     /* array of file parameters */
1446   char **parameter;                             /* array of file parameters */
1447
1448   boolean redefined;
1449   boolean fallback_to_default;
1450   boolean default_is_cloned;
1451 };
1452
1453 struct SetupFileList
1454 {
1455   char *token;
1456   char *value;
1457
1458   struct SetupFileList *next;
1459 };
1460
1461 struct ListNodeInfo
1462 {
1463   char *source_filename;                        /* primary key for node list */
1464   int num_references;
1465 };
1466
1467 struct PropertyMapping
1468 {
1469   int base_index;
1470   int ext1_index;
1471   int ext2_index;
1472   int ext3_index;
1473
1474   int artwork_index;
1475 };
1476
1477 struct ArtworkListInfo
1478 {
1479   int type;                                     /* type of artwork */
1480
1481   int num_file_list_entries;
1482   int num_dynamic_file_list_entries;
1483   struct FileInfo *file_list;                   /* static artwork file array */
1484   struct FileInfo *dynamic_file_list;           /* dynamic artwrk file array */
1485
1486   int num_suffix_list_entries;
1487   struct ConfigTypeInfo *suffix_list;           /* parameter suffixes array */
1488
1489   int num_base_prefixes;
1490   int num_ext1_suffixes;
1491   int num_ext2_suffixes;
1492   int num_ext3_suffixes;
1493   char **base_prefixes;                         /* base token prefixes array */
1494   char **ext1_suffixes;                         /* property suffixes array 1 */
1495   char **ext2_suffixes;                         /* property suffixes array 2 */
1496   char **ext3_suffixes;                         /* property suffixes array 3 */
1497
1498   int num_ignore_tokens;
1499   char **ignore_tokens;                         /* file tokens to be ignored */
1500
1501   int num_property_mapping_entries;
1502   struct PropertyMapping *property_mapping;     /* mapping token -> artwork */
1503
1504   int sizeof_artwork_list_entry;
1505
1506   struct ListNodeInfo **artwork_list;           /* static artwork node array */
1507   struct ListNodeInfo **dynamic_artwork_list;   /* dynamic artwrk node array */
1508   struct ListNode *content_list;                /* dynamic artwork node list */
1509
1510   void *(*load_artwork)(char *);                /* constructor function */
1511   void (*free_artwork)(void *);                 /* destructor function */
1512 };
1513
1514 struct XY
1515 {
1516   int x, y;
1517 };
1518
1519 struct XYTileSize
1520 {
1521   int x, y;
1522   int tile_size;
1523 };
1524
1525 struct Rect
1526 {
1527   int x, y;
1528   int width, height;
1529 };
1530
1531 struct RectWithBorder
1532 {
1533   int x, y;
1534   int width, height;
1535   int border_size;
1536 };
1537
1538 struct MenuPosInfo
1539 {
1540   int x, y;
1541   int width, height;
1542   int align, valign;
1543 };
1544
1545 struct DoorPartPosInfo
1546 {
1547   int x, y;
1548   int step_xoffset;
1549   int step_yoffset;
1550   int step_delay;
1551   int start_step;
1552   int start_step_opening;
1553   int start_step_closing;
1554   boolean draw_masked;
1555   int sort_priority;
1556 };
1557
1558 struct TextPosInfo
1559 {
1560   int x, y;
1561   int xoffset;                  /* special case for tape date and time */
1562   int xoffset2;                 /* special case for tape date */
1563   int yoffset;                  /* special case for list of preview players */
1564   int width, height;
1565   int align, valign;
1566   int size;                     /* also used for suffix ".digits" */
1567   int font, font_alt;
1568   boolean draw_masked;
1569   boolean draw_player;          /* special case for network player buttons */
1570   int sort_priority;            /* also used for suffix ".draw_order" */
1571   int id;
1572
1573   int direction;                /* needed for panel time/health graphics */
1574   int class;                    /* needed for panel time/health graphics */
1575   int style;                    /* needed for panel time/health graphics */
1576
1577   int tile_size;                /* special case for list of network players */
1578   int border_size;              /* special case for list of preview players */
1579   int vertical;                 /* special case for list of preview players */
1580 };
1581
1582 struct MouseActionInfo
1583 {
1584   int lx, ly;
1585   int button;
1586   int button_hint;
1587 };
1588
1589 struct LevelSetInfo
1590 {
1591   int music[MAX_LEVELS];
1592
1593   char *identifier;
1594   int level_nr;
1595 };
1596
1597 struct LevelStats
1598 {
1599   int played;
1600   int solved;
1601 };
1602
1603
1604 /* ========================================================================= */
1605 /* exported variables                                                        */
1606 /* ========================================================================= */
1607
1608 extern struct ProgramInfo       program;
1609 extern struct NetworkInfo       network;
1610 extern struct OptionInfo        options;
1611 extern struct VideoSystemInfo   video;
1612 extern struct AudioSystemInfo   audio;
1613 extern struct GfxInfo           gfx;
1614 extern struct TileCursorInfo    tile_cursor;
1615 extern struct OverlayInfo       overlay;
1616 extern struct AnimInfo          anim;
1617 extern struct ArtworkInfo       artwork;
1618 extern struct JoystickInfo      joystick;
1619 extern struct SetupInfo         setup;
1620
1621 extern LevelDirTree            *leveldir_first_all;
1622 extern LevelDirTree            *leveldir_first;
1623 extern LevelDirTree            *leveldir_current;
1624 extern int                      level_nr;
1625
1626 extern struct LevelSetInfo      levelset;
1627 extern struct LevelStats        level_stats[];
1628
1629 extern DrawWindow              *window;
1630 extern DrawBuffer              *backbuffer;
1631 extern DrawBuffer              *drawto;
1632
1633 extern int                      button_status;
1634 extern boolean                  motion_status;
1635 extern int                      wheel_steps;
1636 #if defined(TARGET_SDL2)
1637 extern boolean                  keyrepeat_status;
1638 #endif
1639
1640 extern int                      redraw_mask;
1641
1642 extern int                      FrameCounter;
1643
1644
1645 /* function definitions */
1646
1647 void InitProgramInfo(char *, char *, char *, char *, char *, char *, char *,
1648                      char *, int);
1649 void InitNetworkInfo(boolean, boolean, boolean, char *, int);
1650
1651 void InitScoresInfo(void);
1652 void SetWindowTitle(void);
1653
1654 void InitWindowTitleFunction(char *(*window_title_function)(void));
1655 void InitExitMessageFunction(void (*exit_message_function)(char *, va_list));
1656 void InitExitFunction(void (*exit_function)(int));
1657 void InitPlatformDependentStuff(void);
1658 void ClosePlatformDependentStuff(void);
1659
1660 void InitGfxFieldInfo(int, int, int, int, int, int, int, int, Bitmap *);
1661 void InitGfxTileSizeInfo(int, int);
1662 void InitGfxDoor1Info(int, int, int, int);
1663 void InitGfxDoor2Info(int, int, int, int);
1664 void InitGfxDoor3Info(int, int, int, int);
1665 void InitGfxWindowInfo(int, int);
1666 void InitGfxScrollbufferInfo(int, int);
1667 void InitGfxClipRegion(boolean, int, int, int, int);
1668 void InitGfxDrawBusyAnimFunction(void (*draw_busy_anim_function)(void));
1669 void InitGfxDrawGlobalAnimFunction(void (*draw_global_anim_function)(int, int));
1670 void InitGfxDrawGlobalBorderFunction(void (*draw_global_border_function)(int));
1671 void InitGfxDrawTileCursorFunction(void (*draw_tile_cursor_function)(int));
1672 void InitGfxCustomArtworkInfo(void);
1673 void InitGfxOtherSettings(void);
1674 void InitTileCursorInfo(void);
1675 void InitOverlayInfo(void);
1676 void SetTileCursorEnabled(boolean);
1677 void SetTileCursorActive(boolean);
1678 void SetTileCursorTargetXY(int, int);
1679 void SetTileCursorXY(int, int);
1680 void SetTileCursorSXSY(int, int);
1681 void SetOverlayEnabled(boolean);
1682 void SetOverlayActive(boolean);
1683 void SetOverlayShowGrid(boolean);
1684 boolean GetOverlayActive(void);
1685 void SetDrawDeactivationMask(int);
1686 int GetDrawDeactivationMask(void);
1687 void SetDrawBackgroundMask(int);
1688 void SetWindowBackgroundBitmap(Bitmap *);
1689 void SetMainBackgroundBitmap(Bitmap *);
1690 void SetDoorBackgroundBitmap(Bitmap *);
1691 void SetRedrawMaskFromArea(int, int, int, int);
1692
1693 void LimitScreenUpdates(boolean);
1694
1695 void InitVideoDefaults(void);
1696 void InitVideoDisplay(void);
1697 void CloseVideoDisplay(void);
1698 void InitVideoBuffer(int, int, int, boolean);
1699 Bitmap *CreateBitmapStruct(void);
1700 Bitmap *CreateBitmap(int, int, int);
1701 void ReCreateBitmap(Bitmap **, int, int);
1702 void FreeBitmap(Bitmap *);
1703 void BlitBitmap(Bitmap *, Bitmap *, int, int, int, int, int, int);
1704 void BlitBitmapTiled(Bitmap *, Bitmap *, int, int, int, int, int, int, int,int);
1705 void FadeRectangle(int, int, int, int, int, int, int,
1706                    void (*draw_border_function)(void));
1707 void FillRectangle(Bitmap *, int, int, int, int, Pixel);
1708 void ClearRectangle(Bitmap *, int, int, int, int);
1709 void ClearRectangleOnBackground(Bitmap *, int, int, int, int);
1710 void BlitBitmapMasked(Bitmap *, Bitmap *, int, int, int, int, int, int);
1711 boolean DrawingDeactivatedField(void);
1712 boolean DrawingDeactivated(int, int, int, int);
1713 boolean DrawingOnBackground(int, int);
1714 boolean DrawingAreaChanged(void);
1715 void BlitBitmapOnBackground(Bitmap *, Bitmap *, int, int, int, int, int, int);
1716 void BlitTexture(Bitmap *, int, int, int, int, int, int);
1717 void BlitTextureMasked(Bitmap *, int, int, int, int, int, int);
1718 void BlitToScreen(Bitmap *, int, int, int, int, int, int);
1719 void BlitToScreenMasked(Bitmap *, int, int, int, int, int, int);
1720 void DrawSimpleBlackLine(Bitmap *, int, int, int, int);
1721 void DrawSimpleWhiteLine(Bitmap *, int, int, int, int);
1722 void DrawLines(Bitmap *, struct XY *, int, Pixel);
1723 Pixel GetPixel(Bitmap *, int, int);
1724 Pixel GetPixelFromRGB(Bitmap *, unsigned int,unsigned int,unsigned int);
1725 Pixel GetPixelFromRGBcompact(Bitmap *, unsigned int);
1726
1727 void KeyboardAutoRepeatOn(void);
1728 void KeyboardAutoRepeatOff(void);
1729 boolean SetVideoMode(boolean);
1730 void SetVideoFrameDelay(unsigned int);
1731 unsigned int GetVideoFrameDelay(void);
1732 boolean ChangeVideoModeIfNeeded(boolean);
1733
1734 Bitmap *LoadImage(char *);
1735 Bitmap *LoadCustomImage(char *);
1736 void ReloadCustomImage(Bitmap *, char *);
1737
1738 void ReCreateGameTileSizeBitmap(Bitmap **);
1739 void CreateBitmapWithSmallBitmaps(Bitmap **, int, int);
1740 void CreateBitmapTextures(Bitmap **);
1741 void FreeBitmapTextures(Bitmap **);
1742 void ScaleBitmap(Bitmap **, int);
1743
1744 void SetMouseCursor(int);
1745
1746 void OpenAudio(void);
1747 void CloseAudio(void);
1748 void SetAudioMode(boolean);
1749
1750 boolean PendingEvent(void);
1751 void WaitEvent(Event *event);
1752 void PeekEvent(Event *event);
1753 void CheckQuitEvent(void);
1754 Key GetEventKey(KeyEvent *, boolean);
1755 KeyMod HandleKeyModState(Key, int);
1756 KeyMod GetKeyModState(void);
1757 KeyMod GetKeyModStateFromEvents(void);
1758 void StartTextInput(int, int, int, int);
1759 void StopTextInput(void);
1760 boolean CheckCloseWindowEvent(ClientMessageEvent *);
1761
1762 void InitJoysticks(void);
1763 boolean ReadJoystick(int, int *, int *, boolean *, boolean *);
1764 boolean CheckJoystickOpened(int);
1765 void ClearJoystickState(void);
1766
1767 #endif /* SYSTEM_H */