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