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