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