src/libgame/system.h

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