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