rnd-20030703-1-src
[rocksndiamonds.git] / src / libgame / system.h
index 17411f8d0464a4d685bcccfbc557ebdac97a5b9d..d5f4457f48f45219ee63ada6cd2deb1f6bdc8ff8 100644 (file)
@@ -1,7 +1,7 @@
 /***********************************************************
 * Artsoft Retro-Game Library                               *
 *----------------------------------------------------------*
-* (c) 1994-2001 Artsoft Entertainment                      *
+* (c) 1994-2002 Artsoft Entertainment                      *
 *               Holger Schemel                             *
 *               Detmolder Strasse 189                      *
 *               33604 Bielefeld                            *
 #include "platform.h"
 #include "types.h"
 
-#if defined(PLATFORM_MSDOS)
+
+#if defined(PLATFORM_MACOSX)
+#include "macosx.h"
+#elif defined(PLATFORM_WIN32)
+#include "windows.h"
+#elif defined(PLATFORM_MSDOS)
 #include "msdos.h"
 #endif
 
 
 #define DEFAULT_DEPTH          0
 
+#define BLIT_OPAQUE            0
+#define BLIT_MASKED            1
+#define BLIT_INVERSE           2
+#define BLIT_ON_BACKGROUND     3
+
 #define FULLSCREEN_NOT_AVAILABLE FALSE
 #define FULLSCREEN_AVAILABLE    TRUE
 
 #define DEFAULT_KEY_RIGHT      KSYM_Right
 #define DEFAULT_KEY_UP         KSYM_Up
 #define DEFAULT_KEY_DOWN       KSYM_Down
+#if defined(PLATFORM_MACOSX)
+#define DEFAULT_KEY_SNAP       KSYM_Control_L
+#define DEFAULT_KEY_BOMB       KSYM_KP_Enter
+#else
 #define DEFAULT_KEY_SNAP       KSYM_Shift_L
 #define DEFAULT_KEY_BOMB       KSYM_Shift_R
+#endif
 #define DEFAULT_KEY_OKAY       KSYM_Return
 #define DEFAULT_KEY_CANCEL     KSYM_Escape
 
 /* default shortcut keys */
 #define DEFAULT_KEY_SAVE_GAME  KSYM_F1
 #define DEFAULT_KEY_LOAD_GAME  KSYM_F2
+#define DEFAULT_KEY_TOGGLE_PAUSE KSYM_space
 
-/* values for move directions */
-#define MV_NO_MOVING           0
-#define MV_LEFT                        (1 << 0)
-#define MV_RIGHT               (1 << 1)
-#define MV_UP                  (1 << 2)
-#define MV_DOWN                        (1 << 3)
+/* values for key_status */
+#define KEY_NOT_PRESSED                FALSE
+#define KEY_RELEASED           FALSE
+#define KEY_PRESSED            TRUE
 
 /* values for button status */
 #define MB_NOT_PRESSED         FALSE
 #define MB_MIDDLEBUTTON                2
 #define MB_RIGHTBUTTON         3
 
+
+/* values for basic move directions (effective at runtime) */
+#define MV_BIT_LEFT            0
+#define MV_BIT_RIGHT           1
+#define MV_BIT_UP              2
+#define MV_BIT_DOWN            3
+
+#define NUM_DIRECTIONS         4
+
+/* values for special "button" bitmasks (effective at runtime) */
+#define BUTTON_1               4
+#define BUTTON_2               5
+
+/* values for special move patterns (stored in level files) */
+#define MV_BIT_TOWARDS_PLAYER  6
+#define MV_BIT_AWAY_FROM_PLAYER        7
+#define MV_BIT_ALONG_LEFT_SIDE 8
+#define MV_BIT_ALONG_RIGHT_SIDE        9
+#define MV_BIT_TURNING_LEFT    10
+#define MV_BIT_TURNING_RIGHT   11
+
+/* values for move direction/pattern and special "button" key bitmasks */
+#define MV_NO_MOVING           0
+#define MV_LEFT                        (1 << MV_BIT_LEFT)
+#define MV_RIGHT               (1 << MV_BIT_RIGHT)
+#define MV_UP                  (1 << MV_BIT_UP)
+#define MV_DOWN                        (1 << MV_BIT_DOWN)
+
+#define KEY_BUTTON_1           (1 << BUTTON_1)
+#define KEY_BUTTON_2           (1 << BUTTON_2)
+#define KEY_MOTION             (MV_LEFT | MV_RIGHT | MV_UP | MV_DOWN)
+#define KEY_BUTTON             (KEY_BUTTON_1 | KEY_BUTTON_2)
+#define KEY_ACTION             (KEY_MOTION | KEY_BUTTON)
+
+#define MV_DIR_BIT(x)          ((x) == MV_LEFT  ? MV_BIT_LEFT  :       \
+                                (x) == MV_RIGHT ? MV_BIT_RIGHT :       \
+                                (x) == MV_UP    ? MV_BIT_UP    : MV_BIT_DOWN)
+
+#define MV_HORIZONTAL          (MV_LEFT | MV_RIGHT)
+#define MV_VERTICAL            (MV_UP | MV_DOWN)
+#define MV_ALL_DIRECTIONS      (MV_HORIZONTAL | MV_VERTICAL)
+#define MV_ANY_DIRECTION       (MV_ALL_DIRECTIONS)
+#define MV_TOWARDS_PLAYER      (1 << MV_BIT_TOWARDS_PLAYER)
+#define MV_AWAY_FROM_PLAYER    (1 << MV_BIT_AWAY_FROM_PLAYER)
+#define MV_ALONG_LEFT_SIDE     (1 << MV_BIT_ALONG_LEFT_SIDE)
+#define MV_ALONG_RIGHT_SIDE    (1 << MV_BIT_ALONG_RIGHT_SIDE)
+#define MV_TURNING_LEFT                (1 << MV_BIT_TURNING_LEFT)
+#define MV_TURNING_RIGHT       (1 << MV_BIT_TURNING_RIGHT)
+
+
+/* values for animation mode (frame order and direction) */
+#define ANIM_NONE              0
+#define ANIM_LOOP              (1 << 0)
+#define ANIM_LINEAR            (1 << 1)
+#define ANIM_PINGPONG          (1 << 2)
+#define ANIM_PINGPONG2         (1 << 3)
+#define ANIM_RANDOM            (1 << 4)
+#define ANIM_REVERSE           (1 << 5)
+
+
 /* values for redraw_mask */
 #define REDRAW_NONE            (0)
 #define REDRAW_ALL             (1 << 0)
 #define REDRAW_FPS             (1 << 11)
 #define REDRAWTILES_THRESHOLD  (SCR_FIELDX * SCR_FIELDY / 2)
 
+
+/* values for mouse cursor */
+#define CURSOR_DEFAULT         0
+#define CURSOR_PLAYFIELD       1
+
+
 /* maximum number of parallel players supported by libgame functions */
 #define MAX_PLAYERS            4
 
 /* default name for new levels */
 #define NAMELESS_LEVEL_NAME    "nameless level"
 
+/* default text for non-existant artwork */
+#define NOT_AVAILABLE          "(not available)"
+
+/* default value for undefined filename */
+#define UNDEFINED_FILENAME     "[NONE]"
+
+/* default value for undefined parameter */
+#define ARG_DEFAULT            "[DEFAULT]"
+
+/* default values for undefined configuration file parameters */
+#define ARG_UNDEFINED          "-1000000"
+#define ARG_UNDEFINED_VALUE    (atoi(ARG_UNDEFINED))
+
 /* definitions for game sub-directories */
 #ifndef RO_GAME_DIR
 #define RO_GAME_DIR            "."
 #define LEVELS_DIRECTORY       "levels"
 #define TAPES_DIRECTORY                "tapes"
 #define SCORES_DIRECTORY       "scores"
+#define DOCS_DIRECTORY         "docs"
 
 #if !defined(PLATFORM_MSDOS)
 #define GRAPHICS_SUBDIR                "gfx_classic"
 #define DOOR_GFX_PAGEY2                (gfx.dysize)
 
 /* functions for version handling */
-#define VERSION_IDENT(x,y,z)   ((x) * 10000 + (y) * 100 + (z))
-#define VERSION_MAJOR(x)       ((x) / 10000)
-#define VERSION_MINOR(x)       (((x) % 10000) / 100)
-#define VERSION_PATCH(x)       ((x) % 100)
-
+#define VERSION_IDENT(x,y,z)   ((x) * 1000000 + (y) * 10000 + (z) * 100)
+#define RELEASE_IDENT(x,y,z,r) (VERSION_IDENT(x,y,z) + (r))
+#define VERSION_MAJOR(x)       ((x) / 1000000)
+#define VERSION_MINOR(x)       (((x) % 1000000) / 10000)
+#define VERSION_PATCH(x)       (((x) % 10000) / 100)
+#define VERSION_RELEASE(x)     ((x) % 100)
+
+/* functions for parent/child process identification */
+#if defined(PLATFORM_UNIX)
+#define IS_PARENT_PROCESS()    (audio.mixer_pid != getpid())
+#define IS_CHILD_PROCESS()     (audio.mixer_pid == getpid())
+#define HAS_CHILD_PROCESS()    (audio.mixer_pid > 0)
+#else
+#define IS_PARENT_PROCESS()    TRUE
+#define IS_CHILD_PROCESS()     FALSE
+#define HAS_CHILD_PROCESS()    FALSE
+#endif
 
 /* type definitions */
 typedef int (*EventFilter)(const Event *);
@@ -184,7 +290,7 @@ struct ProgramInfo
 
   char *x11_icon_filename;
   char *x11_iconmask_filename;
-  char *msdos_pointer_filename;
+  char *msdos_cursor_filename;
 
   char *cookie_prefix;
   char *filename_prefix;       /* prefix to cut off from DOS filenames */
@@ -201,12 +307,16 @@ struct OptionInfo
   char *display_name;
   char *server_host;
   int server_port;
+
   char *ro_base_directory;
   char *rw_base_directory;
   char *level_directory;
   char *graphics_directory;
   char *sounds_directory;
   char *music_directory;
+  char *docs_directory;
+  char *execute_command;
+
   boolean serveronly;
   boolean network;
   boolean verbose;
@@ -224,21 +334,34 @@ struct VideoSystemInfo
 struct AudioSystemInfo
 {
   boolean sound_available;
-  boolean music_available;
   boolean loops_available;
-  boolean mods_available;
-  boolean sound_enabled;
+  boolean music_available;
 
+  boolean sound_enabled;
   boolean sound_deactivated;   /* for temporarily disabling sound */
 
-  int soundserver_pipe[2];
-  int soundserver_pid;
+  int mixer_pipe[2];
+  int mixer_pid;
   char *device_name;
   int device_fd;
 
-  int channels;
+  int num_channels;
   int music_channel;
-  int music_nr;
+  int first_sound_channel;
+};
+
+struct FontBitmapInfo
+{
+  Bitmap *bitmap;
+  int src_x, src_y;            /* start position of animation frames */
+  int width, height;           /* width/height of each animation frame */
+  int draw_x, draw_y;          /* offset for drawing font characters */
+  int num_chars;
+  int num_chars_per_line;
+
+#if defined(TARGET_X11_NATIVE_PERFORMANCE_WORKAROUND)
+  Pixmap *clip_mask;           /* single-char-only clip mask array for X11 */
+#endif
 };
 
 struct GfxInfo
@@ -255,7 +378,19 @@ struct GfxInfo
   int vx, vy;
   int vxsize, vysize;
 
-  boolean draw_deactivation_mask;
+  int draw_deactivation_mask;
+  int draw_background_mask;
+
+  Bitmap *field_save_buffer;
+
+  Bitmap *background_bitmap;
+  int background_bitmap_mask;
+
+  int num_fonts;
+  struct FontBitmapInfo *font_bitmap_info;
+  int (*select_font_function)(int);
+
+  int anim_random_frame;
 };
 
 struct JoystickInfo
@@ -291,10 +426,30 @@ struct SetupInputInfo
   struct SetupKeyboardInfo key;
 };
 
+struct SetupEditorInfo
+{
+  boolean el_boulderdash;
+  boolean el_emerald_mine;
+  boolean el_more;
+  boolean el_sokoban;
+  boolean el_supaplex;
+  boolean el_diamond_caves;
+  boolean el_dx_boulderdash;
+  boolean el_chars;
+  boolean el_custom;
+};
+
 struct SetupShortcutInfo
 {
   Key save_game;
   Key load_game;
+  Key toggle_pause;
+};
+
+struct SetupSystemInfo
+{
+  char *sdl_audiodriver;
+  int audio_fragment_size;
 };
 
 struct SetupInfo
@@ -322,16 +477,26 @@ struct SetupInfo
   char *graphics_set;
   char *sounds_set;
   char *music_set;
+  boolean override_level_graphics;
+  boolean override_level_sounds;
+  boolean override_level_music;
 
+  struct SetupEditorInfo editor;
   struct SetupShortcutInfo shortcut;
   struct SetupInputInfo input[MAX_PLAYERS];
+  struct SetupSystemInfo system;
+  struct OptionInfo options;
 };
 
 #define TREE_TYPE_GENERIC              0
-#define TREE_TYPE_LEVEL_DIR            1
-#define TREE_TYPE_GRAPHICS_DIR         2
-#define TREE_TYPE_SOUNDS_DIR           3
-#define TREE_TYPE_MUSIC_DIR            4
+#define TREE_TYPE_GRAPHICS_DIR         1
+#define TREE_TYPE_SOUNDS_DIR           2
+#define TREE_TYPE_MUSIC_DIR            3
+#define TREE_TYPE_LEVEL_DIR            4
+
+#define ARTWORK_TYPE_GRAPHICS          TREE_TYPE_GRAPHICS_DIR
+#define ARTWORK_TYPE_SOUNDS            TREE_TYPE_SOUNDS_DIR
+#define ARTWORK_TYPE_MUSIC             TREE_TYPE_MUSIC_DIR
 
 struct TreeInfo
 {
@@ -347,22 +512,32 @@ struct TreeInfo
 
   /* fields for "type == TREE_TYPE_LEVEL_DIR" */
 
-  char *filename;      /* level series single directory name */
-  char *fullpath;      /* complete path relative to level directory */
-  char *basepath;      /* absolute base path of level directory */
-  char *name;          /* level series name, as displayed on main screen */
-  char *name_short;    /* optional short name for level selection screen */
-  char *name_sorting;  /* optional sorting name for correct level sorting */
-  char *author;                /* level series author name levels without author */
-  char *imported_from; /* optional comment for imported level series */
+  char *filename;      /* tree info sub-directory basename (may be ".") */
+  char *fullpath;      /* complete path relative to tree base directory */
+  char *basepath;      /* absolute base path of tree base directory */
+  char *identifier;    /* identifier string for configuration files */
+  char *name;          /* tree info name, as displayed in selection menues */
+  char *name_sorting;  /* optional sorting name for correct name sorting */
+  char *author;                /* level or artwork author name */
+  char *imported_from; /* optional comment for imported levels or artwork */
+
+  char *graphics_set;  /* optional custom graphics set (level tree only) */
+  char *sounds_set;    /* optional custom sounds set (level tree only) */
+  char *music_set;     /* optional custom music set (level tree only) */
+  char *graphics_path; /* path to optional custom graphics set (level only) */
+  char *sounds_path;   /* path to optional custom sounds set (level only) */
+  char *music_path;    /* path to optional custom music set (level only) */
+
   int levels;          /* number of levels in level series */
   int first_level;     /* first level number (to allow start with 0 or 1) */
   int last_level;      /* last level number (automatically calculated) */
   int sort_priority;   /* sort levels by 'sort_priority' and then by name */
+
   boolean level_group; /* directory contains more level series directories */
   boolean parent_link; /* entry links back to parent directory */
   boolean user_defined;        /* user defined levels are stored in home directory */
   boolean readonly;    /* readonly levels can not be changed with editor */
+
   int color;           /* color to use on selection screen for this level */
   char *class_desc;    /* description of level series class */
   int handicap_level;  /* number of the lowest unsolved level */
@@ -370,6 +545,7 @@ struct TreeInfo
 
 typedef struct TreeInfo TreeInfo;
 typedef struct TreeInfo LevelDirTree;
+typedef struct TreeInfo ArtworkDirTree;
 typedef struct TreeInfo GraphicsDirTree;
 typedef struct TreeInfo SoundsDirTree;
 typedef struct TreeInfo MusicDirTree;
@@ -383,9 +559,102 @@ struct ArtworkInfo
   MusicDirTree *mus_first;
   MusicDirTree *mus_current;
 
-  char *graphics_set_current;
-  char *sounds_set_current;
-  char *music_set_current;
+  char *gfx_current_identifier;
+  char *snd_current_identifier;
+  char *mus_current_identifier;
+};
+
+struct ValueTextInfo
+{
+  int value;
+  char *text;
+};
+
+struct ConfigInfo
+{
+  char *token;
+  char *value;
+  int type;
+};
+
+struct TokenIntPtrInfo
+{
+  char *token;
+  int *value;
+};
+
+struct FileInfo
+{
+  char *token;
+
+  char *default_filename;
+  char *filename;
+
+  char **default_parameter;                    /* array of file parameters */
+  char **parameter;                            /* array of file parameters */
+
+  boolean redefined;
+};
+
+struct SetupFileList
+{
+  char *token;
+  char *value;
+
+  struct SetupFileList *next;
+};
+
+struct ListNodeInfo
+{
+  char *source_filename;                       /* primary key for node list */
+  int num_references;
+};
+
+struct PropertyMapping
+{
+  int base_index;
+  int ext1_index;
+  int ext2_index;
+  int ext3_index;
+
+  int artwork_index;
+};
+
+struct ArtworkListInfo
+{
+  int type;                                    /* type of artwork */
+
+  int num_file_list_entries;
+  int num_dynamic_file_list_entries;
+  struct FileInfo *file_list;                  /* static artwork file array */
+  struct FileInfo *dynamic_file_list;          /* dynamic artwrk file array */
+
+  int num_suffix_list_entries;
+  struct ConfigInfo *suffix_list;              /* parameter suffixes array */
+
+  int num_base_prefixes;
+  int num_ext1_suffixes;
+  int num_ext2_suffixes;
+  int num_ext3_suffixes;
+  char **base_prefixes;                                /* base token prefixes array */
+  char **ext1_suffixes;                                /* property suffixes array 1 */
+  char **ext2_suffixes;                                /* property suffixes array 2 */
+  char **ext3_suffixes;                                /* property suffixes array 3 */
+
+  int num_ignore_tokens;
+  char **ignore_tokens;                                /* file tokens to be ignored */
+
+  int num_property_mapping_entries;
+  struct PropertyMapping *property_mapping;    /* mapping token -> artwork */
+
+  int sizeof_artwork_list_entry;
+
+  struct ListNodeInfo **artwork_list;          /* static artwork node array */
+  struct ListNodeInfo **dynamic_artwork_list;  /* dynamic artwrk node array */
+  struct ListNode *content_list;               /* dynamic artwork node list */
+
+  void *(*load_artwork)(char *);               /* constructor function */
+  void (*free_artwork)(void *);                        /* destructor function */
 };
 
 
@@ -398,6 +667,7 @@ extern struct OptionInfo    options;
 extern struct VideoSystemInfo  video;
 extern struct AudioSystemInfo  audio;
 extern struct GfxInfo          gfx;
+extern struct AnimInfo         anim;
 extern struct ArtworkInfo      artwork;
 extern struct JoystickInfo     joystick;
 extern struct SetupInfo                setup;
@@ -426,19 +696,21 @@ extern int                        FrameCounter;
 
 /* function definitions */
 
-void InitCommandName(char *);
-void InitExitFunction(void (*exit_function)(int));
-void InitPlatformDependantStuff(void);
-void ClosePlatformDependantStuff(void);
-
 void InitProgramInfo(char *, char *, char *, char *, char *, char *, char *,
-                    char *, char *, int);
+                    char *, char *, char *, int);
+
+void InitExitFunction(void (*exit_function)(int));
+void InitPlatformDependentStuff(void);
+void ClosePlatformDependentStuff(void);
 
-void InitGfxFieldInfo(int, int, int, int, int, int, int, int);
+void InitGfxFieldInfo(int, int, int, int, int, int, int, int, Bitmap *);
 void InitGfxDoor1Info(int, int, int, int);
 void InitGfxDoor2Info(int, int, int, int);
 void InitGfxScrollbufferInfo(int, int);
-void SetDrawDeactivationMask(int );
+void SetDrawDeactivationMask(int);
+void SetDrawBackgroundMask(int);
+void SetMainBackgroundBitmap(Bitmap *);
+void SetDoorBackgroundBitmap(Bitmap *);
 
 inline void InitVideoDisplay(void);
 inline void CloseVideoDisplay(void);
@@ -447,10 +719,15 @@ inline Bitmap *CreateBitmapStruct(void);
 inline Bitmap *CreateBitmap(int, int, int);
 inline void FreeBitmap(Bitmap *);
 inline void BlitBitmap(Bitmap *, Bitmap *, int, int, int, int, int, int);
+inline void FillRectangle(Bitmap *, int, int, int, int, Pixel);
 inline void ClearRectangle(Bitmap *, int, int, int, int);
+inline void ClearRectangleOnBackground(Bitmap *, int, int, int, int);
 inline void SetClipMask(Bitmap *, GC, Pixmap);
 inline void SetClipOrigin(Bitmap *, GC, int, int);
 inline void BlitBitmapMasked(Bitmap *, Bitmap *, int, int, int, int, int, int);
+inline boolean DrawingOnBackground(int, int);
+inline void BlitBitmapOnBackground(Bitmap *, Bitmap *, int, int, int, int, int,
+                                  int);
 inline void DrawSimpleWhiteLine(Bitmap *, int, int, int, int);
 inline void DrawLines(Bitmap *, struct XY *, int, Pixel);
 inline Pixel GetPixel(Bitmap *, int, int);
@@ -469,6 +746,11 @@ Bitmap *LoadImage(char *);
 Bitmap *LoadCustomImage(char *);
 void ReloadCustomImage(Bitmap *, char *);
 
+Bitmap *ZoomBitmap(Bitmap *, int, int);
+void CreateBitmapWithSmallBitmaps(Bitmap *);
+
+void SetMouseCursor(int);
+
 inline void OpenAudio(void);
 inline void CloseAudio(void);
 inline void SetAudioMode(boolean);
@@ -477,6 +759,8 @@ inline void InitEventFilter(EventFilter);
 inline boolean PendingEvent(void);
 inline void NextEvent(Event *event);
 inline Key GetEventKey(KeyEvent *, boolean);
+inline KeyMod HandleKeyModState(Key, int);
+inline KeyMod GetKeyModState();
 inline boolean CheckCloseWindowEvent(ClientMessageEvent *);
 
 inline void InitJoysticks();