src/libgame/system.h

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