1 /***********************************************************
2 * Artsoft Retro-Game Library *
3 *----------------------------------------------------------*
4 * (c) 1994-2001 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)
31 /* the additional 'b' is needed for Win32 to open files in binary mode */
32 #define MODE_READ "rb"
33 #define MODE_WRITE "wb"
34 #define MODE_APPEND "ab"
36 #define DEFAULT_DEPTH 0
38 #define FULLSCREEN_NOT_AVAILABLE FALSE
39 #define FULLSCREEN_AVAILABLE TRUE
41 /* default input keys */
42 #define DEFAULT_KEY_LEFT KSYM_Left
43 #define DEFAULT_KEY_RIGHT KSYM_Right
44 #define DEFAULT_KEY_UP KSYM_Up
45 #define DEFAULT_KEY_DOWN KSYM_Down
46 #define DEFAULT_KEY_SNAP KSYM_Shift_L
47 #define DEFAULT_KEY_BOMB KSYM_Shift_R
48 #define DEFAULT_KEY_OKAY KSYM_Return
49 #define DEFAULT_KEY_CANCEL KSYM_Escape
51 /* default shortcut keys */
52 #define DEFAULT_KEY_SAVE_GAME KSYM_F1
53 #define DEFAULT_KEY_LOAD_GAME KSYM_F2
55 /* values for move directions */
56 #define MV_NO_MOVING 0
57 #define MV_LEFT (1 << 0)
58 #define MV_RIGHT (1 << 1)
59 #define MV_UP (1 << 2)
60 #define MV_DOWN (1 << 3)
62 /* values for button status */
63 #define MB_NOT_PRESSED FALSE
64 #define MB_NOT_RELEASED TRUE
65 #define MB_RELEASED FALSE
66 #define MB_PRESSED TRUE
67 #define MB_MENU_CHOICE FALSE
68 #define MB_MENU_MARK TRUE
69 #define MB_MENU_INITIALIZE (-1)
70 #define MB_MENU_LEAVE (-2)
71 #define MB_LEFTBUTTON 1
72 #define MB_MIDDLEBUTTON 2
73 #define MB_RIGHTBUTTON 3
75 /* values for redraw_mask */
76 #define REDRAW_NONE (0)
77 #define REDRAW_ALL (1 << 0)
78 #define REDRAW_FIELD (1 << 1)
79 #define REDRAW_TILES (1 << 2)
80 #define REDRAW_DOOR_1 (1 << 3)
81 #define REDRAW_VIDEO_1 (1 << 4)
82 #define REDRAW_VIDEO_2 (1 << 5)
83 #define REDRAW_VIDEO_3 (1 << 6)
84 #define REDRAW_MICROLEVEL (1 << 7)
85 #define REDRAW_MICROLABEL (1 << 8)
86 #define REDRAW_FROM_BACKBUFFER (1 << 9)
87 #define REDRAW_DOOR_2 (REDRAW_VIDEO_1 | \
90 #define REDRAW_DOOR_3 (1 << 10)
91 #define REDRAW_DOORS (REDRAW_DOOR_1 | \
94 #define REDRAW_MAIN (REDRAW_FIELD | \
97 #define REDRAW_FPS (1 << 11)
98 #define REDRAWTILES_THRESHOLD (SCR_FIELDX * SCR_FIELDY / 2)
100 /* maximum number of parallel players supported by libgame functions */
101 #define MAX_PLAYERS 4
103 /* maximum allowed length of player name */
104 #define MAX_PLAYER_NAME_LEN 10
106 /* default name for empty highscore entry */
107 #define EMPTY_PLAYER_NAME "no name"
109 /* default name for unknown player names */
110 #define ANONYMOUS_NAME "anonymous"
112 /* default name for new levels */
113 #define NAMELESS_LEVEL_NAME "nameless level"
115 /* definitions for game sub-directories */
117 #define RO_GAME_DIR "."
121 #define RW_GAME_DIR "."
124 #define RO_BASE_PATH RO_GAME_DIR
125 #define RW_BASE_PATH RW_GAME_DIR
127 #define GRAPHICS_DIRECTORY "graphics"
128 #define SOUNDS_DIRECTORY "sounds"
129 #define MUSIC_DIRECTORY "music"
130 #define LEVELS_DIRECTORY "levels"
131 #define TAPES_DIRECTORY "tapes"
132 #define SCORES_DIRECTORY "scores"
134 #if !defined(PLATFORM_MSDOS)
135 #define GRAPHICS_SUBDIR "gfx_classic"
136 #define SOUNDS_SUBDIR "snd_classic"
137 #define MUSIC_SUBDIR "mus_classic"
139 #define GRAPHICS_SUBDIR "gfx_orig"
140 #define SOUNDS_SUBDIR "snd_orig"
141 #define MUSIC_SUBDIR "mus_orig"
144 /* areas in bitmap PIX_DOOR */
145 /* meaning in PIX_DB_DOOR: (3 PAGEs)
146 PAGEX1: 1. buffer for DOOR_1
147 PAGEX2: 2. buffer for DOOR_1
148 PAGEX3: buffer for animations
151 #define DOOR_GFX_PAGESIZE (gfx.dxsize)
152 #define DOOR_GFX_PAGEX1 (0 * DOOR_GFX_PAGESIZE)
153 #define DOOR_GFX_PAGEX2 (1 * DOOR_GFX_PAGESIZE)
154 #define DOOR_GFX_PAGEX3 (2 * DOOR_GFX_PAGESIZE)
155 #define DOOR_GFX_PAGEX4 (3 * DOOR_GFX_PAGESIZE)
156 #define DOOR_GFX_PAGEX5 (4 * DOOR_GFX_PAGESIZE)
157 #define DOOR_GFX_PAGEX6 (5 * DOOR_GFX_PAGESIZE)
158 #define DOOR_GFX_PAGEX7 (6 * DOOR_GFX_PAGESIZE)
159 #define DOOR_GFX_PAGEX8 (7 * DOOR_GFX_PAGESIZE)
160 #define DOOR_GFX_PAGEY1 (0)
161 #define DOOR_GFX_PAGEY2 (gfx.dysize)
163 /* functions for version handling */
164 #define VERSION_IDENT(x,y,z) ((x) * 10000 + (y) * 100 + (z))
165 #define VERSION_MAJOR(x) ((x) / 10000)
166 #define VERSION_MINOR(x) (((x) % 10000) / 100)
167 #define VERSION_PATCH(x) ((x) % 100)
170 /* type definitions */
171 typedef int (*EventFilter)(const Event *);
174 /* structure definitions */
178 char *command_basename;
179 char *userdata_directory;
185 char *x11_icon_filename;
186 char *x11_iconmask_filename;
187 char *msdos_pointer_filename;
190 char *filename_prefix; /* prefix to cut off from DOS filenames */
196 void (*exit_function)(int);
204 char *ro_base_directory;
205 char *rw_base_directory;
206 char *level_directory;
207 char *graphics_directory;
208 char *sounds_directory;
209 char *music_directory;
216 struct VideoSystemInfo
219 int width, height, depth;
220 boolean fullscreen_available;
221 boolean fullscreen_enabled;
224 struct AudioSystemInfo
226 boolean sound_available;
227 boolean music_available;
228 boolean loops_available;
229 boolean mods_available;
230 boolean sound_enabled;
232 int soundserver_pipe[2];
246 int real_sx, real_sy;
247 int full_sxsize, full_sysize;
248 int scrollbuffer_width, scrollbuffer_height;
256 boolean draw_deactivation_mask;
262 int fd[MAX_PLAYERS]; /* file descriptor of player's joystick */
265 struct SetupJoystickInfo
267 char *device_name; /* device name of player's joystick */
269 int xleft, xmiddle, xright;
270 int yupper, ymiddle, ylower;
275 struct SetupKeyboardInfo
285 struct SetupInputInfo
287 boolean use_joystick;
288 struct SetupJoystickInfo joy;
289 struct SetupKeyboardInfo key;
292 struct SetupShortcutInfo
305 boolean sound_simple;
307 boolean double_buffering;
308 boolean direct_draw; /* !double_buffering (redundant!) */
309 boolean scroll_delay;
310 boolean soft_scrolling;
318 boolean ask_on_escape;
324 struct SetupShortcutInfo shortcut;
325 struct SetupInputInfo input[MAX_PLAYERS];
328 #define TREE_TYPE_GENERIC 0
329 #define TREE_TYPE_LEVEL_DIR 1
330 #define TREE_TYPE_GRAPHICS_DIR 2
331 #define TREE_TYPE_SOUNDS_DIR 3
332 #define TREE_TYPE_MUSIC_DIR 4
336 struct TreeInfo **node_top; /* topmost node in tree */
337 struct TreeInfo *node_parent; /* parent level directory info */
338 struct TreeInfo *node_group; /* level group sub-directory info */
339 struct TreeInfo *next; /* next level series structure node */
341 int cl_first; /* internal control field for setup screen */
342 int cl_cursor; /* internal control field for setup screen */
344 int type; /* type of tree content */
346 /* fields for "type == TREE_TYPE_LEVEL_DIR" */
348 char *filename; /* level series single directory name */
349 char *fullpath; /* complete path relative to level directory */
350 char *basepath; /* absolute base path of level directory */
351 char *name; /* level series name, as displayed on main screen */
352 char *name_short; /* optional short name for level selection screen */
353 char *name_sorting; /* optional sorting name for correct level sorting */
354 char *author; /* level series author name levels without author */
355 char *imported_from; /* optional comment for imported level series */
356 int levels; /* number of levels in level series */
357 int first_level; /* first level number (to allow start with 0 or 1) */
358 int last_level; /* last level number (automatically calculated) */
359 int sort_priority; /* sort levels by 'sort_priority' and then by name */
360 boolean level_group; /* directory contains more level series directories */
361 boolean parent_link; /* entry links back to parent directory */
362 boolean user_defined; /* user defined levels are stored in home directory */
363 boolean readonly; /* readonly levels can not be changed with editor */
364 int color; /* color to use on selection screen for this level */
365 char *class_desc; /* description of level series class */
366 int handicap_level; /* number of the lowest unsolved level */
369 typedef struct TreeInfo TreeInfo;
370 typedef struct TreeInfo LevelDirTree;
371 typedef struct TreeInfo GraphicsDirTree;
372 typedef struct TreeInfo SoundsDirTree;
373 typedef struct TreeInfo MusicDirTree;
377 GraphicsDirTree *gfx_first;
378 GraphicsDirTree *gfx_current;
379 SoundsDirTree *snd_first;
380 SoundsDirTree *snd_current;
381 MusicDirTree *mus_first;
382 MusicDirTree *mus_current;
384 char *graphics_set_current;
385 char *sounds_set_current;
386 char *music_set_current;
390 /* ========================================================================= */
391 /* exported variables */
392 /* ========================================================================= */
394 extern struct ProgramInfo program;
395 extern struct OptionInfo options;
396 extern struct VideoSystemInfo video;
397 extern struct AudioSystemInfo audio;
398 extern struct GfxInfo gfx;
399 extern struct ArtworkInfo artwork;
400 extern struct JoystickInfo joystick;
401 extern struct SetupInfo setup;
403 extern LevelDirTree *leveldir_first;
404 extern LevelDirTree *leveldir_current;
407 extern Display *display;
408 extern Visual *visual;
410 extern Colormap cmap;
412 extern DrawWindow *window;
413 extern DrawBuffer *backbuffer;
414 extern DrawBuffer *drawto;
416 extern int button_status;
417 extern boolean motion_status;
419 extern int redraw_mask;
420 extern int redraw_tiles;
422 extern int FrameCounter;
425 /* function definitions */
427 void InitCommandName(char *);
428 void InitExitFunction(void (*exit_function)(int));
429 void InitPlatformDependantStuff(void);
430 void ClosePlatformDependantStuff(void);
432 void InitProgramInfo(char *, char *, char *, char *, char *, char *, char *,
433 char *, char *, int);
435 void InitGfxFieldInfo(int, int, int, int, int, int, int, int);
436 void InitGfxDoor1Info(int, int, int, int);
437 void InitGfxDoor2Info(int, int, int, int);
438 void InitGfxScrollbufferInfo(int, int);
439 void SetDrawDeactivationMask(int );
441 inline void InitVideoDisplay(void);
442 inline void CloseVideoDisplay(void);
443 inline void InitVideoBuffer(DrawBuffer **,DrawWindow **, int,int,int, boolean);
444 inline Bitmap *CreateBitmapStruct(void);
445 inline Bitmap *CreateBitmap(int, int, int);
446 inline void FreeBitmap(Bitmap *);
447 inline void BlitBitmap(Bitmap *, Bitmap *, int, int, int, int, int, int);
448 inline void ClearRectangle(Bitmap *, int, int, int, int);
449 inline void SetClipMask(Bitmap *, GC, Pixmap);
450 inline void SetClipOrigin(Bitmap *, GC, int, int);
451 inline void BlitBitmapMasked(Bitmap *, Bitmap *, int, int, int, int, int, int);
452 inline void DrawSimpleWhiteLine(Bitmap *, int, int, int, int);
453 inline void DrawLines(Bitmap *, struct XY *, int, Pixel);
454 inline Pixel GetPixel(Bitmap *, int, int);
455 inline Pixel GetPixelFromRGB(Bitmap *, unsigned int,unsigned int,unsigned int);
456 inline Pixel GetPixelFromRGBcompact(Bitmap *, unsigned int);
458 inline void FlushDisplay(void);
459 inline void SyncDisplay(void);
460 inline void KeyboardAutoRepeatOn(void);
461 inline void KeyboardAutoRepeatOff(void);
462 inline boolean PointerInWindow(DrawWindow *);
463 inline boolean SetVideoMode(boolean);
464 inline boolean ChangeVideoModeIfNeeded(boolean);
466 Bitmap *LoadImage(char *);
467 Bitmap *LoadCustomImage(char *);
468 void ReloadCustomImage(Bitmap *, char *);
470 inline void OpenAudio(void);
471 inline void CloseAudio(void);
472 inline void SetAudioMode(boolean);
474 inline void InitEventFilter(EventFilter);
475 inline boolean PendingEvent(void);
476 inline void NextEvent(Event *event);
477 inline Key GetEventKey(KeyEvent *, boolean);
478 inline boolean CheckCloseWindowEvent(ClientMessageEvent *);
480 inline void InitJoysticks();
481 inline boolean ReadJoystick(int, int *, int *, boolean *, boolean *);
483 #endif /* SYSTEM_H */