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_MV_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 text for non-existant artwork */
 142 #define NOT_AVAILABLE           "(not available)"
 143
 144 /* default value for undefined filename */
 145 #define UNDEFINED_FILENAME      "[NONE]"
 146
 147 /* default name for new levels */
 148 #define NAMELESS_LEVEL_NAME     "nameless level"
 149
 150 /* definitions for game sub-directories */
 151 #ifndef RO_GAME_DIR
 152 #define RO_GAME_DIR             "."
 153 #endif
 154
 155 #ifndef RW_GAME_DIR
 156 #define RW_GAME_DIR             "."
 157 #endif
 158
 159 #define RO_BASE_PATH            RO_GAME_DIR
 160 #define RW_BASE_PATH            RW_GAME_DIR
 161
 162 #define GRAPHICS_DIRECTORY      "graphics"
 163 #define SOUNDS_DIRECTORY        "sounds"
 164 #define MUSIC_DIRECTORY         "music"
 165 #define LEVELS_DIRECTORY        "levels"
 166 #define TAPES_DIRECTORY         "tapes"
 167 #define SCORES_DIRECTORY        "scores"
 168
 169 #if !defined(PLATFORM_MSDOS)
 170 #define GRAPHICS_SUBDIR         "gfx_classic"
 171 #define SOUNDS_SUBDIR           "snd_classic"
 172 #define MUSIC_SUBDIR            "mus_classic"
 173 #else
 174 #define GRAPHICS_SUBDIR         "gfx_orig"
 175 #define SOUNDS_SUBDIR           "snd_orig"
 176 #define MUSIC_SUBDIR            "mus_orig"
 177 #endif
 178
 179 /* areas in bitmap PIX_DOOR */
 180 /* meaning in PIX_DB_DOOR: (3 PAGEs)
 181    PAGEX1: 1. buffer for DOOR_1
 182    PAGEX2: 2. buffer for DOOR_1
 183    PAGEX3: buffer for animations
 184 */
 185
 186 #define DOOR_GFX_PAGESIZE       (gfx.dxsize)
 187 #define DOOR_GFX_PAGEX1         (0 * DOOR_GFX_PAGESIZE)
 188 #define DOOR_GFX_PAGEX2         (1 * DOOR_GFX_PAGESIZE)
 189 #define DOOR_GFX_PAGEX3         (2 * DOOR_GFX_PAGESIZE)
 190 #define DOOR_GFX_PAGEX4         (3 * DOOR_GFX_PAGESIZE)
 191 #define DOOR_GFX_PAGEX5         (4 * DOOR_GFX_PAGESIZE)
 192 #define DOOR_GFX_PAGEX6         (5 * DOOR_GFX_PAGESIZE)
 193 #define DOOR_GFX_PAGEX7         (6 * DOOR_GFX_PAGESIZE)
 194 #define DOOR_GFX_PAGEX8         (7 * DOOR_GFX_PAGESIZE)
 195 #define DOOR_GFX_PAGEY1         (0)
 196 #define DOOR_GFX_PAGEY2         (gfx.dysize)
 197
 198 /* functions for version handling */
 199 #define VERSION_IDENT(x,y,z)    ((x) * 10000 + (y) * 100 + (z))
 200 #define VERSION_MAJOR(x)        ((x) / 10000)
 201 #define VERSION_MINOR(x)        (((x) % 10000) / 100)
 202 #define VERSION_PATCH(x)        ((x) % 100)
 203
 204 /* functions for parent/child process identification */
 205 #define IS_PARENT_PROCESS(pid)  ((pid) > 0)
 206 #define IS_CHILD_PROCESS(pid)   ((pid) == 0)
 207
 208
 209 /* type definitions */
 210 typedef int (*EventFilter)(const Event *);
 211
 212
 213 /* structure definitions */
 214
 215 struct ProgramInfo
 216 {
 217   char *command_basename;
 218   char *userdata_directory;
 219
 220   char *program_title;
 221   char *window_title;
 222   char *icon_title;
 223
 224   char *x11_icon_filename;
 225   char *x11_iconmask_filename;
 226   char *msdos_pointer_filename;
 227
 228   char *cookie_prefix;
 229   char *filename_prefix;        /* prefix to cut off from DOS filenames */
 230
 231   int version_major;
 232   int version_minor;
 233   int version_patch;
 234
 235   void (*exit_function)(int);
 236 };
 237
 238 struct OptionInfo
 239 {
 240   char *display_name;
 241   char *server_host;
 242   int server_port;
 243   char *ro_base_directory;
 244   char *rw_base_directory;
 245   char *level_directory;
 246   char *graphics_directory;
 247   char *sounds_directory;
 248   char *music_directory;
 249   boolean serveronly;
 250   boolean network;
 251   boolean verbose;
 252   boolean debug;
 253   char *debug_command;
 254 };
 255
 256 struct VideoSystemInfo
 257 {
 258   int default_depth;
 259   int width, height, depth;
 260   boolean fullscreen_available;
 261   boolean fullscreen_enabled;
 262 };
 263
 264 struct AudioSystemInfo
 265 {
 266   boolean sound_available;
 267   boolean loops_available;
 268   boolean music_available;
 269
 270   boolean sound_enabled;
 271   boolean sound_deactivated;    /* for temporarily disabling sound */
 272
 273   int mixer_pipe[2];
 274   int mixer_pid;
 275   char *device_name;
 276   int device_fd;
 277
 278   int num_channels;
 279   int music_channel;
 280   int first_sound_channel;
 281 };
 282
 283 struct GfxInfo
 284 {
 285   int sx, sy;
 286   int sxsize, sysize;
 287   int real_sx, real_sy;
 288   int full_sxsize, full_sysize;
 289   int scrollbuffer_width, scrollbuffer_height;
 290
 291   int dx, dy;
 292   int dxsize, dysize;
 293
 294   int vx, vy;
 295   int vxsize, vysize;
 296
 297   boolean draw_deactivation_mask;
 298 };
 299
 300 struct JoystickInfo
 301 {
 302   int status;
 303   int fd[MAX_PLAYERS];          /* file descriptor of player's joystick */
 304 };
 305
 306 struct SetupJoystickInfo
 307 {
 308   char *device_name;            /* device name of player's joystick */
 309
 310   int xleft, xmiddle, xright;
 311   int yupper, ymiddle, ylower;
 312   int snap;
 313   int bomb;
 314 };
 315
 316 struct SetupKeyboardInfo
 317 {
 318   Key left;
 319   Key right;
 320   Key up;
 321   Key down;
 322   Key snap;
 323   Key bomb;
 324 };
 325
 326 struct SetupInputInfo
 327 {
 328   boolean use_joystick;
 329   struct SetupJoystickInfo joy;
 330   struct SetupKeyboardInfo key;
 331 };
 332
 333 struct SetupShortcutInfo
 334 {
 335   Key save_game;
 336   Key load_game;
 337   Key toggle_pause;
 338 };
 339
 340 struct SetupInfo
 341 {
 342   char *player_name;
 343
 344   boolean sound;
 345   boolean sound_loops;
 346   boolean sound_music;
 347   boolean sound_simple;
 348   boolean toons;
 349   boolean double_buffering;
 350   boolean direct_draw;          /* !double_buffering (redundant!) */
 351   boolean scroll_delay;
 352   boolean soft_scrolling;
 353   boolean fading;
 354   boolean autorecord;
 355   boolean quick_doors;
 356   boolean team_mode;
 357   boolean handicap;
 358   boolean time_limit;
 359   boolean fullscreen;
 360   boolean ask_on_escape;
 361
 362   char *graphics_set;
 363   char *sounds_set;
 364   char *music_set;
 365   boolean override_level_graphics;
 366   boolean override_level_sounds;
 367   boolean override_level_music;
 368
 369   struct SetupShortcutInfo shortcut;
 370   struct SetupInputInfo input[MAX_PLAYERS];
 371 };
 372
 373 #define TREE_TYPE_GENERIC               0
 374 #define TREE_TYPE_GRAPHICS_DIR          1
 375 #define TREE_TYPE_SOUNDS_DIR            2
 376 #define TREE_TYPE_MUSIC_DIR             3
 377 #define TREE_TYPE_LEVEL_DIR             4
 378
 379 #define ARTWORK_TYPE_GRAPHICS           TREE_TYPE_GRAPHICS_DIR
 380 #define ARTWORK_TYPE_SOUNDS             TREE_TYPE_SOUNDS_DIR
 381 #define ARTWORK_TYPE_MUSIC              TREE_TYPE_MUSIC_DIR
 382
 383 struct TreeInfo
 384 {
 385   struct TreeInfo **node_top;           /* topmost node in tree */
 386   struct TreeInfo *node_parent;         /* parent level directory info */
 387   struct TreeInfo *node_group;          /* level group sub-directory info */
 388   struct TreeInfo *next;                /* next level series structure node */
 389
 390   int cl_first;         /* internal control field for setup screen */
 391   int cl_cursor;        /* internal control field for setup screen */
 392
 393   int type;             /* type of tree content */
 394
 395   /* fields for "type == TREE_TYPE_LEVEL_DIR" */
 396
 397   char *filename;       /* tree info sub-directory basename (may be ".") */
 398   char *fullpath;       /* complete path relative to tree base directory */
 399   char *basepath;       /* absolute base path of tree base directory */
 400   char *identifier;     /* identifier string for configuration files */
 401   char *name;           /* tree info name, as displayed in selection menues */
 402   char *name_sorting;   /* optional sorting name for correct name sorting */
 403   char *author;         /* level or artwork author name */
 404   char *imported_from;  /* optional comment for imported levels or artwork */
 405
 406   char *graphics_set;   /* optional custom graphics set (level tree only) */
 407   char *sounds_set;     /* optional custom sounds set (level tree only) */
 408   char *music_set;      /* optional custom music set (level tree only) */
 409   char *graphics_path;  /* path to optional custom graphics set (level only) */
 410   char *sounds_path;    /* path to optional custom sounds set (level only) */
 411   char *music_path;     /* path to optional custom music set (level only) */
 412
 413   int levels;           /* number of levels in level series */
 414   int first_level;      /* first level number (to allow start with 0 or 1) */
 415   int last_level;       /* last level number (automatically calculated) */
 416   int sort_priority;    /* sort levels by 'sort_priority' and then by name */
 417
 418   boolean level_group;  /* directory contains more level series directories */
 419   boolean parent_link;  /* entry links back to parent directory */
 420   boolean user_defined; /* user defined levels are stored in home directory */
 421   boolean readonly;     /* readonly levels can not be changed with editor */
 422
 423   int color;            /* color to use on selection screen for this level */
 424   char *class_desc;     /* description of level series class */
 425   int handicap_level;   /* number of the lowest unsolved level */
 426 };
 427
 428 typedef struct TreeInfo TreeInfo;
 429 typedef struct TreeInfo LevelDirTree;
 430 typedef struct TreeInfo ArtworkDirTree;
 431 typedef struct TreeInfo GraphicsDirTree;
 432 typedef struct TreeInfo SoundsDirTree;
 433 typedef struct TreeInfo MusicDirTree;
 434
 435 struct ArtworkInfo
 436 {
 437   GraphicsDirTree *gfx_first;
 438   GraphicsDirTree *gfx_current;
 439   SoundsDirTree *snd_first;
 440   SoundsDirTree *snd_current;
 441   MusicDirTree *mus_first;
 442   MusicDirTree *mus_current;
 443
 444   char *gfx_current_identifier;
 445   char *snd_current_identifier;
 446   char *mus_current_identifier;
 447 };
 448
 449 struct ConfigInfo
 450 {
 451   char *token;
 452   char *value;
 453 };
 454
 455 struct FileInfo
 456 {
 457   char *token;
 458
 459   char *default_filename;
 460   char *filename;
 461
 462   int *default_parameter;                       /* array of file parameters */
 463   int *parameter;                               /* array of file parameters */
 464 };
 465
 466 struct ListNodeInfo
 467 {
 468   char *source_filename;                        /* primary key for node list */
 469   int num_references;
 470 };
 471
 472 struct ArtworkListInfo
 473 {
 474   int type;                                     /* type of artwork */
 475
 476   int num_file_list_entries;
 477   int num_suffix_list_entries;
 478
 479   struct FileInfo *file_list;                   /* static artwork file array */
 480   struct ConfigInfo *suffix_list;               /* parameter suffixes array */
 481
 482   struct ListNodeInfo **artwork_list;           /* static artwork node array */
 483
 484   struct ListNode *content_list;                /* dynamic artwork node list */
 485
 486   void *(*load_artwork)(char *);                /* constructor function */
 487   void (*free_artwork)(void *);                 /* destructor function */
 488 };
 489
 490
 491 /* ========================================================================= */
 492 /* exported variables                                                        */
 493 /* ========================================================================= */
 494
 495 extern struct ProgramInfo       program;
 496 extern struct OptionInfo        options;
 497 extern struct VideoSystemInfo   video;
 498 extern struct AudioSystemInfo   audio;
 499 extern struct GfxInfo           gfx;
 500 extern struct ArtworkInfo       artwork;
 501 extern struct JoystickInfo      joystick;
 502 extern struct SetupInfo         setup;
 503
 504 extern LevelDirTree            *leveldir_first;
 505 extern LevelDirTree            *leveldir_current;
 506 extern int                      level_nr;
 507
 508 extern Display                 *display;
 509 extern Visual                  *visual;
 510 extern int                      screen;
 511 extern Colormap                 cmap;
 512
 513 extern DrawWindow              *window;
 514 extern DrawBuffer              *backbuffer;
 515 extern DrawBuffer              *drawto;
 516
 517 extern int                      button_status;
 518 extern boolean                  motion_status;
 519
 520 extern int                      redraw_mask;
 521 extern int                      redraw_tiles;
 522
 523 extern int                      FrameCounter;
 524
 525
 526 /* function definitions */
 527
 528 void InitCommandName(char *);
 529 void InitExitFunction(void (*exit_function)(int));
 530 void InitPlatformDependantStuff(void);
 531 void ClosePlatformDependantStuff(void);
 532
 533 void InitProgramInfo(char *, char *, char *, char *, char *, char *, char *,
 534                      char *, char *, int);
 535
 536 void InitGfxFieldInfo(int, int, int, int, int, int, int, int);
 537 void InitGfxDoor1Info(int, int, int, int);
 538 void InitGfxDoor2Info(int, int, int, int);
 539 void InitGfxScrollbufferInfo(int, int);
 540 void SetDrawDeactivationMask(int );
 541
 542 inline void InitVideoDisplay(void);
 543 inline void CloseVideoDisplay(void);
 544 inline void InitVideoBuffer(DrawBuffer **,DrawWindow **, int,int,int, boolean);
 545 inline Bitmap *CreateBitmapStruct(void);
 546 inline Bitmap *CreateBitmap(int, int, int);
 547 inline void FreeBitmap(Bitmap *);
 548 inline void BlitBitmap(Bitmap *, Bitmap *, int, int, int, int, int, int);
 549 inline void ClearRectangle(Bitmap *, int, int, int, int);
 550 inline void SetClipMask(Bitmap *, GC, Pixmap);
 551 inline void SetClipOrigin(Bitmap *, GC, int, int);
 552 inline void BlitBitmapMasked(Bitmap *, Bitmap *, int, int, int, int, int, int);
 553 inline void DrawSimpleWhiteLine(Bitmap *, int, int, int, int);
 554 inline void DrawLines(Bitmap *, struct XY *, int, Pixel);
 555 inline Pixel GetPixel(Bitmap *, int, int);
 556 inline Pixel GetPixelFromRGB(Bitmap *, unsigned int,unsigned int,unsigned int);
 557 inline Pixel GetPixelFromRGBcompact(Bitmap *, unsigned int);
 558
 559 inline void FlushDisplay(void);
 560 inline void SyncDisplay(void);
 561 inline void KeyboardAutoRepeatOn(void);
 562 inline void KeyboardAutoRepeatOff(void);
 563 inline boolean PointerInWindow(DrawWindow *);
 564 inline boolean SetVideoMode(boolean);
 565 inline boolean ChangeVideoModeIfNeeded(boolean);
 566
 567 Bitmap *LoadImage(char *);
 568 Bitmap *LoadCustomImage(char *);
 569 void ReloadCustomImage(Bitmap *, char *);
 570
 571 inline void OpenAudio(void);
 572 inline void CloseAudio(void);
 573 inline void SetAudioMode(boolean);
 574
 575 inline void InitEventFilter(EventFilter);
 576 inline boolean PendingEvent(void);
 577 inline void NextEvent(Event *event);
 578 inline Key GetEventKey(KeyEvent *, boolean);
 579 inline boolean CheckCloseWindowEvent(ClientMessageEvent *);
 580
 581 inline void InitJoysticks();
 582 inline boolean ReadJoystick(int, int *, int *, boolean *, boolean *);
 583
 584 #endif /* SYSTEM_H */