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