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