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 /* default shortcut keys */
  52 #define DEFAULT_KEY_SAVE_GAME   KSYM_F1
  53 #define DEFAULT_KEY_LOAD_GAME   KSYM_F2
  54 #define DEFAULT_KEY_TOGGLE_PAUSE KSYM_space
  55
  56 /* values for move directions and special "button" keys */
  57 #define MV_NO_MOVING            0
  58 #define MV_LEFT                 (1 << 0)
  59 #define MV_RIGHT                (1 << 1)
  60 #define MV_UP                   (1 << 2)
  61 #define MV_DOWN                 (1 << 3)
  62 #define KEY_BUTTON_1            (1 << 4)
  63 #define KEY_BUTTON_2            (1 << 5)
  64 #define KEY_MOTION              (MV_LEFT | MV_RIGHT | MV_UP | MV_DOWN)
  65 #define KEY_BUTTON              (KEY_BUTTON_1 | KEY_BUTTON_2)
  66 #define KEY_ACTION              (KEY_MOTION | KEY_BUTTON)
  67
  68 /* values for button status */
  69 #define MB_NOT_PRESSED          FALSE
  70 #define MB_NOT_RELEASED         TRUE
  71 #define MB_RELEASED             FALSE
  72 #define MB_PRESSED              TRUE
  73 #define MB_MENU_CHOICE          FALSE
  74 #define MB_MENU_MARK            TRUE
  75 #define MB_MENU_INITIALIZE      (-1)
  76 #define MB_MENU_LEAVE           (-2)
  77 #define MB_LEFTBUTTON           1
  78 #define MB_MIDDLEBUTTON         2
  79 #define MB_RIGHTBUTTON          3
  80
  81 /* values for redraw_mask */
  82 #define REDRAW_NONE             (0)
  83 #define REDRAW_ALL              (1 << 0)
  84 #define REDRAW_FIELD            (1 << 1)
  85 #define REDRAW_TILES            (1 << 2)
  86 #define REDRAW_DOOR_1           (1 << 3)
  87 #define REDRAW_VIDEO_1          (1 << 4)
  88 #define REDRAW_VIDEO_2          (1 << 5)
  89 #define REDRAW_VIDEO_3          (1 << 6)
  90 #define REDRAW_MICROLEVEL       (1 << 7)
  91 #define REDRAW_MICROLABEL       (1 << 8)
  92 #define REDRAW_FROM_BACKBUFFER  (1 << 9)
  93 #define REDRAW_DOOR_2           (REDRAW_VIDEO_1 | \
  94                                  REDRAW_VIDEO_2 | \
  95                                  REDRAW_VIDEO_3)
  96 #define REDRAW_DOOR_3           (1 << 10)
  97 #define REDRAW_DOORS            (REDRAW_DOOR_1 | \
  98                                  REDRAW_DOOR_2 | \
  99                                  REDRAW_DOOR_3)
 100 #define REDRAW_MAIN             (REDRAW_FIELD | \
 101                                  REDRAW_TILES | \
 102                                  REDRAW_MICROLEVEL)
 103 #define REDRAW_FPS              (1 << 11)
 104 #define REDRAWTILES_THRESHOLD   (SCR_FIELDX * SCR_FIELDY / 2)
 105
 106 /* maximum number of parallel players supported by libgame functions */
 107 #define MAX_PLAYERS             4
 108
 109 /* maximum allowed length of player name */
 110 #define MAX_PLAYER_NAME_LEN     10
 111
 112 /* default name for empty highscore entry */
 113 #define EMPTY_PLAYER_NAME       "no name"
 114
 115 /* default name for unknown player names */
 116 #define ANONYMOUS_NAME          "anonymous"
 117
 118 /* default name for new levels */
 119 #define NAMELESS_LEVEL_NAME     "nameless level"
 120
 121 /* definitions for game sub-directories */
 122 #ifndef RO_GAME_DIR
 123 #define RO_GAME_DIR             "."
 124 #endif
 125
 126 #ifndef RW_GAME_DIR
 127 #define RW_GAME_DIR             "."
 128 #endif
 129
 130 #define RO_BASE_PATH            RO_GAME_DIR
 131 #define RW_BASE_PATH            RW_GAME_DIR
 132
 133 #define GRAPHICS_DIRECTORY      "graphics"
 134 #define SOUNDS_DIRECTORY        "sounds"
 135 #define MUSIC_DIRECTORY         "music"
 136 #define LEVELS_DIRECTORY        "levels"
 137 #define TAPES_DIRECTORY         "tapes"
 138 #define SCORES_DIRECTORY        "scores"
 139
 140 #if !defined(PLATFORM_MSDOS)
 141 #define GRAPHICS_SUBDIR         "gfx_classic"
 142 #define SOUNDS_SUBDIR           "snd_classic"
 143 #define MUSIC_SUBDIR            "mus_classic"
 144 #else
 145 #define GRAPHICS_SUBDIR         "gfx_orig"
 146 #define SOUNDS_SUBDIR           "snd_orig"
 147 #define MUSIC_SUBDIR            "mus_orig"
 148 #endif
 149
 150 /* areas in bitmap PIX_DOOR */
 151 /* meaning in PIX_DB_DOOR: (3 PAGEs)
 152    PAGEX1: 1. buffer for DOOR_1
 153    PAGEX2: 2. buffer for DOOR_1
 154    PAGEX3: buffer for animations
 155 */
 156
 157 #define DOOR_GFX_PAGESIZE       (gfx.dxsize)
 158 #define DOOR_GFX_PAGEX1         (0 * DOOR_GFX_PAGESIZE)
 159 #define DOOR_GFX_PAGEX2         (1 * DOOR_GFX_PAGESIZE)
 160 #define DOOR_GFX_PAGEX3         (2 * DOOR_GFX_PAGESIZE)
 161 #define DOOR_GFX_PAGEX4         (3 * DOOR_GFX_PAGESIZE)
 162 #define DOOR_GFX_PAGEX5         (4 * DOOR_GFX_PAGESIZE)
 163 #define DOOR_GFX_PAGEX6         (5 * DOOR_GFX_PAGESIZE)
 164 #define DOOR_GFX_PAGEX7         (6 * DOOR_GFX_PAGESIZE)
 165 #define DOOR_GFX_PAGEX8         (7 * DOOR_GFX_PAGESIZE)
 166 #define DOOR_GFX_PAGEY1         (0)
 167 #define DOOR_GFX_PAGEY2         (gfx.dysize)
 168
 169 /* functions for version handling */
 170 #define VERSION_IDENT(x,y,z)    ((x) * 10000 + (y) * 100 + (z))
 171 #define VERSION_MAJOR(x)        ((x) / 10000)
 172 #define VERSION_MINOR(x)        (((x) % 10000) / 100)
 173 #define VERSION_PATCH(x)        ((x) % 100)
 174
 175 /* functions for parent/child process identification */
 176 #define IS_PARENT_PROCESS(pid)  ((pid) > 0)
 177 #define IS_CHILD_PROCESS(pid)   ((pid) == 0)
 178
 179
 180 /* type definitions */
 181 typedef int (*EventFilter)(const Event *);
 182
 183
 184 /* structure definitions */
 185
 186 struct ProgramInfo
 187 {
 188   char *command_basename;
 189   char *userdata_directory;
 190
 191   char *program_title;
 192   char *window_title;
 193   char *icon_title;
 194
 195   char *x11_icon_filename;
 196   char *x11_iconmask_filename;
 197   char *msdos_pointer_filename;
 198
 199   char *cookie_prefix;
 200   char *filename_prefix;        /* prefix to cut off from DOS filenames */
 201
 202   int version_major;
 203   int version_minor;
 204   int version_patch;
 205
 206   void (*exit_function)(int);
 207 };
 208
 209 struct OptionInfo
 210 {
 211   char *display_name;
 212   char *server_host;
 213   int server_port;
 214   char *ro_base_directory;
 215   char *rw_base_directory;
 216   char *level_directory;
 217   char *graphics_directory;
 218   char *sounds_directory;
 219   char *music_directory;
 220   boolean serveronly;
 221   boolean network;
 222   boolean verbose;
 223   boolean debug;
 224   char *debug_command;
 225 };
 226
 227 struct VideoSystemInfo
 228 {
 229   int default_depth;
 230   int width, height, depth;
 231   boolean fullscreen_available;
 232   boolean fullscreen_enabled;
 233 };
 234
 235 struct AudioSystemInfo
 236 {
 237   boolean sound_available;
 238   boolean loops_available;
 239   boolean music_available;
 240
 241   boolean sound_enabled;
 242   boolean sound_deactivated;    /* for temporarily disabling sound */
 243
 244   int mixer_pipe[2];
 245   int mixer_pid;
 246   char *device_name;
 247   int device_fd;
 248
 249   int num_channels;
 250   int music_channel;
 251   int first_sound_channel;
 252 };
 253
 254 struct GfxInfo
 255 {
 256   int sx, sy;
 257   int sxsize, sysize;
 258   int real_sx, real_sy;
 259   int full_sxsize, full_sysize;
 260   int scrollbuffer_width, scrollbuffer_height;
 261
 262   int dx, dy;
 263   int dxsize, dysize;
 264
 265   int vx, vy;
 266   int vxsize, vysize;
 267
 268   boolean draw_deactivation_mask;
 269 };
 270
 271 struct JoystickInfo
 272 {
 273   int status;
 274   int fd[MAX_PLAYERS];          /* file descriptor of player's joystick */
 275 };
 276
 277 struct SetupJoystickInfo
 278 {
 279   char *device_name;            /* device name of player's joystick */
 280
 281   int xleft, xmiddle, xright;
 282   int yupper, ymiddle, ylower;
 283   int snap;
 284   int bomb;
 285 };
 286
 287 struct SetupKeyboardInfo
 288 {
 289   Key left;
 290   Key right;
 291   Key up;
 292   Key down;
 293   Key snap;
 294   Key bomb;
 295 };
 296
 297 struct SetupInputInfo
 298 {
 299   boolean use_joystick;
 300   struct SetupJoystickInfo joy;
 301   struct SetupKeyboardInfo key;
 302 };
 303
 304 struct SetupShortcutInfo
 305 {
 306   Key save_game;
 307   Key load_game;
 308   Key toggle_pause;
 309 };
 310
 311 struct SetupInfo
 312 {
 313   char *player_name;
 314
 315   boolean sound;
 316   boolean sound_loops;
 317   boolean sound_music;
 318   boolean sound_simple;
 319   boolean toons;
 320   boolean double_buffering;
 321   boolean direct_draw;          /* !double_buffering (redundant!) */
 322   boolean scroll_delay;
 323   boolean soft_scrolling;
 324   boolean fading;
 325   boolean autorecord;
 326   boolean quick_doors;
 327   boolean team_mode;
 328   boolean handicap;
 329   boolean time_limit;
 330   boolean fullscreen;
 331   boolean ask_on_escape;
 332
 333   char *graphics_set;
 334   char *sounds_set;
 335   char *music_set;
 336   boolean override_level_graphics;
 337   boolean override_level_sounds;
 338   boolean override_level_music;
 339
 340   struct SetupShortcutInfo shortcut;
 341   struct SetupInputInfo input[MAX_PLAYERS];
 342 };
 343
 344 #define TREE_TYPE_GENERIC               0
 345 #define TREE_TYPE_LEVEL_DIR             1
 346 #define TREE_TYPE_GRAPHICS_DIR          2
 347 #define TREE_TYPE_SOUNDS_DIR            3
 348 #define TREE_TYPE_MUSIC_DIR             4
 349
 350 struct TreeInfo
 351 {
 352   struct TreeInfo **node_top;           /* topmost node in tree */
 353   struct TreeInfo *node_parent;         /* parent level directory info */
 354   struct TreeInfo *node_group;          /* level group sub-directory info */
 355   struct TreeInfo *next;                /* next level series structure node */
 356
 357   int cl_first;         /* internal control field for setup screen */
 358   int cl_cursor;        /* internal control field for setup screen */
 359
 360   int type;             /* type of tree content */
 361
 362   /* fields for "type == TREE_TYPE_LEVEL_DIR" */
 363
 364   char *filename;       /* level series single directory name */
 365   char *fullpath;       /* complete path relative to level directory */
 366   char *basepath;       /* absolute base path of level directory */
 367   char *name;           /* level series name, as displayed on main screen */
 368   char *name_short;     /* optional short name for level selection screen */
 369   char *name_sorting;   /* optional sorting name for correct level sorting */
 370   char *author;         /* level series author name levels without author */
 371   char *imported_from;  /* optional comment for imported level series */
 372   int levels;           /* number of levels in level series */
 373   int first_level;      /* first level number (to allow start with 0 or 1) */
 374   int last_level;       /* last level number (automatically calculated) */
 375   int sort_priority;    /* sort levels by 'sort_priority' and then by name */
 376   boolean level_group;  /* directory contains more level series directories */
 377   boolean parent_link;  /* entry links back to parent directory */
 378   boolean user_defined; /* user defined levels are stored in home directory */
 379   boolean readonly;     /* readonly levels can not be changed with editor */
 380   int color;            /* color to use on selection screen for this level */
 381   char *class_desc;     /* description of level series class */
 382   int handicap_level;   /* number of the lowest unsolved level */
 383 };
 384
 385 typedef struct TreeInfo TreeInfo;
 386 typedef struct TreeInfo LevelDirTree;
 387 typedef struct TreeInfo ArtworkDirTree;
 388 typedef struct TreeInfo GraphicsDirTree;
 389 typedef struct TreeInfo SoundsDirTree;
 390 typedef struct TreeInfo MusicDirTree;
 391
 392 struct ArtworkInfo
 393 {
 394   GraphicsDirTree *gfx_first;
 395   GraphicsDirTree *gfx_current;
 396   SoundsDirTree *snd_first;
 397   SoundsDirTree *snd_current;
 398   MusicDirTree *mus_first;
 399   MusicDirTree *mus_current;
 400
 401   char *graphics_set_current_name;
 402   char *sounds_set_current_name;
 403   char *music_set_current_name;
 404 };
 405
 406
 407 /* ========================================================================= */
 408 /* exported variables                                                        */
 409 /* ========================================================================= */
 410
 411 extern struct ProgramInfo       program;
 412 extern struct OptionInfo        options;
 413 extern struct VideoSystemInfo   video;
 414 extern struct AudioSystemInfo   audio;
 415 extern struct GfxInfo           gfx;
 416 extern struct ArtworkInfo       artwork;
 417 extern struct JoystickInfo      joystick;
 418 extern struct SetupInfo         setup;
 419
 420 extern LevelDirTree            *leveldir_first;
 421 extern LevelDirTree            *leveldir_current;
 422 extern int                      level_nr;
 423
 424 extern Display                 *display;
 425 extern Visual                  *visual;
 426 extern int                      screen;
 427 extern Colormap                 cmap;
 428
 429 extern DrawWindow              *window;
 430 extern DrawBuffer              *backbuffer;
 431 extern DrawBuffer              *drawto;
 432
 433 extern int                      button_status;
 434 extern boolean                  motion_status;
 435
 436 extern int                      redraw_mask;
 437 extern int                      redraw_tiles;
 438
 439 extern int                      FrameCounter;
 440
 441
 442 /* function definitions */
 443
 444 void InitCommandName(char *);
 445 void InitExitFunction(void (*exit_function)(int));
 446 void InitPlatformDependantStuff(void);
 447 void ClosePlatformDependantStuff(void);
 448
 449 void InitProgramInfo(char *, char *, char *, char *, char *, char *, char *,
 450                      char *, char *, int);
 451
 452 void InitGfxFieldInfo(int, int, int, int, int, int, int, int);
 453 void InitGfxDoor1Info(int, int, int, int);
 454 void InitGfxDoor2Info(int, int, int, int);
 455 void InitGfxScrollbufferInfo(int, int);
 456 void SetDrawDeactivationMask(int );
 457
 458 inline void InitVideoDisplay(void);
 459 inline void CloseVideoDisplay(void);
 460 inline void InitVideoBuffer(DrawBuffer **,DrawWindow **, int,int,int, boolean);
 461 inline Bitmap *CreateBitmapStruct(void);
 462 inline Bitmap *CreateBitmap(int, int, int);
 463 inline void FreeBitmap(Bitmap *);
 464 inline void BlitBitmap(Bitmap *, Bitmap *, int, int, int, int, int, int);
 465 inline void ClearRectangle(Bitmap *, int, int, int, int);
 466 inline void SetClipMask(Bitmap *, GC, Pixmap);
 467 inline void SetClipOrigin(Bitmap *, GC, int, int);
 468 inline void BlitBitmapMasked(Bitmap *, Bitmap *, int, int, int, int, int, int);
 469 inline void DrawSimpleWhiteLine(Bitmap *, int, int, int, int);
 470 inline void DrawLines(Bitmap *, struct XY *, int, Pixel);
 471 inline Pixel GetPixel(Bitmap *, int, int);
 472 inline Pixel GetPixelFromRGB(Bitmap *, unsigned int,unsigned int,unsigned int);
 473 inline Pixel GetPixelFromRGBcompact(Bitmap *, unsigned int);
 474
 475 inline void FlushDisplay(void);
 476 inline void SyncDisplay(void);
 477 inline void KeyboardAutoRepeatOn(void);
 478 inline void KeyboardAutoRepeatOff(void);
 479 inline boolean PointerInWindow(DrawWindow *);
 480 inline boolean SetVideoMode(boolean);
 481 inline boolean ChangeVideoModeIfNeeded(boolean);
 482
 483 Bitmap *LoadImage(char *);
 484 Bitmap *LoadCustomImage(char *);
 485 void ReloadCustomImage(Bitmap *, char *);
 486
 487 inline void OpenAudio(void);
 488 inline void CloseAudio(void);
 489 inline void SetAudioMode(boolean);
 490
 491 inline void InitEventFilter(EventFilter);
 492 inline boolean PendingEvent(void);
 493 inline void NextEvent(Event *event);
 494 inline Key GetEventKey(KeyEvent *, boolean);
 495 inline boolean CheckCloseWindowEvent(ClientMessageEvent *);
 496
 497 inline void InitJoysticks();
 498 inline boolean ReadJoystick(int, int *, int *, boolean *, boolean *);
 499
 500 #endif /* SYSTEM_H */