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
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
89 /* values for key_status */
90 #define KEY_NOT_PRESSED FALSE
91 #define KEY_RELEASED FALSE
92 #define KEY_PRESSED TRUE
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
118 /* values for move directions */
119 #define MV_BIT_LEFT 0
120 #define MV_BIT_RIGHT 1
122 #define MV_BIT_DOWN 3
124 #define NUM_DIRECTIONS 4
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
132 #define NUM_DIRECTIONS_FULL 8
134 /* values for special "button" bitmasks */
138 #define NUM_PLAYER_ACTIONS 6
140 /* values for special "focus player" bitmasks */
141 #define BIT_SET_FOCUS 6
143 /* values for move directions and special "button" key bitmasks */
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)
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)
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)
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)
169 #define KEY_SET_FOCUS (1 << BIT_SET_FOCUS)
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 : \
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 : \
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 : \
198 /* values for animation mode (frame order and direction) */
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)
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)
217 #define ANIM_DEFAULT ANIM_LOOP
219 /* values for special drawing styles (currently only for crumbled graphics) */
221 #define STYLE_ACCURATE_BORDERS (1 << 0)
222 #define STYLE_INNER_CORNERS (1 << 1)
224 #define STYLE_DEFAULT STYLE_NONE
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)
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)
245 #define FADE_MODE_DEFAULT FADE_MODE_FADE
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
253 #define VALIGN_TOP (1 << 0)
254 #define VALIGN_BOTTOM (1 << 1)
255 #define VALIGN_MIDDLE (1 << 2)
256 #define VALIGN_DEFAULT VALIGN_TOP
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)
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 | \
280 #define REDRAW_DOOR_3 (1 << 10)
281 #define REDRAW_DOORS (REDRAW_DOOR_1 | \
284 #define REDRAW_MAIN (REDRAW_FIELD | \
287 #define REDRAW_FPS (1 << 11)
288 #define REDRAWTILES_THRESHOLD (SCR_FIELDX * SCR_FIELDY / 2)
290 #define IN_GFX_SCREEN(x, y) (x >= gfx.sx && x < gfx.sx + gfx.sxsize && \
291 y >= gfx.sy && y < gfx.sy + gfx.sysize)
292 #define IN_GFX_DOOR(x, y) (x >= gfx.dx && x < gfx.dx + gfx.dxsize && \
293 y >= gfx.dy && y < gfx.dy + gfx.dysize)
294 #define IN_GFX_VIDEO(x, y) (x >= gfx.vx && x < gfx.vx + gfx.vxsize && \
295 y >= gfx.vy && y < gfx.vy + gfx.vysize)
297 /* values for mouse cursor */
298 #define CURSOR_DEFAULT 0
299 #define CURSOR_NONE 1
300 #define CURSOR_PLAYFIELD 2
302 /* fundamental game speed values */
303 #define ONE_SECOND_DELAY 1000 /* delay value for one second */
304 #define GAME_FRAME_DELAY 20 /* frame delay in milliseconds */
305 #define FFWD_FRAME_DELAY 10 /* 200% speed for fast forward */
306 #define FRAMES_PER_SECOND (ONE_SECOND_DELAY / GAME_FRAME_DELAY)
307 #define FRAMES_PER_SECOND_SP 35
309 /* maximum playfield size supported by libgame functions */
310 #define MAX_PLAYFIELD_WIDTH 128
311 #define MAX_PLAYFIELD_HEIGHT 128
313 /* maximum number of parallel players supported by libgame functions */
314 #define MAX_PLAYERS 4
316 /* maximum allowed length of player name */
317 #define MAX_PLAYER_NAME_LEN 10
319 /* maximum number of levels in a level set */
320 #define MAX_LEVELS 1000
322 /* default name for empty highscore entry */
323 #define EMPTY_PLAYER_NAME "no name"
325 /* default name for unknown player names */
326 #define ANONYMOUS_NAME "anonymous"
328 /* default for other unknown names */
329 #define UNKNOWN_NAME "unknown"
331 /* default name for new levels */
332 #define NAMELESS_LEVEL_NAME "nameless level"
334 /* default text for non-existant artwork */
335 #define NOT_AVAILABLE "(not available)"
337 /* default value for undefined filename */
338 #define UNDEFINED_FILENAME "[NONE]"
340 /* default value for undefined parameter */
341 #define ARG_DEFAULT "[DEFAULT]"
343 /* default values for undefined configuration file parameters */
344 #define ARG_UNDEFINED "-1000000"
345 #define ARG_UNDEFINED_VALUE (atoi(ARG_UNDEFINED))
347 /* definitions for game sub-directories */
349 #define RO_GAME_DIR "."
353 #define RW_GAME_DIR "."
356 #define RO_BASE_PATH RO_GAME_DIR
357 #define RW_BASE_PATH RW_GAME_DIR
359 /* directory names */
360 #define GRAPHICS_DIRECTORY "graphics"
361 #define SOUNDS_DIRECTORY "sounds"
362 #define MUSIC_DIRECTORY "music"
363 #define LEVELS_DIRECTORY "levels"
364 #define TAPES_DIRECTORY "tapes"
365 #define SCORES_DIRECTORY "scores"
366 #define DOCS_DIRECTORY "docs"
367 #define CACHE_DIRECTORY "cache"
369 #if !defined(PLATFORM_MSDOS)
370 #define GFX_CLASSIC_SUBDIR "gfx_classic"
371 #define SND_CLASSIC_SUBDIR "snd_classic"
372 #define MUS_CLASSIC_SUBDIR "mus_classic"
374 #define GFX_CLASSIC_SUBDIR "gfx_orig"
375 #define SND_CLASSIC_SUBDIR "snd_orig"
376 #define MUS_CLASSIC_SUBDIR "mus_orig"
379 #if defined(CREATE_SPECIAL_EDITION_RND_JUE)
380 #define GFX_DEFAULT_SUBDIR "jue0"
381 #define SND_DEFAULT_SUBDIR "jue0"
382 #define MUS_DEFAULT_SUBDIR "jue0"
384 #define GFX_DEFAULT_SUBDIR GFX_CLASSIC_SUBDIR
385 #define SND_DEFAULT_SUBDIR SND_CLASSIC_SUBDIR
386 #define MUS_DEFAULT_SUBDIR MUS_CLASSIC_SUBDIR
389 #if defined(CREATE_SPECIAL_EDITION)
390 #define GFX_FALLBACK_FILENAME "fallback.pcx"
391 #define SND_FALLBACK_FILENAME "fallback.wav"
392 #define MUS_FALLBACK_FILENAME "fallback.wav"
395 /* file names and filename extensions */
396 #if !defined(PLATFORM_MSDOS)
397 #define LEVELSETUP_DIRECTORY "levelsetup"
398 #define SETUP_FILENAME "setup.conf"
399 #define LEVELSETUP_FILENAME "levelsetup.conf"
400 #define EDITORSETUP_FILENAME "editorsetup.conf"
401 #define EDITORCASCADE_FILENAME "editorcascade.conf"
402 #define HELPANIM_FILENAME "helpanim.conf"
403 #define HELPTEXT_FILENAME "helptext.conf"
404 #define LEVELINFO_FILENAME "levelinfo.conf"
405 #define GRAPHICSINFO_FILENAME "graphicsinfo.conf"
406 #define SOUNDSINFO_FILENAME "soundsinfo.conf"
407 #define MUSICINFO_FILENAME "musicinfo.conf"
408 #define ARTWORKINFO_CACHE_FILE "artworkinfo.cache"
409 #define LEVELFILE_EXTENSION "level"
410 #define TAPEFILE_EXTENSION "tape"
411 #define SCOREFILE_EXTENSION "score"
413 #define LEVELSETUP_DIRECTORY "lvlsetup"
414 #define SETUP_FILENAME "setup.cnf"
415 #define LEVELSETUP_FILENAME "lvlsetup.cnf"
416 #define EDITORSETUP_FILENAME "edsetup.cnf"
417 #define EDITORCASCADE_FILENAME "edcascad.conf"
418 #define HELPANIM_FILENAME "helpanim.cnf"
419 #define HELPTEXT_FILENAME "helptext.cnf"
420 #define LEVELINFO_FILENAME "lvlinfo.cnf"
421 #define GRAPHICSINFO_FILENAME "gfxinfo.cnf"
422 #define SOUNDSINFO_FILENAME "sndinfo.cnf"
423 #define MUSICINFO_FILENAME "musinfo.cnf"
424 #define ARTWORKINFO_CACHE_FILE "artinfo.cac"
425 #define LEVELFILE_EXTENSION "lvl"
426 #define TAPEFILE_EXTENSION "tap"
427 #define SCOREFILE_EXTENSION "sco"
430 #define ERROR_BASENAME "stderr.txt"
432 #define CHAR_PATH_SEPARATOR_UNIX '/'
433 #define CHAR_PATH_SEPARATOR_DOS '\\'
435 #define STRING_PATH_SEPARATOR_UNIX "/"
436 #define STRING_PATH_SEPARATOR_DOS "\\"
438 #define STRING_NEWLINE_UNIX "\n"
439 #define STRING_NEWLINE_DOS "\r\n"
441 #if defined(PLATFORM_WIN32) || defined(PLATFORM_MSDOS)
442 #define CHAR_PATH_SEPARATOR CHAR_PATH_SEPARATOR_DOS
443 #define STRING_PATH_SEPARATOR STRING_PATH_SEPARATOR_DOS
444 #define STRING_NEWLINE STRING_NEWLINE_DOS
446 #define CHAR_PATH_SEPARATOR CHAR_PATH_SEPARATOR_UNIX
447 #define STRING_PATH_SEPARATOR STRING_PATH_SEPARATOR_UNIX
448 #define STRING_NEWLINE STRING_NEWLINE_UNIX
452 /* areas in bitmap PIX_DOOR */
453 /* meaning in PIX_DB_DOOR: (3 PAGEs)
454 PAGEX1: 1. buffer for DOOR_1
455 PAGEX2: 2. buffer for DOOR_1
456 PAGEX3: buffer for animations
459 /* these values are hard-coded to be able to use them in initialization */
460 #define DOOR_GFX_PAGE_WIDTH 100 /* should be set to "gfx.dxsize" */
461 #define DOOR_GFX_PAGE_HEIGHT 280 /* should be set to "gfx.dysize" */
463 #define DOOR_GFX_PAGESIZE (DOOR_GFX_PAGE_WIDTH)
464 #define DOOR_GFX_PAGEX1 (0 * DOOR_GFX_PAGESIZE)
465 #define DOOR_GFX_PAGEX2 (1 * DOOR_GFX_PAGESIZE)
466 #define DOOR_GFX_PAGEX3 (2 * DOOR_GFX_PAGESIZE)
467 #define DOOR_GFX_PAGEX4 (3 * DOOR_GFX_PAGESIZE)
468 #define DOOR_GFX_PAGEX5 (4 * DOOR_GFX_PAGESIZE)
469 #define DOOR_GFX_PAGEX6 (5 * DOOR_GFX_PAGESIZE)
470 #define DOOR_GFX_PAGEX7 (6 * DOOR_GFX_PAGESIZE)
471 #define DOOR_GFX_PAGEX8 (7 * DOOR_GFX_PAGESIZE)
472 #define DOOR_GFX_PAGEY1 (0)
473 #define DOOR_GFX_PAGEY2 (DOOR_GFX_PAGE_HEIGHT)
476 /* macros for version handling */
477 #define VERSION_MAJOR(x) ((x) / 1000000)
478 #define VERSION_MINOR(x) (((x) % 1000000) / 10000)
479 #define VERSION_PATCH(x) (((x) % 10000) / 100)
480 #define VERSION_BUILD(x) ((x) % 100)
481 #define VERSION_IDENT(a,b,c,d) ((a) * 1000000 + (b) * 10000 + (c) * 100 + (d))
484 /* macros for parent/child process identification */
485 #if defined(PLATFORM_UNIX)
486 #define IS_PARENT_PROCESS() (audio.mixer_pid != getpid())
487 #define IS_CHILD_PROCESS() (audio.mixer_pid == getpid())
488 #define HAS_CHILD_PROCESS() (audio.mixer_pid > 0)
490 #define IS_PARENT_PROCESS() TRUE
491 #define IS_CHILD_PROCESS() FALSE
492 #define HAS_CHILD_PROCESS() FALSE
496 /* values for artwork type */
497 #define ARTWORK_TYPE_GRAPHICS 0
498 #define ARTWORK_TYPE_SOUNDS 1
499 #define ARTWORK_TYPE_MUSIC 2
501 #define NUM_ARTWORK_TYPES 3
504 /* values for tree type (chosen to match artwork type) */
505 #define TREE_TYPE_UNDEFINED -1
506 #define TREE_TYPE_GRAPHICS_DIR ARTWORK_TYPE_GRAPHICS
507 #define TREE_TYPE_SOUNDS_DIR ARTWORK_TYPE_SOUNDS
508 #define TREE_TYPE_MUSIC_DIR ARTWORK_TYPE_MUSIC
509 #define TREE_TYPE_LEVEL_DIR 3
510 #define TREE_TYPE_LEVEL_NR 4
512 #define NUM_TREE_TYPES 5
514 #define INFOTEXT_UNDEFINED ""
515 #define INFOTEXT_GRAPHICS_DIR "Custom Graphics"
516 #define INFOTEXT_SOUNDS_DIR "Custom Sounds"
517 #define INFOTEXT_MUSIC_DIR "Custom Music"
518 #define INFOTEXT_LEVEL_DIR "Level Sets"
519 #define INFOTEXT_LEVEL_NR "Levels"
521 #define TREE_INFOTEXT(t) ((t) == TREE_TYPE_LEVEL_NR ? \
522 INFOTEXT_LEVEL_NR : \
523 (t) == TREE_TYPE_LEVEL_DIR ? \
524 INFOTEXT_LEVEL_DIR : \
525 (t) == TREE_TYPE_GRAPHICS_DIR ? \
526 INFOTEXT_GRAPHICS_DIR : \
527 (t) == TREE_TYPE_SOUNDS_DIR ? \
528 INFOTEXT_SOUNDS_DIR : \
529 (t) == TREE_TYPE_MUSIC_DIR ? \
530 INFOTEXT_MUSIC_DIR : \
533 /* values for artwork handling */
534 #define LEVELDIR_ARTWORK_SET_PTR(leveldir, type) \
535 ((type) == ARTWORK_TYPE_GRAPHICS ? \
536 &(leveldir)->graphics_set : \
537 (type) == ARTWORK_TYPE_SOUNDS ? \
538 &(leveldir)->sounds_set : \
539 &(leveldir)->music_set)
541 #define LEVELDIR_ARTWORK_SET(leveldir, type) \
542 ((type) == ARTWORK_TYPE_GRAPHICS ? \
543 (leveldir)->graphics_set : \
544 (type) == ARTWORK_TYPE_SOUNDS ? \
545 (leveldir)->sounds_set : \
546 (leveldir)->music_set)
548 #define LEVELDIR_ARTWORK_PATH_PTR(leveldir, type) \
549 ((type) == ARTWORK_TYPE_GRAPHICS ? \
550 &(leveldir)->graphics_path : \
551 (type) == ARTWORK_TYPE_SOUNDS ? \
552 &(leveldir)->sounds_path : \
553 &(leveldir)->music_path)
555 #define LEVELDIR_ARTWORK_PATH(leveldir, type) \
556 ((type) == ARTWORK_TYPE_GRAPHICS ? \
557 (leveldir)->graphics_path : \
558 (type) == ARTWORK_TYPE_SOUNDS ? \
559 (leveldir)->sounds_path : \
560 (leveldir)->music_path)
562 #define SETUP_ARTWORK_SET(setup, type) \
563 ((type) == ARTWORK_TYPE_GRAPHICS ? \
564 (setup).graphics_set : \
565 (type) == ARTWORK_TYPE_SOUNDS ? \
566 (setup).sounds_set : \
569 #define SETUP_OVERRIDE_ARTWORK(setup, type) \
570 ((type) == ARTWORK_TYPE_GRAPHICS ? \
571 (setup).override_level_graphics : \
572 (type) == ARTWORK_TYPE_SOUNDS ? \
573 (setup).override_level_sounds : \
574 (setup).override_level_music)
576 #define GFX_OVERRIDE_ARTWORK(type) \
577 ((type) == ARTWORK_TYPE_GRAPHICS ? \
578 gfx.override_level_graphics : \
579 (type) == ARTWORK_TYPE_SOUNDS ? \
580 gfx.override_level_sounds : \
581 gfx.override_level_music)
583 #define ARTWORK_FIRST_NODE(artwork, type) \
584 ((type) == ARTWORK_TYPE_GRAPHICS ? \
585 (artwork).gfx_first : \
586 (type) == ARTWORK_TYPE_SOUNDS ? \
587 (artwork).snd_first : \
590 #define ARTWORK_CURRENT_IDENTIFIER_PTR(artwork, type) \
591 ((type) == ARTWORK_TYPE_GRAPHICS ? \
592 &(artwork).gfx_current_identifier : \
593 (type) == ARTWORK_TYPE_SOUNDS ? \
594 &(artwork).snd_current_identifier : \
595 &(artwork).mus_current_identifier)
597 #define ARTWORK_CURRENT_IDENTIFIER(artwork, type) \
598 ((type) == ARTWORK_TYPE_GRAPHICS ? \
599 (artwork).gfx_current_identifier : \
600 (type) == ARTWORK_TYPE_SOUNDS ? \
601 (artwork).snd_current_identifier : \
602 (artwork).mus_current_identifier)
604 #define ARTWORKINFO_FILENAME(type) \
605 ((type) == ARTWORK_TYPE_GRAPHICS ? \
606 GRAPHICSINFO_FILENAME : \
607 (type) == ARTWORK_TYPE_SOUNDS ? \
608 SOUNDSINFO_FILENAME : \
609 (type) == ARTWORK_TYPE_MUSIC ? \
610 MUSICINFO_FILENAME : "")
612 #define ARTWORK_DIRECTORY(type) \
613 ((type) == ARTWORK_TYPE_GRAPHICS ? \
614 GRAPHICS_DIRECTORY : \
615 (type) == ARTWORK_TYPE_SOUNDS ? \
617 (type) == ARTWORK_TYPE_MUSIC ? \
618 MUSIC_DIRECTORY : "")
620 #define OPTIONS_ARTWORK_DIRECTORY(type) \
621 ((type) == ARTWORK_TYPE_GRAPHICS ? \
622 options.graphics_directory : \
623 (type) == ARTWORK_TYPE_SOUNDS ? \
624 options.sounds_directory : \
625 (type) == ARTWORK_TYPE_MUSIC ? \
626 options.music_directory : "")
628 #define UPDATE_BUSY_STATE() \
630 if (gfx.draw_busy_anim_function != NULL) \
631 gfx.draw_busy_anim_function(); \
635 /* type definitions */
636 typedef int (*EventFilter)(const Event *);
639 /* structure definitions */
643 char *command_basepath; /* directory that contains the program */
644 char *command_basename; /* base filename of the program binary */
646 char *userdata_subdir; /* personal user game data directory */
647 char *userdata_subdir_unix; /* personal user game data directory (Unix) */
648 char *userdata_path; /* resulting full path to game data directory */
654 char *x11_icon_filename;
655 char *x11_iconmask_filename;
656 char *sdl_icon_filename;
657 char *msdos_cursor_filename;
660 char *filename_prefix; /* prefix to cut off from DOS filenames */
662 char *error_filename; /* filename where to write error messages to */
663 FILE *error_file; /* (used instead of 'stderr' on some systems) */
669 void (*exit_function)(int);
678 char *ro_base_directory;
679 char *rw_base_directory;
680 char *level_directory;
681 char *graphics_directory;
682 char *sounds_directory;
683 char *music_directory;
684 char *docs_directory;
686 char *execute_command;
694 boolean debug_x11_sync;
697 struct ScreenModeInfo
702 struct VideoSystemInfo
705 int width, height, depth;
707 boolean fullscreen_available;
708 boolean fullscreen_enabled;
709 struct ScreenModeInfo *fullscreen_modes;
710 char *fullscreen_mode_current;
713 struct AudioSystemInfo
715 boolean sound_available;
716 boolean loops_available;
717 boolean music_available;
719 boolean sound_enabled;
720 boolean sound_deactivated; /* for temporarily disabling sound */
729 int first_sound_channel;
732 struct FontBitmapInfo
736 int src_x, src_y; /* start position of animation frames */
737 int width, height; /* width/height of each animation frame */
739 int draw_xoffset; /* offset for drawing font characters */
740 int draw_yoffset; /* offset for drawing font characters */
743 int num_chars_per_line;
745 #if defined(TARGET_X11_NATIVE_PERFORMANCE_WORKAROUND)
746 Pixmap *clip_mask; /* single-char-only clip mask array for X11 */
754 int real_sx, real_sy;
755 int full_sxsize, full_sysize;
756 int scrollbuffer_width, scrollbuffer_height;
764 int win_xsize, win_ysize;
766 int draw_deactivation_mask;
767 int draw_background_mask;
769 Bitmap *field_save_buffer;
771 Bitmap *background_bitmap;
772 int background_bitmap_mask;
774 boolean clipping_enabled;
776 int clip_width, clip_height;
778 boolean override_level_graphics;
779 boolean override_level_sounds;
780 boolean override_level_music;
782 boolean draw_init_text;
785 struct FontBitmapInfo *font_bitmap_info;
786 int (*select_font_function)(int);
787 int (*get_font_from_token_function)(char *);
789 int anim_random_frame;
791 void (*draw_busy_anim_function)(void);
797 int fd[MAX_PLAYERS]; /* file descriptor of player's joystick */
800 struct SetupJoystickInfo
802 char *device_name; /* device name of player's joystick */
804 int xleft, xmiddle, xright;
805 int yupper, ymiddle, ylower;
809 struct SetupKeyboardInfo
811 Key left, right, up, down;
815 struct SetupInputInfo
817 boolean use_joystick;
818 struct SetupJoystickInfo joy;
819 struct SetupKeyboardInfo key;
822 struct SetupEditorInfo
824 boolean el_boulderdash;
825 boolean el_emerald_mine;
826 boolean el_emerald_mine_club;
830 boolean el_diamond_caves;
831 boolean el_dx_boulderdash;
833 boolean el_steel_chars;
835 boolean el_user_defined;
838 boolean el_headlines;
843 boolean show_element_token;
846 struct SetupEditorCascadeInfo
857 boolean el_steel_chars;
865 struct SetupShortcutInfo
871 Key focus_player[MAX_PLAYERS];
872 Key focus_player_all;
891 struct SetupSystemInfo
893 char *sdl_videodriver;
894 char *sdl_audiodriver;
895 int audio_fragment_size;
905 boolean sound_simple;
907 boolean scroll_delay;
908 boolean scroll_delay_value;
909 boolean soft_scrolling;
910 boolean fade_screens;
912 boolean show_titlescreen;
919 char *fullscreen_mode;
920 boolean ask_on_escape;
921 boolean ask_on_escape_editor;
922 boolean quick_switch;
923 boolean input_on_focus;
924 boolean prefer_aga_graphics;
925 int game_frame_delay;
926 boolean sp_show_border_elements;
927 boolean small_game_graphics;
932 int override_level_graphics; /* not boolean -- can also be "AUTO" */
933 int override_level_sounds; /* not boolean -- can also be "AUTO" */
934 int override_level_music; /* not boolean -- can also be "AUTO" */
936 struct SetupEditorInfo editor;
937 struct SetupEditorCascadeInfo editor_cascade;
938 struct SetupShortcutInfo shortcut;
939 struct SetupInputInfo input[MAX_PLAYERS];
940 struct SetupSystemInfo system;
941 struct OptionInfo options;
946 struct TreeInfo **node_top; /* topmost node in tree */
947 struct TreeInfo *node_parent; /* parent level directory info */
948 struct TreeInfo *node_group; /* level group sub-directory info */
949 struct TreeInfo *next; /* next level series structure node */
951 int cl_first; /* internal control field for setup screen */
952 int cl_cursor; /* internal control field for setup screen */
954 int type; /* type of tree content */
956 /* fields for "type == TREE_TYPE_LEVEL_DIR" */
958 char *subdir; /* tree info sub-directory basename (may be ".") */
959 char *fullpath; /* complete path relative to tree base directory */
960 char *basepath; /* absolute base path of tree base directory */
961 char *identifier; /* identifier string for configuration files */
962 char *name; /* tree info name, as displayed in selection menues */
963 char *name_sorting; /* optional sorting name for correct name sorting */
964 char *author; /* level or artwork author name */
965 char *year; /* optional year of creation for levels or artwork */
966 char *imported_from; /* optional comment for imported levels or artwork */
967 char *imported_by; /* optional comment for imported levels or artwork */
968 char *tested_by; /* optional comment to name people who tested a set */
970 char *graphics_set_ecs; /* special EMC custom graphics set (ECS graphics) */
971 char *graphics_set_aga; /* special EMC custom graphics set (AGA graphics) */
972 char *graphics_set; /* optional custom graphics set (level tree only) */
973 char *sounds_set; /* optional custom sounds set (level tree only) */
974 char *music_set; /* optional custom music set (level tree only) */
975 char *graphics_path; /* path to optional custom graphics set (level only) */
976 char *sounds_path; /* path to optional custom sounds set (level only) */
977 char *music_path; /* path to optional custom music set (level only) */
979 char *level_filename; /* filename of level file (for packed level file) */
980 char *level_filetype; /* type of levels in level directory or level file */
982 char *special_flags; /* flags for special actions performed on level file */
984 int levels; /* number of levels in level series */
985 int first_level; /* first level number (to allow start with 0 or 1) */
986 int last_level; /* last level number (automatically calculated) */
987 int sort_priority; /* sort levels by 'sort_priority' and then by name */
989 boolean latest_engine;/* force level set to use the latest game engine */
991 boolean level_group; /* directory contains more level series directories */
992 boolean parent_link; /* entry links back to parent directory */
993 boolean in_user_dir; /* user defined levels are stored in home directory */
994 boolean user_defined; /* levels in user directory and marked as "private" */
995 boolean readonly; /* readonly levels can not be changed with editor */
996 boolean handicap; /* level set has no handicap when set to "false" */
997 boolean skip_levels; /* levels can be skipped when set to "true" */
999 int color; /* color to use on selection screen for this level */
1000 char *class_desc; /* description of level series class */
1001 int handicap_level; /* number of the lowest unsolved level */
1003 char *infotext; /* optional text to describe the tree type (headline) */
1006 typedef struct TreeInfo TreeInfo;
1007 typedef struct TreeInfo LevelDirTree;
1008 typedef struct TreeInfo ArtworkDirTree;
1009 typedef struct TreeInfo GraphicsDirTree;
1010 typedef struct TreeInfo SoundsDirTree;
1011 typedef struct TreeInfo MusicDirTree;
1015 GraphicsDirTree *gfx_first;
1016 GraphicsDirTree *gfx_current;
1017 SoundsDirTree *snd_first;
1018 SoundsDirTree *snd_current;
1019 MusicDirTree *mus_first;
1020 MusicDirTree *mus_current;
1022 char *gfx_current_identifier;
1023 char *snd_current_identifier;
1024 char *mus_current_identifier;
1027 struct ValueTextInfo
1039 struct ConfigTypeInfo
1046 struct TokenIntPtrInfo
1056 char *default_filename;
1059 char **default_parameter; /* array of file parameters */
1060 char **parameter; /* array of file parameters */
1063 boolean fallback_to_default;
1064 boolean default_is_cloned;
1067 struct SetupFileList
1072 struct SetupFileList *next;
1077 char *source_filename; /* primary key for node list */
1081 struct PropertyMapping
1091 struct ArtworkListInfo
1093 int type; /* type of artwork */
1095 int num_file_list_entries;
1096 int num_dynamic_file_list_entries;
1097 struct FileInfo *file_list; /* static artwork file array */
1098 struct FileInfo *dynamic_file_list; /* dynamic artwrk file array */
1100 int num_suffix_list_entries;
1101 struct ConfigTypeInfo *suffix_list; /* parameter suffixes array */
1103 int num_base_prefixes;
1104 int num_ext1_suffixes;
1105 int num_ext2_suffixes;
1106 int num_ext3_suffixes;
1107 char **base_prefixes; /* base token prefixes array */
1108 char **ext1_suffixes; /* property suffixes array 1 */
1109 char **ext2_suffixes; /* property suffixes array 2 */
1110 char **ext3_suffixes; /* property suffixes array 3 */
1112 int num_ignore_tokens;
1113 char **ignore_tokens; /* file tokens to be ignored */
1115 int num_property_mapping_entries;
1116 struct PropertyMapping *property_mapping; /* mapping token -> artwork */
1118 int sizeof_artwork_list_entry;
1120 struct ListNodeInfo **artwork_list; /* static artwork node array */
1121 struct ListNodeInfo **dynamic_artwork_list; /* dynamic artwrk node array */
1122 struct ListNode *content_list; /* dynamic artwork node list */
1124 void *(*load_artwork)(char *); /* constructor function */
1125 void (*free_artwork)(void *); /* destructor function */
1139 struct RectWithBorder
1160 boolean draw_masked;
1172 /* ========================================================================= */
1173 /* exported variables */
1174 /* ========================================================================= */
1176 extern struct ProgramInfo program;
1177 extern struct OptionInfo options;
1178 extern struct VideoSystemInfo video;
1179 extern struct AudioSystemInfo audio;
1180 extern struct GfxInfo gfx;
1181 extern struct AnimInfo anim;
1182 extern struct ArtworkInfo artwork;
1183 extern struct JoystickInfo joystick;
1184 extern struct SetupInfo setup;
1186 extern LevelDirTree *leveldir_first_all;
1187 extern LevelDirTree *leveldir_first;
1188 extern LevelDirTree *leveldir_current;
1189 extern int level_nr;
1191 extern struct LevelStats level_stats[];
1193 extern Display *display;
1194 extern Visual *visual;
1196 extern Colormap cmap;
1198 extern DrawWindow *window;
1199 extern DrawBuffer *backbuffer;
1200 extern DrawBuffer *drawto;
1202 extern int button_status;
1203 extern boolean motion_status;
1205 extern int redraw_mask;
1206 extern int redraw_tiles;
1208 extern int FrameCounter;
1211 /* function definitions */
1213 void InitProgramInfo(char *, char *, char *, char *, char *, char *, char *,
1214 char *, char *, char *, char *, char *, int);
1216 void InitExitFunction(void (*exit_function)(int));
1217 void InitPlatformDependentStuff(void);
1218 void ClosePlatformDependentStuff(void);
1220 void InitGfxFieldInfo(int, int, int, int, int, int, int, int, Bitmap *);
1221 void InitGfxDoor1Info(int, int, int, int);
1222 void InitGfxDoor2Info(int, int, int, int);
1223 void InitGfxWindowInfo(int, int);
1224 void InitGfxScrollbufferInfo(int, int);
1225 void InitGfxClipRegion(boolean, int, int, int, int);
1226 void InitGfxDrawBusyAnimFunction(void (*draw_busy_anim_function)(void));
1227 void InitGfxCustomArtworkInfo();
1228 void SetDrawDeactivationMask(int);
1229 void SetDrawBackgroundMask(int);
1230 void SetWindowBackgroundBitmap(Bitmap *);
1231 void SetMainBackgroundBitmap(Bitmap *);
1232 void SetDoorBackgroundBitmap(Bitmap *);
1234 void InitVideoDisplay(void);
1235 void CloseVideoDisplay(void);
1236 void InitVideoBuffer(int, int, int, boolean);
1237 Bitmap *CreateBitmapStruct(void);
1238 Bitmap *CreateBitmap(int, int, int);
1239 void ReCreateBitmap(Bitmap **, int, int, int);
1240 void FreeBitmap(Bitmap *);
1241 void BlitBitmap(Bitmap *, Bitmap *, int, int, int, int, int, int);
1242 void BlitBitmapTiled(Bitmap *, Bitmap *, int, int, int, int, int, int, int,int);
1243 void FadeRectangle(Bitmap *bitmap, int, int, int, int, int, int, int,
1244 void (*draw_border_function)(void));
1245 void FillRectangle(Bitmap *, int, int, int, int, Pixel);
1246 void ClearRectangle(Bitmap *, int, int, int, int);
1247 void ClearRectangleOnBackground(Bitmap *, int, int, int, int);
1248 void SetClipMask(Bitmap *, GC, Pixmap);
1249 void SetClipOrigin(Bitmap *, GC, int, int);
1250 void BlitBitmapMasked(Bitmap *, Bitmap *, int, int, int, int, int, int);
1251 boolean DrawingOnBackground(int, int);
1252 void BlitBitmapOnBackground(Bitmap *, Bitmap *, int, int, int, int, int, int);
1253 void DrawSimpleBlackLine(Bitmap *, int, int, int, int);
1254 void DrawSimpleWhiteLine(Bitmap *, int, int, int, int);
1255 void DrawLines(Bitmap *, struct XY *, int, Pixel);
1256 Pixel GetPixel(Bitmap *, int, int);
1257 Pixel GetPixelFromRGB(Bitmap *, unsigned int,unsigned int,unsigned int);
1258 Pixel GetPixelFromRGBcompact(Bitmap *, unsigned int);
1260 void FlushDisplay(void);
1261 void SyncDisplay(void);
1262 void KeyboardAutoRepeatOn(void);
1263 void KeyboardAutoRepeatOff(void);
1264 boolean PointerInWindow(DrawWindow *);
1265 boolean SetVideoMode(boolean);
1266 boolean ChangeVideoModeIfNeeded(boolean);
1268 Bitmap *LoadImage(char *);
1269 Bitmap *LoadCustomImage(char *);
1270 void ReloadCustomImage(Bitmap *, char *);
1272 Bitmap *ZoomBitmap(Bitmap *, int, int);
1273 void CreateBitmapWithSmallBitmaps(Bitmap *, int);
1274 void ScaleBitmap(Bitmap *, int);
1276 void SetMouseCursor(int);
1278 void OpenAudio(void);
1279 void CloseAudio(void);
1280 void SetAudioMode(boolean);
1282 void InitEventFilter(EventFilter);
1283 boolean PendingEvent(void);
1284 void NextEvent(Event *event);
1285 void PeekEvent(Event *event);
1286 Key GetEventKey(KeyEvent *, boolean);
1287 KeyMod HandleKeyModState(Key, int);
1288 KeyMod GetKeyModState();
1289 KeyMod GetKeyModStateFromEvents();
1290 boolean CheckCloseWindowEvent(ClientMessageEvent *);
1292 void InitJoysticks();
1293 boolean ReadJoystick(int, int *, int *, boolean *, boolean *);
1295 #endif /* SYSTEM_H */