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