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)
199 #define ANIM_FADE (1 << 14)
200 #define ANIM_CROSSFADE (1 << 15)
202 #define ANIM_DEFAULT ANIM_LOOP
204 /* values for text alignment */
205 #define ALIGN_LEFT (1 << 0)
206 #define ALIGN_RIGHT (1 << 1)
207 #define ALIGN_CENTER (1 << 2)
209 #define ALIGN_DEFAULT ALIGN_LEFT
211 #define ALIGNED_XPOS(x,w,a) ((a) == ALIGN_CENTER ? (x) - (w) / 2 : \
212 (a) == ALIGN_RIGHT ? (x) - (w) : (x))
214 /* values for redraw_mask */
215 #define REDRAW_NONE (0)
216 #define REDRAW_ALL (1 << 0)
217 #define REDRAW_FIELD (1 << 1)
218 #define REDRAW_TILES (1 << 2)
219 #define REDRAW_DOOR_1 (1 << 3)
220 #define REDRAW_VIDEO_1 (1 << 4)
221 #define REDRAW_VIDEO_2 (1 << 5)
222 #define REDRAW_VIDEO_3 (1 << 6)
223 #define REDRAW_MICROLEVEL (1 << 7)
224 #define REDRAW_MICROLABEL (1 << 8)
225 #define REDRAW_FROM_BACKBUFFER (1 << 9)
226 #define REDRAW_DOOR_2 (REDRAW_VIDEO_1 | \
229 #define REDRAW_DOOR_3 (1 << 10)
230 #define REDRAW_DOORS (REDRAW_DOOR_1 | \
233 #define REDRAW_MAIN (REDRAW_FIELD | \
236 #define REDRAW_FPS (1 << 11)
237 #define REDRAWTILES_THRESHOLD (SCR_FIELDX * SCR_FIELDY / 2)
239 #define FADE_MODE_FADE_IN 0
240 #define FADE_MODE_FADE_OUT 1
241 #define FADE_MODE_CROSSFADE 2
243 #define IN_GFX_SCREEN(x, y) (x >= gfx.sx && x < gfx.sx + gfx.sxsize && \
244 y >= gfx.sy && y < gfx.sy + gfx.sysize)
245 #define IN_GFX_DOOR(x, y) (x >= gfx.dx && x < gfx.dx + gfx.dxsize && \
246 y >= gfx.dy && y < gfx.dy + gfx.dysize)
247 #define IN_GFX_VIDEO(x, y) (x >= gfx.vx && x < gfx.vx + gfx.vxsize && \
248 y >= gfx.vy && y < gfx.vy + gfx.vysize)
250 /* values for mouse cursor */
251 #define CURSOR_DEFAULT 0
252 #define CURSOR_PLAYFIELD 1
254 /* fundamental game speed values */
255 #define ONE_SECOND_DELAY 1000 /* delay value for one second */
256 #define GAME_FRAME_DELAY 20 /* frame delay in milliseconds */
257 #define FFWD_FRAME_DELAY 10 /* 200% speed for fast forward */
258 #define FRAMES_PER_SECOND (ONE_SECOND_DELAY / GAME_FRAME_DELAY)
260 /* maximum playfield size supported by libgame functions */
261 #define MAX_PLAYFIELD_WIDTH 128
262 #define MAX_PLAYFIELD_HEIGHT 128
264 /* maximum number of parallel players supported by libgame functions */
265 #define MAX_PLAYERS 4
267 /* maximum allowed length of player name */
268 #define MAX_PLAYER_NAME_LEN 10
270 /* default name for empty highscore entry */
271 #define EMPTY_PLAYER_NAME "no name"
273 /* default name for unknown player names */
274 #define ANONYMOUS_NAME "anonymous"
276 /* default for other unknown names */
277 #define UNKNOWN_NAME "unknown"
279 /* default name for new levels */
280 #define NAMELESS_LEVEL_NAME "nameless level"
282 /* default text for non-existant artwork */
283 #define NOT_AVAILABLE "(not available)"
285 /* default value for undefined filename */
286 #define UNDEFINED_FILENAME "[NONE]"
288 /* default value for undefined parameter */
289 #define ARG_DEFAULT "[DEFAULT]"
291 /* default values for undefined configuration file parameters */
292 #define ARG_UNDEFINED "-1000000"
293 #define ARG_UNDEFINED_VALUE (atoi(ARG_UNDEFINED))
295 /* definitions for game sub-directories */
297 #define RO_GAME_DIR "."
301 #define RW_GAME_DIR "."
304 #define RO_BASE_PATH RO_GAME_DIR
305 #define RW_BASE_PATH RW_GAME_DIR
307 /* directory names */
308 #define GRAPHICS_DIRECTORY "graphics"
309 #define SOUNDS_DIRECTORY "sounds"
310 #define MUSIC_DIRECTORY "music"
311 #define LEVELS_DIRECTORY "levels"
312 #define TAPES_DIRECTORY "tapes"
313 #define SCORES_DIRECTORY "scores"
314 #define DOCS_DIRECTORY "docs"
315 #define CACHE_DIRECTORY "cache"
317 #if !defined(PLATFORM_MSDOS)
318 #define GFX_CLASSIC_SUBDIR "gfx_classic"
319 #define SND_CLASSIC_SUBDIR "snd_classic"
320 #define MUS_CLASSIC_SUBDIR "mus_classic"
322 #define GFX_CLASSIC_SUBDIR "gfx_orig"
323 #define SND_CLASSIC_SUBDIR "snd_orig"
324 #define MUS_CLASSIC_SUBDIR "mus_orig"
327 /* file names and filename extensions */
328 #if !defined(PLATFORM_MSDOS)
329 #define LEVELSETUP_DIRECTORY "levelsetup"
330 #define SETUP_FILENAME "setup.conf"
331 #define LEVELSETUP_FILENAME "levelsetup.conf"
332 #define EDITORSETUP_FILENAME "editorsetup.conf"
333 #define EDITORCASCADE_FILENAME "editorcascade.conf"
334 #define HELPANIM_FILENAME "helpanim.conf"
335 #define HELPTEXT_FILENAME "helptext.conf"
336 #define LEVELINFO_FILENAME "levelinfo.conf"
337 #define GRAPHICSINFO_FILENAME "graphicsinfo.conf"
338 #define SOUNDSINFO_FILENAME "soundsinfo.conf"
339 #define MUSICINFO_FILENAME "musicinfo.conf"
340 #define ARTWORKINFO_CACHE_FILE "artworkinfo.cache"
341 #define LEVELFILE_EXTENSION "level"
342 #define TAPEFILE_EXTENSION "tape"
343 #define SCOREFILE_EXTENSION "score"
345 #define LEVELSETUP_DIRECTORY "lvlsetup"
346 #define SETUP_FILENAME "setup.cnf"
347 #define LEVELSETUP_FILENAME "lvlsetup.cnf"
348 #define EDITORSETUP_FILENAME "edsetup.cnf"
349 #define EDITORCASCADE_FILENAME "edcascad.conf"
350 #define HELPANIM_FILENAME "helpanim.cnf"
351 #define HELPTEXT_FILENAME "helptext.cnf"
352 #define LEVELINFO_FILENAME "lvlinfo.cnf"
353 #define GRAPHICSINFO_FILENAME "gfxinfo.cnf"
354 #define SOUNDSINFO_FILENAME "sndinfo.cnf"
355 #define MUSICINFO_FILENAME "musinfo.cnf"
356 #define ARTWORKINFO_CACHE_FILE "artinfo.cac"
357 #define LEVELFILE_EXTENSION "lvl"
358 #define TAPEFILE_EXTENSION "tap"
359 #define SCOREFILE_EXTENSION "sco"
362 #define ERROR_BASENAME "stderr.txt"
364 #define CHAR_PATH_SEPARATOR_UNIX '/'
365 #define CHAR_PATH_SEPARATOR_DOS '\\'
367 #define STRING_PATH_SEPARATOR_UNIX "/"
368 #define STRING_PATH_SEPARATOR_DOS "\\"
370 #define STRING_NEWLINE_UNIX "\n"
371 #define STRING_NEWLINE_DOS "\r\n"
373 #if defined(PLATFORM_WIN32) || defined(PLATFORM_MSDOS)
374 #define CHAR_PATH_SEPARATOR CHAR_PATH_SEPARATOR_DOS
375 #define STRING_PATH_SEPARATOR STRING_PATH_SEPARATOR_DOS
376 #define STRING_NEWLINE STRING_NEWLINE_DOS
378 #define CHAR_PATH_SEPARATOR CHAR_PATH_SEPARATOR_UNIX
379 #define STRING_PATH_SEPARATOR STRING_PATH_SEPARATOR_UNIX
380 #define STRING_NEWLINE STRING_NEWLINE_UNIX
384 /* areas in bitmap PIX_DOOR */
385 /* meaning in PIX_DB_DOOR: (3 PAGEs)
386 PAGEX1: 1. buffer for DOOR_1
387 PAGEX2: 2. buffer for DOOR_1
388 PAGEX3: buffer for animations
391 /* these values are hard-coded to be able to use them in initialization */
392 #define DOOR_GFX_PAGE_WIDTH 100 /* should be set to "gfx.dxsize" */
393 #define DOOR_GFX_PAGE_HEIGHT 280 /* should be set to "gfx.dysize" */
395 #define DOOR_GFX_PAGESIZE (DOOR_GFX_PAGE_WIDTH)
396 #define DOOR_GFX_PAGEX1 (0 * DOOR_GFX_PAGESIZE)
397 #define DOOR_GFX_PAGEX2 (1 * DOOR_GFX_PAGESIZE)
398 #define DOOR_GFX_PAGEX3 (2 * DOOR_GFX_PAGESIZE)
399 #define DOOR_GFX_PAGEX4 (3 * DOOR_GFX_PAGESIZE)
400 #define DOOR_GFX_PAGEX5 (4 * DOOR_GFX_PAGESIZE)
401 #define DOOR_GFX_PAGEX6 (5 * DOOR_GFX_PAGESIZE)
402 #define DOOR_GFX_PAGEX7 (6 * DOOR_GFX_PAGESIZE)
403 #define DOOR_GFX_PAGEX8 (7 * DOOR_GFX_PAGESIZE)
404 #define DOOR_GFX_PAGEY1 (0)
405 #define DOOR_GFX_PAGEY2 (DOOR_GFX_PAGE_HEIGHT)
408 /* macros for version handling */
409 #define VERSION_MAJOR(x) ((x) / 1000000)
410 #define VERSION_MINOR(x) (((x) % 1000000) / 10000)
411 #define VERSION_PATCH(x) (((x) % 10000) / 100)
412 #define VERSION_BUILD(x) ((x) % 100)
413 #define VERSION_IDENT(a,b,c,d) ((a) * 1000000 + (b) * 10000 + (c) * 100 + (d))
416 /* macros for parent/child process identification */
417 #if defined(PLATFORM_UNIX)
418 #define IS_PARENT_PROCESS() (audio.mixer_pid != getpid())
419 #define IS_CHILD_PROCESS() (audio.mixer_pid == getpid())
420 #define HAS_CHILD_PROCESS() (audio.mixer_pid > 0)
422 #define IS_PARENT_PROCESS() TRUE
423 #define IS_CHILD_PROCESS() FALSE
424 #define HAS_CHILD_PROCESS() FALSE
428 /* values for artwork type */
429 #define ARTWORK_TYPE_GRAPHICS 0
430 #define ARTWORK_TYPE_SOUNDS 1
431 #define ARTWORK_TYPE_MUSIC 2
433 #define NUM_ARTWORK_TYPES 3
436 /* values for tree type (chosen to match artwork type) */
437 #define TREE_TYPE_UNDEFINED -1
438 #define TREE_TYPE_GRAPHICS_DIR ARTWORK_TYPE_GRAPHICS
439 #define TREE_TYPE_SOUNDS_DIR ARTWORK_TYPE_SOUNDS
440 #define TREE_TYPE_MUSIC_DIR ARTWORK_TYPE_MUSIC
441 #define TREE_TYPE_LEVEL_DIR 3
443 #define NUM_TREE_TYPES 4
445 #define INFOTEXT_UNDEFINED ""
446 #define INFOTEXT_GRAPHICS_DIR "Custom Graphics"
447 #define INFOTEXT_SOUNDS_DIR "Custom Sounds"
448 #define INFOTEXT_MUSIC_DIR "Custom Music"
449 #define INFOTEXT_LEVEL_DIR "Level Sets"
451 #define TREE_INFOTEXT(t) ((t) == TREE_TYPE_LEVEL_DIR ? \
452 INFOTEXT_LEVEL_DIR : \
453 (t) == TREE_TYPE_GRAPHICS_DIR ? \
454 INFOTEXT_GRAPHICS_DIR : \
455 (t) == TREE_TYPE_SOUNDS_DIR ? \
456 INFOTEXT_SOUNDS_DIR : \
457 (t) == TREE_TYPE_MUSIC_DIR ? \
458 INFOTEXT_MUSIC_DIR : \
461 /* values for artwork handling */
462 #define LEVELDIR_ARTWORK_SET_PTR(leveldir, type) \
463 ((type) == ARTWORK_TYPE_GRAPHICS ? \
464 &(leveldir)->graphics_set : \
465 (type) == ARTWORK_TYPE_SOUNDS ? \
466 &(leveldir)->sounds_set : \
467 &(leveldir)->music_set)
469 #define LEVELDIR_ARTWORK_SET(leveldir, type) \
470 ((type) == ARTWORK_TYPE_GRAPHICS ? \
471 (leveldir)->graphics_set : \
472 (type) == ARTWORK_TYPE_SOUNDS ? \
473 (leveldir)->sounds_set : \
474 (leveldir)->music_set)
476 #define LEVELDIR_ARTWORK_PATH_PTR(leveldir, type) \
477 ((type) == ARTWORK_TYPE_GRAPHICS ? \
478 &(leveldir)->graphics_path : \
479 (type) == ARTWORK_TYPE_SOUNDS ? \
480 &(leveldir)->sounds_path : \
481 &(leveldir)->music_path)
483 #define LEVELDIR_ARTWORK_PATH(leveldir, type) \
484 ((type) == ARTWORK_TYPE_GRAPHICS ? \
485 (leveldir)->graphics_path : \
486 (type) == ARTWORK_TYPE_SOUNDS ? \
487 (leveldir)->sounds_path : \
488 (leveldir)->music_path)
490 #define SETUP_ARTWORK_SET(setup, type) \
491 ((type) == ARTWORK_TYPE_GRAPHICS ? \
492 (setup).graphics_set : \
493 (type) == ARTWORK_TYPE_SOUNDS ? \
494 (setup).sounds_set : \
497 #define SETUP_OVERRIDE_ARTWORK(setup, type) \
498 ((type) == ARTWORK_TYPE_GRAPHICS ? \
499 (setup).override_level_graphics : \
500 (type) == ARTWORK_TYPE_SOUNDS ? \
501 (setup).override_level_sounds : \
502 (setup).override_level_music)
504 #define ARTWORK_FIRST_NODE(artwork, type) \
505 ((type) == ARTWORK_TYPE_GRAPHICS ? \
506 (artwork).gfx_first : \
507 (type) == ARTWORK_TYPE_SOUNDS ? \
508 (artwork).snd_first : \
511 #define ARTWORK_CURRENT_IDENTIFIER_PTR(artwork, type) \
512 ((type) == ARTWORK_TYPE_GRAPHICS ? \
513 &(artwork).gfx_current_identifier : \
514 (type) == ARTWORK_TYPE_SOUNDS ? \
515 &(artwork).snd_current_identifier : \
516 &(artwork).mus_current_identifier)
518 #define ARTWORK_CURRENT_IDENTIFIER(artwork, type) \
519 ((type) == ARTWORK_TYPE_GRAPHICS ? \
520 (artwork).gfx_current_identifier : \
521 (type) == ARTWORK_TYPE_SOUNDS ? \
522 (artwork).snd_current_identifier : \
523 (artwork).mus_current_identifier)
525 #define ARTWORKINFO_FILENAME(type) \
526 ((type) == ARTWORK_TYPE_GRAPHICS ? \
527 GRAPHICSINFO_FILENAME : \
528 (type) == ARTWORK_TYPE_SOUNDS ? \
529 SOUNDSINFO_FILENAME : \
530 (type) == ARTWORK_TYPE_MUSIC ? \
531 MUSICINFO_FILENAME : "")
533 #define ARTWORK_DIRECTORY(type) \
534 ((type) == ARTWORK_TYPE_GRAPHICS ? \
535 GRAPHICS_DIRECTORY : \
536 (type) == ARTWORK_TYPE_SOUNDS ? \
538 (type) == ARTWORK_TYPE_MUSIC ? \
539 MUSIC_DIRECTORY : "")
541 #define OPTIONS_ARTWORK_DIRECTORY(type) \
542 ((type) == ARTWORK_TYPE_GRAPHICS ? \
543 options.graphics_directory : \
544 (type) == ARTWORK_TYPE_SOUNDS ? \
545 options.sounds_directory : \
546 (type) == ARTWORK_TYPE_MUSIC ? \
547 options.music_directory : "")
550 /* type definitions */
551 typedef int (*EventFilter)(const Event *);
554 /* structure definitions */
558 char *command_basepath; /* directory that contains the program */
559 char *command_basename; /* base filename of the program binary */
561 char *userdata_subdir; /* personal user game data directory */
562 char *userdata_subdir_unix; /* personal user game data directory (Unix) */
563 char *userdata_path; /* resulting full path to game data directory */
569 char *x11_icon_filename;
570 char *x11_iconmask_filename;
571 char *sdl_icon_filename;
572 char *msdos_cursor_filename;
575 char *filename_prefix; /* prefix to cut off from DOS filenames */
577 char *error_filename; /* filename where to write error messages to */
578 FILE *error_file; /* (used instead of 'stderr' on some systems) */
584 void (*exit_function)(int);
593 char *ro_base_directory;
594 char *rw_base_directory;
595 char *level_directory;
596 char *graphics_directory;
597 char *sounds_directory;
598 char *music_directory;
599 char *docs_directory;
600 char *execute_command;
608 struct ScreenModeInfo
613 struct VideoSystemInfo
616 int width, height, depth;
618 boolean fullscreen_available;
619 boolean fullscreen_enabled;
620 struct ScreenModeInfo *fullscreen_modes;
621 char *fullscreen_mode_current;
624 struct AudioSystemInfo
626 boolean sound_available;
627 boolean loops_available;
628 boolean music_available;
630 boolean sound_enabled;
631 boolean sound_deactivated; /* for temporarily disabling sound */
640 int first_sound_channel;
643 struct FontBitmapInfo
647 int src_x, src_y; /* start position of animation frames */
648 int width, height; /* width/height of each animation frame */
650 int draw_xoffset; /* offset for drawing font characters */
651 int draw_yoffset; /* offset for drawing font characters */
654 int num_chars_per_line;
656 #if defined(TARGET_X11_NATIVE_PERFORMANCE_WORKAROUND)
657 Pixmap *clip_mask; /* single-char-only clip mask array for X11 */
665 int real_sx, real_sy;
666 int full_sxsize, full_sysize;
667 int scrollbuffer_width, scrollbuffer_height;
675 int draw_deactivation_mask;
676 int draw_background_mask;
678 Bitmap *field_save_buffer;
680 Bitmap *background_bitmap;
681 int background_bitmap_mask;
684 struct FontBitmapInfo *font_bitmap_info;
685 int (*select_font_function)(int);
687 int anim_random_frame;
693 int fd[MAX_PLAYERS]; /* file descriptor of player's joystick */
696 struct SetupJoystickInfo
698 char *device_name; /* device name of player's joystick */
700 int xleft, xmiddle, xright;
701 int yupper, ymiddle, ylower;
705 struct SetupKeyboardInfo
707 Key left, right, up, down;
711 struct SetupInputInfo
713 boolean use_joystick;
714 struct SetupJoystickInfo joy;
715 struct SetupKeyboardInfo key;
718 struct SetupEditorInfo
720 boolean el_boulderdash;
721 boolean el_emerald_mine;
722 boolean el_emerald_mine_club;
726 boolean el_diamond_caves;
727 boolean el_dx_boulderdash;
729 boolean el_steel_chars;
731 boolean el_user_defined;
734 boolean el_headlines;
739 boolean show_element_token;
742 struct SetupEditorCascadeInfo
753 boolean el_steel_chars;
761 struct SetupShortcutInfo
767 Key focus_player[MAX_PLAYERS];
768 Key focus_player_all;
771 struct SetupSystemInfo
773 char *sdl_audiodriver;
774 int audio_fragment_size;
784 boolean sound_simple;
786 boolean double_buffering;
787 boolean direct_draw; /* !double_buffering (redundant!) */
788 boolean scroll_delay;
789 boolean soft_scrolling;
790 boolean fade_screens;
792 boolean show_titlescreen;
799 char *fullscreen_mode;
800 boolean ask_on_escape;
801 boolean ask_on_escape_editor;
802 boolean quick_switch;
803 boolean input_on_focus;
804 boolean prefer_aga_graphics;
809 boolean override_level_graphics;
810 boolean override_level_sounds;
811 boolean override_level_music;
813 struct SetupEditorInfo editor;
814 struct SetupEditorCascadeInfo editor_cascade;
815 struct SetupShortcutInfo shortcut;
816 struct SetupInputInfo input[MAX_PLAYERS];
817 struct SetupSystemInfo system;
818 struct OptionInfo options;
823 struct TreeInfo **node_top; /* topmost node in tree */
824 struct TreeInfo *node_parent; /* parent level directory info */
825 struct TreeInfo *node_group; /* level group sub-directory info */
826 struct TreeInfo *next; /* next level series structure node */
828 int cl_first; /* internal control field for setup screen */
829 int cl_cursor; /* internal control field for setup screen */
831 int type; /* type of tree content */
833 /* fields for "type == TREE_TYPE_LEVEL_DIR" */
835 char *subdir; /* tree info sub-directory basename (may be ".") */
836 char *fullpath; /* complete path relative to tree base directory */
837 char *basepath; /* absolute base path of tree base directory */
838 char *identifier; /* identifier string for configuration files */
839 char *name; /* tree info name, as displayed in selection menues */
840 char *name_sorting; /* optional sorting name for correct name sorting */
841 char *author; /* level or artwork author name */
842 char *imported_from; /* optional comment for imported levels or artwork */
843 char *imported_by; /* optional comment for imported levels or artwork */
845 char *graphics_set_ecs; /* special EMC custom graphics set (ECS graphics) */
846 char *graphics_set_aga; /* special EMC custom graphics set (AGA graphics) */
847 char *graphics_set; /* optional custom graphics set (level tree only) */
848 char *sounds_set; /* optional custom sounds set (level tree only) */
849 char *music_set; /* optional custom music set (level tree only) */
850 char *graphics_path; /* path to optional custom graphics set (level only) */
851 char *sounds_path; /* path to optional custom sounds set (level only) */
852 char *music_path; /* path to optional custom music set (level only) */
854 char *level_filename; /* filename of level file (for packed level file) */
855 char *level_filetype; /* type of levels in level directory or level file */
857 int levels; /* number of levels in level series */
858 int first_level; /* first level number (to allow start with 0 or 1) */
859 int last_level; /* last level number (automatically calculated) */
860 int sort_priority; /* sort levels by 'sort_priority' and then by name */
862 boolean latest_engine;/* force level set to use the latest game engine */
864 boolean level_group; /* directory contains more level series directories */
865 boolean parent_link; /* entry links back to parent directory */
866 boolean in_user_dir; /* user defined levels are stored in home directory */
867 boolean user_defined; /* levels in user directory and marked as "private" */
868 boolean readonly; /* readonly levels can not be changed with editor */
869 boolean handicap; /* level set has no handicap when set to "false" */
870 boolean skip_levels; /* levels can be skipped when set to "true" */
872 int color; /* color to use on selection screen for this level */
873 char *class_desc; /* description of level series class */
874 int handicap_level; /* number of the lowest unsolved level */
876 char *infotext; /* optional text to describe the tree type (headline) */
879 typedef struct TreeInfo TreeInfo;
880 typedef struct TreeInfo LevelDirTree;
881 typedef struct TreeInfo ArtworkDirTree;
882 typedef struct TreeInfo GraphicsDirTree;
883 typedef struct TreeInfo SoundsDirTree;
884 typedef struct TreeInfo MusicDirTree;
888 GraphicsDirTree *gfx_first;
889 GraphicsDirTree *gfx_current;
890 SoundsDirTree *snd_first;
891 SoundsDirTree *snd_current;
892 MusicDirTree *mus_first;
893 MusicDirTree *mus_current;
895 char *gfx_current_identifier;
896 char *snd_current_identifier;
897 char *mus_current_identifier;
912 struct ConfigTypeInfo
919 struct TokenIntPtrInfo
929 char *default_filename;
932 char **default_parameter; /* array of file parameters */
933 char **parameter; /* array of file parameters */
936 boolean fallback_to_default;
944 struct SetupFileList *next;
949 char *source_filename; /* primary key for node list */
953 struct PropertyMapping
963 struct ArtworkListInfo
965 int type; /* type of artwork */
967 int num_file_list_entries;
968 int num_dynamic_file_list_entries;
969 struct FileInfo *file_list; /* static artwork file array */
970 struct FileInfo *dynamic_file_list; /* dynamic artwrk file array */
972 int num_suffix_list_entries;
973 struct ConfigTypeInfo *suffix_list; /* parameter suffixes array */
975 int num_base_prefixes;
976 int num_ext1_suffixes;
977 int num_ext2_suffixes;
978 int num_ext3_suffixes;
979 char **base_prefixes; /* base token prefixes array */
980 char **ext1_suffixes; /* property suffixes array 1 */
981 char **ext2_suffixes; /* property suffixes array 2 */
982 char **ext3_suffixes; /* property suffixes array 3 */
984 int num_ignore_tokens;
985 char **ignore_tokens; /* file tokens to be ignored */
987 int num_property_mapping_entries;
988 struct PropertyMapping *property_mapping; /* mapping token -> artwork */
990 int sizeof_artwork_list_entry;
992 struct ListNodeInfo **artwork_list; /* static artwork node array */
993 struct ListNodeInfo **dynamic_artwork_list; /* dynamic artwrk node array */
994 struct ListNode *content_list; /* dynamic artwork node list */
996 void *(*load_artwork)(char *); /* constructor function */
997 void (*free_artwork)(void *); /* destructor function */
1012 /* ========================================================================= */
1013 /* exported variables */
1014 /* ========================================================================= */
1016 extern struct ProgramInfo program;
1017 extern struct OptionInfo options;
1018 extern struct VideoSystemInfo video;
1019 extern struct AudioSystemInfo audio;
1020 extern struct GfxInfo gfx;
1021 extern struct AnimInfo anim;
1022 extern struct ArtworkInfo artwork;
1023 extern struct JoystickInfo joystick;
1024 extern struct SetupInfo setup;
1026 extern LevelDirTree *leveldir_first_all;
1027 extern LevelDirTree *leveldir_first;
1028 extern LevelDirTree *leveldir_current;
1029 extern int level_nr;
1031 extern Display *display;
1032 extern Visual *visual;
1034 extern Colormap cmap;
1036 extern DrawWindow *window;
1037 extern DrawBuffer *backbuffer;
1038 extern DrawBuffer *drawto;
1040 extern int button_status;
1041 extern boolean motion_status;
1043 extern int redraw_mask;
1044 extern int redraw_tiles;
1046 extern int FrameCounter;
1049 /* function definitions */
1051 void InitProgramInfo(char *, char *, char *, char *, char *, char *, char *,
1052 char *, char *, char *, char *, char *, int);
1054 void InitExitFunction(void (*exit_function)(int));
1055 void InitPlatformDependentStuff(void);
1056 void ClosePlatformDependentStuff(void);
1058 void InitGfxFieldInfo(int, int, int, int, int, int, int, int, Bitmap *);
1059 void InitGfxDoor1Info(int, int, int, int);
1060 void InitGfxDoor2Info(int, int, int, int);
1061 void InitGfxScrollbufferInfo(int, int);
1062 void SetDrawDeactivationMask(int);
1063 void SetDrawBackgroundMask(int);
1064 void SetWindowBackgroundBitmap(Bitmap *);
1065 void SetMainBackgroundBitmap(Bitmap *);
1066 void SetDoorBackgroundBitmap(Bitmap *);
1068 void InitVideoDisplay(void);
1069 void CloseVideoDisplay(void);
1070 void InitVideoBuffer(int, int, int, boolean);
1071 Bitmap *CreateBitmapStruct(void);
1072 Bitmap *CreateBitmap(int, int, int);
1073 void FreeBitmap(Bitmap *);
1074 void BlitBitmap(Bitmap *, Bitmap *, int, int, int, int, int, int);
1075 void FadeRectangle(Bitmap *bitmap, int, int, int, int, int, int, int,
1076 void (*draw_border_function)(void));
1077 void FillRectangle(Bitmap *, int, int, int, int, Pixel);
1078 void ClearRectangle(Bitmap *, int, int, int, int);
1079 void ClearRectangleOnBackground(Bitmap *, int, int, int, int);
1080 void SetClipMask(Bitmap *, GC, Pixmap);
1081 void SetClipOrigin(Bitmap *, GC, int, int);
1082 void BlitBitmapMasked(Bitmap *, Bitmap *, int, int, int, int, int, int);
1083 boolean DrawingOnBackground(int, int);
1084 void BlitBitmapOnBackground(Bitmap *, Bitmap *, int, int, int, int, int, int);
1085 void DrawSimpleBlackLine(Bitmap *, int, int, int, int);
1086 void DrawSimpleWhiteLine(Bitmap *, int, int, int, int);
1087 void DrawLines(Bitmap *, struct XY *, int, Pixel);
1088 Pixel GetPixel(Bitmap *, int, int);
1089 Pixel GetPixelFromRGB(Bitmap *, unsigned int,unsigned int,unsigned int);
1090 Pixel GetPixelFromRGBcompact(Bitmap *, unsigned int);
1092 void FlushDisplay(void);
1093 void SyncDisplay(void);
1094 void KeyboardAutoRepeatOn(void);
1095 void KeyboardAutoRepeatOff(void);
1096 boolean PointerInWindow(DrawWindow *);
1097 boolean SetVideoMode(boolean);
1098 boolean ChangeVideoModeIfNeeded(boolean);
1100 Bitmap *LoadImage(char *);
1101 Bitmap *LoadCustomImage(char *);
1102 void ReloadCustomImage(Bitmap *, char *);
1104 Bitmap *ZoomBitmap(Bitmap *, int, int);
1105 void CreateBitmapWithSmallBitmaps(Bitmap *, int);
1106 void ScaleBitmap(Bitmap *, int);
1108 void SetMouseCursor(int);
1110 void OpenAudio(void);
1111 void CloseAudio(void);
1112 void SetAudioMode(boolean);
1114 void InitEventFilter(EventFilter);
1115 boolean PendingEvent(void);
1116 void NextEvent(Event *event);
1117 void PeekEvent(Event *event);
1118 Key GetEventKey(KeyEvent *, boolean);
1119 KeyMod HandleKeyModState(Key, int);
1120 KeyMod GetKeyModState();
1121 KeyMod GetKeyModStateFromEvents();
1122 boolean CheckCloseWindowEvent(ClientMessageEvent *);
1124 void InitJoysticks();
1125 boolean ReadJoystick(int, int *, int *, boolean *, boolean *);
1127 #endif /* SYSTEM_H */