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