1 /***********************************************************
2 * Artsoft Retro-Game Library *
3 *----------------------------------------------------------*
4 * (c) 1994-2002 Artsoft Entertainment *
6 * Detmolder Strasse 189 *
9 * e-mail: info@artsoft.org *
10 *----------------------------------------------------------*
12 ***********************************************************/
20 #if defined(PLATFORM_MSDOS)
24 #if defined(TARGET_SDL)
26 #elif defined(TARGET_X11)
30 #if defined(PLATFORM_MACOSX)
31 /* some symbols are already defined on Mac OS X */
32 #define Delay Delay_internal
33 #define DrawLine DrawLine_internal
34 #define DrawText DrawText_internal
35 #define GetPixel GetPixel_internal
39 /* the additional 'b' is needed for Win32 to open files in binary mode */
40 #define MODE_READ "rb"
41 #define MODE_WRITE "wb"
42 #define MODE_APPEND "ab"
44 #define DEFAULT_DEPTH 0
46 #define FULLSCREEN_NOT_AVAILABLE FALSE
47 #define FULLSCREEN_AVAILABLE TRUE
49 /* default input keys */
50 #define DEFAULT_KEY_LEFT KSYM_Left
51 #define DEFAULT_KEY_RIGHT KSYM_Right
52 #define DEFAULT_KEY_UP KSYM_Up
53 #define DEFAULT_KEY_DOWN KSYM_Down
54 #if defined(PLATFORM_MACOSX)
55 #define DEFAULT_KEY_SNAP KSYM_Control_L
56 #define DEFAULT_KEY_BOMB KSYM_KP_Enter
58 #define DEFAULT_KEY_SNAP KSYM_Shift_L
59 #define DEFAULT_KEY_BOMB KSYM_Shift_R
61 #define DEFAULT_KEY_OKAY KSYM_Return
62 #define DEFAULT_KEY_CANCEL KSYM_Escape
64 /* default shortcut keys */
65 #define DEFAULT_KEY_SAVE_GAME KSYM_F1
66 #define DEFAULT_KEY_LOAD_GAME KSYM_F2
67 #define DEFAULT_KEY_TOGGLE_PAUSE KSYM_space
69 /* values for move directions and special "button" keys */
71 #define MV_BIT_RIGHT 1
74 #define NUM_DIRECTIONS 4
76 #define MV_NO_MOVING 0
77 #define MV_LEFT (1 << MV_BIT_LEFT)
78 #define MV_RIGHT (1 << MV_BIT_RIGHT)
79 #define MV_UP (1 << MV_BIT_UP)
80 #define MV_DOWN (1 << MV_BIT_DOWN)
81 #define KEY_BUTTON_1 (1 << 4)
82 #define KEY_BUTTON_2 (1 << 5)
83 #define KEY_MOTION (MV_LEFT | MV_RIGHT | MV_UP | MV_DOWN)
84 #define KEY_BUTTON (KEY_BUTTON_1 | KEY_BUTTON_2)
85 #define KEY_ACTION (KEY_MOTION | KEY_BUTTON)
87 #define MV_DIR_BIT(x) ((x) == MV_LEFT ? MV_BIT_LEFT : \
88 (x) == MV_RIGHT ? MV_BIT_RIGHT : \
89 (x) == MV_UP ? MV_BIT_UP : MV_BIT_DOWN)
91 /* values for button status */
92 #define MB_NOT_PRESSED FALSE
93 #define MB_NOT_RELEASED TRUE
94 #define MB_RELEASED FALSE
95 #define MB_PRESSED TRUE
96 #define MB_MENU_CHOICE FALSE
97 #define MB_MENU_MARK TRUE
98 #define MB_MENU_INITIALIZE (-1)
99 #define MB_MENU_LEAVE (-2)
100 #define MB_LEFTBUTTON 1
101 #define MB_MIDDLEBUTTON 2
102 #define MB_RIGHTBUTTON 3
104 /* values for redraw_mask */
105 #define REDRAW_NONE (0)
106 #define REDRAW_ALL (1 << 0)
107 #define REDRAW_FIELD (1 << 1)
108 #define REDRAW_TILES (1 << 2)
109 #define REDRAW_DOOR_1 (1 << 3)
110 #define REDRAW_VIDEO_1 (1 << 4)
111 #define REDRAW_VIDEO_2 (1 << 5)
112 #define REDRAW_VIDEO_3 (1 << 6)
113 #define REDRAW_MICROLEVEL (1 << 7)
114 #define REDRAW_MICROLABEL (1 << 8)
115 #define REDRAW_FROM_BACKBUFFER (1 << 9)
116 #define REDRAW_DOOR_2 (REDRAW_VIDEO_1 | \
119 #define REDRAW_DOOR_3 (1 << 10)
120 #define REDRAW_DOORS (REDRAW_DOOR_1 | \
123 #define REDRAW_MAIN (REDRAW_FIELD | \
126 #define REDRAW_FPS (1 << 11)
127 #define REDRAWTILES_THRESHOLD (SCR_FIELDX * SCR_FIELDY / 2)
129 /* maximum number of parallel players supported by libgame functions */
130 #define MAX_PLAYERS 4
132 /* maximum allowed length of player name */
133 #define MAX_PLAYER_NAME_LEN 10
135 /* default name for empty highscore entry */
136 #define EMPTY_PLAYER_NAME "no name"
138 /* default name for unknown player names */
139 #define ANONYMOUS_NAME "anonymous"
141 /* default name for new levels */
142 #define NAMELESS_LEVEL_NAME "nameless level"
144 /* default text for non-existant artwork */
145 #define NOT_AVAILABLE "(not available)"
147 /* default value for undefined filename */
148 #define UNDEFINED_FILENAME "[NONE]"
150 /* default values for undefined configuration file parameters */
151 #define ARG_UNDEFINED "-1000000"
152 #define ARG_UNDEFINED_VALUE (atoi(ARG_UNDEFINED))
154 /* definitions for game sub-directories */
156 #define RO_GAME_DIR "."
160 #define RW_GAME_DIR "."
163 #define RO_BASE_PATH RO_GAME_DIR
164 #define RW_BASE_PATH RW_GAME_DIR
166 #define GRAPHICS_DIRECTORY "graphics"
167 #define SOUNDS_DIRECTORY "sounds"
168 #define MUSIC_DIRECTORY "music"
169 #define LEVELS_DIRECTORY "levels"
170 #define TAPES_DIRECTORY "tapes"
171 #define SCORES_DIRECTORY "scores"
173 #if !defined(PLATFORM_MSDOS)
174 #define GRAPHICS_SUBDIR "gfx_classic"
175 #define SOUNDS_SUBDIR "snd_classic"
176 #define MUSIC_SUBDIR "mus_classic"
178 #define GRAPHICS_SUBDIR "gfx_orig"
179 #define SOUNDS_SUBDIR "snd_orig"
180 #define MUSIC_SUBDIR "mus_orig"
183 /* areas in bitmap PIX_DOOR */
184 /* meaning in PIX_DB_DOOR: (3 PAGEs)
185 PAGEX1: 1. buffer for DOOR_1
186 PAGEX2: 2. buffer for DOOR_1
187 PAGEX3: buffer for animations
190 #define DOOR_GFX_PAGESIZE (gfx.dxsize)
191 #define DOOR_GFX_PAGEX1 (0 * DOOR_GFX_PAGESIZE)
192 #define DOOR_GFX_PAGEX2 (1 * DOOR_GFX_PAGESIZE)
193 #define DOOR_GFX_PAGEX3 (2 * DOOR_GFX_PAGESIZE)
194 #define DOOR_GFX_PAGEX4 (3 * DOOR_GFX_PAGESIZE)
195 #define DOOR_GFX_PAGEX5 (4 * DOOR_GFX_PAGESIZE)
196 #define DOOR_GFX_PAGEX6 (5 * DOOR_GFX_PAGESIZE)
197 #define DOOR_GFX_PAGEX7 (6 * DOOR_GFX_PAGESIZE)
198 #define DOOR_GFX_PAGEX8 (7 * DOOR_GFX_PAGESIZE)
199 #define DOOR_GFX_PAGEY1 (0)
200 #define DOOR_GFX_PAGEY2 (gfx.dysize)
202 /* functions for version handling */
203 #define VERSION_IDENT(x,y,z) ((x) * 10000 + (y) * 100 + (z))
204 #define VERSION_MAJOR(x) ((x) / 10000)
205 #define VERSION_MINOR(x) (((x) % 10000) / 100)
206 #define VERSION_PATCH(x) ((x) % 100)
208 /* functions for parent/child process identification */
209 #if defined(PLATFORM_UNIX)
210 #define IS_PARENT_PROCESS() (audio.mixer_pid != getpid())
211 #define IS_CHILD_PROCESS() (audio.mixer_pid == getpid())
213 #define IS_PARENT_PROCESS() TRUE
214 #define IS_CHILD_PROCESS() FALSE
217 /* type definitions */
218 typedef int (*EventFilter)(const Event *);
221 /* structure definitions */
225 char *command_basename;
226 char *userdata_directory;
232 char *x11_icon_filename;
233 char *x11_iconmask_filename;
234 char *msdos_pointer_filename;
237 char *filename_prefix; /* prefix to cut off from DOS filenames */
243 void (*exit_function)(int);
252 char *ro_base_directory;
253 char *rw_base_directory;
254 char *level_directory;
255 char *graphics_directory;
256 char *sounds_directory;
257 char *music_directory;
258 char *execute_command;
266 struct VideoSystemInfo
269 int width, height, depth;
270 boolean fullscreen_available;
271 boolean fullscreen_enabled;
274 struct AudioSystemInfo
276 boolean sound_available;
277 boolean loops_available;
278 boolean music_available;
280 boolean sound_enabled;
281 boolean sound_deactivated; /* for temporarily disabling sound */
290 int first_sound_channel;
296 int src_x, src_y; /* start position of animation frames */
297 int width, height; /* width/height of each animation frame */
298 int draw_x, draw_y; /* offset for drawing font characters */
300 #if defined(TARGET_X11_NATIVE_PERFORMANCE_WORKAROUND)
301 Pixmap *clip_mask; /* single-char-only clip mask array for X11 */
309 int real_sx, real_sy;
310 int full_sxsize, full_sysize;
311 int scrollbuffer_width, scrollbuffer_height;
319 int draw_deactivation_mask;
320 int draw_background_mask;
322 Bitmap *background_bitmap;
323 int background_bitmap_mask;
325 boolean menu_main_hide_static_text;
328 struct FontInfo *font;
339 int fd[MAX_PLAYERS]; /* file descriptor of player's joystick */
342 struct SetupJoystickInfo
344 char *device_name; /* device name of player's joystick */
346 int xleft, xmiddle, xright;
347 int yupper, ymiddle, ylower;
352 struct SetupKeyboardInfo
362 struct SetupInputInfo
364 boolean use_joystick;
365 struct SetupJoystickInfo joy;
366 struct SetupKeyboardInfo key;
369 struct SetupEditorInfo
371 boolean el_boulderdash;
372 boolean el_emerald_mine;
376 boolean el_diamond_caves;
377 boolean el_dx_boulderdash;
382 struct SetupShortcutInfo
396 boolean sound_simple;
398 boolean double_buffering;
399 boolean direct_draw; /* !double_buffering (redundant!) */
400 boolean scroll_delay;
401 boolean soft_scrolling;
409 boolean ask_on_escape;
414 boolean override_level_graphics;
415 boolean override_level_sounds;
416 boolean override_level_music;
418 struct SetupEditorInfo editor;
419 struct SetupShortcutInfo shortcut;
420 struct SetupInputInfo input[MAX_PLAYERS];
423 #define TREE_TYPE_GENERIC 0
424 #define TREE_TYPE_GRAPHICS_DIR 1
425 #define TREE_TYPE_SOUNDS_DIR 2
426 #define TREE_TYPE_MUSIC_DIR 3
427 #define TREE_TYPE_LEVEL_DIR 4
429 #define ARTWORK_TYPE_GRAPHICS TREE_TYPE_GRAPHICS_DIR
430 #define ARTWORK_TYPE_SOUNDS TREE_TYPE_SOUNDS_DIR
431 #define ARTWORK_TYPE_MUSIC TREE_TYPE_MUSIC_DIR
435 struct TreeInfo **node_top; /* topmost node in tree */
436 struct TreeInfo *node_parent; /* parent level directory info */
437 struct TreeInfo *node_group; /* level group sub-directory info */
438 struct TreeInfo *next; /* next level series structure node */
440 int cl_first; /* internal control field for setup screen */
441 int cl_cursor; /* internal control field for setup screen */
443 int type; /* type of tree content */
445 /* fields for "type == TREE_TYPE_LEVEL_DIR" */
447 char *filename; /* tree info sub-directory basename (may be ".") */
448 char *fullpath; /* complete path relative to tree base directory */
449 char *basepath; /* absolute base path of tree base directory */
450 char *identifier; /* identifier string for configuration files */
451 char *name; /* tree info name, as displayed in selection menues */
452 char *name_sorting; /* optional sorting name for correct name sorting */
453 char *author; /* level or artwork author name */
454 char *imported_from; /* optional comment for imported levels or artwork */
456 char *graphics_set; /* optional custom graphics set (level tree only) */
457 char *sounds_set; /* optional custom sounds set (level tree only) */
458 char *music_set; /* optional custom music set (level tree only) */
459 char *graphics_path; /* path to optional custom graphics set (level only) */
460 char *sounds_path; /* path to optional custom sounds set (level only) */
461 char *music_path; /* path to optional custom music set (level only) */
463 int levels; /* number of levels in level series */
464 int first_level; /* first level number (to allow start with 0 or 1) */
465 int last_level; /* last level number (automatically calculated) */
466 int sort_priority; /* sort levels by 'sort_priority' and then by name */
468 boolean level_group; /* directory contains more level series directories */
469 boolean parent_link; /* entry links back to parent directory */
470 boolean user_defined; /* user defined levels are stored in home directory */
471 boolean readonly; /* readonly levels can not be changed with editor */
473 int color; /* color to use on selection screen for this level */
474 char *class_desc; /* description of level series class */
475 int handicap_level; /* number of the lowest unsolved level */
478 typedef struct TreeInfo TreeInfo;
479 typedef struct TreeInfo LevelDirTree;
480 typedef struct TreeInfo ArtworkDirTree;
481 typedef struct TreeInfo GraphicsDirTree;
482 typedef struct TreeInfo SoundsDirTree;
483 typedef struct TreeInfo MusicDirTree;
487 GraphicsDirTree *gfx_first;
488 GraphicsDirTree *gfx_current;
489 SoundsDirTree *snd_first;
490 SoundsDirTree *snd_current;
491 MusicDirTree *mus_first;
492 MusicDirTree *mus_current;
494 char *gfx_current_identifier;
495 char *snd_current_identifier;
496 char *mus_current_identifier;
510 char *default_filename;
513 char **default_parameter; /* array of file parameters */
514 char **parameter; /* array of file parameters */
524 struct SetupFileList *next;
529 char *source_filename; /* primary key for node list */
533 struct PropertyMapping
543 struct ArtworkListInfo
545 int type; /* type of artwork */
547 int num_file_list_entries;
548 int num_dynamic_file_list_entries;
549 struct FileInfo *file_list; /* static artwork file array */
550 struct FileInfo *dynamic_file_list; /* dynamic artwrk file array */
552 int num_suffix_list_entries;
553 struct ConfigInfo *suffix_list; /* parameter suffixes array */
555 int num_base_prefixes;
556 int num_ext1_suffixes;
557 int num_ext2_suffixes;
558 int num_ext3_suffixes;
559 char **base_prefixes; /* base token prefixes array */
560 char **ext1_suffixes; /* property suffixes array 1 */
561 char **ext2_suffixes; /* property suffixes array 2 */
562 char **ext3_suffixes; /* property suffixes array 3 */
564 int num_ignore_tokens;
565 char **ignore_tokens; /* file tokens to be ignored */
567 int num_property_mapping_entries;
568 struct PropertyMapping *property_mapping; /* mapping token -> artwork */
570 int sizeof_artwork_list_entry;
572 struct ListNodeInfo **artwork_list; /* static artwork node array */
573 struct ListNodeInfo **dynamic_artwork_list; /* dynamic artwrk node array */
574 struct ListNode *content_list; /* dynamic artwork node list */
576 void *(*load_artwork)(char *); /* constructor function */
577 void (*free_artwork)(void *); /* destructor function */
581 /* ========================================================================= */
582 /* exported variables */
583 /* ========================================================================= */
585 extern struct ProgramInfo program;
586 extern struct OptionInfo options;
587 extern struct VideoSystemInfo video;
588 extern struct AudioSystemInfo audio;
589 extern struct GfxInfo gfx;
590 extern struct AnimInfo anim;
591 extern struct ArtworkInfo artwork;
592 extern struct JoystickInfo joystick;
593 extern struct SetupInfo setup;
595 extern LevelDirTree *leveldir_first;
596 extern LevelDirTree *leveldir_current;
599 extern Display *display;
600 extern Visual *visual;
602 extern Colormap cmap;
604 extern DrawWindow *window;
605 extern DrawBuffer *backbuffer;
606 extern DrawBuffer *drawto;
608 extern int button_status;
609 extern boolean motion_status;
611 extern int redraw_mask;
612 extern int redraw_tiles;
614 extern int FrameCounter;
617 /* function definitions */
619 void InitCommandName(char *);
620 void InitExitFunction(void (*exit_function)(int));
621 void InitPlatformDependantStuff(void);
622 void ClosePlatformDependantStuff(void);
624 void InitProgramInfo(char *, char *, char *, char *, char *, char *, char *,
625 char *, char *, int);
627 void InitGfxFieldInfo(int, int, int, int, int, int, int, int);
628 void InitGfxDoor1Info(int, int, int, int);
629 void InitGfxDoor2Info(int, int, int, int);
630 void InitGfxScrollbufferInfo(int, int);
631 void SetDrawDeactivationMask(int);
632 void SetDrawBackgroundMask(int);
633 void SetMainBackgroundBitmap(Bitmap *);
634 void SetDoorBackgroundBitmap(Bitmap *);
636 inline void InitVideoDisplay(void);
637 inline void CloseVideoDisplay(void);
638 inline void InitVideoBuffer(DrawBuffer **,DrawWindow **, int,int,int, boolean);
639 inline Bitmap *CreateBitmapStruct(void);
640 inline Bitmap *CreateBitmap(int, int, int);
641 inline void FreeBitmap(Bitmap *);
642 inline void BlitBitmap(Bitmap *, Bitmap *, int, int, int, int, int, int);
643 inline void ClearRectangle(Bitmap *, int, int, int, int);
644 inline void ClearRectangleOnBackground(Bitmap *, int, int, int, int);
645 inline void SetClipMask(Bitmap *, GC, Pixmap);
646 inline void SetClipOrigin(Bitmap *, GC, int, int);
647 inline void BlitBitmapMasked(Bitmap *, Bitmap *, int, int, int, int, int, int);
648 inline boolean DrawingOnBackground(int, int);
649 inline void BlitBitmapOnBackground(Bitmap *, Bitmap *, int, int, int, int, int,
651 inline void DrawSimpleWhiteLine(Bitmap *, int, int, int, int);
652 inline void DrawLines(Bitmap *, struct XY *, int, Pixel);
653 inline Pixel GetPixel(Bitmap *, int, int);
654 inline Pixel GetPixelFromRGB(Bitmap *, unsigned int,unsigned int,unsigned int);
655 inline Pixel GetPixelFromRGBcompact(Bitmap *, unsigned int);
657 inline void FlushDisplay(void);
658 inline void SyncDisplay(void);
659 inline void KeyboardAutoRepeatOn(void);
660 inline void KeyboardAutoRepeatOff(void);
661 inline boolean PointerInWindow(DrawWindow *);
662 inline boolean SetVideoMode(boolean);
663 inline boolean ChangeVideoModeIfNeeded(boolean);
665 Bitmap *LoadImage(char *);
666 Bitmap *LoadCustomImage(char *);
667 void ReloadCustomImage(Bitmap *, char *);
669 Bitmap *ZoomBitmap(Bitmap *, int, int);
670 void CreateBitmapWithSmallBitmaps(Bitmap *);
672 inline void OpenAudio(void);
673 inline void CloseAudio(void);
674 inline void SetAudioMode(boolean);
676 inline void InitEventFilter(EventFilter);
677 inline boolean PendingEvent(void);
678 inline void NextEvent(Event *event);
679 inline Key GetEventKey(KeyEvent *, boolean);
680 inline boolean CheckCloseWindowEvent(ClientMessageEvent *);
682 inline void InitJoysticks();
683 inline boolean ReadJoystick(int, int *, int *, boolean *, boolean *);
685 #endif /* SYSTEM_H */