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