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