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 /* values for button_status */
44 #define MB_NOT_PRESSED FALSE
45 #define MB_NOT_RELEASED TRUE
46 #define MB_RELEASED FALSE
47 #define MB_PRESSED TRUE
48 #define MB_MENU_CHOICE FALSE
49 #define MB_MENU_MARK TRUE
50 #define MB_MENU_INITIALIZE (-1)
51 #define MB_LEFTBUTTON 1
52 #define MB_MIDDLEBUTTON 2
53 #define MB_RIGHTBUTTON 3
55 /* values for redraw_mask */
56 #define REDRAW_NONE (0)
57 #define REDRAW_ALL (1 << 0)
58 #define REDRAW_FIELD (1 << 1)
59 #define REDRAW_TILES (1 << 2)
60 #define REDRAW_DOOR_1 (1 << 3)
61 #define REDRAW_VIDEO_1 (1 << 4)
62 #define REDRAW_VIDEO_2 (1 << 5)
63 #define REDRAW_VIDEO_3 (1 << 6)
64 #define REDRAW_MICROLEVEL (1 << 7)
65 #define REDRAW_MICROLABEL (1 << 8)
66 #define REDRAW_FROM_BACKBUFFER (1 << 9)
67 #define REDRAW_DOOR_2 (REDRAW_VIDEO_1 | \
70 #define REDRAW_DOOR_3 (1 << 10)
71 #define REDRAW_DOORS (REDRAW_DOOR_1 | \
74 #define REDRAW_MAIN (REDRAW_FIELD | \
77 #define REDRAW_FPS (1 << 11)
78 #define REDRAWTILES_THRESHOLD (SCR_FIELDX * SCR_FIELDY / 2)
81 /* default name for empty highscore entry */
82 #define EMPTY_PLAYER_NAME "no name"
84 /* default name for unknown player names */
85 #define ANONYMOUS_NAME "anonymous"
87 /* default name for new levels */
88 #define NAMELESS_LEVEL_NAME "nameless level"
90 /* definitions for game sub-directories */
92 #define RO_GAME_DIR "."
96 #define RW_GAME_DIR "."
99 #define RO_BASE_PATH RO_GAME_DIR
100 #define RW_BASE_PATH RW_GAME_DIR
102 #define GRAPHICS_DIRECTORY "graphics"
103 #define MUSIC_DIRECTORY "music"
104 #define SOUNDS_DIRECTORY "sounds"
105 #define LEVELS_DIRECTORY "levels"
106 #define TAPES_DIRECTORY "tapes"
107 #define SCORES_DIRECTORY "scores"
109 /* areas in bitmap PIX_DOOR */
110 /* meaning in PIX_DB_DOOR: (3 PAGEs)
111 PAGEX1: 1. buffer for DOOR_1
112 PAGEX2: 2. buffer for DOOR_1
113 PAGEX3: buffer for animations
116 #define DOOR_GFX_PAGESIZE (gfx.dxsize)
117 #define DOOR_GFX_PAGEX1 (0 * DOOR_GFX_PAGESIZE)
118 #define DOOR_GFX_PAGEX2 (1 * DOOR_GFX_PAGESIZE)
119 #define DOOR_GFX_PAGEX3 (2 * DOOR_GFX_PAGESIZE)
120 #define DOOR_GFX_PAGEX4 (3 * DOOR_GFX_PAGESIZE)
121 #define DOOR_GFX_PAGEX5 (4 * DOOR_GFX_PAGESIZE)
122 #define DOOR_GFX_PAGEX6 (5 * DOOR_GFX_PAGESIZE)
123 #define DOOR_GFX_PAGEX7 (6 * DOOR_GFX_PAGESIZE)
124 #define DOOR_GFX_PAGEX8 (7 * DOOR_GFX_PAGESIZE)
125 #define DOOR_GFX_PAGEY1 (0)
126 #define DOOR_GFX_PAGEY2 (gfx.dysize)
129 /* type definitions */
131 typedef int (*EventFilter)(const Event *);
134 /* structure definitions */
138 char *command_basename;
139 char *userdata_directory;
144 char *x11_icon_filename;
145 char *x11_iconmask_filename;
146 char *msdos_pointer_filename;
148 void (*exit_function)(int);
156 char *ro_base_directory;
157 char *rw_base_directory;
158 char *level_directory;
165 struct VideoSystemInfo
168 int width, height, depth;
169 boolean fullscreen_available;
170 boolean fullscreen_enabled;
173 struct AudioSystemInfo
175 boolean sound_available;
176 boolean music_available;
177 boolean loops_available;
178 boolean mods_available;
179 boolean sound_enabled;
181 int soundserver_pipe[2];
195 int real_sx, real_sy;
196 int full_sxsize, full_sysize;
197 int scrollbuffer_width, scrollbuffer_height;
208 char *filename; /* level series single directory name */
209 char *fullpath; /* complete path relative to level directory */
210 char *basepath; /* absolute base path of level directory */
211 char *name; /* level series name, as displayed on main screen */
212 char *name_short; /* optional short name for level selection screen */
213 char *name_sorting; /* optional sorting name for correct level sorting */
214 char *author; /* level series author name levels without author */
215 char *imported_from; /* optional comment for imported level series */
216 int levels; /* number of levels in level series */
217 int first_level; /* first level number (to allow start with 0 or 1) */
218 int last_level; /* last level number (automatically calculated) */
219 int sort_priority; /* sort levels by 'sort_priority' and then by name */
220 boolean level_group; /* directory contains more level series directories */
221 boolean parent_link; /* entry links back to parent directory */
222 boolean user_defined; /* user defined levels are stored in home directory */
223 boolean readonly; /* readonly levels can not be changed with editor */
224 int color; /* color to use on selection screen for this level */
225 char *class_desc; /* description of level series class */
226 int handicap_level; /* number of the lowest unsolved level */
227 int cl_first; /* internal control field for "choose level" screen */
228 int cl_cursor; /* internal control field for "choose level" screen */
230 struct LevelDirInfo *node_parent; /* parent level directory info */
231 struct LevelDirInfo *node_group; /* level group sub-directory info */
232 struct LevelDirInfo *next; /* next level series structure node */
236 /* ========================================================================= */
237 /* exported variables */
238 /* ========================================================================= */
240 extern struct ProgramInfo program;
241 extern struct OptionInfo options;
242 extern struct VideoSystemInfo video;
243 extern struct AudioSystemInfo audio;
244 extern struct GfxInfo gfx;
246 extern struct LevelDirInfo *leveldir_first;
247 extern struct LevelDirInfo *leveldir_current;
249 extern Display *display;
250 extern Visual *visual;
252 extern Colormap cmap;
254 extern DrawWindow *window;
255 extern DrawBuffer *backbuffer;
256 extern DrawBuffer *drawto;
258 extern int button_status;
259 extern boolean motion_status;
261 extern int redraw_mask;
262 extern int redraw_tiles;
264 extern int FrameCounter;
267 /* function definitions */
269 void InitCommandName(char *);
270 void InitExitFunction(void (*exit_function)(int));
271 void InitPlatformDependantStuff(void);
272 void ClosePlatformDependantStuff(void);
274 void InitProgramInfo(char *, char *, char *, char *, char *, char *, char *);
276 void InitGfxFieldInfo(int, int, int, int, int, int, int, int);
277 void InitGfxDoor1Info(int, int, int, int);
278 void InitGfxDoor2Info(int, int, int, int);
279 void InitGfxScrollbufferInfo(int, int);
281 inline void InitVideoDisplay(void);
282 inline void CloseVideoDisplay(void);
283 inline void InitVideoBuffer(DrawBuffer **,DrawWindow **, int,int,int, boolean);
284 inline Bitmap *CreateBitmapStruct(void);
285 inline Bitmap *CreateBitmap(int, int, int);
286 inline void FreeBitmap(Bitmap *);
287 inline void BlitBitmap(Bitmap *, Bitmap *, int, int, int, int, int, int);
288 inline void ClearRectangle(Bitmap *, int, int, int, int);
289 inline void SetClipMask(Bitmap *, GC, Pixmap);
290 inline void SetClipOrigin(Bitmap *, GC, int, int);
291 inline void BlitBitmapMasked(Bitmap *, Bitmap *, int, int, int, int, int, int);
292 inline void DrawSimpleWhiteLine(Bitmap *, int, int, int, int);
293 inline void DrawLines(Bitmap *, struct XY *, int, Pixel);
294 inline Pixel GetPixelFromRGB(Bitmap *, unsigned int,unsigned int,unsigned int);
295 inline Pixel GetPixelFromRGBcompact(Bitmap *, unsigned int);
297 inline void FlushDisplay(void);
298 inline void SyncDisplay(void);
299 inline void KeyboardAutoRepeatOn(void);
300 inline void KeyboardAutoRepeatOff(void);
301 inline boolean PointerInWindow(DrawWindow *);
302 inline boolean SetVideoMode(boolean);
303 inline boolean ChangeVideoModeIfNeeded(boolean);
305 Bitmap *LoadImage(char *);
307 inline void OpenAudio(void);
308 inline void CloseAudio(void);
309 inline void SetAudioMode(boolean);
311 inline void InitEventFilter(EventFilter);
312 inline boolean PendingEvent(void);
313 inline void NextEvent(Event *event);
314 inline Key GetEventKey(KeyEvent *, boolean);
315 inline boolean CheckCloseWindowEvent(ClientMessageEvent *);
317 #endif /* SYSTEM_H */