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