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. */
61 #define TS_CONS25KEYS 0x0400 /* Fuller cons25 emul (fix function keys). */
63 /* Character that blanks a cell. */
67 #include "teken_wcwidth.h"
68 #include "teken_scs.h"
70 static teken_state_t teken_state_init;
77 teken_funcs_bell(const teken_t *t)
80 teken_assert(t->t_funcs->tf_bell != NULL);
81 t->t_funcs->tf_bell(t->t_softc);
85 teken_funcs_cursor(const teken_t *t)
88 teken_assert(t->t_cursor.tp_row < t->t_winsize.tp_row);
89 teken_assert(t->t_cursor.tp_col < t->t_winsize.tp_col);
91 teken_assert(t->t_funcs->tf_cursor != NULL);
92 t->t_funcs->tf_cursor(t->t_softc, &t->t_cursor);
96 teken_funcs_putchar(const teken_t *t, const teken_pos_t *p, teken_char_t c,
97 const teken_attr_t *a)
100 teken_assert(p->tp_row < t->t_winsize.tp_row);
101 teken_assert(p->tp_col < t->t_winsize.tp_col);
103 teken_assert(t->t_funcs->tf_putchar != NULL);
104 t->t_funcs->tf_putchar(t->t_softc, p, c, a);
108 teken_funcs_fill(const teken_t *t, const teken_rect_t *r,
109 const teken_char_t c, const teken_attr_t *a)
112 teken_assert(r->tr_end.tp_row > r->tr_begin.tp_row);
113 teken_assert(r->tr_end.tp_row <= t->t_winsize.tp_row);
114 teken_assert(r->tr_end.tp_col > r->tr_begin.tp_col);
115 teken_assert(r->tr_end.tp_col <= t->t_winsize.tp_col);
117 teken_assert(t->t_funcs->tf_fill != NULL);
118 t->t_funcs->tf_fill(t->t_softc, r, c, a);
122 teken_funcs_copy(const teken_t *t, const teken_rect_t *r, const teken_pos_t *p)
125 teken_assert(r->tr_end.tp_row > r->tr_begin.tp_row);
126 teken_assert(r->tr_end.tp_row <= t->t_winsize.tp_row);
127 teken_assert(r->tr_end.tp_col > r->tr_begin.tp_col);
128 teken_assert(r->tr_end.tp_col <= t->t_winsize.tp_col);
129 teken_assert(p->tp_row + (r->tr_end.tp_row - r->tr_begin.tp_row) <= t->t_winsize.tp_row);
130 teken_assert(p->tp_col + (r->tr_end.tp_col - r->tr_begin.tp_col) <= t->t_winsize.tp_col);
132 teken_assert(t->t_funcs->tf_copy != NULL);
133 t->t_funcs->tf_copy(t->t_softc, r, p);
137 teken_funcs_pre_input(const teken_t *t)
140 if (t->t_funcs->tf_pre_input != NULL)
141 t->t_funcs->tf_pre_input(t->t_softc);
145 teken_funcs_post_input(const teken_t *t)
148 if (t->t_funcs->tf_post_input != NULL)
149 t->t_funcs->tf_post_input(t->t_softc);
153 teken_funcs_param(const teken_t *t, int cmd, unsigned int value)
156 teken_assert(t->t_funcs->tf_param != NULL);
157 t->t_funcs->tf_param(t->t_softc, cmd, value);
161 teken_funcs_respond(const teken_t *t, const void *buf, size_t len)
164 teken_assert(t->t_funcs->tf_respond != NULL);
165 t->t_funcs->tf_respond(t->t_softc, buf, len);
168 #include "teken_subr.h"
169 #include "teken_subr_compat.h"
172 * Programming interface.
176 teken_init(teken_t *t, const teken_funcs_t *tf, void *softc)
178 teken_pos_t tp = { .tp_row = 24, .tp_col = 80 };
183 t->t_nextstate = teken_state_init;
187 t->t_defattr.ta_format = 0;
188 t->t_defattr.ta_fgcolor = TC_WHITE;
189 t->t_defattr.ta_bgcolor = TC_BLACK;
190 teken_subr_do_reset(t);
192 teken_set_winsize(t, &tp);
196 teken_input_char(teken_t *t, teken_char_t c)
200 * There is no support for DCS and OSC. Just discard strings
201 * until we receive characters that may indicate string
204 if (t->t_stateflags & TS_INSTRING) {
207 t->t_stateflags &= ~TS_INSTRING;
210 t->t_stateflags &= ~TS_INSTRING;
224 teken_subr_backspace(t);
228 teken_subr_newline(t);
231 teken_subr_newpage(t);
234 if (t->t_stateflags & TS_CONS25)
235 t->t_nextstate(t, c);
240 if (t->t_stateflags & TS_CONS25)
241 t->t_nextstate(t, c);
246 teken_subr_carriage_return(t);
249 teken_subr_horizontal_tab(t);
252 t->t_nextstate(t, c);
256 /* Post-processing assertions. */
257 teken_assert(t->t_cursor.tp_row >= t->t_originreg.ts_begin);
258 teken_assert(t->t_cursor.tp_row < t->t_originreg.ts_end);
259 teken_assert(t->t_cursor.tp_row < t->t_winsize.tp_row);
260 teken_assert(t->t_cursor.tp_col < t->t_winsize.tp_col);
261 teken_assert(t->t_saved_cursor.tp_row < t->t_winsize.tp_row);
262 teken_assert(t->t_saved_cursor.tp_col < t->t_winsize.tp_col);
263 teken_assert(t->t_scrollreg.ts_end <= t->t_winsize.tp_row);
264 teken_assert(t->t_scrollreg.ts_begin < t->t_scrollreg.ts_end);
265 /* Origin region has to be window size or the same as scrollreg. */
266 teken_assert((t->t_originreg.ts_begin == t->t_scrollreg.ts_begin &&
267 t->t_originreg.ts_end == t->t_scrollreg.ts_end) ||
268 (t->t_originreg.ts_begin == 0 &&
269 t->t_originreg.ts_end == t->t_winsize.tp_row));
273 teken_input_byte(teken_t *t, unsigned char c)
279 if ((c & 0x80) == 0x00 || t->t_stateflags & TS_8BIT) {
280 /* One-byte sequence. */
282 teken_input_char(t, c);
283 } else if ((c & 0xe0) == 0xc0) {
284 /* Two-byte sequence. */
286 t->t_utf8_partial = c & 0x1f;
287 } else if ((c & 0xf0) == 0xe0) {
288 /* Three-byte sequence. */
290 t->t_utf8_partial = c & 0x0f;
291 } else if ((c & 0xf8) == 0xf0) {
292 /* Four-byte sequence. */
294 t->t_utf8_partial = c & 0x07;
295 } else if ((c & 0xc0) == 0x80) {
296 if (t->t_utf8_left == 0)
299 t->t_utf8_partial = (t->t_utf8_partial << 6) | (c & 0x3f);
300 if (t->t_utf8_left == 0) {
301 teken_printf("Got UTF-8 char %x\n", t->t_utf8_partial);
302 teken_input_char(t, t->t_utf8_partial);
308 teken_input(teken_t *t, const void *buf, size_t len)
312 teken_funcs_pre_input(t);
314 teken_input_byte(t, *c++);
315 teken_funcs_post_input(t);
319 teken_get_cursor(const teken_t *t)
322 return (&t->t_cursor);
326 teken_set_cursor(teken_t *t, const teken_pos_t *p)
329 /* XXX: bounds checking with originreg! */
330 teken_assert(p->tp_row < t->t_winsize.tp_row);
331 teken_assert(p->tp_col < t->t_winsize.tp_col);
337 teken_get_curattr(const teken_t *t)
340 return (&t->t_curattr);
344 teken_set_curattr(teken_t *t, const teken_attr_t *a)
351 teken_get_defattr(const teken_t *t)
354 return (&t->t_defattr);
358 teken_set_defattr(teken_t *t, const teken_attr_t *a)
361 t->t_curattr = t->t_saved_curattr = t->t_defattr = *a;
365 teken_get_winsize(const teken_t *t)
368 return (&t->t_winsize);
372 teken_trim_cursor_pos(teken_t *t, const teken_pos_t *new)
374 const teken_pos_t *cur;
378 if (cur->tp_row < new->tp_row || cur->tp_col < new->tp_col)
380 if (t->t_cursor.tp_row >= new->tp_row)
381 t->t_cursor.tp_row = new->tp_row - 1;
382 if (t->t_cursor.tp_col >= new->tp_col)
383 t->t_cursor.tp_col = new->tp_col - 1;
387 teken_set_winsize(teken_t *t, const teken_pos_t *p)
390 teken_trim_cursor_pos(t, p);
392 teken_subr_do_reset(t);
396 teken_set_winsize_noreset(teken_t *t, const teken_pos_t *p)
399 teken_trim_cursor_pos(t, p);
401 teken_subr_do_resize(t);
405 teken_set_8bit(teken_t *t)
408 t->t_stateflags |= TS_8BIT;
412 teken_set_cons25(teken_t *t)
415 t->t_stateflags |= TS_CONS25;
419 teken_set_cons25keys(teken_t *t)
422 t->t_stateflags |= TS_CONS25KEYS;
430 teken_state_switch(teken_t *t, teken_state_t *s)
435 t->t_stateflags |= TS_FIRSTDIGIT;
439 teken_state_numbers(teken_t *t, teken_char_t c)
442 teken_assert(t->t_curnum < T_NUMSIZE);
444 if (c >= '0' && c <= '9') {
445 if (t->t_stateflags & TS_FIRSTDIGIT) {
447 t->t_stateflags &= ~TS_FIRSTDIGIT;
448 t->t_nums[t->t_curnum] = c - '0';
449 } else if (t->t_nums[t->t_curnum] < UINT_MAX / 100) {
451 * There is no need to continue parsing input
452 * once the value exceeds the size of the
453 * terminal. It would only allow for integer
454 * overflows when performing arithmetic on the
457 * Ignore any further digits if the value is
458 * already UINT_MAX / 100.
460 t->t_nums[t->t_curnum] =
461 t->t_nums[t->t_curnum] * 10 + c - '0';
464 } else if (c == ';') {
465 if (t->t_stateflags & TS_FIRSTDIGIT)
466 t->t_nums[t->t_curnum] = 0;
468 /* Only allow a limited set of arguments. */
469 if (++t->t_curnum == T_NUMSIZE) {
470 teken_state_switch(t, teken_state_init);
474 t->t_stateflags |= TS_FIRSTDIGIT;
477 if (t->t_stateflags & TS_FIRSTDIGIT && t->t_curnum > 0) {
478 /* Finish off the last empty argument. */
479 t->t_nums[t->t_curnum] = 0;
481 } else if ((t->t_stateflags & TS_FIRSTDIGIT) == 0) {
482 /* Also count the last argument. */
498 #define K (TC_BLACK | TC_LIGHT)
499 #define B (TC_BLUE | TC_LIGHT)
500 #define Y (TC_BROWN | TC_LIGHT)
501 #define C (TC_CYAN | TC_LIGHT)
502 #define G (TC_GREEN | TC_LIGHT)
503 #define M (TC_MAGENTA | TC_LIGHT)
504 #define R (TC_RED | TC_LIGHT)
505 #define W (TC_WHITE | TC_LIGHT)
508 * The xterm-256 color map has steps of 0x28 (in the range 0-0xff), except
509 * for the first step which is 0x5f. Scale to the range 0-6 by dividing
510 * by 0x28 and rounding down. The range of 0-5 cannot represent the
513 * This table is generated by the follow rules:
514 * - if all components are equal, the result is black for (0, 0, 0) and
515 * (2, 2, 2), else white; otherwise:
516 * - subtract the smallest component from all components
517 * - if this gives only one nonzero component, then that is the color
518 * - else if one component is 2 or more larger than the other nonzero one,
519 * then that component gives the color
520 * - else there are 2 nonzero components. The color is that of a small
521 * equal mixture of these components (cyan, yellow or magenta). E.g.,
522 * (0, 5, 6) (Turquoise2) is a much purer cyan than (0, 2, 3)
523 * (DeepSkyBlue4), but we map both to cyan since we can't represent
524 * delicate shades of either blue or cyan and blue would be worse.
525 * Here it is important that components of 1 never occur. Blue would
526 * be twice as large as green in (0, 1, 2).
528 static const teken_color_t teken_256to8tab[] = {
529 /* xterm normal colors: */
530 k, r, g, y, b, m, c, w,
532 /* xterm bright colors: */
533 k, r, g, y, b, m, c, w,
591 * This table is generated from the previous one by setting TC_LIGHT for
592 * entries whose luminosity in the xterm256 color map is 60% or larger.
593 * Thus the previous table is currently not really needed. It will be
594 * used for different fine tuning of the tables.
596 static const teken_color_t teken_256to16tab[] = {
597 /* xterm normal colors: */
598 k, r, g, y, b, m, c, w,
600 /* xterm bright colors: */
601 K, R, G, Y, B, M, C, W,
676 teken_256to8(teken_color_t c)
679 return (teken_256to8tab[c % 256]);
683 teken_256to16(teken_color_t c)
686 return (teken_256to16tab[c % 256]);
689 static const char * const special_strings_cons25[] = {
690 [TKEY_UP] = "\x1B[A", [TKEY_DOWN] = "\x1B[B",
691 [TKEY_LEFT] = "\x1B[D", [TKEY_RIGHT] = "\x1B[C",
693 [TKEY_HOME] = "\x1B[H", [TKEY_END] = "\x1B[F",
694 [TKEY_INSERT] = "\x1B[L", [TKEY_DELETE] = "\x7F",
695 [TKEY_PAGE_UP] = "\x1B[I", [TKEY_PAGE_DOWN] = "\x1B[G",
697 [TKEY_F1] = "\x1B[M", [TKEY_F2] = "\x1B[N",
698 [TKEY_F3] = "\x1B[O", [TKEY_F4] = "\x1B[P",
699 [TKEY_F5] = "\x1B[Q", [TKEY_F6] = "\x1B[R",
700 [TKEY_F7] = "\x1B[S", [TKEY_F8] = "\x1B[T",
701 [TKEY_F9] = "\x1B[U", [TKEY_F10] = "\x1B[V",
702 [TKEY_F11] = "\x1B[W", [TKEY_F12] = "\x1B[X",
705 static const char * const special_strings_ckeys[] = {
706 [TKEY_UP] = "\x1BOA", [TKEY_DOWN] = "\x1BOB",
707 [TKEY_LEFT] = "\x1BOD", [TKEY_RIGHT] = "\x1BOC",
709 [TKEY_HOME] = "\x1BOH", [TKEY_END] = "\x1BOF",
712 static const char * const special_strings_normal[] = {
713 [TKEY_UP] = "\x1B[A", [TKEY_DOWN] = "\x1B[B",
714 [TKEY_LEFT] = "\x1B[D", [TKEY_RIGHT] = "\x1B[C",
716 [TKEY_HOME] = "\x1B[H", [TKEY_END] = "\x1B[F",
717 [TKEY_INSERT] = "\x1B[2~", [TKEY_DELETE] = "\x1B[3~",
718 [TKEY_PAGE_UP] = "\x1B[5~", [TKEY_PAGE_DOWN] = "\x1B[6~",
720 [TKEY_F1] = "\x1BOP", [TKEY_F2] = "\x1BOQ",
721 [TKEY_F3] = "\x1BOR", [TKEY_F4] = "\x1BOS",
722 [TKEY_F5] = "\x1B[15~", [TKEY_F6] = "\x1B[17~",
723 [TKEY_F7] = "\x1B[18~", [TKEY_F8] = "\x1B[19~",
724 [TKEY_F9] = "\x1B[20~", [TKEY_F10] = "\x1B[21~",
725 [TKEY_F11] = "\x1B[23~", [TKEY_F12] = "\x1B[24~",
729 teken_get_sequence(const teken_t *t, unsigned int k)
733 if ((t->t_stateflags & (TS_CONS25 | TS_CONS25KEYS)) ==
734 (TS_CONS25 | TS_CONS25KEYS))
735 return (NULL); /* Don't override good kbd(4) strings. */
736 if (t->t_stateflags & TS_CONS25 &&
737 k < sizeof special_strings_cons25 / sizeof(char *))
738 return (special_strings_cons25[k]);
740 /* Cursor keys mode. */
741 if (t->t_stateflags & TS_CURSORKEYS &&
742 k < sizeof special_strings_ckeys / sizeof(char *))
743 return (special_strings_ckeys[k]);
745 /* Default xterm sequences. */
746 if (k < sizeof special_strings_normal / sizeof(char *))
747 return (special_strings_normal[k]);
752 #include "teken_state.h"