1 /***********************************************************
2 * Artsoft Retro-Game Library *
3 *----------------------------------------------------------*
4 * (c) 1994-2006 Artsoft Entertainment *
6 * Detmolder Strasse 189 *
9 * e-mail: info@artsoft.org *
10 *----------------------------------------------------------*
12 ***********************************************************/
21 #if defined(PLATFORM_MACOSX)
23 #elif defined(PLATFORM_WIN32)
25 #elif defined(PLATFORM_MSDOS)
29 #if defined(TARGET_SDL)
31 #elif defined(TARGET_X11)
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"
41 #define DEFAULT_DEPTH 0
45 #define BLIT_INVERSE 2
46 #define BLIT_ON_BACKGROUND 3
48 #define FULLSCREEN_NOT_AVAILABLE FALSE
49 #define FULLSCREEN_AVAILABLE TRUE
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
60 #define DEFAULT_KEY_SNAP KSYM_Control_L
61 #define DEFAULT_KEY_DROP KSYM_Control_R
63 #define DEFAULT_KEY_OKAY KSYM_Return
64 #define DEFAULT_KEY_CANCEL KSYM_Escape
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
76 /* values for key_status */
77 #define KEY_NOT_PRESSED FALSE
78 #define KEY_RELEASED FALSE
79 #define KEY_PRESSED TRUE
81 /* values for button status */
82 #define MB_NOT_PRESSED FALSE
83 #define MB_NOT_RELEASED TRUE
84 #define MB_RELEASED FALSE
85 #define MB_PRESSED TRUE
86 #define MB_MENU_CHOICE FALSE
87 #define MB_MENU_MARK TRUE
88 #define MB_MENU_INITIALIZE (-1)
89 #define MB_MENU_LEAVE (-2)
90 #define MB_LEFTBUTTON 1
91 #define MB_MIDDLEBUTTON 2
92 #define MB_RIGHTBUTTON 3
94 #define MB_WHEEL_DOWN 5
95 #define MB_WHEEL_LEFT 6
96 #define MB_WHEEL_RIGHT 7
97 #define IS_WHEEL_BUTTON_VERTICAL(b) ((b) >= MB_WHEEL_UP && \
99 #define IS_WHEEL_BUTTON_HORIZONTAL(b) ((b) >= MB_WHEEL_LEFT && \
100 (b) <= MB_WHEEL_RIGHT)
101 #define IS_WHEEL_BUTTON(b) ((b) >= MB_WHEEL_UP && \
102 (b) <= MB_WHEEL_DOWN)
103 #define DEFAULT_WHEEL_STEPS 3
105 /* values for move directions */
106 #define MV_BIT_LEFT 0
107 #define MV_BIT_RIGHT 1
109 #define MV_BIT_DOWN 3
111 #define NUM_DIRECTIONS 4
113 /* diagonal movement directions are used in a different contect than buttons */
114 #define MV_BIT_UPLEFT 4
115 #define MV_BIT_UPRIGHT 5
116 #define MV_BIT_DOWNLEFT 6
117 #define MV_BIT_DOWNRIGHT 7
119 #define NUM_DIRECTIONS_FULL 8
121 /* values for special "button" bitmasks */
125 /* values for special "focus player" bitmasks */
126 #define BIT_SET_FOCUS 6
128 /* values for move directions and special "button" key bitmasks */
130 #define MV_LEFT (1 << MV_BIT_LEFT)
131 #define MV_RIGHT (1 << MV_BIT_RIGHT)
132 #define MV_UP (1 << MV_BIT_UP)
133 #define MV_DOWN (1 << MV_BIT_DOWN)
135 #define MV_UPLEFT (MV_UP | MV_LEFT)
136 #define MV_UPRIGHT (MV_UP | MV_RIGHT)
137 #define MV_DOWNLEFT (MV_DOWN | MV_LEFT)
138 #define MV_DOWNRIGHT (MV_DOWN | MV_RIGHT)
140 #define MV_HORIZONTAL (MV_LEFT | MV_RIGHT)
141 #define MV_VERTICAL (MV_UP | MV_DOWN)
142 #define MV_ALL_DIRECTIONS (MV_LEFT | MV_RIGHT | MV_UP | MV_DOWN)
143 #define MV_ANY_DIRECTION (MV_ALL_DIRECTIONS)
144 #define MV_NO_DIRECTION (MV_NONE)
146 #define KEY_BUTTON_1 (1 << BUTTON_1)
147 #define KEY_BUTTON_2 (1 << BUTTON_2)
148 #define KEY_MOTION (MV_LEFT | MV_RIGHT | MV_UP | MV_DOWN)
149 #define KEY_BUTTON (KEY_BUTTON_1 | KEY_BUTTON_2)
150 #define KEY_ACTION (KEY_MOTION | KEY_BUTTON)
152 #define KEY_SET_FOCUS (1 << BIT_SET_FOCUS)
154 #define MV_DIR_FROM_BIT(x) ((x) < NUM_DIRECTIONS ? 1 << (x) : \
155 (x) == MV_BIT_UPLEFT ? MV_UPLEFT : \
156 (x) == MV_BIT_UPRIGHT ? MV_UPRIGHT : \
157 (x) == MV_BIT_DOWNLEFT ? MV_DOWNLEFT : \
158 (x) == MV_BIT_DOWNRIGHT ? MV_DOWNRIGHT : \
161 #define MV_DIR_TO_BIT(x) ((x) == MV_LEFT ? MV_BIT_LEFT : \
162 (x) == MV_RIGHT ? MV_BIT_RIGHT : \
163 (x) == MV_UP ? MV_BIT_UP : \
164 (x) == MV_DOWN ? MV_BIT_DOWN : \
165 (x) == MV_UPLEFT ? MV_BIT_UPLEFT : \
166 (x) == MV_UPRIGHT ? MV_BIT_UPRIGHT : \
167 (x) == MV_DOWNLEFT ? MV_BIT_DOWNLEFT : \
168 (x) == MV_DOWNRIGHT ? MV_BIT_DOWNRIGHT : \
171 #define MV_DIR_OPPOSITE(x) ((x) == MV_LEFT ? MV_RIGHT : \
172 (x) == MV_RIGHT ? MV_LEFT : \
173 (x) == MV_UP ? MV_DOWN : \
174 (x) == MV_DOWN ? MV_UP : \
175 (x) == MV_UPLEFT ? MV_DOWNRIGHT : \
176 (x) == MV_UPRIGHT ? MV_DOWNLEFT : \
177 (x) == MV_DOWNLEFT ? MV_UPRIGHT : \
178 (x) == MV_DOWNRIGHT ? MV_UPLEFT : \
181 /* values for animation mode (frame order and direction) */
183 #define ANIM_LOOP (1 << 0)
184 #define ANIM_LINEAR (1 << 1)
185 #define ANIM_PINGPONG (1 << 2)
186 #define ANIM_PINGPONG2 (1 << 3)
187 #define ANIM_RANDOM (1 << 4)
188 #define ANIM_CE_VALUE (1 << 5)
189 #define ANIM_CE_SCORE (1 << 6)
190 #define ANIM_CE_DELAY (1 << 7)
191 #define ANIM_REVERSE (1 << 8)
192 #define ANIM_OPAQUE_PLAYER (1 << 9)
194 /* values for special (non game element) animation modes */
195 #define ANIM_HORIZONTAL (1 << 10)
196 #define ANIM_VERTICAL (1 << 11)
197 #define ANIM_CENTERED (1 << 12)
198 #define ANIM_STATIC_PANEL (1 << 13)
200 #define ANIM_DEFAULT ANIM_LOOP
202 /* values for fade mode */
203 #define FADE_TYPE_NONE 0
204 #define FADE_TYPE_FADE_IN (1 << 0)
205 #define FADE_TYPE_FADE_OUT (1 << 1)
206 #define FADE_TYPE_TRANSFORM (1 << 2)
207 #define FADE_TYPE_CROSSFADE (1 << 3)
208 #define FADE_TYPE_MELT (1 << 4)
209 #define FADE_TYPE_SKIP (1 << 5)
211 #define FADE_MODE_NONE (FADE_TYPE_NONE)
212 #define FADE_MODE_FADE_IN (FADE_TYPE_FADE_IN)
213 #define FADE_MODE_FADE_OUT (FADE_TYPE_FADE_OUT)
214 #define FADE_MODE_FADE (FADE_TYPE_FADE_IN | FADE_TYPE_FADE_OUT)
215 #define FADE_MODE_TRANSFORM (FADE_TYPE_TRANSFORM | FADE_TYPE_FADE_IN)
216 #define FADE_MODE_CROSSFADE (FADE_MODE_TRANSFORM | FADE_TYPE_CROSSFADE)
217 #define FADE_MODE_MELT (FADE_MODE_TRANSFORM | FADE_TYPE_MELT)
218 #define FADE_MODE_SKIP_FADE_IN (FADE_TYPE_SKIP | FADE_TYPE_FADE_IN)
219 #define FADE_MODE_SKIP_FADE_OUT (FADE_TYPE_SKIP | FADE_TYPE_FADE_OUT)
221 #define FADE_MODE_DEFAULT FADE_MODE_FADE
223 /* values for text alignment */
224 #define ALIGN_LEFT (1 << 0)
225 #define ALIGN_RIGHT (1 << 1)
226 #define ALIGN_CENTER (1 << 2)
227 #define ALIGN_DEFAULT ALIGN_LEFT
229 #define VALIGN_TOP (1 << 0)
230 #define VALIGN_BOTTOM (1 << 1)
231 #define VALIGN_MIDDLE (1 << 2)
232 #define VALIGN_DEFAULT VALIGN_TOP
234 #define ALIGNED_XPOS(x,w,a) ((a) == ALIGN_CENTER ? (x) - (w) / 2 : \
235 (a) == ALIGN_RIGHT ? (x) - (w) : (x))
236 #define ALIGNED_YPOS(y,h,v) ((v) == VALIGN_MIDDLE ? (y) - (h) / 2 : \
237 (v) == VALIGN_BOTTOM ? (y) - (h) : (y))
238 #define ALIGNED_TEXT_XPOS(p) ALIGNED_XPOS((p)->x, (p)->width, (p)->align)
239 #define ALIGNED_TEXT_YPOS(p) ALIGNED_YPOS((p)->y, (p)->height, (p)->valign)
241 /* values for redraw_mask */
242 #define REDRAW_NONE (0)
243 #define REDRAW_ALL (1 << 0)
244 #define REDRAW_FIELD (1 << 1)
245 #define REDRAW_TILES (1 << 2)
246 #define REDRAW_DOOR_1 (1 << 3)
247 #define REDRAW_VIDEO_1 (1 << 4)
248 #define REDRAW_VIDEO_2 (1 << 5)
249 #define REDRAW_VIDEO_3 (1 << 6)
250 #define REDRAW_MICROLEVEL (1 << 7)
251 #define REDRAW_MICROLABEL (1 << 8)
252 #define REDRAW_FROM_BACKBUFFER (1 << 9)
253 #define REDRAW_DOOR_2 (REDRAW_VIDEO_1 | \
256 #define REDRAW_DOOR_3 (1 << 10)
257 #define REDRAW_DOORS (REDRAW_DOOR_1 | \
260 #define REDRAW_MAIN (REDRAW_FIELD | \
263 #define REDRAW_FPS (1 << 11)
264 #define REDRAWTILES_THRESHOLD (SCR_FIELDX * SCR_FIELDY / 2)
266 #define IN_GFX_SCREEN(x, y) (x >= gfx.sx && x < gfx.sx + gfx.sxsize && \
267 y >= gfx.sy && y < gfx.sy + gfx.sysize)
268 #define IN_GFX_DOOR(x, y) (x >= gfx.dx && x < gfx.dx + gfx.dxsize && \
269 y >= gfx.dy && y < gfx.dy + gfx.dysize)
270 #define IN_GFX_VIDEO(x, y) (x >= gfx.vx && x < gfx.vx + gfx.vxsize && \
271 y >= gfx.vy && y < gfx.vy + gfx.vysize)
273 /* values for mouse cursor */
274 #define CURSOR_DEFAULT 0
275 #define CURSOR_NONE 1
276 #define CURSOR_PLAYFIELD 2
278 /* fundamental game speed values */
279 #define ONE_SECOND_DELAY 1000 /* delay value for one second */
280 #define GAME_FRAME_DELAY 20 /* frame delay in milliseconds */
281 #define FFWD_FRAME_DELAY 10 /* 200% speed for fast forward */
282 #define FRAMES_PER_SECOND (ONE_SECOND_DELAY / GAME_FRAME_DELAY)
284 /* maximum playfield size supported by libgame functions */
285 #define MAX_PLAYFIELD_WIDTH 128
286 #define MAX_PLAYFIELD_HEIGHT 128
288 /* maximum number of parallel players supported by libgame functions */
289 #define MAX_PLAYERS 4
291 /* maximum allowed length of player name */
292 #define MAX_PLAYER_NAME_LEN 10
294 /* default name for empty highscore entry */
295 #define EMPTY_PLAYER_NAME "no name"
297 /* default name for unknown player names */
298 #define ANONYMOUS_NAME "anonymous"
300 /* default for other unknown names */
301 #define UNKNOWN_NAME "unknown"
303 /* default name for new levels */
304 #define NAMELESS_LEVEL_NAME "nameless level"
306 /* default text for non-existant artwork */
307 #define NOT_AVAILABLE "(not available)"
309 /* default value for undefined filename */
310 #define UNDEFINED_FILENAME "[NONE]"
312 /* default value for undefined parameter */
313 #define ARG_DEFAULT "[DEFAULT]"
315 /* default values for undefined configuration file parameters */
316 #define ARG_UNDEFINED "-1000000"
317 #define ARG_UNDEFINED_VALUE (atoi(ARG_UNDEFINED))
319 /* definitions for game sub-directories */
321 #define RO_GAME_DIR "."
325 #define RW_GAME_DIR "."
328 #define RO_BASE_PATH RO_GAME_DIR
329 #define RW_BASE_PATH RW_GAME_DIR
331 /* directory names */
332 #define GRAPHICS_DIRECTORY "graphics"
333 #define SOUNDS_DIRECTORY "sounds"
334 #define MUSIC_DIRECTORY "music"
335 #define LEVELS_DIRECTORY "levels"
336 #define TAPES_DIRECTORY "tapes"
337 #define SCORES_DIRECTORY "scores"
338 #define DOCS_DIRECTORY "docs"
339 #define CACHE_DIRECTORY "cache"
341 #if !defined(PLATFORM_MSDOS)
342 #define GFX_CLASSIC_SUBDIR "gfx_classic"
343 #define SND_CLASSIC_SUBDIR "snd_classic"
344 #define MUS_CLASSIC_SUBDIR "mus_classic"
346 #define GFX_CLASSIC_SUBDIR "gfx_orig"
347 #define SND_CLASSIC_SUBDIR "snd_orig"
348 #define MUS_CLASSIC_SUBDIR "mus_orig"
351 #if defined(CREATE_SPECIAL_EDITION_RND_JUE)
352 #define GFX_DEFAULT_SUBDIR "jue0"
353 #define SND_DEFAULT_SUBDIR "jue0"
354 #define MUS_DEFAULT_SUBDIR "jue0"
356 #define GFX_DEFAULT_SUBDIR GFX_CLASSIC_SUBDIR
357 #define SND_DEFAULT_SUBDIR SND_CLASSIC_SUBDIR
358 #define MUS_DEFAULT_SUBDIR MUS_CLASSIC_SUBDIR
361 #if defined(CREATE_SPECIAL_EDITION)
362 #define GFX_FALLBACK_FILENAME "fallback.pcx"
363 #define SND_FALLBACK_FILENAME "fallback.wav"
364 #define MUS_FALLBACK_FILENAME "fallback.wav"
367 /* file names and filename extensions */
368 #if !defined(PLATFORM_MSDOS)
369 #define LEVELSETUP_DIRECTORY "levelsetup"
370 #define SETUP_FILENAME "setup.conf"
371 #define LEVELSETUP_FILENAME "levelsetup.conf"
372 #define EDITORSETUP_FILENAME "editorsetup.conf"
373 #define EDITORCASCADE_FILENAME "editorcascade.conf"
374 #define HELPANIM_FILENAME "helpanim.conf"
375 #define HELPTEXT_FILENAME "helptext.conf"
376 #define LEVELINFO_FILENAME "levelinfo.conf"
377 #define GRAPHICSINFO_FILENAME "graphicsinfo.conf"
378 #define SOUNDSINFO_FILENAME "soundsinfo.conf"
379 #define MUSICINFO_FILENAME "musicinfo.conf"
380 #define ARTWORKINFO_CACHE_FILE "artworkinfo.cache"
381 #define LEVELFILE_EXTENSION "level"
382 #define TAPEFILE_EXTENSION "tape"
383 #define SCOREFILE_EXTENSION "score"
385 #define LEVELSETUP_DIRECTORY "lvlsetup"
386 #define SETUP_FILENAME "setup.cnf"
387 #define LEVELSETUP_FILENAME "lvlsetup.cnf"
388 #define EDITORSETUP_FILENAME "edsetup.cnf"
389 #define EDITORCASCADE_FILENAME "edcascad.conf"
390 #define HELPANIM_FILENAME "helpanim.cnf"
391 #define HELPTEXT_FILENAME "helptext.cnf"
392 #define LEVELINFO_FILENAME "lvlinfo.cnf"
393 #define GRAPHICSINFO_FILENAME "gfxinfo.cnf"
394 #define SOUNDSINFO_FILENAME "sndinfo.cnf"
395 #define MUSICINFO_FILENAME "musinfo.cnf"
396 #define ARTWORKINFO_CACHE_FILE "artinfo.cac"
397 #define LEVELFILE_EXTENSION "lvl"
398 #define TAPEFILE_EXTENSION "tap"
399 #define SCOREFILE_EXTENSION "sco"
402 #define ERROR_BASENAME "stderr.txt"
404 #define CHAR_PATH_SEPARATOR_UNIX '/'
405 #define CHAR_PATH_SEPARATOR_DOS '\\'
407 #define STRING_PATH_SEPARATOR_UNIX "/"
408 #define STRING_PATH_SEPARATOR_DOS "\\"
410 #define STRING_NEWLINE_UNIX "\n"
411 #define STRING_NEWLINE_DOS "\r\n"
413 #if defined(PLATFORM_WIN32) || defined(PLATFORM_MSDOS)
414 #define CHAR_PATH_SEPARATOR CHAR_PATH_SEPARATOR_DOS
415 #define STRING_PATH_SEPARATOR STRING_PATH_SEPARATOR_DOS
416 #define STRING_NEWLINE STRING_NEWLINE_DOS
418 #define CHAR_PATH_SEPARATOR CHAR_PATH_SEPARATOR_UNIX
419 #define STRING_PATH_SEPARATOR STRING_PATH_SEPARATOR_UNIX
420 #define STRING_NEWLINE STRING_NEWLINE_UNIX
424 /* areas in bitmap PIX_DOOR */
425 /* meaning in PIX_DB_DOOR: (3 PAGEs)
426 PAGEX1: 1. buffer for DOOR_1
427 PAGEX2: 2. buffer for DOOR_1
428 PAGEX3: buffer for animations
431 /* these values are hard-coded to be able to use them in initialization */
432 #define DOOR_GFX_PAGE_WIDTH 100 /* should be set to "gfx.dxsize" */
433 #define DOOR_GFX_PAGE_HEIGHT 280 /* should be set to "gfx.dysize" */
435 #define DOOR_GFX_PAGESIZE (DOOR_GFX_PAGE_WIDTH)
436 #define DOOR_GFX_PAGEX1 (0 * DOOR_GFX_PAGESIZE)
437 #define DOOR_GFX_PAGEX2 (1 * DOOR_GFX_PAGESIZE)
438 #define DOOR_GFX_PAGEX3 (2 * DOOR_GFX_PAGESIZE)
439 #define DOOR_GFX_PAGEX4 (3 * DOOR_GFX_PAGESIZE)
440 #define DOOR_GFX_PAGEX5 (4 * DOOR_GFX_PAGESIZE)
441 #define DOOR_GFX_PAGEX6 (5 * DOOR_GFX_PAGESIZE)
442 #define DOOR_GFX_PAGEX7 (6 * DOOR_GFX_PAGESIZE)
443 #define DOOR_GFX_PAGEX8 (7 * DOOR_GFX_PAGESIZE)
444 #define DOOR_GFX_PAGEY1 (0)
445 #define DOOR_GFX_PAGEY2 (DOOR_GFX_PAGE_HEIGHT)
448 /* macros for version handling */
449 #define VERSION_MAJOR(x) ((x) / 1000000)
450 #define VERSION_MINOR(x) (((x) % 1000000) / 10000)
451 #define VERSION_PATCH(x) (((x) % 10000) / 100)
452 #define VERSION_BUILD(x) ((x) % 100)
453 #define VERSION_IDENT(a,b,c,d) ((a) * 1000000 + (b) * 10000 + (c) * 100 + (d))
456 /* macros for parent/child process identification */
457 #if defined(PLATFORM_UNIX)
458 #define IS_PARENT_PROCESS() (audio.mixer_pid != getpid())
459 #define IS_CHILD_PROCESS() (audio.mixer_pid == getpid())
460 #define HAS_CHILD_PROCESS() (audio.mixer_pid > 0)
462 #define IS_PARENT_PROCESS() TRUE
463 #define IS_CHILD_PROCESS() FALSE
464 #define HAS_CHILD_PROCESS() FALSE
468 /* values for artwork type */
469 #define ARTWORK_TYPE_GRAPHICS 0
470 #define ARTWORK_TYPE_SOUNDS 1
471 #define ARTWORK_TYPE_MUSIC 2
473 #define NUM_ARTWORK_TYPES 3
476 /* values for tree type (chosen to match artwork type) */
477 #define TREE_TYPE_UNDEFINED -1
478 #define TREE_TYPE_GRAPHICS_DIR ARTWORK_TYPE_GRAPHICS
479 #define TREE_TYPE_SOUNDS_DIR ARTWORK_TYPE_SOUNDS
480 #define TREE_TYPE_MUSIC_DIR ARTWORK_TYPE_MUSIC
481 #define TREE_TYPE_LEVEL_DIR 3
483 #define NUM_TREE_TYPES 4
485 #define INFOTEXT_UNDEFINED ""
486 #define INFOTEXT_GRAPHICS_DIR "Custom Graphics"
487 #define INFOTEXT_SOUNDS_DIR "Custom Sounds"
488 #define INFOTEXT_MUSIC_DIR "Custom Music"
489 #define INFOTEXT_LEVEL_DIR "Level Sets"
491 #define TREE_INFOTEXT(t) ((t) == TREE_TYPE_LEVEL_DIR ? \
492 INFOTEXT_LEVEL_DIR : \
493 (t) == TREE_TYPE_GRAPHICS_DIR ? \
494 INFOTEXT_GRAPHICS_DIR : \
495 (t) == TREE_TYPE_SOUNDS_DIR ? \
496 INFOTEXT_SOUNDS_DIR : \
497 (t) == TREE_TYPE_MUSIC_DIR ? \
498 INFOTEXT_MUSIC_DIR : \
501 /* values for artwork handling */
502 #define LEVELDIR_ARTWORK_SET_PTR(leveldir, type) \
503 ((type) == ARTWORK_TYPE_GRAPHICS ? \
504 &(leveldir)->graphics_set : \
505 (type) == ARTWORK_TYPE_SOUNDS ? \
506 &(leveldir)->sounds_set : \
507 &(leveldir)->music_set)
509 #define LEVELDIR_ARTWORK_SET(leveldir, type) \
510 ((type) == ARTWORK_TYPE_GRAPHICS ? \
511 (leveldir)->graphics_set : \
512 (type) == ARTWORK_TYPE_SOUNDS ? \
513 (leveldir)->sounds_set : \
514 (leveldir)->music_set)
516 #define LEVELDIR_ARTWORK_PATH_PTR(leveldir, type) \
517 ((type) == ARTWORK_TYPE_GRAPHICS ? \
518 &(leveldir)->graphics_path : \
519 (type) == ARTWORK_TYPE_SOUNDS ? \
520 &(leveldir)->sounds_path : \
521 &(leveldir)->music_path)
523 #define LEVELDIR_ARTWORK_PATH(leveldir, type) \
524 ((type) == ARTWORK_TYPE_GRAPHICS ? \
525 (leveldir)->graphics_path : \
526 (type) == ARTWORK_TYPE_SOUNDS ? \
527 (leveldir)->sounds_path : \
528 (leveldir)->music_path)
530 #define SETUP_ARTWORK_SET(setup, type) \
531 ((type) == ARTWORK_TYPE_GRAPHICS ? \
532 (setup).graphics_set : \
533 (type) == ARTWORK_TYPE_SOUNDS ? \
534 (setup).sounds_set : \
537 #define SETUP_OVERRIDE_ARTWORK(setup, type) \
538 ((type) == ARTWORK_TYPE_GRAPHICS ? \
539 (setup).override_level_graphics : \
540 (type) == ARTWORK_TYPE_SOUNDS ? \
541 (setup).override_level_sounds : \
542 (setup).override_level_music)
544 #define GFX_OVERRIDE_ARTWORK(type) \
545 ((type) == ARTWORK_TYPE_GRAPHICS ? \
546 gfx.override_level_graphics : \
547 (type) == ARTWORK_TYPE_SOUNDS ? \
548 gfx.override_level_sounds : \
549 gfx.override_level_music)
551 #define ARTWORK_FIRST_NODE(artwork, type) \
552 ((type) == ARTWORK_TYPE_GRAPHICS ? \
553 (artwork).gfx_first : \
554 (type) == ARTWORK_TYPE_SOUNDS ? \
555 (artwork).snd_first : \
558 #define ARTWORK_CURRENT_IDENTIFIER_PTR(artwork, type) \
559 ((type) == ARTWORK_TYPE_GRAPHICS ? \
560 &(artwork).gfx_current_identifier : \
561 (type) == ARTWORK_TYPE_SOUNDS ? \
562 &(artwork).snd_current_identifier : \
563 &(artwork).mus_current_identifier)
565 #define ARTWORK_CURRENT_IDENTIFIER(artwork, type) \
566 ((type) == ARTWORK_TYPE_GRAPHICS ? \
567 (artwork).gfx_current_identifier : \
568 (type) == ARTWORK_TYPE_SOUNDS ? \
569 (artwork).snd_current_identifier : \
570 (artwork).mus_current_identifier)
572 #define ARTWORKINFO_FILENAME(type) \
573 ((type) == ARTWORK_TYPE_GRAPHICS ? \
574 GRAPHICSINFO_FILENAME : \
575 (type) == ARTWORK_TYPE_SOUNDS ? \
576 SOUNDSINFO_FILENAME : \
577 (type) == ARTWORK_TYPE_MUSIC ? \
578 MUSICINFO_FILENAME : "")
580 #define ARTWORK_DIRECTORY(type) \
581 ((type) == ARTWORK_TYPE_GRAPHICS ? \
582 GRAPHICS_DIRECTORY : \
583 (type) == ARTWORK_TYPE_SOUNDS ? \
585 (type) == ARTWORK_TYPE_MUSIC ? \
586 MUSIC_DIRECTORY : "")
588 #define OPTIONS_ARTWORK_DIRECTORY(type) \
589 ((type) == ARTWORK_TYPE_GRAPHICS ? \
590 options.graphics_directory : \
591 (type) == ARTWORK_TYPE_SOUNDS ? \
592 options.sounds_directory : \
593 (type) == ARTWORK_TYPE_MUSIC ? \
594 options.music_directory : "")
596 #define UPDATE_BUSY_STATE() \
598 if (gfx.draw_busy_anim_function != NULL) \
599 gfx.draw_busy_anim_function(); \
603 /* type definitions */
604 typedef int (*EventFilter)(const Event *);
607 /* structure definitions */
611 char *command_basepath; /* directory that contains the program */
612 char *command_basename; /* base filename of the program binary */
614 char *userdata_subdir; /* personal user game data directory */
615 char *userdata_subdir_unix; /* personal user game data directory (Unix) */
616 char *userdata_path; /* resulting full path to game data directory */
622 char *x11_icon_filename;
623 char *x11_iconmask_filename;
624 char *sdl_icon_filename;
625 char *msdos_cursor_filename;
628 char *filename_prefix; /* prefix to cut off from DOS filenames */
630 char *error_filename; /* filename where to write error messages to */
631 FILE *error_file; /* (used instead of 'stderr' on some systems) */
637 void (*exit_function)(int);
646 char *ro_base_directory;
647 char *rw_base_directory;
648 char *level_directory;
649 char *graphics_directory;
650 char *sounds_directory;
651 char *music_directory;
652 char *docs_directory;
653 char *execute_command;
659 boolean debug_x11_sync;
662 struct ScreenModeInfo
667 struct VideoSystemInfo
670 int width, height, depth;
672 boolean fullscreen_available;
673 boolean fullscreen_enabled;
674 struct ScreenModeInfo *fullscreen_modes;
675 char *fullscreen_mode_current;
678 struct AudioSystemInfo
680 boolean sound_available;
681 boolean loops_available;
682 boolean music_available;
684 boolean sound_enabled;
685 boolean sound_deactivated; /* for temporarily disabling sound */
694 int first_sound_channel;
697 struct FontBitmapInfo
701 int src_x, src_y; /* start position of animation frames */
702 int width, height; /* width/height of each animation frame */
704 int draw_xoffset; /* offset for drawing font characters */
705 int draw_yoffset; /* offset for drawing font characters */
708 int num_chars_per_line;
710 #if defined(TARGET_X11_NATIVE_PERFORMANCE_WORKAROUND)
711 Pixmap *clip_mask; /* single-char-only clip mask array for X11 */
719 int real_sx, real_sy;
720 int full_sxsize, full_sysize;
721 int scrollbuffer_width, scrollbuffer_height;
729 int draw_deactivation_mask;
730 int draw_background_mask;
732 Bitmap *field_save_buffer;
734 Bitmap *background_bitmap;
735 int background_bitmap_mask;
737 boolean override_level_graphics;
738 boolean override_level_sounds;
739 boolean override_level_music;
741 boolean draw_init_text;
744 struct FontBitmapInfo *font_bitmap_info;
745 int (*select_font_function)(int);
746 int (*get_font_from_token_function)(char *);
748 int anim_random_frame;
750 void (*draw_busy_anim_function)(void);
756 int fd[MAX_PLAYERS]; /* file descriptor of player's joystick */
759 struct SetupJoystickInfo
761 char *device_name; /* device name of player's joystick */
763 int xleft, xmiddle, xright;
764 int yupper, ymiddle, ylower;
768 struct SetupKeyboardInfo
770 Key left, right, up, down;
774 struct SetupInputInfo
776 boolean use_joystick;
777 struct SetupJoystickInfo joy;
778 struct SetupKeyboardInfo key;
781 struct SetupEditorInfo
783 boolean el_boulderdash;
784 boolean el_emerald_mine;
785 boolean el_emerald_mine_club;
789 boolean el_diamond_caves;
790 boolean el_dx_boulderdash;
792 boolean el_steel_chars;
794 boolean el_user_defined;
797 boolean el_headlines;
802 boolean show_element_token;
805 struct SetupEditorCascadeInfo
816 boolean el_steel_chars;
824 struct SetupShortcutInfo
830 Key focus_player[MAX_PLAYERS];
831 Key focus_player_all;
834 struct SetupSystemInfo
836 char *sdl_videodriver;
837 char *sdl_audiodriver;
838 int audio_fragment_size;
848 boolean sound_simple;
850 boolean scroll_delay;
851 boolean scroll_delay_value;
852 boolean soft_scrolling;
853 boolean fade_screens;
855 boolean show_titlescreen;
862 char *fullscreen_mode;
863 boolean ask_on_escape;
864 boolean ask_on_escape_editor;
865 boolean quick_switch;
866 boolean input_on_focus;
867 boolean prefer_aga_graphics;
868 int game_frame_delay;
873 int override_level_graphics; /* not boolean -- can also be "AUTO" */
874 int override_level_sounds; /* not boolean -- can also be "AUTO" */
875 int override_level_music; /* not boolean -- can also be "AUTO" */
877 struct SetupEditorInfo editor;
878 struct SetupEditorCascadeInfo editor_cascade;
879 struct SetupShortcutInfo shortcut;
880 struct SetupInputInfo input[MAX_PLAYERS];
881 struct SetupSystemInfo system;
882 struct OptionInfo options;
887 struct TreeInfo **node_top; /* topmost node in tree */
888 struct TreeInfo *node_parent; /* parent level directory info */
889 struct TreeInfo *node_group; /* level group sub-directory info */
890 struct TreeInfo *next; /* next level series structure node */
892 int cl_first; /* internal control field for setup screen */
893 int cl_cursor; /* internal control field for setup screen */
895 int type; /* type of tree content */
897 /* fields for "type == TREE_TYPE_LEVEL_DIR" */
899 char *subdir; /* tree info sub-directory basename (may be ".") */
900 char *fullpath; /* complete path relative to tree base directory */
901 char *basepath; /* absolute base path of tree base directory */
902 char *identifier; /* identifier string for configuration files */
903 char *name; /* tree info name, as displayed in selection menues */
904 char *name_sorting; /* optional sorting name for correct name sorting */
905 char *author; /* level or artwork author name */
906 char *year; /* optional year of creation for levels or artwork */
907 char *imported_from; /* optional comment for imported levels or artwork */
908 char *imported_by; /* optional comment for imported levels or artwork */
909 char *tested_by; /* optional comment to name people who tested a set */
911 char *graphics_set_ecs; /* special EMC custom graphics set (ECS graphics) */
912 char *graphics_set_aga; /* special EMC custom graphics set (AGA graphics) */
913 char *graphics_set; /* optional custom graphics set (level tree only) */
914 char *sounds_set; /* optional custom sounds set (level tree only) */
915 char *music_set; /* optional custom music set (level tree only) */
916 char *graphics_path; /* path to optional custom graphics set (level only) */
917 char *sounds_path; /* path to optional custom sounds set (level only) */
918 char *music_path; /* path to optional custom music set (level only) */
920 char *level_filename; /* filename of level file (for packed level file) */
921 char *level_filetype; /* type of levels in level directory or level file */
923 int levels; /* number of levels in level series */
924 int first_level; /* first level number (to allow start with 0 or 1) */
925 int last_level; /* last level number (automatically calculated) */
926 int sort_priority; /* sort levels by 'sort_priority' and then by name */
928 boolean latest_engine;/* force level set to use the latest game engine */
930 boolean level_group; /* directory contains more level series directories */
931 boolean parent_link; /* entry links back to parent directory */
932 boolean in_user_dir; /* user defined levels are stored in home directory */
933 boolean user_defined; /* levels in user directory and marked as "private" */
934 boolean readonly; /* readonly levels can not be changed with editor */
935 boolean handicap; /* level set has no handicap when set to "false" */
936 boolean skip_levels; /* levels can be skipped when set to "true" */
938 int color; /* color to use on selection screen for this level */
939 char *class_desc; /* description of level series class */
940 int handicap_level; /* number of the lowest unsolved level */
942 char *infotext; /* optional text to describe the tree type (headline) */
945 typedef struct TreeInfo TreeInfo;
946 typedef struct TreeInfo LevelDirTree;
947 typedef struct TreeInfo ArtworkDirTree;
948 typedef struct TreeInfo GraphicsDirTree;
949 typedef struct TreeInfo SoundsDirTree;
950 typedef struct TreeInfo MusicDirTree;
954 GraphicsDirTree *gfx_first;
955 GraphicsDirTree *gfx_current;
956 SoundsDirTree *snd_first;
957 SoundsDirTree *snd_current;
958 MusicDirTree *mus_first;
959 MusicDirTree *mus_current;
961 char *gfx_current_identifier;
962 char *snd_current_identifier;
963 char *mus_current_identifier;
978 struct ConfigTypeInfo
985 struct TokenIntPtrInfo
995 char *default_filename;
998 char **default_parameter; /* array of file parameters */
999 char **parameter; /* array of file parameters */
1002 boolean fallback_to_default;
1003 boolean default_is_cloned;
1006 struct SetupFileList
1011 struct SetupFileList *next;
1016 char *source_filename; /* primary key for node list */
1020 struct PropertyMapping
1030 struct ArtworkListInfo
1032 int type; /* type of artwork */
1034 int num_file_list_entries;
1035 int num_dynamic_file_list_entries;
1036 struct FileInfo *file_list; /* static artwork file array */
1037 struct FileInfo *dynamic_file_list; /* dynamic artwrk file array */
1039 int num_suffix_list_entries;
1040 struct ConfigTypeInfo *suffix_list; /* parameter suffixes array */
1042 int num_base_prefixes;
1043 int num_ext1_suffixes;
1044 int num_ext2_suffixes;
1045 int num_ext3_suffixes;
1046 char **base_prefixes; /* base token prefixes array */
1047 char **ext1_suffixes; /* property suffixes array 1 */
1048 char **ext2_suffixes; /* property suffixes array 2 */
1049 char **ext3_suffixes; /* property suffixes array 3 */
1051 int num_ignore_tokens;
1052 char **ignore_tokens; /* file tokens to be ignored */
1054 int num_property_mapping_entries;
1055 struct PropertyMapping *property_mapping; /* mapping token -> artwork */
1057 int sizeof_artwork_list_entry;
1059 struct ListNodeInfo **artwork_list; /* static artwork node array */
1060 struct ListNodeInfo **dynamic_artwork_list; /* dynamic artwrk node array */
1061 struct ListNode *content_list; /* dynamic artwork node list */
1063 void *(*load_artwork)(char *); /* constructor function */
1064 void (*free_artwork)(void *); /* destructor function */
1092 boolean draw_masked;
1098 /* ========================================================================= */
1099 /* exported variables */
1100 /* ========================================================================= */
1102 extern struct ProgramInfo program;
1103 extern struct OptionInfo options;
1104 extern struct VideoSystemInfo video;
1105 extern struct AudioSystemInfo audio;
1106 extern struct GfxInfo gfx;
1107 extern struct AnimInfo anim;
1108 extern struct ArtworkInfo artwork;
1109 extern struct JoystickInfo joystick;
1110 extern struct SetupInfo setup;
1112 extern LevelDirTree *leveldir_first_all;
1113 extern LevelDirTree *leveldir_first;
1114 extern LevelDirTree *leveldir_current;
1115 extern int level_nr;
1117 extern Display *display;
1118 extern Visual *visual;
1120 extern Colormap cmap;
1122 extern DrawWindow *window;
1123 extern DrawBuffer *backbuffer;
1124 extern DrawBuffer *drawto;
1126 extern int button_status;
1127 extern boolean motion_status;
1129 extern int redraw_mask;
1130 extern int redraw_tiles;
1132 extern int FrameCounter;
1135 /* function definitions */
1137 void InitProgramInfo(char *, char *, char *, char *, char *, char *, char *,
1138 char *, char *, char *, char *, char *, int);
1140 void InitExitFunction(void (*exit_function)(int));
1141 void InitPlatformDependentStuff(void);
1142 void ClosePlatformDependentStuff(void);
1144 void InitGfxFieldInfo(int, int, int, int, int, int, int, int, Bitmap *);
1145 void InitGfxDoor1Info(int, int, int, int);
1146 void InitGfxDoor2Info(int, int, int, int);
1147 void InitGfxScrollbufferInfo(int, int);
1148 void InitGfxDrawBusyAnimFunction(void (*draw_busy_anim_function)(void));
1149 void InitGfxCustomArtworkInfo();
1150 void SetDrawDeactivationMask(int);
1151 void SetDrawBackgroundMask(int);
1152 void SetWindowBackgroundBitmap(Bitmap *);
1153 void SetMainBackgroundBitmap(Bitmap *);
1154 void SetDoorBackgroundBitmap(Bitmap *);
1156 void InitVideoDisplay(void);
1157 void CloseVideoDisplay(void);
1158 void InitVideoBuffer(int, int, int, boolean);
1159 Bitmap *CreateBitmapStruct(void);
1160 Bitmap *CreateBitmap(int, int, int);
1161 void FreeBitmap(Bitmap *);
1162 void BlitBitmap(Bitmap *, Bitmap *, int, int, int, int, int, int);
1163 void FadeRectangle(Bitmap *bitmap, int, int, int, int, int, int, int,
1164 void (*draw_border_function)(void));
1165 void FillRectangle(Bitmap *, int, int, int, int, Pixel);
1166 void ClearRectangle(Bitmap *, int, int, int, int);
1167 void ClearRectangleOnBackground(Bitmap *, int, int, int, int);
1168 void SetClipMask(Bitmap *, GC, Pixmap);
1169 void SetClipOrigin(Bitmap *, GC, int, int);
1170 void BlitBitmapMasked(Bitmap *, Bitmap *, int, int, int, int, int, int);
1171 boolean DrawingOnBackground(int, int);
1172 void BlitBitmapOnBackground(Bitmap *, Bitmap *, int, int, int, int, int, int);
1173 void DrawSimpleBlackLine(Bitmap *, int, int, int, int);
1174 void DrawSimpleWhiteLine(Bitmap *, int, int, int, int);
1175 void DrawLines(Bitmap *, struct XY *, int, Pixel);
1176 Pixel GetPixel(Bitmap *, int, int);
1177 Pixel GetPixelFromRGB(Bitmap *, unsigned int,unsigned int,unsigned int);
1178 Pixel GetPixelFromRGBcompact(Bitmap *, unsigned int);
1180 void FlushDisplay(void);
1181 void SyncDisplay(void);
1182 void KeyboardAutoRepeatOn(void);
1183 void KeyboardAutoRepeatOff(void);
1184 boolean PointerInWindow(DrawWindow *);
1185 boolean SetVideoMode(boolean);
1186 boolean ChangeVideoModeIfNeeded(boolean);
1188 Bitmap *LoadImage(char *);
1189 Bitmap *LoadCustomImage(char *);
1190 void ReloadCustomImage(Bitmap *, char *);
1192 Bitmap *ZoomBitmap(Bitmap *, int, int);
1193 void CreateBitmapWithSmallBitmaps(Bitmap *, int);
1194 void ScaleBitmap(Bitmap *, int);
1196 void SetMouseCursor(int);
1198 void OpenAudio(void);
1199 void CloseAudio(void);
1200 void SetAudioMode(boolean);
1202 void InitEventFilter(EventFilter);
1203 boolean PendingEvent(void);
1204 void NextEvent(Event *event);
1205 void PeekEvent(Event *event);
1206 Key GetEventKey(KeyEvent *, boolean);
1207 KeyMod HandleKeyModState(Key, int);
1208 KeyMod GetKeyModState();
1209 KeyMod GetKeyModStateFromEvents();
1210 boolean CheckCloseWindowEvent(ClientMessageEvent *);
1212 void InitJoysticks();
1213 boolean ReadJoystick(int, int *, int *, boolean *, boolean *);
1215 #endif /* SYSTEM_H */