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