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