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 TREE_TYPE_IS_DIR(type)  ((type) == TREE_TYPE_GRAPHICS_DIR ||    \
 778                                  (type) == TREE_TYPE_SOUNDS_DIR ||      \
 779                                  (type) == TREE_TYPE_MUSIC_DIR ||       \
 780                                  (type) == TREE_TYPE_LEVEL_DIR)
 781
 782 #define INFOTEXT_UNDEFINED      ""
 783 #define INFOTEXT_GRAPHICS_DIR   "Custom Graphics"
 784 #define INFOTEXT_SOUNDS_DIR     "Custom Sounds"
 785 #define INFOTEXT_MUSIC_DIR      "Custom Music"
 786 #define INFOTEXT_LEVEL_DIR      "Level Sets"
 787 #define INFOTEXT_LEVEL_NR       "Levels"
 788 #define INFOTEXT_PLAYER_NAME    "Players & Teams"
 789
 790 #define BACKLINK_TEXT_MAIN      ".. (main menu)"
 791 #define BACKLINK_TEXT_SETUP     ".. (setup menu)"
 792 #define BACKLINK_TEXT_PARENT    ".. (parent directory)"
 793
 794 #define TREE_INFOTEXT(t)        ((t) == TREE_TYPE_PLAYER_NAME ?         \
 795                                  INFOTEXT_PLAYER_NAME :                 \
 796                                  (t) == TREE_TYPE_LEVEL_NR ?            \
 797                                  INFOTEXT_LEVEL_NR :                    \
 798                                  (t) == TREE_TYPE_LEVEL_DIR ?           \
 799                                  INFOTEXT_LEVEL_DIR :                   \
 800                                  (t) == TREE_TYPE_GRAPHICS_DIR ?        \
 801                                  INFOTEXT_GRAPHICS_DIR :                \
 802                                  (t) == TREE_TYPE_SOUNDS_DIR ?          \
 803                                  INFOTEXT_SOUNDS_DIR :                  \
 804                                  (t) == TREE_TYPE_MUSIC_DIR ?           \
 805                                  INFOTEXT_MUSIC_DIR :                   \
 806                                  INFOTEXT_UNDEFINED)
 807
 808 #define TREE_BACKLINK_TEXT(t)   ((t) == TREE_TYPE_LEVEL_DIR ?           \
 809                                  BACKLINK_TEXT_MAIN :                   \
 810                                  BACKLINK_TEXT_SETUP)
 811
 812 #define TREE_USERDIR(t)         ((t) == TREE_TYPE_LEVEL_DIR ?           \
 813                                  getUserLevelDir(NULL) :                \
 814                                  (t) == TREE_TYPE_GRAPHICS_DIR ?        \
 815                                  getUserGraphicsDir() :                 \
 816                                  (t) == TREE_TYPE_SOUNDS_DIR ?          \
 817                                  getUserSoundsDir() :                   \
 818                                  (t) == TREE_TYPE_MUSIC_DIR ?           \
 819                                  getUserMusicDir() :                    \
 820                                  NULL)
 821
 822 #define TREE_FIRST_NODE_PTR(t)  ((t) == TREE_TYPE_LEVEL_DIR ?           \
 823                                  &leveldir_first :                      \
 824                                  (t) == TREE_TYPE_GRAPHICS_DIR ?        \
 825                                  &artwork.gfx_first :                   \
 826                                  (t) == TREE_TYPE_SOUNDS_DIR ?          \
 827                                  &artwork.snd_first :                   \
 828                                  (t) == TREE_TYPE_MUSIC_DIR ?           \
 829                                  &artwork.mus_first :                   \
 830                                  NULL)
 831
 832 #define TREE_FIRST_NODE(t)      ((t) == TREE_TYPE_LEVEL_DIR ?           \
 833                                  leveldir_first :                       \
 834                                  (t) == TREE_TYPE_GRAPHICS_DIR ?        \
 835                                  artwork.gfx_first :                    \
 836                                  (t) == TREE_TYPE_SOUNDS_DIR ?          \
 837                                  artwork.snd_first :                    \
 838                                  (t) == TREE_TYPE_MUSIC_DIR ?           \
 839                                  artwork.mus_first :                    \
 840                                  NULL)
 841
 842 // values for artwork handling
 843 #define LEVELDIR_ARTWORK_SET_PTR(leveldir, type)                        \
 844                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
 845                                  &(leveldir)->graphics_set :            \
 846                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
 847                                  &(leveldir)->sounds_set :              \
 848                                  &(leveldir)->music_set)
 849
 850 #define LEVELDIR_ARTWORK_SET(leveldir, type)                            \
 851                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
 852                                  (leveldir)->graphics_set :             \
 853                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
 854                                  (leveldir)->sounds_set :               \
 855                                  (leveldir)->music_set)
 856
 857 #define LEVELDIR_ARTWORK_PATH_PTR(leveldir, type)                       \
 858                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
 859                                  &(leveldir)->graphics_path :           \
 860                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
 861                                  &(leveldir)->sounds_path :             \
 862                                  &(leveldir)->music_path)
 863
 864 #define LEVELDIR_ARTWORK_PATH(leveldir, type)                           \
 865                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
 866                                  (leveldir)->graphics_path :            \
 867                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
 868                                  (leveldir)->sounds_path :              \
 869                                  (leveldir)->music_path)
 870
 871 #define SETUP_ARTWORK_SET(setup, type)                                  \
 872                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
 873                                  (setup).graphics_set :                 \
 874                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
 875                                  (setup).sounds_set :                   \
 876                                  (setup).music_set)
 877
 878 #define SETUP_OVERRIDE_ARTWORK(setup, type)                             \
 879                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
 880                                  (setup).override_level_graphics :      \
 881                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
 882                                  (setup).override_level_sounds :        \
 883                                  (setup).override_level_music)
 884
 885 #define GFX_OVERRIDE_ARTWORK(type)                                      \
 886                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
 887                                  gfx.override_level_graphics :          \
 888                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
 889                                  gfx.override_level_sounds :            \
 890                                  gfx.override_level_music)
 891
 892 #define ARTWORK_FIRST_NODE(artwork, type)                               \
 893                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
 894                                  (artwork).gfx_first :                  \
 895                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
 896                                  (artwork).snd_first :                  \
 897                                  (artwork).mus_first)
 898
 899 #define ARTWORK_CURRENT_PTR(artwork, type)                              \
 900                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
 901                                  &(artwork).gfx_current :               \
 902                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
 903                                  &(artwork).snd_current :               \
 904                                  &(artwork).mus_current)
 905
 906 #define ARTWORK_CURRENT(artwork, type)                                  \
 907                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
 908                                  (artwork).gfx_current :                \
 909                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
 910                                  (artwork).snd_current :                \
 911                                  (artwork).mus_current)
 912
 913 #define ARTWORK_CURRENT_IDENTIFIER_PTR(artwork, type)                   \
 914                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
 915                                  &(artwork).gfx_current_identifier :    \
 916                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
 917                                  &(artwork).snd_current_identifier :    \
 918                                  &(artwork).mus_current_identifier)
 919
 920 #define ARTWORK_CURRENT_IDENTIFIER(artwork, type)                       \
 921                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
 922                                  (artwork).gfx_current_identifier :     \
 923                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
 924                                  (artwork).snd_current_identifier :     \
 925                                  (artwork).mus_current_identifier)
 926
 927 #define ARTWORKINFO_FILENAME(type)                                      \
 928                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
 929                                  GRAPHICSINFO_FILENAME :                \
 930                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
 931                                  SOUNDSINFO_FILENAME :                  \
 932                                  (type) == ARTWORK_TYPE_MUSIC ?         \
 933                                  MUSICINFO_FILENAME : "")
 934
 935 #define ARTWORK_DIRECTORY(type)                                         \
 936                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
 937                                  GRAPHICS_DIRECTORY :                   \
 938                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
 939                                  SOUNDS_DIRECTORY :                     \
 940                                  (type) == ARTWORK_TYPE_MUSIC ?         \
 941                                  MUSIC_DIRECTORY : "")
 942
 943 #define OPTIONS_ARTWORK_DIRECTORY(type)                                 \
 944                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
 945                                  options.graphics_directory :           \
 946                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
 947                                  options.sounds_directory :             \
 948                                  (type) == ARTWORK_TYPE_MUSIC ?         \
 949                                  options.music_directory : "")
 950
 951 #define USER_ARTWORK_DIRECTORY(type)                                    \
 952                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
 953                                  getUserGraphicsDir() :                 \
 954                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
 955                                  getUserSoundsDir() :                   \
 956                                  (type) == ARTWORK_TYPE_MUSIC ?         \
 957                                  getUserMusicDir() : "")
 958
 959 #define ARTWORK_DEFAULT_SUBDIR(type)                                    \
 960                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
 961                                  GFX_DEFAULT_SUBDIR :                   \
 962                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
 963                                  SND_DEFAULT_SUBDIR :                   \
 964                                  MUS_DEFAULT_SUBDIR)
 965
 966 #define UPDATE_BUSY_STATE()                     \
 967 {                                               \
 968   if (gfx.draw_busy_anim_function != NULL)      \
 969     gfx.draw_busy_anim_function();              \
 970 }
 971
 972
 973 // structure definitions
 974
 975 struct ProgramInfo
 976 {
 977   char *command_basepath;       // path to the program binary
 978   char *command_basename;       // base filename of the program binary
 979
 980   char *config_filename;        // optional global program config filename
 981
 982   char *maindata_path;          // main game data (installation) directory
 983
 984   char *userdata_subdir;        // personal user game data directory
 985   char *userdata_path;          // resulting full path to game data directory
 986
 987   char *program_title;
 988   char *window_title;
 989   char *icon_title;
 990
 991   char *icon_filename;
 992
 993   char *cookie_prefix;
 994
 995   char *log_filename[NUM_LOGS];         // log filenames for out/err messages
 996   FILE *log_file[NUM_LOGS];             // log file handles for out/err files
 997   FILE *log_file_default[NUM_LOGS];     // default log file handles (out/err)
 998
 999   int version_super;
1000   int version_major;
1001   int version_minor;
1002   int version_patch;
1003   int version_ident;
1004
1005   char *version_string;
1006
1007   char *(*window_title_function)(void);
1008   void (*exit_message_function)(char *, va_list);
1009   void (*exit_function)(int);
1010
1011   boolean global_scores;
1012   boolean many_scores_per_name;
1013
1014   boolean headless;
1015 };
1016
1017 struct NetworkInfo
1018 {
1019   boolean enabled;
1020   boolean connected;
1021   boolean serveronly;
1022
1023   char *server_host;
1024   int server_port;
1025
1026   SDL_Thread *server_thread;
1027   boolean is_server_thread;
1028 };
1029
1030 struct RuntimeInfo
1031 {
1032   boolean uses_touch_device;
1033 };
1034
1035 struct OptionInfo
1036 {
1037   char *server_host;
1038   int server_port;
1039
1040   char *ro_base_directory;
1041   char *rw_base_directory;
1042   char *level_directory;
1043   char *graphics_directory;
1044   char *sounds_directory;
1045   char *music_directory;
1046   char *docs_directory;
1047   char *conf_directory;
1048
1049   char *execute_command;
1050
1051   char *special_flags;
1052   char *debug_mode;
1053
1054   boolean mytapes;
1055   boolean serveronly;
1056   boolean network;
1057   boolean verbose;
1058   boolean debug;
1059 };
1060
1061 struct VideoSystemInfo
1062 {
1063   int default_depth;
1064   int width, height, depth;
1065   int window_width, window_height;
1066   int display_width, display_height;
1067   int screen_width, screen_height;
1068   int screen_xoffset, screen_yoffset;
1069
1070   boolean fullscreen_available;
1071   boolean fullscreen_enabled;
1072   boolean fullscreen_initial;
1073
1074   boolean window_scaling_available;
1075   int window_scaling_percent;
1076   char *window_scaling_quality;
1077   int screen_rendering_mode;
1078   int vsync_mode;
1079
1080   unsigned int frame_counter;
1081   unsigned int frame_delay;
1082   unsigned int frame_delay_value;
1083
1084   boolean shifted_up;
1085   int shifted_up_pos;
1086   int shifted_up_pos_last;
1087   unsigned int shifted_up_delay;
1088   unsigned int shifted_up_delay_value;
1089
1090   boolean initialized;
1091 };
1092
1093 struct AudioSystemInfo
1094 {
1095   boolean sound_available;
1096   boolean loops_available;
1097   boolean music_available;
1098
1099   boolean sound_enabled;
1100   boolean sound_deactivated;    // for temporarily disabling sound
1101
1102   int mixer_pipe[2];
1103   int mixer_pid;
1104   char *device_name;
1105   int device_fd;
1106
1107   int num_channels;
1108   int music_channel;
1109   int first_sound_channel;
1110 };
1111
1112 struct FontBitmapInfo
1113 {
1114   Bitmap *bitmap;
1115
1116   int src_x, src_y;             // start position of font characters
1117   int width, height;            // width / height of font characters
1118
1119   int offset_x;                 // offset to next font character
1120   int offset_y;                 // offset to next font character
1121
1122   int draw_xoffset;             // offset for drawing font characters
1123   int draw_yoffset;             // offset for drawing font characters
1124
1125   int num_chars;
1126   int num_chars_per_line;
1127 };
1128
1129 struct GfxInfo
1130 {
1131   int sx, sy;
1132   int sxsize, sysize;
1133   int real_sx, real_sy;
1134   int full_sxsize, full_sysize;
1135   int scrollbuffer_width, scrollbuffer_height;
1136
1137   int game_tile_size, standard_tile_size;
1138
1139   int dx, dy;
1140   int dxsize, dysize;
1141
1142   int vx, vy;
1143   int vxsize, vysize;
1144
1145   int ex, ey;
1146   int exsize, eysize;
1147
1148   int win_xsize, win_ysize;
1149
1150   int draw_deactivation_mask;
1151   int draw_background_mask;
1152
1153   Bitmap *field_save_buffer;
1154
1155   Bitmap *background_bitmap;
1156   int background_bitmap_mask;
1157
1158   Bitmap *fade_bitmap_backup;
1159   Bitmap *fade_bitmap_source;
1160   Bitmap *fade_bitmap_target;
1161   Bitmap *fade_bitmap_black;
1162
1163   int fade_border_source_status;
1164   int fade_border_target_status;
1165   Bitmap *masked_border_bitmap_ptr;
1166
1167   Bitmap *final_screen_bitmap;
1168
1169   boolean clipping_enabled;
1170   int clip_x, clip_y;
1171   int clip_width, clip_height;
1172
1173   boolean override_level_graphics;
1174   boolean override_level_sounds;
1175   boolean override_level_music;
1176
1177   boolean draw_init_text;
1178
1179   int num_fonts;
1180   struct FontBitmapInfo *font_bitmap_info;
1181   int (*select_font_function)(int);
1182   int (*get_font_from_token_function)(char *);
1183
1184   int anim_random_frame;
1185
1186   void (*draw_busy_anim_function)(void);
1187   void (*draw_global_anim_function)(int, int);
1188   void (*draw_global_border_function)(int);
1189   void (*draw_tile_cursor_function)(int);
1190
1191   int cursor_mode;
1192   int cursor_mode_override;
1193   int cursor_mode_final;
1194   int mouse_x, mouse_y;
1195 };
1196
1197 struct TileCursorInfo
1198 {
1199   boolean enabled;              // tile cursor generally enabled or disabled
1200   boolean active;               // tile cursor activated (depending on game)
1201   boolean moving;               // tile cursor moving to target position
1202
1203   int xpos, ypos;               // tile cursor level playfield position
1204   int x, y;                     // tile cursor current screen position
1205   int target_x, target_y;       // tile cursor target screen position
1206
1207   int sx, sy;                   // tile cursor screen start position
1208
1209   boolean xsn_debug;            // enable or disable XSN debugging
1210 };
1211
1212 struct OverlayInfo
1213 {
1214   boolean enabled;              // overlay generally enabled or disabled
1215   boolean active;               // overlay activated (depending on game mode)
1216
1217   boolean show_grid;
1218
1219   int grid_xsize;
1220   int grid_ysize;
1221
1222   char grid_button[MAX_GRID_XSIZE][MAX_GRID_YSIZE];
1223   char grid_button_highlight;
1224
1225   int grid_button_action;
1226 };
1227
1228 struct JoystickInfo
1229 {
1230   int status;
1231   int nr[MAX_PLAYERS];          // joystick number for each player
1232 };
1233
1234 struct SetupJoystickInfo
1235 {
1236   char *device_name;            // device name of player's joystick
1237
1238   int xleft, xmiddle, xright;
1239   int yupper, ymiddle, ylower;
1240   int snap, drop;
1241 };
1242
1243 struct SetupKeyboardInfo
1244 {
1245   Key left, right, up, down;
1246   Key snap, drop;
1247 };
1248
1249 struct SetupTouchInfo
1250 {
1251   char *control_type;
1252   int move_distance;
1253   int drop_distance;
1254
1255   int grid_xsize[2];
1256   int grid_ysize[2];
1257
1258   char grid_button[2][MAX_GRID_XSIZE][MAX_GRID_YSIZE];
1259
1260   int transparency;             // in percent (0 == opaque, 100 == invisible)
1261   boolean draw_outlined;
1262   boolean draw_pressed;
1263
1264   boolean grid_initialized;
1265 };
1266
1267 struct SetupInputInfo
1268 {
1269   boolean use_joystick;
1270   struct SetupJoystickInfo joy;
1271   struct SetupKeyboardInfo key;
1272 };
1273
1274 struct SetupEditorInfo
1275 {
1276   boolean el_boulderdash;
1277   boolean el_emerald_mine;
1278   boolean el_emerald_mine_club;
1279   boolean el_more;
1280   boolean el_sokoban;
1281   boolean el_supaplex;
1282   boolean el_diamond_caves;
1283   boolean el_dx_boulderdash;
1284
1285   boolean el_mirror_magic;
1286   boolean el_deflektor;
1287
1288   boolean el_chars;
1289   boolean el_steel_chars;
1290
1291   boolean el_classic;
1292   boolean el_custom;
1293   boolean el_user_defined;
1294   boolean el_dynamic;
1295
1296   boolean el_headlines;
1297
1298   boolean el_by_game;
1299   boolean el_by_type;
1300
1301   boolean show_element_token;
1302
1303   boolean show_read_only_warning;
1304
1305   boolean use_template_for_new_levels;
1306 };
1307
1308 struct SetupAutoSetupInfo
1309 {
1310   int editor_zoom_tilesize;
1311 };
1312
1313 struct SetupLevelSetupInfo
1314 {
1315   char *last_level_series[MAX_LEVELDIR_HISTORY + 1];
1316 };
1317
1318 struct SetupEditorCascadeInfo
1319 {
1320   boolean el_bd;
1321   boolean el_em;
1322   boolean el_emc;
1323   boolean el_rnd;
1324   boolean el_sb;
1325   boolean el_sp;
1326   boolean el_dc;
1327   boolean el_dx;
1328   boolean el_mm;
1329   boolean el_df;
1330   boolean el_chars;
1331   boolean el_steel_chars;
1332   boolean el_ce;
1333   boolean el_ge;
1334   boolean el_ref;
1335   boolean el_user;
1336   boolean el_dynamic;
1337 };
1338
1339 struct SetupShortcutInfo
1340 {
1341   Key save_game;
1342   Key load_game;
1343   Key toggle_pause;
1344
1345   Key focus_player[MAX_PLAYERS];
1346   Key focus_player_all;
1347
1348   Key tape_eject;
1349   Key tape_extra;
1350   Key tape_stop;
1351   Key tape_pause;
1352   Key tape_record;
1353   Key tape_play;
1354
1355   Key sound_simple;
1356   Key sound_loops;
1357   Key sound_music;
1358
1359   Key snap_left;
1360   Key snap_right;
1361   Key snap_up;
1362   Key snap_down;
1363 };
1364
1365 struct SetupSystemInfo
1366 {
1367   char *sdl_renderdriver;
1368   char *sdl_videodriver;
1369   char *sdl_audiodriver;
1370   int audio_fragment_size;
1371 };
1372
1373 struct SetupInternalInfo
1374 {
1375   char *program_title;
1376   char *program_version;
1377   char *program_author;
1378   char *program_email;
1379   char *program_website;
1380   char *program_copyright;
1381   char *program_company;
1382
1383   char *program_icon_file;
1384
1385   char *default_graphics_set;
1386   char *default_sounds_set;
1387   char *default_music_set;
1388
1389   char *fallback_graphics_file;
1390   char *fallback_sounds_file;
1391   char *fallback_music_file;
1392
1393   char *default_level_series;
1394
1395   int default_window_width;
1396   int default_window_height;
1397
1398   boolean choose_from_top_leveldir;
1399   boolean show_scaling_in_title;
1400   boolean create_user_levelset;
1401
1402   boolean menu_game;
1403   boolean menu_engines;
1404   boolean menu_editor;
1405   boolean menu_graphics;
1406   boolean menu_sound;
1407   boolean menu_artwork;
1408   boolean menu_input;
1409   boolean menu_touch;
1410   boolean menu_shortcuts;
1411   boolean menu_exit;
1412   boolean menu_save_and_exit;
1413 };
1414
1415 struct SetupDebugInfo
1416 {
1417   int frame_delay[10];
1418   Key frame_delay_key[10];
1419   boolean frame_delay_use_mod_key;
1420   boolean frame_delay_game_only;
1421   boolean show_frames_per_second;
1422   int xsn_mode;
1423   int xsn_percent;
1424 };
1425
1426 struct SetupInfo
1427 {
1428   char *player_name;
1429
1430   boolean multiple_users;
1431
1432   boolean sound;
1433   boolean sound_loops;
1434   boolean sound_music;
1435   boolean sound_simple;
1436   boolean toons;
1437   boolean scroll_delay;
1438   boolean forced_scroll_delay;
1439   int scroll_delay_value;
1440   char *engine_snapshot_mode;
1441   int engine_snapshot_memory;
1442   boolean fade_screens;
1443   boolean autorecord;
1444   boolean show_titlescreen;
1445   boolean quick_doors;
1446   boolean team_mode;
1447   boolean handicap;
1448   boolean skip_levels;
1449   boolean increment_levels;
1450   boolean auto_play_next_level;
1451   boolean count_score_after_game;
1452   boolean show_scores_after_game;
1453   boolean time_limit;
1454   boolean fullscreen;
1455   int window_scaling_percent;
1456   char *window_scaling_quality;
1457   char *screen_rendering_mode;
1458   char *vsync_mode;
1459   boolean ask_on_escape;
1460   boolean ask_on_escape_editor;
1461   boolean ask_on_game_over;
1462   boolean quick_switch;
1463   boolean input_on_focus;
1464   boolean prefer_aga_graphics;
1465   boolean prefer_lowpass_sounds;
1466   boolean prefer_extra_panel_items;
1467   boolean game_speed_extended;
1468   int game_frame_delay;
1469   boolean sp_show_border_elements;
1470   boolean small_game_graphics;
1471   boolean show_snapshot_buttons;
1472
1473   char *graphics_set;
1474   char *sounds_set;
1475   char *music_set;
1476   int override_level_graphics;          // not boolean -- can also be "AUTO"
1477   int override_level_sounds;            // not boolean -- can also be "AUTO"
1478   int override_level_music;             // not boolean -- can also be "AUTO"
1479
1480   int volume_simple;
1481   int volume_loops;
1482   int volume_music;
1483
1484   boolean network_mode;
1485   int network_player_nr;
1486   char *network_server_hostname;
1487
1488   struct SetupAutoSetupInfo auto_setup;
1489   struct SetupLevelSetupInfo level_setup;
1490
1491   struct SetupEditorInfo editor;
1492   struct SetupEditorCascadeInfo editor_cascade;
1493   struct SetupShortcutInfo shortcut;
1494   struct SetupInputInfo input[MAX_PLAYERS];
1495   struct SetupTouchInfo touch;
1496   struct SetupSystemInfo system;
1497   struct SetupInternalInfo internal;
1498   struct SetupDebugInfo debug;
1499
1500   struct OptionInfo options;
1501 };
1502
1503 struct UserInfo
1504 {
1505   int nr;
1506 };
1507
1508 struct TreeInfo
1509 {
1510   struct TreeInfo **node_top;           // topmost node in tree
1511   struct TreeInfo *node_parent;         // parent level directory info
1512   struct TreeInfo *node_group;          // level group sub-directory info
1513   struct TreeInfo *next;                // next level series structure node
1514
1515   int cl_first;         // internal control field for setup screen
1516   int cl_cursor;        // internal control field for setup screen
1517
1518   int type;             // type of tree content
1519
1520   // fields for "type == TREE_TYPE_LEVEL_DIR"
1521
1522   char *subdir;         // tree info sub-directory basename (may be ".")
1523   char *fullpath;       // complete path relative to tree base directory
1524   char *basepath;       // absolute base path of tree base directory
1525   char *identifier;     // identifier string for configuration files
1526   char *name;           // tree info name, as displayed in selection menues
1527   char *name_sorting;   // optional sorting name for correct name sorting
1528   char *author;         // level or artwork author name
1529   char *year;           // optional year of creation for levels or artwork
1530
1531   char *program_title;     // optional alternative text for program title
1532   char *program_copyright; // optional alternative text for program copyright
1533   char *program_company;   // optional alternative text for program company
1534
1535   char *imported_from;  // optional comment for imported levels or artwork
1536   char *imported_by;    // optional comment for imported levels or artwork
1537   char *tested_by;      // optional comment to name people who tested a set
1538
1539   char *graphics_set_ecs; // special EMC custom graphics set (ECS graphics)
1540   char *graphics_set_aga; // special EMC custom graphics set (AGA graphics)
1541   char *graphics_set;   // optional custom graphics set (level tree only)
1542   char *sounds_set_default; // default EMC custom sounds set
1543   char *sounds_set_lowpass; // special EMC custom sounds set (lowpass filter)
1544   char *sounds_set;     // optional custom sounds set (level tree only)
1545   char *music_set;      // optional custom music set (level tree only)
1546   char *graphics_path;  // path to optional custom graphics set (level only)
1547   char *sounds_path;    // path to optional custom sounds set (level only)
1548   char *music_path;     // path to optional custom music set (level only)
1549
1550   char *level_filename; // filename of level file (for packed level file)
1551   char *level_filetype; // type of levels in level directory or level file
1552
1553   char *special_flags;  // flags for special actions performed on level file
1554
1555   int levels;           // number of levels in level series
1556   int first_level;      // first level number (to allow start with 0 or 1)
1557   int last_level;       // last level number (automatically calculated)
1558   int sort_priority;    // sort levels by 'sort_priority' and then by name
1559
1560   boolean latest_engine;// force level set to use the latest game engine
1561
1562   boolean level_group;  // directory contains more level series directories
1563   boolean parent_link;  // entry links back to parent directory
1564   boolean in_user_dir;  // user defined levels are stored in home directory
1565   boolean user_defined; // levels in user directory and marked as "private"
1566   boolean readonly;     // readonly levels can not be changed with editor
1567   boolean handicap;     // level set has no handicap when set to "false"
1568   boolean skip_levels;  // levels can be skipped when set to "true"
1569
1570   boolean use_emc_tiles;// use (swapped) V5/V6 EMC tiles when set to "true"
1571
1572   int color;            // color to use on selection screen for this level
1573   char *class_desc;     // description of level series class
1574   int handicap_level;   // number of the lowest unsolved level
1575
1576   char *infotext;       // optional text to describe the tree type (headline)
1577 };
1578
1579 typedef struct TreeInfo TreeInfo;
1580 typedef struct TreeInfo LevelDirTree;
1581 typedef struct TreeInfo ArtworkDirTree;
1582 typedef struct TreeInfo GraphicsDirTree;
1583 typedef struct TreeInfo SoundsDirTree;
1584 typedef struct TreeInfo MusicDirTree;
1585
1586 struct ArtworkInfo
1587 {
1588   GraphicsDirTree *gfx_first;
1589   GraphicsDirTree *gfx_current;
1590   SoundsDirTree *snd_first;
1591   SoundsDirTree *snd_current;
1592   MusicDirTree *mus_first;
1593   MusicDirTree *mus_current;
1594
1595   char *gfx_current_identifier;
1596   char *snd_current_identifier;
1597   char *mus_current_identifier;
1598 };
1599
1600 struct ValueTextInfo
1601 {
1602   int value;
1603   char *text;
1604 };
1605
1606 struct StringValueTextInfo
1607 {
1608   char *value;
1609   char *text;
1610 };
1611
1612 struct ConfigInfo
1613 {
1614   char *token;
1615   char *value;
1616 };
1617
1618 struct ConfigTypeInfo
1619 {
1620   char *token;
1621   char *value;
1622   int type;
1623 };
1624
1625 struct TokenIntPtrInfo
1626 {
1627   char *token;
1628   int *value;
1629 };
1630
1631 struct FileInfo
1632 {
1633   char *token;
1634
1635   char *default_filename;
1636   char *filename;
1637
1638   char **default_parameter;                     // array of file parameters
1639   char **parameter;                             // array of file parameters
1640
1641   boolean redefined;
1642   boolean fallback_to_default;
1643   boolean default_is_cloned;
1644 };
1645
1646 struct SetupFileList
1647 {
1648   char *token;
1649   char *value;
1650
1651   struct SetupFileList *next;
1652 };
1653
1654 struct ListNodeInfo
1655 {
1656   char *source_filename;                        // primary key for node list
1657   int num_references;
1658 };
1659
1660 struct PropertyMapping
1661 {
1662   int base_index;
1663   int ext1_index;
1664   int ext2_index;
1665   int ext3_index;
1666
1667   int artwork_index;
1668 };
1669
1670 struct ArtworkListInfo
1671 {
1672   int type;                                     // type of artwork
1673
1674   int num_file_list_entries;
1675   int num_dynamic_file_list_entries;
1676   struct FileInfo *file_list;                   // static artwork file array
1677   struct FileInfo *dynamic_file_list;           // dynamic artwrk file array
1678
1679   int num_suffix_list_entries;
1680   struct ConfigTypeInfo *suffix_list;           // parameter suffixes array
1681
1682   int num_base_prefixes;
1683   int num_ext1_suffixes;
1684   int num_ext2_suffixes;
1685   int num_ext3_suffixes;
1686   char **base_prefixes;                         // base token prefixes array
1687   char **ext1_suffixes;                         // property suffixes array 1
1688   char **ext2_suffixes;                         // property suffixes array 2
1689   char **ext3_suffixes;                         // property suffixes array 3
1690
1691   int num_ignore_tokens;
1692   char **ignore_tokens;                         // file tokens to be ignored
1693
1694   int num_property_mapping_entries;
1695   struct PropertyMapping *property_mapping;     // mapping token -> artwork
1696
1697   int sizeof_artwork_list_entry;
1698
1699   struct ListNodeInfo **artwork_list;           // static artwork node array
1700   struct ListNodeInfo **dynamic_artwork_list;   // dynamic artwrk node array
1701   struct ListNode *content_list;                // dynamic artwork node list
1702
1703   void *(*load_artwork)(char *);                // constructor function
1704   void (*free_artwork)(void *);                 // destructor function
1705 };
1706
1707 struct XY
1708 {
1709   int x, y;
1710 };
1711
1712 struct XYTileSize
1713 {
1714   int x, y;
1715   int tile_size;
1716 };
1717
1718 struct Rect
1719 {
1720   int x, y;
1721   int width, height;
1722 };
1723
1724 struct RectWithBorder
1725 {
1726   int x, y;
1727   int width, height;
1728   int min_width, min_height;
1729   int max_width, max_height;
1730   int margin_left;
1731   int margin_right;
1732   int margin_top;
1733   int margin_bottom;
1734   int border_left;
1735   int border_right;
1736   int border_top;
1737   int border_bottom;
1738   int border_size;
1739   int align_size;
1740   int align, valign;
1741 };
1742
1743 struct MenuPosInfo
1744 {
1745   int x, y;
1746   int width, height;
1747   int align, valign;
1748 };
1749
1750 struct DoorPartPosInfo
1751 {
1752   int x, y;
1753   int step_xoffset;
1754   int step_yoffset;
1755   int step_delay;
1756   int start_step;
1757   int start_step_opening;
1758   int start_step_closing;
1759   boolean draw_masked;
1760   int sort_priority;
1761 };
1762
1763 struct TextPosInfo
1764 {
1765   int x, y;
1766   int xoffset;                  // special case for tape date and time
1767   int xoffset2;                 // special case for tape date
1768   int yoffset;                  // special case for list of preview players
1769   int width, height;
1770   int align, valign;
1771   int size;                     // also used for suffix ".digits"
1772   int font, font_alt;
1773   boolean draw_masked;
1774   boolean draw_player;          // special case for network player buttons
1775   int sort_priority;            // also used for suffix ".draw_order"
1776   int id;
1777
1778   int direction;                // needed for panel time/health graphics
1779   int class;                    // needed for panel time/health graphics
1780   int style;                    // needed for panel time/health graphics
1781
1782   int tile_size;                // special case for list of network players
1783   int border_size;              // special case for list of preview players
1784   int vertical;                 // special case for list of preview players
1785
1786   boolean redefined;            // redefined by custom artwork
1787 };
1788
1789 struct MouseActionInfo
1790 {
1791   int lx, ly;
1792   int button;
1793   int button_hint;
1794 };
1795
1796 struct LevelSetInfo
1797 {
1798   int music[MAX_LEVELS];
1799
1800   char *identifier;
1801   int level_nr;
1802 };
1803
1804 struct LevelStats
1805 {
1806   int played;
1807   int solved;
1808 };
1809
1810
1811 // ============================================================================
1812 // exported variables
1813 // ============================================================================
1814
1815 extern struct ProgramInfo       program;
1816 extern struct NetworkInfo       network;
1817 extern struct RuntimeInfo       runtime;
1818 extern struct OptionInfo        options;
1819 extern struct VideoSystemInfo   video;
1820 extern struct AudioSystemInfo   audio;
1821 extern struct GfxInfo           gfx;
1822 extern struct TileCursorInfo    tile_cursor;
1823 extern struct OverlayInfo       overlay;
1824 extern struct AnimInfo          anim;
1825 extern struct ArtworkInfo       artwork;
1826 extern struct JoystickInfo      joystick;
1827 extern struct SetupInfo         setup;
1828 extern struct UserInfo          user;
1829
1830 extern LevelDirTree            *leveldir_first_all;
1831 extern LevelDirTree            *leveldir_first;
1832 extern LevelDirTree            *leveldir_current;
1833 extern int                      level_nr;
1834
1835 extern struct LevelSetInfo      levelset;
1836 extern struct LevelStats        level_stats[];
1837
1838 extern DrawWindow              *window;
1839 extern DrawBuffer              *backbuffer;
1840 extern DrawBuffer              *drawto;
1841
1842 extern int                      button_status;
1843 extern boolean                  motion_status;
1844 extern int                      wheel_steps;
1845 extern boolean                  keyrepeat_status;
1846 extern boolean                  textinput_status;
1847
1848 extern int                      redraw_mask;
1849
1850 extern int                      FrameCounter;
1851
1852
1853 // function definitions
1854
1855 void InitProgramInfo(char *, char *, char *, char *, char *, char *, char *,
1856                      char *, int);
1857 void InitNetworkInfo(boolean, boolean, boolean, char *, int);
1858 void InitRuntimeInfo(void);
1859
1860 void InitScoresInfo(void);
1861 void SetWindowTitle(void);
1862
1863 void InitWindowTitleFunction(char *(*window_title_function)(void));
1864 void InitExitMessageFunction(void (*exit_message_function)(char *, va_list));
1865 void InitExitFunction(void (*exit_function)(int));
1866 void InitPlatformDependentStuff(void);
1867 void ClosePlatformDependentStuff(void);
1868
1869 void InitGfxFieldInfo(int, int, int, int, int, int, int, int, Bitmap *);
1870 void InitGfxTileSizeInfo(int, int);
1871 void InitGfxDoor1Info(int, int, int, int);
1872 void InitGfxDoor2Info(int, int, int, int);
1873 void InitGfxDoor3Info(int, int, int, int);
1874 void InitGfxWindowInfo(int, int);
1875 void InitGfxScrollbufferInfo(int, int);
1876 void InitGfxClipRegion(boolean, int, int, int, int);
1877 void InitGfxDrawBusyAnimFunction(void (*draw_busy_anim_function)(void));
1878 void InitGfxDrawGlobalAnimFunction(void (*draw_global_anim_function)(int, int));
1879 void InitGfxDrawGlobalBorderFunction(void (*draw_global_border_function)(int));
1880 void InitGfxDrawTileCursorFunction(void (*draw_tile_cursor_function)(int));
1881 void InitGfxCustomArtworkInfo(void);
1882 void InitGfxOtherSettings(void);
1883 void InitTileCursorInfo(void);
1884 void InitOverlayInfo(void);
1885 void SetOverlayGridSizeAndButtons(void);
1886 void SetTileCursorEnabled(boolean);
1887 void SetTileCursorActive(boolean);
1888 void SetTileCursorTargetXY(int, int);
1889 void SetTileCursorXY(int, int);
1890 void SetTileCursorSXSY(int, int);
1891 void SetOverlayEnabled(boolean);
1892 void SetOverlayActive(boolean);
1893 void SetOverlayShowGrid(boolean);
1894 boolean GetOverlayEnabled(void);
1895 boolean GetOverlayActive(void);
1896 void SetDrawDeactivationMask(int);
1897 int GetDrawDeactivationMask(void);
1898 void SetDrawBackgroundMask(int);
1899 void SetWindowBackgroundBitmap(Bitmap *);
1900 void SetMainBackgroundBitmap(Bitmap *);
1901 void SetDoorBackgroundBitmap(Bitmap *);
1902 void SetRedrawMaskFromArea(int, int, int, int);
1903
1904 void LimitScreenUpdates(boolean);
1905
1906 void InitVideoDefaults(void);
1907 void InitVideoDisplay(void);
1908 void CloseVideoDisplay(void);
1909 void InitVideoBuffer(int, int, int, boolean);
1910 Bitmap *CreateBitmapStruct(void);
1911 Bitmap *CreateBitmap(int, int, int);
1912 void ReCreateBitmap(Bitmap **, int, int);
1913 void FreeBitmap(Bitmap *);
1914 void BlitBitmap(Bitmap *, Bitmap *, int, int, int, int, int, int);
1915 void BlitBitmapTiled(Bitmap *, Bitmap *, int, int, int, int, int, int, int,int);
1916 void FadeRectangle(int, int, int, int, int, int, int,
1917                    void (*draw_border_function)(void));
1918 void FillRectangle(Bitmap *, int, int, int, int, Pixel);
1919 void ClearRectangle(Bitmap *, int, int, int, int);
1920 void ClearRectangleOnBackground(Bitmap *, int, int, int, int);
1921 void BlitBitmapMasked(Bitmap *, Bitmap *, int, int, int, int, int, int);
1922 boolean DrawingDeactivatedField(void);
1923 boolean DrawingDeactivated(int, int, int, int);
1924 boolean DrawingOnBackground(int, int);
1925 boolean DrawingAreaChanged(void);
1926 void BlitBitmapOnBackground(Bitmap *, Bitmap *, int, int, int, int, int, int);
1927 void BlitTexture(Bitmap *, int, int, int, int, int, int);
1928 void BlitTextureMasked(Bitmap *, int, int, int, int, int, int);
1929 void BlitToScreen(Bitmap *, int, int, int, int, int, int);
1930 void BlitToScreenMasked(Bitmap *, int, int, int, int, int, int);
1931 void DrawSimpleBlackLine(Bitmap *, int, int, int, int);
1932 void DrawSimpleWhiteLine(Bitmap *, int, int, int, int);
1933 void DrawLines(Bitmap *, struct XY *, int, Pixel);
1934 Pixel GetPixel(Bitmap *, int, int);
1935 Pixel GetPixelFromRGB(Bitmap *, unsigned int,unsigned int,unsigned int);
1936 Pixel GetPixelFromRGBcompact(Bitmap *, unsigned int);
1937
1938 void KeyboardAutoRepeatOn(void);
1939 void KeyboardAutoRepeatOff(void);
1940 boolean SetVideoMode(boolean);
1941 void SetVideoFrameDelay(unsigned int);
1942 unsigned int GetVideoFrameDelay(void);
1943 boolean ChangeVideoModeIfNeeded(boolean);
1944
1945 Bitmap *LoadImage(char *);
1946 Bitmap *LoadCustomImage(char *);
1947 void ReloadCustomImage(Bitmap *, char *);
1948
1949 void ReCreateGameTileSizeBitmap(Bitmap **);
1950 void CreateBitmapWithSmallBitmaps(Bitmap **, int, int);
1951 void CreateBitmapTextures(Bitmap **);
1952 void FreeBitmapTextures(Bitmap **);
1953 void ScaleBitmap(Bitmap **, int);
1954
1955 void SetMouseCursor(int);
1956 void UpdateRawMousePosition(int, int);
1957 void UpdateMousePosition(void);
1958
1959 void OpenAudio(void);
1960 void CloseAudio(void);
1961 void SetAudioMode(boolean);
1962
1963 void InitEventFilter(EventFilter);
1964 boolean PendingEvent(void);
1965 void WaitEvent(Event *event);
1966 void PeekEvent(Event *event);
1967 void PumpEvents(void);
1968 void CheckQuitEvent(void);
1969 Key GetEventKey(KeyEvent *, boolean);
1970 KeyMod HandleKeyModState(Key, int);
1971 KeyMod GetKeyModState(void);
1972 KeyMod GetKeyModStateFromEvents(void);
1973 void StartTextInput(int, int, int, int);
1974 void StopTextInput(void);
1975 void PushUserEvent(int, int, int);
1976
1977 void InitJoysticks(void);
1978 boolean ReadJoystick(int, int *, int *, boolean *, boolean *);
1979 boolean CheckJoystickOpened(int);
1980 void ClearJoystickState(void);
1981
1982 #endif // SYSTEM_H