4 * Copyright (c) 1997 Ben Harrison
6 * This software may be copied and distributed for educational, research,
7 * and not for profit purposes provided that this copyright and statement
8 * are included in all such copies.
11 #ifndef INCLUDED_Z_TERM_H
12 #define INCLUDED_Z_TERM_H
18 * A term_win is a "window" for a Term
20 * - Cursor Useless/Visible codes
21 * - Cursor Location (see "Useless")
23 * - Array[h] -- Access to the attribute array
24 * - Array[h] -- Access to the character array
26 * - Array[h*w] -- Attribute array
27 * - Array[h*w] -- Character array
29 * Note that the attr/char pair at (x,y) is a[y][x]/c[y][x]
30 * and that the row of attr/chars at (0,y) is a[y]/c[y]
33 typedef struct term_win term_win;
46 #ifdef USE_TRANSPARENCY
52 #endif /* USE_TRANSPARENCY */
59 * An actual "term" structure
61 * - Extra "user" info (used by application)
63 * - Extra "data" info (used by implementation)
67 * An extra "user" flag (used by application)
71 * An extra "data" flag (used by implementation)
74 * - Flag "active_flag"
75 * This "term" is "active"
77 * - Flag "mapped_flag"
78 * This "term" is "mapped"
80 * - Flag "total_erase"
81 * This "term" should be fully erased
83 * - Flag "fixed_shape"
84 * This "term" is not allowed to resize
86 * - Flag "icky_corner"
87 * This "term" has an "icky" corner grid
89 * - Flag "soft_cursor"
90 * This "term" uses a "software" cursor
92 * - Flag "always_pict"
93 * Use the "Term_pict()" routine for all text
95 * - Flag "higher_pict"
96 * Use the "Term_pict()" routine for special text
98 * - Flag "always_text"
99 * Use the "Term_text()" routine for invisible text
101 * - Flag "unused_flag"
102 * Reserved for future use
104 * - Flag "never_bored"
105 * Never call the "TERM_XTRA_BORED" action
107 * - Flag "never_frosh"
108 * Never call the "TERM_XTRA_FROSH" action
111 * - Value "attr_blank"
112 * Use this "attr" value for "blank" grids
114 * - Value "char_blank"
115 * Use this "char" value for "blank" grids
118 * - Ignore this pointer
120 * - Keypress Queue -- various data
122 * - Keypress Queue -- pending keys
125 * - Window Width (max 255)
126 * - Window Height (max 255)
128 * - Minimum modified row
129 * - Maximum modified row
131 * - Minimum modified column (per row)
132 * - Maximum modified column (per row)
135 * - Displayed screen image
136 * - Requested screen image
138 * - Temporary screen image
139 * - Memorized screen image
142 * - Hook for init-ing the term
143 * - Hook for nuke-ing the term
145 * - Hook for user actions
147 * - Hook for extra actions
149 * - Hook for placing the cursor
151 * - Hook for drawing some blank spaces
153 * - Hook for drawing a string of chars using an attr
155 * - Hook for drawing a sequence of special attr/char pairs
158 typedef struct term term;
208 void (*init_hook)(term *t);
209 void (*nuke_hook)(term *t);
211 errr (*user_hook)(int n);
213 errr (*xtra_hook)(int n, int v);
215 errr (*curs_hook)(int x, int y);
217 errr (*wipe_hook)(int x, int y, int n);
219 errr (*text_hook)(int x, int y, int n, byte a, cptr s);
221 #ifdef USE_TRANSPARENCY
222 errr (*pict_hook)(int x, int y, int n, const byte *ap, const char *cp, const byte *tap, const char *tcp);
223 #else /* USE_TRANSPARENCY */
224 errr (*pict_hook)(int x, int y, int n, const byte *ap, const char *cp);
225 #endif /* USE_TRANSPARENCY */
235 /**** Available Constants ****/
239 * Definitions for the "actions" of "Term_xtra()"
241 * These values may be used as the first parameter of "Term_xtra()",
242 * with the second parameter depending on the "action" itself. Many
243 * of the actions shown below are optional on at least one platform.
245 * The "TERM_XTRA_EVENT" action uses "v" to "wait" for an event
246 * The "TERM_XTRA_SHAPE" action uses "v" to "show" the cursor
247 * The "TERM_XTRA_FROSH" action uses "v" for the index of the row
248 * The "TERM_XTRA_SOUND" action uses "v" for the index of a sound
249 * The "TERM_XTRA_ALIVE" action uses "v" to "activate" (or "close")
250 * The "TERM_XTRA_LEVEL" action uses "v" to "resume" (or "suspend")
251 * The "TERM_XTRA_DELAY" action uses "v" as a "millisecond" value
253 * The other actions do not need a "v" code, so "zero" is used.
255 #define TERM_XTRA_EVENT 1 /* Process some pending events */
256 #define TERM_XTRA_FLUSH 2 /* Flush all pending events */
257 #define TERM_XTRA_CLEAR 3 /* Clear the entire window */
258 #define TERM_XTRA_SHAPE 4 /* Set cursor shape (optional) */
259 #define TERM_XTRA_FROSH 5 /* Flush one row (optional) */
260 #define TERM_XTRA_FRESH 6 /* Flush all rows (optional) */
261 #define TERM_XTRA_NOISE 7 /* Make a noise (optional) */
262 #define TERM_XTRA_SOUND 8 /* Make a sound (optional) */
263 #define TERM_XTRA_BORED 9 /* Handle stuff when bored (optional) */
264 #define TERM_XTRA_REACT 10 /* React to global changes (optional) */
265 #define TERM_XTRA_ALIVE 11 /* Change the "hard" level (optional) */
266 #define TERM_XTRA_LEVEL 12 /* Change the "soft" level (optional) */
267 #define TERM_XTRA_DELAY 13 /* Delay some milliseconds (optional) */
270 /**** Available Variables ****/
275 /**** Available Functions ****/
277 extern errr Term_user(int n);
278 extern errr Term_xtra(int n, int v);
280 #ifdef USE_TRANSPARENCY
281 extern void Term_queue_char(int x, int y, byte a, char c, byte ta, char tc);
283 extern void Term_queue_line(int x, int y, int n, byte *a, char *c, byte *ta, char *tc);
284 #else /* USE_TRANSPARENCY */
285 extern void Term_queue_char(int x, int y, byte a, char c);
287 extern void Term_queue_line(int x, int y, int n, byte *a, char *c);
288 #endif /* USE_TRANSPARENCY */
290 extern void Term_queue_chars(int x, int y, int n, byte a, cptr s);
292 extern errr Term_fresh(void);
293 extern errr Term_set_cursor(int v);
294 extern errr Term_gotoxy(int x, int y);
295 extern errr Term_draw(int x, int y, byte a, char c);
296 extern errr Term_addch(byte a, char c);
297 extern errr Term_addstr(int n, byte a, cptr s);
298 extern errr Term_putch(int x, int y, byte a, char c);
299 extern errr Term_putstr(int x, int y, int n, byte a, cptr s);
301 extern errr Term_putstr_v(int x, int y, int n, byte a, cptr s);
303 extern errr Term_erase(int x, int y, int n);
304 extern errr Term_clear(void);
305 extern errr Term_redraw(void);
306 extern errr Term_redraw_section(int x1, int y1, int x2, int y2);
308 extern errr Term_get_cursor(int *v);
309 extern errr Term_get_size(int *w, int *h);
310 extern errr Term_locate(int *x, int *y);
311 extern errr Term_what(int x, int y, byte *a, char *c);
313 extern errr Term_flush(void);
314 extern errr Term_keypress(int k);
315 extern errr Term_key_push(int k);
316 extern errr Term_inkey(char *ch, bool wait, bool take);
318 extern errr Term_save(void);
319 extern errr Term_load(void);
321 extern errr Term_exchange(void);
323 extern errr Term_resize(int w, int h);
325 extern errr Term_activate(term *t);
327 extern errr term_nuke(term *t);
328 extern errr term_init(term *t, int w, int h, int k);