src/libgame/system.h

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