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