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