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