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