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