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