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_STOP KSYM_UNDEFINED
77 #define DEFAULT_KEY_TAPE_PAUSE KSYM_UNDEFINED
78 #define DEFAULT_KEY_TAPE_RECORD KSYM_UNDEFINED
79 #define DEFAULT_KEY_TAPE_PLAY KSYM_UNDEFINED
80 #define DEFAULT_KEY_SOUND_SIMPLE KSYM_UNDEFINED
81 #define DEFAULT_KEY_SOUND_LOOPS KSYM_UNDEFINED
82 #define DEFAULT_KEY_SOUND_MUSIC KSYM_UNDEFINED
83 #define DEFAULT_KEY_SNAP_LEFT KSYM_UNDEFINED
84 #define DEFAULT_KEY_SNAP_RIGHT KSYM_UNDEFINED
85 #define DEFAULT_KEY_SNAP_UP KSYM_UNDEFINED
86 #define DEFAULT_KEY_SNAP_DOWN KSYM_UNDEFINED
88 /* values for key_status */
89 #define KEY_NOT_PRESSED FALSE
90 #define KEY_RELEASED FALSE
91 #define KEY_PRESSED TRUE
93 /* values for button status */
94 #define MB_NOT_PRESSED FALSE
95 #define MB_NOT_RELEASED TRUE
96 #define MB_RELEASED FALSE
97 #define MB_PRESSED TRUE
98 #define MB_MENU_CHOICE FALSE
99 #define MB_MENU_MARK TRUE
100 #define MB_MENU_INITIALIZE (-1)
101 #define MB_MENU_LEAVE (-2)
102 #define MB_LEFTBUTTON 1
103 #define MB_MIDDLEBUTTON 2
104 #define MB_RIGHTBUTTON 3
105 #define MB_WHEEL_UP 4
106 #define MB_WHEEL_DOWN 5
107 #define MB_WHEEL_LEFT 6
108 #define MB_WHEEL_RIGHT 7
109 #define IS_WHEEL_BUTTON_VERTICAL(b) ((b) >= MB_WHEEL_UP && \
110 (b) <= MB_WHEEL_DOWN)
111 #define IS_WHEEL_BUTTON_HORIZONTAL(b) ((b) >= MB_WHEEL_LEFT && \
112 (b) <= MB_WHEEL_RIGHT)
113 #define IS_WHEEL_BUTTON(b) ((b) >= MB_WHEEL_UP && \
114 (b) <= MB_WHEEL_DOWN)
115 #define DEFAULT_WHEEL_STEPS 3
117 /* values for move directions */
118 #define MV_BIT_LEFT 0
119 #define MV_BIT_RIGHT 1
121 #define MV_BIT_DOWN 3
123 #define NUM_DIRECTIONS 4
125 /* diagonal movement directions are used in a different contect than buttons */
126 #define MV_BIT_UPLEFT 4
127 #define MV_BIT_UPRIGHT 5
128 #define MV_BIT_DOWNLEFT 6
129 #define MV_BIT_DOWNRIGHT 7
131 #define NUM_DIRECTIONS_FULL 8
133 /* values for special "button" bitmasks */
137 #define NUM_PLAYER_ACTIONS 6
139 /* values for special "focus player" bitmasks */
140 #define BIT_SET_FOCUS 6
142 /* values for move directions and special "button" key bitmasks */
144 #define MV_LEFT (1 << MV_BIT_LEFT)
145 #define MV_RIGHT (1 << MV_BIT_RIGHT)
146 #define MV_UP (1 << MV_BIT_UP)
147 #define MV_DOWN (1 << MV_BIT_DOWN)
149 #define MV_UPLEFT (MV_UP | MV_LEFT)
150 #define MV_UPRIGHT (MV_UP | MV_RIGHT)
151 #define MV_DOWNLEFT (MV_DOWN | MV_LEFT)
152 #define MV_DOWNRIGHT (MV_DOWN | MV_RIGHT)
154 #define MV_HORIZONTAL (MV_LEFT | MV_RIGHT)
155 #define MV_VERTICAL (MV_UP | MV_DOWN)
156 #define MV_ALL_DIRECTIONS (MV_LEFT | MV_RIGHT | MV_UP | MV_DOWN)
157 #define MV_ANY_DIRECTION (MV_ALL_DIRECTIONS)
158 #define MV_NO_DIRECTION (MV_NONE)
160 #define KEY_BUTTON_1 (1 << BUTTON_1)
161 #define KEY_BUTTON_2 (1 << BUTTON_2)
162 #define KEY_BUTTON_SNAP KEY_BUTTON_1
163 #define KEY_BUTTON_DROP KEY_BUTTON_2
164 #define KEY_MOTION (MV_LEFT | MV_RIGHT | MV_UP | MV_DOWN)
165 #define KEY_BUTTON (KEY_BUTTON_1 | KEY_BUTTON_2)
166 #define KEY_ACTION (KEY_MOTION | KEY_BUTTON)
168 #define KEY_SET_FOCUS (1 << BIT_SET_FOCUS)
170 #define MV_DIR_FROM_BIT(x) ((x) < NUM_DIRECTIONS ? 1 << (x) : \
171 (x) == MV_BIT_UPLEFT ? MV_UPLEFT : \
172 (x) == MV_BIT_UPRIGHT ? MV_UPRIGHT : \
173 (x) == MV_BIT_DOWNLEFT ? MV_DOWNLEFT : \
174 (x) == MV_BIT_DOWNRIGHT ? MV_DOWNRIGHT : \
177 #define MV_DIR_TO_BIT(x) ((x) == MV_LEFT ? MV_BIT_LEFT : \
178 (x) == MV_RIGHT ? MV_BIT_RIGHT : \
179 (x) == MV_UP ? MV_BIT_UP : \
180 (x) == MV_DOWN ? MV_BIT_DOWN : \
181 (x) == MV_UPLEFT ? MV_BIT_UPLEFT : \
182 (x) == MV_UPRIGHT ? MV_BIT_UPRIGHT : \
183 (x) == MV_DOWNLEFT ? MV_BIT_DOWNLEFT : \
184 (x) == MV_DOWNRIGHT ? MV_BIT_DOWNRIGHT : \
187 #define MV_DIR_OPPOSITE(x) ((x) == MV_LEFT ? MV_RIGHT : \
188 (x) == MV_RIGHT ? MV_LEFT : \
189 (x) == MV_UP ? MV_DOWN : \
190 (x) == MV_DOWN ? MV_UP : \
191 (x) == MV_UPLEFT ? MV_DOWNRIGHT : \
192 (x) == MV_UPRIGHT ? MV_DOWNLEFT : \
193 (x) == MV_DOWNLEFT ? MV_UPRIGHT : \
194 (x) == MV_DOWNRIGHT ? MV_UPLEFT : \
197 /* values for animation mode (frame order and direction) */
199 #define ANIM_LOOP (1 << 0)
200 #define ANIM_LINEAR (1 << 1)
201 #define ANIM_PINGPONG (1 << 2)
202 #define ANIM_PINGPONG2 (1 << 3)
203 #define ANIM_RANDOM (1 << 4)
204 #define ANIM_CE_VALUE (1 << 5)
205 #define ANIM_CE_SCORE (1 << 6)
206 #define ANIM_CE_DELAY (1 << 7)
207 #define ANIM_REVERSE (1 << 8)
208 #define ANIM_OPAQUE_PLAYER (1 << 9)
210 /* values for special (non game element) animation modes */
211 #define ANIM_HORIZONTAL (1 << 10)
212 #define ANIM_VERTICAL (1 << 11)
213 #define ANIM_CENTERED (1 << 12)
214 #define ANIM_STATIC_PANEL (1 << 13)
216 #define ANIM_DEFAULT ANIM_LOOP
218 /* values for special drawing styles (currently only for crumbled graphics) */
220 #define STYLE_ACCURATE_BORDERS (1 << 0)
221 #define STYLE_INNER_CORNERS (1 << 1)
223 #define STYLE_DEFAULT STYLE_NONE
225 /* values for fade mode */
226 #define FADE_TYPE_NONE 0
227 #define FADE_TYPE_FADE_IN (1 << 0)
228 #define FADE_TYPE_FADE_OUT (1 << 1)
229 #define FADE_TYPE_TRANSFORM (1 << 2)
230 #define FADE_TYPE_CROSSFADE (1 << 3)
231 #define FADE_TYPE_MELT (1 << 4)
232 #define FADE_TYPE_SKIP (1 << 5)
234 #define FADE_MODE_NONE (FADE_TYPE_NONE)
235 #define FADE_MODE_FADE_IN (FADE_TYPE_FADE_IN)
236 #define FADE_MODE_FADE_OUT (FADE_TYPE_FADE_OUT)
237 #define FADE_MODE_FADE (FADE_TYPE_FADE_IN | FADE_TYPE_FADE_OUT)
238 #define FADE_MODE_TRANSFORM (FADE_TYPE_TRANSFORM | FADE_TYPE_FADE_IN)
239 #define FADE_MODE_CROSSFADE (FADE_MODE_TRANSFORM | FADE_TYPE_CROSSFADE)
240 #define FADE_MODE_MELT (FADE_MODE_TRANSFORM | FADE_TYPE_MELT)
241 #define FADE_MODE_SKIP_FADE_IN (FADE_TYPE_SKIP | FADE_TYPE_FADE_IN)
242 #define FADE_MODE_SKIP_FADE_OUT (FADE_TYPE_SKIP | FADE_TYPE_FADE_OUT)
244 #define FADE_MODE_DEFAULT FADE_MODE_FADE
246 /* values for text alignment */
247 #define ALIGN_LEFT (1 << 0)
248 #define ALIGN_RIGHT (1 << 1)
249 #define ALIGN_CENTER (1 << 2)
250 #define ALIGN_DEFAULT ALIGN_LEFT
252 #define VALIGN_TOP (1 << 0)
253 #define VALIGN_BOTTOM (1 << 1)
254 #define VALIGN_MIDDLE (1 << 2)
255 #define VALIGN_DEFAULT VALIGN_TOP
257 #define ALIGNED_XPOS(x,w,a) ((a) == ALIGN_CENTER ? (x) - (w) / 2 : \
258 (a) == ALIGN_RIGHT ? (x) - (w) : (x))
259 #define ALIGNED_YPOS(y,h,v) ((v) == VALIGN_MIDDLE ? (y) - (h) / 2 : \
260 (v) == VALIGN_BOTTOM ? (y) - (h) : (y))
261 #define ALIGNED_TEXT_XPOS(p) ALIGNED_XPOS((p)->x, (p)->width, (p)->align)
262 #define ALIGNED_TEXT_YPOS(p) ALIGNED_YPOS((p)->y, (p)->height, (p)->valign)
264 /* values for redraw_mask */
265 #define REDRAW_NONE (0)
266 #define REDRAW_ALL (1 << 0)
267 #define REDRAW_FIELD (1 << 1)
268 #define REDRAW_TILES (1 << 2)
269 #define REDRAW_DOOR_1 (1 << 3)
270 #define REDRAW_VIDEO_1 (1 << 4)
271 #define REDRAW_VIDEO_2 (1 << 5)
272 #define REDRAW_VIDEO_3 (1 << 6)
273 #define REDRAW_MICROLEVEL (1 << 7)
274 #define REDRAW_MICROLABEL (1 << 8)
275 #define REDRAW_FROM_BACKBUFFER (1 << 9)
276 #define REDRAW_DOOR_2 (REDRAW_VIDEO_1 | \
279 #define REDRAW_DOOR_3 (1 << 10)
280 #define REDRAW_DOORS (REDRAW_DOOR_1 | \
283 #define REDRAW_MAIN (REDRAW_FIELD | \
286 #define REDRAW_FPS (1 << 11)
287 #define REDRAWTILES_THRESHOLD (SCR_FIELDX * SCR_FIELDY / 2)
289 #define IN_GFX_SCREEN(x, y) (x >= gfx.sx && x < gfx.sx + gfx.sxsize && \
290 y >= gfx.sy && y < gfx.sy + gfx.sysize)
291 #define IN_GFX_DOOR(x, y) (x >= gfx.dx && x < gfx.dx + gfx.dxsize && \
292 y >= gfx.dy && y < gfx.dy + gfx.dysize)
293 #define IN_GFX_VIDEO(x, y) (x >= gfx.vx && x < gfx.vx + gfx.vxsize && \
294 y >= gfx.vy && y < gfx.vy + gfx.vysize)
296 /* values for mouse cursor */
297 #define CURSOR_DEFAULT 0
298 #define CURSOR_NONE 1
299 #define CURSOR_PLAYFIELD 2
301 /* fundamental game speed values */
302 #define ONE_SECOND_DELAY 1000 /* delay value for one second */
303 #define GAME_FRAME_DELAY 20 /* frame delay in milliseconds */
304 #define FFWD_FRAME_DELAY 10 /* 200% speed for fast forward */
305 #define FRAMES_PER_SECOND (ONE_SECOND_DELAY / GAME_FRAME_DELAY)
307 /* maximum playfield size supported by libgame functions */
308 #define MAX_PLAYFIELD_WIDTH 128
309 #define MAX_PLAYFIELD_HEIGHT 128
311 /* maximum number of parallel players supported by libgame functions */
312 #define MAX_PLAYERS 4
314 /* maximum allowed length of player name */
315 #define MAX_PLAYER_NAME_LEN 10
317 /* default name for empty highscore entry */
318 #define EMPTY_PLAYER_NAME "no name"
320 /* default name for unknown player names */
321 #define ANONYMOUS_NAME "anonymous"
323 /* default for other unknown names */
324 #define UNKNOWN_NAME "unknown"
326 /* default name for new levels */
327 #define NAMELESS_LEVEL_NAME "nameless level"
329 /* default text for non-existant artwork */
330 #define NOT_AVAILABLE "(not available)"
332 /* default value for undefined filename */
333 #define UNDEFINED_FILENAME "[NONE]"
335 /* default value for undefined parameter */
336 #define ARG_DEFAULT "[DEFAULT]"
338 /* default values for undefined configuration file parameters */
339 #define ARG_UNDEFINED "-1000000"
340 #define ARG_UNDEFINED_VALUE (atoi(ARG_UNDEFINED))
342 /* definitions for game sub-directories */
344 #define RO_GAME_DIR "."
348 #define RW_GAME_DIR "."
351 #define RO_BASE_PATH RO_GAME_DIR
352 #define RW_BASE_PATH RW_GAME_DIR
354 /* directory names */
355 #define GRAPHICS_DIRECTORY "graphics"
356 #define SOUNDS_DIRECTORY "sounds"
357 #define MUSIC_DIRECTORY "music"
358 #define LEVELS_DIRECTORY "levels"
359 #define TAPES_DIRECTORY "tapes"
360 #define SCORES_DIRECTORY "scores"
361 #define DOCS_DIRECTORY "docs"
362 #define CACHE_DIRECTORY "cache"
364 #if !defined(PLATFORM_MSDOS)
365 #define GFX_CLASSIC_SUBDIR "gfx_classic"
366 #define SND_CLASSIC_SUBDIR "snd_classic"
367 #define MUS_CLASSIC_SUBDIR "mus_classic"
369 #define GFX_CLASSIC_SUBDIR "gfx_orig"
370 #define SND_CLASSIC_SUBDIR "snd_orig"
371 #define MUS_CLASSIC_SUBDIR "mus_orig"
374 #if defined(CREATE_SPECIAL_EDITION_RND_JUE)
375 #define GFX_DEFAULT_SUBDIR "jue0"
376 #define SND_DEFAULT_SUBDIR "jue0"
377 #define MUS_DEFAULT_SUBDIR "jue0"
379 #define GFX_DEFAULT_SUBDIR GFX_CLASSIC_SUBDIR
380 #define SND_DEFAULT_SUBDIR SND_CLASSIC_SUBDIR
381 #define MUS_DEFAULT_SUBDIR MUS_CLASSIC_SUBDIR
384 #if defined(CREATE_SPECIAL_EDITION)
385 #define GFX_FALLBACK_FILENAME "fallback.pcx"
386 #define SND_FALLBACK_FILENAME "fallback.wav"
387 #define MUS_FALLBACK_FILENAME "fallback.wav"
390 /* file names and filename extensions */
391 #if !defined(PLATFORM_MSDOS)
392 #define LEVELSETUP_DIRECTORY "levelsetup"
393 #define SETUP_FILENAME "setup.conf"
394 #define LEVELSETUP_FILENAME "levelsetup.conf"
395 #define EDITORSETUP_FILENAME "editorsetup.conf"
396 #define EDITORCASCADE_FILENAME "editorcascade.conf"
397 #define HELPANIM_FILENAME "helpanim.conf"
398 #define HELPTEXT_FILENAME "helptext.conf"
399 #define LEVELINFO_FILENAME "levelinfo.conf"
400 #define GRAPHICSINFO_FILENAME "graphicsinfo.conf"
401 #define SOUNDSINFO_FILENAME "soundsinfo.conf"
402 #define MUSICINFO_FILENAME "musicinfo.conf"
403 #define ARTWORKINFO_CACHE_FILE "artworkinfo.cache"
404 #define LEVELFILE_EXTENSION "level"
405 #define TAPEFILE_EXTENSION "tape"
406 #define SCOREFILE_EXTENSION "score"
408 #define LEVELSETUP_DIRECTORY "lvlsetup"
409 #define SETUP_FILENAME "setup.cnf"
410 #define LEVELSETUP_FILENAME "lvlsetup.cnf"
411 #define EDITORSETUP_FILENAME "edsetup.cnf"
412 #define EDITORCASCADE_FILENAME "edcascad.conf"
413 #define HELPANIM_FILENAME "helpanim.cnf"
414 #define HELPTEXT_FILENAME "helptext.cnf"
415 #define LEVELINFO_FILENAME "lvlinfo.cnf"
416 #define GRAPHICSINFO_FILENAME "gfxinfo.cnf"
417 #define SOUNDSINFO_FILENAME "sndinfo.cnf"
418 #define MUSICINFO_FILENAME "musinfo.cnf"
419 #define ARTWORKINFO_CACHE_FILE "artinfo.cac"
420 #define LEVELFILE_EXTENSION "lvl"
421 #define TAPEFILE_EXTENSION "tap"
422 #define SCOREFILE_EXTENSION "sco"
425 #define ERROR_BASENAME "stderr.txt"
427 #define CHAR_PATH_SEPARATOR_UNIX '/'
428 #define CHAR_PATH_SEPARATOR_DOS '\\'
430 #define STRING_PATH_SEPARATOR_UNIX "/"
431 #define STRING_PATH_SEPARATOR_DOS "\\"
433 #define STRING_NEWLINE_UNIX "\n"
434 #define STRING_NEWLINE_DOS "\r\n"
436 #if defined(PLATFORM_WIN32) || defined(PLATFORM_MSDOS)
437 #define CHAR_PATH_SEPARATOR CHAR_PATH_SEPARATOR_DOS
438 #define STRING_PATH_SEPARATOR STRING_PATH_SEPARATOR_DOS
439 #define STRING_NEWLINE STRING_NEWLINE_DOS
441 #define CHAR_PATH_SEPARATOR CHAR_PATH_SEPARATOR_UNIX
442 #define STRING_PATH_SEPARATOR STRING_PATH_SEPARATOR_UNIX
443 #define STRING_NEWLINE STRING_NEWLINE_UNIX
447 /* areas in bitmap PIX_DOOR */
448 /* meaning in PIX_DB_DOOR: (3 PAGEs)
449 PAGEX1: 1. buffer for DOOR_1
450 PAGEX2: 2. buffer for DOOR_1
451 PAGEX3: buffer for animations
454 /* these values are hard-coded to be able to use them in initialization */
455 #define DOOR_GFX_PAGE_WIDTH 100 /* should be set to "gfx.dxsize" */
456 #define DOOR_GFX_PAGE_HEIGHT 280 /* should be set to "gfx.dysize" */
458 #define DOOR_GFX_PAGESIZE (DOOR_GFX_PAGE_WIDTH)
459 #define DOOR_GFX_PAGEX1 (0 * DOOR_GFX_PAGESIZE)
460 #define DOOR_GFX_PAGEX2 (1 * DOOR_GFX_PAGESIZE)
461 #define DOOR_GFX_PAGEX3 (2 * DOOR_GFX_PAGESIZE)
462 #define DOOR_GFX_PAGEX4 (3 * DOOR_GFX_PAGESIZE)
463 #define DOOR_GFX_PAGEX5 (4 * DOOR_GFX_PAGESIZE)
464 #define DOOR_GFX_PAGEX6 (5 * DOOR_GFX_PAGESIZE)
465 #define DOOR_GFX_PAGEX7 (6 * DOOR_GFX_PAGESIZE)
466 #define DOOR_GFX_PAGEX8 (7 * DOOR_GFX_PAGESIZE)
467 #define DOOR_GFX_PAGEY1 (0)
468 #define DOOR_GFX_PAGEY2 (DOOR_GFX_PAGE_HEIGHT)
471 /* macros for version handling */
472 #define VERSION_MAJOR(x) ((x) / 1000000)
473 #define VERSION_MINOR(x) (((x) % 1000000) / 10000)
474 #define VERSION_PATCH(x) (((x) % 10000) / 100)
475 #define VERSION_BUILD(x) ((x) % 100)
476 #define VERSION_IDENT(a,b,c,d) ((a) * 1000000 + (b) * 10000 + (c) * 100 + (d))
479 /* macros for parent/child process identification */
480 #if defined(PLATFORM_UNIX)
481 #define IS_PARENT_PROCESS() (audio.mixer_pid != getpid())
482 #define IS_CHILD_PROCESS() (audio.mixer_pid == getpid())
483 #define HAS_CHILD_PROCESS() (audio.mixer_pid > 0)
485 #define IS_PARENT_PROCESS() TRUE
486 #define IS_CHILD_PROCESS() FALSE
487 #define HAS_CHILD_PROCESS() FALSE
491 /* values for artwork type */
492 #define ARTWORK_TYPE_GRAPHICS 0
493 #define ARTWORK_TYPE_SOUNDS 1
494 #define ARTWORK_TYPE_MUSIC 2
496 #define NUM_ARTWORK_TYPES 3
499 /* values for tree type (chosen to match artwork type) */
500 #define TREE_TYPE_UNDEFINED -1
501 #define TREE_TYPE_GRAPHICS_DIR ARTWORK_TYPE_GRAPHICS
502 #define TREE_TYPE_SOUNDS_DIR ARTWORK_TYPE_SOUNDS
503 #define TREE_TYPE_MUSIC_DIR ARTWORK_TYPE_MUSIC
504 #define TREE_TYPE_LEVEL_DIR 3
506 #define NUM_TREE_TYPES 4
508 #define INFOTEXT_UNDEFINED ""
509 #define INFOTEXT_GRAPHICS_DIR "Custom Graphics"
510 #define INFOTEXT_SOUNDS_DIR "Custom Sounds"
511 #define INFOTEXT_MUSIC_DIR "Custom Music"
512 #define INFOTEXT_LEVEL_DIR "Level Sets"
514 #define TREE_INFOTEXT(t) ((t) == TREE_TYPE_LEVEL_DIR ? \
515 INFOTEXT_LEVEL_DIR : \
516 (t) == TREE_TYPE_GRAPHICS_DIR ? \
517 INFOTEXT_GRAPHICS_DIR : \
518 (t) == TREE_TYPE_SOUNDS_DIR ? \
519 INFOTEXT_SOUNDS_DIR : \
520 (t) == TREE_TYPE_MUSIC_DIR ? \
521 INFOTEXT_MUSIC_DIR : \
524 /* values for artwork handling */
525 #define LEVELDIR_ARTWORK_SET_PTR(leveldir, type) \
526 ((type) == ARTWORK_TYPE_GRAPHICS ? \
527 &(leveldir)->graphics_set : \
528 (type) == ARTWORK_TYPE_SOUNDS ? \
529 &(leveldir)->sounds_set : \
530 &(leveldir)->music_set)
532 #define LEVELDIR_ARTWORK_SET(leveldir, type) \
533 ((type) == ARTWORK_TYPE_GRAPHICS ? \
534 (leveldir)->graphics_set : \
535 (type) == ARTWORK_TYPE_SOUNDS ? \
536 (leveldir)->sounds_set : \
537 (leveldir)->music_set)
539 #define LEVELDIR_ARTWORK_PATH_PTR(leveldir, type) \
540 ((type) == ARTWORK_TYPE_GRAPHICS ? \
541 &(leveldir)->graphics_path : \
542 (type) == ARTWORK_TYPE_SOUNDS ? \
543 &(leveldir)->sounds_path : \
544 &(leveldir)->music_path)
546 #define LEVELDIR_ARTWORK_PATH(leveldir, type) \
547 ((type) == ARTWORK_TYPE_GRAPHICS ? \
548 (leveldir)->graphics_path : \
549 (type) == ARTWORK_TYPE_SOUNDS ? \
550 (leveldir)->sounds_path : \
551 (leveldir)->music_path)
553 #define SETUP_ARTWORK_SET(setup, type) \
554 ((type) == ARTWORK_TYPE_GRAPHICS ? \
555 (setup).graphics_set : \
556 (type) == ARTWORK_TYPE_SOUNDS ? \
557 (setup).sounds_set : \
560 #define SETUP_OVERRIDE_ARTWORK(setup, type) \
561 ((type) == ARTWORK_TYPE_GRAPHICS ? \
562 (setup).override_level_graphics : \
563 (type) == ARTWORK_TYPE_SOUNDS ? \
564 (setup).override_level_sounds : \
565 (setup).override_level_music)
567 #define GFX_OVERRIDE_ARTWORK(type) \
568 ((type) == ARTWORK_TYPE_GRAPHICS ? \
569 gfx.override_level_graphics : \
570 (type) == ARTWORK_TYPE_SOUNDS ? \
571 gfx.override_level_sounds : \
572 gfx.override_level_music)
574 #define ARTWORK_FIRST_NODE(artwork, type) \
575 ((type) == ARTWORK_TYPE_GRAPHICS ? \
576 (artwork).gfx_first : \
577 (type) == ARTWORK_TYPE_SOUNDS ? \
578 (artwork).snd_first : \
581 #define ARTWORK_CURRENT_IDENTIFIER_PTR(artwork, type) \
582 ((type) == ARTWORK_TYPE_GRAPHICS ? \
583 &(artwork).gfx_current_identifier : \
584 (type) == ARTWORK_TYPE_SOUNDS ? \
585 &(artwork).snd_current_identifier : \
586 &(artwork).mus_current_identifier)
588 #define ARTWORK_CURRENT_IDENTIFIER(artwork, type) \
589 ((type) == ARTWORK_TYPE_GRAPHICS ? \
590 (artwork).gfx_current_identifier : \
591 (type) == ARTWORK_TYPE_SOUNDS ? \
592 (artwork).snd_current_identifier : \
593 (artwork).mus_current_identifier)
595 #define ARTWORKINFO_FILENAME(type) \
596 ((type) == ARTWORK_TYPE_GRAPHICS ? \
597 GRAPHICSINFO_FILENAME : \
598 (type) == ARTWORK_TYPE_SOUNDS ? \
599 SOUNDSINFO_FILENAME : \
600 (type) == ARTWORK_TYPE_MUSIC ? \
601 MUSICINFO_FILENAME : "")
603 #define ARTWORK_DIRECTORY(type) \
604 ((type) == ARTWORK_TYPE_GRAPHICS ? \
605 GRAPHICS_DIRECTORY : \
606 (type) == ARTWORK_TYPE_SOUNDS ? \
608 (type) == ARTWORK_TYPE_MUSIC ? \
609 MUSIC_DIRECTORY : "")
611 #define OPTIONS_ARTWORK_DIRECTORY(type) \
612 ((type) == ARTWORK_TYPE_GRAPHICS ? \
613 options.graphics_directory : \
614 (type) == ARTWORK_TYPE_SOUNDS ? \
615 options.sounds_directory : \
616 (type) == ARTWORK_TYPE_MUSIC ? \
617 options.music_directory : "")
619 #define UPDATE_BUSY_STATE() \
621 if (gfx.draw_busy_anim_function != NULL) \
622 gfx.draw_busy_anim_function(); \
626 /* type definitions */
627 typedef int (*EventFilter)(const Event *);
630 /* structure definitions */
634 char *command_basepath; /* directory that contains the program */
635 char *command_basename; /* base filename of the program binary */
637 char *userdata_subdir; /* personal user game data directory */
638 char *userdata_subdir_unix; /* personal user game data directory (Unix) */
639 char *userdata_path; /* resulting full path to game data directory */
645 char *x11_icon_filename;
646 char *x11_iconmask_filename;
647 char *sdl_icon_filename;
648 char *msdos_cursor_filename;
651 char *filename_prefix; /* prefix to cut off from DOS filenames */
653 char *error_filename; /* filename where to write error messages to */
654 FILE *error_file; /* (used instead of 'stderr' on some systems) */
660 void (*exit_function)(int);
669 char *ro_base_directory;
670 char *rw_base_directory;
671 char *level_directory;
672 char *graphics_directory;
673 char *sounds_directory;
674 char *music_directory;
675 char *docs_directory;
677 char *execute_command;
685 boolean debug_x11_sync;
688 struct ScreenModeInfo
693 struct VideoSystemInfo
696 int width, height, depth;
698 boolean fullscreen_available;
699 boolean fullscreen_enabled;
700 struct ScreenModeInfo *fullscreen_modes;
701 char *fullscreen_mode_current;
704 struct AudioSystemInfo
706 boolean sound_available;
707 boolean loops_available;
708 boolean music_available;
710 boolean sound_enabled;
711 boolean sound_deactivated; /* for temporarily disabling sound */
720 int first_sound_channel;
723 struct FontBitmapInfo
727 int src_x, src_y; /* start position of animation frames */
728 int width, height; /* width/height of each animation frame */
730 int draw_xoffset; /* offset for drawing font characters */
731 int draw_yoffset; /* offset for drawing font characters */
734 int num_chars_per_line;
736 #if defined(TARGET_X11_NATIVE_PERFORMANCE_WORKAROUND)
737 Pixmap *clip_mask; /* single-char-only clip mask array for X11 */
745 int real_sx, real_sy;
746 int full_sxsize, full_sysize;
747 int scrollbuffer_width, scrollbuffer_height;
755 int win_xsize, win_ysize;
757 int draw_deactivation_mask;
758 int draw_background_mask;
760 Bitmap *field_save_buffer;
762 Bitmap *background_bitmap;
763 int background_bitmap_mask;
765 boolean clipping_enabled;
767 int clip_width, clip_height;
769 boolean override_level_graphics;
770 boolean override_level_sounds;
771 boolean override_level_music;
773 boolean draw_init_text;
776 struct FontBitmapInfo *font_bitmap_info;
777 int (*select_font_function)(int);
778 int (*get_font_from_token_function)(char *);
780 int anim_random_frame;
782 void (*draw_busy_anim_function)(void);
788 int fd[MAX_PLAYERS]; /* file descriptor of player's joystick */
791 struct SetupJoystickInfo
793 char *device_name; /* device name of player's joystick */
795 int xleft, xmiddle, xright;
796 int yupper, ymiddle, ylower;
800 struct SetupKeyboardInfo
802 Key left, right, up, down;
806 struct SetupInputInfo
808 boolean use_joystick;
809 struct SetupJoystickInfo joy;
810 struct SetupKeyboardInfo key;
813 struct SetupEditorInfo
815 boolean el_boulderdash;
816 boolean el_emerald_mine;
817 boolean el_emerald_mine_club;
821 boolean el_diamond_caves;
822 boolean el_dx_boulderdash;
824 boolean el_steel_chars;
826 boolean el_user_defined;
829 boolean el_headlines;
834 boolean show_element_token;
837 struct SetupEditorCascadeInfo
848 boolean el_steel_chars;
856 struct SetupShortcutInfo
862 Key focus_player[MAX_PLAYERS];
863 Key focus_player_all;
881 struct SetupSystemInfo
883 char *sdl_videodriver;
884 char *sdl_audiodriver;
885 int audio_fragment_size;
895 boolean sound_simple;
897 boolean scroll_delay;
898 boolean scroll_delay_value;
899 boolean soft_scrolling;
900 boolean fade_screens;
902 boolean show_titlescreen;
909 char *fullscreen_mode;
910 boolean ask_on_escape;
911 boolean ask_on_escape_editor;
912 boolean quick_switch;
913 boolean input_on_focus;
914 boolean prefer_aga_graphics;
915 int game_frame_delay;
916 boolean sp_show_border_elements;
921 int override_level_graphics; /* not boolean -- can also be "AUTO" */
922 int override_level_sounds; /* not boolean -- can also be "AUTO" */
923 int override_level_music; /* not boolean -- can also be "AUTO" */
925 struct SetupEditorInfo editor;
926 struct SetupEditorCascadeInfo editor_cascade;
927 struct SetupShortcutInfo shortcut;
928 struct SetupInputInfo input[MAX_PLAYERS];
929 struct SetupSystemInfo system;
930 struct OptionInfo options;
935 struct TreeInfo **node_top; /* topmost node in tree */
936 struct TreeInfo *node_parent; /* parent level directory info */
937 struct TreeInfo *node_group; /* level group sub-directory info */
938 struct TreeInfo *next; /* next level series structure node */
940 int cl_first; /* internal control field for setup screen */
941 int cl_cursor; /* internal control field for setup screen */
943 int type; /* type of tree content */
945 /* fields for "type == TREE_TYPE_LEVEL_DIR" */
947 char *subdir; /* tree info sub-directory basename (may be ".") */
948 char *fullpath; /* complete path relative to tree base directory */
949 char *basepath; /* absolute base path of tree base directory */
950 char *identifier; /* identifier string for configuration files */
951 char *name; /* tree info name, as displayed in selection menues */
952 char *name_sorting; /* optional sorting name for correct name sorting */
953 char *author; /* level or artwork author name */
954 char *year; /* optional year of creation for levels or artwork */
955 char *imported_from; /* optional comment for imported levels or artwork */
956 char *imported_by; /* optional comment for imported levels or artwork */
957 char *tested_by; /* optional comment to name people who tested a set */
959 char *graphics_set_ecs; /* special EMC custom graphics set (ECS graphics) */
960 char *graphics_set_aga; /* special EMC custom graphics set (AGA graphics) */
961 char *graphics_set; /* optional custom graphics set (level tree only) */
962 char *sounds_set; /* optional custom sounds set (level tree only) */
963 char *music_set; /* optional custom music set (level tree only) */
964 char *graphics_path; /* path to optional custom graphics set (level only) */
965 char *sounds_path; /* path to optional custom sounds set (level only) */
966 char *music_path; /* path to optional custom music set (level only) */
968 char *level_filename; /* filename of level file (for packed level file) */
969 char *level_filetype; /* type of levels in level directory or level file */
971 char *special_flags; /* flags for special actions performed on level file */
973 int levels; /* number of levels in level series */
974 int first_level; /* first level number (to allow start with 0 or 1) */
975 int last_level; /* last level number (automatically calculated) */
976 int sort_priority; /* sort levels by 'sort_priority' and then by name */
978 boolean latest_engine;/* force level set to use the latest game engine */
980 boolean level_group; /* directory contains more level series directories */
981 boolean parent_link; /* entry links back to parent directory */
982 boolean in_user_dir; /* user defined levels are stored in home directory */
983 boolean user_defined; /* levels in user directory and marked as "private" */
984 boolean readonly; /* readonly levels can not be changed with editor */
985 boolean handicap; /* level set has no handicap when set to "false" */
986 boolean skip_levels; /* levels can be skipped when set to "true" */
988 int color; /* color to use on selection screen for this level */
989 char *class_desc; /* description of level series class */
990 int handicap_level; /* number of the lowest unsolved level */
992 char *infotext; /* optional text to describe the tree type (headline) */
995 typedef struct TreeInfo TreeInfo;
996 typedef struct TreeInfo LevelDirTree;
997 typedef struct TreeInfo ArtworkDirTree;
998 typedef struct TreeInfo GraphicsDirTree;
999 typedef struct TreeInfo SoundsDirTree;
1000 typedef struct TreeInfo MusicDirTree;
1004 GraphicsDirTree *gfx_first;
1005 GraphicsDirTree *gfx_current;
1006 SoundsDirTree *snd_first;
1007 SoundsDirTree *snd_current;
1008 MusicDirTree *mus_first;
1009 MusicDirTree *mus_current;
1011 char *gfx_current_identifier;
1012 char *snd_current_identifier;
1013 char *mus_current_identifier;
1016 struct ValueTextInfo
1028 struct ConfigTypeInfo
1035 struct TokenIntPtrInfo
1045 char *default_filename;
1048 char **default_parameter; /* array of file parameters */
1049 char **parameter; /* array of file parameters */
1052 boolean fallback_to_default;
1053 boolean default_is_cloned;
1056 struct SetupFileList
1061 struct SetupFileList *next;
1066 char *source_filename; /* primary key for node list */
1070 struct PropertyMapping
1080 struct ArtworkListInfo
1082 int type; /* type of artwork */
1084 int num_file_list_entries;
1085 int num_dynamic_file_list_entries;
1086 struct FileInfo *file_list; /* static artwork file array */
1087 struct FileInfo *dynamic_file_list; /* dynamic artwrk file array */
1089 int num_suffix_list_entries;
1090 struct ConfigTypeInfo *suffix_list; /* parameter suffixes array */
1092 int num_base_prefixes;
1093 int num_ext1_suffixes;
1094 int num_ext2_suffixes;
1095 int num_ext3_suffixes;
1096 char **base_prefixes; /* base token prefixes array */
1097 char **ext1_suffixes; /* property suffixes array 1 */
1098 char **ext2_suffixes; /* property suffixes array 2 */
1099 char **ext3_suffixes; /* property suffixes array 3 */
1101 int num_ignore_tokens;
1102 char **ignore_tokens; /* file tokens to be ignored */
1104 int num_property_mapping_entries;
1105 struct PropertyMapping *property_mapping; /* mapping token -> artwork */
1107 int sizeof_artwork_list_entry;
1109 struct ListNodeInfo **artwork_list; /* static artwork node array */
1110 struct ListNodeInfo **dynamic_artwork_list; /* dynamic artwrk node array */
1111 struct ListNode *content_list; /* dynamic artwork node list */
1113 void *(*load_artwork)(char *); /* constructor function */
1114 void (*free_artwork)(void *); /* destructor function */
1128 struct RectWithBorder
1149 boolean draw_masked;
1155 /* ========================================================================= */
1156 /* exported variables */
1157 /* ========================================================================= */
1159 extern struct ProgramInfo program;
1160 extern struct OptionInfo options;
1161 extern struct VideoSystemInfo video;
1162 extern struct AudioSystemInfo audio;
1163 extern struct GfxInfo gfx;
1164 extern struct AnimInfo anim;
1165 extern struct ArtworkInfo artwork;
1166 extern struct JoystickInfo joystick;
1167 extern struct SetupInfo setup;
1169 extern LevelDirTree *leveldir_first_all;
1170 extern LevelDirTree *leveldir_first;
1171 extern LevelDirTree *leveldir_current;
1172 extern int level_nr;
1174 extern Display *display;
1175 extern Visual *visual;
1177 extern Colormap cmap;
1179 extern DrawWindow *window;
1180 extern DrawBuffer *backbuffer;
1181 extern DrawBuffer *drawto;
1183 extern int button_status;
1184 extern boolean motion_status;
1186 extern int redraw_mask;
1187 extern int redraw_tiles;
1189 extern int FrameCounter;
1192 /* function definitions */
1194 void InitProgramInfo(char *, char *, char *, char *, char *, char *, char *,
1195 char *, char *, char *, char *, char *, int);
1197 void InitExitFunction(void (*exit_function)(int));
1198 void InitPlatformDependentStuff(void);
1199 void ClosePlatformDependentStuff(void);
1201 void InitGfxFieldInfo(int, int, int, int, int, int, int, int, Bitmap *);
1202 void InitGfxDoor1Info(int, int, int, int);
1203 void InitGfxDoor2Info(int, int, int, int);
1204 void InitGfxWindowInfo(int, int);
1205 void InitGfxScrollbufferInfo(int, int);
1206 void InitGfxClipRegion(boolean, int, int, int, int);
1207 void InitGfxDrawBusyAnimFunction(void (*draw_busy_anim_function)(void));
1208 void InitGfxCustomArtworkInfo();
1209 void SetDrawDeactivationMask(int);
1210 void SetDrawBackgroundMask(int);
1211 void SetWindowBackgroundBitmap(Bitmap *);
1212 void SetMainBackgroundBitmap(Bitmap *);
1213 void SetDoorBackgroundBitmap(Bitmap *);
1215 void InitVideoDisplay(void);
1216 void CloseVideoDisplay(void);
1217 void InitVideoBuffer(int, int, int, boolean);
1218 Bitmap *CreateBitmapStruct(void);
1219 Bitmap *CreateBitmap(int, int, int);
1220 void ReCreateBitmap(Bitmap **, int, int, int);
1221 void FreeBitmap(Bitmap *);
1222 void BlitBitmap(Bitmap *, Bitmap *, int, int, int, int, int, int);
1223 void FadeRectangle(Bitmap *bitmap, int, int, int, int, int, int, int,
1224 void (*draw_border_function)(void));
1225 void FillRectangle(Bitmap *, int, int, int, int, Pixel);
1226 void ClearRectangle(Bitmap *, int, int, int, int);
1227 void ClearRectangleOnBackground(Bitmap *, int, int, int, int);
1228 void SetClipMask(Bitmap *, GC, Pixmap);
1229 void SetClipOrigin(Bitmap *, GC, int, int);
1230 void BlitBitmapMasked(Bitmap *, Bitmap *, int, int, int, int, int, int);
1231 boolean DrawingOnBackground(int, int);
1232 void BlitBitmapOnBackground(Bitmap *, Bitmap *, int, int, int, int, int, int);
1233 void DrawSimpleBlackLine(Bitmap *, int, int, int, int);
1234 void DrawSimpleWhiteLine(Bitmap *, int, int, int, int);
1235 void DrawLines(Bitmap *, struct XY *, int, Pixel);
1236 Pixel GetPixel(Bitmap *, int, int);
1237 Pixel GetPixelFromRGB(Bitmap *, unsigned int,unsigned int,unsigned int);
1238 Pixel GetPixelFromRGBcompact(Bitmap *, unsigned int);
1240 void FlushDisplay(void);
1241 void SyncDisplay(void);
1242 void KeyboardAutoRepeatOn(void);
1243 void KeyboardAutoRepeatOff(void);
1244 boolean PointerInWindow(DrawWindow *);
1245 boolean SetVideoMode(boolean);
1246 boolean ChangeVideoModeIfNeeded(boolean);
1248 Bitmap *LoadImage(char *);
1249 Bitmap *LoadCustomImage(char *);
1250 void ReloadCustomImage(Bitmap *, char *);
1252 Bitmap *ZoomBitmap(Bitmap *, int, int);
1253 void CreateBitmapWithSmallBitmaps(Bitmap *, int);
1254 void ScaleBitmap(Bitmap *, int);
1256 void SetMouseCursor(int);
1258 void OpenAudio(void);
1259 void CloseAudio(void);
1260 void SetAudioMode(boolean);
1262 void InitEventFilter(EventFilter);
1263 boolean PendingEvent(void);
1264 void NextEvent(Event *event);
1265 void PeekEvent(Event *event);
1266 Key GetEventKey(KeyEvent *, boolean);
1267 KeyMod HandleKeyModState(Key, int);
1268 KeyMod GetKeyModState();
1269 KeyMod GetKeyModStateFromEvents();
1270 boolean CheckCloseWindowEvent(ClientMessageEvent *);
1272 void InitJoysticks();
1273 boolean ReadJoystick(int, int *, int *, boolean *, boolean *);
1275 #endif /* SYSTEM_H */