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 MIN_VSYNC_FRAME_DELAY   15      // minimum value for vsync to keep
 462 #define MAX_VSYNC_FRAME_DELAY   16      // maximum value for vsync to work
 463 #define FRAMES_PER_SECOND       (ONE_SECOND_DELAY / GAME_FRAME_DELAY)
 464 #define FRAMES_PER_SECOND_SP    35
 465
 466 // maximum playfield size supported by libgame functions
 467 #define MAX_PLAYFIELD_WIDTH     128
 468 #define MAX_PLAYFIELD_HEIGHT    128
 469
 470 // maximum number of parallel players supported by libgame functions
 471 #define MAX_PLAYERS             4
 472
 473 // maximum allowed length of player name
 474 #define MAX_PLAYER_NAME_LEN     10
 475
 476 // maximum number of levels in a level set
 477 #define MAX_LEVELS              1000
 478
 479 // maximum number of global animation and parts
 480 #define MAX_GLOBAL_ANIMS                32
 481 #define MAX_GLOBAL_ANIM_PARTS           32
 482
 483 // minimum/maximum/default x/y grid size for virtual buttons
 484 #define MIN_GRID_XSIZE                  3
 485 #define MIN_GRID_YSIZE                  3
 486 #define MAX_GRID_XSIZE                  32
 487 #define MAX_GRID_YSIZE                  32
 488 #define GRID_REAL_WIDTH                 MAX(1, MAX(video.screen_width,  \
 489                                                    video.screen_height))
 490 #define GRID_REAL_HEIGHT                MAX(1, MIN(video.screen_width,  \
 491                                                    video.screen_height))
 492 #define DEFAULT_GRID_XSIZE_0            18
 493 #define DEFAULT_GRID_YSIZE_0            MIN(MAX(MIN_GRID_YSIZE,         \
 494                                                 DEFAULT_GRID_XSIZE_0 *  \
 495                                                 GRID_REAL_HEIGHT /      \
 496                                                 GRID_REAL_WIDTH),       \
 497                                             MAX_GRID_YSIZE)
 498 #define DEFAULT_GRID_XSIZE_1            13
 499 #define DEFAULT_GRID_YSIZE_1            MIN(MAX(MIN_GRID_YSIZE,         \
 500                                                 DEFAULT_GRID_XSIZE_1 *  \
 501                                                 GRID_REAL_WIDTH /       \
 502                                                 GRID_REAL_HEIGHT),      \
 503                                             MAX_GRID_YSIZE)
 504
 505 #define DEFAULT_GRID_XSIZE(n)           ((n) == 0 ? DEFAULT_GRID_XSIZE_0 : \
 506                                          DEFAULT_GRID_XSIZE_1)
 507 #define DEFAULT_GRID_YSIZE(n)           ((n) == 0 ? DEFAULT_GRID_YSIZE_0 : \
 508                                          DEFAULT_GRID_YSIZE_1)
 509
 510 #define GRID_ACTIVE_NR()                (video.screen_width >   \
 511                                          video.screen_height ? 0 : 1)
 512
 513 // values for grid button characters for virtual buttons
 514 #define CHAR_GRID_BUTTON_NONE           ' '
 515 #define CHAR_GRID_BUTTON_LEFT           '<'
 516 #define CHAR_GRID_BUTTON_RIGHT          '>'
 517 #define CHAR_GRID_BUTTON_UP             '^'
 518 #define CHAR_GRID_BUTTON_DOWN           'v'
 519 #define CHAR_GRID_BUTTON_SNAP           '1'
 520 #define CHAR_GRID_BUTTON_DROP           '2'
 521
 522 #define GET_ACTION_FROM_GRID_BUTTON(c)  ((c) == CHAR_GRID_BUTTON_LEFT ?  \
 523                                          JOY_LEFT :                      \
 524                                          (c) == CHAR_GRID_BUTTON_RIGHT ? \
 525                                          JOY_RIGHT :                     \
 526                                          (c) == CHAR_GRID_BUTTON_UP ?    \
 527                                          JOY_UP :                        \
 528                                          (c) == CHAR_GRID_BUTTON_DOWN ?  \
 529                                          JOY_DOWN :                      \
 530                                          (c) == CHAR_GRID_BUTTON_SNAP ?  \
 531                                          JOY_BUTTON_1 :                  \
 532                                          (c) == CHAR_GRID_BUTTON_DROP ?  \
 533                                          JOY_BUTTON_2 :                  \
 534                                          JOY_NO_ACTION)
 535
 536 // default name for empty highscore entry
 537 #define EMPTY_PLAYER_NAME       "no name"
 538
 539 // default name for unknown player names
 540 #define ANONYMOUS_NAME          "anonymous"
 541
 542 // default for other unknown names
 543 #define UNKNOWN_NAME            "unknown"
 544
 545 // default name for new levels
 546 #define NAMELESS_LEVEL_NAME     "nameless level"
 547
 548 // default text for non-existant artwork
 549 #define NOT_AVAILABLE           "(not available)"
 550
 551 // default value for undefined filename
 552 #define UNDEFINED_FILENAME      "[NONE]"
 553
 554 // default value for undefined levelset
 555 #define UNDEFINED_LEVELSET      "[NONE]"
 556
 557 // default value for undefined parameter
 558 #define ARG_DEFAULT             "[DEFAULT]"
 559
 560 // default values for undefined configuration file parameters
 561 #define ARG_UNDEFINED           "-1000000"
 562 #define ARG_UNDEFINED_VALUE     (-1000000)
 563
 564 // default value for off-screen positions
 565 #define POS_OFFSCREEN           (-1000000)
 566
 567 // definitions for game sub-directories
 568 #ifndef RO_GAME_DIR
 569 #define RO_GAME_DIR             "."
 570 #endif
 571
 572 #ifndef RW_GAME_DIR
 573 #define RW_GAME_DIR             "."
 574 #endif
 575
 576 #define RO_BASE_PATH            RO_GAME_DIR
 577 #define RW_BASE_PATH            RW_GAME_DIR
 578
 579 // directory names
 580 #define GRAPHICS_DIRECTORY      "graphics"
 581 #define SOUNDS_DIRECTORY        "sounds"
 582 #define MUSIC_DIRECTORY         "music"
 583 #define LEVELS_DIRECTORY        "levels"
 584 #define TAPES_DIRECTORY         "tapes"
 585 #define SCORES_DIRECTORY        "scores"
 586 #define DOCS_DIRECTORY          "docs"
 587 #define CACHE_DIRECTORY         "cache"
 588 #define CONF_DIRECTORY          "conf"
 589 #define NETWORK_DIRECTORY       "network"
 590
 591 #define GFX_CLASSIC_SUBDIR      "gfx_classic"
 592 #define SND_CLASSIC_SUBDIR      "snd_classic"
 593 #define MUS_CLASSIC_SUBDIR      "mus_classic"
 594
 595 #define GFX_DEFAULT_SUBDIR      (setup.internal.default_graphics_set)
 596 #define SND_DEFAULT_SUBDIR      (setup.internal.default_sounds_set)
 597 #define MUS_DEFAULT_SUBDIR      (setup.internal.default_music_set)
 598
 599 #define GFX_FALLBACK_FILENAME   (setup.internal.fallback_graphics_file)
 600 #define SND_FALLBACK_FILENAME   (setup.internal.fallback_sounds_file)
 601 #define MUS_FALLBACK_FILENAME   (setup.internal.fallback_music_file)
 602
 603 #define DEFAULT_LEVELSET        (setup.internal.default_level_series)
 604
 605 // file names and filename extensions
 606 #define LEVELSETUP_DIRECTORY    "levelsetup"
 607 #define SETUP_FILENAME          "setup.conf"
 608 #define AUTOSETUP_FILENAME      "autosetup.conf"
 609 #define LEVELSETUP_FILENAME     "levelsetup.conf"
 610 #define EDITORSETUP_FILENAME    "editorsetup.conf"
 611 #define EDITORCASCADE_FILENAME  "editorcascade.conf"
 612 #define HELPANIM_FILENAME       "helpanim.conf"
 613 #define HELPTEXT_FILENAME       "helptext.conf"
 614 #define LEVELINFO_FILENAME      "levelinfo.conf"
 615 #define GRAPHICSINFO_FILENAME   "graphicsinfo.conf"
 616 #define SOUNDSINFO_FILENAME     "soundsinfo.conf"
 617 #define MUSICINFO_FILENAME      "musicinfo.conf"
 618 #define ARTWORKINFO_CACHE_FILE  "artworkinfo.cache"
 619 #define LEVELTEMPLATE_FILENAME  "template.level"
 620 #define LEVELFILE_EXTENSION     "level"
 621 #define TAPEFILE_EXTENSION      "tape"
 622 #define SCOREFILE_EXTENSION     "score"
 623
 624 #define GAMECONTROLLER_BASENAME "gamecontrollerdb.txt"
 625
 626 #define LOG_OUT_BASENAME        "stdout.txt"
 627 #define LOG_ERR_BASENAME        "stderr.txt"
 628
 629 #define LOG_OUT_ID              0
 630 #define LOG_ERR_ID              1
 631 #define NUM_LOGS                2
 632
 633 #define STRING_PARENT_DIRECTORY         ".."
 634 #define STRING_TOP_DIRECTORY            "/"
 635
 636 #define CHAR_PATH_SEPARATOR_UNIX        '/'
 637 #define CHAR_PATH_SEPARATOR_DOS         '\\'
 638
 639 #define STRING_PATH_SEPARATOR_UNIX      "/"
 640 #define STRING_PATH_SEPARATOR_DOS       "\\"
 641
 642 #define STRING_NEWLINE_UNIX             "\n"
 643 #define STRING_NEWLINE_DOS              "\r\n"
 644
 645 #if defined(PLATFORM_WIN32)
 646 #define CHAR_PATH_SEPARATOR     CHAR_PATH_SEPARATOR_DOS
 647 #define STRING_PATH_SEPARATOR   STRING_PATH_SEPARATOR_DOS
 648 #define STRING_NEWLINE          STRING_NEWLINE_DOS
 649 #else
 650 #define CHAR_PATH_SEPARATOR     CHAR_PATH_SEPARATOR_UNIX
 651 #define STRING_PATH_SEPARATOR   STRING_PATH_SEPARATOR_UNIX
 652 #define STRING_NEWLINE          STRING_NEWLINE_UNIX
 653 #endif
 654
 655
 656 // areas in bitmap PIX_DOOR
 657 // meaning in PIX_DB_DOOR: (3 PAGEs)
 658 // PAGEX1: 1. buffer for DOOR_1
 659 // PAGEX2: 2. buffer for DOOR_1
 660 // PAGEX3: buffer for animations
 661
 662 // these values are hard-coded to be able to use them in initialization
 663 #define DOOR_GFX_PAGE_WIDTH     100     // should be set to "gfx.dxsize"
 664 #define DOOR_GFX_PAGE_HEIGHT    280     // should be set to "gfx.dysize"
 665
 666 #define DOOR_GFX_PAGESIZE       (DOOR_GFX_PAGE_WIDTH)
 667 #define DOOR_GFX_PAGEX1         (0 * DOOR_GFX_PAGESIZE)
 668 #define DOOR_GFX_PAGEX2         (1 * DOOR_GFX_PAGESIZE)
 669 #define DOOR_GFX_PAGEX3         (2 * DOOR_GFX_PAGESIZE)
 670 #define DOOR_GFX_PAGEX4         (3 * DOOR_GFX_PAGESIZE)
 671 #define DOOR_GFX_PAGEX5         (4 * DOOR_GFX_PAGESIZE)
 672 #define DOOR_GFX_PAGEX6         (5 * DOOR_GFX_PAGESIZE)
 673 #define DOOR_GFX_PAGEX7         (6 * DOOR_GFX_PAGESIZE)
 674 #define DOOR_GFX_PAGEX8         (7 * DOOR_GFX_PAGESIZE)
 675 #define DOOR_GFX_PAGEY1         (0)
 676 #define DOOR_GFX_PAGEY2         (DOOR_GFX_PAGE_HEIGHT)
 677
 678
 679 // macros for version handling
 680 #define VERSION_PART_1(x)       ((x) / 1000000)
 681 #define VERSION_PART_2(x)       (((x) % 1000000) / 10000)
 682 #define VERSION_PART_3(x)       (((x) % 10000) / 100)
 683 #define VERSION_PART_4(x)       ((x) % 100)
 684
 685 #define VERSION_SUPER(x)        VERSION_PART_1(x)
 686 #define VERSION_MAJOR(x)        VERSION_PART_2(x)
 687 #define VERSION_MINOR(x)        VERSION_PART_3(x)
 688 #define VERSION_PATCH(x)        VERSION_PART_4(x)
 689 #define VERSION_IDENT(a,b,c,d)  ((a) * 1000000 + (b) * 10000 + (c) * 100 + (d))
 690
 691
 692 // macros for parent/child process identification
 693 #if defined(PLATFORM_UNIX)
 694 #define IS_PARENT_PROCESS()     (audio.mixer_pid != getpid())
 695 #define IS_CHILD_PROCESS()      (audio.mixer_pid == getpid())
 696 #define HAS_CHILD_PROCESS()     (audio.mixer_pid > 0)
 697 #else
 698 #define IS_PARENT_PROCESS()     TRUE
 699 #define IS_CHILD_PROCESS()      FALSE
 700 #define HAS_CHILD_PROCESS()     FALSE
 701 #endif
 702
 703
 704 // values for artwork type
 705 #define ARTWORK_TYPE_GRAPHICS   0
 706 #define ARTWORK_TYPE_SOUNDS     1
 707 #define ARTWORK_TYPE_MUSIC      2
 708
 709 #define NUM_ARTWORK_TYPES       3
 710
 711
 712 // values for tree type (chosen to match artwork type)
 713 #define TREE_TYPE_UNDEFINED     -1
 714 #define TREE_TYPE_GRAPHICS_DIR  ARTWORK_TYPE_GRAPHICS
 715 #define TREE_TYPE_SOUNDS_DIR    ARTWORK_TYPE_SOUNDS
 716 #define TREE_TYPE_MUSIC_DIR     ARTWORK_TYPE_MUSIC
 717 #define TREE_TYPE_LEVEL_DIR     3
 718 #define TREE_TYPE_LEVEL_NR      4
 719
 720 #define NUM_TREE_TYPES          5
 721
 722 #define INFOTEXT_UNDEFINED      ""
 723 #define INFOTEXT_GRAPHICS_DIR   "Custom Graphics"
 724 #define INFOTEXT_SOUNDS_DIR     "Custom Sounds"
 725 #define INFOTEXT_MUSIC_DIR      "Custom Music"
 726 #define INFOTEXT_LEVEL_DIR      "Level Sets"
 727 #define INFOTEXT_LEVEL_NR       "Levels"
 728
 729 #define TREE_INFOTEXT(t)        ((t) == TREE_TYPE_LEVEL_NR ?            \
 730                                  INFOTEXT_LEVEL_NR :                    \
 731                                  (t) == TREE_TYPE_LEVEL_DIR ?           \
 732                                  INFOTEXT_LEVEL_DIR :                   \
 733                                  (t) == TREE_TYPE_GRAPHICS_DIR ?        \
 734                                  INFOTEXT_GRAPHICS_DIR :                \
 735                                  (t) == TREE_TYPE_SOUNDS_DIR ?          \
 736                                  INFOTEXT_SOUNDS_DIR :                  \
 737                                  (t) == TREE_TYPE_MUSIC_DIR ?           \
 738                                  INFOTEXT_MUSIC_DIR :                   \
 739                                  INFOTEXT_UNDEFINED)
 740
 741 // values for artwork handling
 742 #define LEVELDIR_ARTWORK_SET_PTR(leveldir, type)                        \
 743                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
 744                                  &(leveldir)->graphics_set :            \
 745                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
 746                                  &(leveldir)->sounds_set :              \
 747                                  &(leveldir)->music_set)
 748
 749 #define LEVELDIR_ARTWORK_SET(leveldir, type)                            \
 750                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
 751                                  (leveldir)->graphics_set :             \
 752                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
 753                                  (leveldir)->sounds_set :               \
 754                                  (leveldir)->music_set)
 755
 756 #define LEVELDIR_ARTWORK_PATH_PTR(leveldir, type)                       \
 757                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
 758                                  &(leveldir)->graphics_path :           \
 759                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
 760                                  &(leveldir)->sounds_path :             \
 761                                  &(leveldir)->music_path)
 762
 763 #define LEVELDIR_ARTWORK_PATH(leveldir, type)                           \
 764                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
 765                                  (leveldir)->graphics_path :            \
 766                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
 767                                  (leveldir)->sounds_path :              \
 768                                  (leveldir)->music_path)
 769
 770 #define SETUP_ARTWORK_SET(setup, type)                                  \
 771                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
 772                                  (setup).graphics_set :                 \
 773                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
 774                                  (setup).sounds_set :                   \
 775                                  (setup).music_set)
 776
 777 #define SETUP_OVERRIDE_ARTWORK(setup, type)                             \
 778                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
 779                                  (setup).override_level_graphics :      \
 780                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
 781                                  (setup).override_level_sounds :        \
 782                                  (setup).override_level_music)
 783
 784 #define GFX_OVERRIDE_ARTWORK(type)                                      \
 785                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
 786                                  gfx.override_level_graphics :          \
 787                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
 788                                  gfx.override_level_sounds :            \
 789                                  gfx.override_level_music)
 790
 791 #define ARTWORK_FIRST_NODE(artwork, type)                               \
 792                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
 793                                  (artwork).gfx_first :                  \
 794                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
 795                                  (artwork).snd_first :                  \
 796                                  (artwork).mus_first)
 797
 798 #define ARTWORK_CURRENT_IDENTIFIER_PTR(artwork, type)                   \
 799                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
 800                                  &(artwork).gfx_current_identifier :    \
 801                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
 802                                  &(artwork).snd_current_identifier :    \
 803                                  &(artwork).mus_current_identifier)
 804
 805 #define ARTWORK_CURRENT_IDENTIFIER(artwork, type)                       \
 806                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
 807                                  (artwork).gfx_current_identifier :     \
 808                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
 809                                  (artwork).snd_current_identifier :     \
 810                                  (artwork).mus_current_identifier)
 811
 812 #define ARTWORKINFO_FILENAME(type)                                      \
 813                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
 814                                  GRAPHICSINFO_FILENAME :                \
 815                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
 816                                  SOUNDSINFO_FILENAME :                  \
 817                                  (type) == ARTWORK_TYPE_MUSIC ?         \
 818                                  MUSICINFO_FILENAME : "")
 819
 820 #define ARTWORK_DIRECTORY(type)                                         \
 821                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
 822                                  GRAPHICS_DIRECTORY :                   \
 823                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
 824                                  SOUNDS_DIRECTORY :                     \
 825                                  (type) == ARTWORK_TYPE_MUSIC ?         \
 826                                  MUSIC_DIRECTORY : "")
 827
 828 #define OPTIONS_ARTWORK_DIRECTORY(type)                                 \
 829                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
 830                                  options.graphics_directory :           \
 831                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
 832                                  options.sounds_directory :             \
 833                                  (type) == ARTWORK_TYPE_MUSIC ?         \
 834                                  options.music_directory : "")
 835
 836 #define UPDATE_BUSY_STATE()                     \
 837 {                                               \
 838   if (gfx.draw_busy_anim_function != NULL)      \
 839     gfx.draw_busy_anim_function();              \
 840 }
 841
 842
 843 // structure definitions
 844
 845 struct ProgramInfo
 846 {
 847   char *command_basepath;       // path to the program binary
 848   char *command_basename;       // base filename of the program binary
 849
 850   char *config_filename;        // optional global program config filename
 851
 852   char *maindata_path;          // main game data (installation) directory
 853
 854   char *userdata_subdir;        // personal user game data directory
 855   char *userdata_path;          // resulting full path to game data directory
 856
 857   char *program_title;
 858   char *window_title;
 859   char *icon_title;
 860
 861   char *icon_filename;
 862
 863   char *cookie_prefix;
 864
 865   char *log_filename[NUM_LOGS];         // log filenames for out/err messages
 866   FILE *log_file[NUM_LOGS];             // log file handles for out/err files
 867   FILE *log_file_default[NUM_LOGS];     // default log file handles (out/err)
 868
 869   int version_super;
 870   int version_major;
 871   int version_minor;
 872   int version_patch;
 873   int version_ident;
 874
 875   char *version_string;
 876
 877   char *(*window_title_function)(void);
 878   void (*exit_message_function)(char *, va_list);
 879   void (*exit_function)(int);
 880
 881   boolean global_scores;
 882   boolean many_scores_per_name;
 883
 884   boolean headless;
 885 };
 886
 887 struct NetworkInfo
 888 {
 889   boolean enabled;
 890   boolean connected;
 891   boolean serveronly;
 892
 893   char *server_host;
 894   int server_port;
 895
 896 };
 897
 898 struct OptionInfo
 899 {
 900   char *server_host;
 901   int server_port;
 902
 903   char *ro_base_directory;
 904   char *rw_base_directory;
 905   char *level_directory;
 906   char *graphics_directory;
 907   char *sounds_directory;
 908   char *music_directory;
 909   char *docs_directory;
 910   char *conf_directory;
 911
 912   char *execute_command;
 913
 914   char *special_flags;
 915
 916   boolean mytapes;
 917   boolean serveronly;
 918   boolean network;
 919   boolean verbose;
 920   boolean debug;
 921 };
 922
 923 struct VideoSystemInfo
 924 {
 925   int default_depth;
 926   int width, height, depth;
 927   int window_width, window_height;
 928   int display_width, display_height;
 929   int screen_width, screen_height;
 930   int screen_xoffset, screen_yoffset;
 931
 932   boolean fullscreen_available;
 933   boolean fullscreen_enabled;
 934   boolean fullscreen_initial;
 935
 936   boolean window_scaling_available;
 937   int window_scaling_percent;
 938   char *window_scaling_quality;
 939   int screen_rendering_mode;
 940   int vsync_mode;
 941
 942   unsigned int frame_delay;
 943   unsigned int frame_delay_value;
 944
 945   boolean shifted_up;
 946   int shifted_up_pos;
 947   int shifted_up_pos_last;
 948   unsigned int shifted_up_delay;
 949   unsigned int shifted_up_delay_value;
 950
 951   boolean initialized;
 952 };
 953
 954 struct AudioSystemInfo
 955 {
 956   boolean sound_available;
 957   boolean loops_available;
 958   boolean music_available;
 959
 960   boolean sound_enabled;
 961   boolean sound_deactivated;    // for temporarily disabling sound
 962
 963   int mixer_pipe[2];
 964   int mixer_pid;
 965   char *device_name;
 966   int device_fd;
 967
 968   int num_channels;
 969   int music_channel;
 970   int first_sound_channel;
 971 };
 972
 973 struct FontBitmapInfo
 974 {
 975   Bitmap *bitmap;
 976
 977   int src_x, src_y;             // start position of font characters
 978   int width, height;            // width / height of font characters
 979
 980   int offset_x;                 // offset to next font character
 981   int offset_y;                 // offset to next font character
 982
 983   int draw_xoffset;             // offset for drawing font characters
 984   int draw_yoffset;             // offset for drawing font characters
 985
 986   int num_chars;
 987   int num_chars_per_line;
 988 };
 989
 990 struct GfxInfo
 991 {
 992   int sx, sy;
 993   int sxsize, sysize;
 994   int real_sx, real_sy;
 995   int full_sxsize, full_sysize;
 996   int scrollbuffer_width, scrollbuffer_height;
 997
 998   int game_tile_size, standard_tile_size;
 999
1000   int dx, dy;
1001   int dxsize, dysize;
1002
1003   int vx, vy;
1004   int vxsize, vysize;
1005
1006   int ex, ey;
1007   int exsize, eysize;
1008
1009   int win_xsize, win_ysize;
1010
1011   int draw_deactivation_mask;
1012   int draw_background_mask;
1013
1014   Bitmap *field_save_buffer;
1015
1016   Bitmap *background_bitmap;
1017   int background_bitmap_mask;
1018
1019   Bitmap *fade_bitmap_backup;
1020   Bitmap *fade_bitmap_source;
1021   Bitmap *fade_bitmap_target;
1022   Bitmap *fade_bitmap_black;
1023
1024   int fade_border_source_status;
1025   int fade_border_target_status;
1026   Bitmap *masked_border_bitmap_ptr;
1027
1028   Bitmap *final_screen_bitmap;
1029
1030   boolean clipping_enabled;
1031   int clip_x, clip_y;
1032   int clip_width, clip_height;
1033
1034   boolean override_level_graphics;
1035   boolean override_level_sounds;
1036   boolean override_level_music;
1037
1038   boolean draw_init_text;
1039
1040   int num_fonts;
1041   struct FontBitmapInfo *font_bitmap_info;
1042   int (*select_font_function)(int);
1043   int (*get_font_from_token_function)(char *);
1044
1045   int anim_random_frame;
1046
1047   void (*draw_busy_anim_function)(void);
1048   void (*draw_global_anim_function)(int, int);
1049   void (*draw_global_border_function)(int);
1050   void (*draw_tile_cursor_function)(int);
1051
1052   int cursor_mode;
1053 };
1054
1055 struct TileCursorInfo
1056 {
1057   boolean enabled;              // tile cursor generally enabled or disabled
1058   boolean active;               // tile cursor activated (depending on game)
1059   boolean moving;               // tile cursor moving to target position
1060
1061   int xpos, ypos;               // tile cursor level playfield position
1062   int x, y;                     // tile cursor current screen position
1063   int target_x, target_y;       // tile cursor target screen position
1064
1065   int sx, sy;                   // tile cursor screen start position
1066 };
1067
1068 struct OverlayInfo
1069 {
1070   boolean enabled;              // overlay generally enabled or disabled
1071   boolean active;               // overlay activated (depending on game mode)
1072
1073   boolean show_grid;
1074
1075   int grid_xsize;
1076   int grid_ysize;
1077
1078   char grid_button[MAX_GRID_XSIZE][MAX_GRID_YSIZE];
1079   char grid_button_highlight;
1080
1081   int grid_button_action;
1082 };
1083
1084 struct JoystickInfo
1085 {
1086   int status;
1087   int nr[MAX_PLAYERS];          // joystick number for each player
1088 };
1089
1090 struct SetupJoystickInfo
1091 {
1092   char *device_name;            // device name of player's joystick
1093
1094   int xleft, xmiddle, xright;
1095   int yupper, ymiddle, ylower;
1096   int snap, drop;
1097 };
1098
1099 struct SetupKeyboardInfo
1100 {
1101   Key left, right, up, down;
1102   Key snap, drop;
1103 };
1104
1105 struct SetupTouchInfo
1106 {
1107   char *control_type;
1108   int move_distance;
1109   int drop_distance;
1110
1111   int grid_xsize[2];
1112   int grid_ysize[2];
1113
1114   char grid_button[2][MAX_GRID_XSIZE][MAX_GRID_YSIZE];
1115
1116   int transparency;             // in percent (0 == opaque, 100 == invisible)
1117   boolean draw_outlined;
1118   boolean draw_pressed;
1119
1120   boolean grid_initialized;
1121 };
1122
1123 struct SetupInputInfo
1124 {
1125   boolean use_joystick;
1126   struct SetupJoystickInfo joy;
1127   struct SetupKeyboardInfo key;
1128 };
1129
1130 struct SetupEditorInfo
1131 {
1132   boolean el_boulderdash;
1133   boolean el_emerald_mine;
1134   boolean el_emerald_mine_club;
1135   boolean el_more;
1136   boolean el_sokoban;
1137   boolean el_supaplex;
1138   boolean el_diamond_caves;
1139   boolean el_dx_boulderdash;
1140
1141   boolean el_mirror_magic;
1142   boolean el_deflektor;
1143
1144   boolean el_chars;
1145   boolean el_steel_chars;
1146
1147   boolean el_classic;
1148   boolean el_custom;
1149   boolean el_user_defined;
1150   boolean el_dynamic;
1151
1152   boolean el_headlines;
1153
1154   boolean el_by_game;
1155   boolean el_by_type;
1156
1157   boolean show_element_token;
1158
1159   boolean use_template_for_new_levels;
1160 };
1161
1162 struct SetupAutoSetupInfo
1163 {
1164   int editor_zoom_tilesize;
1165 };
1166
1167 struct SetupEditorCascadeInfo
1168 {
1169   boolean el_bd;
1170   boolean el_em;
1171   boolean el_emc;
1172   boolean el_rnd;
1173   boolean el_sb;
1174   boolean el_sp;
1175   boolean el_dc;
1176   boolean el_dx;
1177   boolean el_mm;
1178   boolean el_df;
1179   boolean el_chars;
1180   boolean el_steel_chars;
1181   boolean el_ce;
1182   boolean el_ge;
1183   boolean el_ref;
1184   boolean el_user;
1185   boolean el_dynamic;
1186 };
1187
1188 struct SetupShortcutInfo
1189 {
1190   Key save_game;
1191   Key load_game;
1192   Key toggle_pause;
1193
1194   Key focus_player[MAX_PLAYERS];
1195   Key focus_player_all;
1196
1197   Key tape_eject;
1198   Key tape_extra;
1199   Key tape_stop;
1200   Key tape_pause;
1201   Key tape_record;
1202   Key tape_play;
1203
1204   Key sound_simple;
1205   Key sound_loops;
1206   Key sound_music;
1207
1208   Key snap_left;
1209   Key snap_right;
1210   Key snap_up;
1211   Key snap_down;
1212 };
1213
1214 struct SetupSystemInfo
1215 {
1216   char *sdl_videodriver;
1217   char *sdl_audiodriver;
1218   int audio_fragment_size;
1219 };
1220
1221 struct SetupInternalInfo
1222 {
1223   char *program_title;
1224   char *program_version;
1225   char *program_author;
1226   char *program_email;
1227   char *program_website;
1228   char *program_copyright;
1229   char *program_company;
1230
1231   char *program_icon_file;
1232
1233   char *default_graphics_set;
1234   char *default_sounds_set;
1235   char *default_music_set;
1236
1237   char *fallback_graphics_file;
1238   char *fallback_sounds_file;
1239   char *fallback_music_file;
1240
1241   char *default_level_series;
1242
1243   int default_window_width;
1244   int default_window_height;
1245
1246   boolean choose_from_top_leveldir;
1247   boolean show_scaling_in_title;
1248 };
1249
1250 struct SetupDebugInfo
1251 {
1252   int frame_delay[10];
1253   Key frame_delay_key[10];
1254   boolean frame_delay_use_mod_key;
1255   boolean frame_delay_game_only;
1256   boolean show_frames_per_second;
1257 };
1258
1259 struct SetupInfo
1260 {
1261   char *player_name;
1262
1263   boolean sound;
1264   boolean sound_loops;
1265   boolean sound_music;
1266   boolean sound_simple;
1267   boolean toons;
1268   boolean scroll_delay;
1269   boolean scroll_delay_value;
1270   char *engine_snapshot_mode;
1271   int engine_snapshot_memory;
1272   boolean fade_screens;
1273   boolean autorecord;
1274   boolean show_titlescreen;
1275   boolean quick_doors;
1276   boolean team_mode;
1277   boolean handicap;
1278   boolean skip_levels;
1279   boolean increment_levels;
1280   boolean auto_play_next_level;
1281   boolean skip_scores_after_game;
1282   boolean time_limit;
1283   boolean fullscreen;
1284   int window_scaling_percent;
1285   char *window_scaling_quality;
1286   char *screen_rendering_mode;
1287   char *vsync_mode;
1288   boolean ask_on_escape;
1289   boolean ask_on_escape_editor;
1290   boolean ask_on_game_over;
1291   boolean quick_switch;
1292   boolean input_on_focus;
1293   boolean prefer_aga_graphics;
1294   boolean game_speed_extended;
1295   int game_frame_delay;
1296   boolean sp_show_border_elements;
1297   boolean small_game_graphics;
1298   boolean show_snapshot_buttons;
1299
1300   char *graphics_set;
1301   char *sounds_set;
1302   char *music_set;
1303   int override_level_graphics;          // not boolean -- can also be "AUTO"
1304   int override_level_sounds;            // not boolean -- can also be "AUTO"
1305   int override_level_music;             // not boolean -- can also be "AUTO"
1306
1307   int volume_simple;
1308   int volume_loops;
1309   int volume_music;
1310
1311   boolean network_mode;
1312   int network_player_nr;
1313   char *network_server_hostname;
1314
1315   struct SetupAutoSetupInfo auto_setup;
1316   struct SetupEditorInfo editor;
1317   struct SetupEditorCascadeInfo editor_cascade;
1318   struct SetupShortcutInfo shortcut;
1319   struct SetupInputInfo input[MAX_PLAYERS];
1320   struct SetupTouchInfo touch;
1321   struct SetupSystemInfo system;
1322   struct SetupInternalInfo internal;
1323   struct SetupDebugInfo debug;
1324
1325   struct OptionInfo options;
1326 };
1327
1328 struct TreeInfo
1329 {
1330   struct TreeInfo **node_top;           // topmost node in tree
1331   struct TreeInfo *node_parent;         // parent level directory info
1332   struct TreeInfo *node_group;          // level group sub-directory info
1333   struct TreeInfo *next;                // next level series structure node
1334
1335   int cl_first;         // internal control field for setup screen
1336   int cl_cursor;        // internal control field for setup screen
1337
1338   int type;             // type of tree content
1339
1340   // fields for "type == TREE_TYPE_LEVEL_DIR"
1341
1342   char *subdir;         // tree info sub-directory basename (may be ".")
1343   char *fullpath;       // complete path relative to tree base directory
1344   char *basepath;       // absolute base path of tree base directory
1345   char *identifier;     // identifier string for configuration files
1346   char *name;           // tree info name, as displayed in selection menues
1347   char *name_sorting;   // optional sorting name for correct name sorting
1348   char *author;         // level or artwork author name
1349   char *year;           // optional year of creation for levels or artwork
1350
1351   char *program_title;     // optional alternative text for program title
1352   char *program_copyright; // optional alternative text for program copyright
1353   char *program_company;   // optional alternative text for program company
1354
1355   char *imported_from;  // optional comment for imported levels or artwork
1356   char *imported_by;    // optional comment for imported levels or artwork
1357   char *tested_by;      // optional comment to name people who tested a set
1358
1359   char *graphics_set_ecs; // special EMC custom graphics set (ECS graphics)
1360   char *graphics_set_aga; // special EMC custom graphics set (AGA graphics)
1361   char *graphics_set;   // optional custom graphics set (level tree only)
1362   char *sounds_set;     // optional custom sounds set (level tree only)
1363   char *music_set;      // optional custom music set (level tree only)
1364   char *graphics_path;  // path to optional custom graphics set (level only)
1365   char *sounds_path;    // path to optional custom sounds set (level only)
1366   char *music_path;     // path to optional custom music set (level only)
1367
1368   char *level_filename; // filename of level file (for packed level file)
1369   char *level_filetype; // type of levels in level directory or level file
1370
1371   char *special_flags;  // flags for special actions performed on level file
1372
1373   int levels;           // number of levels in level series
1374   int first_level;      // first level number (to allow start with 0 or 1)
1375   int last_level;       // last level number (automatically calculated)
1376   int sort_priority;    // sort levels by 'sort_priority' and then by name
1377
1378   boolean latest_engine;// force level set to use the latest game engine
1379
1380   boolean level_group;  // directory contains more level series directories
1381   boolean parent_link;  // entry links back to parent directory
1382   boolean in_user_dir;  // user defined levels are stored in home directory
1383   boolean user_defined; // levels in user directory and marked as "private"
1384   boolean readonly;     // readonly levels can not be changed with editor
1385   boolean handicap;     // level set has no handicap when set to "false"
1386   boolean skip_levels;  // levels can be skipped when set to "true"
1387
1388   int color;            // color to use on selection screen for this level
1389   char *class_desc;     // description of level series class
1390   int handicap_level;   // number of the lowest unsolved level
1391
1392   char *infotext;       // optional text to describe the tree type (headline)
1393 };
1394
1395 typedef struct TreeInfo TreeInfo;
1396 typedef struct TreeInfo LevelDirTree;
1397 typedef struct TreeInfo ArtworkDirTree;
1398 typedef struct TreeInfo GraphicsDirTree;
1399 typedef struct TreeInfo SoundsDirTree;
1400 typedef struct TreeInfo MusicDirTree;
1401
1402 struct ArtworkInfo
1403 {
1404   GraphicsDirTree *gfx_first;
1405   GraphicsDirTree *gfx_current;
1406   SoundsDirTree *snd_first;
1407   SoundsDirTree *snd_current;
1408   MusicDirTree *mus_first;
1409   MusicDirTree *mus_current;
1410
1411   char *gfx_current_identifier;
1412   char *snd_current_identifier;
1413   char *mus_current_identifier;
1414 };
1415
1416 struct ValueTextInfo
1417 {
1418   int value;
1419   char *text;
1420 };
1421
1422 struct StringValueTextInfo
1423 {
1424   char *value;
1425   char *text;
1426 };
1427
1428 struct ConfigInfo
1429 {
1430   char *token;
1431   char *value;
1432 };
1433
1434 struct ConfigTypeInfo
1435 {
1436   char *token;
1437   char *value;
1438   int type;
1439 };
1440
1441 struct TokenIntPtrInfo
1442 {
1443   char *token;
1444   int *value;
1445 };
1446
1447 struct FileInfo
1448 {
1449   char *token;
1450
1451   char *default_filename;
1452   char *filename;
1453
1454   char **default_parameter;                     // array of file parameters
1455   char **parameter;                             // array of file parameters
1456
1457   boolean redefined;
1458   boolean fallback_to_default;
1459   boolean default_is_cloned;
1460 };
1461
1462 struct SetupFileList
1463 {
1464   char *token;
1465   char *value;
1466
1467   struct SetupFileList *next;
1468 };
1469
1470 struct ListNodeInfo
1471 {
1472   char *source_filename;                        // primary key for node list
1473   int num_references;
1474 };
1475
1476 struct PropertyMapping
1477 {
1478   int base_index;
1479   int ext1_index;
1480   int ext2_index;
1481   int ext3_index;
1482
1483   int artwork_index;
1484 };
1485
1486 struct ArtworkListInfo
1487 {
1488   int type;                                     // type of artwork
1489
1490   int num_file_list_entries;
1491   int num_dynamic_file_list_entries;
1492   struct FileInfo *file_list;                   // static artwork file array
1493   struct FileInfo *dynamic_file_list;           // dynamic artwrk file array
1494
1495   int num_suffix_list_entries;
1496   struct ConfigTypeInfo *suffix_list;           // parameter suffixes array
1497
1498   int num_base_prefixes;
1499   int num_ext1_suffixes;
1500   int num_ext2_suffixes;
1501   int num_ext3_suffixes;
1502   char **base_prefixes;                         // base token prefixes array
1503   char **ext1_suffixes;                         // property suffixes array 1
1504   char **ext2_suffixes;                         // property suffixes array 2
1505   char **ext3_suffixes;                         // property suffixes array 3
1506
1507   int num_ignore_tokens;
1508   char **ignore_tokens;                         // file tokens to be ignored
1509
1510   int num_property_mapping_entries;
1511   struct PropertyMapping *property_mapping;     // mapping token -> artwork
1512
1513   int sizeof_artwork_list_entry;
1514
1515   struct ListNodeInfo **artwork_list;           // static artwork node array
1516   struct ListNodeInfo **dynamic_artwork_list;   // dynamic artwrk node array
1517   struct ListNode *content_list;                // dynamic artwork node list
1518
1519   void *(*load_artwork)(char *);                // constructor function
1520   void (*free_artwork)(void *);                 // destructor function
1521 };
1522
1523 struct XY
1524 {
1525   int x, y;
1526 };
1527
1528 struct XYTileSize
1529 {
1530   int x, y;
1531   int tile_size;
1532 };
1533
1534 struct Rect
1535 {
1536   int x, y;
1537   int width, height;
1538 };
1539
1540 struct RectWithBorder
1541 {
1542   int x, y;
1543   int width, height;
1544   int border_size;
1545 };
1546
1547 struct MenuPosInfo
1548 {
1549   int x, y;
1550   int width, height;
1551   int align, valign;
1552 };
1553
1554 struct DoorPartPosInfo
1555 {
1556   int x, y;
1557   int step_xoffset;
1558   int step_yoffset;
1559   int step_delay;
1560   int start_step;
1561   int start_step_opening;
1562   int start_step_closing;
1563   boolean draw_masked;
1564   int sort_priority;
1565 };
1566
1567 struct TextPosInfo
1568 {
1569   int x, y;
1570   int xoffset;                  // special case for tape date and time
1571   int xoffset2;                 // special case for tape date
1572   int yoffset;                  // special case for list of preview players
1573   int width, height;
1574   int align, valign;
1575   int size;                     // also used for suffix ".digits"
1576   int font, font_alt;
1577   boolean draw_masked;
1578   boolean draw_player;          // special case for network player buttons
1579   int sort_priority;            // also used for suffix ".draw_order"
1580   int id;
1581
1582   int direction;                // needed for panel time/health graphics
1583   int class;                    // needed for panel time/health graphics
1584   int style;                    // needed for panel time/health graphics
1585
1586   int tile_size;                // special case for list of network players
1587   int border_size;              // special case for list of preview players
1588   int vertical;                 // special case for list of preview players
1589 };
1590
1591 struct MouseActionInfo
1592 {
1593   int lx, ly;
1594   int button;
1595   int button_hint;
1596 };
1597
1598 struct LevelSetInfo
1599 {
1600   int music[MAX_LEVELS];
1601
1602   char *identifier;
1603   int level_nr;
1604 };
1605
1606 struct LevelStats
1607 {
1608   int played;
1609   int solved;
1610 };
1611
1612
1613 // ============================================================================
1614 // exported variables
1615 // ============================================================================
1616
1617 extern struct ProgramInfo       program;
1618 extern struct NetworkInfo       network;
1619 extern struct OptionInfo        options;
1620 extern struct VideoSystemInfo   video;
1621 extern struct AudioSystemInfo   audio;
1622 extern struct GfxInfo           gfx;
1623 extern struct TileCursorInfo    tile_cursor;
1624 extern struct OverlayInfo       overlay;
1625 extern struct AnimInfo          anim;
1626 extern struct ArtworkInfo       artwork;
1627 extern struct JoystickInfo      joystick;
1628 extern struct SetupInfo         setup;
1629
1630 extern LevelDirTree            *leveldir_first_all;
1631 extern LevelDirTree            *leveldir_first;
1632 extern LevelDirTree            *leveldir_current;
1633 extern int                      level_nr;
1634
1635 extern struct LevelSetInfo      levelset;
1636 extern struct LevelStats        level_stats[];
1637
1638 extern DrawWindow              *window;
1639 extern DrawBuffer              *backbuffer;
1640 extern DrawBuffer              *drawto;
1641
1642 extern int                      button_status;
1643 extern boolean                  motion_status;
1644 extern int                      wheel_steps;
1645 #if defined(TARGET_SDL2)
1646 extern boolean                  keyrepeat_status;
1647 #endif
1648
1649 extern int                      redraw_mask;
1650
1651 extern int                      FrameCounter;
1652
1653
1654 // function definitions
1655
1656 void InitProgramInfo(char *, char *, char *, char *, char *, char *, char *,
1657                      char *, int);
1658 void InitNetworkInfo(boolean, boolean, boolean, char *, int);
1659
1660 void InitScoresInfo(void);
1661 void SetWindowTitle(void);
1662
1663 void InitWindowTitleFunction(char *(*window_title_function)(void));
1664 void InitExitMessageFunction(void (*exit_message_function)(char *, va_list));
1665 void InitExitFunction(void (*exit_function)(int));
1666 void InitPlatformDependentStuff(void);
1667 void ClosePlatformDependentStuff(void);
1668
1669 void InitGfxFieldInfo(int, int, int, int, int, int, int, int, Bitmap *);
1670 void InitGfxTileSizeInfo(int, int);
1671 void InitGfxDoor1Info(int, int, int, int);
1672 void InitGfxDoor2Info(int, int, int, int);
1673 void InitGfxDoor3Info(int, int, int, int);
1674 void InitGfxWindowInfo(int, int);
1675 void InitGfxScrollbufferInfo(int, int);
1676 void InitGfxClipRegion(boolean, int, int, int, int);
1677 void InitGfxDrawBusyAnimFunction(void (*draw_busy_anim_function)(void));
1678 void InitGfxDrawGlobalAnimFunction(void (*draw_global_anim_function)(int, int));
1679 void InitGfxDrawGlobalBorderFunction(void (*draw_global_border_function)(int));
1680 void InitGfxDrawTileCursorFunction(void (*draw_tile_cursor_function)(int));
1681 void InitGfxCustomArtworkInfo(void);
1682 void InitGfxOtherSettings(void);
1683 void InitTileCursorInfo(void);
1684 void InitOverlayInfo(void);
1685 void SetTileCursorEnabled(boolean);
1686 void SetTileCursorActive(boolean);
1687 void SetTileCursorTargetXY(int, int);
1688 void SetTileCursorXY(int, int);
1689 void SetTileCursorSXSY(int, int);
1690 void SetOverlayEnabled(boolean);
1691 void SetOverlayActive(boolean);
1692 void SetOverlayShowGrid(boolean);
1693 boolean GetOverlayActive(void);
1694 void SetDrawDeactivationMask(int);
1695 int GetDrawDeactivationMask(void);
1696 void SetDrawBackgroundMask(int);
1697 void SetWindowBackgroundBitmap(Bitmap *);
1698 void SetMainBackgroundBitmap(Bitmap *);
1699 void SetDoorBackgroundBitmap(Bitmap *);
1700 void SetRedrawMaskFromArea(int, int, int, int);
1701
1702 void LimitScreenUpdates(boolean);
1703
1704 void InitVideoDefaults(void);
1705 void InitVideoDisplay(void);
1706 void CloseVideoDisplay(void);
1707 void InitVideoBuffer(int, int, int, boolean);
1708 Bitmap *CreateBitmapStruct(void);
1709 Bitmap *CreateBitmap(int, int, int);
1710 void ReCreateBitmap(Bitmap **, int, int);
1711 void FreeBitmap(Bitmap *);
1712 void BlitBitmap(Bitmap *, Bitmap *, int, int, int, int, int, int);
1713 void BlitBitmapTiled(Bitmap *, Bitmap *, int, int, int, int, int, int, int,int);
1714 void FadeRectangle(int, int, int, int, int, int, int,
1715                    void (*draw_border_function)(void));
1716 void FillRectangle(Bitmap *, int, int, int, int, Pixel);
1717 void ClearRectangle(Bitmap *, int, int, int, int);
1718 void ClearRectangleOnBackground(Bitmap *, int, int, int, int);
1719 void BlitBitmapMasked(Bitmap *, Bitmap *, int, int, int, int, int, int);
1720 boolean DrawingDeactivatedField(void);
1721 boolean DrawingDeactivated(int, int, int, int);
1722 boolean DrawingOnBackground(int, int);
1723 boolean DrawingAreaChanged(void);
1724 void BlitBitmapOnBackground(Bitmap *, Bitmap *, int, int, int, int, int, int);
1725 void BlitTexture(Bitmap *, int, int, int, int, int, int);
1726 void BlitTextureMasked(Bitmap *, int, int, int, int, int, int);
1727 void BlitToScreen(Bitmap *, int, int, int, int, int, int);
1728 void BlitToScreenMasked(Bitmap *, int, int, int, int, int, int);
1729 void DrawSimpleBlackLine(Bitmap *, int, int, int, int);
1730 void DrawSimpleWhiteLine(Bitmap *, int, int, int, int);
1731 void DrawLines(Bitmap *, struct XY *, int, Pixel);
1732 Pixel GetPixel(Bitmap *, int, int);
1733 Pixel GetPixelFromRGB(Bitmap *, unsigned int,unsigned int,unsigned int);
1734 Pixel GetPixelFromRGBcompact(Bitmap *, unsigned int);
1735
1736 void KeyboardAutoRepeatOn(void);
1737 void KeyboardAutoRepeatOff(void);
1738 boolean SetVideoMode(boolean);
1739 void SetVideoFrameDelay(unsigned int);
1740 unsigned int GetVideoFrameDelay(void);
1741 boolean ChangeVideoModeIfNeeded(boolean);
1742
1743 Bitmap *LoadImage(char *);
1744 Bitmap *LoadCustomImage(char *);
1745 void ReloadCustomImage(Bitmap *, char *);
1746
1747 void ReCreateGameTileSizeBitmap(Bitmap **);
1748 void CreateBitmapWithSmallBitmaps(Bitmap **, int, int);
1749 void CreateBitmapTextures(Bitmap **);
1750 void FreeBitmapTextures(Bitmap **);
1751 void ScaleBitmap(Bitmap **, int);
1752
1753 void SetMouseCursor(int);
1754
1755 void OpenAudio(void);
1756 void CloseAudio(void);
1757 void SetAudioMode(boolean);
1758
1759 boolean PendingEvent(void);
1760 void WaitEvent(Event *event);
1761 void PeekEvent(Event *event);
1762 void CheckQuitEvent(void);
1763 Key GetEventKey(KeyEvent *, boolean);
1764 KeyMod HandleKeyModState(Key, int);
1765 KeyMod GetKeyModState(void);
1766 KeyMod GetKeyModStateFromEvents(void);
1767 void StartTextInput(int, int, int, int);
1768 void StopTextInput(void);
1769 boolean CheckCloseWindowEvent(ClientMessageEvent *);
1770
1771 void InitJoysticks(void);
1772 boolean ReadJoystick(int, int *, int *, boolean *, boolean *);
1773 boolean CheckJoystickOpened(int);
1774 void ClearJoystickState(void);
1775
1776 #endif // SYSTEM_H