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- */
18 /* Special flags in the attr data */
19 #define AF_BIGTILE2 0xf0
23 #define AF_KANJI1 0x10
24 #define AF_KANJI2 0x20
25 #define AF_KANJIC 0x0f
28 * °À¤ËÁ´³Ñʸ»ú¤Î£±¥Ð¥¤¥ÈÌÜ¡¢£²¥Ð¥¤¥ÈÌܤ⵲±¡£
33 * This file provides a generic, efficient, terminal window package,
34 * which can be used not only on standard terminal environments such
35 * as dumb terminals connected to a Unix box, but also in more modern
36 * "graphic" environments, such as the Macintosh or Unix/X11.
38 * Each "window" works like a standard "dumb terminal", that is, it
39 * can display a two dimensional array of grids containing colored
40 * textual symbols, plus an optional cursor, and it can be used to
41 * get keypress events from the user.
43 * In fact, this package can simply be used, if desired, to support
44 * programs which will look the same on a dumb terminal as they do
45 * on a graphic platform such as the Macintosh.
47 * This package was designed to help port the game "Angband" to a wide
48 * variety of different platforms. Angband, like many other games in
49 * the "rogue-like" heirarchy, requires, at the minimum, the ability
50 * to display "colored textual symbols" in a standard 80x24 "window",
51 * such as that provided by most dumb terminals, and many old personal
52 * computers, and to check for "keypresses" from the user. The major
53 * concerns were thus portability and efficiency, so Angband could be
54 * easily ported to many different systems, with minimal effort, and
55 * yet would run quickly on each of these systems, no matter what kind
56 * of underlying hardware/software support was being used.
58 * It is important to understand the differences between the older
59 * "dumb terminals" and the newer "graphic interface" machines, since
60 * this package was designed to work with both types of systems.
63 * waiting for a keypress is complex
64 * checking for a keypress is often cheap
65 * changing "colors" may be expensive
66 * the "color" of a "blank" is rarely important
67 * moving the "cursor" is relatively cheap
68 * use a "software" cursor (only moves when requested)
69 * drawing characters normally will not erase old ones
70 * drawing a character on the cursor often erases it
71 * may have fast routines for "clear a region"
72 * the bottom right corner is usually not special
75 * waiting for a keypress is simple
76 * checking for a keypress is often expensive
77 * changing "colors" is usually cheap
78 * the "color" of a "blank" may be important
79 * moving the "cursor" may be expensive
80 * use a "hardware" cursor (moves during screen updates)
81 * drawing new symbols automatically erases old ones
82 * characters may only be drawn at the cursor location
83 * drawing a character on the cursor will move the cursor
84 * may have fast routines for "clear entire window"
85 * may have fast routines for "clear to end of line"
86 * the bottom right corner is often dangerous
89 * This package provides support for multiple windows, each of an
90 * arbitrary size (up to 255x255), each with its own set of flags,
91 * and its own hooks to handle several low-level procedures which
92 * differ from platform to platform. Then the main program simply
93 * creates one or more "term" structures, setting the various flags
94 * and hooks in a manner appropriate for the current platform, and
95 * then it can use the various "term" structures without worrying
96 * about the underlying platform.
99 * This package allows each "grid" in each window to hold an attr/char
100 * pair, with each ranging from 0 to 255, and makes very few assumptions
101 * about the meaning of any attr/char values. Normally, we assume that
102 * "attr 0" is "black", with the semantics that "black" text should be
103 * sent to "Term_wipe()" instead of "Term_text()", but this sematics is
104 * modified if either the "always_pict" or the "always_text" flags are
105 * set. We assume that "char 0" is "dangerous", since placing such a
106 * "char" in the middle of a string "terminates" the string, and usually
107 * we prevent its use.
109 * Finally, we use a special attr/char pair, defaulting to "attr 0" and
110 * "char 32", also known as "black space", when we "erase" or "clear"
111 * any window, but this pair can be redefined to any pair, including
112 * the standard "white space", or the bizarre "emptiness" ("attr 0"
113 * and "char 0"), as long as various obscure restrictions are met.
116 * This package provides several functions which allow a program to
117 * interact with the "term" structures. Most of the functions allow
118 * the program to "request" certain changes to the current "term",
119 * such as moving the cursor, drawing an attr/char pair, erasing a
120 * region of grids, hiding the cursor, etc. Then there is a special
121 * function which causes all of the "pending" requests to be performed
122 * in an efficient manner. There is another set of functions which
123 * allow the program to query the "requested state" of the current
124 * "term", such as asking for the cursor location, or what attr/char
125 * is at a given location, etc. There is another set of functions
126 * dealing with "keypress" events, which allows the program to ask if
127 * the user has pressed any keys, or to forget any keys the user pressed.
128 * There is a pair of functions to allow this package to memorize the
129 * contents of the current "term", and to restore these contents at
130 * a later time. There is a special function which allows the program
131 * to specify which "term" structure should be the "current" one. At
132 * the lowest level, there is a set of functions which allow a new
133 * "term" to be initialized or destroyed, and which allow this package,
134 * or a program, to access the special "hooks" defined for the current
135 * "term", and a set of functions which those "hooks" can use to inform
136 * this package of the results of certain occurances, for example, one
137 * such function allows this package to learn about user keypresses,
138 * detected by one of the special "hooks".
140 * We provide, among other things, the functions "Term_keypress()"
141 * to "react" to keypress events, and "Term_redraw()" to redraw the
142 * entire window, plus "Term_resize()" to note a new size.
145 * Note that the current "term" contains two "window images". One of
146 * these images represents the "requested" contents of the "term", and
147 * the other represents the "actual" contents of the "term", at the time
148 * of the last performance of pending requests. This package uses these
149 * two images to determine the "minimal" amount of work needed to make
150 * the "actual" contents of the "term" match the "requested" contents of
151 * the "term". This method is not perfect, but it often reduces the
152 * amount of work needed to perform the pending requests, which thus
153 * increases the speed of the program itself. This package promises
154 * that the requested changes will appear to occur either "all at once"
155 * or in a "top to bottom" order. In addition, a "cursor" is maintained,
156 * and this cursor is updated along with the actual window contents.
158 * Currently, the "Term_fresh()" routine attempts to perform the "minimum"
159 * number of physical updates, in terms of total "work" done by the hooks
160 * Term_wipe(), Term_text(), and Term_pict(), making use of the fact that
161 * adjacent characters of the same color can both be drawn together using
162 * the "Term_text()" hook, and that "black" text can often be sent to the
163 * "Term_wipe()" hook instead of the "Term_text()" hook, and if something
164 * is already displayed in a window, then it is not necessary to display
165 * it again. Unfortunately, this may induce slightly non-optimal results
166 * in some cases, in particular, those in which, say, a string of ten
167 * characters needs to be written, but the fifth character has already
168 * been displayed. Currently, this will cause the "Term_text()" routine
169 * to be called once for each half of the string, instead of once for the
170 * whole string, which, on some machines, may be non-optimal behavior.
172 * The new formalism includes a "displayed" screen image (old) which
173 * is actually seen by the user, a "requested" screen image (scr)
174 * which is being prepared for display, a "memorized" screen image
175 * (mem) which is used to save and restore screen images, and a
176 * "temporary" screen image (tmp) which is currently unused.
179 * Several "flags" are available in each "term" to allow the underlying
180 * visual system (which initializes the "term" structure) to "optimize"
181 * the performance of this package for the given system, or to request
182 * certain behavior which is helpful/required for the given system.
184 * The "soft_cursor" flag indicates the use of a "soft" cursor, which
185 * only moves when explicitly requested,and which is "erased" when
186 * any characters are drawn on top of it. This flag is used for all
187 * "graphic" systems which handle the cursor by "drawing" it.
189 * The "icky_corner" flag indicates that the bottom right "corner"
190 * of the windows are "icky", and "printing" anything there may
191 * induce "messy" behavior, such as "scrolling". This flag is used
192 * for most old "dumb terminal" systems.
195 * The "term" structure contains the following function "hooks":
197 * Term->init_hook = Init the term
198 * Term->nuke_hook = Nuke the term
199 * Term->user_hook = Perform user actions
200 * Term->xtra_hook = Perform extra actions
201 * Term->curs_hook = Draw (or Move) the cursor
202 * Term->bigcurs_hook = Draw (or Move) the big cursor (bigtile mode)
203 * Term->wipe_hook = Draw some blank spaces
204 * Term->text_hook = Draw some text in the window
205 * Term->pict_hook = Draw some attr/chars in the window
207 * The "Term->user_hook" hook provides a simple hook to an implementation
208 * defined function, with application defined semantics. It is available
209 * to the program via the "Term_user()" function.
211 * The "Term->xtra_hook" hook provides a variety of different functions,
212 * based on the first parameter (which should be taken from the various
213 * TERM_XTRA_* defines) and the second parameter (which may make sense
214 * only for some first parameters). It is available to the program via
215 * the "Term_xtra()" function, though some first parameters are only
216 * "legal" when called from inside this package.
218 * The "Term->curs_hook" hook provides this package with a simple way
219 * to "move" or "draw" the cursor to the grid "x,y", depending on the
220 * setting of the "soft_cursor" flag. Note that the cursor is never
221 * redrawn if "nothing" has happened to the screen (even temporarily).
222 * This hook is required.
224 * The "Term->wipe_hook" hook provides this package with a simple way
225 * to "erase", starting at "x,y", the next "n" grids. This hook assumes
226 * that the input is valid. This hook is required, unless the setting
227 * of the "always_pict" or "always_text" flags makes it optional.
229 * The "Term->text_hook" hook provides this package with a simple way
230 * to "draw", starting at "x,y", the "n" chars contained in "cp", using
231 * the attr "a". This hook assumes that the input is valid, and that
232 * "n" is between 1 and 256 inclusive, but it should NOT assume that
233 * the contents of "cp" are null-terminated. This hook is required,
234 * unless the setting of the "always_pict" flag makes it optional.
236 * The "Term->pict_hook" hook provides this package with a simple way
237 * to "draw", starting at "x,y", the "n" attr/char pairs contained in
238 * the arrays "ap" and "cp". This hook assumes that the input is valid,
239 * and that "n" is between 1 and 256 inclusive, but it should NOT assume
240 * that the contents of "cp" are null-terminated. This hook is optional,
241 * unless the setting of the "always_pict" or "higher_pict" flags make
242 * it required. Note that recently, this hook was changed from taking
243 * a byte "a" and a char "c" to taking a length "n", an array of bytes
244 * "ap" and an array of chars "cp". Old implementations of this hook
245 * should now iterate over all "n" attr/char pairs.
248 * The game "Angband" uses a set of files called "main-xxx.c", for
249 * various "xxx" suffixes. Most of these contain a function called
250 * "init_xxx()", that will prepare the underlying visual system for
251 * use with Angband, and then create one or more "term" structures,
252 * using flags and hooks appropriate to the given platform, so that
253 * the "main()" function can call one (or more) of the "init_xxx()"
254 * functions, as appropriate, to prepare the required "term" structs
255 * (one for each desired sub-window), and these "init_xxx()" functions
256 * are called from a centralized "main()" function in "main.c". Other
257 * "main-xxx.c" systems contain their own "main()" function which, in
258 * addition to doing everything needed to initialize the actual program,
259 * also does everything that the normal "init_xxx()" functions would do.
261 * The game "Angband" defines, in addition to "attr 0", all of the
262 * attr codes from 1 to 15, using definitions in "defines.h", and
263 * thus the "main-xxx.c" files used by Angband must handle these
264 * attr values correctly. Also, they must handle all other attr
265 * values, though they may do so in any way they wish, for example,
266 * by always taking every attr code mod 16. Many of the "main-xxx.c"
267 * files use "white space" ("attr 1" / "char 32") to "erase" or "clear"
268 * any window, for efficiency.
270 * The game "Angband" uses the "Term_user" hook to allow any of the
271 * "main-xxx.c" files to interact with the user, by calling this hook
272 * whenever the user presses the "!" key when the game is waiting for
273 * a new command. This could be used, for example, to provide "unix
274 * shell commands" to the Unix versions of the game.
276 * See "main-xxx.c" for a simple skeleton file which can be used to
277 * create a "visual system" for a new platform when porting Angband.
293 /*** Local routines ***/
297 * Nuke a term_win (see below)
299 static errr term_win_nuke(term_win *s, int w, int h)
301 /* Free the window access arrays */
302 C_KILL(s->a, h, byte*);
303 C_KILL(s->c, h, char*);
305 /* Free the window content arrays */
306 C_KILL(s->va, h * w, byte);
307 C_KILL(s->vc, h * w, char);
309 /* Free the terrain access arrays */
310 C_KILL(s->ta, h, byte*);
311 C_KILL(s->tc, h, char*);
313 /* Free the terrain content arrays */
314 C_KILL(s->vta, h * w, byte);
315 C_KILL(s->vtc, h * w, char);
323 * Initialize a "term_win" (using the given window size)
325 static errr term_win_init(term_win *s, int w, int h)
329 /* Make the window access arrays */
330 C_MAKE(s->a, h, byte*);
331 C_MAKE(s->c, h, char*);
333 /* Make the window content arrays */
334 C_MAKE(s->va, h * w, byte);
335 C_MAKE(s->vc, h * w, char);
337 /* Make the terrain access arrays */
338 C_MAKE(s->ta, h, byte*);
339 C_MAKE(s->tc, h, char*);
341 /* Make the terrain content arrays */
342 C_MAKE(s->vta, h * w, byte);
343 C_MAKE(s->vtc, h * w, char);
346 /* Prepare the window access arrays */
347 for (y = 0; y < h; y++)
349 s->a[y] = s->va + w * y;
350 s->c[y] = s->vc + w * y;
352 s->ta[y] = s->vta + w * y;
353 s->tc[y] = s->vtc + w * y;
362 * Copy a "term_win" from another
364 static errr term_win_copy(term_win *s, term_win *f, int w, int h)
369 for (y = 0; y < h; y++)
371 byte *f_aa = f->a[y];
372 char *f_cc = f->c[y];
374 byte *s_aa = s->a[y];
375 char *s_cc = s->c[y];
377 byte *f_taa = f->ta[y];
378 char *f_tcc = f->tc[y];
380 byte *s_taa = s->ta[y];
381 char *s_tcc = s->tc[y];
383 for (x = 0; x < w; x++)
405 /*** External hooks ***/
409 * Execute the "Term->user_hook" hook, if available (see above).
411 errr Term_user(int n)
413 /* Verify the hook */
414 if (!Term->user_hook) return (-1);
417 return ((*Term->user_hook)(n));
421 * Execute the "Term->xtra_hook" hook, if available (see above).
423 errr Term_xtra(int n, int v)
425 /* Verify the hook */
426 if (!Term->xtra_hook) return (-1);
429 return ((*Term->xtra_hook)(n, v));
438 * Hack -- fake hook for "Term_curs()" (see above)
440 static errr Term_curs_hack(int x, int y)
451 * Hack -- fake hook for "Term_bigcurs()" (see above)
453 static errr Term_bigcurs_hack(int x, int y)
455 return (*Term->curs_hook)(x, y);
459 * Hack -- fake hook for "Term_wipe()" (see above)
461 static errr Term_wipe_hack(int x, int y, int n)
473 * Hack -- fake hook for "Term_text()" (see above)
475 static errr Term_text_hack(int x, int y, int n, byte a, cptr cp)
489 * Hack -- fake hook for "Term_pict()" (see above)
491 static errr Term_pict_hack(int x, int y, int n, const byte *ap, cptr cp, const byte *tap, cptr tcp)
508 /*** Efficient routines ***/
512 * Mentally draw an attr/char at a given location
514 * Assumes given location and values are valid.
516 void Term_queue_char(int x, int y, byte a, char c, byte ta, char tc)
518 term_win *scrn = Term->scr;
520 byte *scr_aa = &scrn->a[y][x];
521 char *scr_cc = &scrn->c[y][x];
523 byte *scr_taa = &scrn->ta[y][x];
524 char *scr_tcc = &scrn->tc[y][x];
526 /* Hack -- Ignore non-changes */
527 if ((*scr_aa == a) && (*scr_cc == c) &&
528 (*scr_taa == ta) && (*scr_tcc == tc)) return;
530 /* Save the "literal" information */
537 /* Check for new min/max row info */
538 if (y < Term->y1) Term->y1 = y;
539 if (y > Term->y2) Term->y2 = y;
541 /* Check for new min/max col info for this row */
542 if (x < Term->x1[y]) Term->x1[y] = x;
543 if (x > Term->x2[y]) Term->x2[y] = x;
545 if (((scrn->a[y][x] & AF_BIGTILE2) == AF_BIGTILE2) ||
546 (scrn->a[y][x] & AF_KANJI2))
547 if ((x - 1) < Term->x1[y]) Term->x1[y]--;
552 * Bigtile version of Term_queue_char().
554 * If use_bigtile is FALSE, simply call Term_queue_char().
556 * Otherwise, mentally draw a pair of attr/char at a given location.
558 * Assumes given location and values are valid.
560 void Term_queue_bigchar(int x, int y, byte a, char c, byte ta, char tc)
565 * A table which relates each ascii character to a multibyte
568 * ¡Ö¢£¡×¤ÏÆóÇÜÉýƦÉå¤ÎÆâÉô¥³¡¼¥É¤Ë»ÈÍÑ¡£
570 static char ascii_to_zenkaku[] =
571 "¡¡¡ª¡É¡ô¡ð¡ó¡õ¡Ç¡Ê¡Ë¡ö¡Ü¡¤¡Ý¡¥¡¿"
572 "£°£±£²£³£´£µ£¶£·£¸£¹¡§¡¨¡ã¡á¡ä¡©"
573 "¡÷£Á£Â£Ã£Ä£Å£Æ£Ç£È£É£Ê£Ë£Ì£Í£Î£Ï"
574 "£Ð£Ñ£Ò£Ó£Ô£Õ£Ö£×£Ø£Ù£Ú¡Î¡À¡Ï¡°¡²"
575 "¡Æ£á£â£ã£ä£å£æ£ç£è£é£ê£ë£ì£í£î£ï"
576 "£ð£ñ£ò£ó£ô£õ£ö£÷£ø£ù£ú¡Ð¡Ã¡Ñ¡Á¢£";
582 /* If non bigtile mode, call orginal function */
585 Term_queue_char(x, y, a, c, ta, tc);
589 /* A tile becomes a Bigtile */
590 if ((a & AF_TILE1) && (c & 0x80))
592 /* Mark it as a Bigtile */
597 /* Ignore non-tile background */
598 if (!((ta & AF_TILE1) && (tc & 0x80)))
607 * Use a multibyte character instead of a dirty pair of ASCII
610 else if (' ' <= c) /* isprint(c) */
612 c2 = ascii_to_zenkaku[2 * (c - ' ') + 1];
613 c = ascii_to_zenkaku[2 * (c - ' ')];
615 /* Mark it as a Kanji */
623 /* Dirty pair of ASCII characters */
628 /* Display pair of attr/char */
629 Term_queue_char(x, y, a, c, ta, tc);
630 Term_queue_char(x + 1, y, a2, c2, 0, 0);
635 * Mentally draw a string of attr/chars at a given location
637 * Assumes given location and values are valid.
639 * This function is designed to be fast, with no consistancy checking.
640 * It is used to update the map in the game.
642 void Term_queue_line(int x, int y, int n, byte *a, char *c, byte *ta, char *tc)
644 term_win *scrn = Term->scr;
649 byte *scr_aa = &scrn->a[y][x];
650 char *scr_cc = &scrn->c[y][x];
652 byte *scr_taa = &scrn->ta[y][x];
653 char *scr_tcc = &scrn->tc[y][x];
657 /* Hack -- Ignore non-changes */
658 if ((*scr_aa == *a) && (*scr_cc == *c) &&
659 (*scr_taa == *ta) && (*scr_tcc == *tc))
673 /* Save the "literal" information */
677 /* Save the "literal" information */
681 /* Track minimum changed column */
684 /* Track maximum changed column */
690 /* Expand the "change area" as needed */
693 /* Check for new min/max row info */
694 if (y < Term->y1) Term->y1 = y;
695 if (y > Term->y2) Term->y2 = y;
697 /* Check for new min/max col info in this row */
698 if (x1 < Term->x1[y]) Term->x1[y] = x1;
699 if (x2 > Term->x2[y]) Term->x2[y] = x2;
706 * Mentally draw some attr/chars at a given location
708 * Assumes that (x,y) is a valid location, that the first "n" characters
709 * of the string "s" are all valid (non-zero), and that (x+n-1,y) is also
710 * a valid location, so the first "n" characters of "s" can all be added
711 * starting at (x,y) without causing any illegal operations.
713 void Term_queue_chars(int x, int y, int n, byte a, cptr s)
715 int x1 = -1, x2 = -1;
717 byte *scr_aa = Term->scr->a[y];
719 char *scr_cc = Term->scr->c[y];
721 byte *scr_taa = Term->scr->ta[y];
722 char *scr_tcc = Term->scr->tc[y];
724 char *scr_cc = Term->scr->c[y];
726 byte *scr_taa = Term->scr->ta[y];
727 char *scr_tcc = Term->scr->tc[y];
733 if (n == 0 || *s == 0) return;
735 * Á´³Ñʸ»ú¤Î±¦È¾Ê¬¤«¤éʸ»ú¤òɽ¼¨¤¹¤ë¾ì¹ç¡¢
736 * ½Å¤Ê¤Ã¤¿Ê¸»ú¤Îº¸Éôʬ¤ò¾Ãµî¡£
737 * ɽ¼¨³«»Ï°ÌÃÖ¤¬º¸Ã¼¤Ç¤Ê¤¤¤È²¾Äê¡£
739 if ((scr_aa[x] & AF_KANJI2) && (scr_aa[x] & AF_BIGTILE2) != AF_BIGTILE2)
742 scr_aa[x - 1] &= AF_KANJIC;
746 /* Queue the attr/chars */
747 for ( ; n; x++, s++, n--)
750 /* Æüìʸ»ú¤È¤·¤ÆMSB¤¬Î©¤Ã¤Æ¤¤¤ë²ÄǽÀ¤¬¤¢¤ë */
751 /* ¤½¤Î¾ì¹çattr¤ÎMSB¤âΩ¤Ã¤Æ¤¤¤ë¤Î¤Ç¤³¤ì¤Ç¼±Ê̤¹¤ë */
753 if (!(a & AF_TILE1) && iskanji(*s))
758 byte na1 = (a | AF_KANJI1);
759 byte na2 = (a | AF_KANJI2);
761 if((--n == 0) || !nc2) break;
763 if(scr_aa[x++] == na1 && scr_aa[x] == na2 &&
764 scr_cc[x - 1] == nc1 && scr_cc[x] == nc2 &&
765 (scr_taa[x - 1] == 0) && (scr_taa[x]==0) &&
766 (scr_tcc[x - 1] == 0) && (scr_tcc[x]==0) )
774 if(x1 < 0) x1 = x - 1;
783 byte ota = scr_taa[x];
784 char otc = scr_tcc[x];
786 /* Hack -- Ignore non-changes */
787 if ((oa == a) && (oc == *s) && (ota == 0) && (otc == 0)) continue;
789 /* Save the "literal" information */
796 /* Note the "range" of window updates */
806 * Á´³Ñʸ»ú¤Îº¸È¾Ê¬¤Çɽ¼¨¤ò½ªÎ»¤¹¤ë¾ì¹ç¡¢
807 * ½Å¤Ê¤Ã¤¿Ê¸»ú¤Î±¦Éôʬ¤ò¾Ãµî¡£
808 * (¾ò·ïÄɲ᧥¿¥¤¥ë¤Î1ʸ»úÌܤǤʤ¤»ö¤ò³Î¤«¤á¤ë¤è¤¦¤Ë¡£)
813 Term_get_size(&w, &h);
814 if (x != w && !(scr_aa[x] & AF_TILE1) && (scr_aa[x] & AF_KANJI2))
817 scr_aa[x] &= AF_KANJIC;
823 /* Expand the "change area" as needed */
826 /* Check for new min/max row info */
827 if (y < Term->y1) Term->y1 = y;
828 if (y > Term->y2) Term->y2 = y;
830 /* Check for new min/max col info in this row */
831 if (x1 < Term->x1[y]) Term->x1[y] = x1;
832 if (x2 > Term->x2[y]) Term->x2[y] = x2;
838 /*** Refresh routines ***/
842 * Flush a row of the current window (see "Term_fresh")
844 * Display text using "Term_pict()"
846 static void Term_fresh_row_pict(int y, int x1, int x2)
850 byte *old_aa = Term->old->a[y];
851 char *old_cc = Term->old->c[y];
853 byte *scr_aa = Term->scr->a[y];
854 char *scr_cc = Term->scr->c[y];
856 byte *old_taa = Term->old->ta[y];
857 char *old_tcc = Term->old->tc[y];
859 byte *scr_taa = Term->scr->ta[y];
860 char *scr_tcc = Term->scr->tc[y];
882 /* Á´³Ñʸ»ú¤Î£²¥Ð¥¤¥ÈÌܤ«¤É¤¦¤« */
885 /* Scan "modified" columns */
886 for (x = x1; x <= x2; x++)
888 /* See what is currently here */
892 /* See what is desired there */
899 /* Á´³Ñʸ»ú£²¥Ð¥¤¥ÈÌÜ */
906 /* Æüìʸ»ú¤È¤·¤ÆMSB¤¬Î©¤Ã¤Æ¤¤¤ë²ÄǽÀ¤¬¤¢¤ë */
907 /* ¤½¤Î¾ì¹çattr¤ÎMSB¤âΩ¤Ã¤Æ¤¤¤ë¤Î¤Ç¤³¤ì¤Ç¼±Ê̤¹¤ë */
909 kanji = (iskanji(nc) && !(na & AF_TILE1));
918 /* Handle unchanged grids */
920 if ((na == oa) && (nc == oc) && (nta == ota) && (ntc == otc)
921 &&(!kanji || (scr_aa[x + 1] == old_aa[x + 1] &&
922 scr_cc[x + 1] == old_cc[x + 1] &&
923 scr_taa[x + 1] == old_taa[x + 1] &&
924 scr_tcc[x + 1] == old_tcc[x + 1])))
926 if ((na == oa) && (nc == oc) && (nta == ota) && (ntc == otc))
932 /* Draw pending attr/char pairs */
933 (void)((*Term->pict_hook)(fx, y, fn,
934 &scr_aa[fx], &scr_cc[fx],&scr_taa[fx], &scr_tcc[fx]));
941 /* Á´³Ñʸ»ú¤Î»þ¤ÏºÆ³«°ÌÃ֤ϡܣ± */
952 /* Save new contents */
959 /* Restart and Advance */
960 if (fn++ == 0) fx = x;
966 /* Draw pending attr/char pairs */
967 (void)((*Term->pict_hook)(fx, y, fn,
968 &scr_aa[fx], &scr_cc[fx], &scr_taa[fx], &scr_tcc[fx]));
975 * Flush a row of the current window (see "Term_fresh")
977 * Display text using "Term_text()" and "Term_wipe()",
978 * but use "Term_pict()" for high-bit attr/char pairs
980 static void Term_fresh_row_both(int y, int x1, int x2)
984 byte *old_aa = Term->old->a[y];
985 char *old_cc = Term->old->c[y];
987 byte *scr_aa = Term->scr->a[y];
988 char *scr_cc = Term->scr->c[y];
990 byte *old_taa = Term->old->ta[y];
991 char *old_tcc = Term->old->tc[y];
992 byte *scr_taa = Term->scr->ta[y];
993 char *scr_tcc = Term->scr->tc[y];
1000 /* The "always_text" flag */
1001 int always_text = Term->always_text;
1003 /* Pending length */
1010 byte fa = Term->attr_blank;
1019 /* Á´³Ñʸ»ú¤Î£²¥Ð¥¤¥ÈÌܤ«¤É¤¦¤« */
1022 /* Scan "modified" columns */
1023 for (x = x1; x <= x2; x++)
1025 /* See what is currently here */
1029 /* See what is desired there */
1036 /* Á´³Ñʸ»ú£²¥Ð¥¤¥ÈÌÜ */
1043 /* Æüìʸ»ú¤È¤·¤ÆMSB¤¬Î©¤Ã¤Æ¤¤¤ë²ÄǽÀ¤¬¤¢¤ë */
1044 /* ¤½¤Î¾ì¹çattr¤ÎMSB¤âΩ¤Ã¤Æ¤¤¤ë¤Î¤Ç¤³¤ì¤Ç¼±Ê̤¹¤ë */
1046 /* kanji = (iskanji(nc)); */
1047 kanji = (iskanji(nc) && !(na & AF_TILE1));
1056 /* Handle unchanged grids */
1058 if ((na == oa) && (nc == oc) && (nta == ota) && (ntc == otc)&&
1059 (!kanji || (scr_aa[x + 1] == old_aa[x + 1] &&
1060 scr_cc[x + 1] == old_cc[x + 1] &&
1061 scr_taa[x + 1] == old_taa[x + 1] &&
1062 scr_tcc[x + 1] == old_tcc[x + 1])))
1064 if ((na == oa) && (nc == oc) && (nta == ota) && (ntc == otc))
1070 /* Draw pending chars (normal) */
1071 if (fa || always_text)
1073 (void)((*Term->text_hook)(fx, y, fn, fa, &scr_cc[fx]));
1076 /* Draw pending chars (black) */
1079 (void)((*Term->wipe_hook)(fx, y, fn));
1087 /* Á´³Ñʸ»ú¤Î»þ¤ÏºÆ³«°ÌÃ֤ϡܣ± */
1099 /* Save new contents */
1106 /* 2nd byte of bigtile */
1107 if ((na & AF_BIGTILE2) == AF_BIGTILE2) continue;
1109 /* Handle high-bit attr/chars */
1110 if ((na & AF_TILE1) && (nc & 0x80))
1115 /* Draw pending chars (normal) */
1116 if (fa || always_text)
1118 (void)((*Term->text_hook)(fx, y, fn, fa, &scr_cc[fx]));
1121 /* Draw pending chars (black) */
1124 (void)((*Term->wipe_hook)(fx, y, fn));
1131 /* Hack -- Draw the special attr/char pair */
1132 (void)((*Term->pict_hook)(x, y, 1, &na, &nc, &nta, &ntc));
1138 /* Notice new color */
1140 if (fa != (na & AF_KANJIC))
1149 /* Draw the pending chars */
1150 if (fa || always_text)
1152 (void)((*Term->text_hook)(fx, y, fn, fa, &scr_cc[fx]));
1155 /* Hack -- Erase "leading" spaces */
1158 (void)((*Term->wipe_hook)(fx, y, fn));
1165 /* Save the new color */
1167 fa = (na & AF_KANJIC);
1174 /* Restart and Advance */
1175 if (fn++ == 0) fx = x;
1181 /* Draw pending chars (normal) */
1182 if (fa || always_text)
1184 (void)((*Term->text_hook)(fx, y, fn, fa, &scr_cc[fx]));
1187 /* Draw pending chars (black) */
1190 (void)((*Term->wipe_hook)(fx, y, fn));
1197 * Flush a row of the current window (see "Term_fresh")
1199 * Display text using "Term_text()" and "Term_wipe()"
1201 static void Term_fresh_row_text(int y, int x1, int x2)
1205 byte *old_aa = Term->old->a[y];
1206 char *old_cc = Term->old->c[y];
1208 byte *scr_aa = Term->scr->a[y];
1209 char *scr_cc = Term->scr->c[y];
1211 /* The "always_text" flag */
1212 int always_text = Term->always_text;
1214 /* Pending length */
1221 byte fa = Term->attr_blank;
1230 /* Á´³Ñʸ»ú¤Î£²¥Ð¥¤¥ÈÌܤ«¤É¤¦¤« */
1233 for (x = 0; x < x1; x++)
1234 if (!(old_aa[x] & AF_TILE1) && iskanji(old_cc[x]))
1245 /* Scan "modified" columns */
1246 for (x = x1; x <= x2; x++)
1248 /* See what is currently here */
1252 /* See what is desired there */
1259 /* Á´³Ñʸ»ú£²¥Ð¥¤¥ÈÌÜ */
1266 /* Æüìʸ»ú¤È¤·¤ÆMSB¤¬Î©¤Ã¤Æ¤¤¤ë²ÄǽÀ¤¬¤¢¤ë */
1267 /* ¤½¤Î¾ì¹çattr¤ÎMSB¤âΩ¤Ã¤Æ¤¤¤ë¤Î¤Ç¤³¤ì¤Ç¼±Ê̤¹¤ë */
1269 kanji = (iskanji(nc) && !(na & AF_TILE1));
1271 /* Handle unchanged grids */
1273 if ((na == oa) && (nc == oc) &&
1274 (!kanji || (scr_aa[x + 1] == old_aa[x + 1] &&
1275 scr_cc[x + 1] == old_cc[x + 1])))
1277 if ((na == oa) && (nc == oc))
1284 /* Draw pending chars (normal) */
1285 if (fa || always_text)
1287 (void)((*Term->text_hook)(fx, y, fn, fa, &scr_cc[fx]));
1290 /* Draw pending chars (black) */
1293 (void)((*Term->wipe_hook)(fx, y, fn));
1301 /* Á´³Ñʸ»ú¤Î»þ¤ÏºÆ³«°ÌÃ֤ϡܣ± */
1313 /* Save new contents */
1317 /* Notice new color */
1319 if (fa != (na & AF_KANJIC))
1328 /* Draw the pending chars */
1329 if (fa || always_text)
1331 (void)((*Term->text_hook)(fx, y, fn, fa, &scr_cc[fx]));
1334 /* Hack -- Erase "leading" spaces */
1337 (void)((*Term->wipe_hook)(fx, y, fn));
1344 /* Save the new color */
1346 fa = (na & AF_KANJIC);
1353 /* Restart and Advance */
1354 if (fn++ == 0) fx = x;
1360 /* Draw pending chars (normal) */
1361 if (fa || always_text)
1363 (void)((*Term->text_hook)(fx, y, fn, fa, &scr_cc[fx]));
1366 /* Draw pending chars (black) */
1369 (void)((*Term->wipe_hook)(fx, y, fn));
1379 * Actually perform all requested changes to the window
1381 * If absolutely nothing has changed, not even temporarily, or if the
1382 * current "Term" is not mapped, then this function will return 1 and
1383 * do absolutely nothing.
1385 * Note that when "soft_cursor" is true, we erase the cursor (if needed)
1386 * whenever anything has changed, and redraw it (if needed) after all of
1387 * the screen updates are complete. This will induce a small amount of
1388 * "cursor flicker" but only when the screen has been updated. If the
1389 * screen is updated and then restored, you may still get this flicker.
1391 * When "soft_cursor" is not true, we make the cursor invisible before
1392 * doing anything else if it is supposed to be invisible by the time we
1393 * are done, and we make it visible after moving it to its final location
1394 * after all of the screen updates are complete.
1396 * Note that "Term_xtra(TERM_XTRA_CLEAR,0)" must erase the entire screen,
1397 * including the cursor, if needed, and may place the cursor anywhere.
1399 * Note that "Term_xtra(TERM_XTRA_FROSH,y)" will be always be called
1400 * after any row "y" has been "flushed", unless the "Term->never_frosh"
1401 * flag is set, and "Term_xtra(TERM_XTRA_FRESH,0)" will be called after
1402 * all of the rows have been "flushed".
1404 * Note the use of three different functions to handle the actual flush,
1405 * based on the settings of the "Term->always_pict" and "Term->higher_pict"
1406 * flags (see below).
1408 * The three helper functions (above) work by collecting similar adjacent
1409 * grids into stripes, and then sending each stripe to "Term->pict_hook",
1410 * "Term->text_hook", or "Term->wipe_hook", based on the settings of the
1411 * "Term->always_pict" and "Term->higher_pict" flags, which select which
1412 * of the helper functions to call to flush each row.
1414 * The helper functions currently "skip" any grids which already contain
1415 * the desired contents. This may or may not be the best method, especially
1416 * when the desired content fits nicely into the current stripe. For example,
1417 * it might be better to go ahead and queue them while allowed, but keep a
1418 * count of the "trailing skipables", then, when time to flush, or when a
1419 * "non skippable" is found, force a flush if there are too many skippables.
1421 * Perhaps an "initialization" stage, where the "text" (and "attr")
1422 * buffers are "filled" with information, converting "blanks" into
1423 * a convenient representation, and marking "skips" with "zero chars",
1424 * and then some "processing" is done to determine which chars to skip.
1426 * Currently, the helper functions are optimal for systems which prefer
1427 * to "print a char + move a char + print a char" to "print three chars",
1428 * and for applications that do a lot of "detailed" color printing.
1430 * In the two "queue" functions, total "non-changes" are "pre-skipped".
1431 * The helper functions must also handle situations in which the contents
1432 * of a grid are changed, but then changed back to the original value,
1433 * and situations in which two grids in the same row are changed, but
1434 * the grids between them are unchanged.
1436 * If the "Term->always_pict" flag is set, then "Term_fresh_row_pict()"
1437 * will be used instead of "Term_fresh_row_text()". This allows all the
1438 * modified grids to be collected into stripes of attr/char pairs, which
1439 * are then sent to the "Term->pict_hook" hook, which can draw these pairs
1440 * in whatever way it would like.
1442 * If the "Term->higher_pict" flag is set, then "Term_fresh_row_both()"
1443 * will be used instead of "Term_fresh_row_text()". This allows all the
1444 * "special" attr/char pairs (in which both the attr and char have the
1445 * high-bit set) to be sent (one pair at a time) to the "Term->pict_hook"
1446 * hook, which can draw these pairs in whatever way it would like.
1448 * Normally, the "Term_wipe()" function is used only to display "blanks"
1449 * that were induced by "Term_clear()" or "Term_erase()", and then only
1450 * if the "attr_blank" and "char_blank" fields have not been redefined
1451 * to use "white space" instead of the default "black space". Actually,
1452 * the "Term_wipe()" function is used to display all "black" text, such
1453 * as the default "spaces" created by "Term_clear()" and "Term_erase()".
1455 * Note that the "Term->always_text" flag will disable the use of the
1456 * "Term_wipe()" function hook entirely, and force all text, even text
1457 * drawn in the color "black", to be explicitly drawn. This is useful
1458 * for machines which implement "Term_wipe()" by just drawing spaces.
1460 * Note that the "Term->always_pict" flag will disable the use of the
1461 * "Term_wipe()" function entirely, and force everything, even text
1462 * drawn in the attr "black", to be explicitly drawn.
1464 * Note that if no "black" text is ever drawn, and if "attr_blank" is
1465 * not "zero", then the "Term_wipe" hook will never be used, even if
1466 * the "Term->always_text" flag is not set.
1468 * This function does nothing unless the "Term" is "mapped", which allows
1469 * certain systems to optimize the handling of "closed" windows.
1471 * On systems with a "soft" cursor, we must explicitly erase the cursor
1472 * before flushing the output, if needed, to prevent a "jumpy" refresh.
1473 * The actual method for this is horrible, but there is very little that
1474 * we can do to simplify it efficiently. XXX XXX XXX
1476 * On systems with a "hard" cursor, we will "hide" the cursor before
1477 * flushing the output, if needed, to avoid a "flickery" refresh. It
1478 * would be nice to *always* hide the cursor during the refresh, but
1479 * this might be expensive (and/or ugly) on some machines.
1481 * The "Term->icky_corner" flag is used to avoid calling "Term_wipe()"
1482 * or "Term_pict()" or "Term_text()" on the bottom right corner of the
1483 * window, which might induce "scrolling" or other nasty stuff on old
1484 * dumb terminals. This flag is handled very efficiently. We assume
1485 * that the "Term_curs()" call will prevent placing the cursor in the
1486 * corner, if needed, though I doubt such placement is ever a problem.
1487 * Currently, the use of "Term->icky_corner" and "Term->soft_cursor"
1488 * together may result in undefined behavior.
1490 errr Term_fresh(void)
1500 term_win *old = Term->old;
1501 term_win *scr = Term->scr;
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 byte *aa = old->a[y];
1537 char *cc = old->c[y];
1539 byte *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)
1581 byte *old_aa = old->a[ty];
1582 char *old_cc = old->c[ty];
1584 byte *old_taa = old->ta[ty];
1585 char *old_tcc = old->tc[ty];
1587 byte 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));
1607 /* Hack -- restore the actual character */
1608 else if (old_aa[tx] || Term->always_text)
1610 (void)((*Term->text_hook)(tx, ty, csize, (unsigned char) (old_aa[tx] & 0xf), &old_cc[tx]));
1613 /* Hack -- erase the grid */
1616 (void)((*Term->wipe_hook)(tx, ty, 1));
1621 /* Cursor Update -- Erase old Cursor */
1624 /* Cursor will be invisible */
1625 if (scr->cu || !scr->cv)
1627 /* Make the cursor invisible */
1628 Term_xtra(TERM_XTRA_SHAPE, 0);
1633 /* Something to update */
1636 /* Handle "icky corner" */
1637 if (Term->icky_corner)
1639 /* Avoid the corner */
1642 /* Avoid the corner */
1643 if (Term->x2[h - 1] > w - 2)
1645 /* Avoid the corner */
1646 Term->x2[h - 1] = w - 2;
1652 /* Scan the "modified" rows */
1653 for (y = y1; y <= y2; ++y)
1655 int x1 = Term->x1[y];
1656 int x2 = Term->x2[y];
1658 /* Flush each "modified" row */
1661 /* Always use "Term_pict()" */
1662 if (Term->always_pict)
1665 Term_fresh_row_pict(y, x1, x2);
1668 /* Sometimes use "Term_pict()" */
1669 else if (Term->higher_pict)
1672 Term_fresh_row_both(y, x1, x2);
1675 /* Never use "Term_pict()" */
1679 Term_fresh_row_text(y, x1, x2);
1682 /* This row is all done */
1686 /* Hack -- Flush that row (if allowed) */
1687 if (!Term->never_frosh) Term_xtra(TERM_XTRA_FROSH, y);
1691 /* No rows are invalid */
1697 /* Cursor update -- Show new Cursor */
1698 if (Term->soft_cursor)
1700 /* Draw the cursor */
1701 if (!scr->cu && scr->cv)
1704 if ((scr->cx + 1 < w) &&
1705 ((old->a[scr->cy][scr->cx + 1] & AF_BIGTILE2) == AF_BIGTILE2 ||
1706 (!(old->a[scr->cy][scr->cx] & AF_TILE1) &&
1707 iskanji(old->c[scr->cy][scr->cx]))))
1709 if ((scr->cx + 1 < w) && (old->a[scr->cy][scr->cx + 1] & AF_BIGTILE2) == AF_BIGTILE2)
1712 /* Double width cursor for the Bigtile mode */
1713 (void)((*Term->bigcurs_hook)(scr->cx, scr->cy));
1717 /* Call the cursor display routine */
1718 (void)((*Term->curs_hook)(scr->cx, scr->cy));
1723 /* Cursor Update -- Show new Cursor */
1726 /* The cursor is useless, hide it */
1729 /* Paranoia -- Put the cursor NEAR where it belongs */
1730 (void)((*Term->curs_hook)(w - 1, scr->cy));
1732 /* Make the cursor invisible */
1733 /* Term_xtra(TERM_XTRA_SHAPE, 0); */
1736 /* The cursor is invisible, hide it */
1739 /* Paranoia -- Put the cursor where it belongs */
1740 (void)((*Term->curs_hook)(scr->cx, scr->cy));
1742 /* Make the cursor invisible */
1743 /* Term_xtra(TERM_XTRA_SHAPE, 0); */
1746 /* The cursor is visible, display it correctly */
1749 /* Put the cursor where it belongs */
1750 (void)((*Term->curs_hook)(scr->cx, scr->cy));
1752 /* Make the cursor visible */
1753 Term_xtra(TERM_XTRA_SHAPE, 1);
1758 /* Save the "cursor state" */
1765 /* Actually flush the output */
1766 Term_xtra(TERM_XTRA_FRESH, 0);
1775 /*** Output routines ***/
1779 * Set the cursor visibility
1781 errr Term_set_cursor(int v)
1784 if (Term->scr->cv == v) return (1);
1795 * Place the cursor at a given location
1797 * Note -- "illegal" requests do not move the cursor.
1799 errr Term_gotoxy(int x, int y)
1805 if ((x < 0) || (x >= w)) return (-1);
1806 if ((y < 0) || (y >= h)) return (-1);
1808 /* Remember the cursor */
1812 /* The cursor is not useless */
1821 * At a given location, place an attr/char
1822 * Do not change the cursor position
1823 * No visual changes until "Term_fresh()".
1825 errr Term_draw(int x, int y, byte a, char c)
1830 /* Verify location */
1831 if ((x < 0) || (x >= w)) return (-1);
1832 if ((y < 0) || (y >= h)) return (-1);
1834 /* Paranoia -- illegal char */
1835 if (!c) return (-2);
1837 /* Queue it for later */
1838 Term_queue_char(x, y, a, c, 0, 0);
1846 * Using the given attr, add the given char at the cursor.
1848 * We return "-2" if the character is "illegal". XXX XXX
1850 * We return "-1" if the cursor is currently unusable.
1852 * We queue the given attr/char for display at the current
1853 * cursor location, and advance the cursor to the right,
1854 * marking it as unuable and returning "1" if it leaves
1855 * the screen, and otherwise returning "0".
1857 * So when this function, or the following one, return a
1858 * positive value, future calls to either function will
1859 * return negative ones.
1861 errr Term_addch(byte a, char c)
1865 /* Handle "unusable" cursor */
1866 if (Term->scr->cu) return (-1);
1868 /* Paranoia -- no illegal chars */
1869 if (!c) return (-2);
1871 /* Queue the given character for display */
1872 Term_queue_char(Term->scr->cx, Term->scr->cy, a, c, 0, 0);
1874 /* Advance the cursor */
1878 if (Term->scr->cx < w) return (0);
1880 /* Note "Useless" cursor */
1883 /* Note "Useless" cursor */
1889 * Bigtile version of Term_addch().
1891 * If use_bigtile is FALSE, simply call Term_addch() .
1893 * Otherwise, queue a pair of attr/char for display at the current
1894 * cursor location, and advance the cursor to the right by two.
1896 errr Term_add_bigch(byte a, char c)
1898 if (!use_bigtile) return Term_addch(a, c);
1900 /* Handle "unusable" cursor */
1901 if (Term->scr->cu) return (-1);
1903 /* Paranoia -- no illegal chars */
1904 if (!c) return (-2);
1906 /* Queue the given character for display */
1907 Term_queue_bigchar(Term->scr->cx, Term->scr->cy, a, c, 0, 0);
1909 /* Advance the cursor */
1913 if (Term->scr->cx < Term->wid) return (0);
1915 /* Note "Useless" cursor */
1918 /* Note "Useless" cursor */
1924 * At the current location, using an attr, add a string
1926 * We also take a length "n", using negative values to imply
1927 * the largest possible value, and then we use the minimum of
1928 * this length and the "actual" length of the string as the
1929 * actual number of characters to attempt to display, never
1930 * displaying more characters than will actually fit, since
1931 * we do NOT attempt to "wrap" the cursor at the screen edge.
1933 * We return "-1" if the cursor is currently unusable.
1934 * We return "N" if we were "only" able to write "N" chars,
1935 * even if all of the given characters fit on the screen,
1936 * and mark the cursor as unusable for future attempts.
1938 * So when this function, or the preceding one, return a
1939 * positive value, future calls to either function will
1940 * return negative ones.
1942 errr Term_addstr(int n, byte a, cptr s)
1950 /* Handle "unusable" cursor */
1951 if (Term->scr->cu) return (-1);
1953 /* Obtain maximal length */
1954 k = (n < 0) ? (w + 1) : n;
1956 /* Obtain the usable string length */
1957 for (n = 0; (n < k) && s[n]; n++) /* loop */;
1959 /* React to reaching the edge of the screen */
1960 if (Term->scr->cx + n >= w) res = n = w - Term->scr->cx;
1962 /* Queue the first "n" characters for display */
1963 Term_queue_chars(Term->scr->cx, Term->scr->cy, n, a, s);
1965 /* Advance the cursor */
1968 /* Hack -- Notice "Useless" cursor */
1969 if (res) Term->scr->cu = 1;
1971 /* Success (usually) */
1977 * Move to a location and, using an attr, add a char
1979 errr Term_putch(int x, int y, byte a, char c)
1984 if ((res = Term_gotoxy(x, y)) != 0) return (res);
1986 /* Then add the char */
1987 if ((res = Term_addch(a, c)) != 0) return (res);
1995 * Move to a location and, using an attr, add a string
1997 errr Term_putstr(int x, int y, int n, byte a, cptr s)
2002 if ((res = Term_gotoxy(x, y)) != 0) return (res);
2004 /* Then add the string */
2005 if ((res = Term_addstr(n, a, s)) != 0) return (res);
2013 * Move to a location and, using an attr, add a string vertically
2015 errr Term_putstr_v(int x, int y, int n, byte a, cptr s)
2022 for (i = 0; i < n && s[i] != 0; i++)
2025 if ((res = Term_gotoxy(x, y0)) != 0) return (res);
2029 if ((res = Term_addstr(2, a, &s[i])) != 0) return (res);
2032 if (s[i] == 0) break;
2034 if ((res = Term_addstr(1, a, &s[i])) != 0) return (res);
2045 * Place cursor at (x,y), and clear the next "n" chars
2047 errr Term_erase(int x, int y, int n)
2052 /* int h = Term->hgt; */
2057 int na = Term->attr_blank;
2058 int nc = Term->char_blank;
2067 if (Term_gotoxy(x, y)) return (-1);
2069 /* Force legal size */
2070 if (x + n > w) n = w - x;
2073 scr_aa = Term->scr->a[y];
2074 scr_cc = Term->scr->c[y];
2076 scr_taa = Term->scr->ta[y];
2077 scr_tcc = Term->scr->tc[y];
2081 * Á´³Ñʸ»ú¤Î±¦È¾Ê¬¤«¤éʸ»ú¤òɽ¼¨¤¹¤ë¾ì¹ç¡¢
2082 * ½Å¤Ê¤Ã¤¿Ê¸»ú¤Îº¸Éôʬ¤ò¾Ãµî¡£
2084 if (n > 0 && (((scr_aa[x] & AF_KANJI2) && !(scr_aa[x] & AF_TILE1))
2085 || (scr_aa[x] & AF_BIGTILE2) == AF_BIGTILE2))
2087 if (n > 0 && (scr_aa[x] & AF_BIGTILE2) == AF_BIGTILE2)
2094 /* Scan every column */
2095 for (i = 0; i < n; i++, x++)
2100 /* Hack -- Ignore "non-changes" */
2101 if ((oa == na) && (oc == nc)) continue;
2105 * Á´³Ñʸ»ú¤Îº¸È¾Ê¬¤Çɽ¼¨¤ò½ªÎ»¤¹¤ë¾ì¹ç¡¢
2106 * ½Å¤Ê¤Ã¤¿Ê¸»ú¤Î±¦Éôʬ¤ò¾Ãµî¡£
2108 * 2001/04/29 -- Habu
2109 * ¹Ô¤Î±¦Ã¼¤Î¾ì¹ç¤Ï¤³¤Î½èÍý¤ò¤·¤Ê¤¤¤è¤¦¤Ë½¤Àµ¡£
2111 if ((oa & AF_KANJI1) && (i + 1) == n && x != w - 1)
2114 /* Save the "literal" information */
2121 /* Track minimum changed column */
2124 /* Track maximum changed column */
2128 /* Expand the "change area" as needed */
2131 /* Check for new min/max row info */
2132 if (y < Term->y1) Term->y1 = y;
2133 if (y > Term->y2) Term->y2 = y;
2135 /* Check for new min/max col info in this row */
2136 if (x1 < Term->x1[y]) Term->x1[y] = x1;
2137 if (x2 > Term->x2[y]) Term->x2[y] = x2;
2146 * Clear the entire window, and move to the top left corner
2148 * Note the use of the special "total_erase" code
2150 errr Term_clear(void)
2157 byte na = Term->attr_blank;
2158 char nc = Term->char_blank;
2163 /* Cursor to the top left */
2164 Term->scr->cx = Term->scr->cy = 0;
2167 for (y = 0; y < h; y++)
2169 byte *scr_aa = Term->scr->a[y];
2170 char *scr_cc = Term->scr->c[y];
2172 byte *scr_taa = Term->scr->ta[y];
2173 char *scr_tcc = Term->scr->tc[y];
2175 /* Wipe each column */
2176 for (x = 0; x < w; x++)
2185 /* This row has changed */
2187 Term->x2[y] = w - 1;
2190 /* Every row has changed */
2194 /* Force "total erase" */
2195 Term->total_erase = TRUE;
2206 * Redraw (and refresh) the whole window.
2208 errr Term_redraw(void)
2210 /* Force "total erase" */
2211 Term->total_erase = TRUE;
2213 /* Hack -- Refresh */
2222 * Redraw part of a widow.
2224 errr Term_redraw_section(int x1, int y1, int x2, int y2)
2230 /* Bounds checking */
2231 if (y2 >= Term->hgt) y2 = Term->hgt - 1;
2232 if (x2 >= Term->wid) x2 = Term->wid - 1;
2240 /* Set the x limits */
2241 for (i = Term->y1; i <= Term->y2; i++)
2249 if (Term->scr->a[i][x1j] & AF_KANJI2) x1j--;
2252 if (x2j < Term->wid - 1)
2254 if (Term->scr->a[i][x2j] & AF_KANJI1) x2j++;
2260 c_ptr = Term->old->c[i];
2262 /* Clear the section so it is redrawn */
2263 for (j = x1j; j <= x2j; j++)
2265 /* Hack - set the old character to "none" */
2272 c_ptr = Term->old->c[i];
2274 /* Clear the section so it is redrawn */
2275 for (j = x1; j <= x2; j++)
2277 /* Hack - set the old character to "none" */
2283 /* Hack -- Refresh */
2292 /*** Access routines ***/
2296 * Extract the cursor visibility
2298 errr Term_get_cursor(int *v)
2300 /* Extract visibility */
2301 (*v) = Term->scr->cv;
2309 * Extract the current window size
2311 errr Term_get_size(int *w, int *h)
2313 /* Access the cursor */
2323 * Extract the current cursor location
2325 errr Term_locate(int *x, int *y)
2327 /* Access the cursor */
2328 (*x) = Term->scr->cx;
2329 (*y) = Term->scr->cy;
2331 /* Warn about "useless" cursor */
2332 if (Term->scr->cu) return (1);
2340 * At a given location, determine the "current" attr and char
2341 * Note that this refers to what will be on the window after the
2342 * next call to "Term_fresh()". It may or may not already be there.
2344 errr Term_what(int x, int y, byte *a, char *c)
2349 /* Verify location */
2350 if ((x < 0) || (x >= w)) return (-1);
2351 if ((y < 0) || (y >= h)) return (-1);
2354 (*a) = Term->scr->a[y][x];
2355 (*c) = Term->scr->c[y][x];
2363 /*** Input routines ***/
2367 * Flush and forget the input
2369 errr Term_flush(void)
2371 /* Hack -- Flush all events */
2372 Term_xtra(TERM_XTRA_FLUSH, 0);
2374 /* Forget all keypresses */
2375 Term->key_head = Term->key_tail = 0;
2384 * Add a keypress to the "queue"
2386 errr Term_keypress(int k)
2388 /* Hack -- Refuse to enqueue non-keys */
2389 if (!k) return (-1);
2391 /* Store the char, advance the queue */
2392 Term->key_queue[Term->key_head++] = k;
2394 /* Circular queue, handle wrap */
2395 if (Term->key_head == Term->key_size) Term->key_head = 0;
2397 /* Success (unless overflow) */
2398 if (Term->key_head != Term->key_tail) return (0);
2401 /* Hack -- Forget the oldest key */
2402 if (++Term->key_tail == Term->key_size) Term->key_tail = 0;
2411 * Add a keypress to the FRONT of the "queue"
2413 errr Term_key_push(int k)
2415 /* Hack -- Refuse to enqueue non-keys */
2416 if (!k) return (-1);
2418 /* Hack -- Overflow may induce circular queue */
2419 if (Term->key_tail == 0) Term->key_tail = Term->key_size;
2421 /* Back up, Store the char */
2422 Term->key_queue[--Term->key_tail] = k;
2424 /* Success (unless overflow) */
2425 if (Term->key_head != Term->key_tail) return (0);
2428 /* Hack -- Forget the oldest key */
2429 if (++Term->key_tail == Term->key_size) Term->key_tail = 0;
2441 * Check for a pending keypress on the key queue.
2443 * Store the keypress, if any, in "ch", and return "0".
2444 * Otherwise store "zero" in "ch", and return "1".
2446 * Wait for a keypress if "wait" is true.
2448 * Remove the keypress if "take" is true.
2450 errr Term_inkey(char *ch, bool wait, bool take)
2459 /* Hack -- get bored */
2460 if (!Term->never_bored)
2462 /* Process random events */
2463 Term_xtra(TERM_XTRA_BORED, 0);
2469 /* Process pending events while necessary */
2470 while (Term->key_head == Term->key_tail)
2472 /* Process events (wait for one) */
2473 Term_xtra(TERM_XTRA_EVENT, TRUE);
2480 /* Process pending events if necessary */
2481 if (Term->key_head == Term->key_tail)
2483 /* Process events (do not wait) */
2484 Term_xtra(TERM_XTRA_EVENT, FALSE);
2488 /* No keys are ready */
2489 if (Term->key_head == Term->key_tail) return (1);
2491 /* Extract the next keypress */
2492 (*ch) = Term->key_queue[Term->key_tail];
2494 /* If requested, advance the queue, wrap around if necessary */
2495 if (take && (++Term->key_tail == Term->key_size)) Term->key_tail = 0;
2503 /*** Extra routines ***/
2507 * Save the "requested" screen into the "memorized" screen
2509 * Every "Term_save()" should match exactly one "Term_load()"
2511 errr Term_save(void)
2519 /* Allocate window */
2520 MAKE(Term->mem, term_win);
2522 /* Initialize window */
2523 term_win_init(Term->mem, w, h);
2527 term_win_copy(Term->mem, Term->scr, w, h);
2535 * Restore the "requested" contents (see above).
2537 * Every "Term_save()" should match exactly one "Term_load()"
2539 errr Term_load(void)
2549 /* Allocate window */
2550 MAKE(Term->mem, term_win);
2552 /* Initialize window */
2553 term_win_init(Term->mem, w, h);
2557 term_win_copy(Term->scr, Term->mem, w, h);
2560 for (y = 0; y < h; y++)
2564 Term->x2[y] = w - 1;
2577 * Exchange the "requested" screen with the "tmp" screen
2579 errr Term_exchange(void)
2586 term_win *exchanger;
2592 /* Allocate window */
2593 MAKE(Term->tmp, term_win);
2595 /* Initialize window */
2596 term_win_init(Term->tmp, w, h);
2600 exchanger = Term->scr;
2601 Term->scr = Term->tmp;
2602 Term->tmp = exchanger;
2605 for (y = 0; y < h; y++)
2609 Term->x2[y] = w - 1;
2623 * React to a new physical window size.
2625 errr Term_resize(int w, int h)
2639 /* Resizing is forbidden */
2640 if (Term->fixed_shape) return (-1);
2642 /* Ignore illegal changes */
2643 if ((w < 1) || (h < 1)) return (-1);
2646 /* Ignore non-changes */
2647 if ((Term->wid == w) && (Term->hgt == h) && (arg_bigtile == use_bigtile))
2650 use_bigtile = arg_bigtile;
2652 /* Minimum dimensions */
2653 wid = MIN(Term->wid, w);
2654 hgt = MIN(Term->hgt, h);
2660 /* Save old window */
2661 hold_old = Term->old;
2663 /* Save old window */
2664 hold_scr = Term->scr;
2666 /* Save old window */
2667 hold_mem = Term->mem;
2669 /* Save old window */
2670 hold_tmp = Term->tmp;
2672 /* Create new scanners */
2673 C_MAKE(Term->x1, h, byte);
2674 C_MAKE(Term->x2, h, byte);
2676 /* Create new window */
2677 MAKE(Term->old, term_win);
2679 /* Initialize new window */
2680 term_win_init(Term->old, w, h);
2682 /* Save the contents */
2683 term_win_copy(Term->old, hold_old, wid, hgt);
2685 /* Create new window */
2686 MAKE(Term->scr, term_win);
2688 /* Initialize new window */
2689 term_win_init(Term->scr, w, h);
2691 /* Save the contents */
2692 term_win_copy(Term->scr, hold_scr, wid, hgt);
2697 /* Create new window */
2698 MAKE(Term->mem, term_win);
2700 /* Initialize new window */
2701 term_win_init(Term->mem, w, h);
2703 /* Save the contents */
2704 term_win_copy(Term->mem, hold_mem, wid, hgt);
2710 /* Create new window */
2711 MAKE(Term->tmp, term_win);
2713 /* Initialize new window */
2714 term_win_init(Term->tmp, w, h);
2716 /* Save the contents */
2717 term_win_copy(Term->tmp, hold_tmp, wid, hgt);
2720 /* Free some arrays */
2721 C_KILL(hold_x1, Term->hgt, byte);
2722 C_KILL(hold_x2, Term->hgt, byte);
2725 term_win_nuke(hold_old, Term->wid, Term->hgt);
2728 KILL(hold_old, term_win);
2730 /* Illegal cursor */
2731 if (Term->old->cx >= w) Term->old->cu = 1;
2732 if (Term->old->cy >= h) Term->old->cu = 1;
2735 term_win_nuke(hold_scr, Term->wid, Term->hgt);
2738 KILL(hold_scr, term_win);
2740 /* Illegal cursor */
2741 if (Term->scr->cx >= w) Term->scr->cu = 1;
2742 if (Term->scr->cy >= h) Term->scr->cu = 1;
2748 term_win_nuke(hold_mem, Term->wid, Term->hgt);
2751 KILL(hold_mem, term_win);
2753 /* Illegal cursor */
2754 if (Term->mem->cx >= w) Term->mem->cu = 1;
2755 if (Term->mem->cy >= h) Term->mem->cu = 1;
2762 term_win_nuke(hold_tmp, Term->wid, Term->hgt);
2765 KILL(hold_tmp, term_win);
2767 /* Illegal cursor */
2768 if (Term->tmp->cx >= w) Term->tmp->cu = 1;
2769 if (Term->tmp->cy >= h) Term->tmp->cu = 1;
2776 /* Force "total erase" */
2777 Term->total_erase = TRUE;
2780 for (i = 0; i < h; i++)
2784 Term->x2[i] = w - 1;
2791 /* Execute the "resize_hook" hook, if available */
2792 if (Term->resize_hook)
2794 Term->resize_hook();
2804 * Activate a new Term (and deactivate the current Term)
2806 * This function is extremely important, and also somewhat bizarre.
2807 * It is the only function that should "modify" the value of "Term".
2809 * To "create" a valid "term", one should do "term_init(t)", then
2810 * set the various flags and hooks, and then do "Term_activate(t)".
2812 errr Term_activate(term *t)
2814 /* Hack -- already done */
2815 if (Term == t) return (1);
2817 /* Deactivate the old Term */
2818 if (Term) Term_xtra(TERM_XTRA_LEVEL, 0);
2820 /* Hack -- Call the special "init" hook */
2821 if (t && !t->active_flag)
2823 /* Call the "init" hook */
2824 if (t->init_hook) (*t->init_hook)(t);
2827 t->active_flag = TRUE;
2830 t->mapped_flag = TRUE;
2833 /* Remember the Term */
2836 /* Activate the new Term */
2837 if (Term) Term_xtra(TERM_XTRA_LEVEL, 1);
2848 errr term_nuke(term *t)
2854 /* Hack -- Call the special "nuke" hook */
2857 /* Call the "nuke" hook */
2858 if (t->nuke_hook) (*t->nuke_hook)(t);
2861 t->active_flag = FALSE;
2863 /* Assume not mapped */
2864 t->mapped_flag = FALSE;
2868 /* Nuke "displayed" */
2869 term_win_nuke(t->old, w, h);
2871 /* Kill "displayed" */
2872 KILL(t->old, term_win);
2874 /* Nuke "requested" */
2875 term_win_nuke(t->scr, w, h);
2877 /* Kill "requested" */
2878 KILL(t->scr, term_win);
2883 /* Nuke "memorized" */
2884 term_win_nuke(t->mem, w, h);
2886 /* Kill "memorized" */
2887 KILL(t->mem, term_win);
2893 /* Nuke "temporary" */
2894 term_win_nuke(t->tmp, w, h);
2896 /* Kill "temporary" */
2897 KILL(t->tmp, term_win);
2900 /* Free some arrays */
2901 C_KILL(t->x1, h, byte);
2902 C_KILL(t->x2, h, byte);
2904 /* Free the input queue */
2905 C_KILL(t->key_queue, t->key_size, char);
2913 * Initialize a term, using a window of the given size.
2914 * Also prepare the "input queue" for "k" keypresses
2915 * By default, the cursor starts out "invisible"
2916 * By default, we "erase" using "black spaces"
2918 errr term_init(term *t, int w, int h, int k)
2924 (void)WIPE(t, term);
2927 /* Prepare the input queue */
2928 t->key_head = t->key_tail = 0;
2930 /* Determine the input queue size */
2933 /* Allocate the input queue */
2934 C_MAKE(t->key_queue, t->key_size, char);
2941 /* Allocate change arrays */
2942 C_MAKE(t->x1, h, byte);
2943 C_MAKE(t->x2, h, byte);
2946 /* Allocate "displayed" */
2947 MAKE(t->old, term_win);
2949 /* Initialize "displayed" */
2950 term_win_init(t->old, w, h);
2953 /* Allocate "requested" */
2954 MAKE(t->scr, term_win);
2956 /* Initialize "requested" */
2957 term_win_init(t->scr, w, h);
2961 for (y = 0; y < h; y++)
2972 /* Force "total erase" */
2973 t->total_erase = TRUE;
2976 /* Default "blank" */
2978 t->char_blank = ' ';
2981 /* Prepare "fake" hooks to prevent core dumps */
2982 t->curs_hook = Term_curs_hack;
2983 t->bigcurs_hook = Term_bigcurs_hack;
2984 t->wipe_hook = Term_wipe_hack;
2985 t->text_hook = Term_text_hack;
2986 t->pict_hook = Term_pict_hack;