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))
213 #define ALIGNED_MENU_XPOS(p) ALIGNED_XPOS((p)->x, (p)->width, (p)->align)
214 #define ALIGNED_MENU_YPOS(p) ((p)->y)
216 /* values for redraw_mask */
217 #define REDRAW_NONE (0)
218 #define REDRAW_ALL (1 << 0)
219 #define REDRAW_FIELD (1 << 1)
220 #define REDRAW_TILES (1 << 2)
221 #define REDRAW_DOOR_1 (1 << 3)
222 #define REDRAW_VIDEO_1 (1 << 4)
223 #define REDRAW_VIDEO_2 (1 << 5)
224 #define REDRAW_VIDEO_3 (1 << 6)
225 #define REDRAW_MICROLEVEL (1 << 7)
226 #define REDRAW_MICROLABEL (1 << 8)
227 #define REDRAW_FROM_BACKBUFFER (1 << 9)
228 #define REDRAW_DOOR_2 (REDRAW_VIDEO_1 | \
231 #define REDRAW_DOOR_3 (1 << 10)
232 #define REDRAW_DOORS (REDRAW_DOOR_1 | \
235 #define REDRAW_MAIN (REDRAW_FIELD | \
238 #define REDRAW_FPS (1 << 11)
239 #define REDRAWTILES_THRESHOLD (SCR_FIELDX * SCR_FIELDY / 2)
241 #define FADE_MODE_FADE_IN 0
242 #define FADE_MODE_FADE_OUT 1
243 #define FADE_MODE_CROSSFADE 2
245 #define IN_GFX_SCREEN(x, y) (x >= gfx.sx && x < gfx.sx + gfx.sxsize && \
246 y >= gfx.sy && y < gfx.sy + gfx.sysize)
247 #define IN_GFX_DOOR(x, y) (x >= gfx.dx && x < gfx.dx + gfx.dxsize && \
248 y >= gfx.dy && y < gfx.dy + gfx.dysize)
249 #define IN_GFX_VIDEO(x, y) (x >= gfx.vx && x < gfx.vx + gfx.vxsize && \
250 y >= gfx.vy && y < gfx.vy + gfx.vysize)
252 /* values for mouse cursor */
253 #define CURSOR_DEFAULT 0
254 #define CURSOR_NONE 1
255 #define CURSOR_PLAYFIELD 2
257 /* fundamental game speed values */
258 #define ONE_SECOND_DELAY 1000 /* delay value for one second */
259 #define GAME_FRAME_DELAY 20 /* frame delay in milliseconds */
260 #define FFWD_FRAME_DELAY 10 /* 200% speed for fast forward */
261 #define FRAMES_PER_SECOND (ONE_SECOND_DELAY / GAME_FRAME_DELAY)
263 /* maximum playfield size supported by libgame functions */
264 #define MAX_PLAYFIELD_WIDTH 128
265 #define MAX_PLAYFIELD_HEIGHT 128
267 /* maximum number of parallel players supported by libgame functions */
268 #define MAX_PLAYERS 4
270 /* maximum allowed length of player name */
271 #define MAX_PLAYER_NAME_LEN 10
273 /* default name for empty highscore entry */
274 #define EMPTY_PLAYER_NAME "no name"
276 /* default name for unknown player names */
277 #define ANONYMOUS_NAME "anonymous"
279 /* default for other unknown names */
280 #define UNKNOWN_NAME "unknown"
282 /* default name for new levels */
283 #define NAMELESS_LEVEL_NAME "nameless level"
285 /* default text for non-existant artwork */
286 #define NOT_AVAILABLE "(not available)"
288 /* default value for undefined filename */
289 #define UNDEFINED_FILENAME "[NONE]"
291 /* default value for undefined parameter */
292 #define ARG_DEFAULT "[DEFAULT]"
294 /* default values for undefined configuration file parameters */
295 #define ARG_UNDEFINED "-1000000"
296 #define ARG_UNDEFINED_VALUE (atoi(ARG_UNDEFINED))
298 /* definitions for game sub-directories */
300 #define RO_GAME_DIR "."
304 #define RW_GAME_DIR "."
307 #define RO_BASE_PATH RO_GAME_DIR
308 #define RW_BASE_PATH RW_GAME_DIR
310 /* directory names */
311 #define GRAPHICS_DIRECTORY "graphics"
312 #define SOUNDS_DIRECTORY "sounds"
313 #define MUSIC_DIRECTORY "music"
314 #define LEVELS_DIRECTORY "levels"
315 #define TAPES_DIRECTORY "tapes"
316 #define SCORES_DIRECTORY "scores"
317 #define DOCS_DIRECTORY "docs"
318 #define CACHE_DIRECTORY "cache"
320 #if !defined(PLATFORM_MSDOS)
321 #define GFX_CLASSIC_SUBDIR "gfx_classic"
322 #define SND_CLASSIC_SUBDIR "snd_classic"
323 #define MUS_CLASSIC_SUBDIR "mus_classic"
325 #define GFX_CLASSIC_SUBDIR "gfx_orig"
326 #define SND_CLASSIC_SUBDIR "snd_orig"
327 #define MUS_CLASSIC_SUBDIR "mus_orig"
330 /* file names and filename extensions */
331 #if !defined(PLATFORM_MSDOS)
332 #define LEVELSETUP_DIRECTORY "levelsetup"
333 #define SETUP_FILENAME "setup.conf"
334 #define LEVELSETUP_FILENAME "levelsetup.conf"
335 #define EDITORSETUP_FILENAME "editorsetup.conf"
336 #define EDITORCASCADE_FILENAME "editorcascade.conf"
337 #define HELPANIM_FILENAME "helpanim.conf"
338 #define HELPTEXT_FILENAME "helptext.conf"
339 #define LEVELINFO_FILENAME "levelinfo.conf"
340 #define GRAPHICSINFO_FILENAME "graphicsinfo.conf"
341 #define SOUNDSINFO_FILENAME "soundsinfo.conf"
342 #define MUSICINFO_FILENAME "musicinfo.conf"
343 #define ARTWORKINFO_CACHE_FILE "artworkinfo.cache"
344 #define LEVELFILE_EXTENSION "level"
345 #define TAPEFILE_EXTENSION "tape"
346 #define SCOREFILE_EXTENSION "score"
348 #define LEVELSETUP_DIRECTORY "lvlsetup"
349 #define SETUP_FILENAME "setup.cnf"
350 #define LEVELSETUP_FILENAME "lvlsetup.cnf"
351 #define EDITORSETUP_FILENAME "edsetup.cnf"
352 #define EDITORCASCADE_FILENAME "edcascad.conf"
353 #define HELPANIM_FILENAME "helpanim.cnf"
354 #define HELPTEXT_FILENAME "helptext.cnf"
355 #define LEVELINFO_FILENAME "lvlinfo.cnf"
356 #define GRAPHICSINFO_FILENAME "gfxinfo.cnf"
357 #define SOUNDSINFO_FILENAME "sndinfo.cnf"
358 #define MUSICINFO_FILENAME "musinfo.cnf"
359 #define ARTWORKINFO_CACHE_FILE "artinfo.cac"
360 #define LEVELFILE_EXTENSION "lvl"
361 #define TAPEFILE_EXTENSION "tap"
362 #define SCOREFILE_EXTENSION "sco"
365 #define ERROR_BASENAME "stderr.txt"
367 #define CHAR_PATH_SEPARATOR_UNIX '/'
368 #define CHAR_PATH_SEPARATOR_DOS '\\'
370 #define STRING_PATH_SEPARATOR_UNIX "/"
371 #define STRING_PATH_SEPARATOR_DOS "\\"
373 #define STRING_NEWLINE_UNIX "\n"
374 #define STRING_NEWLINE_DOS "\r\n"
376 #if defined(PLATFORM_WIN32) || defined(PLATFORM_MSDOS)
377 #define CHAR_PATH_SEPARATOR CHAR_PATH_SEPARATOR_DOS
378 #define STRING_PATH_SEPARATOR STRING_PATH_SEPARATOR_DOS
379 #define STRING_NEWLINE STRING_NEWLINE_DOS
381 #define CHAR_PATH_SEPARATOR CHAR_PATH_SEPARATOR_UNIX
382 #define STRING_PATH_SEPARATOR STRING_PATH_SEPARATOR_UNIX
383 #define STRING_NEWLINE STRING_NEWLINE_UNIX
387 /* areas in bitmap PIX_DOOR */
388 /* meaning in PIX_DB_DOOR: (3 PAGEs)
389 PAGEX1: 1. buffer for DOOR_1
390 PAGEX2: 2. buffer for DOOR_1
391 PAGEX3: buffer for animations
394 /* these values are hard-coded to be able to use them in initialization */
395 #define DOOR_GFX_PAGE_WIDTH 100 /* should be set to "gfx.dxsize" */
396 #define DOOR_GFX_PAGE_HEIGHT 280 /* should be set to "gfx.dysize" */
398 #define DOOR_GFX_PAGESIZE (DOOR_GFX_PAGE_WIDTH)
399 #define DOOR_GFX_PAGEX1 (0 * DOOR_GFX_PAGESIZE)
400 #define DOOR_GFX_PAGEX2 (1 * DOOR_GFX_PAGESIZE)
401 #define DOOR_GFX_PAGEX3 (2 * DOOR_GFX_PAGESIZE)
402 #define DOOR_GFX_PAGEX4 (3 * DOOR_GFX_PAGESIZE)
403 #define DOOR_GFX_PAGEX5 (4 * DOOR_GFX_PAGESIZE)
404 #define DOOR_GFX_PAGEX6 (5 * DOOR_GFX_PAGESIZE)
405 #define DOOR_GFX_PAGEX7 (6 * DOOR_GFX_PAGESIZE)
406 #define DOOR_GFX_PAGEX8 (7 * DOOR_GFX_PAGESIZE)
407 #define DOOR_GFX_PAGEY1 (0)
408 #define DOOR_GFX_PAGEY2 (DOOR_GFX_PAGE_HEIGHT)
411 /* macros for version handling */
412 #define VERSION_MAJOR(x) ((x) / 1000000)
413 #define VERSION_MINOR(x) (((x) % 1000000) / 10000)
414 #define VERSION_PATCH(x) (((x) % 10000) / 100)
415 #define VERSION_BUILD(x) ((x) % 100)
416 #define VERSION_IDENT(a,b,c,d) ((a) * 1000000 + (b) * 10000 + (c) * 100 + (d))
419 /* macros for parent/child process identification */
420 #if defined(PLATFORM_UNIX)
421 #define IS_PARENT_PROCESS() (audio.mixer_pid != getpid())
422 #define IS_CHILD_PROCESS() (audio.mixer_pid == getpid())
423 #define HAS_CHILD_PROCESS() (audio.mixer_pid > 0)
425 #define IS_PARENT_PROCESS() TRUE
426 #define IS_CHILD_PROCESS() FALSE
427 #define HAS_CHILD_PROCESS() FALSE
431 /* values for artwork type */
432 #define ARTWORK_TYPE_GRAPHICS 0
433 #define ARTWORK_TYPE_SOUNDS 1
434 #define ARTWORK_TYPE_MUSIC 2
436 #define NUM_ARTWORK_TYPES 3
439 /* values for tree type (chosen to match artwork type) */
440 #define TREE_TYPE_UNDEFINED -1
441 #define TREE_TYPE_GRAPHICS_DIR ARTWORK_TYPE_GRAPHICS
442 #define TREE_TYPE_SOUNDS_DIR ARTWORK_TYPE_SOUNDS
443 #define TREE_TYPE_MUSIC_DIR ARTWORK_TYPE_MUSIC
444 #define TREE_TYPE_LEVEL_DIR 3
446 #define NUM_TREE_TYPES 4
448 #define INFOTEXT_UNDEFINED ""
449 #define INFOTEXT_GRAPHICS_DIR "Custom Graphics"
450 #define INFOTEXT_SOUNDS_DIR "Custom Sounds"
451 #define INFOTEXT_MUSIC_DIR "Custom Music"
452 #define INFOTEXT_LEVEL_DIR "Level Sets"
454 #define TREE_INFOTEXT(t) ((t) == TREE_TYPE_LEVEL_DIR ? \
455 INFOTEXT_LEVEL_DIR : \
456 (t) == TREE_TYPE_GRAPHICS_DIR ? \
457 INFOTEXT_GRAPHICS_DIR : \
458 (t) == TREE_TYPE_SOUNDS_DIR ? \
459 INFOTEXT_SOUNDS_DIR : \
460 (t) == TREE_TYPE_MUSIC_DIR ? \
461 INFOTEXT_MUSIC_DIR : \
464 /* values for artwork handling */
465 #define LEVELDIR_ARTWORK_SET_PTR(leveldir, type) \
466 ((type) == ARTWORK_TYPE_GRAPHICS ? \
467 &(leveldir)->graphics_set : \
468 (type) == ARTWORK_TYPE_SOUNDS ? \
469 &(leveldir)->sounds_set : \
470 &(leveldir)->music_set)
472 #define LEVELDIR_ARTWORK_SET(leveldir, type) \
473 ((type) == ARTWORK_TYPE_GRAPHICS ? \
474 (leveldir)->graphics_set : \
475 (type) == ARTWORK_TYPE_SOUNDS ? \
476 (leveldir)->sounds_set : \
477 (leveldir)->music_set)
479 #define LEVELDIR_ARTWORK_PATH_PTR(leveldir, type) \
480 ((type) == ARTWORK_TYPE_GRAPHICS ? \
481 &(leveldir)->graphics_path : \
482 (type) == ARTWORK_TYPE_SOUNDS ? \
483 &(leveldir)->sounds_path : \
484 &(leveldir)->music_path)
486 #define LEVELDIR_ARTWORK_PATH(leveldir, type) \
487 ((type) == ARTWORK_TYPE_GRAPHICS ? \
488 (leveldir)->graphics_path : \
489 (type) == ARTWORK_TYPE_SOUNDS ? \
490 (leveldir)->sounds_path : \
491 (leveldir)->music_path)
493 #define SETUP_ARTWORK_SET(setup, type) \
494 ((type) == ARTWORK_TYPE_GRAPHICS ? \
495 (setup).graphics_set : \
496 (type) == ARTWORK_TYPE_SOUNDS ? \
497 (setup).sounds_set : \
500 #define SETUP_OVERRIDE_ARTWORK(setup, type) \
501 ((type) == ARTWORK_TYPE_GRAPHICS ? \
502 (setup).override_level_graphics : \
503 (type) == ARTWORK_TYPE_SOUNDS ? \
504 (setup).override_level_sounds : \
505 (setup).override_level_music)
507 #define ARTWORK_FIRST_NODE(artwork, type) \
508 ((type) == ARTWORK_TYPE_GRAPHICS ? \
509 (artwork).gfx_first : \
510 (type) == ARTWORK_TYPE_SOUNDS ? \
511 (artwork).snd_first : \
514 #define ARTWORK_CURRENT_IDENTIFIER_PTR(artwork, type) \
515 ((type) == ARTWORK_TYPE_GRAPHICS ? \
516 &(artwork).gfx_current_identifier : \
517 (type) == ARTWORK_TYPE_SOUNDS ? \
518 &(artwork).snd_current_identifier : \
519 &(artwork).mus_current_identifier)
521 #define ARTWORK_CURRENT_IDENTIFIER(artwork, type) \
522 ((type) == ARTWORK_TYPE_GRAPHICS ? \
523 (artwork).gfx_current_identifier : \
524 (type) == ARTWORK_TYPE_SOUNDS ? \
525 (artwork).snd_current_identifier : \
526 (artwork).mus_current_identifier)
528 #define ARTWORKINFO_FILENAME(type) \
529 ((type) == ARTWORK_TYPE_GRAPHICS ? \
530 GRAPHICSINFO_FILENAME : \
531 (type) == ARTWORK_TYPE_SOUNDS ? \
532 SOUNDSINFO_FILENAME : \
533 (type) == ARTWORK_TYPE_MUSIC ? \
534 MUSICINFO_FILENAME : "")
536 #define ARTWORK_DIRECTORY(type) \
537 ((type) == ARTWORK_TYPE_GRAPHICS ? \
538 GRAPHICS_DIRECTORY : \
539 (type) == ARTWORK_TYPE_SOUNDS ? \
541 (type) == ARTWORK_TYPE_MUSIC ? \
542 MUSIC_DIRECTORY : "")
544 #define OPTIONS_ARTWORK_DIRECTORY(type) \
545 ((type) == ARTWORK_TYPE_GRAPHICS ? \
546 options.graphics_directory : \
547 (type) == ARTWORK_TYPE_SOUNDS ? \
548 options.sounds_directory : \
549 (type) == ARTWORK_TYPE_MUSIC ? \
550 options.music_directory : "")
553 /* type definitions */
554 typedef int (*EventFilter)(const Event *);
557 /* structure definitions */
561 char *command_basepath; /* directory that contains the program */
562 char *command_basename; /* base filename of the program binary */
564 char *userdata_subdir; /* personal user game data directory */
565 char *userdata_subdir_unix; /* personal user game data directory (Unix) */
566 char *userdata_path; /* resulting full path to game data directory */
572 char *x11_icon_filename;
573 char *x11_iconmask_filename;
574 char *sdl_icon_filename;
575 char *msdos_cursor_filename;
578 char *filename_prefix; /* prefix to cut off from DOS filenames */
580 char *error_filename; /* filename where to write error messages to */
581 FILE *error_file; /* (used instead of 'stderr' on some systems) */
587 void (*exit_function)(int);
596 char *ro_base_directory;
597 char *rw_base_directory;
598 char *level_directory;
599 char *graphics_directory;
600 char *sounds_directory;
601 char *music_directory;
602 char *docs_directory;
603 char *execute_command;
611 struct ScreenModeInfo
616 struct VideoSystemInfo
619 int width, height, depth;
621 boolean fullscreen_available;
622 boolean fullscreen_enabled;
623 struct ScreenModeInfo *fullscreen_modes;
624 char *fullscreen_mode_current;
627 struct AudioSystemInfo
629 boolean sound_available;
630 boolean loops_available;
631 boolean music_available;
633 boolean sound_enabled;
634 boolean sound_deactivated; /* for temporarily disabling sound */
643 int first_sound_channel;
646 struct FontBitmapInfo
650 int src_x, src_y; /* start position of animation frames */
651 int width, height; /* width/height of each animation frame */
653 int draw_xoffset; /* offset for drawing font characters */
654 int draw_yoffset; /* offset for drawing font characters */
657 int num_chars_per_line;
659 #if defined(TARGET_X11_NATIVE_PERFORMANCE_WORKAROUND)
660 Pixmap *clip_mask; /* single-char-only clip mask array for X11 */
668 int real_sx, real_sy;
669 int full_sxsize, full_sysize;
670 int scrollbuffer_width, scrollbuffer_height;
678 int draw_deactivation_mask;
679 int draw_background_mask;
681 Bitmap *field_save_buffer;
683 Bitmap *background_bitmap;
684 int background_bitmap_mask;
687 struct FontBitmapInfo *font_bitmap_info;
688 int (*select_font_function)(int);
690 int anim_random_frame;
696 int fd[MAX_PLAYERS]; /* file descriptor of player's joystick */
699 struct SetupJoystickInfo
701 char *device_name; /* device name of player's joystick */
703 int xleft, xmiddle, xright;
704 int yupper, ymiddle, ylower;
708 struct SetupKeyboardInfo
710 Key left, right, up, down;
714 struct SetupInputInfo
716 boolean use_joystick;
717 struct SetupJoystickInfo joy;
718 struct SetupKeyboardInfo key;
721 struct SetupEditorInfo
723 boolean el_boulderdash;
724 boolean el_emerald_mine;
725 boolean el_emerald_mine_club;
729 boolean el_diamond_caves;
730 boolean el_dx_boulderdash;
732 boolean el_steel_chars;
734 boolean el_user_defined;
737 boolean el_headlines;
742 boolean show_element_token;
745 struct SetupEditorCascadeInfo
756 boolean el_steel_chars;
764 struct SetupShortcutInfo
770 Key focus_player[MAX_PLAYERS];
771 Key focus_player_all;
774 struct SetupSystemInfo
776 char *sdl_audiodriver;
777 int audio_fragment_size;
787 boolean sound_simple;
789 boolean double_buffering;
790 boolean direct_draw; /* !double_buffering (redundant!) */
791 boolean scroll_delay;
792 boolean soft_scrolling;
793 boolean fade_screens;
795 boolean show_titlescreen;
802 char *fullscreen_mode;
803 boolean ask_on_escape;
804 boolean ask_on_escape_editor;
805 boolean quick_switch;
806 boolean input_on_focus;
807 boolean prefer_aga_graphics;
808 int game_frame_delay;
813 boolean override_level_graphics;
814 boolean override_level_sounds;
815 boolean override_level_music;
817 struct SetupEditorInfo editor;
818 struct SetupEditorCascadeInfo editor_cascade;
819 struct SetupShortcutInfo shortcut;
820 struct SetupInputInfo input[MAX_PLAYERS];
821 struct SetupSystemInfo system;
822 struct OptionInfo options;
827 struct TreeInfo **node_top; /* topmost node in tree */
828 struct TreeInfo *node_parent; /* parent level directory info */
829 struct TreeInfo *node_group; /* level group sub-directory info */
830 struct TreeInfo *next; /* next level series structure node */
832 int cl_first; /* internal control field for setup screen */
833 int cl_cursor; /* internal control field for setup screen */
835 int type; /* type of tree content */
837 /* fields for "type == TREE_TYPE_LEVEL_DIR" */
839 char *subdir; /* tree info sub-directory basename (may be ".") */
840 char *fullpath; /* complete path relative to tree base directory */
841 char *basepath; /* absolute base path of tree base directory */
842 char *identifier; /* identifier string for configuration files */
843 char *name; /* tree info name, as displayed in selection menues */
844 char *name_sorting; /* optional sorting name for correct name sorting */
845 char *author; /* level or artwork author name */
846 char *imported_from; /* optional comment for imported levels or artwork */
847 char *imported_by; /* optional comment for imported levels or artwork */
849 char *graphics_set_ecs; /* special EMC custom graphics set (ECS graphics) */
850 char *graphics_set_aga; /* special EMC custom graphics set (AGA graphics) */
851 char *graphics_set; /* optional custom graphics set (level tree only) */
852 char *sounds_set; /* optional custom sounds set (level tree only) */
853 char *music_set; /* optional custom music set (level tree only) */
854 char *graphics_path; /* path to optional custom graphics set (level only) */
855 char *sounds_path; /* path to optional custom sounds set (level only) */
856 char *music_path; /* path to optional custom music set (level only) */
858 char *level_filename; /* filename of level file (for packed level file) */
859 char *level_filetype; /* type of levels in level directory or level file */
861 int levels; /* number of levels in level series */
862 int first_level; /* first level number (to allow start with 0 or 1) */
863 int last_level; /* last level number (automatically calculated) */
864 int sort_priority; /* sort levels by 'sort_priority' and then by name */
866 boolean latest_engine;/* force level set to use the latest game engine */
868 boolean level_group; /* directory contains more level series directories */
869 boolean parent_link; /* entry links back to parent directory */
870 boolean in_user_dir; /* user defined levels are stored in home directory */
871 boolean user_defined; /* levels in user directory and marked as "private" */
872 boolean readonly; /* readonly levels can not be changed with editor */
873 boolean handicap; /* level set has no handicap when set to "false" */
874 boolean skip_levels; /* levels can be skipped when set to "true" */
876 int color; /* color to use on selection screen for this level */
877 char *class_desc; /* description of level series class */
878 int handicap_level; /* number of the lowest unsolved level */
880 char *infotext; /* optional text to describe the tree type (headline) */
883 typedef struct TreeInfo TreeInfo;
884 typedef struct TreeInfo LevelDirTree;
885 typedef struct TreeInfo ArtworkDirTree;
886 typedef struct TreeInfo GraphicsDirTree;
887 typedef struct TreeInfo SoundsDirTree;
888 typedef struct TreeInfo MusicDirTree;
892 GraphicsDirTree *gfx_first;
893 GraphicsDirTree *gfx_current;
894 SoundsDirTree *snd_first;
895 SoundsDirTree *snd_current;
896 MusicDirTree *mus_first;
897 MusicDirTree *mus_current;
899 char *gfx_current_identifier;
900 char *snd_current_identifier;
901 char *mus_current_identifier;
916 struct ConfigTypeInfo
923 struct TokenIntPtrInfo
933 char *default_filename;
936 char **default_parameter; /* array of file parameters */
937 char **parameter; /* array of file parameters */
940 boolean fallback_to_default;
948 struct SetupFileList *next;
953 char *source_filename; /* primary key for node list */
957 struct PropertyMapping
967 struct ArtworkListInfo
969 int type; /* type of artwork */
971 int num_file_list_entries;
972 int num_dynamic_file_list_entries;
973 struct FileInfo *file_list; /* static artwork file array */
974 struct FileInfo *dynamic_file_list; /* dynamic artwrk file array */
976 int num_suffix_list_entries;
977 struct ConfigTypeInfo *suffix_list; /* parameter suffixes array */
979 int num_base_prefixes;
980 int num_ext1_suffixes;
981 int num_ext2_suffixes;
982 int num_ext3_suffixes;
983 char **base_prefixes; /* base token prefixes array */
984 char **ext1_suffixes; /* property suffixes array 1 */
985 char **ext2_suffixes; /* property suffixes array 2 */
986 char **ext3_suffixes; /* property suffixes array 3 */
988 int num_ignore_tokens;
989 char **ignore_tokens; /* file tokens to be ignored */
991 int num_property_mapping_entries;
992 struct PropertyMapping *property_mapping; /* mapping token -> artwork */
994 int sizeof_artwork_list_entry;
996 struct ListNodeInfo **artwork_list; /* static artwork node array */
997 struct ListNodeInfo **dynamic_artwork_list; /* dynamic artwrk node array */
998 struct ListNode *content_list; /* dynamic artwork node list */
1000 void *(*load_artwork)(char *); /* constructor function */
1001 void (*free_artwork)(void *); /* destructor function */
1033 /* ========================================================================= */
1034 /* exported variables */
1035 /* ========================================================================= */
1037 extern struct ProgramInfo program;
1038 extern struct OptionInfo options;
1039 extern struct VideoSystemInfo video;
1040 extern struct AudioSystemInfo audio;
1041 extern struct GfxInfo gfx;
1042 extern struct AnimInfo anim;
1043 extern struct ArtworkInfo artwork;
1044 extern struct JoystickInfo joystick;
1045 extern struct SetupInfo setup;
1047 extern LevelDirTree *leveldir_first_all;
1048 extern LevelDirTree *leveldir_first;
1049 extern LevelDirTree *leveldir_current;
1050 extern int level_nr;
1052 extern Display *display;
1053 extern Visual *visual;
1055 extern Colormap cmap;
1057 extern DrawWindow *window;
1058 extern DrawBuffer *backbuffer;
1059 extern DrawBuffer *drawto;
1061 extern int button_status;
1062 extern boolean motion_status;
1064 extern int redraw_mask;
1065 extern int redraw_tiles;
1067 extern int FrameCounter;
1070 /* function definitions */
1072 void InitProgramInfo(char *, char *, char *, char *, char *, char *, char *,
1073 char *, char *, char *, char *, char *, int);
1075 void InitExitFunction(void (*exit_function)(int));
1076 void InitPlatformDependentStuff(void);
1077 void ClosePlatformDependentStuff(void);
1079 void InitGfxFieldInfo(int, int, int, int, int, int, int, int, Bitmap *);
1080 void InitGfxDoor1Info(int, int, int, int);
1081 void InitGfxDoor2Info(int, int, int, int);
1082 void InitGfxScrollbufferInfo(int, int);
1083 void SetDrawDeactivationMask(int);
1084 void SetDrawBackgroundMask(int);
1085 void SetWindowBackgroundBitmap(Bitmap *);
1086 void SetMainBackgroundBitmap(Bitmap *);
1087 void SetDoorBackgroundBitmap(Bitmap *);
1089 void InitVideoDisplay(void);
1090 void CloseVideoDisplay(void);
1091 void InitVideoBuffer(int, int, int, boolean);
1092 Bitmap *CreateBitmapStruct(void);
1093 Bitmap *CreateBitmap(int, int, int);
1094 void FreeBitmap(Bitmap *);
1095 void BlitBitmap(Bitmap *, Bitmap *, int, int, int, int, int, int);
1096 void FadeRectangle(Bitmap *bitmap, int, int, int, int, int, int, int,
1097 void (*draw_border_function)(void));
1098 void FillRectangle(Bitmap *, int, int, int, int, Pixel);
1099 void ClearRectangle(Bitmap *, int, int, int, int);
1100 void ClearRectangleOnBackground(Bitmap *, int, int, int, int);
1101 void SetClipMask(Bitmap *, GC, Pixmap);
1102 void SetClipOrigin(Bitmap *, GC, int, int);
1103 void BlitBitmapMasked(Bitmap *, Bitmap *, int, int, int, int, int, int);
1104 boolean DrawingOnBackground(int, int);
1105 void BlitBitmapOnBackground(Bitmap *, Bitmap *, int, int, int, int, int, int);
1106 void DrawSimpleBlackLine(Bitmap *, int, int, int, int);
1107 void DrawSimpleWhiteLine(Bitmap *, int, int, int, int);
1108 void DrawLines(Bitmap *, struct XY *, int, Pixel);
1109 Pixel GetPixel(Bitmap *, int, int);
1110 Pixel GetPixelFromRGB(Bitmap *, unsigned int,unsigned int,unsigned int);
1111 Pixel GetPixelFromRGBcompact(Bitmap *, unsigned int);
1113 void FlushDisplay(void);
1114 void SyncDisplay(void);
1115 void KeyboardAutoRepeatOn(void);
1116 void KeyboardAutoRepeatOff(void);
1117 boolean PointerInWindow(DrawWindow *);
1118 boolean SetVideoMode(boolean);
1119 boolean ChangeVideoModeIfNeeded(boolean);
1121 Bitmap *LoadImage(char *);
1122 Bitmap *LoadCustomImage(char *);
1123 void ReloadCustomImage(Bitmap *, char *);
1125 Bitmap *ZoomBitmap(Bitmap *, int, int);
1126 void CreateBitmapWithSmallBitmaps(Bitmap *, int);
1127 void ScaleBitmap(Bitmap *, int);
1129 void SetMouseCursor(int);
1131 void OpenAudio(void);
1132 void CloseAudio(void);
1133 void SetAudioMode(boolean);
1135 void InitEventFilter(EventFilter);
1136 boolean PendingEvent(void);
1137 void NextEvent(Event *event);
1138 void PeekEvent(Event *event);
1139 Key GetEventKey(KeyEvent *, boolean);
1140 KeyMod HandleKeyModState(Key, int);
1141 KeyMod GetKeyModState();
1142 KeyMod GetKeyModStateFromEvents();
1143 boolean CheckCloseWindowEvent(ClientMessageEvent *);
1145 void InitJoysticks();
1146 boolean ReadJoystick(int, int *, int *, boolean *, boolean *);
1148 #endif /* SYSTEM_H */