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 ***********************************************************/
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_BOMB KSYM_KP_Enter
60 #define DEFAULT_KEY_SNAP KSYM_Shift_L
61 #define DEFAULT_KEY_BOMB KSYM_Shift_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
72 /* values for move directions and special "button" keys */
74 #define MV_BIT_RIGHT 1
77 #define NUM_DIRECTIONS 4
79 #define MV_NO_MOVING 0
80 #define MV_LEFT (1 << MV_BIT_LEFT)
81 #define MV_RIGHT (1 << MV_BIT_RIGHT)
82 #define MV_UP (1 << MV_BIT_UP)
83 #define MV_DOWN (1 << MV_BIT_DOWN)
84 #define KEY_BUTTON_1 (1 << 4)
85 #define KEY_BUTTON_2 (1 << 5)
86 #define KEY_MOTION (MV_LEFT | MV_RIGHT | MV_UP | MV_DOWN)
87 #define KEY_BUTTON (KEY_BUTTON_1 | KEY_BUTTON_2)
88 #define KEY_ACTION (KEY_MOTION | KEY_BUTTON)
90 #define MV_DIR_BIT(x) ((x) == MV_LEFT ? MV_BIT_LEFT : \
91 (x) == MV_RIGHT ? MV_BIT_RIGHT : \
92 (x) == MV_UP ? MV_BIT_UP : MV_BIT_DOWN)
95 /* values for button status */
96 #define MB_NOT_PRESSED FALSE
97 #define MB_NOT_RELEASED TRUE
98 #define MB_RELEASED FALSE
99 #define MB_PRESSED TRUE
100 #define MB_MENU_CHOICE FALSE
101 #define MB_MENU_MARK TRUE
102 #define MB_MENU_INITIALIZE (-1)
103 #define MB_MENU_LEAVE (-2)
104 #define MB_LEFTBUTTON 1
105 #define MB_MIDDLEBUTTON 2
106 #define MB_RIGHTBUTTON 3
109 /* values for animation mode (frame order and direction) */
111 #define ANIM_LOOP (1 << 0)
112 #define ANIM_LINEAR (1 << 1)
113 #define ANIM_PINGPONG (1 << 2)
114 #define ANIM_PINGPONG2 (1 << 3)
115 #define ANIM_RANDOM (1 << 4)
116 #define ANIM_REVERSE (1 << 5)
119 /* values for redraw_mask */
120 #define REDRAW_NONE (0)
121 #define REDRAW_ALL (1 << 0)
122 #define REDRAW_FIELD (1 << 1)
123 #define REDRAW_TILES (1 << 2)
124 #define REDRAW_DOOR_1 (1 << 3)
125 #define REDRAW_VIDEO_1 (1 << 4)
126 #define REDRAW_VIDEO_2 (1 << 5)
127 #define REDRAW_VIDEO_3 (1 << 6)
128 #define REDRAW_MICROLEVEL (1 << 7)
129 #define REDRAW_MICROLABEL (1 << 8)
130 #define REDRAW_FROM_BACKBUFFER (1 << 9)
131 #define REDRAW_DOOR_2 (REDRAW_VIDEO_1 | \
134 #define REDRAW_DOOR_3 (1 << 10)
135 #define REDRAW_DOORS (REDRAW_DOOR_1 | \
138 #define REDRAW_MAIN (REDRAW_FIELD | \
141 #define REDRAW_FPS (1 << 11)
142 #define REDRAWTILES_THRESHOLD (SCR_FIELDX * SCR_FIELDY / 2)
145 /* values for mouse cursor */
146 #define CURSOR_DEFAULT 0
147 #define CURSOR_PLAYFIELD 1
150 /* maximum number of parallel players supported by libgame functions */
151 #define MAX_PLAYERS 4
153 /* maximum allowed length of player name */
154 #define MAX_PLAYER_NAME_LEN 10
156 /* default name for empty highscore entry */
157 #define EMPTY_PLAYER_NAME "no name"
159 /* default name for unknown player names */
160 #define ANONYMOUS_NAME "anonymous"
162 /* default name for new levels */
163 #define NAMELESS_LEVEL_NAME "nameless level"
165 /* default text for non-existant artwork */
166 #define NOT_AVAILABLE "(not available)"
168 /* default value for undefined filename */
169 #define UNDEFINED_FILENAME "[NONE]"
171 /* default value for undefined parameter */
172 #define ARG_DEFAULT "[DEFAULT]"
174 /* default values for undefined configuration file parameters */
175 #define ARG_UNDEFINED "-1000000"
176 #define ARG_UNDEFINED_VALUE (atoi(ARG_UNDEFINED))
178 /* definitions for game sub-directories */
180 #define RO_GAME_DIR "."
184 #define RW_GAME_DIR "."
187 #define RO_BASE_PATH RO_GAME_DIR
188 #define RW_BASE_PATH RW_GAME_DIR
190 #define GRAPHICS_DIRECTORY "graphics"
191 #define SOUNDS_DIRECTORY "sounds"
192 #define MUSIC_DIRECTORY "music"
193 #define LEVELS_DIRECTORY "levels"
194 #define TAPES_DIRECTORY "tapes"
195 #define SCORES_DIRECTORY "scores"
197 #if !defined(PLATFORM_MSDOS)
198 #define GRAPHICS_SUBDIR "gfx_classic"
199 #define SOUNDS_SUBDIR "snd_classic"
200 #define MUSIC_SUBDIR "mus_classic"
202 #define GRAPHICS_SUBDIR "gfx_orig"
203 #define SOUNDS_SUBDIR "snd_orig"
204 #define MUSIC_SUBDIR "mus_orig"
207 /* areas in bitmap PIX_DOOR */
208 /* meaning in PIX_DB_DOOR: (3 PAGEs)
209 PAGEX1: 1. buffer for DOOR_1
210 PAGEX2: 2. buffer for DOOR_1
211 PAGEX3: buffer for animations
214 #define DOOR_GFX_PAGESIZE (gfx.dxsize)
215 #define DOOR_GFX_PAGEX1 (0 * DOOR_GFX_PAGESIZE)
216 #define DOOR_GFX_PAGEX2 (1 * DOOR_GFX_PAGESIZE)
217 #define DOOR_GFX_PAGEX3 (2 * DOOR_GFX_PAGESIZE)
218 #define DOOR_GFX_PAGEX4 (3 * DOOR_GFX_PAGESIZE)
219 #define DOOR_GFX_PAGEX5 (4 * DOOR_GFX_PAGESIZE)
220 #define DOOR_GFX_PAGEX6 (5 * DOOR_GFX_PAGESIZE)
221 #define DOOR_GFX_PAGEX7 (6 * DOOR_GFX_PAGESIZE)
222 #define DOOR_GFX_PAGEX8 (7 * DOOR_GFX_PAGESIZE)
223 #define DOOR_GFX_PAGEY1 (0)
224 #define DOOR_GFX_PAGEY2 (gfx.dysize)
226 /* functions for version handling */
227 #define VERSION_IDENT(x,y,z) ((x) * 10000 + (y) * 100 + (z))
228 #define VERSION_MAJOR(x) ((x) / 10000)
229 #define VERSION_MINOR(x) (((x) % 10000) / 100)
230 #define VERSION_PATCH(x) ((x) % 100)
232 /* functions for parent/child process identification */
233 #if defined(PLATFORM_UNIX)
234 #define IS_PARENT_PROCESS() (audio.mixer_pid != getpid())
235 #define IS_CHILD_PROCESS() (audio.mixer_pid == getpid())
237 #define IS_PARENT_PROCESS() TRUE
238 #define IS_CHILD_PROCESS() FALSE
241 /* type definitions */
242 typedef int (*EventFilter)(const Event *);
245 /* structure definitions */
249 char *command_basename;
250 char *userdata_directory;
256 char *x11_icon_filename;
257 char *x11_iconmask_filename;
258 char *msdos_cursor_filename;
261 char *filename_prefix; /* prefix to cut off from DOS filenames */
267 void (*exit_function)(int);
276 char *ro_base_directory;
277 char *rw_base_directory;
278 char *level_directory;
279 char *graphics_directory;
280 char *sounds_directory;
281 char *music_directory;
282 char *execute_command;
290 struct VideoSystemInfo
293 int width, height, depth;
294 boolean fullscreen_available;
295 boolean fullscreen_enabled;
298 struct AudioSystemInfo
300 boolean sound_available;
301 boolean loops_available;
302 boolean music_available;
304 boolean sound_enabled;
305 boolean sound_deactivated; /* for temporarily disabling sound */
314 int first_sound_channel;
317 struct FontBitmapInfo
320 int src_x, src_y; /* start position of animation frames */
321 int width, height; /* width/height of each animation frame */
322 int draw_x, draw_y; /* offset for drawing font characters */
324 int num_chars_per_line;
326 #if defined(TARGET_X11_NATIVE_PERFORMANCE_WORKAROUND)
327 Pixmap *clip_mask; /* single-char-only clip mask array for X11 */
328 int last_num_chars; /* to free last font clip masks */
336 int real_sx, real_sy;
337 int full_sxsize, full_sysize;
338 int scrollbuffer_width, scrollbuffer_height;
346 int draw_deactivation_mask;
347 int draw_background_mask;
349 Bitmap *field_save_buffer;
351 Bitmap *background_bitmap;
352 int background_bitmap_mask;
355 struct FontBitmapInfo *font_bitmap_info;
356 int (*select_font_function)(int);
358 int anim_random_frame;
364 int fd[MAX_PLAYERS]; /* file descriptor of player's joystick */
367 struct SetupJoystickInfo
369 char *device_name; /* device name of player's joystick */
371 int xleft, xmiddle, xright;
372 int yupper, ymiddle, ylower;
377 struct SetupKeyboardInfo
387 struct SetupInputInfo
389 boolean use_joystick;
390 struct SetupJoystickInfo joy;
391 struct SetupKeyboardInfo key;
394 struct SetupEditorInfo
396 boolean el_boulderdash;
397 boolean el_emerald_mine;
401 boolean el_diamond_caves;
402 boolean el_dx_boulderdash;
407 struct SetupShortcutInfo
414 struct SetupSystemInfo
416 char *sdl_audiodriver;
417 int audio_fragment_size;
427 boolean sound_simple;
429 boolean double_buffering;
430 boolean direct_draw; /* !double_buffering (redundant!) */
431 boolean scroll_delay;
432 boolean soft_scrolling;
440 boolean ask_on_escape;
445 boolean override_level_graphics;
446 boolean override_level_sounds;
447 boolean override_level_music;
449 struct SetupEditorInfo editor;
450 struct SetupShortcutInfo shortcut;
451 struct SetupInputInfo input[MAX_PLAYERS];
452 struct SetupSystemInfo system;
453 struct OptionInfo options;
456 #define TREE_TYPE_GENERIC 0
457 #define TREE_TYPE_GRAPHICS_DIR 1
458 #define TREE_TYPE_SOUNDS_DIR 2
459 #define TREE_TYPE_MUSIC_DIR 3
460 #define TREE_TYPE_LEVEL_DIR 4
462 #define ARTWORK_TYPE_GRAPHICS TREE_TYPE_GRAPHICS_DIR
463 #define ARTWORK_TYPE_SOUNDS TREE_TYPE_SOUNDS_DIR
464 #define ARTWORK_TYPE_MUSIC TREE_TYPE_MUSIC_DIR
468 struct TreeInfo **node_top; /* topmost node in tree */
469 struct TreeInfo *node_parent; /* parent level directory info */
470 struct TreeInfo *node_group; /* level group sub-directory info */
471 struct TreeInfo *next; /* next level series structure node */
473 int cl_first; /* internal control field for setup screen */
474 int cl_cursor; /* internal control field for setup screen */
476 int type; /* type of tree content */
478 /* fields for "type == TREE_TYPE_LEVEL_DIR" */
480 char *filename; /* tree info sub-directory basename (may be ".") */
481 char *fullpath; /* complete path relative to tree base directory */
482 char *basepath; /* absolute base path of tree base directory */
483 char *identifier; /* identifier string for configuration files */
484 char *name; /* tree info name, as displayed in selection menues */
485 char *name_sorting; /* optional sorting name for correct name sorting */
486 char *author; /* level or artwork author name */
487 char *imported_from; /* optional comment for imported levels or artwork */
489 char *graphics_set; /* optional custom graphics set (level tree only) */
490 char *sounds_set; /* optional custom sounds set (level tree only) */
491 char *music_set; /* optional custom music set (level tree only) */
492 char *graphics_path; /* path to optional custom graphics set (level only) */
493 char *sounds_path; /* path to optional custom sounds set (level only) */
494 char *music_path; /* path to optional custom music set (level only) */
496 int levels; /* number of levels in level series */
497 int first_level; /* first level number (to allow start with 0 or 1) */
498 int last_level; /* last level number (automatically calculated) */
499 int sort_priority; /* sort levels by 'sort_priority' and then by name */
501 boolean level_group; /* directory contains more level series directories */
502 boolean parent_link; /* entry links back to parent directory */
503 boolean user_defined; /* user defined levels are stored in home directory */
504 boolean readonly; /* readonly levels can not be changed with editor */
506 int color; /* color to use on selection screen for this level */
507 char *class_desc; /* description of level series class */
508 int handicap_level; /* number of the lowest unsolved level */
511 typedef struct TreeInfo TreeInfo;
512 typedef struct TreeInfo LevelDirTree;
513 typedef struct TreeInfo ArtworkDirTree;
514 typedef struct TreeInfo GraphicsDirTree;
515 typedef struct TreeInfo SoundsDirTree;
516 typedef struct TreeInfo MusicDirTree;
520 GraphicsDirTree *gfx_first;
521 GraphicsDirTree *gfx_current;
522 SoundsDirTree *snd_first;
523 SoundsDirTree *snd_current;
524 MusicDirTree *mus_first;
525 MusicDirTree *mus_current;
527 char *gfx_current_identifier;
528 char *snd_current_identifier;
529 char *mus_current_identifier;
549 char *default_filename;
552 char **default_parameter; /* array of file parameters */
553 char **parameter; /* array of file parameters */
563 struct SetupFileList *next;
568 char *source_filename; /* primary key for node list */
572 struct PropertyMapping
582 struct ArtworkListInfo
584 int type; /* type of artwork */
586 int num_file_list_entries;
587 int num_dynamic_file_list_entries;
588 struct FileInfo *file_list; /* static artwork file array */
589 struct FileInfo *dynamic_file_list; /* dynamic artwrk file array */
591 int num_suffix_list_entries;
592 struct ConfigInfo *suffix_list; /* parameter suffixes array */
594 int num_base_prefixes;
595 int num_ext1_suffixes;
596 int num_ext2_suffixes;
597 int num_ext3_suffixes;
598 char **base_prefixes; /* base token prefixes array */
599 char **ext1_suffixes; /* property suffixes array 1 */
600 char **ext2_suffixes; /* property suffixes array 2 */
601 char **ext3_suffixes; /* property suffixes array 3 */
603 int num_ignore_tokens;
604 char **ignore_tokens; /* file tokens to be ignored */
606 int num_property_mapping_entries;
607 struct PropertyMapping *property_mapping; /* mapping token -> artwork */
609 int sizeof_artwork_list_entry;
611 struct ListNodeInfo **artwork_list; /* static artwork node array */
612 struct ListNodeInfo **dynamic_artwork_list; /* dynamic artwrk node array */
613 struct ListNode *content_list; /* dynamic artwork node list */
615 void *(*load_artwork)(char *); /* constructor function */
616 void (*free_artwork)(void *); /* destructor function */
620 /* ========================================================================= */
621 /* exported variables */
622 /* ========================================================================= */
624 extern struct ProgramInfo program;
625 extern struct OptionInfo options;
626 extern struct VideoSystemInfo video;
627 extern struct AudioSystemInfo audio;
628 extern struct GfxInfo gfx;
629 extern struct AnimInfo anim;
630 extern struct ArtworkInfo artwork;
631 extern struct JoystickInfo joystick;
632 extern struct SetupInfo setup;
634 extern LevelDirTree *leveldir_first;
635 extern LevelDirTree *leveldir_current;
638 extern Display *display;
639 extern Visual *visual;
641 extern Colormap cmap;
643 extern DrawWindow *window;
644 extern DrawBuffer *backbuffer;
645 extern DrawBuffer *drawto;
647 extern int button_status;
648 extern boolean motion_status;
650 extern int redraw_mask;
651 extern int redraw_tiles;
653 extern int FrameCounter;
656 /* function definitions */
658 void InitProgramInfo(char *, char *, char *, char *, char *, char *, char *,
659 char *, char *, char *, int);
661 void InitExitFunction(void (*exit_function)(int));
662 void InitPlatformDependantStuff(void);
663 void ClosePlatformDependantStuff(void);
665 void InitGfxFieldInfo(int, int, int, int, int, int, int, int, Bitmap *);
666 void InitGfxDoor1Info(int, int, int, int);
667 void InitGfxDoor2Info(int, int, int, int);
668 void InitGfxScrollbufferInfo(int, int);
669 void SetDrawDeactivationMask(int);
670 void SetDrawBackgroundMask(int);
671 void SetMainBackgroundBitmap(Bitmap *);
672 void SetDoorBackgroundBitmap(Bitmap *);
674 inline void InitVideoDisplay(void);
675 inline void CloseVideoDisplay(void);
676 inline void InitVideoBuffer(DrawBuffer **,DrawWindow **, int,int,int, boolean);
677 inline Bitmap *CreateBitmapStruct(void);
678 inline Bitmap *CreateBitmap(int, int, int);
679 inline void FreeBitmap(Bitmap *);
680 inline void BlitBitmap(Bitmap *, Bitmap *, int, int, int, int, int, int);
681 inline void FillRectangle(Bitmap *, int, int, int, int, Pixel);
682 inline void ClearRectangle(Bitmap *, int, int, int, int);
683 inline void ClearRectangleOnBackground(Bitmap *, int, int, int, int);
684 inline void SetClipMask(Bitmap *, GC, Pixmap);
685 inline void SetClipOrigin(Bitmap *, GC, int, int);
686 inline void BlitBitmapMasked(Bitmap *, Bitmap *, int, int, int, int, int, int);
687 inline boolean DrawingOnBackground(int, int);
688 inline void BlitBitmapOnBackground(Bitmap *, Bitmap *, int, int, int, int, int,
690 inline void DrawSimpleWhiteLine(Bitmap *, int, int, int, int);
691 inline void DrawLines(Bitmap *, struct XY *, int, Pixel);
692 inline Pixel GetPixel(Bitmap *, int, int);
693 inline Pixel GetPixelFromRGB(Bitmap *, unsigned int,unsigned int,unsigned int);
694 inline Pixel GetPixelFromRGBcompact(Bitmap *, unsigned int);
696 inline void FlushDisplay(void);
697 inline void SyncDisplay(void);
698 inline void KeyboardAutoRepeatOn(void);
699 inline void KeyboardAutoRepeatOff(void);
700 inline boolean PointerInWindow(DrawWindow *);
701 inline boolean SetVideoMode(boolean);
702 inline boolean ChangeVideoModeIfNeeded(boolean);
704 Bitmap *LoadImage(char *);
705 Bitmap *LoadCustomImage(char *);
706 void ReloadCustomImage(Bitmap *, char *);
708 Bitmap *ZoomBitmap(Bitmap *, int, int);
709 void CreateBitmapWithSmallBitmaps(Bitmap *);
711 void SetMouseCursor(int);
713 inline void OpenAudio(void);
714 inline void CloseAudio(void);
715 inline void SetAudioMode(boolean);
717 inline void InitEventFilter(EventFilter);
718 inline boolean PendingEvent(void);
719 inline void NextEvent(Event *event);
720 inline Key GetEventKey(KeyEvent *, boolean);
721 inline boolean CheckCloseWindowEvent(ClientMessageEvent *);
723 inline void InitJoysticks();
724 inline boolean ReadJoystick(int, int *, int *, boolean *, boolean *);
726 #endif /* SYSTEM_H */