rnd-20050202-1-src
[rocksndiamonds.git] / src / libgame / system.h
index 8126eb0490a6d2e18d33135569430dfec1defda6..c0fc43600c3cec35618f05c17ba64fae3c7eefee 100644 (file)
 #define DEFAULT_KEY_DOWN       KSYM_Down
 #if defined(PLATFORM_MACOSX)
 #define DEFAULT_KEY_SNAP       KSYM_Control_L
-#define DEFAULT_KEY_BOMB       KSYM_KP_Enter
+#define DEFAULT_KEY_DROP       KSYM_KP_Enter
 #else
-#define DEFAULT_KEY_SNAP       KSYM_Shift_L
-#define DEFAULT_KEY_BOMB       KSYM_Shift_R
+#define DEFAULT_KEY_SNAP       KSYM_Control_L
+#define DEFAULT_KEY_DROP       KSYM_Control_R
 #endif
 #define DEFAULT_KEY_OKAY       KSYM_Return
 #define DEFAULT_KEY_CANCEL     KSYM_Escape
 #define DEFAULT_KEY_LOAD_GAME  KSYM_F2
 #define DEFAULT_KEY_TOGGLE_PAUSE KSYM_space
 
+/* 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_NOT_RELEASED                TRUE
+#define MB_RELEASED            FALSE
+#define MB_PRESSED             TRUE
+#define MB_MENU_CHOICE         FALSE
+#define MB_MENU_MARK           TRUE
+#define MB_MENU_INITIALIZE     (-1)
+#define MB_MENU_LEAVE          (-2)
+#define MB_LEFTBUTTON          1
+#define MB_MIDDLEBUTTON                2
+#define MB_RIGHTBUTTON         3
+
 
-/* values for move directions and special "button" keys */
+/* values for move directions */
 #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 */
+#define BUTTON_1               4
+#define BUTTON_2               5
+
+/* values for move directions 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 << 4)
-#define KEY_BUTTON_2           (1 << 5)
+
+#define MV_HORIZONTAL          (MV_LEFT | MV_RIGHT)
+#define MV_VERTICAL            (MV_UP   | MV_DOWN)
+#define MV_ALL_DIRECTIONS      (MV_LEFT | MV_RIGHT | MV_UP | MV_DOWN)
+#define MV_ANY_DIRECTION       (MV_ALL_DIRECTIONS)
+
+#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)
                                 (x) == MV_RIGHT ? MV_BIT_RIGHT :       \
                                 (x) == MV_UP    ? MV_BIT_UP    : MV_BIT_DOWN)
 
-
-/* values for button status */
-#define MB_NOT_PRESSED         FALSE
-#define MB_NOT_RELEASED                TRUE
-#define MB_RELEASED            FALSE
-#define MB_PRESSED             TRUE
-#define MB_MENU_CHOICE         FALSE
-#define MB_MENU_MARK           TRUE
-#define MB_MENU_INITIALIZE     (-1)
-#define MB_MENU_LEAVE          (-2)
-#define MB_LEFTBUTTON          1
-#define MB_MIDDLEBUTTON                2
-#define MB_RIGHTBUTTON         3
+#define MV_DIR_OPPOSITE(x)     ((x) == MV_LEFT  ? MV_RIGHT :           \
+                                (x) == MV_RIGHT ? MV_LEFT  :           \
+                                (x) == MV_UP    ? MV_DOWN  :           \
+                                (x) == MV_DOWN  ? MV_UP    : MV_NO_MOVING)
 
 
 /* values for animation mode (frame order and direction) */
 #define ANIM_RANDOM            (1 << 4)
 #define ANIM_REVERSE           (1 << 5)
 
+/* values for special (non game element) animation modes */
+#define ANIM_HORIZONTAL                (1 << 6)
+#define ANIM_VERTICAL          (1 << 7)
+
+#define ANIM_DEFAULT           ANIM_LOOP
 
 /* values for redraw_mask */
 #define REDRAW_NONE            (0)
 #define REDRAW_FPS             (1 << 11)
 #define REDRAWTILES_THRESHOLD  (SCR_FIELDX * SCR_FIELDY / 2)
 
+#define IN_GFX_SCREEN(x, y)    (x >= gfx.sx && x < gfx.sx + gfx.sxsize && \
+                                y >= gfx.sy && y < gfx.sy + gfx.sysize)
+#define IN_GFX_DOOR(x, y)      (x >= gfx.dx && x < gfx.dx + gfx.dxsize && \
+                                y >= gfx.dy && y < gfx.dy + gfx.dysize)
+#define IN_GFX_VIDEO(x, y)     (x >= gfx.vx && x < gfx.vx + gfx.vxsize && \
+                                y >= gfx.vy && y < gfx.vy + gfx.vysize)
 
 /* values for mouse cursor */
 #define CURSOR_DEFAULT         0
 /* default name for unknown player names */
 #define ANONYMOUS_NAME         "anonymous"
 
+/* default for other unknown names */
+#define UNKNOWN_NAME           "unknown"
+
 /* default name for new levels */
 #define NAMELESS_LEVEL_NAME    "nameless level"
 
 #define RO_BASE_PATH           RO_GAME_DIR
 #define RW_BASE_PATH           RW_GAME_DIR
 
+/* directory names */
 #define GRAPHICS_DIRECTORY     "graphics"
 #define SOUNDS_DIRECTORY       "sounds"
 #define MUSIC_DIRECTORY                "music"
 #define LEVELS_DIRECTORY       "levels"
 #define TAPES_DIRECTORY                "tapes"
 #define SCORES_DIRECTORY       "scores"
+#define DOCS_DIRECTORY         "docs"
+
+#if !defined(PLATFORM_MSDOS)
+#define GFX_CLASSIC_SUBDIR     "gfx_classic"
+#define SND_CLASSIC_SUBDIR     "snd_classic"
+#define MUS_CLASSIC_SUBDIR     "mus_classic"
+#else
+#define GFX_CLASSIC_SUBDIR     "gfx_orig"
+#define SND_CLASSIC_SUBDIR     "snd_orig"
+#define MUS_CLASSIC_SUBDIR     "mus_orig"
+#endif
 
+/* file names and filename extensions */
 #if !defined(PLATFORM_MSDOS)
-#define GRAPHICS_SUBDIR                "gfx_classic"
-#define SOUNDS_SUBDIR          "snd_classic"
-#define MUSIC_SUBDIR           "mus_classic"
+#define LEVELSETUP_DIRECTORY   "levelsetup"
+#define SETUP_FILENAME         "setup.conf"
+#define LEVELSETUP_FILENAME    "levelsetup.conf"
+#define EDITORSETUP_FILENAME   "editorsetup.conf"
+#define HELPANIM_FILENAME      "helpanim.conf"
+#define HELPTEXT_FILENAME      "helptext.conf"
+#define LEVELINFO_FILENAME     "levelinfo.conf"
+#define GRAPHICSINFO_FILENAME  "graphicsinfo.conf"
+#define SOUNDSINFO_FILENAME    "soundsinfo.conf"
+#define MUSICINFO_FILENAME     "musicinfo.conf"
+#define LEVELFILE_EXTENSION    "level"
+#define TAPEFILE_EXTENSION     "tape"
+#define SCOREFILE_EXTENSION    "score"
 #else
-#define GRAPHICS_SUBDIR                "gfx_orig"
-#define SOUNDS_SUBDIR          "snd_orig"
-#define MUSIC_SUBDIR           "mus_orig"
+#define LEVELSETUP_DIRECTORY   "lvlsetup"
+#define SETUP_FILENAME         "setup.cnf"
+#define LEVELSETUP_FILENAME    "lvlsetup.cnf"
+#define EDITORSETUP_FILENAME   "edsetup.cnf"
+#define HELPANIM_FILENAME      "helpanim.cnf"
+#define HELPTEXT_FILENAME      "helptext.cnf"
+#define LEVELINFO_FILENAME     "lvlinfo.cnf"
+#define GRAPHICSINFO_FILENAME  "gfxinfo.cnf"
+#define SOUNDSINFO_FILENAME    "sndinfo.cnf"
+#define MUSICINFO_FILENAME     "musinfo.cnf"
+#define LEVELFILE_EXTENSION    "lvl"
+#define TAPEFILE_EXTENSION     "tap"
+#define SCOREFILE_EXTENSION    "sco"
 #endif
 
+
 /* areas in bitmap PIX_DOOR */
 /* meaning in PIX_DB_DOOR: (3 PAGEs)
    PAGEX1: 1. buffer for DOOR_1
    PAGEX3: buffer for animations
 */
 
-#define DOOR_GFX_PAGESIZE      (gfx.dxsize)
+/* these values are hard-coded to be able to use them in initialization */
+#define DOOR_GFX_PAGE_WIDTH    100     /* should be set to "gfx.dxsize" */
+#define DOOR_GFX_PAGE_HEIGHT   280     /* should be set to "gfx.dysize" */
+
+#define DOOR_GFX_PAGESIZE      (DOOR_GFX_PAGE_WIDTH)
 #define DOOR_GFX_PAGEX1                (0 * DOOR_GFX_PAGESIZE)
 #define DOOR_GFX_PAGEX2                (1 * DOOR_GFX_PAGESIZE)
 #define DOOR_GFX_PAGEX3                (2 * DOOR_GFX_PAGESIZE)
 #define DOOR_GFX_PAGEX7                (6 * DOOR_GFX_PAGESIZE)
 #define DOOR_GFX_PAGEX8                (7 * DOOR_GFX_PAGESIZE)
 #define DOOR_GFX_PAGEY1                (0)
-#define DOOR_GFX_PAGEY2                (gfx.dysize)
+#define DOOR_GFX_PAGEY2                (DOOR_GFX_PAGE_HEIGHT)
+
+
+/* macros for version handling */
+#define VERSION_MAJOR(x)       ((x) / 1000000)
+#define VERSION_MINOR(x)       (((x) % 1000000) / 10000)
+#define VERSION_PATCH(x)       (((x) % 10000) / 100)
+#define VERSION_BUILD(x)       ((x) % 100)
+#define VERSION_IDENT(a,b,c,d) ((a) * 1000000 + (b) * 10000 + (c) * 100 + (d))
 
-/* 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)
 
-/* functions for parent/child process identification */
+/* macros 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
 
+
+/* values for artwork type */
+#define ARTWORK_TYPE_GRAPHICS  0
+#define ARTWORK_TYPE_SOUNDS    1
+#define ARTWORK_TYPE_MUSIC     2
+
+#define NUM_ARTWORK_TYPES      3
+
+
+/* values for tree type (chosen to match artwork type) */
+#define TREE_TYPE_UNDEFINED    -1
+#define TREE_TYPE_GRAPHICS_DIR ARTWORK_TYPE_GRAPHICS
+#define TREE_TYPE_SOUNDS_DIR   ARTWORK_TYPE_SOUNDS
+#define TREE_TYPE_MUSIC_DIR    ARTWORK_TYPE_MUSIC
+#define TREE_TYPE_LEVEL_DIR    3
+
+#define NUM_TREE_TYPES         4
+
+
+/* values for artwork handling */
+#define LEVELDIR_ARTWORK_SET(leveldir, type)                           \
+                               ((type) == ARTWORK_TYPE_GRAPHICS ?      \
+                                (leveldir)->graphics_set :             \
+                                (type) == ARTWORK_TYPE_SOUNDS ?        \
+                                (leveldir)->sounds_set :               \
+                                (leveldir)->music_set)
+
+#define LEVELDIR_ARTWORK_PATH(leveldir, type)                          \
+                               ((type) == ARTWORK_TYPE_GRAPHICS ?      \
+                                (leveldir)->graphics_path :            \
+                                (type) == ARTWORK_TYPE_SOUNDS ?        \
+                                (leveldir)->sounds_path :              \
+                                (leveldir)->music_path)
+
+#define SETUP_ARTWORK_SET(setup, type)                                 \
+                               ((type) == ARTWORK_TYPE_GRAPHICS ?      \
+                                (setup).graphics_set :                 \
+                                (type) == ARTWORK_TYPE_SOUNDS ?        \
+                                (setup).sounds_set :                   \
+                                (setup).music_set)
+
+#define SETUP_OVERRIDE_ARTWORK(setup, type)                            \
+                               ((type) == ARTWORK_TYPE_GRAPHICS ?      \
+                                (setup).override_level_graphics :      \
+                                (type) == ARTWORK_TYPE_SOUNDS ?        \
+                                (setup).override_level_sounds :        \
+                                (setup).override_level_music)
+
+#define ARTWORK_FIRST_NODE(artwork, type)                              \
+                               ((type) == ARTWORK_TYPE_GRAPHICS ?      \
+                                (artwork).gfx_first :  \
+                                (type) == ARTWORK_TYPE_SOUNDS ?        \
+                                (artwork).snd_first :  \
+                                (artwork).mus_first)
+
+#define ARTWORK_CURRENT_IDENTIFIER(artwork, type)                      \
+                               ((type) == ARTWORK_TYPE_GRAPHICS ?      \
+                                (artwork).gfx_current_identifier :     \
+                                (type) == ARTWORK_TYPE_SOUNDS ?        \
+                                (artwork).snd_current_identifier :     \
+                                (artwork).mus_current_identifier)
+
+#define ARTWORKINFO_FILENAME(type)                                     \
+                               ((type) == ARTWORK_TYPE_GRAPHICS ?      \
+                                GRAPHICSINFO_FILENAME :                \
+                                (type) == ARTWORK_TYPE_SOUNDS ?        \
+                                SOUNDSINFO_FILENAME :                  \
+                                (type) == ARTWORK_TYPE_MUSIC ?         \
+                                MUSICINFO_FILENAME : "")
+
+#define ARTWORK_DIRECTORY(type)                                                \
+                               ((type) == ARTWORK_TYPE_GRAPHICS ?      \
+                                GRAPHICS_DIRECTORY :                   \
+                                (type) == ARTWORK_TYPE_SOUNDS ?        \
+                                SOUNDS_DIRECTORY :                     \
+                                (type) == ARTWORK_TYPE_MUSIC ?         \
+                                MUSIC_DIRECTORY : "")
+
+#define OPTIONS_ARTWORK_DIRECTORY(type)                                        \
+                               ((type) == ARTWORK_TYPE_GRAPHICS ?      \
+                                options.graphics_directory :           \
+                                (type) == ARTWORK_TYPE_SOUNDS ?        \
+                                options.sounds_directory :             \
+                                (type) == ARTWORK_TYPE_MUSIC ?         \
+                                options.music_directory : "")
+
+
 /* type definitions */
 typedef int (*EventFilter)(const Event *);
 
@@ -279,6 +444,7 @@ struct OptionInfo
   char *graphics_directory;
   char *sounds_directory;
   char *music_directory;
+  char *docs_directory;
   char *execute_command;
 
   boolean serveronly;
@@ -325,7 +491,6 @@ struct FontBitmapInfo
 
 #if defined(TARGET_X11_NATIVE_PERFORMANCE_WORKAROUND)
   Pixmap *clip_mask;           /* single-char-only clip mask array for X11 */
-  int last_num_chars;          /* to free last font clip masks */
 #endif
 };
 
@@ -370,18 +535,13 @@ struct SetupJoystickInfo
 
   int xleft, xmiddle, xright;
   int yupper, ymiddle, ylower;
-  int snap;
-  int bomb;
+  int snap, drop;
 };
 
 struct SetupKeyboardInfo
 {
-  Key left;
-  Key right;
-  Key up;
-  Key down;
-  Key snap;
-  Key bomb;
+  Key left, right, up, down;
+  Key snap, drop;
 };
 
 struct SetupInputInfo
@@ -395,6 +555,7 @@ struct SetupEditorInfo
 {
   boolean el_boulderdash;
   boolean el_emerald_mine;
+  boolean el_emerald_mine_club;
   boolean el_more;
   boolean el_sokoban;
   boolean el_supaplex;
@@ -402,6 +563,10 @@ struct SetupEditorInfo
   boolean el_dx_boulderdash;
   boolean el_chars;
   boolean el_custom;
+  boolean el_custom_more;
+  boolean el_user_defined;
+
+  boolean el_headlines;
 };
 
 struct SetupShortcutInfo
@@ -453,16 +618,6 @@ struct SetupInfo
   struct OptionInfo options;
 };
 
-#define TREE_TYPE_GENERIC              0
-#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
 {
   struct TreeInfo **node_top;          /* topmost node in tree */
@@ -477,7 +632,7 @@ struct TreeInfo
 
   /* fields for "type == TREE_TYPE_LEVEL_DIR" */
 
-  char *filename;      /* tree info sub-directory basename (may be ".") */
+  char *subdir;                /* 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 */
@@ -485,6 +640,7 @@ struct TreeInfo
   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 *imported_by;   /* 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) */
@@ -493,15 +649,21 @@ struct TreeInfo
   char *sounds_path;   /* path to optional custom sounds set (level only) */
   char *music_path;    /* path to optional custom music set (level only) */
 
+  char *level_filename;        /* filename of level file (for packed level file) */
+  char *level_filetype;        /* type of levels in level directory or level file */
+
   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 latest_engine;/* force level set to use the latest game engine */
+
   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 */
+  boolean handicap;    /* level set has no handicap when set to "false" */
 
   int color;           /* color to use on selection screen for this level */
   char *class_desc;    /* description of level series class */
@@ -536,12 +698,24 @@ struct ValueTextInfo
 };
 
 struct ConfigInfo
+{
+  char *token;
+  char *value;
+};
+
+struct ConfigTypeInfo
 {
   char *token;
   char *value;
   int type;
 };
 
+struct TokenIntPtrInfo
+{
+  char *token;
+  int *value;
+};
+
 struct FileInfo
 {
   char *token;
@@ -589,7 +763,7 @@ struct ArtworkListInfo
   struct FileInfo *dynamic_file_list;          /* dynamic artwrk file array */
 
   int num_suffix_list_entries;
-  struct ConfigInfo *suffix_list;              /* parameter suffixes array */
+  struct ConfigTypeInfo *suffix_list;          /* parameter suffixes array */
 
   int num_base_prefixes;
   int num_ext1_suffixes;
@@ -659,8 +833,8 @@ void InitProgramInfo(char *, char *, char *, char *, char *, char *, char *,
                     char *, char *, char *, int);
 
 void InitExitFunction(void (*exit_function)(int));
-void InitPlatformDependantStuff(void);
-void ClosePlatformDependantStuff(void);
+void InitPlatformDependentStuff(void);
+void ClosePlatformDependentStuff(void);
 
 void InitGfxFieldInfo(int, int, int, int, int, int, int, int, Bitmap *);
 void InitGfxDoor1Info(int, int, int, int);
@@ -706,7 +880,7 @@ Bitmap *LoadCustomImage(char *);
 void ReloadCustomImage(Bitmap *, char *);
 
 Bitmap *ZoomBitmap(Bitmap *, int, int);
-void CreateBitmapWithSmallBitmaps(Bitmap *);
+void CreateBitmapWithSmallBitmaps(Bitmap *, int);
 
 void SetMouseCursor(int);
 
@@ -718,6 +892,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();