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 /* contant definitions */
33 /* the additional 'b' is needed for Win32 to open files in binary mode */
34 #define MODE_READ "rb"
35 #define MODE_WRITE "wb"
36 #define MODE_APPEND "ab"
38 #define DEFAULT_DEPTH 0
40 #define FULLSCREEN_NOT_AVAILABLE FALSE
41 #define FULLSCREEN_AVAILABLE TRUE
43 /* default input keys */
44 #define DEFAULT_KEY_LEFT KSYM_Left
45 #define DEFAULT_KEY_RIGHT KSYM_Right
46 #define DEFAULT_KEY_UP KSYM_Up
47 #define DEFAULT_KEY_DOWN KSYM_Down
48 #define DEFAULT_KEY_SNAP KSYM_Shift_L
49 #define DEFAULT_KEY_BOMB KSYM_Shift_R
50 #define DEFAULT_KEY_OKAY KSYM_Return
51 #define DEFAULT_KEY_CANCEL KSYM_Escape
53 /* values for move directions */
54 #define MV_NO_MOVING 0
55 #define MV_LEFT (1 << 0)
56 #define MV_RIGHT (1 << 1)
57 #define MV_UP (1 << 2)
58 #define MV_DOWN (1 << 3)
60 /* values for button status */
61 #define MB_NOT_PRESSED FALSE
62 #define MB_NOT_RELEASED TRUE
63 #define MB_RELEASED FALSE
64 #define MB_PRESSED TRUE
65 #define MB_MENU_CHOICE FALSE
66 #define MB_MENU_MARK TRUE
67 #define MB_MENU_INITIALIZE (-1)
68 #define MB_LEFTBUTTON 1
69 #define MB_MIDDLEBUTTON 2
70 #define MB_RIGHTBUTTON 3
72 /* values for redraw_mask */
73 #define REDRAW_NONE (0)
74 #define REDRAW_ALL (1 << 0)
75 #define REDRAW_FIELD (1 << 1)
76 #define REDRAW_TILES (1 << 2)
77 #define REDRAW_DOOR_1 (1 << 3)
78 #define REDRAW_VIDEO_1 (1 << 4)
79 #define REDRAW_VIDEO_2 (1 << 5)
80 #define REDRAW_VIDEO_3 (1 << 6)
81 #define REDRAW_MICROLEVEL (1 << 7)
82 #define REDRAW_MICROLABEL (1 << 8)
83 #define REDRAW_FROM_BACKBUFFER (1 << 9)
84 #define REDRAW_DOOR_2 (REDRAW_VIDEO_1 | \
87 #define REDRAW_DOOR_3 (1 << 10)
88 #define REDRAW_DOORS (REDRAW_DOOR_1 | \
91 #define REDRAW_MAIN (REDRAW_FIELD | \
94 #define REDRAW_FPS (1 << 11)
95 #define REDRAWTILES_THRESHOLD (SCR_FIELDX * SCR_FIELDY / 2)
97 /* maximum number of parallel players supported by libgame functions */
100 /* maximum allowed length of player name */
101 #define MAX_PLAYER_NAME_LEN 10
103 /* default name for empty highscore entry */
104 #define EMPTY_PLAYER_NAME "no name"
106 /* default name for unknown player names */
107 #define ANONYMOUS_NAME "anonymous"
109 /* default name for new levels */
110 #define NAMELESS_LEVEL_NAME "nameless level"
112 /* definitions for game sub-directories */
114 #define RO_GAME_DIR "."
118 #define RW_GAME_DIR "."
121 #define RO_BASE_PATH RO_GAME_DIR
122 #define RW_BASE_PATH RW_GAME_DIR
124 #define GRAPHICS_DIRECTORY "graphics"
125 #define MUSIC_DIRECTORY "music"
126 #define SOUNDS_DIRECTORY "sounds"
127 #define LEVELS_DIRECTORY "levels"
128 #define TAPES_DIRECTORY "tapes"
129 #define SCORES_DIRECTORY "scores"
131 /* areas in bitmap PIX_DOOR */
132 /* meaning in PIX_DB_DOOR: (3 PAGEs)
133 PAGEX1: 1. buffer for DOOR_1
134 PAGEX2: 2. buffer for DOOR_1
135 PAGEX3: buffer for animations
138 #define DOOR_GFX_PAGESIZE (gfx.dxsize)
139 #define DOOR_GFX_PAGEX1 (0 * DOOR_GFX_PAGESIZE)
140 #define DOOR_GFX_PAGEX2 (1 * DOOR_GFX_PAGESIZE)
141 #define DOOR_GFX_PAGEX3 (2 * DOOR_GFX_PAGESIZE)
142 #define DOOR_GFX_PAGEX4 (3 * DOOR_GFX_PAGESIZE)
143 #define DOOR_GFX_PAGEX5 (4 * DOOR_GFX_PAGESIZE)
144 #define DOOR_GFX_PAGEX6 (5 * DOOR_GFX_PAGESIZE)
145 #define DOOR_GFX_PAGEX7 (6 * DOOR_GFX_PAGESIZE)
146 #define DOOR_GFX_PAGEX8 (7 * DOOR_GFX_PAGESIZE)
147 #define DOOR_GFX_PAGEY1 (0)
148 #define DOOR_GFX_PAGEY2 (gfx.dysize)
151 /* type definitions */
153 typedef int (*EventFilter)(const Event *);
156 /* structure definitions */
160 char *command_basename;
161 char *userdata_directory;
166 char *x11_icon_filename;
167 char *x11_iconmask_filename;
168 char *msdos_pointer_filename;
170 void (*exit_function)(int);
178 char *ro_base_directory;
179 char *rw_base_directory;
180 char *level_directory;
181 char *graphics_directory;
182 char *sounds_directory;
183 char *music_directory;
190 struct VideoSystemInfo
193 int width, height, depth;
194 boolean fullscreen_available;
195 boolean fullscreen_enabled;
198 struct AudioSystemInfo
200 boolean sound_available;
201 boolean music_available;
202 boolean loops_available;
203 boolean mods_available;
204 boolean sound_enabled;
206 int soundserver_pipe[2];
220 int real_sx, real_sy;
221 int full_sxsize, full_sysize;
222 int scrollbuffer_width, scrollbuffer_height;
234 int fd[MAX_PLAYERS]; /* file descriptor of player's joystick */
237 struct SetupJoystickInfo
239 char *device_name; /* device name of player's joystick */
241 int xleft, xmiddle, xright;
242 int yupper, ymiddle, ylower;
247 struct SetupKeyboardInfo
257 struct SetupInputInfo
259 boolean use_joystick;
260 struct SetupJoystickInfo joy;
261 struct SetupKeyboardInfo key;
271 boolean sound_simple;
273 boolean double_buffering;
274 boolean direct_draw; /* !double_buffering (redundant!) */
275 boolean scroll_delay;
276 boolean soft_scrolling;
285 struct SetupInputInfo input[MAX_PLAYERS];
290 char *filename; /* level series single directory name */
291 char *fullpath; /* complete path relative to level directory */
292 char *basepath; /* absolute base path of level directory */
293 char *name; /* level series name, as displayed on main screen */
294 char *name_short; /* optional short name for level selection screen */
295 char *name_sorting; /* optional sorting name for correct level sorting */
296 char *author; /* level series author name levels without author */
297 char *imported_from; /* optional comment for imported level series */
298 int levels; /* number of levels in level series */
299 int first_level; /* first level number (to allow start with 0 or 1) */
300 int last_level; /* last level number (automatically calculated) */
301 int sort_priority; /* sort levels by 'sort_priority' and then by name */
302 boolean level_group; /* directory contains more level series directories */
303 boolean parent_link; /* entry links back to parent directory */
304 boolean user_defined; /* user defined levels are stored in home directory */
305 boolean readonly; /* readonly levels can not be changed with editor */
306 int color; /* color to use on selection screen for this level */
307 char *class_desc; /* description of level series class */
308 int handicap_level; /* number of the lowest unsolved level */
309 int cl_first; /* internal control field for "choose level" screen */
310 int cl_cursor; /* internal control field for "choose level" screen */
312 struct LevelDirInfo *node_parent; /* parent level directory info */
313 struct LevelDirInfo *node_group; /* level group sub-directory info */
314 struct LevelDirInfo *next; /* next level series structure node */
318 /* ========================================================================= */
319 /* exported variables */
320 /* ========================================================================= */
322 extern struct ProgramInfo program;
323 extern struct OptionInfo options;
324 extern struct VideoSystemInfo video;
325 extern struct AudioSystemInfo audio;
326 extern struct GfxInfo gfx;
327 extern struct JoystickInfo joystick;
328 extern struct SetupInfo setup;
330 extern struct LevelDirInfo *leveldir_first;
331 extern struct LevelDirInfo *leveldir_current;
334 extern Display *display;
335 extern Visual *visual;
337 extern Colormap cmap;
339 extern DrawWindow *window;
340 extern DrawBuffer *backbuffer;
341 extern DrawBuffer *drawto;
343 extern int button_status;
344 extern boolean motion_status;
346 extern int redraw_mask;
347 extern int redraw_tiles;
349 extern int FrameCounter;
352 /* function definitions */
354 void InitCommandName(char *);
355 void InitExitFunction(void (*exit_function)(int));
356 void InitPlatformDependantStuff(void);
357 void ClosePlatformDependantStuff(void);
359 void InitProgramInfo(char *, char *, char *, char *, char *, char *, char *);
361 void InitGfxFieldInfo(int, int, int, int, int, int, int, int);
362 void InitGfxDoor1Info(int, int, int, int);
363 void InitGfxDoor2Info(int, int, int, int);
364 void InitGfxScrollbufferInfo(int, int);
366 inline void InitVideoDisplay(void);
367 inline void CloseVideoDisplay(void);
368 inline void InitVideoBuffer(DrawBuffer **,DrawWindow **, int,int,int, boolean);
369 inline Bitmap *CreateBitmapStruct(void);
370 inline Bitmap *CreateBitmap(int, int, int);
371 inline void FreeBitmap(Bitmap *);
372 inline void BlitBitmap(Bitmap *, Bitmap *, int, int, int, int, int, int);
373 inline void ClearRectangle(Bitmap *, int, int, int, int);
374 inline void SetClipMask(Bitmap *, GC, Pixmap);
375 inline void SetClipOrigin(Bitmap *, GC, int, int);
376 inline void BlitBitmapMasked(Bitmap *, Bitmap *, int, int, int, int, int, int);
377 inline void DrawSimpleWhiteLine(Bitmap *, int, int, int, int);
378 inline void DrawLines(Bitmap *, struct XY *, int, Pixel);
379 inline Pixel GetPixel(Bitmap *, int, int);
380 inline Pixel GetPixelFromRGB(Bitmap *, unsigned int,unsigned int,unsigned int);
381 inline Pixel GetPixelFromRGBcompact(Bitmap *, unsigned int);
383 inline void FlushDisplay(void);
384 inline void SyncDisplay(void);
385 inline void KeyboardAutoRepeatOn(void);
386 inline void KeyboardAutoRepeatOff(void);
387 inline boolean PointerInWindow(DrawWindow *);
388 inline boolean SetVideoMode(boolean);
389 inline boolean ChangeVideoModeIfNeeded(boolean);
391 Bitmap *LoadImage(char *);
393 inline void OpenAudio(void);
394 inline void CloseAudio(void);
395 inline void SetAudioMode(boolean);
397 inline void InitEventFilter(EventFilter);
398 inline boolean PendingEvent(void);
399 inline void NextEvent(Event *event);
400 inline Key GetEventKey(KeyEvent *, boolean);
401 inline boolean CheckCloseWindowEvent(ClientMessageEvent *);
403 #endif /* SYSTEM_H */