/* File: z-term.h */ /* * Copyright (c) 1997 Ben Harrison * * This software may be copied and distributed for educational, research, * and not for profit purposes provided that this copyright and statement * are included in all such copies. */ #ifndef INCLUDED_Z_TERM_H #define INCLUDED_Z_TERM_H #ifdef __cplusplus extern "C" { #endif #include "h-basic.h" /* * A term_win is a "window" for a Term * * - Cursor Useless/Visible codes * - Cursor Location (see "Useless") * * - Array[h] -- Access to the attribute array * - Array[h] -- Access to the character array * * - Array[h*w] -- Attribute array * - Array[h*w] -- Character array * * Note that the attr/char pair at (x,y) is a[y][x]/c[y][x] * and that the row of attr/chars at (0,y) is a[y]/c[y] */ typedef struct term_win term_win; struct term_win { bool_ cu, cv; byte cx, cy; byte **a; char **c; byte *va; char *vc; }; /* * An actual "term" structure * * - Extra "data" info (used by implementation) * * * - Flag "active_flag" * This "term" is "active" * * - Flag "mapped_flag" * This "term" is "mapped" * * - Flag "total_erase" * This "term" should be fully erased * * - Flag "icky_corner" * This "term" has an "icky" corner grid * * - Flag "soft_cursor" * This "term" uses a "software" cursor * * * * * - Ignore this pointer * * - Keypress Queue -- various data * * - Keypress Queue -- pending keys * * * - Window Width (max 255) * - Window Height (max 255) * * - Minimum modified row * - Maximum modified row * * - Minimum modified column (per row) * - Maximum modified column (per row) * * * - Displayed screen image * - Requested screen image * * - Temporary screen image * - Memorized screen image * * * - Hook for init-ing the term * - Hook for nuke-ing the term * * - Hook for extra actions * * - Hook for placing the cursor * * - Hook for drawing a string of chars using an attr * * - Hook for drawing a sequence of special attr/char pairs */ typedef struct term term; struct term { vptr data; bool_ active_flag; bool_ mapped_flag; bool_ total_erase; bool_ icky_corner; bool_ soft_cursor; char *key_queue; u16b key_head; u16b key_tail; u16b key_size; byte wid; byte hgt; byte y1; byte y2; byte *x1; byte *x2; term_win *old; term_win *scr; term_win *mem; void (*init_hook)(term *t); void (*nuke_hook)(term *t); errr (*xtra_hook)(int n, int v); errr (*curs_hook)(int x, int y); errr (*text_hook)(int x, int y, int n, byte a, cptr s); void (*resize_hook)(); }; /*** Color constants ***/ /* * Angband "attributes" (with symbols, and base (R,G,B) codes) * * The "(R,G,B)" codes are given in "fourths" of the "maximal" value, * and should "gamma corrected" on most (non-Macintosh) machines. */ #define TERM_DARK 0 /* 'd' */ /* 0,0,0 */ #define TERM_WHITE 1 /* 'w' */ /* 4,4,4 */ #define TERM_SLATE 2 /* 's' */ /* 2,2,2 */ #define TERM_ORANGE 3 /* 'o' */ /* 4,2,0 */ #define TERM_RED 4 /* 'r' */ /* 3,0,0 */ #define TERM_GREEN 5 /* 'g' */ /* 0,2,1 */ #define TERM_BLUE 6 /* 'b' */ /* 0,0,4 */ #define TERM_UMBER 7 /* 'u' */ /* 2,1,0 */ #define TERM_L_DARK 8 /* 'D' */ /* 1,1,1 */ #define TERM_L_WHITE 9 /* 'W' */ /* 3,3,3 */ #define TERM_VIOLET 10 /* 'v' */ /* 4,0,4 */ #define TERM_YELLOW 11 /* 'y' */ /* 4,4,0 */ #define TERM_L_RED 12 /* 'R' */ /* 4,0,0 */ #define TERM_L_GREEN 13 /* 'G' */ /* 0,4,0 */ #define TERM_L_BLUE 14 /* 'B' */ /* 0,4,4 */ #define TERM_L_UMBER 15 /* 'U' */ /* 3,2,1 */ /**** Available Constants ****/ /* * Definitions for the "actions" of "Term_xtra()" * * These values may be used as the first parameter of "Term_xtra()", * with the second parameter depending on the "action" itself. Many * of the actions shown below are optional on at least one platform. * * The "TERM_XTRA_EVENT" action uses "v" to "wait" for an event * The "TERM_XTRA_SHAPE" action uses "v" to "show" the cursor * The "TERM_XTRA_ALIVE" action uses "v" to "activate" (or "close") * The "TERM_XTRA_LEVEL" action uses "v" to "resume" (or "suspend") * * The other actions do not need a "v" code, so "zero" is used. */ #define TERM_XTRA_EVENT 1 /* Process some pending events */ #define TERM_XTRA_FLUSH 2 /* Flush all pending events */ #define TERM_XTRA_CLEAR 3 /* Clear the entire window */ #define TERM_XTRA_SHAPE 4 /* Set cursor shape (optional) */ #define TERM_XTRA_FRESH 6 /* Flush all rows (optional) */ #define TERM_XTRA_NOISE 7 /* Make a noise (optional) */ #define TERM_XTRA_BORED 9 /* Handle stuff when bored (optional) */ #define TERM_XTRA_REACT 10 /* React to global changes (optional) */ #define TERM_XTRA_ALIVE 11 /* Change the "hard" level (optional) */ #define TERM_XTRA_LEVEL 12 /* Change the "soft" level (optional) */ #define TERM_XTRA_RENAME_MAIN_WIN 16 /* Rename the main game window */ /**** Available Variables ****/ extern term *Term; /**** Available Functions ****/ errr Term_xtra(int n, int v); void Term_queue_char(int x, int y, byte a, char c); void Term_queue_chars(int x, int y, int n, byte a, cptr s); errr Term_fresh(); errr Term_set_cursor(int v); errr Term_gotoxy(int x, int y); errr Term_draw(int x, int y, byte a, char c); errr Term_addch(byte a, char c); errr Term_addstr(int n, byte a, cptr s); errr Term_putch(int x, int y, byte a, char c); errr Term_putstr(int x, int y, int n, byte a, cptr s); errr Term_erase(int x, int y, int n); errr Term_clear(); errr Term_redraw(); errr Term_redraw_section(int x1, int y1, int x2, int y2); void Term_bell(); errr Term_get_cursor(int *v); errr Term_get_size(int *w, int *h); errr Term_locate(int *x, int *y); errr Term_what(int x, int y, byte *a, char *c); errr Term_flush(); errr Term_keypress(int k); errr Term_key_push(int k); errr Term_inkey(char *ch, bool_ wait, bool_ take); errr Term_save(); term_win* Term_save_to(); errr Term_load(); errr Term_load_from(term_win *save); errr Term_resize(int w, int h); errr Term_activate(term *t); errr term_nuke(term *t); errr term_init(term *t, int w, int h, int k); #ifdef __cplusplus } /* extern "C" */ #endif #endif