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 MUSIC_DIRECTORY "music"
129 #define SOUNDS_DIRECTORY "sounds"
130 #define LEVELS_DIRECTORY "levels"
131 #define TAPES_DIRECTORY "tapes"
132 #define SCORES_DIRECTORY "scores"
134 /* areas in bitmap PIX_DOOR */
135 /* meaning in PIX_DB_DOOR: (3 PAGEs)
136 PAGEX1: 1. buffer for DOOR_1
137 PAGEX2: 2. buffer for DOOR_1
138 PAGEX3: buffer for animations
141 #define DOOR_GFX_PAGESIZE (gfx.dxsize)
142 #define DOOR_GFX_PAGEX1 (0 * DOOR_GFX_PAGESIZE)
143 #define DOOR_GFX_PAGEX2 (1 * DOOR_GFX_PAGESIZE)
144 #define DOOR_GFX_PAGEX3 (2 * DOOR_GFX_PAGESIZE)
145 #define DOOR_GFX_PAGEX4 (3 * DOOR_GFX_PAGESIZE)
146 #define DOOR_GFX_PAGEX5 (4 * DOOR_GFX_PAGESIZE)
147 #define DOOR_GFX_PAGEX6 (5 * DOOR_GFX_PAGESIZE)
148 #define DOOR_GFX_PAGEX7 (6 * DOOR_GFX_PAGESIZE)
149 #define DOOR_GFX_PAGEX8 (7 * DOOR_GFX_PAGESIZE)
150 #define DOOR_GFX_PAGEY1 (0)
151 #define DOOR_GFX_PAGEY2 (gfx.dysize)
153 /* functions for version handling */
154 #define VERSION_IDENT(x,y,z) ((x) * 10000 + (y) * 100 + (z))
155 #define VERSION_MAJOR(x) ((x) / 10000)
156 #define VERSION_MINOR(x) (((x) % 10000) / 100)
157 #define VERSION_PATCH(x) ((x) % 100)
160 /* type definitions */
161 typedef int (*EventFilter)(const Event *);
164 /* structure definitions */
168 char *command_basename;
169 char *userdata_directory;
175 char *x11_icon_filename;
176 char *x11_iconmask_filename;
177 char *msdos_pointer_filename;
180 char *filename_prefix; /* prefix to cut off from DOS filenames */
186 void (*exit_function)(int);
194 char *ro_base_directory;
195 char *rw_base_directory;
196 char *level_directory;
197 char *graphics_directory;
198 char *sounds_directory;
199 char *music_directory;
206 struct VideoSystemInfo
209 int width, height, depth;
210 boolean fullscreen_available;
211 boolean fullscreen_enabled;
214 struct AudioSystemInfo
216 boolean sound_available;
217 boolean music_available;
218 boolean loops_available;
219 boolean mods_available;
220 boolean sound_enabled;
222 int soundserver_pipe[2];
236 int real_sx, real_sy;
237 int full_sxsize, full_sysize;
238 int scrollbuffer_width, scrollbuffer_height;
246 boolean draw_deactivation_mask;
252 int fd[MAX_PLAYERS]; /* file descriptor of player's joystick */
255 struct SetupJoystickInfo
257 char *device_name; /* device name of player's joystick */
259 int xleft, xmiddle, xright;
260 int yupper, ymiddle, ylower;
265 struct SetupKeyboardInfo
275 struct SetupInputInfo
277 boolean use_joystick;
278 struct SetupJoystickInfo joy;
279 struct SetupKeyboardInfo key;
282 struct SetupShortcutInfo
295 boolean sound_simple;
297 boolean double_buffering;
298 boolean direct_draw; /* !double_buffering (redundant!) */
299 boolean scroll_delay;
300 boolean soft_scrolling;
309 struct SetupShortcutInfo shortcut;
310 struct SetupInputInfo input[MAX_PLAYERS];
313 #define TREE_TYPE_GENERIC 0
314 #define TREE_TYPE_LEVEL_DIR 1
315 #define TREE_TYPE_GRAPHICS_DIR 2
316 #define TREE_TYPE_SOUNDS_DIR 3
317 #define TREE_TYPE_MUSIC_DIR 4
321 struct TreeInfo *node_parent; /* parent level directory info */
322 struct TreeInfo *node_group; /* level group sub-directory info */
323 struct TreeInfo *next; /* next level series structure node */
325 int cl_first; /* internal control field for setup screen */
326 int cl_cursor; /* internal control field for setup screen */
328 int type; /* type of tree content */
330 /* fields for "type == TREE_TYPE_LEVEL_DIR" */
332 char *filename; /* level series single directory name */
333 char *fullpath; /* complete path relative to level directory */
334 char *basepath; /* absolute base path of level directory */
335 char *name; /* level series name, as displayed on main screen */
336 char *name_short; /* optional short name for level selection screen */
337 char *name_sorting; /* optional sorting name for correct level sorting */
338 char *author; /* level series author name levels without author */
339 char *imported_from; /* optional comment for imported level series */
340 int levels; /* number of levels in level series */
341 int first_level; /* first level number (to allow start with 0 or 1) */
342 int last_level; /* last level number (automatically calculated) */
343 int sort_priority; /* sort levels by 'sort_priority' and then by name */
344 boolean level_group; /* directory contains more level series directories */
345 boolean parent_link; /* entry links back to parent directory */
346 boolean user_defined; /* user defined levels are stored in home directory */
347 boolean readonly; /* readonly levels can not be changed with editor */
348 int color; /* color to use on selection screen for this level */
349 char *class_desc; /* description of level series class */
350 int handicap_level; /* number of the lowest unsolved level */
353 typedef struct TreeInfo TreeInfo;
354 typedef struct TreeInfo LevelDirTree;
355 typedef struct TreeInfo GraphicsDirTree;
356 typedef struct TreeInfo SoundsDirTree;
357 typedef struct TreeInfo MusicDirTree;
361 GraphicsDirTree *gfx_first;
362 GraphicsDirTree *gfx_current;
363 SoundsDirTree *snd_first;
364 SoundsDirTree *snd_current;
365 MusicDirTree *mus_first;
366 MusicDirTree *mus_current;
370 /* ========================================================================= */
371 /* exported variables */
372 /* ========================================================================= */
374 extern struct ProgramInfo program;
375 extern struct OptionInfo options;
376 extern struct VideoSystemInfo video;
377 extern struct AudioSystemInfo audio;
378 extern struct GfxInfo gfx;
379 extern struct ArtworkInfo artwork;
380 extern struct JoystickInfo joystick;
381 extern struct SetupInfo setup;
383 extern LevelDirTree *leveldir_first;
384 extern LevelDirTree *leveldir_current;
387 extern Display *display;
388 extern Visual *visual;
390 extern Colormap cmap;
392 extern DrawWindow *window;
393 extern DrawBuffer *backbuffer;
394 extern DrawBuffer *drawto;
396 extern int button_status;
397 extern boolean motion_status;
399 extern int redraw_mask;
400 extern int redraw_tiles;
402 extern int FrameCounter;
405 /* function definitions */
407 void InitCommandName(char *);
408 void InitExitFunction(void (*exit_function)(int));
409 void InitPlatformDependantStuff(void);
410 void ClosePlatformDependantStuff(void);
412 void InitProgramInfo(char *, char *, char *, char *, char *, char *, char *,
413 char *, char *, int);
415 void InitGfxFieldInfo(int, int, int, int, int, int, int, int);
416 void InitGfxDoor1Info(int, int, int, int);
417 void InitGfxDoor2Info(int, int, int, int);
418 void InitGfxScrollbufferInfo(int, int);
419 void SetDrawDeactivationMask(int );
421 inline void InitVideoDisplay(void);
422 inline void CloseVideoDisplay(void);
423 inline void InitVideoBuffer(DrawBuffer **,DrawWindow **, int,int,int, boolean);
424 inline Bitmap *CreateBitmapStruct(void);
425 inline Bitmap *CreateBitmap(int, int, int);
426 inline void FreeBitmap(Bitmap *);
427 inline void BlitBitmap(Bitmap *, Bitmap *, int, int, int, int, int, int);
428 inline void ClearRectangle(Bitmap *, int, int, int, int);
429 inline void SetClipMask(Bitmap *, GC, Pixmap);
430 inline void SetClipOrigin(Bitmap *, GC, int, int);
431 inline void BlitBitmapMasked(Bitmap *, Bitmap *, int, int, int, int, int, int);
432 inline void DrawSimpleWhiteLine(Bitmap *, int, int, int, int);
433 inline void DrawLines(Bitmap *, struct XY *, int, Pixel);
434 inline Pixel GetPixel(Bitmap *, int, int);
435 inline Pixel GetPixelFromRGB(Bitmap *, unsigned int,unsigned int,unsigned int);
436 inline Pixel GetPixelFromRGBcompact(Bitmap *, unsigned int);
438 inline void FlushDisplay(void);
439 inline void SyncDisplay(void);
440 inline void KeyboardAutoRepeatOn(void);
441 inline void KeyboardAutoRepeatOff(void);
442 inline boolean PointerInWindow(DrawWindow *);
443 inline boolean SetVideoMode(boolean);
444 inline boolean ChangeVideoModeIfNeeded(boolean);
446 Bitmap *LoadImage(char *);
447 Bitmap *LoadCustomImage(char *);
449 inline void OpenAudio(void);
450 inline void CloseAudio(void);
451 inline void SetAudioMode(boolean);
453 inline void InitEventFilter(EventFilter);
454 inline boolean PendingEvent(void);
455 inline void NextEvent(Event *event);
456 inline Key GetEventKey(KeyEvent *, boolean);
457 inline boolean CheckCloseWindowEvent(ClientMessageEvent *);
459 inline void InitJoysticks();
460 inline boolean ReadJoystick(int, int *, int *, boolean *, boolean *);
462 #endif /* SYSTEM_H */