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