2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 2008-2009 Ed Schouten <ed@FreeBSD.org>
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31 #include <sys/cdefs.h>
32 #if defined(__FreeBSD__) && defined(_KERNEL)
33 #include <sys/param.h>
34 #include <sys/limits.h>
36 #include <sys/systm.h>
37 #define teken_assert(x) MPASS(x)
38 #else /* !(__FreeBSD__ && _KERNEL) */
39 #include <sys/types.h>
45 #define teken_assert(x) assert(x)
46 #endif /* __FreeBSD__ && _KERNEL */
49 #define teken_printf(x,...)
51 /* Private flags for t_stateflags. */
52 #define TS_FIRSTDIGIT 0x0001 /* First numeric digit in escape sequence. */
53 #define TS_INSERT 0x0002 /* Insert mode. */
54 #define TS_AUTOWRAP 0x0004 /* Autowrap. */
55 #define TS_ORIGIN 0x0008 /* Origin mode. */
56 #define TS_WRAPPED 0x0010 /* Next character should be printed on col 0. */
57 #define TS_8BIT 0x0020 /* UTF-8 disabled. */
58 #define TS_CONS25 0x0040 /* cons25 emulation. */
59 #define TS_INSTRING 0x0080 /* Inside string. */
60 #define TS_CURSORKEYS 0x0100 /* Cursor keys mode. */
62 /* Character that blanks a cell. */
66 #include "teken_wcwidth.h"
67 #include "teken_scs.h"
69 static teken_state_t teken_state_init;
76 teken_funcs_bell(const teken_t *t)
79 teken_assert(t->t_funcs->tf_bell != NULL);
80 t->t_funcs->tf_bell(t->t_softc);
84 teken_funcs_cursor(const teken_t *t)
87 teken_assert(t->t_cursor.tp_row < t->t_winsize.tp_row);
88 teken_assert(t->t_cursor.tp_col < t->t_winsize.tp_col);
90 teken_assert(t->t_funcs->tf_cursor != NULL);
91 t->t_funcs->tf_cursor(t->t_softc, &t->t_cursor);
95 teken_funcs_putchar(const teken_t *t, const teken_pos_t *p, teken_char_t c,
96 const teken_attr_t *a)
99 teken_assert(p->tp_row < t->t_winsize.tp_row);
100 teken_assert(p->tp_col < t->t_winsize.tp_col);
102 teken_assert(t->t_funcs->tf_putchar != NULL);
103 t->t_funcs->tf_putchar(t->t_softc, p, c, a);
107 teken_funcs_fill(const teken_t *t, const teken_rect_t *r,
108 const teken_char_t c, const teken_attr_t *a)
111 teken_assert(r->tr_end.tp_row > r->tr_begin.tp_row);
112 teken_assert(r->tr_end.tp_row <= t->t_winsize.tp_row);
113 teken_assert(r->tr_end.tp_col > r->tr_begin.tp_col);
114 teken_assert(r->tr_end.tp_col <= t->t_winsize.tp_col);
116 teken_assert(t->t_funcs->tf_fill != NULL);
117 t->t_funcs->tf_fill(t->t_softc, r, c, a);
121 teken_funcs_copy(const teken_t *t, const teken_rect_t *r, const teken_pos_t *p)
124 teken_assert(r->tr_end.tp_row > r->tr_begin.tp_row);
125 teken_assert(r->tr_end.tp_row <= t->t_winsize.tp_row);
126 teken_assert(r->tr_end.tp_col > r->tr_begin.tp_col);
127 teken_assert(r->tr_end.tp_col <= t->t_winsize.tp_col);
128 teken_assert(p->tp_row + (r->tr_end.tp_row - r->tr_begin.tp_row) <= t->t_winsize.tp_row);
129 teken_assert(p->tp_col + (r->tr_end.tp_col - r->tr_begin.tp_col) <= t->t_winsize.tp_col);
131 teken_assert(t->t_funcs->tf_copy != NULL);
132 t->t_funcs->tf_copy(t->t_softc, r, p);
136 teken_funcs_param(const teken_t *t, int cmd, unsigned int value)
139 teken_assert(t->t_funcs->tf_param != NULL);
140 t->t_funcs->tf_param(t->t_softc, cmd, value);
144 teken_funcs_respond(const teken_t *t, const void *buf, size_t len)
147 teken_assert(t->t_funcs->tf_respond != NULL);
148 t->t_funcs->tf_respond(t->t_softc, buf, len);
151 #include "teken_subr.h"
152 #include "teken_subr_compat.h"
155 * Programming interface.
159 teken_init(teken_t *t, const teken_funcs_t *tf, void *softc)
161 teken_pos_t tp = { .tp_row = 24, .tp_col = 80 };
166 t->t_nextstate = teken_state_init;
170 t->t_defattr.ta_format = 0;
171 t->t_defattr.ta_fgcolor = TC_WHITE;
172 t->t_defattr.ta_bgcolor = TC_BLACK;
173 teken_subr_do_reset(t);
175 teken_set_winsize(t, &tp);
179 teken_input_char(teken_t *t, teken_char_t c)
183 * There is no support for DCS and OSC. Just discard strings
184 * until we receive characters that may indicate string
187 if (t->t_stateflags & TS_INSTRING) {
190 t->t_stateflags &= ~TS_INSTRING;
193 t->t_stateflags &= ~TS_INSTRING;
207 teken_subr_backspace(t);
211 teken_subr_newline(t);
214 teken_subr_newpage(t);
217 if (t->t_stateflags & TS_CONS25)
218 t->t_nextstate(t, c);
223 if (t->t_stateflags & TS_CONS25)
224 t->t_nextstate(t, c);
229 teken_subr_carriage_return(t);
232 teken_subr_horizontal_tab(t);
235 t->t_nextstate(t, c);
239 /* Post-processing assertions. */
240 teken_assert(t->t_cursor.tp_row >= t->t_originreg.ts_begin);
241 teken_assert(t->t_cursor.tp_row < t->t_originreg.ts_end);
242 teken_assert(t->t_cursor.tp_row < t->t_winsize.tp_row);
243 teken_assert(t->t_cursor.tp_col < t->t_winsize.tp_col);
244 teken_assert(t->t_saved_cursor.tp_row < t->t_winsize.tp_row);
245 teken_assert(t->t_saved_cursor.tp_col < t->t_winsize.tp_col);
246 teken_assert(t->t_scrollreg.ts_end <= t->t_winsize.tp_row);
247 teken_assert(t->t_scrollreg.ts_begin < t->t_scrollreg.ts_end);
248 /* Origin region has to be window size or the same as scrollreg. */
249 teken_assert((t->t_originreg.ts_begin == t->t_scrollreg.ts_begin &&
250 t->t_originreg.ts_end == t->t_scrollreg.ts_end) ||
251 (t->t_originreg.ts_begin == 0 &&
252 t->t_originreg.ts_end == t->t_winsize.tp_row));
256 teken_input_byte(teken_t *t, unsigned char c)
262 if ((c & 0x80) == 0x00 || t->t_stateflags & TS_8BIT) {
263 /* One-byte sequence. */
265 teken_input_char(t, c);
266 } else if ((c & 0xe0) == 0xc0) {
267 /* Two-byte sequence. */
269 t->t_utf8_partial = c & 0x1f;
270 } else if ((c & 0xf0) == 0xe0) {
271 /* Three-byte sequence. */
273 t->t_utf8_partial = c & 0x0f;
274 } else if ((c & 0xf8) == 0xf0) {
275 /* Four-byte sequence. */
277 t->t_utf8_partial = c & 0x07;
278 } else if ((c & 0xc0) == 0x80) {
279 if (t->t_utf8_left == 0)
282 t->t_utf8_partial = (t->t_utf8_partial << 6) | (c & 0x3f);
283 if (t->t_utf8_left == 0) {
284 teken_printf("Got UTF-8 char %x\n", t->t_utf8_partial);
285 teken_input_char(t, t->t_utf8_partial);
291 teken_input(teken_t *t, const void *buf, size_t len)
296 teken_input_byte(t, *c++);
300 teken_get_cursor(const teken_t *t)
303 return (&t->t_cursor);
307 teken_set_cursor(teken_t *t, const teken_pos_t *p)
310 /* XXX: bounds checking with originreg! */
311 teken_assert(p->tp_row < t->t_winsize.tp_row);
312 teken_assert(p->tp_col < t->t_winsize.tp_col);
318 teken_get_curattr(const teken_t *t)
321 return (&t->t_curattr);
325 teken_set_curattr(teken_t *t, const teken_attr_t *a)
332 teken_get_defattr(const teken_t *t)
335 return (&t->t_defattr);
339 teken_set_defattr(teken_t *t, const teken_attr_t *a)
342 t->t_curattr = t->t_saved_curattr = t->t_defattr = *a;
346 teken_get_winsize(const teken_t *t)
349 return (&t->t_winsize);
353 teken_trim_cursor_pos(teken_t *t, const teken_pos_t *new)
355 const teken_pos_t *cur;
359 if (cur->tp_row < new->tp_row || cur->tp_col < new->tp_col)
361 if (t->t_cursor.tp_row >= new->tp_row)
362 t->t_cursor.tp_row = new->tp_row - 1;
363 if (t->t_cursor.tp_col >= new->tp_col)
364 t->t_cursor.tp_col = new->tp_col - 1;
368 teken_set_winsize(teken_t *t, const teken_pos_t *p)
371 teken_trim_cursor_pos(t, p);
373 teken_subr_do_reset(t);
377 teken_set_winsize_noreset(teken_t *t, const teken_pos_t *p)
380 teken_trim_cursor_pos(t, p);
382 teken_subr_do_resize(t);
386 teken_set_8bit(teken_t *t)
389 t->t_stateflags |= TS_8BIT;
393 teken_set_cons25(teken_t *t)
396 t->t_stateflags |= TS_CONS25;
404 teken_state_switch(teken_t *t, teken_state_t *s)
409 t->t_stateflags |= TS_FIRSTDIGIT;
413 teken_state_numbers(teken_t *t, teken_char_t c)
416 teken_assert(t->t_curnum < T_NUMSIZE);
418 if (c >= '0' && c <= '9') {
419 if (t->t_stateflags & TS_FIRSTDIGIT) {
421 t->t_stateflags &= ~TS_FIRSTDIGIT;
422 t->t_nums[t->t_curnum] = c - '0';
423 } else if (t->t_nums[t->t_curnum] < UINT_MAX / 100) {
425 * There is no need to continue parsing input
426 * once the value exceeds the size of the
427 * terminal. It would only allow for integer
428 * overflows when performing arithmetic on the
431 * Ignore any further digits if the value is
432 * already UINT_MAX / 100.
434 t->t_nums[t->t_curnum] =
435 t->t_nums[t->t_curnum] * 10 + c - '0';
438 } else if (c == ';') {
439 if (t->t_stateflags & TS_FIRSTDIGIT)
440 t->t_nums[t->t_curnum] = 0;
442 /* Only allow a limited set of arguments. */
443 if (++t->t_curnum == T_NUMSIZE) {
444 teken_state_switch(t, teken_state_init);
448 t->t_stateflags |= TS_FIRSTDIGIT;
451 if (t->t_stateflags & TS_FIRSTDIGIT && t->t_curnum > 0) {
452 /* Finish off the last empty argument. */
453 t->t_nums[t->t_curnum] = 0;
455 } else if ((t->t_stateflags & TS_FIRSTDIGIT) == 0) {
456 /* Also count the last argument. */
472 #define K (TC_BLACK | TC_LIGHT)
473 #define B (TC_BLUE | TC_LIGHT)
474 #define Y (TC_BROWN | TC_LIGHT)
475 #define C (TC_CYAN | TC_LIGHT)
476 #define G (TC_GREEN | TC_LIGHT)
477 #define M (TC_MAGENTA | TC_LIGHT)
478 #define R (TC_RED | TC_LIGHT)
479 #define W (TC_WHITE | TC_LIGHT)
482 * The xterm-256 color map has steps of 0x28 (in the range 0-0xff), except
483 * for the first step which is 0x5f. Scale to the range 0-6 by dividing
484 * by 0x28 and rounding down. The range of 0-5 cannot represent the
487 * This table is generated by the follow rules:
488 * - if all components are equal, the result is black for (0, 0, 0) and
489 * (2, 2, 2), else white; otherwise:
490 * - subtract the smallest component from all components
491 * - if this gives only one nonzero component, then that is the color
492 * - else if one component is 2 or more larger than the other nonzero one,
493 * then that component gives the color
494 * - else there are 2 nonzero components. The color is that of a small
495 * equal mixture of these components (cyan, yellow or magenta). E.g.,
496 * (0, 5, 6) (Turquoise2) is a much purer cyan than (0, 2, 3)
497 * (DeepSkyBlue4), but we map both to cyan since we can't represent
498 * delicate shades of either blue or cyan and blue would be worse.
499 * Here it is important that components of 1 never occur. Blue would
500 * be twice as large as green in (0, 1, 2).
502 static const teken_color_t teken_256to8tab[] = {
503 /* xterm normal colors: */
504 k, r, g, y, b, m, c, w,
506 /* xterm bright colors: */
507 k, r, g, y, b, m, c, w,
565 * This table is generated from the previous one by setting TC_LIGHT for
566 * entries whose luminosity in the xterm256 color map is 60% or larger.
567 * Thus the previous table is currently not really needed. It will be
568 * used for different fine tuning of the tables.
570 static const teken_color_t teken_256to16tab[] = {
571 /* xterm normal colors: */
572 k, r, g, y, b, m, c, w,
574 /* xterm bright colors: */
575 K, R, G, Y, B, M, C, W,
650 teken_256to8(teken_color_t c)
653 return (teken_256to8tab[c % 256]);
657 teken_256to16(teken_color_t c)
660 return (teken_256to16tab[c % 256]);
663 static const char * const special_strings_cons25[] = {
664 [TKEY_UP] = "\x1B[A", [TKEY_DOWN] = "\x1B[B",
665 [TKEY_LEFT] = "\x1B[D", [TKEY_RIGHT] = "\x1B[C",
667 [TKEY_HOME] = "\x1B[H", [TKEY_END] = "\x1B[F",
668 [TKEY_INSERT] = "\x1B[L", [TKEY_DELETE] = "\x7F",
669 [TKEY_PAGE_UP] = "\x1B[I", [TKEY_PAGE_DOWN] = "\x1B[G",
671 [TKEY_F1] = "\x1B[M", [TKEY_F2] = "\x1B[N",
672 [TKEY_F3] = "\x1B[O", [TKEY_F4] = "\x1B[P",
673 [TKEY_F5] = "\x1B[Q", [TKEY_F6] = "\x1B[R",
674 [TKEY_F7] = "\x1B[S", [TKEY_F8] = "\x1B[T",
675 [TKEY_F9] = "\x1B[U", [TKEY_F10] = "\x1B[V",
676 [TKEY_F11] = "\x1B[W", [TKEY_F12] = "\x1B[X",
679 static const char * const special_strings_ckeys[] = {
680 [TKEY_UP] = "\x1BOA", [TKEY_DOWN] = "\x1BOB",
681 [TKEY_LEFT] = "\x1BOD", [TKEY_RIGHT] = "\x1BOC",
683 [TKEY_HOME] = "\x1BOH", [TKEY_END] = "\x1BOF",
686 static const char * const special_strings_normal[] = {
687 [TKEY_UP] = "\x1B[A", [TKEY_DOWN] = "\x1B[B",
688 [TKEY_LEFT] = "\x1B[D", [TKEY_RIGHT] = "\x1B[C",
690 [TKEY_HOME] = "\x1B[H", [TKEY_END] = "\x1B[F",
691 [TKEY_INSERT] = "\x1B[2~", [TKEY_DELETE] = "\x1B[3~",
692 [TKEY_PAGE_UP] = "\x1B[5~", [TKEY_PAGE_DOWN] = "\x1B[6~",
694 [TKEY_F1] = "\x1BOP", [TKEY_F2] = "\x1BOQ",
695 [TKEY_F3] = "\x1BOR", [TKEY_F4] = "\x1BOS",
696 [TKEY_F5] = "\x1B[15~", [TKEY_F6] = "\x1B[17~",
697 [TKEY_F7] = "\x1B[18~", [TKEY_F8] = "\x1B[19~",
698 [TKEY_F9] = "\x1B[20~", [TKEY_F10] = "\x1B[21~",
699 [TKEY_F11] = "\x1B[23~", [TKEY_F12] = "\x1B[24~",
703 teken_get_sequence(const teken_t *t, unsigned int k)
707 if (t->t_stateflags & TS_CONS25 &&
708 k < sizeof special_strings_cons25 / sizeof(char *))
709 return (special_strings_cons25[k]);
711 /* Cursor keys mode. */
712 if (t->t_stateflags & TS_CURSORKEYS &&
713 k < sizeof special_strings_ckeys / sizeof(char *))
714 return (special_strings_ckeys[k]);
716 /* Default xterm sequences. */
717 if (k < sizeof special_strings_normal / sizeof(char *))
718 return (special_strings_normal[k]);
723 #include "teken_state.h"