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