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