src/libgame/system.h

   1 /***********************************************************
   2 * Artsoft Retro-Game Library                               *
   3 *----------------------------------------------------------*
   4 * (c) 1994-2001 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
  31 /* the additional 'b' is needed for Win32 to open files in binary mode */
  32 #define MODE_READ               "rb"
  33 #define MODE_WRITE              "wb"
  34 #define MODE_APPEND             "ab"
  35
  36 #define DEFAULT_DEPTH           0
  37
  38 #define FULLSCREEN_NOT_AVAILABLE FALSE
  39 #define FULLSCREEN_AVAILABLE     TRUE
  40
  41 /* default input keys */
  42 #define DEFAULT_KEY_LEFT        KSYM_Left
  43 #define DEFAULT_KEY_RIGHT       KSYM_Right
  44 #define DEFAULT_KEY_UP          KSYM_Up
  45 #define DEFAULT_KEY_DOWN        KSYM_Down
  46 #define DEFAULT_KEY_SNAP        KSYM_Shift_L
  47 #define DEFAULT_KEY_BOMB        KSYM_Shift_R
  48 #define DEFAULT_KEY_OKAY        KSYM_Return
  49 #define DEFAULT_KEY_CANCEL      KSYM_Escape
  50
  51 /* values for move directions */
  52 #define MV_NO_MOVING            0
  53 #define MV_LEFT                 (1 << 0)
  54 #define MV_RIGHT                (1 << 1)
  55 #define MV_UP                   (1 << 2)
  56 #define MV_DOWN                 (1 << 3)
  57
  58 /* values for button status */
  59 #define MB_NOT_PRESSED          FALSE
  60 #define MB_NOT_RELEASED         TRUE
  61 #define MB_RELEASED             FALSE
  62 #define MB_PRESSED              TRUE
  63 #define MB_MENU_CHOICE          FALSE
  64 #define MB_MENU_MARK            TRUE
  65 #define MB_MENU_INITIALIZE      (-1)
  66 #define MB_MENU_LEAVE           (-2)
  67 #define MB_LEFTBUTTON           1
  68 #define MB_MIDDLEBUTTON         2
  69 #define MB_RIGHTBUTTON          3
  70
  71 /* values for redraw_mask */
  72 #define REDRAW_NONE             (0)
  73 #define REDRAW_ALL              (1 << 0)
  74 #define REDRAW_FIELD            (1 << 1)
  75 #define REDRAW_TILES            (1 << 2)
  76 #define REDRAW_DOOR_1           (1 << 3)
  77 #define REDRAW_VIDEO_1          (1 << 4)
  78 #define REDRAW_VIDEO_2          (1 << 5)
  79 #define REDRAW_VIDEO_3          (1 << 6)
  80 #define REDRAW_MICROLEVEL       (1 << 7)
  81 #define REDRAW_MICROLABEL       (1 << 8)
  82 #define REDRAW_FROM_BACKBUFFER  (1 << 9)
  83 #define REDRAW_DOOR_2           (REDRAW_VIDEO_1 | \
  84                                  REDRAW_VIDEO_2 | \
  85                                  REDRAW_VIDEO_3)
  86 #define REDRAW_DOOR_3           (1 << 10)
  87 #define REDRAW_DOORS            (REDRAW_DOOR_1 | \
  88                                  REDRAW_DOOR_2 | \
  89                                  REDRAW_DOOR_3)
  90 #define REDRAW_MAIN             (REDRAW_FIELD | \
  91                                  REDRAW_TILES | \
  92                                  REDRAW_MICROLEVEL)
  93 #define REDRAW_FPS              (1 << 11)
  94 #define REDRAWTILES_THRESHOLD   (SCR_FIELDX * SCR_FIELDY / 2)
  95
  96 /* maximum number of parallel players supported by libgame functions */
  97 #define MAX_PLAYERS             4
  98
  99 /* maximum allowed length of player name */
 100 #define MAX_PLAYER_NAME_LEN     10
 101
 102 /* default name for empty highscore entry */
 103 #define EMPTY_PLAYER_NAME       "no name"
 104
 105 /* default name for unknown player names */
 106 #define ANONYMOUS_NAME          "anonymous"
 107
 108 /* default name for new levels */
 109 #define NAMELESS_LEVEL_NAME     "nameless level"
 110
 111 /* definitions for game sub-directories */
 112 #ifndef RO_GAME_DIR
 113 #define RO_GAME_DIR             "."
 114 #endif
 115
 116 #ifndef RW_GAME_DIR
 117 #define RW_GAME_DIR             "."
 118 #endif
 119
 120 #define RO_BASE_PATH            RO_GAME_DIR
 121 #define RW_BASE_PATH            RW_GAME_DIR
 122
 123 #define GRAPHICS_DIRECTORY      "graphics"
 124 #define MUSIC_DIRECTORY         "music"
 125 #define SOUNDS_DIRECTORY        "sounds"
 126 #define LEVELS_DIRECTORY        "levels"
 127 #define TAPES_DIRECTORY         "tapes"
 128 #define SCORES_DIRECTORY        "scores"
 129
 130 /* areas in bitmap PIX_DOOR */
 131 /* meaning in PIX_DB_DOOR: (3 PAGEs)
 132    PAGEX1: 1. buffer for DOOR_1
 133    PAGEX2: 2. buffer for DOOR_1
 134    PAGEX3: buffer for animations
 135 */
 136
 137 #define DOOR_GFX_PAGESIZE       (gfx.dxsize)
 138 #define DOOR_GFX_PAGEX1         (0 * DOOR_GFX_PAGESIZE)
 139 #define DOOR_GFX_PAGEX2         (1 * DOOR_GFX_PAGESIZE)
 140 #define DOOR_GFX_PAGEX3         (2 * DOOR_GFX_PAGESIZE)
 141 #define DOOR_GFX_PAGEX4         (3 * DOOR_GFX_PAGESIZE)
 142 #define DOOR_GFX_PAGEX5         (4 * DOOR_GFX_PAGESIZE)
 143 #define DOOR_GFX_PAGEX6         (5 * DOOR_GFX_PAGESIZE)
 144 #define DOOR_GFX_PAGEX7         (6 * DOOR_GFX_PAGESIZE)
 145 #define DOOR_GFX_PAGEX8         (7 * DOOR_GFX_PAGESIZE)
 146 #define DOOR_GFX_PAGEY1         (0)
 147 #define DOOR_GFX_PAGEY2         (gfx.dysize)
 148
 149 /* functions for version handling */
 150 #define VERSION_IDENT(x,y,z)    ((x) * 10000 + (y) * 100 + (z))
 151 #define VERSION_MAJOR(x)        ((x) / 10000)
 152 #define VERSION_MINOR(x)        (((x) % 10000) / 100)
 153 #define VERSION_PATCH(x)        ((x) % 100)
 154
 155
 156 /* type definitions */
 157 typedef int (*EventFilter)(const Event *);
 158
 159
 160 /* structure definitions */
 161
 162 struct ProgramInfo
 163 {
 164   char *command_basename;
 165   char *userdata_directory;
 166
 167   char *program_title;
 168   char *window_title;
 169   char *icon_title;
 170
 171   char *x11_icon_filename;
 172   char *x11_iconmask_filename;
 173   char *msdos_pointer_filename;
 174
 175   char *cookie_prefix;
 176   char *filename_prefix;        /* prefix to cut off from DOS filenames */
 177
 178   int version_major;
 179   int version_minor;
 180   int version_patch;
 181
 182   void (*exit_function)(int);
 183 };
 184
 185 struct OptionInfo
 186 {
 187   char *display_name;
 188   char *server_host;
 189   int server_port;
 190   char *ro_base_directory;
 191   char *rw_base_directory;
 192   char *level_directory;
 193   char *graphics_directory;
 194   char *sounds_directory;
 195   char *music_directory;
 196   boolean serveronly;
 197   boolean network;
 198   boolean verbose;
 199   boolean debug;
 200 };
 201
 202 struct VideoSystemInfo
 203 {
 204   int default_depth;
 205   int width, height, depth;
 206   boolean fullscreen_available;
 207   boolean fullscreen_enabled;
 208 };
 209
 210 struct AudioSystemInfo
 211 {
 212   boolean sound_available;
 213   boolean music_available;
 214   boolean loops_available;
 215   boolean mods_available;
 216   boolean sound_enabled;
 217
 218   int soundserver_pipe[2];
 219   int soundserver_pid;
 220   char *device_name;
 221   int device_fd;
 222
 223   int channels;
 224   int music_channel;
 225   int music_nr;
 226 };
 227
 228 struct GfxInfo
 229 {
 230   int sx, sy;
 231   int sxsize, sysize;
 232   int real_sx, real_sy;
 233   int full_sxsize, full_sysize;
 234   int scrollbuffer_width, scrollbuffer_height;
 235
 236   int dx, dy;
 237   int dxsize, dysize;
 238
 239   int vx, vy;
 240   int vxsize, vysize;
 241
 242   boolean draw_deactivation_mask;
 243 };
 244
 245 struct ArtworkInfo
 246 {
 247   char *custom_artwork;
 248   char *custom_graphics;
 249   char *custom_sounds;
 250   char *custom_music;
 251 };
 252
 253 struct JoystickInfo
 254 {
 255   int status;
 256   int fd[MAX_PLAYERS];          /* file descriptor of player's joystick */
 257 };
 258
 259 struct SetupJoystickInfo
 260 {
 261   char *device_name;            /* device name of player's joystick */
 262
 263   int xleft, xmiddle, xright;
 264   int yupper, ymiddle, ylower;
 265   int snap;
 266   int bomb;
 267 };
 268
 269 struct SetupKeyboardInfo
 270 {
 271   Key left;
 272   Key right;
 273   Key up;
 274   Key down;
 275   Key snap;
 276   Key bomb;
 277 };
 278
 279 struct SetupInputInfo
 280 {
 281   boolean use_joystick;
 282   struct SetupJoystickInfo joy;
 283   struct SetupKeyboardInfo key;
 284 };
 285
 286 struct SetupInfo
 287 {
 288   char *player_name;
 289
 290   boolean sound;
 291   boolean sound_loops;
 292   boolean sound_music;
 293   boolean sound_simple;
 294   boolean toons;
 295   boolean double_buffering;
 296   boolean direct_draw;          /* !double_buffering (redundant!) */
 297   boolean scroll_delay;
 298   boolean soft_scrolling;
 299   boolean fading;
 300   boolean autorecord;
 301   boolean quick_doors;
 302   boolean team_mode;
 303   boolean handicap;
 304   boolean time_limit;
 305   boolean fullscreen;
 306
 307   struct SetupInputInfo input[MAX_PLAYERS];
 308 };
 309
 310 struct LevelDirInfo
 311 {
 312   char *filename;       /* level series single directory name */
 313   char *fullpath;       /* complete path relative to level directory */
 314   char *basepath;       /* absolute base path of level directory */
 315   char *name;           /* level series name, as displayed on main screen */
 316   char *name_short;     /* optional short name for level selection screen */
 317   char *name_sorting;   /* optional sorting name for correct level sorting */
 318   char *author;         /* level series author name levels without author */
 319   char *imported_from;  /* optional comment for imported level series */
 320   int levels;           /* number of levels in level series */
 321   int first_level;      /* first level number (to allow start with 0 or 1) */
 322   int last_level;       /* last level number (automatically calculated) */
 323   int sort_priority;    /* sort levels by 'sort_priority' and then by name */
 324   boolean level_group;  /* directory contains more level series directories */
 325   boolean parent_link;  /* entry links back to parent directory */
 326   boolean user_defined; /* user defined levels are stored in home directory */
 327   boolean readonly;     /* readonly levels can not be changed with editor */
 328   int color;            /* color to use on selection screen for this level */
 329   char *class_desc;     /* description of level series class */
 330   int handicap_level;   /* number of the lowest unsolved level */
 331   int cl_first;         /* internal control field for "choose level" screen */
 332   int cl_cursor;        /* internal control field for "choose level" screen */
 333
 334   struct LevelDirInfo *node_parent;     /* parent level directory info */
 335   struct LevelDirInfo *node_group;      /* level group sub-directory info */
 336   struct LevelDirInfo *next;            /* next level series structure node */
 337 };
 338
 339
 340 /* ========================================================================= */
 341 /* exported variables                                                        */
 342 /* ========================================================================= */
 343
 344 extern struct ProgramInfo       program;
 345 extern struct OptionInfo        options;
 346 extern struct VideoSystemInfo   video;
 347 extern struct AudioSystemInfo   audio;
 348 extern struct GfxInfo           gfx;
 349 extern struct ArtworkInfo       artwork;
 350 extern struct JoystickInfo      joystick;
 351 extern struct SetupInfo         setup;
 352
 353 extern struct LevelDirInfo     *leveldir_first;
 354 extern struct LevelDirInfo     *leveldir_current;
 355 extern int                      level_nr;
 356
 357 extern Display                 *display;
 358 extern Visual                  *visual;
 359 extern int                      screen;
 360 extern Colormap                 cmap;
 361
 362 extern DrawWindow              *window;
 363 extern DrawBuffer              *backbuffer;
 364 extern DrawBuffer              *drawto;
 365
 366 extern int                      button_status;
 367 extern boolean                  motion_status;
 368
 369 extern int                      redraw_mask;
 370 extern int                      redraw_tiles;
 371
 372 extern int                      FrameCounter;
 373
 374
 375 /* function definitions */
 376
 377 void InitCommandName(char *);
 378 void InitExitFunction(void (*exit_function)(int));
 379 void InitPlatformDependantStuff(void);
 380 void ClosePlatformDependantStuff(void);
 381
 382 void InitProgramInfo(char *, char *, char *, char *, char *, char *, char *,
 383                      char *, char *, int);
 384
 385 void InitGfxFieldInfo(int, int, int, int, int, int, int, int);
 386 void InitGfxDoor1Info(int, int, int, int);
 387 void InitGfxDoor2Info(int, int, int, int);
 388 void InitGfxScrollbufferInfo(int, int);
 389 void SetDrawDeactivationMask(int );
 390
 391 inline void InitVideoDisplay(void);
 392 inline void CloseVideoDisplay(void);
 393 inline void InitVideoBuffer(DrawBuffer **,DrawWindow **, int,int,int, boolean);
 394 inline Bitmap *CreateBitmapStruct(void);
 395 inline Bitmap *CreateBitmap(int, int, int);
 396 inline void FreeBitmap(Bitmap *);
 397 inline void BlitBitmap(Bitmap *, Bitmap *, int, int, int, int, int, int);
 398 inline void ClearRectangle(Bitmap *, int, int, int, int);
 399 inline void SetClipMask(Bitmap *, GC, Pixmap);
 400 inline void SetClipOrigin(Bitmap *, GC, int, int);
 401 inline void BlitBitmapMasked(Bitmap *, Bitmap *, int, int, int, int, int, int);
 402 inline void DrawSimpleWhiteLine(Bitmap *, int, int, int, int);
 403 inline void DrawLines(Bitmap *, struct XY *, int, Pixel);
 404 inline Pixel GetPixel(Bitmap *, int, int);
 405 inline Pixel GetPixelFromRGB(Bitmap *, unsigned int,unsigned int,unsigned int);
 406 inline Pixel GetPixelFromRGBcompact(Bitmap *, unsigned int);
 407
 408 inline void FlushDisplay(void);
 409 inline void SyncDisplay(void);
 410 inline void KeyboardAutoRepeatOn(void);
 411 inline void KeyboardAutoRepeatOff(void);
 412 inline boolean PointerInWindow(DrawWindow *);
 413 inline boolean SetVideoMode(boolean);
 414 inline boolean ChangeVideoModeIfNeeded(boolean);
 415
 416 Bitmap *LoadImage(char *);
 417 Bitmap *LoadCustomImage(char *);
 418
 419 inline void OpenAudio(void);
 420 inline void CloseAudio(void);
 421 inline void SetAudioMode(boolean);
 422
 423 inline void InitEventFilter(EventFilter);
 424 inline boolean PendingEvent(void);
 425 inline void NextEvent(Event *event);
 426 inline Key GetEventKey(KeyEvent *, boolean);
 427 inline boolean CheckCloseWindowEvent(ClientMessageEvent *);
 428
 429 inline void InitJoysticks();
 430 inline boolean ReadJoystick(int, int *, int *, boolean *, boolean *);
 431
 432 #endif /* SYSTEM_H */