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 /* Purpose: a generic, efficient, terminal window package -BEN- */
12 #include "system/angband.h"
19 /* Special flags in the attr data */
20 #define AF_BIGTILE2 0xf0
24 #define AF_KANJI1 0x10
25 #define AF_KANJI2 0x20
26 #define AF_KANJIC 0x0f
29 * 属性に全角文字の1バイト目、2バイト目も記憶。
34 * This file provides a generic, efficient, terminal window package,
35 * which can be used not only on standard terminal environments such
36 * as dumb terminals connected to a Unix box, but also in more modern
37 * "graphic" environments, such as the Macintosh or Unix/X11.
39 * Each "window" works like a standard "dumb terminal", that is, it
40 * can display a two dimensional array of grids containing colored
41 * textual symbols, plus an optional cursor, and it can be used to
42 * get keypress events from the user.
44 * In fact, this package can simply be used, if desired, to support
45 * programs which will look the same on a dumb terminal as they do
46 * on a graphic platform such as the Macintosh.
48 * This package was designed to help port the game "Angband" to a wide
49 * variety of different platforms. Angband, like many other games in
50 * the "rogue-like" heirarchy, requires, at the minimum, the ability
51 * to display "colored textual symbols" in a standard 80x24 "window",
52 * such as that provided by most dumb terminals, and many old personal
53 * computers, and to check for "keypresses" from the user. The major
54 * concerns were thus portability and efficiency, so Angband could be
55 * easily ported to many different systems, with minimal effort, and
56 * yet would run quickly on each of these sys
57 tems, no matter what kind
58 * of underlying hardware/software support was being used.
60 * It is important to understand the differences between the older
61 * "dumb terminals" and the newer "graphic interface" machines, since
62 * this package was designed to work with both types of systems.
65 * waiting for a keypress is complex
66 * checking for a keypress is often cheap
67 * changing "colors" may be expensive
68 * the "color" of a "blank" is rarely important
69 * moving the "cursor" is relatively cheap
70 * use a "software" cursor (only moves when requested)
71 * drawing characters normally will not erase old ones
72 * drawing a character on the cursor often erases it
73 * may have fast routines for "clear a region"
74 * the bottom right corner is usually not special
77 * waiting for a keypress is simple
78 * checking for a keypress is often expensive
79 * changing "colors" is usually cheap
80 * the "color" of a "blank" may be important
81 * moving the "cursor" may be expensive
82 * use a "hardware" cursor (moves during screen updates)
83 * drawing new symbols automatically erases old ones
84 * characters may only be drawn at the cursor location
85 * drawing a character on the cursor will move the cursor
86 * may have fast routines for "clear entire window"
87 * may have fast routines for "clear to end of line"
88 * the bottom right corner is often dangerous
91 * This package provides support for multiple windows, each of an
92 * arbitrary size (up to 255x255), each with its own set of flags,
93 * and its own hooks to handle several low-level procedures which
94 * differ from platform to platform. Then the main program simply
95 * creates one or more "term" structures, setting the various flags
96 * and hooks in a manner appropriate for the current platform, and
97 * then it can use the various "term" structures without worrying
98 * about the underlying platform.
101 * This package allows each "grid" in each window to hold an attr/char
102 * pair, with each ranging from 0 to 255, and makes very few assumptions
103 * about the meaning of any attr/char values. Normally, we assume that
104 * "attr 0" is "black", with the semantics that "black" text should be
105 * sent to "Term_wipe()" instead of "Term_text()", but this sematics is
106 * modified if either the "always_pict" or the "always_text" flags are
107 * set. We assume that "char 0" is "dangerous", since placing such a
108 * "char" in the middle of a string "terminates" the string, and usually
109 * we prevent its use.
111 * Finally, we use a special attr/char pair, defaulting to "attr 0" and
112 * "char 32", also known as "black space", when we "erase" or "clear"
113 * any window, but this pair can be redefined to any pair, including
114 * the standard "white space", or the bizarre "emptiness" ("attr 0"
115 * and "char 0"), as long as various obscure restrictions are met.
118 * This package provides several functions which allow a program to
119 * interact with the "term" structures. Most of the functions allow
120 * the program to "request" certain changes to the current "term",
121 * such as moving the cursor, drawing an attr/char pair, erasing a
122 * region of grids, hiding the cursor, etc. Then there is a special
123 * function which causes all of the "pending" requests to be performed
124 * in an efficient manner. There is another set of functions which
125 * allow the program to query the "requested state" of the current
126 * "term", such as asking for the cursor location, or what attr/char
127 * is at a given location, etc. There is another set of functions
128 * dealing with "keypress" events, which allows the program to ask if
129 * the user has pressed any keys, or to forget any keys the user pressed.
130 * There is a pair of functions to allow this package to memorize the
131 * contents of the current "term", and to restore these contents at
132 * a later time. There is a special function which allows the program
133 * to specify which "term" structure should be the "current" one. At
134 * the lowest level, there is a set of functions which allow a new
135 * "term" to be initialized or destroyed, and which allow this package,
136 * or a program, to access the special "hooks" defined for the current
137 * "term", and a set of functions which those "hooks" can use to inform
138 * this package of the results of certain occurances, for example, one
139 * such function allows this package to learn about user keypresses,
140 * detected by one of the special "hooks".
142 * We provide, among other things, the functions "Term_keypress()"
143 * to "react" to keypress events, and "Term_redraw()" to redraw the
144 * entire window, plus "Term_resize()" to note a new size.
147 * Note that the current "term" contains two "window images". One of
148 * these images represents the "requested" contents of the "term", and
149 * the other represents the "actual" contents of the "term", at the time
150 * of the last performance of pending requests. This package uses these
151 * two images to determine the "minimal" amount of work needed to make
152 * the "actual" contents of the "term" match the "requested" contents of
153 * the "term". This method is not perfect, but it often reduces the
154 * amount of work needed to perform the pending requests, which thus
155 * increases the speed of the program itself. This package promises
156 * that the requested changes will appear to occur either "all at once"
157 * or in a "top to bottom" order. In addition, a "cursor" is maintained,
158 * and this cursor is updated along with the actual window contents.
160 * Currently, the "Term_fresh()" routine attempts to perform the "minimum"
161 * number of physical updates, in terms of total "work" done by the hooks
162 * Term_wipe(), Term_text(), and Term_pict(), making use of the fact that
163 * adjacent characters of the same color can both be drawn together using
164 * the "Term_text()" hook, and that "black" text can often be sent to the
165 * "Term_wipe()" hook instead of the "Term_text()" hook, and if something
166 * is already displayed in a window, then it is not necessary to display
167 * it again. Unfortunately, this may induce slightly non-optimal results
168 * in some cases, in particular, those in which, say, a string of ten
169 * characters needs to be written, but the fifth character has already
170 * been displayed. Currently, this will cause the "Term_text()" routine
171 * to be called once for each half of the string, instead of once for the
172 * whole string, which, on some machines, may be non-optimal behavior.
174 * The new formalism includes a "displayed" screen image (old) which
175 * is actually seen by the user, a "requested" screen image (scr)
176 * which is being prepared for display, a "memorized" screen image
177 * (mem) which is used to save and restore screen images, and a
178 * "temporary" screen image (tmp) which is currently unused.
181 * Several "flags" are available in each "term" to allow the underlying
182 * visual system (which initializes the "term" structure) to "optimize"
183 * the performance of this package for the given system, or to request
184 * certain behavior which is helpful/required for the given system.
186 * The "soft_cursor" flag indicates the use of a "soft" cursor, which
187 * only moves when explicitly requested,and which is "erased" when
188 * any characters are drawn on top of it. This flag is used for all
189 * "graphic" systems which handle the cursor by "drawing" it.
191 * The "icky_corner" flag indicates that the bottom right "corner"
192 * of the windows are "icky", and "printing" anything there may
193 * induce "messy" behavior, such as "scrolling". This flag is used
194 * for most old "dumb terminal" systems.
197 * The "term" structure contains the following function "hooks":
199 * Term->init_hook = Init the term
200 * Term->nuke_hook = Nuke the term
201 * Term->user_hook = Perform user actions
202 * Term->xtra_hook = Perform extra actions
203 * Term->curs_hook = Draw (or Move) the cursor
204 * Term->bigcurs_hook = Draw (or Move) the big cursor (bigtile mode)
205 * Term->wipe_hook = Draw some blank spaces
206 * Term->text_hook = Draw some text in the window
207 * Term->pict_hook = Draw some attr/chars in the window
209 * The "Term->user_hook" hook provides a simple hook to an implementation
210 * defined function, with application defined semantics. It is available
211 * to the program via the "Term_user()" function.
213 * The "Term->xtra_hook" hook provides a variety of different functions,
214 * based on the first parameter (which should be taken from the various
215 * TERM_XTRA_* defines) and the second parameter (which may make sense
216 * only for some first parameters). It is available to the program via
217 * the "Term_xtra()" function, though some first parameters are only
218 * "legal" when called from inside this package.
220 * The "Term->curs_hook" hook provides this package with a simple way
221 * to "move" or "draw" the cursor to the grid "x,y", depending on the
222 * setting of the "soft_cursor" flag. Note that the cursor is never
223 * redrawn if "nothing" has happened to the screen (even temporarily).
224 * This hook is required.
226 * The "Term->wipe_hook" hook provides this package with a simple way
227 * to "erase", starting at "x,y", the next "n" grids. This hook assumes
228 * that the input is valid. This hook is required, unless the setting
229 * of the "always_pict" or "always_text" flags makes it optional.
231 * The "Term->text_hook" hook provides this package with a simple way
232 * to "draw", starting at "x,y", the "n" chars contained in "cp", using
233 * the attr "a". This hook assumes that the input is valid, and that
234 * "n" is between 1 and 256 inclusive, but it should NOT assume that
235 * the contents of "cp" are null-terminated. This hook is required,
236 * unless the setting of the "always_pict" flag makes it optional.
238 * The "Term->pict_hook" hook provides this package with a simple way
239 * to "draw", starting at "x,y", the "n" attr/char pairs contained in
240 * the arrays "ap" and "cp". This hook assumes that the input is valid,
241 * and that "n" is between 1 and 256 inclusive, but it should NOT assume
242 * that the contents of "cp" are null-terminated. This hook is optional,
243 * unless the setting of the "always_pict" or "higher_pict" flags make
244 * it required. Note that recently, this hook was changed from taking
245 * a byte "a" and a char "c" to taking a length "n", an array of bytes
246 * "ap" and an array of chars "cp". Old implementations of this hook
247 * should now iterate over all "n" attr/char pairs.
250 * The game "Angband" uses a set of files called "main-xxx.c", for
251 * various "xxx" suffixes. Most of these contain a function called
252 * "init_xxx()", that will prepare the underlying visual system for
253 * use with Angband, and then create one or more "term" structures,
254 * using flags and hooks appropriate to the given platform, so that
255 * the "main()" function can call one (or more) of the "init_xxx()"
256 * functions, as appropriate, to prepare the required "term" structs
257 * (one for each desired sub-window), and these "init_xxx()" functions
258 * are called from a centralized "main()" function in "main.c". Other
259 * "main-xxx.c" systems contain their own "main()" function which, in
260 * addition to doing everything needed to initialize the actual program,
261 * also does everything that the normal "init_xxx()" functions would do.
263 * The game "Angband" defines, in addition to "attr 0", all of the
264 * attr codes from 1 to 15, using definitions in "defines.h", and
265 * thus the "main-xxx.c" files used by Angband must handle these
266 * attr values correctly. Also, they must handle all other attr
267 * values, though they may do so in any way they wish, for example,
268 * by always taking every attr code mod 16. Many of the "main-xxx.c"
269 * files use "white space" ("attr 1" / "char 32") to "erase" or "clear"
270 * any window, for efficiency.
272 * The game "Angband" uses the "Term_user" hook to allow any of the
273 * "main-xxx.c" files to interact with the user, by calling this hook
274 * whenever the user presses the "!" key when the game is waiting for
275 * a new command. This could be used, for example, to provide "unix
276 * shell commands" to the Unix versions of the game.
278 * See "main-xxx.c" for a simple skeleton file which can be used to
279 * create a "visual system" for a new platform when porting Angband.
295 /*** Local routines ***/
299 * Nuke a term_win (see below)
301 static errr term_win_nuke(term_win *s, TERM_LEN w, TERM_LEN h)
303 /* Free the window access arrays */
304 C_KILL(s->a, h, TERM_COLOR*);
305 C_KILL(s->c, h, char*);
307 /* Free the window content arrays */
308 C_KILL(s->va, h * w, TERM_COLOR);
309 C_KILL(s->vc, h * w, char);
311 /* Free the terrain access arrays */
312 C_KILL(s->ta, h, TERM_COLOR*);
313 C_KILL(s->tc, h, char*);
315 /* Free the terrain content arrays */
316 C_KILL(s->vta, h * w, TERM_COLOR);
317 C_KILL(s->vtc, h * w, char);
325 * Initialize a "term_win" (using the given window size)
327 static errr term_win_init(term_win *s, TERM_LEN w, TERM_LEN h)
331 /* Make the window access arrays */
332 C_MAKE(s->a, h, TERM_COLOR*);
333 C_MAKE(s->c, h, char*);
335 /* Make the window content arrays */
336 C_MAKE(s->va, h * w, TERM_COLOR);
337 C_MAKE(s->vc, h * w, char);
339 /* Make the terrain access arrays */
340 C_MAKE(s->ta, h, TERM_COLOR*);
341 C_MAKE(s->tc, h, char*);
343 /* Make the terrain content arrays */
344 C_MAKE(s->vta, h * w, TERM_COLOR);
345 C_MAKE(s->vtc, h * w, char);
348 /* Prepare the window access arrays */
349 for (y = 0; y < h; y++)
351 s->a[y] = s->va + w * y;
352 s->c[y] = s->vc + w * y;
354 s->ta[y] = s->vta + w * y;
355 s->tc[y] = s->vtc + w * y;
364 * Copy a "term_win" from another
366 static errr term_win_copy(term_win *s, term_win *f, TERM_LEN w, TERM_LEN h)
371 for (y = 0; y < h; y++)
373 TERM_COLOR *f_aa = f->a[y];
374 char *f_cc = f->c[y];
376 TERM_COLOR *s_aa = s->a[y];
377 char *s_cc = s->c[y];
379 TERM_COLOR *f_taa = f->ta[y];
380 char *f_tcc = f->tc[y];
382 TERM_COLOR *s_taa = s->ta[y];
383 char *s_tcc = s->tc[y];
385 for (x = 0; x < w; x++)
407 /*** External hooks ***/
411 * Execute the "Term->user_hook" hook, if available (see above).
413 errr Term_user(int n)
415 /* Verify the hook */
416 if (!Term->user_hook) return -1;
419 return ((*Term->user_hook)(n));
423 * Execute the "Term->xtra_hook" hook, if available (see above).
425 errr Term_xtra(int n, int v)
427 /* Verify the hook */
428 if (!Term->xtra_hook) return -1;
431 return ((*Term->xtra_hook)(n, v));
440 * Hack -- fake hook for "Term_curs()" (see above)
442 static errr Term_curs_hack(TERM_LEN x, TERM_LEN y)
452 * Hack -- fake hook for "Term_bigcurs()" (see above)
454 static errr Term_bigcurs_hack(TERM_LEN x, TERM_LEN y)
456 return (*Term->curs_hook)(x, y);
460 * Hack -- fake hook for "Term_wipe()" (see above)
462 static errr Term_wipe_hack(TERM_LEN x, TERM_LEN y, int n)
473 * Hack -- fake hook for "Term_text()" (see above)
475 static errr Term_text_hack(TERM_LEN x, TERM_LEN y, int n, TERM_COLOR a, concptr cp)
488 * Hack -- fake hook for "Term_pict()" (see above)
490 static errr Term_pict_hack(TERM_LEN x, TERM_LEN y, int n, const TERM_COLOR *ap, concptr cp, const TERM_COLOR *tap, concptr tcp)
506 /*** Efficient routines ***/
510 * Mentally draw an attr/char at a given location
511 * Assumes given location and values are valid.
513 void Term_queue_char(TERM_LEN x, TERM_LEN y, TERM_COLOR a, char c, TERM_COLOR ta, char tc)
515 term_win *scrn = Term->scr;
517 TERM_COLOR *scr_aa = &scrn->a[y][x];
518 char *scr_cc = &scrn->c[y][x];
520 TERM_COLOR *scr_taa = &scrn->ta[y][x];
521 char *scr_tcc = &scrn->tc[y][x];
523 /* Hack -- Ignore non-changes */
524 if ((*scr_aa == a) && (*scr_cc == c) &&
525 (*scr_taa == ta) && (*scr_tcc == tc)) return;
527 /* Save the "literal" information */
534 /* Check for new min/max row info */
535 if (y < Term->y1) Term->y1 = (byte)y;
536 if (y > Term->y2) Term->y2 = (byte)y;
538 /* Check for new min/max col info for this row */
539 if (x < Term->x1[y]) Term->x1[y] = (byte)x;
540 if (x > Term->x2[y]) Term->x2[y] = (byte)x;
543 if (((scrn->a[y][x] & AF_BIGTILE2) == AF_BIGTILE2) ||
544 (scrn->a[y][x] & AF_KANJI2))
546 if ((scrn->a[y][x] & AF_BIGTILE2) == AF_BIGTILE2)
548 if ((x - 1) < Term->x1[y]) Term->x1[y]--;
553 * Bigtile version of Term_queue_char().
554 * If use_bigtile is FALSE, simply call Term_queue_char().
555 * Otherwise, mentally draw a pair of attr/char at a given location.
556 * Assumes given location and values are valid.
558 void Term_queue_bigchar(TERM_LEN x, TERM_LEN y, TERM_COLOR a, char c, TERM_COLOR ta, char tc)
563 * A table which relates each ascii character to a multibyte
566 * 「■」は二倍幅豆腐の内部コードに使用。
568 static char ascii_to_zenkaku[] =
580 /* If non bigtile mode, call orginal function */
583 Term_queue_char(x, y, a, c, ta, tc);
587 /* A tile becomes a Bigtile */
588 if ((a & AF_TILE1) && (c & 0x80))
590 /* Mark it as a Bigtile */
595 /* Ignore non-tile background */
596 if (!((ta & AF_TILE1) && (tc & 0x80)))
605 * Use a multibyte character instead of a dirty pair of ASCII
608 else if (' ' <= c) /* isprint(c) */
610 c2 = ascii_to_zenkaku[2 * (c - ' ') + 1];
611 c = ascii_to_zenkaku[2 * (c - ' ')];
613 /* Mark it as a Kanji */
621 /* Dirty pair of ASCII characters */
626 /* Display pair of attr/char */
627 Term_queue_char(x, y, a, c, ta, tc);
628 Term_queue_char(x + 1, y, a2, c2, 0, 0);
633 * Mentally draw a string of attr/chars at a given location
635 * Assumes given location and values are valid.
637 * This function is designed to be fast, with no consistancy checking.
638 * It is used to update the map in the game.
640 void Term_queue_line(TERM_LEN x, TERM_LEN y, int n, TERM_COLOR *a, char *c, TERM_COLOR *ta, char *tc)
642 term_win *scrn = Term->scr;
647 TERM_COLOR *scr_aa = &scrn->a[y][x];
648 char *scr_cc = &scrn->c[y][x];
650 TERM_COLOR *scr_taa = &scrn->ta[y][x];
651 char *scr_tcc = &scrn->tc[y][x];
655 /* Hack -- Ignore non-changes */
656 if ((*scr_aa == *a) && (*scr_cc == *c) &&
657 (*scr_taa == *ta) && (*scr_tcc == *tc))
671 /* Save the "literal" information */
675 /* Save the "literal" information */
679 /* Track minimum changed column */
682 /* Track maximum changed column */
688 /* Expand the "change area" as needed */
691 /* Check for new min/max row info */
692 if (y < Term->y1) Term->y1 = (byte)y;
693 if (y > Term->y2) Term->y2 = (byte)y;
695 /* Check for new min/max col info in this row */
696 if (x1 < Term->x1[y]) Term->x1[y] = (byte)x1;
697 if (x2 > Term->x2[y]) Term->x2[y] = (byte)x2;
704 * Mentally draw some attr/chars at a given location
706 * Assumes that (x,y) is a valid location, that the first "n" characters
707 * of the string "s" are all valid (non-zero), and that (x+n-1,y) is also
708 * a valid location, so the first "n" characters of "s" can all be added
709 * starting at (x,y) without causing any illegal operations.
711 void Term_queue_chars(TERM_LEN x, TERM_LEN y, int n, TERM_COLOR a, concptr s)
713 TERM_LEN x1 = -1, x2 = -1;
715 TERM_COLOR *scr_aa = Term->scr->a[y];
717 char *scr_cc = Term->scr->c[y];
719 TERM_COLOR *scr_taa = Term->scr->ta[y];
720 char *scr_tcc = Term->scr->tc[y];
722 char *scr_cc = Term->scr->c[y];
724 TERM_COLOR *scr_taa = Term->scr->ta[y];
725 char *scr_tcc = Term->scr->tc[y];
731 if (n == 0 || *s == 0) return;
733 * 全角文字の右半分から文字を表示する場合、
737 if ((scr_aa[x] & AF_KANJI2) && (scr_aa[x] & AF_BIGTILE2) != AF_BIGTILE2)
740 scr_aa[x - 1] &= AF_KANJIC;
744 /* Queue the attr/chars */
745 for (; n; x++, s++, n--)
748 /* 特殊文字としてMSBが立っている可能性がある */
749 /* その場合attrのMSBも立っているのでこれで識別する */
751 if (!(a & AF_TILE1) && iskanji(*s))
756 byte na1 = (a | AF_KANJI1);
757 byte na2 = (a | AF_KANJI2);
759 if ((--n == 0) || !nc2) break;
761 if (scr_aa[x++] == na1 && scr_aa[x] == na2 &&
762 scr_cc[x - 1] == nc1 && scr_cc[x] == nc2 &&
763 (scr_taa[x - 1] == 0) && (scr_taa[x] == 0) &&
764 (scr_tcc[x - 1] == 0) && (scr_tcc[x] == 0))
772 if (x1 < 0) x1 = x - 1;
778 TERM_COLOR oa = scr_aa[x];
781 TERM_COLOR ota = scr_taa[x];
782 char otc = scr_tcc[x];
784 /* Hack -- Ignore non-changes */
785 if ((oa == a) && (oc == *s) && (ota == 0) && (otc == 0)) continue;
787 /* Save the "literal" information */
794 /* Note the "range" of window updates */
804 * 全角文字の左半分で表示を終了する場合、
806 * (条件追加:タイルの1文字目でない事を確かめるように。)
811 Term_get_size(&w, &h);
812 if (x != w && !(scr_aa[x] & AF_TILE1) && (scr_aa[x] & AF_KANJI2))
815 scr_aa[x] &= AF_KANJIC;
821 /* Expand the "change area" as needed */
824 /* Check for new min/max row info */
825 if (y < Term->y1) Term->y1 = (byte)y;
826 if (y > Term->y2) Term->y2 = (byte)y;
828 /* Check for new min/max col info in this row */
829 if (x1 < Term->x1[y]) Term->x1[y] = (byte)x1;
830 if (x2 > Term->x2[y]) Term->x2[y] = (byte)x2;
836 /*** Refresh routines ***/
840 * Flush a row of the current window (see "Term_fresh")
842 * Display text using "Term_pict()"
844 static void Term_fresh_row_pict(TERM_LEN y, TERM_LEN x1, TERM_LEN x2)
848 TERM_COLOR *old_aa = Term->old->a[y];
849 char *old_cc = Term->old->c[y];
851 TERM_COLOR *scr_aa = Term->scr->a[y];
852 char *scr_cc = Term->scr->c[y];
854 TERM_COLOR *old_taa = Term->old->ta[y];
855 char *old_tcc = Term->old->tc[y];
857 TERM_COLOR *scr_taa = Term->scr->ta[y];
858 char *scr_tcc = Term->scr->tc[y];
883 /* Scan "modified" columns */
884 for (x = x1; x <= x2; x++)
886 /* See what is currently here */
890 /* See what is desired there */
904 /* 特殊文字としてMSBが立っている可能性がある */
905 /* その場合attrのMSBも立っているのでこれで識別する */
907 kanji = (iskanji(nc) && !(na & AF_TILE1));
916 /* Handle unchanged grids */
918 if ((na == oa) && (nc == oc) && (nta == ota) && (ntc == otc)
919 && (!kanji || (scr_aa[x + 1] == old_aa[x + 1] &&
920 scr_cc[x + 1] == old_cc[x + 1] &&
921 scr_taa[x + 1] == old_taa[x + 1] &&
922 scr_tcc[x + 1] == old_tcc[x + 1])))
924 if ((na == oa) && (nc == oc) && (nta == ota) && (ntc == otc))
930 /* Draw pending attr/char pairs */
931 (void)((*Term->pict_hook)(fx, y, fn,
932 &scr_aa[fx], &scr_cc[fx], &scr_taa[fx], &scr_tcc[fx]));
950 /* Save new contents */
957 /* Restart and Advance */
958 if (fn++ == 0) fx = x;
964 /* Draw pending attr/char pairs */
965 (void)((*Term->pict_hook)(fx, y, fn,
966 &scr_aa[fx], &scr_cc[fx], &scr_taa[fx], &scr_tcc[fx]));
973 * Flush a row of the current window (see "Term_fresh")
975 * Display text using "Term_text()" and "Term_wipe()",
976 * but use "Term_pict()" for high-bit attr/char pairs
978 static void Term_fresh_row_both(TERM_LEN y, int x1, int x2)
982 TERM_COLOR *old_aa = Term->old->a[y];
983 char *old_cc = Term->old->c[y];
985 TERM_COLOR *scr_aa = Term->scr->a[y];
986 char *scr_cc = Term->scr->c[y];
988 TERM_COLOR *old_taa = Term->old->ta[y];
989 char *old_tcc = Term->old->tc[y];
990 TERM_COLOR *scr_taa = Term->scr->ta[y];
991 char *scr_tcc = Term->scr->tc[y];
998 /* The "always_text" flag */
999 int always_text = Term->always_text;
1001 /* Pending length */
1008 byte fa = Term->attr_blank;
1017 /* 全角文字の2バイト目かどうか */
1020 /* Scan "modified" columns */
1021 for (x = x1; x <= x2; x++)
1023 /* See what is currently here */
1027 /* See what is desired there */
1041 /* 特殊文字としてMSBが立っている可能性がある */
1042 /* その場合attrのMSBも立っているのでこれで識別する */
1044 /* kanji = (iskanji(nc)); */
1045 kanji = (iskanji(nc) && !(na & AF_TILE1));
1054 /* Handle unchanged grids */
1056 if ((na == oa) && (nc == oc) && (nta == ota) && (ntc == otc) &&
1057 (!kanji || (scr_aa[x + 1] == old_aa[x + 1] &&
1058 scr_cc[x + 1] == old_cc[x + 1] &&
1059 scr_taa[x + 1] == old_taa[x + 1] &&
1060 scr_tcc[x + 1] == old_tcc[x + 1])))
1062 if ((na == oa) && (nc == oc) && (nta == ota) && (ntc == otc))
1068 /* Draw pending chars (normal) */
1069 if (fa || always_text)
1071 (void)((*Term->text_hook)(fx, y, fn, fa, &scr_cc[fx]));
1074 /* Draw pending chars (black) */
1077 (void)((*Term->wipe_hook)(fx, y, fn));
1085 /* 全角文字の時は再開位置は+1 */
1097 /* Save new contents */
1104 /* 2nd byte of bigtile */
1105 if ((na & AF_BIGTILE2) == AF_BIGTILE2) continue;
1107 /* Handle high-bit attr/chars */
1108 if ((na & AF_TILE1) && (nc & 0x80))
1113 /* Draw pending chars (normal) */
1114 if (fa || always_text)
1116 (void)((*Term->text_hook)(fx, y, fn, fa, &scr_cc[fx]));
1119 /* Draw pending chars (black) */
1122 (void)((*Term->wipe_hook)(fx, y, fn));
1129 /* Hack -- Draw the special attr/char pair */
1130 (void)((*Term->pict_hook)(x, y, 1, &na, &nc, &nta, &ntc));
1136 /* Notice new color */
1138 if (fa != (na & AF_KANJIC))
1147 /* Draw the pending chars */
1148 if (fa || always_text)
1150 (void)((*Term->text_hook)(fx, y, fn, fa, &scr_cc[fx]));
1153 /* Hack -- Erase "leading" spaces */
1156 (void)((*Term->wipe_hook)(fx, y, fn));
1163 /* Save the new color */
1165 fa = (na & AF_KANJIC);
1172 /* Restart and Advance */
1173 if (fn++ == 0) fx = x;
1179 /* Draw pending chars (normal) */
1180 if (fa || always_text)
1182 (void)((*Term->text_hook)(fx, y, fn, fa, &scr_cc[fx]));
1185 /* Draw pending chars (black) */
1188 (void)((*Term->wipe_hook)(fx, y, fn));
1195 * Flush a row of the current window (see "Term_fresh")
1197 * Display text using "Term_text()" and "Term_wipe()"
1199 static void Term_fresh_row_text(TERM_LEN y, TERM_LEN x1, TERM_LEN x2)
1203 TERM_COLOR *old_aa = Term->old->a[y];
1204 char *old_cc = Term->old->c[y];
1206 TERM_COLOR *scr_aa = Term->scr->a[y];
1207 char *scr_cc = Term->scr->c[y];
1209 /* The "always_text" flag */
1210 int always_text = Term->always_text;
1212 /* Pending length */
1219 byte fa = Term->attr_blank;
1228 /* 全角文字の2バイト目かどうか */
1231 for (x = 0; x < x1; x++)
1232 if (!(old_aa[x] & AF_TILE1) && iskanji(old_cc[x]))
1243 /* Scan "modified" columns */
1244 for (x = x1; x <= x2; x++)
1246 /* See what is currently here */
1250 /* See what is desired there */
1264 /* 特殊文字としてMSBが立っている可能性がある */
1265 /* その場合attrのMSBも立っているのでこれで識別する */
1267 kanji = (iskanji(nc) && !(na & AF_TILE1));
1269 /* Handle unchanged grids */
1271 if ((na == oa) && (nc == oc) &&
1272 (!kanji || (scr_aa[x + 1] == old_aa[x + 1] &&
1273 scr_cc[x + 1] == old_cc[x + 1])))
1275 if ((na == oa) && (nc == oc))
1282 /* Draw pending chars (normal) */
1283 if (fa || always_text)
1285 (void)((*Term->text_hook)(fx, y, fn, fa, &scr_cc[fx]));
1288 /* Draw pending chars (black) */
1291 (void)((*Term->wipe_hook)(fx, y, fn));
1299 /* 全角文字の時は再開位置は+1 */
1311 /* Save new contents */
1315 /* Notice new color */
1317 if (fa != (na & AF_KANJIC))
1326 /* Draw the pending chars */
1327 if (fa || always_text)
1329 (void)((*Term->text_hook)(fx, y, fn, fa, &scr_cc[fx]));
1332 /* Hack -- Erase "leading" spaces */
1335 (void)((*Term->wipe_hook)(fx, y, fn));
1342 /* Save the new color */
1344 fa = (na & AF_KANJIC);
1351 /* Restart and Advance */
1352 if (fn++ == 0) fx = x;
1358 /* Draw pending chars (normal) */
1359 if (fa || always_text)
1361 (void)((*Term->text_hook)(fx, y, fn, fa, &scr_cc[fx]));
1364 /* Draw pending chars (black) */
1367 (void)((*Term->wipe_hook)(fx, y, fn));
1377 * Actually perform all requested changes to the window
1379 * If absolutely nothing has changed, not even temporarily, or if the
1380 * current "Term" is not mapped, then this function will return 1 and
1381 * do absolutely nothing.
1383 * Note that when "soft_cursor" is true, we erase the cursor (if needed)
1384 * whenever anything has changed, and redraw it (if needed) after all of
1385 * the screen updates are complete. This will induce a small amount of
1386 * "cursor flicker" but only when the screen has been updated. If the
1387 * screen is updated and then restored, you may still get this flicker.
1389 * When "soft_cursor" is not true, we make the cursor invisible before
1390 * doing anything else if it is supposed to be invisible by the time we
1391 * are done, and we make it visible after moving it to its final location
1392 * after all of the screen updates are complete.
1394 * Note that "Term_xtra(TERM_XTRA_CLEAR,0)" must erase the entire screen,
1395 * including the cursor, if needed, and may place the cursor anywhere.
1397 * Note that "Term_xtra(TERM_XTRA_FROSH,y)" will be always be called
1398 * after any row "y" has been "flushed", unless the "Term->never_frosh"
1399 * flag is set, and "Term_xtra(TERM_XTRA_FRESH,0)" will be called after
1400 * all of the rows have been "flushed".
1402 * Note the use of three different functions to handle the actual flush,
1403 * based on the settings of the "Term->always_pict" and "Term->higher_pict"
1404 * flags (see below).
1406 * The three helper functions (above) work by collecting similar adjacent
1407 * grids into stripes, and then sending each stripe to "Term->pict_hook",
1408 * "Term->text_hook", or "Term->wipe_hook", based on the settings of the
1409 * "Term->always_pict" and "Term->higher_pict" flags, which select which
1410 * of the helper functions to call to flush each row.
1412 * The helper functions currently "skip" any grids which already contain
1413 * the desired contents. This may or may not be the best method, especially
1414 * when the desired content fits nicely into the current stripe. For example,
1415 * it might be better to go ahead and queue them while allowed, but keep a
1416 * count of the "trailing skipables", then, when time to flush, or when a
1417 * "non skippable" is found, force a flush if there are too many skippables.
1419 * Perhaps an "initialization" stage, where the "text" (and "attr")
1420 * buffers are "filled" with information, converting "blanks" into
1421 * a convenient representation, and marking "skips" with "zero chars",
1422 * and then some "processing" is done to determine which chars to skip.
1424 * Currently, the helper functions are optimal for systems which prefer
1425 * to "print a char + move a char + print a char" to "print three chars",
1426 * and for applications that do a lot of "detailed" color printing.
1428 * In the two "queue" functions, total "non-changes" are "pre-skipped".
1429 * The helper functions must also handle situations in which the contents
1430 * of a grid are changed, but then changed back to the original value,
1431 * and situations in which two grids in the same row are changed, but
1432 * the grids between them are unchanged.
1434 * If the "Term->always_pict" flag is set, then "Term_fresh_row_pict()"
1435 * will be used instead of "Term_fresh_row_text()". This allows all the
1436 * modified grids to be collected into stripes of attr/char pairs, which
1437 * are then sent to the "Term->pict_hook" hook, which can draw these pairs
1438 * in whatever way it would like.
1440 * If the "Term->higher_pict" flag is set, then "Term_fresh_row_both()"
1441 * will be used instead of "Term_fresh_row_text()". This allows all the
1442 * "special" attr/char pairs (in which both the attr and char have the
1443 * high-bit set) to be sent (one pair at a time) to the "Term->pict_hook"
1444 * hook, which can draw these pairs in whatever way it would like.
1446 * Normally, the "Term_wipe()" function is used only to display "blanks"
1447 * that were induced by "Term_clear()" or "Term_erase()", and then only
1448 * if the "attr_blank" and "char_blank" fields have not been redefined
1449 * to use "white space" instead of the default "black space". Actually,
1450 * the "Term_wipe()" function is used to display all "black" text, such
1451 * as the default "spaces" created by "Term_clear()" and "Term_erase()".
1453 * Note that the "Term->always_text" flag will disable the use of the
1454 * "Term_wipe()" function hook entirely, and force all text, even text
1455 * drawn in the color "black", to be explicitly drawn. This is useful
1456 * for machines which implement "Term_wipe()" by just drawing spaces.
1458 * Note that the "Term->always_pict" flag will disable the use of the
1459 * "Term_wipe()" function entirely, and force everything, even text
1460 * drawn in the attr "black", to be explicitly drawn.
1462 * Note that if no "black" text is ever drawn, and if "attr_blank" is
1463 * not "zero", then the "Term_wipe" hook will never be used, even if
1464 * the "Term->always_text" flag is not set.
1466 * This function does nothing unless the "Term" is "mapped", which allows
1467 * certain systems to optimize the handling of "closed" windows.
1469 * On systems with a "soft" cursor, we must explicitly erase the cursor
1470 * before flushing the output, if needed, to prevent a "jumpy" refresh.
1471 * The actual method for this is horrible, but there is very little that
1472 * we can do to simplify it efficiently.
1474 * On systems with a "hard" cursor, we will "hide" the cursor before
1475 * flushing the output, if needed, to avoid a "flickery" refresh. It
1476 * would be nice to *always* hide the cursor during the refresh, but
1477 * this might be expensive (and/or ugly) on some machines.
1479 * The "Term->icky_corner" flag is used to avoid calling "Term_wipe()"
1480 * or "Term_pict()" or "Term_text()" on the bottom right corner of the
1481 * window, which might induce "scrolling" or other nasty stuff on old
1482 * dumb terminals. This flag is handled very efficiently. We assume
1483 * that the "Term_curs()" call will prevent placing the cursor in the
1484 * corner, if needed, though I doubt such placement is ever a problem.
1485 * Currently, the use of "Term->icky_corner" and "Term->soft_cursor"
1486 * together may result in undefined behavior.
1488 errr Term_fresh(void)
1498 term_win *old = Term->old;
1499 term_win *scr = Term->scr;
1501 /* Before initialize (Advice from Mr.shimitei)*/
1502 if (!old || !scr) return 1;
1504 /* Do nothing unless "mapped" */
1505 if (!Term->mapped_flag) return 1;
1508 /* Trivial Refresh */
1510 (scr->cu == old->cu) &&
1511 (scr->cv == old->cv) &&
1512 (scr->cx == old->cx) &&
1513 (scr->cy == old->cy) &&
1514 !(Term->total_erase))
1521 /* Handle "total erase" */
1522 if (Term->total_erase)
1524 byte na = Term->attr_blank;
1525 char nc = Term->char_blank;
1527 /* Physically erase the entire window */
1528 Term_xtra(TERM_XTRA_CLEAR, 0);
1530 /* Hack -- clear all "cursor" data */
1531 old->cv = old->cu = old->cx = old->cy = 0;
1534 for (y = 0; y < h; y++)
1536 TERM_COLOR *aa = old->a[y];
1537 char *cc = old->c[y];
1539 TERM_COLOR *taa = old->ta[y];
1540 char *tcc = old->tc[y];
1543 /* Wipe each column */
1544 for (x = 0; x < w; x++)
1546 /* Wipe each grid */
1555 /* Redraw every row */
1557 Term->y2 = y2 = h - 1;
1559 /* Redraw every column */
1560 for (y = 0; y < h; y++)
1563 Term->x2[y] = w - 1;
1566 /* Forget "total erase" */
1567 Term->total_erase = FALSE;
1571 /* Cursor update -- Erase old Cursor */
1572 if (Term->soft_cursor)
1574 /* Cursor was visible */
1575 if (!old->cu && old->cv)
1578 TERM_LEN tx = old->cx;
1579 TERM_LEN ty = old->cy;
1581 TERM_COLOR *old_aa = old->a[ty];
1582 char *old_cc = old->c[ty];
1584 TERM_COLOR *old_taa = old->ta[ty];
1585 char *old_tcc = old->tc[ty];
1587 TERM_COLOR ota = old_taa[tx];
1588 char otc = old_tcc[tx];
1591 if (tx + 1 < Term->wid && !(old_aa[tx] & AF_TILE1)
1592 && iskanji(old_cc[tx]))
1595 /* Hack -- use "Term_pict()" always */
1596 if (Term->always_pict)
1598 (void)((*Term->pict_hook)(tx, ty, csize, &old_aa[tx], &old_cc[tx], &ota, &otc));
1601 /* Hack -- use "Term_pict()" sometimes */
1602 else if (Term->higher_pict && (old_aa[tx] & AF_TILE1) && (old_cc[tx] & 0x80))
1604 (void)((*Term->pict_hook)(tx, ty, 1, &old_aa[tx], &old_cc[tx], &ota, &otc));
1608 * Hack -- restore the actual character
1609 * 元の文字の描画範囲がカーソルより小さいと、
1610 * 上書きされなかった部分がゴミとして残る。
1611 * wipe_hook でカーソルを消去して text_hook で書き直す。
1613 else if (old_aa[tx] || Term->always_text)
1615 (void)((*Term->wipe_hook)(tx, ty, 1));
1616 (void)((*Term->text_hook)(tx, ty, csize, (unsigned char)(old_aa[tx] & 0xf), &old_cc[tx]));
1619 /* Hack -- erase the grid */
1622 (void)((*Term->wipe_hook)(tx, ty, 1));
1627 /* Cursor Update -- Erase old Cursor */
1630 /* Cursor will be invisible */
1631 if (scr->cu || !scr->cv)
1633 /* Make the cursor invisible */
1634 Term_xtra(TERM_XTRA_SHAPE, 0);
1639 /* Something to update */
1642 /* Handle "icky corner" */
1643 if (Term->icky_corner)
1645 /* Avoid the corner */
1648 /* Avoid the corner */
1649 if (Term->x2[h - 1] > w - 2)
1651 /* Avoid the corner */
1652 Term->x2[h - 1] = w - 2;
1658 /* Scan the "modified" rows */
1659 for (y = y1; y <= y2; ++y)
1661 TERM_LEN x1 = Term->x1[y];
1662 TERM_LEN x2 = Term->x2[y];
1664 /* Flush each "modified" row */
1667 /* Always use "Term_pict()" */
1668 if (Term->always_pict)
1671 Term_fresh_row_pict(y, x1, x2);
1674 /* Sometimes use "Term_pict()" */
1675 else if (Term->higher_pict)
1678 Term_fresh_row_both(y, x1, x2);
1681 /* Never use "Term_pict()" */
1685 Term_fresh_row_text(y, x1, x2);
1688 /* This row is all done */
1689 Term->x1[y] = (byte)w;
1692 /* Hack -- Flush that row (if allowed) */
1693 if (!Term->never_frosh) Term_xtra(TERM_XTRA_FROSH, y);
1697 /* No rows are invalid */
1703 /* Cursor update -- Show new Cursor */
1704 if (Term->soft_cursor)
1706 /* Draw the cursor */
1707 if (!scr->cu && scr->cv)
1710 if ((scr->cx + 1 < w) &&
1711 ((old->a[scr->cy][scr->cx + 1] & AF_BIGTILE2) == AF_BIGTILE2 ||
1712 (!(old->a[scr->cy][scr->cx] & AF_TILE1) &&
1713 iskanji(old->c[scr->cy][scr->cx]))))
1715 if ((scr->cx + 1 < w) && (old->a[scr->cy][scr->cx + 1] & AF_BIGTILE2) == AF_BIGTILE2)
1718 /* Double width cursor for the Bigtile mode */
1719 (void)((*Term->bigcurs_hook)(scr->cx, scr->cy));
1723 /* Call the cursor display routine */
1724 (void)((*Term->curs_hook)(scr->cx, scr->cy));
1729 /* Cursor Update -- Show new Cursor */
1732 /* The cursor is useless, hide it */
1735 /* Paranoia -- Put the cursor NEAR where it belongs */
1736 (void)((*Term->curs_hook)(w - 1, scr->cy));
1738 /* Make the cursor invisible */
1739 /* Term_xtra(TERM_XTRA_SHAPE, 0); */
1742 /* The cursor is invisible, hide it */
1745 /* Paranoia -- Put the cursor where it belongs */
1746 (void)((*Term->curs_hook)(scr->cx, scr->cy));
1748 /* Make the cursor invisible */
1749 /* Term_xtra(TERM_XTRA_SHAPE, 0); */
1752 /* The cursor is visible, display it correctly */
1755 /* Put the cursor where it belongs */
1756 (void)((*Term->curs_hook)(scr->cx, scr->cy));
1758 /* Make the cursor visible */
1759 Term_xtra(TERM_XTRA_SHAPE, 1);
1764 /* Save the "cursor state" */
1771 /* Actually flush the output */
1772 Term_xtra(TERM_XTRA_FRESH, 0);
1781 /*** Output routines ***/
1785 * Set the cursor visibility
1787 errr Term_set_cursor(int v)
1790 if (Term->scr->cv == v) return 1;
1793 Term->scr->cv = (bool_hack)v;
1801 * Place the cursor at a given location
1803 * Note -- "illegal" requests do not move the cursor.
1805 errr Term_gotoxy(TERM_LEN x, TERM_LEN y)
1811 if ((x < 0) || (x >= w)) return -1;
1812 if ((y < 0) || (y >= h)) return -1;
1814 /* Remember the cursor */
1815 Term->scr->cx = (byte)x;
1816 Term->scr->cy = (byte)y;
1818 /* The cursor is not useless */
1827 * At a given location, place an attr/char
1828 * Do not change the cursor position
1829 * No visual changes until "Term_fresh()".
1831 errr Term_draw(TERM_LEN x, TERM_LEN y, TERM_COLOR a, char c)
1836 if ((x < 0) || (x >= w)) return -1;
1837 if ((y < 0) || (y >= h)) return -1;
1839 /* Paranoia -- illegal char */
1840 if (!c) return (-2);
1842 /* Queue it for later */
1843 Term_queue_char(x, y, a, c, 0, 0);
1851 * Using the given attr, add the given char at the cursor.
1853 * We return "-2" if the character is "illegal". XXX XXX
1855 * We return "-1" if the cursor is currently unusable.
1857 * We queue the given attr/char for display at the current
1858 * cursor location, and advance the cursor to the right,
1859 * marking it as unuable and returning "1" if it leaves
1860 * the screen, and otherwise returning "0".
1862 * So when this function, or the following one, return a
1863 * positive value, future calls to either function will
1864 * return negative ones.
1866 errr Term_addch(TERM_COLOR a, char c)
1868 TERM_LEN w = Term->wid;
1870 /* Handle "unusable" cursor */
1871 if (Term->scr->cu) return -1;
1873 /* Paranoia -- no illegal chars */
1874 if (!c) return (-2);
1876 /* Queue the given character for display */
1877 Term_queue_char(Term->scr->cx, Term->scr->cy, a, c, 0, 0);
1879 /* Advance the cursor */
1883 if (Term->scr->cx < w) return 0;
1885 /* Note "Useless" cursor */
1888 /* Note "Useless" cursor */
1894 * Bigtile version of Term_addch().
1896 * If use_bigtile is FALSE, simply call Term_addch() .
1898 * Otherwise, queue a pair of attr/char for display at the current
1899 * cursor location, and advance the cursor to the right by two.
1901 errr Term_add_bigch(TERM_COLOR a, char c)
1903 if (!use_bigtile) return Term_addch(a, c);
1905 /* Handle "unusable" cursor */
1906 if (Term->scr->cu) return -1;
1908 /* Paranoia -- no illegal chars */
1909 if (!c) return (-2);
1911 /* Queue the given character for display */
1912 Term_queue_bigchar(Term->scr->cx, Term->scr->cy, a, c, 0, 0);
1914 /* Advance the cursor */
1918 if (Term->scr->cx < Term->wid) return 0;
1920 /* Note "Useless" cursor */
1923 /* Note "Useless" cursor */
1929 * At the current location, using an attr, add a string
1931 * We also take a length "n", using negative values to imply
1932 * the largest possible value, and then we use the minimum of
1933 * this length and the "actual" length of the string as the
1934 * actual number of characters to attempt to display, never
1935 * displaying more characters than will actually fit, since
1936 * we do NOT attempt to "wrap" the cursor at the screen edge.
1938 * We return "-1" if the cursor is currently unusable.
1939 * We return "N" if we were "only" able to write "N" chars,
1940 * even if all of the given characters fit on the screen,
1941 * and mark the cursor as unusable for future attempts.
1943 * So when this function, or the preceding one, return a
1944 * positive value, future calls to either function will
1945 * return negative ones.
1947 errr Term_addstr(int n, TERM_COLOR a, concptr s)
1950 TERM_LEN w = Term->wid;
1953 /* Handle "unusable" cursor */
1954 if (Term->scr->cu) return -1;
1956 /* Obtain maximal length */
1957 k = (n < 0) ? (w + 1) : n;
1959 /* Obtain the usable string length */
1960 for (n = 0; (n < k) && s[n]; n++) /* loop */;
1962 /* React to reaching the edge of the screen */
1963 if (Term->scr->cx + n >= w) res = n = w - Term->scr->cx;
1965 /* Queue the first "n" characters for display */
1966 Term_queue_chars(Term->scr->cx, Term->scr->cy, n, a, s);
1968 /* Advance the cursor */
1969 Term->scr->cx += (byte)n;
1971 /* Hack -- Notice "Useless" cursor */
1972 if (res) Term->scr->cu = 1;
1974 /* Success (usually) */
1980 * Move to a location and, using an attr, add a char
1982 errr Term_putch(TERM_LEN x, TERM_LEN y, TERM_COLOR a, char c)
1987 if ((res = Term_gotoxy(x, y)) != 0) return (res);
1989 /* Then add the char */
1990 if ((res = Term_addch(a, c)) != 0) return (res);
1998 * Move to a location and, using an attr, add a string
2000 errr Term_putstr(TERM_LEN x, TERM_LEN y, int n, TERM_COLOR a, concptr s)
2005 if ((res = Term_gotoxy(x, y)) != 0) return (res);
2007 /* Then add the string */
2008 if ((res = Term_addstr(n, a, s)) != 0) return (res);
2016 * Move to a location and, using an attr, add a string vertically
2018 errr Term_putstr_v(TERM_LEN x, TERM_LEN y, int n, byte a, concptr s)
2025 for (i = 0; i < n && s[i] != 0; i++)
2028 if ((res = Term_gotoxy(x, y0)) != 0) return (res);
2032 if ((res = Term_addstr(2, a, &s[i])) != 0) return (res);
2035 if (s[i] == 0) break;
2038 if ((res = Term_addstr(1, a, &s[i])) != 0) return (res);
2049 * Place cursor at (x,y), and clear the next "n" chars
2051 errr Term_erase(TERM_LEN x, TERM_LEN y, int n)
2055 TERM_LEN w = Term->wid;
2056 /* int h = Term->hgt; */
2061 int na = Term->attr_blank;
2062 int nc = Term->char_blank;
2067 TERM_COLOR *scr_taa;
2071 if (Term_gotoxy(x, y)) return -1;
2073 /* Force legal size */
2074 if (x + n > w) n = w - x;
2077 scr_aa = Term->scr->a[y];
2078 scr_cc = Term->scr->c[y];
2080 scr_taa = Term->scr->ta[y];
2081 scr_tcc = Term->scr->tc[y];
2085 * 全角文字の右半分から文字を表示する場合、
2088 if (n > 0 && (((scr_aa[x] & AF_KANJI2) && !(scr_aa[x] & AF_TILE1))
2089 || (scr_aa[x] & AF_BIGTILE2) == AF_BIGTILE2))
2091 if (n > 0 && (scr_aa[x] & AF_BIGTILE2) == AF_BIGTILE2)
2098 /* Scan every column */
2099 for (i = 0; i < n; i++, x++)
2104 /* Hack -- Ignore "non-changes" */
2105 if ((oa == na) && (oc == nc)) continue;
2109 * 全角文字の左半分で表示を終了する場合、
2112 * 2001/04/29 -- Habu
2113 * 行の右端の場合はこの処理をしないように修正。
2115 if ((oa & AF_KANJI1) && (i + 1) == n && x != w - 1)
2118 /* Save the "literal" information */
2119 scr_aa[x] = (byte)na;
2120 scr_cc[x] = (char)nc;
2125 /* Track minimum changed column */
2128 /* Track maximum changed column */
2132 /* Expand the "change area" as needed */
2135 /* Check for new min/max row info */
2136 if (y < Term->y1) Term->y1 = (byte)y;
2137 if (y > Term->y2) Term->y2 = (byte)y;
2139 /* Check for new min/max col info in this row */
2140 if (x1 < Term->x1[y]) Term->x1[y] = (byte)x1;
2141 if (x2 > Term->x2[y]) Term->x2[y] = (byte)x2;
2150 * Clear the entire window, and move to the top left corner
2152 * Note the use of the special "total_erase" code
2154 errr Term_clear(void)
2158 TERM_LEN w = Term->wid;
2159 TERM_LEN h = Term->hgt;
2161 TERM_COLOR na = Term->attr_blank;
2162 char nc = Term->char_blank;
2167 /* Cursor to the top left */
2168 Term->scr->cx = Term->scr->cy = 0;
2171 for (y = 0; y < h; y++)
2173 TERM_COLOR *scr_aa = Term->scr->a[y];
2174 char *scr_cc = Term->scr->c[y];
2176 TERM_COLOR *scr_taa = Term->scr->ta[y];
2177 char *scr_tcc = Term->scr->tc[y];
2179 /* Wipe each column */
2180 for (x = 0; x < w; x++)
2189 /* This row has changed */
2191 Term->x2[y] = w - 1;
2194 /* Every row has changed */
2198 /* Force "total erase" */
2199 Term->total_erase = TRUE;
2210 * Redraw (and refresh) the whole window.
2212 errr Term_redraw(void)
2214 /* Force "total erase" */
2215 Term->total_erase = TRUE;
2217 /* Hack -- Refresh */
2226 * Redraw part of a window.
2228 errr Term_redraw_section(TERM_LEN x1, TERM_LEN y1, TERM_LEN x2, TERM_LEN y2)
2234 /* Bounds checking */
2235 if (y2 >= Term->hgt) y2 = Term->hgt - 1;
2236 if (x2 >= Term->wid) x2 = Term->wid - 1;
2241 Term->y1 = (byte)y1;
2242 Term->y2 = (byte)y2;
2244 /* Set the x limits */
2245 for (i = Term->y1; i <= Term->y2; i++)
2253 if (Term->scr->a[i][x1j] & AF_KANJI2) x1j--;
2256 if (x2j < Term->wid - 1)
2258 if (Term->scr->a[i][x2j] & AF_KANJI1) x2j++;
2261 Term->x1[i] = (byte)x1j;
2262 Term->x2[i] = (byte)x2j;
2264 g_ptr = Term->old->c[i];
2266 /* Clear the section so it is redrawn */
2267 for (j = x1j; j <= x2j; j++)
2269 /* Hack - set the old character to "none" */
2276 g_ptr = Term->old->c[i];
2278 /* Clear the section so it is redrawn */
2279 for (j = x1; j <= x2; j++)
2281 /* Hack - set the old character to "none" */
2287 /* Hack -- Refresh */
2296 /*** Access routines ***/
2300 * Extract the cursor visibility
2302 errr Term_get_cursor(int *v)
2304 /* Extract visibility */
2305 (*v) = Term->scr->cv;
2313 * Extract the current window size
2315 errr Term_get_size(TERM_LEN *w, TERM_LEN *h)
2317 /* Access the cursor */
2327 * Extract the current cursor location
2329 errr Term_locate(TERM_LEN *x, TERM_LEN *y)
2331 /* Access the cursor */
2332 (*x) = Term->scr->cx;
2333 (*y) = Term->scr->cy;
2335 /* Warn about "useless" cursor */
2336 if (Term->scr->cu) return 1;
2344 * At a given location, determine the "current" attr and char
2345 * Note that this refers to what will be on the window after the
2346 * next call to "Term_fresh()". It may or may not already be there.
2348 errr Term_what(TERM_LEN x, TERM_LEN y, TERM_COLOR *a, char *c)
2350 TERM_LEN w = Term->wid;
2351 TERM_LEN h = Term->hgt;
2353 if ((x < 0) || (x >= w)) return -1;
2354 if ((y < 0) || (y >= h)) return -1;
2357 (*a) = Term->scr->a[y][x];
2358 (*c) = Term->scr->c[y][x];
2366 /*** Input routines ***/
2370 * Flush and forget the input
2372 errr Term_flush(void)
2374 /* Hack -- Flush all events */
2375 Term_xtra(TERM_XTRA_FLUSH, 0);
2377 /* Forget all keypresses */
2378 Term->key_head = Term->key_tail = 0;
2387 * Add a keypress to the "queue"
2389 errr Term_keypress(int k)
2391 /* Hack -- Refuse to enqueue non-keys */
2394 /* Store the char, advance the queue */
2395 Term->key_queue[Term->key_head++] = (char)k;
2397 /* Circular queue, handle wrap */
2398 if (Term->key_head == Term->key_size) Term->key_head = 0;
2400 /* Success (unless overflow) */
2401 if (Term->key_head != Term->key_tail) return 0;
2409 * Add a keypress to the FRONT of the "queue"
2411 errr Term_key_push(int k)
2413 /* Hack -- Refuse to enqueue non-keys */
2416 /* Hack -- Overflow may induce circular queue */
2417 if (Term->key_tail == 0) Term->key_tail = Term->key_size;
2419 /* Back up, Store the char */
2420 Term->key_queue[--Term->key_tail] = (char)k;
2422 /* Success (unless overflow) */
2423 if (Term->key_head != Term->key_tail) return 0;
2434 * Check for a pending keypress on the key queue.
2436 * Store the keypress, if any, in "ch", and return "0".
2437 * Otherwise store "zero" in "ch", and return "1".
2439 * Wait for a keypress if "wait" is true.
2441 * Remove the keypress if "take" is true.
2443 errr Term_inkey(char *ch, bool wait, bool take)
2452 /* Hack -- get bored */
2453 if (!Term->never_bored)
2455 /* Process random events */
2456 Term_xtra(TERM_XTRA_BORED, 0);
2462 /* Process pending events while necessary */
2463 while (Term->key_head == Term->key_tail)
2465 /* Process events (wait for one) */
2466 Term_xtra(TERM_XTRA_EVENT, TRUE);
2473 /* Process pending events if necessary */
2474 if (Term->key_head == Term->key_tail)
2476 /* Process events (do not wait) */
2477 Term_xtra(TERM_XTRA_EVENT, FALSE);
2481 /* No keys are ready */
2482 if (Term->key_head == Term->key_tail) return 1;
2484 /* Extract the next keypress */
2485 (*ch) = Term->key_queue[Term->key_tail];
2487 /* If requested, advance the queue, wrap around if necessary */
2488 if (take && (++Term->key_tail == Term->key_size)) Term->key_tail = 0;
2496 /*** Extra routines ***/
2500 * Save the "requested" screen into the "memorized" screen
2502 * Every "Term_save()" should match exactly one "Term_load()"
2504 errr Term_save(void)
2506 TERM_LEN w = Term->wid;
2507 TERM_LEN h = Term->hgt;
2512 /* Allocate window */
2513 MAKE(Term->mem, term_win);
2515 /* Initialize window */
2516 term_win_init(Term->mem, w, h);
2520 term_win_copy(Term->mem, Term->scr, w, h);
2528 * Restore the "requested" contents (see above).
2530 * Every "Term_save()" should match exactly one "Term_load()"
2532 errr Term_load(void)
2536 TERM_LEN w = Term->wid;
2537 TERM_LEN h = Term->hgt;
2542 /* Allocate window */
2543 MAKE(Term->mem, term_win);
2545 /* Initialize window */
2546 term_win_init(Term->mem, w, h);
2550 term_win_copy(Term->scr, Term->mem, w, h);
2553 for (y = 0; y < h; y++)
2557 Term->x2[y] = w - 1;
2570 * Exchange the "requested" screen with the "tmp" screen
2572 errr Term_exchange(void)
2576 TERM_LEN w = Term->wid;
2577 TERM_LEN h = Term->hgt;
2579 term_win *exchanger;
2585 /* Allocate window */
2586 MAKE(Term->tmp, term_win);
2588 /* Initialize window */
2589 term_win_init(Term->tmp, w, h);
2593 exchanger = Term->scr;
2594 Term->scr = Term->tmp;
2595 Term->tmp = exchanger;
2598 for (y = 0; y < h; y++)
2602 Term->x2[y] = w - 1;
2616 * React to a new physical window size.
2618 errr Term_resize(TERM_LEN w, TERM_LEN h)
2632 /* Resizing is forbidden */
2633 if (Term->fixed_shape) return -1;
2635 /* Ignore illegal changes */
2636 if ((w < 1) || (h < 1)) return -1;
2639 /* Ignore non-changes */
2640 if ((Term->wid == w) && (Term->hgt == h) && (arg_bigtile == use_bigtile))
2643 use_bigtile = arg_bigtile;
2645 /* Minimum dimensions */
2646 wid = MIN(Term->wid, w);
2647 hgt = MIN(Term->hgt, h);
2653 /* Save old window */
2654 hold_old = Term->old;
2656 /* Save old window */
2657 hold_scr = Term->scr;
2659 /* Save old window */
2660 hold_mem = Term->mem;
2662 /* Save old window */
2663 hold_tmp = Term->tmp;
2665 /* Create new scanners */
2666 C_MAKE(Term->x1, h, TERM_LEN);
2667 C_MAKE(Term->x2, h, TERM_LEN);
2669 /* Create new window */
2670 MAKE(Term->old, term_win);
2672 /* Initialize new window */
2673 term_win_init(Term->old, w, h);
2675 /* Save the contents */
2676 term_win_copy(Term->old, hold_old, wid, hgt);
2678 /* Create new window */
2679 MAKE(Term->scr, term_win);
2681 /* Initialize new window */
2682 term_win_init(Term->scr, w, h);
2684 /* Save the contents */
2685 term_win_copy(Term->scr, hold_scr, wid, hgt);
2690 /* Create new window */
2691 MAKE(Term->mem, term_win);
2693 /* Initialize new window */
2694 term_win_init(Term->mem, w, h);
2696 /* Save the contents */
2697 term_win_copy(Term->mem, hold_mem, wid, hgt);
2703 /* Create new window */
2704 MAKE(Term->tmp, term_win);
2706 /* Initialize new window */
2707 term_win_init(Term->tmp, w, h);
2709 /* Save the contents */
2710 term_win_copy(Term->tmp, hold_tmp, wid, hgt);
2713 /* Free some arrays */
2714 C_KILL(hold_x1, Term->hgt, TERM_LEN);
2715 C_KILL(hold_x2, Term->hgt, TERM_LEN);
2718 term_win_nuke(hold_old, Term->wid, Term->hgt);
2721 KILL(hold_old, term_win);
2723 /* Illegal cursor */
2724 if (Term->old->cx >= w) Term->old->cu = 1;
2725 if (Term->old->cy >= h) Term->old->cu = 1;
2728 term_win_nuke(hold_scr, Term->wid, Term->hgt);
2731 KILL(hold_scr, term_win);
2733 /* Illegal cursor */
2734 if (Term->scr->cx >= w) Term->scr->cu = 1;
2735 if (Term->scr->cy >= h) Term->scr->cu = 1;
2741 term_win_nuke(hold_mem, Term->wid, Term->hgt);
2744 KILL(hold_mem, term_win);
2746 /* Illegal cursor */
2747 if (Term->mem->cx >= w) Term->mem->cu = 1;
2748 if (Term->mem->cy >= h) Term->mem->cu = 1;
2755 term_win_nuke(hold_tmp, Term->wid, Term->hgt);
2758 KILL(hold_tmp, term_win);
2760 /* Illegal cursor */
2761 if (Term->tmp->cx >= w) Term->tmp->cu = 1;
2762 if (Term->tmp->cy >= h) Term->tmp->cu = 1;
2769 /* Force "total erase" */
2770 Term->total_erase = TRUE;
2773 for (i = 0; i < h; i++)
2777 Term->x2[i] = w - 1;
2784 /* Execute the "resize_hook" hook, if available */
2785 if (Term->resize_hook)
2787 Term->resize_hook();
2797 * Activate a new Term (and deactivate the current Term)
2799 * This function is extremely important, and also somewhat bizarre.
2800 * It is the only function that should "modify" the value of "Term".
2802 * To "create" a valid "term", one should do "term_init(t)", then
2803 * set the various flags and hooks, and then do "Term_activate(t)".
2805 errr Term_activate(term *t)
2807 /* Hack -- already done */
2808 if (Term == t) return 1;
2810 /* Deactivate the old Term */
2811 if (Term) Term_xtra(TERM_XTRA_LEVEL, 0);
2813 /* Hack -- Call the special "init" hook */
2814 if (t && !t->active_flag)
2816 /* Call the "init" hook */
2817 if (t->init_hook) (*t->init_hook)(t);
2820 t->active_flag = TRUE;
2823 t->mapped_flag = TRUE;
2826 /* Remember the Term */
2829 /* Activate the new Term */
2830 if (Term) Term_xtra(TERM_XTRA_LEVEL, 1);
2841 errr term_nuke(term *t)
2843 TERM_LEN w = t->wid;
2844 TERM_LEN h = t->hgt;
2847 /* Hack -- Call the special "nuke" hook */
2850 /* Call the "nuke" hook */
2851 if (t->nuke_hook) (*t->nuke_hook)(t);
2854 t->active_flag = FALSE;
2856 /* Assume not mapped */
2857 t->mapped_flag = FALSE;
2861 /* Nuke "displayed" */
2862 term_win_nuke(t->old, w, h);
2864 /* Kill "displayed" */
2865 KILL(t->old, term_win);
2867 /* Nuke "requested" */
2868 term_win_nuke(t->scr, w, h);
2870 /* Kill "requested" */
2871 KILL(t->scr, term_win);
2876 /* Nuke "memorized" */
2877 term_win_nuke(t->mem, w, h);
2879 /* Kill "memorized" */
2880 KILL(t->mem, term_win);
2886 /* Nuke "temporary" */
2887 term_win_nuke(t->tmp, w, h);
2889 /* Kill "temporary" */
2890 KILL(t->tmp, term_win);
2893 /* Free some arrays */
2894 C_KILL(t->x1, h, TERM_LEN);
2895 C_KILL(t->x2, h, TERM_LEN);
2897 /* Free the input queue */
2898 C_KILL(t->key_queue, t->key_size, char);
2906 * Initialize a term, using a window of the given size.
2907 * Also prepare the "input queue" for "k" keypresses
2908 * By default, the cursor starts out "invisible"
2909 * By default, we "erase" using "black spaces"
2911 errr term_init(term *t, TERM_LEN w, TERM_LEN h, int k)
2917 (void)WIPE(t, term);
2920 /* Prepare the input queue */
2921 t->key_head = t->key_tail = 0;
2923 /* Determine the input queue size */
2924 t->key_size = (u16b)k;
2926 /* Allocate the input queue */
2927 C_MAKE(t->key_queue, t->key_size, char);
2934 /* Allocate change arrays */
2935 C_MAKE(t->x1, h, TERM_LEN);
2936 C_MAKE(t->x2, h, TERM_LEN);
2939 /* Allocate "displayed" */
2940 MAKE(t->old, term_win);
2942 /* Initialize "displayed" */
2943 term_win_init(t->old, w, h);
2946 /* Allocate "requested" */
2947 MAKE(t->scr, term_win);
2949 /* Initialize "requested" */
2950 term_win_init(t->scr, w, h);
2954 for (y = 0; y < h; y++)
2965 /* Force "total erase" */
2966 t->total_erase = TRUE;
2969 /* Default "blank" */
2971 t->char_blank = ' ';
2974 /* Prepare "fake" hooks to prevent core dumps */
2975 t->curs_hook = Term_curs_hack;
2976 t->bigcurs_hook = Term_bigcurs_hack;
2977 t->wipe_hook = Term_wipe_hack;
2978 t->text_hook = Term_text_hack;
2979 t->pict_hook = Term_pict_hack;