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