rnd-20030125-1-src
[rocksndiamonds.git] / src / libgame / system.h
1 /***********************************************************
2 * Artsoft Retro-Game Library                               *
3 *----------------------------------------------------------*
4 * (c) 1994-2002 Artsoft Entertainment                      *
5 *               Holger Schemel                             *
6 *               Detmolder Strasse 189                      *
7 *               33604 Bielefeld                            *
8 *               Germany                                    *
9 *               e-mail: info@artsoft.org                   *
10 *----------------------------------------------------------*
11 * system.h                                                 *
12 ***********************************************************/
13
14 #ifndef SYSTEM_H
15 #define SYSTEM_H
16
17 #include "platform.h"
18 #include "types.h"
19
20 #if defined(PLATFORM_MSDOS)
21 #include "msdos.h"
22 #endif
23
24 #if defined(TARGET_SDL)
25 #include "sdl.h"
26 #elif defined(TARGET_X11)
27 #include "x11.h"
28 #endif
29
30 #if defined(PLATFORM_MACOSX)
31 /* some symbols are already defined on Mac OS X */
32 #define Delay Delay_internal
33 #define DrawLine DrawLine_internal
34 #define DrawText DrawText_internal
35 #define GetPixel GetPixel_internal
36 #endif
37
38
39 /* the additional 'b' is needed for Win32 to open files in binary mode */
40 #define MODE_READ               "rb"
41 #define MODE_WRITE              "wb"
42 #define MODE_APPEND             "ab"
43
44 #define DEFAULT_DEPTH           0
45
46 #define FULLSCREEN_NOT_AVAILABLE FALSE
47 #define FULLSCREEN_AVAILABLE     TRUE
48
49 /* default input keys */
50 #define DEFAULT_KEY_LEFT        KSYM_Left
51 #define DEFAULT_KEY_RIGHT       KSYM_Right
52 #define DEFAULT_KEY_UP          KSYM_Up
53 #define DEFAULT_KEY_DOWN        KSYM_Down
54 #if defined(PLATFORM_MACOSX)
55 #define DEFAULT_KEY_SNAP        KSYM_Control_L
56 #define DEFAULT_KEY_BOMB        KSYM_KP_Enter
57 #else
58 #define DEFAULT_KEY_SNAP        KSYM_Shift_L
59 #define DEFAULT_KEY_BOMB        KSYM_Shift_R
60 #endif
61 #define DEFAULT_KEY_OKAY        KSYM_Return
62 #define DEFAULT_KEY_CANCEL      KSYM_Escape
63
64 /* default shortcut keys */
65 #define DEFAULT_KEY_SAVE_GAME   KSYM_F1
66 #define DEFAULT_KEY_LOAD_GAME   KSYM_F2
67 #define DEFAULT_KEY_TOGGLE_PAUSE KSYM_space
68
69 /* values for move directions and special "button" keys */
70 #define MV_BIT_LEFT             0
71 #define MV_BIT_RIGHT            1
72 #define MV_BIT_UP               2
73 #define MV_BIT_DOWN             3
74 #define NUM_DIRECTIONS          4
75
76 #define MV_NO_MOVING            0
77 #define MV_LEFT                 (1 << MV_BIT_LEFT)
78 #define MV_RIGHT                (1 << MV_BIT_RIGHT)
79 #define MV_UP                   (1 << MV_BIT_UP)
80 #define MV_DOWN                 (1 << MV_BIT_DOWN)
81 #define KEY_BUTTON_1            (1 << 4)
82 #define KEY_BUTTON_2            (1 << 5)
83 #define KEY_MOTION              (MV_LEFT | MV_RIGHT | MV_UP | MV_DOWN)
84 #define KEY_BUTTON              (KEY_BUTTON_1 | KEY_BUTTON_2)
85 #define KEY_ACTION              (KEY_MOTION | KEY_BUTTON)
86
87 #define MV_DIR_BIT(x)           ((x) == MV_LEFT  ? MV_BIT_LEFT  :       \
88                                  (x) == MV_RIGHT ? MV_BIT_RIGHT :       \
89                                  (x) == MV_UP    ? MV_BIT_UP    : MV_BIT_DOWN)
90
91 /* values for button status */
92 #define MB_NOT_PRESSED          FALSE
93 #define MB_NOT_RELEASED         TRUE
94 #define MB_RELEASED             FALSE
95 #define MB_PRESSED              TRUE
96 #define MB_MENU_CHOICE          FALSE
97 #define MB_MENU_MARK            TRUE
98 #define MB_MENU_INITIALIZE      (-1)
99 #define MB_MENU_LEAVE           (-2)
100 #define MB_LEFTBUTTON           1
101 #define MB_MIDDLEBUTTON         2
102 #define MB_RIGHTBUTTON          3
103
104 /* values for redraw_mask */
105 #define REDRAW_NONE             (0)
106 #define REDRAW_ALL              (1 << 0)
107 #define REDRAW_FIELD            (1 << 1)
108 #define REDRAW_TILES            (1 << 2)
109 #define REDRAW_DOOR_1           (1 << 3)
110 #define REDRAW_VIDEO_1          (1 << 4)
111 #define REDRAW_VIDEO_2          (1 << 5)
112 #define REDRAW_VIDEO_3          (1 << 6)
113 #define REDRAW_MICROLEVEL       (1 << 7)
114 #define REDRAW_MICROLABEL       (1 << 8)
115 #define REDRAW_FROM_BACKBUFFER  (1 << 9)
116 #define REDRAW_DOOR_2           (REDRAW_VIDEO_1 | \
117                                  REDRAW_VIDEO_2 | \
118                                  REDRAW_VIDEO_3)
119 #define REDRAW_DOOR_3           (1 << 10)
120 #define REDRAW_DOORS            (REDRAW_DOOR_1 | \
121                                  REDRAW_DOOR_2 | \
122                                  REDRAW_DOOR_3)
123 #define REDRAW_MAIN             (REDRAW_FIELD | \
124                                  REDRAW_TILES | \
125                                  REDRAW_MICROLEVEL)
126 #define REDRAW_FPS              (1 << 11)
127 #define REDRAWTILES_THRESHOLD   (SCR_FIELDX * SCR_FIELDY / 2)
128
129 /* maximum number of parallel players supported by libgame functions */
130 #define MAX_PLAYERS             4
131
132 /* maximum allowed length of player name */
133 #define MAX_PLAYER_NAME_LEN     10
134
135 /* default name for empty highscore entry */
136 #define EMPTY_PLAYER_NAME       "no name"
137
138 /* default name for unknown player names */
139 #define ANONYMOUS_NAME          "anonymous"
140
141 /* default name for new levels */
142 #define NAMELESS_LEVEL_NAME     "nameless level"
143
144 /* default text for non-existant artwork */
145 #define NOT_AVAILABLE           "(not available)"
146
147 /* default value for undefined filename */
148 #define UNDEFINED_FILENAME      "[NONE]"
149
150 /* default values for undefined configuration file parameters */
151 #define ARG_UNDEFINED           "-1000000"
152 #define ARG_UNDEFINED_VALUE     (atoi(ARG_UNDEFINED))
153
154 /* definitions for game sub-directories */
155 #ifndef RO_GAME_DIR
156 #define RO_GAME_DIR             "."
157 #endif
158
159 #ifndef RW_GAME_DIR
160 #define RW_GAME_DIR             "."
161 #endif
162
163 #define RO_BASE_PATH            RO_GAME_DIR
164 #define RW_BASE_PATH            RW_GAME_DIR
165
166 #define GRAPHICS_DIRECTORY      "graphics"
167 #define SOUNDS_DIRECTORY        "sounds"
168 #define MUSIC_DIRECTORY         "music"
169 #define LEVELS_DIRECTORY        "levels"
170 #define TAPES_DIRECTORY         "tapes"
171 #define SCORES_DIRECTORY        "scores"
172
173 #if !defined(PLATFORM_MSDOS)
174 #define GRAPHICS_SUBDIR         "gfx_classic"
175 #define SOUNDS_SUBDIR           "snd_classic"
176 #define MUSIC_SUBDIR            "mus_classic"
177 #else
178 #define GRAPHICS_SUBDIR         "gfx_orig"
179 #define SOUNDS_SUBDIR           "snd_orig"
180 #define MUSIC_SUBDIR            "mus_orig"
181 #endif
182
183 /* areas in bitmap PIX_DOOR */
184 /* meaning in PIX_DB_DOOR: (3 PAGEs)
185    PAGEX1: 1. buffer for DOOR_1
186    PAGEX2: 2. buffer for DOOR_1
187    PAGEX3: buffer for animations
188 */
189
190 #define DOOR_GFX_PAGESIZE       (gfx.dxsize)
191 #define DOOR_GFX_PAGEX1         (0 * DOOR_GFX_PAGESIZE)
192 #define DOOR_GFX_PAGEX2         (1 * DOOR_GFX_PAGESIZE)
193 #define DOOR_GFX_PAGEX3         (2 * DOOR_GFX_PAGESIZE)
194 #define DOOR_GFX_PAGEX4         (3 * DOOR_GFX_PAGESIZE)
195 #define DOOR_GFX_PAGEX5         (4 * DOOR_GFX_PAGESIZE)
196 #define DOOR_GFX_PAGEX6         (5 * DOOR_GFX_PAGESIZE)
197 #define DOOR_GFX_PAGEX7         (6 * DOOR_GFX_PAGESIZE)
198 #define DOOR_GFX_PAGEX8         (7 * DOOR_GFX_PAGESIZE)
199 #define DOOR_GFX_PAGEY1         (0)
200 #define DOOR_GFX_PAGEY2         (gfx.dysize)
201
202 /* functions for version handling */
203 #define VERSION_IDENT(x,y,z)    ((x) * 10000 + (y) * 100 + (z))
204 #define VERSION_MAJOR(x)        ((x) / 10000)
205 #define VERSION_MINOR(x)        (((x) % 10000) / 100)
206 #define VERSION_PATCH(x)        ((x) % 100)
207
208 /* functions for parent/child process identification */
209 #define IS_PARENT_PROCESS(pid)  ((pid) > 0 || (pid) == -1)
210 #define IS_CHILD_PROCESS(pid)   ((pid) == 0)
211
212
213 /* type definitions */
214 typedef int (*EventFilter)(const Event *);
215
216
217 /* structure definitions */
218
219 struct ProgramInfo
220 {
221   char *command_basename;
222   char *userdata_directory;
223
224   char *program_title;
225   char *window_title;
226   char *icon_title;
227
228   char *x11_icon_filename;
229   char *x11_iconmask_filename;
230   char *msdos_pointer_filename;
231
232   char *cookie_prefix;
233   char *filename_prefix;        /* prefix to cut off from DOS filenames */
234
235   int version_major;
236   int version_minor;
237   int version_patch;
238
239   void (*exit_function)(int);
240 };
241
242 struct OptionInfo
243 {
244   char *display_name;
245   char *server_host;
246   int server_port;
247
248   char *ro_base_directory;
249   char *rw_base_directory;
250   char *level_directory;
251   char *graphics_directory;
252   char *sounds_directory;
253   char *music_directory;
254   char *execute_command;
255
256   boolean serveronly;
257   boolean network;
258   boolean verbose;
259   boolean debug;
260 };
261
262 struct VideoSystemInfo
263 {
264   int default_depth;
265   int width, height, depth;
266   boolean fullscreen_available;
267   boolean fullscreen_enabled;
268 };
269
270 struct AudioSystemInfo
271 {
272   boolean sound_available;
273   boolean loops_available;
274   boolean music_available;
275
276   boolean sound_enabled;
277   boolean sound_deactivated;    /* for temporarily disabling sound */
278
279   int mixer_pipe[2];
280   int mixer_pid;
281   char *device_name;
282   int device_fd;
283
284   int num_channels;
285   int music_channel;
286   int first_sound_channel;
287 };
288
289 struct GfxInfo
290 {
291   int sx, sy;
292   int sxsize, sysize;
293   int real_sx, real_sy;
294   int full_sxsize, full_sysize;
295   int scrollbuffer_width, scrollbuffer_height;
296
297   int dx, dy;
298   int dxsize, dysize;
299
300   int vx, vy;
301   int vxsize, vysize;
302
303   int draw_deactivation_mask;
304   int draw_background_mask;
305
306   Bitmap *background_bitmap;
307   int background_bitmap_mask;
308 };
309
310 struct FontInfo
311 {
312   Bitmap *bitmap_initial;
313   Bitmap *bitmap_big;
314   Bitmap *bitmap_medium;
315   Bitmap *bitmap_small;
316   Bitmap *bitmap_tile;
317 };
318
319 struct AnimInfo
320 {
321   int simple_random_value;
322 };
323
324 struct JoystickInfo
325 {
326   int status;
327   int fd[MAX_PLAYERS];          /* file descriptor of player's joystick */
328 };
329
330 struct SetupJoystickInfo
331 {
332   char *device_name;            /* device name of player's joystick */
333
334   int xleft, xmiddle, xright;
335   int yupper, ymiddle, ylower;
336   int snap;
337   int bomb;
338 };
339
340 struct SetupKeyboardInfo
341 {
342   Key left;
343   Key right;
344   Key up;
345   Key down;
346   Key snap;
347   Key bomb;
348 };
349
350 struct SetupInputInfo
351 {
352   boolean use_joystick;
353   struct SetupJoystickInfo joy;
354   struct SetupKeyboardInfo key;
355 };
356
357 struct SetupEditorInfo
358 {
359   boolean el_boulderdash;
360   boolean el_emerald_mine;
361   boolean el_more;
362   boolean el_sokoban;
363   boolean el_supaplex;
364   boolean el_diamond_caves;
365   boolean el_dx_boulderdash;
366   boolean el_chars;
367   boolean el_custom;
368 };
369
370 struct SetupShortcutInfo
371 {
372   Key save_game;
373   Key load_game;
374   Key toggle_pause;
375 };
376
377 struct SetupInfo
378 {
379   char *player_name;
380
381   boolean sound;
382   boolean sound_loops;
383   boolean sound_music;
384   boolean sound_simple;
385   boolean toons;
386   boolean double_buffering;
387   boolean direct_draw;          /* !double_buffering (redundant!) */
388   boolean scroll_delay;
389   boolean soft_scrolling;
390   boolean fading;
391   boolean autorecord;
392   boolean quick_doors;
393   boolean team_mode;
394   boolean handicap;
395   boolean time_limit;
396   boolean fullscreen;
397   boolean ask_on_escape;
398
399   char *graphics_set;
400   char *sounds_set;
401   char *music_set;
402   boolean override_level_graphics;
403   boolean override_level_sounds;
404   boolean override_level_music;
405
406   struct SetupEditorInfo editor;
407   struct SetupShortcutInfo shortcut;
408   struct SetupInputInfo input[MAX_PLAYERS];
409 };
410
411 #define TREE_TYPE_GENERIC               0
412 #define TREE_TYPE_GRAPHICS_DIR          1
413 #define TREE_TYPE_SOUNDS_DIR            2
414 #define TREE_TYPE_MUSIC_DIR             3
415 #define TREE_TYPE_LEVEL_DIR             4
416
417 #define ARTWORK_TYPE_GRAPHICS           TREE_TYPE_GRAPHICS_DIR
418 #define ARTWORK_TYPE_SOUNDS             TREE_TYPE_SOUNDS_DIR
419 #define ARTWORK_TYPE_MUSIC              TREE_TYPE_MUSIC_DIR
420
421 struct TreeInfo
422 {
423   struct TreeInfo **node_top;           /* topmost node in tree */
424   struct TreeInfo *node_parent;         /* parent level directory info */
425   struct TreeInfo *node_group;          /* level group sub-directory info */
426   struct TreeInfo *next;                /* next level series structure node */
427
428   int cl_first;         /* internal control field for setup screen */
429   int cl_cursor;        /* internal control field for setup screen */
430
431   int type;             /* type of tree content */
432
433   /* fields for "type == TREE_TYPE_LEVEL_DIR" */
434
435   char *filename;       /* tree info sub-directory basename (may be ".") */
436   char *fullpath;       /* complete path relative to tree base directory */
437   char *basepath;       /* absolute base path of tree base directory */
438   char *identifier;     /* identifier string for configuration files */
439   char *name;           /* tree info name, as displayed in selection menues */
440   char *name_sorting;   /* optional sorting name for correct name sorting */
441   char *author;         /* level or artwork author name */
442   char *imported_from;  /* optional comment for imported levels or artwork */
443
444   char *graphics_set;   /* optional custom graphics set (level tree only) */
445   char *sounds_set;     /* optional custom sounds set (level tree only) */
446   char *music_set;      /* optional custom music set (level tree only) */
447   char *graphics_path;  /* path to optional custom graphics set (level only) */
448   char *sounds_path;    /* path to optional custom sounds set (level only) */
449   char *music_path;     /* path to optional custom music set (level only) */
450
451   int levels;           /* number of levels in level series */
452   int first_level;      /* first level number (to allow start with 0 or 1) */
453   int last_level;       /* last level number (automatically calculated) */
454   int sort_priority;    /* sort levels by 'sort_priority' and then by name */
455
456   boolean level_group;  /* directory contains more level series directories */
457   boolean parent_link;  /* entry links back to parent directory */
458   boolean user_defined; /* user defined levels are stored in home directory */
459   boolean readonly;     /* readonly levels can not be changed with editor */
460
461   int color;            /* color to use on selection screen for this level */
462   char *class_desc;     /* description of level series class */
463   int handicap_level;   /* number of the lowest unsolved level */
464 };
465
466 typedef struct TreeInfo TreeInfo;
467 typedef struct TreeInfo LevelDirTree;
468 typedef struct TreeInfo ArtworkDirTree;
469 typedef struct TreeInfo GraphicsDirTree;
470 typedef struct TreeInfo SoundsDirTree;
471 typedef struct TreeInfo MusicDirTree;
472
473 struct ArtworkInfo
474 {
475   GraphicsDirTree *gfx_first;
476   GraphicsDirTree *gfx_current;
477   SoundsDirTree *snd_first;
478   SoundsDirTree *snd_current;
479   MusicDirTree *mus_first;
480   MusicDirTree *mus_current;
481
482   char *gfx_current_identifier;
483   char *snd_current_identifier;
484   char *mus_current_identifier;
485 };
486
487 struct ConfigInfo
488 {
489   char *token;
490   char *value;
491   int type;
492 };
493
494 struct FileInfo
495 {
496   char *token;
497
498   char *default_filename;
499   char *filename;
500
501   int *default_parameter;                       /* array of file parameters */
502   int *parameter;                               /* array of file parameters */
503 };
504
505 struct SetupFileList
506 {
507   char *token;
508   char *value;
509
510   struct SetupFileList *next;
511 };
512
513 struct ListNodeInfo
514 {
515   char *source_filename;                        /* primary key for node list */
516   int num_references;
517 };
518
519 struct PropertyMapping
520 {
521   int base_index;
522   int ext1_index;
523   int ext2_index;
524
525   int artwork_index;
526 };
527
528 struct ArtworkListInfo
529 {
530   int type;                                     /* type of artwork */
531
532   int num_file_list_entries;
533   int num_dynamic_file_list_entries;
534
535   struct FileInfo *file_list;                   /* static artwork file array */
536   struct FileInfo *dynamic_file_list;           /* dynamic artwrk file array */
537
538   int num_suffix_list_entries;
539
540   struct ConfigInfo *suffix_list;               /* parameter suffixes array */
541
542   int num_base_prefixes;
543   int num_ext1_suffixes;
544   int num_ext2_suffixes;
545
546   char **base_prefixes;                         /* base token prefixes array */
547   char **ext1_suffixes;                         /* property suffixes array 1 */
548   char **ext2_suffixes;                         /* property suffixes array 2 */
549
550   int num_property_mapping_entries;
551
552   struct PropertyMapping *property_mapping;     /* mapping token -> artwork */
553
554   int sizeof_artwork_list_entry;
555
556   struct ListNodeInfo **artwork_list;           /* static artwork node array */
557   struct ListNodeInfo **dynamic_artwork_list;   /* dynamic artwrk node array */
558   struct ListNode *content_list;                /* dynamic artwork node list */
559
560   void *(*load_artwork)(char *);                /* constructor function */
561   void (*free_artwork)(void *);                 /* destructor function */
562 };
563
564
565 /* ========================================================================= */
566 /* exported variables                                                        */
567 /* ========================================================================= */
568
569 extern struct ProgramInfo       program;
570 extern struct OptionInfo        options;
571 extern struct VideoSystemInfo   video;
572 extern struct AudioSystemInfo   audio;
573 extern struct GfxInfo           gfx;
574 extern struct FontInfo          font;
575 extern struct AnimInfo          anim;
576 extern struct ArtworkInfo       artwork;
577 extern struct JoystickInfo      joystick;
578 extern struct SetupInfo         setup;
579
580 extern LevelDirTree            *leveldir_first;
581 extern LevelDirTree            *leveldir_current;
582 extern int                      level_nr;
583
584 extern Display                 *display;
585 extern Visual                  *visual;
586 extern int                      screen;
587 extern Colormap                 cmap;
588
589 extern DrawWindow              *window;
590 extern DrawBuffer              *backbuffer;
591 extern DrawBuffer              *drawto;
592
593 extern int                      button_status;
594 extern boolean                  motion_status;
595
596 extern int                      redraw_mask;
597 extern int                      redraw_tiles;
598
599 extern int                      FrameCounter;
600
601
602 /* function definitions */
603
604 void InitCommandName(char *);
605 void InitExitFunction(void (*exit_function)(int));
606 void InitPlatformDependantStuff(void);
607 void ClosePlatformDependantStuff(void);
608
609 void InitProgramInfo(char *, char *, char *, char *, char *, char *, char *,
610                      char *, char *, int);
611
612 void InitGfxFieldInfo(int, int, int, int, int, int, int, int);
613 void InitGfxDoor1Info(int, int, int, int);
614 void InitGfxDoor2Info(int, int, int, int);
615 void InitGfxScrollbufferInfo(int, int);
616 void SetDrawDeactivationMask(int);
617 void SetDrawBackgroundMask(int);
618 void SetMainBackgroundBitmap(Bitmap *);
619 void SetDoorBackgroundBitmap(Bitmap *);
620
621 inline void InitVideoDisplay(void);
622 inline void CloseVideoDisplay(void);
623 inline void InitVideoBuffer(DrawBuffer **,DrawWindow **, int,int,int, boolean);
624 inline Bitmap *CreateBitmapStruct(void);
625 inline Bitmap *CreateBitmap(int, int, int);
626 inline void FreeBitmap(Bitmap *);
627 inline void BlitBitmap(Bitmap *, Bitmap *, int, int, int, int, int, int);
628 inline void ClearRectangle(Bitmap *, int, int, int, int);
629 inline void ClearRectangleOnBackground(Bitmap *, int, int, int, int);
630 inline void SetClipMask(Bitmap *, GC, Pixmap);
631 inline void SetClipOrigin(Bitmap *, GC, int, int);
632 inline void BlitBitmapMasked(Bitmap *, Bitmap *, int, int, int, int, int, int);
633 inline boolean DrawingOnBackground(int, int);
634 inline void BlitBitmapOnBackground(Bitmap *, Bitmap *, int, int, int, int, int,
635                                    int);
636 inline void DrawSimpleWhiteLine(Bitmap *, int, int, int, int);
637 inline void DrawLines(Bitmap *, struct XY *, int, Pixel);
638 inline Pixel GetPixel(Bitmap *, int, int);
639 inline Pixel GetPixelFromRGB(Bitmap *, unsigned int,unsigned int,unsigned int);
640 inline Pixel GetPixelFromRGBcompact(Bitmap *, unsigned int);
641
642 inline void FlushDisplay(void);
643 inline void SyncDisplay(void);
644 inline void KeyboardAutoRepeatOn(void);
645 inline void KeyboardAutoRepeatOff(void);
646 inline boolean PointerInWindow(DrawWindow *);
647 inline boolean SetVideoMode(boolean);
648 inline boolean ChangeVideoModeIfNeeded(boolean);
649
650 Bitmap *LoadImage(char *);
651 Bitmap *LoadCustomImage(char *);
652 void ReloadCustomImage(Bitmap *, char *);
653
654 inline void OpenAudio(void);
655 inline void CloseAudio(void);
656 inline void SetAudioMode(boolean);
657
658 inline void InitEventFilter(EventFilter);
659 inline boolean PendingEvent(void);
660 inline void NextEvent(Event *event);
661 inline Key GetEventKey(KeyEvent *, boolean);
662 inline boolean CheckCloseWindowEvent(ClientMessageEvent *);
663
664 inline void InitJoysticks();
665 inline boolean ReadJoystick(int, int *, int *, boolean *, boolean *);
666
667 #endif /* SYSTEM_H */