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 #ifndef RW_GAME_DIR
 633 #define RW_GAME_DIR             "."
 634 #endif
 635
 636 #define RO_BASE_PATH            RO_GAME_DIR
 637 #define RW_BASE_PATH            RW_GAME_DIR
 638
 639 // directory names
 640 #define GRAPHICS_DIRECTORY      "graphics"
 641 #define SOUNDS_DIRECTORY        "sounds"
 642 #define MUSIC_DIRECTORY         "music"
 643 #define LEVELS_DIRECTORY        "levels"
 644 #define TAPES_DIRECTORY         "tapes"
 645 #define SCORES_DIRECTORY        "scores"
 646 #define DOCS_DIRECTORY          "docs"
 647 #define CACHE_DIRECTORY         "cache"
 648 #define CONF_DIRECTORY          "conf"
 649 #define NETWORK_DIRECTORY       "network"
 650 #define USERS_DIRECTORY         "users"
 651
 652 #define GFX_CLASSIC_SUBDIR      "gfx_classic"
 653 #define SND_CLASSIC_SUBDIR      "snd_classic"
 654 #define MUS_CLASSIC_SUBDIR      "mus_classic"
 655
 656 #define GFX_DEFAULT_SUBDIR      (setup.internal.default_graphics_set)
 657 #define SND_DEFAULT_SUBDIR      (setup.internal.default_sounds_set)
 658 #define MUS_DEFAULT_SUBDIR      (setup.internal.default_music_set)
 659
 660 #define GFX_FALLBACK_FILENAME   (setup.internal.fallback_graphics_file)
 661 #define SND_FALLBACK_FILENAME   (setup.internal.fallback_sounds_file)
 662 #define MUS_FALLBACK_FILENAME   (setup.internal.fallback_music_file)
 663
 664 #define DEFAULT_LEVELSET        (setup.internal.default_level_series)
 665
 666 // file names and filename extensions
 667 #define LEVELSETUP_DIRECTORY    "levelsetup"
 668 #define SETUP_FILENAME          "setup.conf"
 669 #define USERSETUP_FILENAME      "usersetup.conf"
 670 #define AUTOSETUP_FILENAME      "autosetup.conf"
 671 #define LEVELSETUP_FILENAME     "levelsetup.conf"
 672 #define EDITORSETUP_FILENAME    "editorsetup.conf"
 673 #define EDITORCASCADE_FILENAME  "editorcascade.conf"
 674 #define HELPANIM_FILENAME       "helpanim.conf"
 675 #define HELPTEXT_FILENAME       "helptext.conf"
 676 #define LEVELINFO_FILENAME      "levelinfo.conf"
 677 #define GRAPHICSINFO_FILENAME   "graphicsinfo.conf"
 678 #define SOUNDSINFO_FILENAME     "soundsinfo.conf"
 679 #define MUSICINFO_FILENAME      "musicinfo.conf"
 680 #define ARTWORKINFO_CACHE_FILE  "artworkinfo.cache"
 681 #define LEVELTEMPLATE_FILENAME  "template.level"
 682 #define LEVELFILE_EXTENSION     "level"
 683 #define TAPEFILE_EXTENSION      "tape"
 684 #define SCOREFILE_EXTENSION     "score"
 685
 686 #define GAMECONTROLLER_BASENAME "gamecontrollerdb.txt"
 687
 688 #define LOG_OUT_BASENAME        "stdout.txt"
 689 #define LOG_ERR_BASENAME        "stderr.txt"
 690
 691 #define LOG_OUT_ID              0
 692 #define LOG_ERR_ID              1
 693 #define NUM_LOGS                2
 694
 695 #define STRING_PARENT_DIRECTORY         ".."
 696 #define STRING_TOP_DIRECTORY            "/"
 697
 698 #define CHAR_PATH_SEPARATOR_UNIX        '/'
 699 #define CHAR_PATH_SEPARATOR_DOS         '\\'
 700
 701 #define STRING_PATH_SEPARATOR_UNIX      "/"
 702 #define STRING_PATH_SEPARATOR_DOS       "\\"
 703
 704 #define STRING_NEWLINE_UNIX             "\n"
 705 #define STRING_NEWLINE_DOS              "\r\n"
 706
 707 #if defined(PLATFORM_WIN32)
 708 #define CHAR_PATH_SEPARATOR     CHAR_PATH_SEPARATOR_DOS
 709 #define STRING_PATH_SEPARATOR   STRING_PATH_SEPARATOR_DOS
 710 #define STRING_NEWLINE          STRING_NEWLINE_DOS
 711 #else
 712 #define CHAR_PATH_SEPARATOR     CHAR_PATH_SEPARATOR_UNIX
 713 #define STRING_PATH_SEPARATOR   STRING_PATH_SEPARATOR_UNIX
 714 #define STRING_NEWLINE          STRING_NEWLINE_UNIX
 715 #endif
 716
 717
 718 // areas in bitmap PIX_DOOR
 719 // meaning in PIX_DB_DOOR: (3 PAGEs)
 720 // PAGEX1: 1. buffer for DOOR_1
 721 // PAGEX2: 2. buffer for DOOR_1
 722 // PAGEX3: buffer for animations
 723
 724 // these values are hard-coded to be able to use them in initialization
 725 #define DOOR_GFX_PAGE_WIDTH     100     // should be set to "gfx.dxsize"
 726 #define DOOR_GFX_PAGE_HEIGHT    280     // should be set to "gfx.dysize"
 727
 728 #define DOOR_GFX_PAGESIZE       (DOOR_GFX_PAGE_WIDTH)
 729 #define DOOR_GFX_PAGEX1         (0 * DOOR_GFX_PAGESIZE)
 730 #define DOOR_GFX_PAGEX2         (1 * DOOR_GFX_PAGESIZE)
 731 #define DOOR_GFX_PAGEX3         (2 * DOOR_GFX_PAGESIZE)
 732 #define DOOR_GFX_PAGEX4         (3 * DOOR_GFX_PAGESIZE)
 733 #define DOOR_GFX_PAGEX5         (4 * DOOR_GFX_PAGESIZE)
 734 #define DOOR_GFX_PAGEX6         (5 * DOOR_GFX_PAGESIZE)
 735 #define DOOR_GFX_PAGEX7         (6 * DOOR_GFX_PAGESIZE)
 736 #define DOOR_GFX_PAGEX8         (7 * DOOR_GFX_PAGESIZE)
 737 #define DOOR_GFX_PAGEY1         (0)
 738 #define DOOR_GFX_PAGEY2         (DOOR_GFX_PAGE_HEIGHT)
 739
 740
 741 // macros for version handling
 742 #define VERSION_PART_1(x)       ((x) / 1000000)
 743 #define VERSION_PART_2(x)       (((x) % 1000000) / 10000)
 744 #define VERSION_PART_3(x)       (((x) % 10000) / 100)
 745 #define VERSION_PART_4(x)       ((x) % 100)
 746
 747 #define VERSION_SUPER(x)        VERSION_PART_1(x)
 748 #define VERSION_MAJOR(x)        VERSION_PART_2(x)
 749 #define VERSION_MINOR(x)        VERSION_PART_3(x)
 750 #define VERSION_PATCH(x)        VERSION_PART_4(x)
 751 #define VERSION_IDENT(a,b,c,d)  ((a) * 1000000 + (b) * 10000 + (c) * 100 + (d))
 752
 753
 754 // macros for parent/child process identification
 755 #if defined(PLATFORM_UNIX)
 756 #define IS_PARENT_PROCESS()     (audio.mixer_pid != getpid())
 757 #define IS_CHILD_PROCESS()      (audio.mixer_pid == getpid())
 758 #define HAS_CHILD_PROCESS()     (audio.mixer_pid > 0)
 759 #else
 760 #define IS_PARENT_PROCESS()     TRUE
 761 #define IS_CHILD_PROCESS()      FALSE
 762 #define HAS_CHILD_PROCESS()     FALSE
 763 #endif
 764
 765
 766 // values for artwork type
 767 #define ARTWORK_TYPE_GRAPHICS   0
 768 #define ARTWORK_TYPE_SOUNDS     1
 769 #define ARTWORK_TYPE_MUSIC      2
 770
 771 #define NUM_ARTWORK_TYPES       3
 772
 773
 774 // values for tree type (chosen to match artwork type)
 775 #define TREE_TYPE_UNDEFINED     -1
 776 #define TREE_TYPE_GRAPHICS_DIR  ARTWORK_TYPE_GRAPHICS
 777 #define TREE_TYPE_SOUNDS_DIR    ARTWORK_TYPE_SOUNDS
 778 #define TREE_TYPE_MUSIC_DIR     ARTWORK_TYPE_MUSIC
 779 #define TREE_TYPE_LEVEL_DIR     3
 780 #define TREE_TYPE_LEVEL_NR      4
 781 #define TREE_TYPE_PLAYER_NAME   5
 782
 783 #define NUM_BASE_TREE_TYPES     4
 784 #define NUM_TREE_TYPES          6
 785
 786 #define TREE_TYPE_IS_DIR(type)  ((type) == TREE_TYPE_GRAPHICS_DIR ||    \
 787                                  (type) == TREE_TYPE_SOUNDS_DIR ||      \
 788                                  (type) == TREE_TYPE_MUSIC_DIR ||       \
 789                                  (type) == TREE_TYPE_LEVEL_DIR)
 790
 791 #define INFOTEXT_UNDEFINED      ""
 792 #define INFOTEXT_GRAPHICS_DIR   "Custom Graphics"
 793 #define INFOTEXT_SOUNDS_DIR     "Custom Sounds"
 794 #define INFOTEXT_MUSIC_DIR      "Custom Music"
 795 #define INFOTEXT_LEVEL_DIR      "Level Sets"
 796 #define INFOTEXT_LEVEL_NR       "Levels"
 797 #define INFOTEXT_PLAYER_NAME    "Players & Teams"
 798
 799 #define BACKLINK_TEXT_MAIN      ".. (main menu)"
 800 #define BACKLINK_TEXT_SETUP     ".. (setup menu)"
 801 #define BACKLINK_TEXT_PARENT    ".. (parent directory)"
 802
 803 #define TREE_INFOTEXT(t)        ((t) == TREE_TYPE_PLAYER_NAME ?         \
 804                                  INFOTEXT_PLAYER_NAME :                 \
 805                                  (t) == TREE_TYPE_LEVEL_NR ?            \
 806                                  INFOTEXT_LEVEL_NR :                    \
 807                                  (t) == TREE_TYPE_LEVEL_DIR ?           \
 808                                  INFOTEXT_LEVEL_DIR :                   \
 809                                  (t) == TREE_TYPE_GRAPHICS_DIR ?        \
 810                                  INFOTEXT_GRAPHICS_DIR :                \
 811                                  (t) == TREE_TYPE_SOUNDS_DIR ?          \
 812                                  INFOTEXT_SOUNDS_DIR :                  \
 813                                  (t) == TREE_TYPE_MUSIC_DIR ?           \
 814                                  INFOTEXT_MUSIC_DIR :                   \
 815                                  INFOTEXT_UNDEFINED)
 816
 817 #define TREE_BACKLINK_TEXT(t)   ((t) == TREE_TYPE_LEVEL_DIR ?           \
 818                                  BACKLINK_TEXT_MAIN :                   \
 819                                  BACKLINK_TEXT_SETUP)
 820
 821 #define TREE_USERDIR(t)         ((t) == TREE_TYPE_LEVEL_DIR ?           \
 822                                  getUserLevelDir(NULL) :                \
 823                                  (t) == TREE_TYPE_GRAPHICS_DIR ?        \
 824                                  getUserGraphicsDir() :                 \
 825                                  (t) == TREE_TYPE_SOUNDS_DIR ?          \
 826                                  getUserSoundsDir() :                   \
 827                                  (t) == TREE_TYPE_MUSIC_DIR ?           \
 828                                  getUserMusicDir() :                    \
 829                                  NULL)
 830
 831 #define TREE_FIRST_NODE_PTR(t)  ((t) == TREE_TYPE_LEVEL_DIR ?           \
 832                                  &leveldir_first :                      \
 833                                  (t) == TREE_TYPE_GRAPHICS_DIR ?        \
 834                                  &artwork.gfx_first :                   \
 835                                  (t) == TREE_TYPE_SOUNDS_DIR ?          \
 836                                  &artwork.snd_first :                   \
 837                                  (t) == TREE_TYPE_MUSIC_DIR ?           \
 838                                  &artwork.mus_first :                   \
 839                                  NULL)
 840
 841 #define TREE_FIRST_NODE(t)      ((t) == TREE_TYPE_LEVEL_DIR ?           \
 842                                  leveldir_first :                       \
 843                                  (t) == TREE_TYPE_GRAPHICS_DIR ?        \
 844                                  artwork.gfx_first :                    \
 845                                  (t) == TREE_TYPE_SOUNDS_DIR ?          \
 846                                  artwork.snd_first :                    \
 847                                  (t) == TREE_TYPE_MUSIC_DIR ?           \
 848                                  artwork.mus_first :                    \
 849                                  NULL)
 850
 851 // values for artwork handling
 852 #define LEVELDIR_ARTWORK_SET_PTR(leveldir, type)                        \
 853                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
 854                                  &(leveldir)->graphics_set :            \
 855                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
 856                                  &(leveldir)->sounds_set :              \
 857                                  &(leveldir)->music_set)
 858
 859 #define LEVELDIR_ARTWORK_SET(leveldir, type)                            \
 860                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
 861                                  (leveldir)->graphics_set :             \
 862                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
 863                                  (leveldir)->sounds_set :               \
 864                                  (leveldir)->music_set)
 865
 866 #define LEVELDIR_ARTWORK_PATH_PTR(leveldir, type)                       \
 867                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
 868                                  &(leveldir)->graphics_path :           \
 869                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
 870                                  &(leveldir)->sounds_path :             \
 871                                  &(leveldir)->music_path)
 872
 873 #define LEVELDIR_ARTWORK_PATH(leveldir, type)                           \
 874                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
 875                                  (leveldir)->graphics_path :            \
 876                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
 877                                  (leveldir)->sounds_path :              \
 878                                  (leveldir)->music_path)
 879
 880 #define SETUP_ARTWORK_SET(setup, type)                                  \
 881                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
 882                                  (setup).graphics_set :                 \
 883                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
 884                                  (setup).sounds_set :                   \
 885                                  (setup).music_set)
 886
 887 #define SETUP_OVERRIDE_ARTWORK(setup, type)                             \
 888                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
 889                                  (setup).override_level_graphics :      \
 890                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
 891                                  (setup).override_level_sounds :        \
 892                                  (setup).override_level_music)
 893
 894 #define GFX_OVERRIDE_ARTWORK(type)                                      \
 895                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
 896                                  gfx.override_level_graphics :          \
 897                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
 898                                  gfx.override_level_sounds :            \
 899                                  gfx.override_level_music)
 900
 901 #define ARTWORK_FIRST_NODE(artwork, type)                               \
 902                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
 903                                  (artwork).gfx_first :                  \
 904                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
 905                                  (artwork).snd_first :                  \
 906                                  (artwork).mus_first)
 907
 908 #define ARTWORK_CURRENT_PTR(artwork, type)                              \
 909                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
 910                                  &(artwork).gfx_current :               \
 911                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
 912                                  &(artwork).snd_current :               \
 913                                  &(artwork).mus_current)
 914
 915 #define ARTWORK_CURRENT(artwork, type)                                  \
 916                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
 917                                  (artwork).gfx_current :                \
 918                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
 919                                  (artwork).snd_current :                \
 920                                  (artwork).mus_current)
 921
 922 #define ARTWORK_CURRENT_IDENTIFIER_PTR(artwork, type)                   \
 923                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
 924                                  &(artwork).gfx_current_identifier :    \
 925                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
 926                                  &(artwork).snd_current_identifier :    \
 927                                  &(artwork).mus_current_identifier)
 928
 929 #define ARTWORK_CURRENT_IDENTIFIER(artwork, type)                       \
 930                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
 931                                  (artwork).gfx_current_identifier :     \
 932                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
 933                                  (artwork).snd_current_identifier :     \
 934                                  (artwork).mus_current_identifier)
 935
 936 #define ARTWORKINFO_FILENAME(type)                                      \
 937                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
 938                                  GRAPHICSINFO_FILENAME :                \
 939                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
 940                                  SOUNDSINFO_FILENAME :                  \
 941                                  (type) == ARTWORK_TYPE_MUSIC ?         \
 942                                  MUSICINFO_FILENAME : "")
 943
 944 #define ARTWORK_DIRECTORY(type)                                         \
 945                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
 946                                  GRAPHICS_DIRECTORY :                   \
 947                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
 948                                  SOUNDS_DIRECTORY :                     \
 949                                  (type) == ARTWORK_TYPE_MUSIC ?         \
 950                                  MUSIC_DIRECTORY : "")
 951
 952 #define OPTIONS_ARTWORK_DIRECTORY(type)                                 \
 953                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
 954                                  options.graphics_directory :           \
 955                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
 956                                  options.sounds_directory :             \
 957                                  (type) == ARTWORK_TYPE_MUSIC ?         \
 958                                  options.music_directory : "")
 959
 960 #define USER_ARTWORK_DIRECTORY(type)                                    \
 961                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
 962                                  getUserGraphicsDir() :                 \
 963                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
 964                                  getUserSoundsDir() :                   \
 965                                  (type) == ARTWORK_TYPE_MUSIC ?         \
 966                                  getUserMusicDir() : "")
 967
 968 #define ARTWORK_DEFAULT_SUBDIR(type)                                    \
 969                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
 970                                  GFX_DEFAULT_SUBDIR :                   \
 971                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
 972                                  SND_DEFAULT_SUBDIR :                   \
 973                                  MUS_DEFAULT_SUBDIR)
 974
 975 #define UPDATE_BUSY_STATE()                     \
 976 {                                               \
 977   if (gfx.draw_busy_anim_function != NULL)      \
 978     gfx.draw_busy_anim_function();              \
 979 }
 980
 981
 982 // structure definitions
 983
 984 struct ProgramInfo
 985 {
 986   char *command_basepath;       // path to the program binary
 987   char *command_basename;       // base filename of the program binary
 988
 989   char *config_filename;        // optional global program config filename
 990
 991   char *maindata_path;          // main game data (installation) directory
 992
 993   char *userdata_subdir;        // personal user game data directory
 994   char *userdata_path;          // resulting full path to game data directory
 995
 996   char *program_title;
 997   char *window_title;
 998   char *icon_title;
 999
1000   char *icon_filename;
1001
1002   char *cookie_prefix;
1003
1004   char *log_filename[NUM_LOGS];         // log filenames for out/err messages
1005   FILE *log_file[NUM_LOGS];             // log file handles for out/err files
1006   FILE *log_file_default[NUM_LOGS];     // default log file handles (out/err)
1007
1008   int version_super;
1009   int version_major;
1010   int version_minor;
1011   int version_patch;
1012   int version_ident;
1013
1014   char *version_string;
1015
1016   char *(*window_title_function)(void);
1017   void (*exit_message_function)(char *, va_list);
1018   void (*exit_function)(int);
1019
1020   boolean global_scores;
1021   boolean many_scores_per_name;
1022
1023   boolean headless;
1024 };
1025
1026 struct NetworkInfo
1027 {
1028   boolean enabled;
1029   boolean connected;
1030   boolean serveronly;
1031
1032   char *server_host;
1033   int server_port;
1034
1035   SDL_Thread *server_thread;
1036   boolean is_server_thread;
1037 };
1038
1039 struct RuntimeInfo
1040 {
1041   boolean uses_touch_device;
1042 };
1043
1044 struct OptionInfo
1045 {
1046   char *server_host;
1047   int server_port;
1048
1049   char *ro_base_directory;
1050   char *rw_base_directory;
1051   char *level_directory;
1052   char *graphics_directory;
1053   char *sounds_directory;
1054   char *music_directory;
1055   char *docs_directory;
1056   char *conf_directory;
1057
1058   char *execute_command;
1059
1060   char *special_flags;
1061   char *debug_mode;
1062
1063   boolean mytapes;
1064   boolean serveronly;
1065   boolean network;
1066   boolean verbose;
1067   boolean debug;
1068 };
1069
1070 struct VideoSystemInfo
1071 {
1072   int default_depth;
1073   int width, height, depth;
1074   int window_width, window_height;
1075   int display_width, display_height;
1076   int screen_width, screen_height;
1077   int screen_xoffset, screen_yoffset;
1078
1079   boolean fullscreen_available;
1080   boolean fullscreen_enabled;
1081   boolean fullscreen_initial;
1082
1083   boolean window_scaling_available;
1084   int window_scaling_percent;
1085   char *window_scaling_quality;
1086   int screen_rendering_mode;
1087   int vsync_mode;
1088
1089   unsigned int frame_counter;
1090   unsigned int frame_delay;
1091   unsigned int frame_delay_value;
1092
1093   boolean shifted_up;
1094   int shifted_up_pos;
1095   int shifted_up_pos_last;
1096   unsigned int shifted_up_delay;
1097   unsigned int shifted_up_delay_value;
1098
1099   boolean initialized;
1100 };
1101
1102 struct AudioSystemInfo
1103 {
1104   boolean sound_available;
1105   boolean loops_available;
1106   boolean music_available;
1107
1108   boolean sound_enabled;
1109   boolean sound_deactivated;    // for temporarily disabling sound
1110
1111   int mixer_pipe[2];
1112   int mixer_pid;
1113   char *device_name;
1114   int device_fd;
1115
1116   int num_channels;
1117   int music_channel;
1118   int first_sound_channel;
1119 };
1120
1121 struct FontBitmapInfo
1122 {
1123   Bitmap *bitmap;
1124
1125   int src_x, src_y;             // start position of font characters
1126   int width, height;            // width / height of font characters
1127
1128   int offset_x;                 // offset to next font character
1129   int offset_y;                 // offset to next font character
1130
1131   int draw_xoffset;             // offset for drawing font characters
1132   int draw_yoffset;             // offset for drawing font characters
1133
1134   int num_chars;
1135   int num_chars_per_line;
1136 };
1137
1138 struct GfxInfo
1139 {
1140   int sx, sy;
1141   int sxsize, sysize;
1142   int real_sx, real_sy;
1143   int full_sxsize, full_sysize;
1144   int scrollbuffer_width, scrollbuffer_height;
1145
1146   int game_tile_size, standard_tile_size;
1147
1148   int dx, dy;
1149   int dxsize, dysize;
1150
1151   int vx, vy;
1152   int vxsize, vysize;
1153
1154   int ex, ey;
1155   int exsize, eysize;
1156
1157   int win_xsize, win_ysize;
1158
1159   int draw_deactivation_mask;
1160   int draw_background_mask;
1161
1162   Bitmap *field_save_buffer;
1163
1164   Bitmap *background_bitmap;
1165   int background_bitmap_mask;
1166
1167   Bitmap *fade_bitmap_backup;
1168   Bitmap *fade_bitmap_source;
1169   Bitmap *fade_bitmap_target;
1170   Bitmap *fade_bitmap_black;
1171
1172   int fade_border_source_status;
1173   int fade_border_target_status;
1174   Bitmap *masked_border_bitmap_ptr;
1175
1176   Bitmap *final_screen_bitmap;
1177
1178   boolean clipping_enabled;
1179   int clip_x, clip_y;
1180   int clip_width, clip_height;
1181
1182   boolean override_level_graphics;
1183   boolean override_level_sounds;
1184   boolean override_level_music;
1185
1186   boolean draw_init_text;
1187
1188   int num_fonts;
1189   struct FontBitmapInfo *font_bitmap_info;
1190   int (*select_font_function)(int);
1191   int (*get_font_from_token_function)(char *);
1192
1193   int anim_random_frame;
1194
1195   void (*draw_busy_anim_function)(void);
1196   void (*draw_global_anim_function)(int, int);
1197   void (*draw_global_border_function)(int);
1198   void (*draw_tile_cursor_function)(int);
1199
1200   int cursor_mode;
1201   int cursor_mode_override;
1202   int cursor_mode_final;
1203   int mouse_x, mouse_y;
1204 };
1205
1206 struct TileCursorInfo
1207 {
1208   boolean enabled;              // tile cursor generally enabled or disabled
1209   boolean active;               // tile cursor activated (depending on game)
1210   boolean moving;               // tile cursor moving to target position
1211
1212   int xpos, ypos;               // tile cursor level playfield position
1213   int x, y;                     // tile cursor current screen position
1214   int target_x, target_y;       // tile cursor target screen position
1215
1216   int sx, sy;                   // tile cursor screen start position
1217
1218   boolean xsn_debug;            // enable or disable XSN debugging
1219 };
1220
1221 struct OverlayInfo
1222 {
1223   boolean enabled;              // overlay generally enabled or disabled
1224   boolean active;               // overlay activated (depending on game mode)
1225
1226   boolean show_grid;
1227
1228   int grid_xsize;
1229   int grid_ysize;
1230
1231   char grid_button[MAX_GRID_XSIZE][MAX_GRID_YSIZE];
1232   char grid_button_highlight;
1233
1234   int grid_button_action;
1235 };
1236
1237 struct JoystickInfo
1238 {
1239   int status;
1240   int nr[MAX_PLAYERS];          // joystick number for each player
1241 };
1242
1243 struct SetupJoystickInfo
1244 {
1245   char *device_name;            // device name of player's joystick
1246
1247   int xleft, xmiddle, xright;
1248   int yupper, ymiddle, ylower;
1249   int snap, drop;
1250 };
1251
1252 struct SetupKeyboardInfo
1253 {
1254   Key left, right, up, down;
1255   Key snap, drop;
1256 };
1257
1258 struct SetupTouchInfo
1259 {
1260   char *control_type;
1261   int move_distance;
1262   int drop_distance;
1263
1264   int grid_xsize[2];
1265   int grid_ysize[2];
1266
1267   char grid_button[2][MAX_GRID_XSIZE][MAX_GRID_YSIZE];
1268
1269   int transparency;             // in percent (0 == opaque, 100 == invisible)
1270   boolean draw_outlined;
1271   boolean draw_pressed;
1272
1273   boolean grid_initialized;
1274 };
1275
1276 struct SetupInputInfo
1277 {
1278   boolean use_joystick;
1279   struct SetupJoystickInfo joy;
1280   struct SetupKeyboardInfo key;
1281 };
1282
1283 struct SetupEditorInfo
1284 {
1285   boolean el_boulderdash;
1286   boolean el_emerald_mine;
1287   boolean el_emerald_mine_club;
1288   boolean el_more;
1289   boolean el_sokoban;
1290   boolean el_supaplex;
1291   boolean el_diamond_caves;
1292   boolean el_dx_boulderdash;
1293
1294   boolean el_mirror_magic;
1295   boolean el_deflektor;
1296
1297   boolean el_chars;
1298   boolean el_steel_chars;
1299
1300   boolean el_classic;
1301   boolean el_custom;
1302   boolean el_user_defined;
1303   boolean el_dynamic;
1304
1305   boolean el_headlines;
1306
1307   boolean el_by_game;
1308   boolean el_by_type;
1309
1310   boolean show_element_token;
1311
1312   boolean show_read_only_warning;
1313
1314   boolean use_template_for_new_levels;
1315 };
1316
1317 struct SetupAutoSetupInfo
1318 {
1319   int editor_zoom_tilesize;
1320 };
1321
1322 struct SetupLevelSetupInfo
1323 {
1324   char *last_level_series[MAX_LEVELDIR_HISTORY + 1];
1325 };
1326
1327 struct SetupEditorCascadeInfo
1328 {
1329   boolean el_bd;
1330   boolean el_em;
1331   boolean el_emc;
1332   boolean el_rnd;
1333   boolean el_sb;
1334   boolean el_sp;
1335   boolean el_dc;
1336   boolean el_dx;
1337   boolean el_mm;
1338   boolean el_df;
1339   boolean el_chars;
1340   boolean el_steel_chars;
1341   boolean el_ce;
1342   boolean el_ge;
1343   boolean el_ref;
1344   boolean el_user;
1345   boolean el_dynamic;
1346 };
1347
1348 struct SetupShortcutInfo
1349 {
1350   Key save_game;
1351   Key load_game;
1352   Key toggle_pause;
1353
1354   Key focus_player[MAX_PLAYERS];
1355   Key focus_player_all;
1356
1357   Key tape_eject;
1358   Key tape_extra;
1359   Key tape_stop;
1360   Key tape_pause;
1361   Key tape_record;
1362   Key tape_play;
1363
1364   Key sound_simple;
1365   Key sound_loops;
1366   Key sound_music;
1367
1368   Key snap_left;
1369   Key snap_right;
1370   Key snap_up;
1371   Key snap_down;
1372 };
1373
1374 struct SetupSystemInfo
1375 {
1376   char *sdl_renderdriver;
1377   char *sdl_videodriver;
1378   char *sdl_audiodriver;
1379   int audio_fragment_size;
1380 };
1381
1382 struct SetupInternalInfo
1383 {
1384   char *program_title;
1385   char *program_version;
1386   char *program_author;
1387   char *program_email;
1388   char *program_website;
1389   char *program_copyright;
1390   char *program_company;
1391
1392   char *program_icon_file;
1393
1394   char *default_graphics_set;
1395   char *default_sounds_set;
1396   char *default_music_set;
1397
1398   char *fallback_graphics_file;
1399   char *fallback_sounds_file;
1400   char *fallback_music_file;
1401
1402   char *default_level_series;
1403
1404   int default_window_width;
1405   int default_window_height;
1406
1407   boolean choose_from_top_leveldir;
1408   boolean show_scaling_in_title;
1409   boolean create_user_levelset;
1410
1411   boolean menu_game;
1412   boolean menu_engines;
1413   boolean menu_editor;
1414   boolean menu_graphics;
1415   boolean menu_sound;
1416   boolean menu_artwork;
1417   boolean menu_input;
1418   boolean menu_touch;
1419   boolean menu_shortcuts;
1420   boolean menu_exit;
1421   boolean menu_save_and_exit;
1422 };
1423
1424 struct SetupDebugInfo
1425 {
1426   int frame_delay[10];
1427   Key frame_delay_key[10];
1428   boolean frame_delay_use_mod_key;
1429   boolean frame_delay_game_only;
1430   boolean show_frames_per_second;
1431   int xsn_mode;
1432   int xsn_percent;
1433 };
1434
1435 struct SetupInfo
1436 {
1437   char *player_name;
1438
1439   boolean multiple_users;
1440
1441   boolean sound;
1442   boolean sound_loops;
1443   boolean sound_music;
1444   boolean sound_simple;
1445   boolean toons;
1446   boolean scroll_delay;
1447   boolean forced_scroll_delay;
1448   int scroll_delay_value;
1449   char *engine_snapshot_mode;
1450   int engine_snapshot_memory;
1451   boolean fade_screens;
1452   boolean autorecord;
1453   boolean show_titlescreen;
1454   boolean quick_doors;
1455   boolean team_mode;
1456   boolean handicap;
1457   boolean skip_levels;
1458   boolean increment_levels;
1459   boolean auto_play_next_level;
1460   boolean count_score_after_game;
1461   boolean show_scores_after_game;
1462   boolean time_limit;
1463   boolean fullscreen;
1464   int window_scaling_percent;
1465   char *window_scaling_quality;
1466   char *screen_rendering_mode;
1467   char *vsync_mode;
1468   boolean ask_on_escape;
1469   boolean ask_on_escape_editor;
1470   boolean ask_on_game_over;
1471   boolean ask_on_quit_game;
1472   boolean ask_on_quit_program;
1473   boolean quick_switch;
1474   boolean input_on_focus;
1475   boolean prefer_aga_graphics;
1476   boolean prefer_lowpass_sounds;
1477   boolean prefer_extra_panel_items;
1478   boolean game_speed_extended;
1479   int game_frame_delay;
1480   boolean sp_show_border_elements;
1481   boolean small_game_graphics;
1482   boolean show_snapshot_buttons;
1483
1484   char *graphics_set;
1485   char *sounds_set;
1486   char *music_set;
1487   int override_level_graphics;          // not boolean -- can also be "AUTO"
1488   int override_level_sounds;            // not boolean -- can also be "AUTO"
1489   int override_level_music;             // not boolean -- can also be "AUTO"
1490
1491   int volume_simple;
1492   int volume_loops;
1493   int volume_music;
1494
1495   boolean network_mode;
1496   int network_player_nr;
1497   char *network_server_hostname;
1498
1499   struct SetupAutoSetupInfo auto_setup;
1500   struct SetupLevelSetupInfo level_setup;
1501
1502   struct SetupEditorInfo editor;
1503   struct SetupEditorCascadeInfo editor_cascade;
1504   struct SetupShortcutInfo shortcut;
1505   struct SetupInputInfo input[MAX_PLAYERS];
1506   struct SetupTouchInfo touch;
1507   struct SetupSystemInfo system;
1508   struct SetupInternalInfo internal;
1509   struct SetupDebugInfo debug;
1510
1511   struct OptionInfo options;
1512 };
1513
1514 struct UserInfo
1515 {
1516   int nr;
1517 };
1518
1519 struct TreeInfo
1520 {
1521   struct TreeInfo **node_top;           // topmost node in tree
1522   struct TreeInfo *node_parent;         // parent level directory info
1523   struct TreeInfo *node_group;          // level group sub-directory info
1524   struct TreeInfo *next;                // next level series structure node
1525
1526   int cl_first;         // internal control field for setup screen
1527   int cl_cursor;        // internal control field for setup screen
1528
1529   int type;             // type of tree content
1530
1531   // fields for "type == TREE_TYPE_LEVEL_DIR"
1532
1533   char *subdir;         // tree info sub-directory basename (may be ".")
1534   char *fullpath;       // complete path relative to tree base directory
1535   char *basepath;       // absolute base path of tree base directory
1536   char *identifier;     // identifier string for configuration files
1537   char *name;           // tree info name, as displayed in selection menues
1538   char *name_sorting;   // optional sorting name for correct name sorting
1539   char *author;         // level or artwork author name
1540   char *year;           // optional year of creation for levels or artwork
1541
1542   char *program_title;     // optional alternative text for program title
1543   char *program_copyright; // optional alternative text for program copyright
1544   char *program_company;   // optional alternative text for program company
1545
1546   char *imported_from;  // optional comment for imported levels or artwork
1547   char *imported_by;    // optional comment for imported levels or artwork
1548   char *tested_by;      // optional comment to name people who tested a set
1549
1550   char *graphics_set_ecs; // special EMC custom graphics set (ECS graphics)
1551   char *graphics_set_aga; // special EMC custom graphics set (AGA graphics)
1552   char *graphics_set;   // optional custom graphics set (level tree only)
1553   char *sounds_set_default; // default EMC custom sounds set
1554   char *sounds_set_lowpass; // special EMC custom sounds set (lowpass filter)
1555   char *sounds_set;     // optional custom sounds set (level tree only)
1556   char *music_set;      // optional custom music set (level tree only)
1557   char *graphics_path;  // path to optional custom graphics set (level only)
1558   char *sounds_path;    // path to optional custom sounds set (level only)
1559   char *music_path;     // path to optional custom music set (level only)
1560
1561   char *level_filename; // filename of level file (for packed level file)
1562   char *level_filetype; // type of levels in level directory or level file
1563
1564   char *special_flags;  // flags for special actions performed on level file
1565
1566   int levels;           // number of levels in level series
1567   int first_level;      // first level number (to allow start with 0 or 1)
1568   int last_level;       // last level number (automatically calculated)
1569   int sort_priority;    // sort levels by 'sort_priority' and then by name
1570
1571   boolean latest_engine;// force level set to use the latest game engine
1572
1573   boolean level_group;  // directory contains more level series directories
1574   boolean parent_link;  // entry links back to parent directory
1575   boolean is_copy;      // this entry is a copy of another entry in the tree
1576   boolean in_user_dir;  // user defined levels are stored in home directory
1577   boolean user_defined; // levels in user directory and marked as "private"
1578   boolean readonly;     // readonly levels can not be changed with editor
1579   boolean handicap;     // level set has no handicap when set to "false"
1580   boolean skip_levels;  // levels can be skipped when set to "true"
1581
1582   boolean use_emc_tiles;// use (swapped) V5/V6 EMC tiles when set to "true"
1583
1584   int color;            // color to use on selection screen for this level
1585   char *class_desc;     // description of level series class
1586   int handicap_level;   // number of the lowest unsolved level
1587
1588   char *infotext;       // optional text to describe the tree type (headline)
1589 };
1590
1591 typedef struct TreeInfo TreeInfo;
1592 typedef struct TreeInfo LevelDirTree;
1593 typedef struct TreeInfo ArtworkDirTree;
1594 typedef struct TreeInfo GraphicsDirTree;
1595 typedef struct TreeInfo SoundsDirTree;
1596 typedef struct TreeInfo MusicDirTree;
1597
1598 struct ArtworkInfo
1599 {
1600   GraphicsDirTree *gfx_first;
1601   GraphicsDirTree *gfx_current;
1602   SoundsDirTree *snd_first;
1603   SoundsDirTree *snd_current;
1604   MusicDirTree *mus_first;
1605   MusicDirTree *mus_current;
1606
1607   char *gfx_current_identifier;
1608   char *snd_current_identifier;
1609   char *mus_current_identifier;
1610 };
1611
1612 struct ValueTextInfo
1613 {
1614   int value;
1615   char *text;
1616 };
1617
1618 struct StringValueTextInfo
1619 {
1620   char *value;
1621   char *text;
1622 };
1623
1624 struct ConfigInfo
1625 {
1626   char *token;
1627   char *value;
1628 };
1629
1630 struct ConfigTypeInfo
1631 {
1632   char *token;
1633   char *value;
1634   int type;
1635 };
1636
1637 struct TokenIntPtrInfo
1638 {
1639   char *token;
1640   int *value;
1641 };
1642
1643 struct FileInfo
1644 {
1645   char *token;
1646
1647   char *default_filename;
1648   char *filename;
1649
1650   char **default_parameter;                     // array of file parameters
1651   char **parameter;                             // array of file parameters
1652
1653   boolean redefined;
1654   boolean fallback_to_default;
1655   boolean default_is_cloned;
1656 };
1657
1658 struct SetupFileList
1659 {
1660   char *token;
1661   char *value;
1662
1663   struct SetupFileList *next;
1664 };
1665
1666 struct ListNodeInfo
1667 {
1668   char *source_filename;                        // primary key for node list
1669   int num_references;
1670 };
1671
1672 struct PropertyMapping
1673 {
1674   int base_index;
1675   int ext1_index;
1676   int ext2_index;
1677   int ext3_index;
1678
1679   int artwork_index;
1680 };
1681
1682 struct ArtworkListInfo
1683 {
1684   int type;                                     // type of artwork
1685
1686   int num_file_list_entries;
1687   int num_dynamic_file_list_entries;
1688   struct FileInfo *file_list;                   // static artwork file array
1689   struct FileInfo *dynamic_file_list;           // dynamic artwrk file array
1690
1691   int num_suffix_list_entries;
1692   struct ConfigTypeInfo *suffix_list;           // parameter suffixes array
1693
1694   int num_base_prefixes;
1695   int num_ext1_suffixes;
1696   int num_ext2_suffixes;
1697   int num_ext3_suffixes;
1698   char **base_prefixes;                         // base token prefixes array
1699   char **ext1_suffixes;                         // property suffixes array 1
1700   char **ext2_suffixes;                         // property suffixes array 2
1701   char **ext3_suffixes;                         // property suffixes array 3
1702
1703   int num_ignore_tokens;
1704   char **ignore_tokens;                         // file tokens to be ignored
1705
1706   int num_property_mapping_entries;
1707   struct PropertyMapping *property_mapping;     // mapping token -> artwork
1708
1709   int sizeof_artwork_list_entry;
1710
1711   struct ListNodeInfo **artwork_list;           // static artwork node array
1712   struct ListNodeInfo **dynamic_artwork_list;   // dynamic artwrk node array
1713   struct ListNode *content_list;                // dynamic artwork node list
1714
1715   void *(*load_artwork)(char *);                // constructor function
1716   void (*free_artwork)(void *);                 // destructor function
1717 };
1718
1719 struct XY
1720 {
1721   int x, y;
1722 };
1723
1724 struct XYTileSize
1725 {
1726   int x, y;
1727   int tile_size;
1728 };
1729
1730 struct Rect
1731 {
1732   int x, y;
1733   int width, height;
1734 };
1735
1736 struct RectWithBorder
1737 {
1738   int x, y;
1739   int width, height;
1740   int min_width, min_height;
1741   int max_width, max_height;
1742   int margin_left;
1743   int margin_right;
1744   int margin_top;
1745   int margin_bottom;
1746   int border_left;
1747   int border_right;
1748   int border_top;
1749   int border_bottom;
1750   int border_size;
1751   int align_size;
1752   int align, valign;
1753 };
1754
1755 struct MenuPosInfo
1756 {
1757   int x, y;
1758   int width, height;
1759   int align, valign;
1760 };
1761
1762 struct DoorPartPosInfo
1763 {
1764   int x, y;
1765   int step_xoffset;
1766   int step_yoffset;
1767   int step_delay;
1768   int start_step;
1769   int start_step_opening;
1770   int start_step_closing;
1771   boolean draw_masked;
1772   int sort_priority;
1773 };
1774
1775 struct TextPosInfo
1776 {
1777   int x, y;
1778   int xoffset;                  // special case for tape date and time
1779   int xoffset2;                 // special case for tape date
1780   int yoffset;                  // special case for list of preview players
1781   int width, height;
1782   int align, valign;
1783   int size;                     // also used for suffix ".digits"
1784   int font, font_alt;
1785   boolean draw_masked;
1786   boolean draw_player;          // special case for network player buttons
1787   int sort_priority;            // also used for suffix ".draw_order"
1788   int id;
1789
1790   int direction;                // needed for panel time/health graphics
1791   int class;                    // needed for panel time/health graphics
1792   int style;                    // needed for panel time/health graphics
1793
1794   int tile_size;                // special case for list of network players
1795   int border_size;              // special case for list of preview players
1796   int vertical;                 // special case for list of preview players
1797
1798   boolean redefined;            // redefined by custom artwork
1799 };
1800
1801 struct MouseActionInfo
1802 {
1803   int lx, ly;
1804   int button;
1805   int button_hint;
1806 };
1807
1808 struct LevelSetInfo
1809 {
1810   int music[MAX_LEVELS];
1811
1812   char *identifier;
1813   int level_nr;
1814 };
1815
1816 struct LevelStats
1817 {
1818   int played;
1819   int solved;
1820 };
1821
1822
1823 // ============================================================================
1824 // exported variables
1825 // ============================================================================
1826
1827 extern struct ProgramInfo       program;
1828 extern struct NetworkInfo       network;
1829 extern struct RuntimeInfo       runtime;
1830 extern struct OptionInfo        options;
1831 extern struct VideoSystemInfo   video;
1832 extern struct AudioSystemInfo   audio;
1833 extern struct GfxInfo           gfx;
1834 extern struct TileCursorInfo    tile_cursor;
1835 extern struct OverlayInfo       overlay;
1836 extern struct AnimInfo          anim;
1837 extern struct ArtworkInfo       artwork;
1838 extern struct JoystickInfo      joystick;
1839 extern struct SetupInfo         setup;
1840 extern struct UserInfo          user;
1841
1842 extern LevelDirTree            *leveldir_first_all;
1843 extern LevelDirTree            *leveldir_first;
1844 extern LevelDirTree            *leveldir_current;
1845 extern int                      level_nr;
1846
1847 extern struct LevelSetInfo      levelset;
1848 extern struct LevelStats        level_stats[];
1849
1850 extern DrawWindow              *window;
1851 extern DrawBuffer              *backbuffer;
1852 extern DrawBuffer              *drawto;
1853
1854 extern int                      button_status;
1855 extern boolean                  motion_status;
1856 extern int                      wheel_steps;
1857 extern boolean                  keyrepeat_status;
1858 extern boolean                  textinput_status;
1859
1860 extern int                      redraw_mask;
1861
1862 extern int                      FrameCounter;
1863
1864
1865 // function definitions
1866
1867 void InitProgramInfo(char *, char *, char *, char *, char *, char *, char *,
1868                      char *, int);
1869 void InitNetworkInfo(boolean, boolean, boolean, char *, int);
1870 void InitRuntimeInfo(void);
1871
1872 void InitScoresInfo(void);
1873 void SetWindowTitle(void);
1874
1875 void InitWindowTitleFunction(char *(*window_title_function)(void));
1876 void InitExitMessageFunction(void (*exit_message_function)(char *, va_list));
1877 void InitExitFunction(void (*exit_function)(int));
1878 void InitPlatformDependentStuff(void);
1879 void ClosePlatformDependentStuff(void);
1880
1881 void InitGfxFieldInfo(int, int, int, int, int, int, int, int, Bitmap *);
1882 void InitGfxTileSizeInfo(int, int);
1883 void InitGfxDoor1Info(int, int, int, int);
1884 void InitGfxDoor2Info(int, int, int, int);
1885 void InitGfxDoor3Info(int, int, int, int);
1886 void InitGfxWindowInfo(int, int);
1887 void InitGfxScrollbufferInfo(int, int);
1888 void InitGfxClipRegion(boolean, int, int, int, int);
1889 void InitGfxDrawBusyAnimFunction(void (*draw_busy_anim_function)(void));
1890 void InitGfxDrawGlobalAnimFunction(void (*draw_global_anim_function)(int, int));
1891 void InitGfxDrawGlobalBorderFunction(void (*draw_global_border_function)(int));
1892 void InitGfxDrawTileCursorFunction(void (*draw_tile_cursor_function)(int));
1893 void InitGfxCustomArtworkInfo(void);
1894 void InitGfxOtherSettings(void);
1895 void InitTileCursorInfo(void);
1896 void InitOverlayInfo(void);
1897 void SetOverlayGridSizeAndButtons(void);
1898 void SetTileCursorEnabled(boolean);
1899 void SetTileCursorActive(boolean);
1900 void SetTileCursorTargetXY(int, int);
1901 void SetTileCursorXY(int, int);
1902 void SetTileCursorSXSY(int, int);
1903 void SetOverlayEnabled(boolean);
1904 void SetOverlayActive(boolean);
1905 void SetOverlayShowGrid(boolean);
1906 boolean GetOverlayEnabled(void);
1907 boolean GetOverlayActive(void);
1908 void SetDrawDeactivationMask(int);
1909 int GetDrawDeactivationMask(void);
1910 void SetDrawBackgroundMask(int);
1911 void SetWindowBackgroundBitmap(Bitmap *);
1912 void SetMainBackgroundBitmap(Bitmap *);
1913 void SetDoorBackgroundBitmap(Bitmap *);
1914 void SetRedrawMaskFromArea(int, int, int, int);
1915
1916 void LimitScreenUpdates(boolean);
1917
1918 void InitVideoDefaults(void);
1919 void InitVideoDisplay(void);
1920 void CloseVideoDisplay(void);
1921 void InitVideoBuffer(int, int, int, boolean);
1922 Bitmap *CreateBitmapStruct(void);
1923 Bitmap *CreateBitmap(int, int, int);
1924 void ReCreateBitmap(Bitmap **, int, int);
1925 void FreeBitmap(Bitmap *);
1926 void BlitBitmap(Bitmap *, Bitmap *, int, int, int, int, int, int);
1927 void BlitBitmapTiled(Bitmap *, Bitmap *, int, int, int, int, int, int, int,int);
1928 void FadeRectangle(int, int, int, int, int, int, int,
1929                    void (*draw_border_function)(void));
1930 void FillRectangle(Bitmap *, int, int, int, int, Pixel);
1931 void ClearRectangle(Bitmap *, int, int, int, int);
1932 void ClearRectangleOnBackground(Bitmap *, int, int, int, int);
1933 void BlitBitmapMasked(Bitmap *, Bitmap *, int, int, int, int, int, int);
1934 boolean DrawingDeactivatedField(void);
1935 boolean DrawingDeactivated(int, int, int, int);
1936 boolean DrawingOnBackground(int, int);
1937 boolean DrawingAreaChanged(void);
1938 void BlitBitmapOnBackground(Bitmap *, Bitmap *, int, int, int, int, int, int);
1939 void BlitTexture(Bitmap *, int, int, int, int, int, int);
1940 void BlitTextureMasked(Bitmap *, int, int, int, int, int, int);
1941 void BlitToScreen(Bitmap *, int, int, int, int, int, int);
1942 void BlitToScreenMasked(Bitmap *, int, int, int, int, int, int);
1943 void DrawSimpleBlackLine(Bitmap *, int, int, int, int);
1944 void DrawSimpleWhiteLine(Bitmap *, int, int, int, int);
1945 void DrawLines(Bitmap *, struct XY *, int, Pixel);
1946 Pixel GetPixel(Bitmap *, int, int);
1947 Pixel GetPixelFromRGB(Bitmap *, unsigned int,unsigned int,unsigned int);
1948 Pixel GetPixelFromRGBcompact(Bitmap *, unsigned int);
1949
1950 void KeyboardAutoRepeatOn(void);
1951 void KeyboardAutoRepeatOff(void);
1952 boolean SetVideoMode(boolean);
1953 void SetVideoFrameDelay(unsigned int);
1954 unsigned int GetVideoFrameDelay(void);
1955 boolean ChangeVideoModeIfNeeded(boolean);
1956
1957 Bitmap *LoadImage(char *);
1958 Bitmap *LoadCustomImage(char *);
1959 void ReloadCustomImage(Bitmap *, char *);
1960
1961 void ReCreateGameTileSizeBitmap(Bitmap **);
1962 void CreateBitmapWithSmallBitmaps(Bitmap **, int, int);
1963 void CreateBitmapTextures(Bitmap **);
1964 void FreeBitmapTextures(Bitmap **);
1965 void ScaleBitmap(Bitmap **, int);
1966
1967 void SetMouseCursor(int);
1968 void UpdateRawMousePosition(int, int);
1969 void UpdateMousePosition(void);
1970
1971 void OpenAudio(void);
1972 void CloseAudio(void);
1973 void SetAudioMode(boolean);
1974
1975 void InitEventFilter(EventFilter);
1976 boolean PendingEvent(void);
1977 void WaitEvent(Event *event);
1978 void PeekEvent(Event *event);
1979 void PumpEvents(void);
1980 void CheckQuitEvent(void);
1981 Key GetEventKey(KeyEvent *, boolean);
1982 KeyMod HandleKeyModState(Key, int);
1983 KeyMod GetKeyModState(void);
1984 KeyMod GetKeyModStateFromEvents(void);
1985 void StartTextInput(int, int, int, int);
1986 void StopTextInput(void);
1987 void PushUserEvent(int, int, int);
1988
1989 void InitJoysticks(void);
1990 boolean ReadJoystick(int, int *, int *, boolean *, boolean *);
1991 boolean CheckJoystickOpened(int);
1992 void ClearJoystickState(void);
1993
1994 void InitEmscriptenFilesystem(void);
1995 void SyncEmscriptenFilesystem(void);
1996
1997 #endif // SYSTEM_H