GCOV - Varnish Cache


/*-
 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
 *
 * Copyright (c) 2008-2009 Ed Schouten <ed@FreeBSD.org>
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 * $FreeBSD: head/sys/teken/teken.c 333683 2018-05-16 18:12:49Z cem $
 */

#include "config.h"

#include <sys/types.h>
#include <limits.h>
#include <stdint.h>
#include <stdio.h>
#include <string.h>
#define teken_assert(x)         assert(x)

#include "vdef.h"
#include "vas.h"

/* debug messages */
#define teken_printf(...)

/* Private flags for t_stateflags. */
#define TS_FIRSTDIGIT   0x0001  /* First numeric digit in escape sequence. */
#define TS_INSERT       0x0002  /* Insert mode. */
#define TS_AUTOWRAP     0x0004  /* Autowrap. */
#define TS_ORIGIN       0x0008  /* Origin mode. */
#define TS_WRAPPED      0x0010  /* Next character should be printed on col 0. */
#define TS_8BIT         0x0020  /* UTF-8 disabled. */
#define TS_CONS25       0x0040  /* cons25 emulation. */
#define TS_INSTRING     0x0080  /* Inside string. */
#define TS_CURSORKEYS   0x0100  /* Cursor keys mode. */

/* Character that blanks a cell. */
#define BLANK   ' '

#include "teken.h"
#include "teken_wcwidth.h"
#include "teken_scs.h"

static teken_state_t    teken_state_init;

/*
 * Wrappers for hooks.
 */

static inline void
teken_funcs_bell(const teken_t *t)
{

        if (t->t_funcs->tf_bell != NULL)
                t->t_funcs->tf_bell(t->t_softc);
}

static inline void
teken_funcs_cursor(const teken_t *t)
{

        teken_assert(t->t_cursor.tp_row < t->t_winsize.tp_row);
        teken_assert(t->t_cursor.tp_col < t->t_winsize.tp_col);

        teken_assert(t->t_funcs->tf_cursor != NULL);
        t->t_funcs->tf_cursor(t->t_softc, &t->t_cursor);
}

static inline void
teken_funcs_putchar(const teken_t *t, const teken_pos_t *p, teken_char_t c,
    const teken_attr_t *a)
{

        teken_assert(p->tp_row < t->t_winsize.tp_row);
        teken_assert(p->tp_col < t->t_winsize.tp_col);

        teken_assert(t->t_funcs->tf_putchar != NULL);
        t->t_funcs->tf_putchar(t->t_softc, p, c, a);
}

static inline void
teken_funcs_fill(const teken_t *t, const teken_rect_t *r,
    const teken_char_t c, const teken_attr_t *a)
{

        teken_assert(r->tr_end.tp_row > r->tr_begin.tp_row);
        teken_assert(r->tr_end.tp_row <= t->t_winsize.tp_row);
        teken_assert(r->tr_end.tp_col > r->tr_begin.tp_col);
        teken_assert(r->tr_end.tp_col <= t->t_winsize.tp_col);

        teken_assert(t->t_funcs->tf_fill != NULL);
        t->t_funcs->tf_fill(t->t_softc, r, c, a);
}

static inline void
teken_funcs_copy(const teken_t *t, const teken_rect_t *r, const teken_pos_t *p)
{

        teken_assert(r->tr_end.tp_row > r->tr_begin.tp_row);
        teken_assert(r->tr_end.tp_row <= t->t_winsize.tp_row);
        teken_assert(r->tr_end.tp_col > r->tr_begin.tp_col);
        teken_assert(r->tr_end.tp_col <= t->t_winsize.tp_col);
        teken_assert(p->tp_row + (r->tr_end.tp_row - r->tr_begin.tp_row) <= t->t_winsize.tp_row);
        teken_assert(p->tp_col + (r->tr_end.tp_col - r->tr_begin.tp_col) <= t->t_winsize.tp_col);

        teken_assert(t->t_funcs->tf_copy != NULL);
        t->t_funcs->tf_copy(t->t_softc, r, p);
}

static inline void
teken_funcs_pre_input(const teken_t *t)
{

        if (t->t_funcs->tf_pre_input != NULL)
                t->t_funcs->tf_pre_input(t->t_softc);
}

static inline void
teken_funcs_post_input(const teken_t *t)
{

        if (t->t_funcs->tf_post_input != NULL)
                t->t_funcs->tf_post_input(t->t_softc);
}

static inline void
teken_funcs_param(const teken_t *t, int cmd, unsigned int value)
{

        teken_assert(t->t_funcs->tf_param != NULL);
        t->t_funcs->tf_param(t->t_softc, cmd, value);
}

static inline void
teken_funcs_respond(const teken_t *t, const void *buf, size_t len)
{

        teken_assert(t->t_funcs->tf_respond != NULL);
        t->t_funcs->tf_respond(t->t_softc, buf, len);
}

#include "teken_subr.h"
#include "teken_subr_compat.h"

/*
 * Programming interface.
 */

void
teken_init(teken_t *t, const teken_funcs_t *tf, void *softc)
{
        teken_pos_t tp = { .tp_row = 24, .tp_col = 80 };

        t->t_funcs = tf;
        t->t_softc = softc;

        t->t_nextstate = teken_state_init;
        t->t_stateflags = 0;
        t->t_utf8_left = 0;

        t->t_defattr.ta_format = 0;
        t->t_defattr.ta_fgcolor = TC_WHITE;
        t->t_defattr.ta_bgcolor = TC_BLACK;
        teken_subr_do_reset(t);

        teken_set_winsize(t, &tp);
}

static void
teken_input_char(teken_t *t, teken_char_t c)
{

        /*
         * There is no support for DCS and OSC.  Just discard strings
         * until we receive characters that may indicate string
         * termination.
         */
        if (t->t_stateflags & TS_INSTRING) {
                switch (c) {
                case '\x1B':
                        t->t_stateflags &= ~TS_INSTRING;
                        break;
                case '\a':
                        t->t_stateflags &= ~TS_INSTRING;
                        return;
                default:
                        return;
                }
        }

        switch (c) {
        case '\0':
                break;
        case '\a':
                teken_subr_bell(t);
                break;
        case '\b':
                teken_subr_backspace(t);
                break;
        case '\n':
        case '\x0B':
                teken_subr_newline(t);
                break;
        case '\x0C':
                teken_subr_newpage(t);
                break;
        case '\x0E':
                if (t->t_stateflags & TS_CONS25)
                        t->t_nextstate(t, c);
                else
                        t->t_curscs = 1;
                break;
        case '\x0F':
                if (t->t_stateflags & TS_CONS25)
                        t->t_nextstate(t, c);
                else
                        t->t_curscs = 0;
                break;
        case '\r':
                teken_subr_carriage_return(t);
                break;
        case '\t':
                teken_subr_horizontal_tab(t);
                break;
        default:
                t->t_nextstate(t, c);
                break;
        }

        /* Post-processing assertions. */
        teken_assert(t->t_cursor.tp_row >= t->t_originreg.ts_begin);
        teken_assert(t->t_cursor.tp_row < t->t_originreg.ts_end);
        teken_assert(t->t_cursor.tp_row < t->t_winsize.tp_row);
        teken_assert(t->t_cursor.tp_col < t->t_winsize.tp_col);
        teken_assert(t->t_saved_cursor.tp_row < t->t_winsize.tp_row);
        teken_assert(t->t_saved_cursor.tp_col < t->t_winsize.tp_col);
        teken_assert(t->t_scrollreg.ts_end <= t->t_winsize.tp_row);
        teken_assert(t->t_scrollreg.ts_begin < t->t_scrollreg.ts_end);
        /* Origin region has to be window size or the same as scrollreg. */
        teken_assert((t->t_originreg.ts_begin == t->t_scrollreg.ts_begin &&
            t->t_originreg.ts_end == t->t_scrollreg.ts_end) ||
            (t->t_originreg.ts_begin == 0 &&
            t->t_originreg.ts_end == t->t_winsize.tp_row));
}

static void
teken_input_byte(teken_t *t, unsigned char c)
{

        /*
         * UTF-8 handling.
         */
        if ((c & 0x80) == 0x00 || t->t_stateflags & TS_8BIT) {
                /* One-byte sequence. */
                t->t_utf8_left = 0;
                teken_input_char(t, c);
        } else if ((c & 0xe0) == 0xc0) {
                /* Two-byte sequence. */
                t->t_utf8_left = 1;
                t->t_utf8_partial = c & 0x1f;
        } else if ((c & 0xf0) == 0xe0) {
                /* Three-byte sequence. */
                t->t_utf8_left = 2;
                t->t_utf8_partial = c & 0x0f;
        } else if ((c & 0xf8) == 0xf0) {
                /* Four-byte sequence. */
                t->t_utf8_left = 3;
                t->t_utf8_partial = c & 0x07;
        } else if ((c & 0xc0) == 0x80) {
                if (t->t_utf8_left == 0)
                        return;
                t->t_utf8_left--;
                t->t_utf8_partial = (t->t_utf8_partial << 6) | (c & 0x3f);
                if (t->t_utf8_left == 0) {
                        teken_printf("Got UTF-8 char %x\n", t->t_utf8_partial);
                        teken_input_char(t, t->t_utf8_partial);
                }
        }
}

void
teken_input(teken_t *t, const void *buf, size_t len)
{
        const char *c = buf;

        teken_funcs_pre_input(t);
        while (len-- > 0)
                teken_input_byte(t, *c++);
        teken_funcs_post_input(t);
}

const teken_pos_t *
teken_get_cursor(const teken_t *t)
{

        return (&t->t_cursor);
}

void
teken_set_cursor(teken_t *t, const teken_pos_t *p)
{

        /* XXX: bounds checking with originreg! */
        teken_assert(p->tp_row < t->t_winsize.tp_row);
        teken_assert(p->tp_col < t->t_winsize.tp_col);

        t->t_cursor = *p;
}

const teken_attr_t *
teken_get_curattr(const teken_t *t)
{

        return (&t->t_curattr);
}

void
teken_set_curattr(teken_t *t, const teken_attr_t *a)
{

        t->t_curattr = *a;
}

const teken_attr_t *
teken_get_defattr(const teken_t *t)
{

        return (&t->t_defattr);
}

void
teken_set_defattr(teken_t *t, const teken_attr_t *a)
{

        t->t_curattr = t->t_saved_curattr = t->t_defattr = *a;
}

const teken_pos_t *
teken_get_winsize(const teken_t *t)
{

        return (&t->t_winsize);
}

static void
teken_trim_cursor_pos(teken_t *t, const teken_pos_t *new)
{
        const teken_pos_t *cur;

        cur = &t->t_winsize;

        if (cur->tp_row < new->tp_row || cur->tp_col < new->tp_col)
                return;
        if (t->t_cursor.tp_row >= new->tp_row)
                t->t_cursor.tp_row = new->tp_row - 1;
        if (t->t_cursor.tp_col >= new->tp_col)
                t->t_cursor.tp_col = new->tp_col - 1;
}

void
teken_set_winsize(teken_t *t, const teken_pos_t *p)
{

        teken_trim_cursor_pos(t, p);
        t->t_winsize = *p;
        teken_subr_do_reset(t);
}

void
teken_set_winsize_noreset(teken_t *t, const teken_pos_t *p)
{

        teken_trim_cursor_pos(t, p);
        t->t_winsize = *p;
        teken_subr_do_resize(t);
}

void
teken_set_8bit(teken_t *t)
{

        t->t_stateflags |= TS_8BIT;
}

void
teken_set_cons25(teken_t *t)
{

        t->t_stateflags |= TS_CONS25;
}

/*
 * State machine.
 */

static void
teken_state_switch(teken_t *t, teken_state_t *s)
{

        t->t_nextstate = s;
        t->t_curnum = 0;
        t->t_stateflags |= TS_FIRSTDIGIT;
}

static int
teken_state_numbers(teken_t *t, teken_char_t c)
{

        teken_assert(t->t_curnum < T_NUMSIZE);

        if (c >= '0' && c <= '9') {
                if (t->t_stateflags & TS_FIRSTDIGIT) {
                        /* First digit. */
                        t->t_stateflags &= ~TS_FIRSTDIGIT;
                        t->t_nums[t->t_curnum] = c - '0';
                } else if (t->t_nums[t->t_curnum] < UINT_MAX / 100) {
                        /*
                         * There is no need to continue parsing input
                         * once the value exceeds the size of the
                         * terminal. It would only allow for integer
                         * overflows when performing arithmetic on the
                         * cursor position.
                         *
                         * Ignore any further digits if the value is
                         * already UINT_MAX / 100.
                         */
                        t->t_nums[t->t_curnum] =
                            t->t_nums[t->t_curnum] * 10 + c - '0';
                }
                return (1);
        } else if (c == ';') {
                if (t->t_stateflags & TS_FIRSTDIGIT)
                        t->t_nums[t->t_curnum] = 0;

                /* Only allow a limited set of arguments. */
                if (++t->t_curnum == T_NUMSIZE) {
                        teken_state_switch(t, teken_state_init);
                        return (1);
                }

                t->t_stateflags |= TS_FIRSTDIGIT;
                return (1);
        } else {
                if (t->t_stateflags & TS_FIRSTDIGIT && t->t_curnum > 0) {
                        /* Finish off the last empty argument. */
                        t->t_nums[t->t_curnum] = 0;
                        t->t_curnum++;
                } else if ((t->t_stateflags & TS_FIRSTDIGIT) == 0) {
                        /* Also count the last argument. */
                        t->t_curnum++;
                }
        }

        return (0);
}

#define k       TC_BLACK
#define b       TC_BLUE
#define y       TC_BROWN
#define c       TC_CYAN
#define g       TC_GREEN
#define m       TC_MAGENTA
#define r       TC_RED
#define w       TC_WHITE
#define K       (TC_BLACK | TC_LIGHT)
#define B       (TC_BLUE | TC_LIGHT)
#define Y       (TC_BROWN | TC_LIGHT)
#define C       (TC_CYAN | TC_LIGHT)
#define G       (TC_GREEN | TC_LIGHT)
#define M       (TC_MAGENTA | TC_LIGHT)
#define R       (TC_RED | TC_LIGHT)
#define W       (TC_WHITE | TC_LIGHT)

/**
 * The xterm-256 color map has steps of 0x28 (in the range 0-0xff), except
 * for the first step which is 0x5f.  Scale to the range 0-6 by dividing
 * by 0x28 and rounding down.  The range of 0-5 cannot represent the
 * larger first step.
 *
 * This table is generated by the follow rules:
 * - if all components are equal, the result is black for (0, 0, 0) and
 *   (2, 2, 2), else white; otherwise:
 * - subtract the smallest component from all components
 * - if this gives only one nonzero component, then that is the color
 * - else if one component is 2 or more larger than the other nonzero one,
 *   then that component gives the color
 * - else there are 2 nonzero components.  The color is that of a small
 *   equal mixture of these components (cyan, yellow or magenta).  E.g.,
 *   (0, 5, 6) (Turquoise2) is a much purer cyan than (0, 2, 3)
 *   (DeepSkyBlue4), but we map both to cyan since we can't represent
 *   delicate shades of either blue or cyan and blue would be worse.
 *   Here it is important that components of 1 never occur.  Blue would
 *   be twice as large as green in (0, 1, 2).
 */
static const teken_color_t teken_256to8tab[] = {
        /* xterm normal colors: */
        k, r, g, y, b, m, c, w,

        /* xterm bright colors: */
        k, r, g, y, b, m, c, w,

        /* Red0 submap. */
        k, b, b, b, b, b,
        g, c, c, b, b, b,
        g, c, c, c, b, b,
        g, g, c, c, c, b,
        g, g, g, c, c, c,
        g, g, g, g, c, c,

        /* Red2 submap. */
        r, m, m, b, b, b,
        y, k, b, b, b, b,
        y, g, c, c, b, b,
        g, g, c, c, c, b,
        g, g, g, c, c, c,
        g, g, g, g, c, c,

        /* Red3 submap. */
        r, m, m, m, b, b,
        y, r, m, m, b, b,
        y, y, w, b, b, b,
        y, y, g, c, c, b,
        g, g, g, c, c, c,
        g, g, g, g, c, c,

        /* Red4 submap. */
        r, r, m, m, m, b,
        r, r, m, m, m, b,
        y, y, r, m, m, b,
        y, y, y, w, b, b,
        y, y, y, g, c, c,
        g, g, g, g, c, c,

        /* Red5 submap. */
        r, r, r, m, m, m,
        r, r, r, m, m, m,
        r, r, r, m, m, m,
        y, y, y, r, m, m,
        y, y, y, y, w, b,
        y, y, y, y, g, c,

        /* Red6 submap. */
        r, r, r, r, m, m,
        r, r, r, r, m, m,
        r, r, r, r, m, m,
        r, r, r, r, m, m,
        y, y, y, y, r, m,
        y, y, y, y, y, w,

        /* Grey submap. */
        k, k, k, k, k, k,
        k, k, k, k, k, k,
        w, w, w, w, w, w,
        w, w, w, w, w, w,
};

/*
 * This table is generated from the previous one by setting TC_LIGHT for
 * entries whose luminosity in the xterm256 color map is 60% or larger.
 * Thus the previous table is currently not really needed.  It will be
 * used for different fine tuning of the tables.
 */
static const teken_color_t teken_256to16tab[] = {
        /* xterm normal colors: */
        k, r, g, y, b, m, c, w,

        /* xterm bright colors: */
        K, R, G, Y, B, M, C, W,

        /* Red0 submap. */
        k, b, b, b, b, b,
        g, c, c, b, b, b,
        g, c, c, c, b, b,
        g, g, c, c, c, b,
        g, g, g, c, c, c,
        g, g, g, g, c, c,

        /* Red2 submap. */
        r, m, m, b, b, b,
        y, K, b, b, B, B,
        y, g, c, c, B, B,
        g, g, c, c, C, B,
        g, G, G, C, C, C,
        g, G, G, G, C, C,

        /* Red3 submap. */
        r, m, m, m, b, b,
        y, r, m, m, B, B,
        y, y, w, B, B, B,
        y, y, G, C, C, B,
        g, G, G, C, C, C,
        g, G, G, G, C, C,

        /* Red4 submap. */
        r, r, m, m, m, b,
        r, r, m, m, M, B,
        y, y, R, M, M, B,
        y, y, Y, W, B, B,
        y, Y, Y, G, C, C,
        g, G, G, G, C, C,

        /* Red5 submap. */
        r, r, r, m, m, m,
        r, R, R, M, M, M,
        r, R, R, M, M, M,
        y, Y, Y, R, M, M,
        y, Y, Y, Y, W, B,
        y, Y, Y, Y, G, C,

        /* Red6 submap. */
        r, r, r, r, m, m,
        r, R, R, R, M, M,
        r, R, R, R, M, M,
        r, R, R, R, M, M,
        y, Y, Y, Y, R, M,
        y, Y, Y, Y, Y, W,

        /* Grey submap. */
        k, k, k, k, k, k,
        K, K, K, K, K, K,
        w, w, w, w, w, w,
        W, W, W, W, W, W,
};

#undef  k
#undef  b
#undef  y
#undef  c
#undef  g
#undef  m
#undef  r
#undef  w
#undef  K
#undef  B
#undef  Y
#undef  C
#undef  G
#undef  M
#undef  R
#undef  W

teken_color_t
teken_256to8(teken_color_t c)
{

        return (teken_256to8tab[c % 256]);
}

teken_color_t
teken_256to16(teken_color_t c)
{

        return (teken_256to16tab[c % 256]);
}

static const char * const special_strings_cons25[] = {
        [TKEY_UP] = "\x1B[A",           [TKEY_DOWN] = "\x1B[B",
        [TKEY_LEFT] = "\x1B[D",         [TKEY_RIGHT] = "\x1B[C",

        [TKEY_HOME] = "\x1B[H",         [TKEY_END] = "\x1B[F",
        [TKEY_INSERT] = "\x1B[L",       [TKEY_DELETE] = "\x7F",
        [TKEY_PAGE_UP] = "\x1B[I",      [TKEY_PAGE_DOWN] = "\x1B[G",

        [TKEY_F1] = "\x1B[M",           [TKEY_F2] = "\x1B[N",
        [TKEY_F3] = "\x1B[O",           [TKEY_F4] = "\x1B[P",
        [TKEY_F5] = "\x1B[Q",           [TKEY_F6] = "\x1B[R",
        [TKEY_F7] = "\x1B[S",           [TKEY_F8] = "\x1B[T",
        [TKEY_F9] = "\x1B[U",           [TKEY_F10] = "\x1B[V",
        [TKEY_F11] = "\x1B[W",          [TKEY_F12] = "\x1B[X",
};

static const char * const special_strings_ckeys[] = {
        [TKEY_UP] = "\x1BOA",           [TKEY_DOWN] = "\x1BOB",
        [TKEY_LEFT] = "\x1BOD",         [TKEY_RIGHT] = "\x1BOC",

        [TKEY_HOME] = "\x1BOH",         [TKEY_END] = "\x1BOF",
};

static const char * const special_strings_normal[] = {
        [TKEY_UP] = "\x1B[A",           [TKEY_DOWN] = "\x1B[B",
        [TKEY_LEFT] = "\x1B[D",         [TKEY_RIGHT] = "\x1B[C",

        [TKEY_HOME] = "\x1B[H",         [TKEY_END] = "\x1B[F",
        [TKEY_INSERT] = "\x1B[2~",      [TKEY_DELETE] = "\x1B[3~",
        [TKEY_PAGE_UP] = "\x1B[5~",     [TKEY_PAGE_DOWN] = "\x1B[6~",

        [TKEY_F1] = "\x1BOP",           [TKEY_F2] = "\x1BOQ",
        [TKEY_F3] = "\x1BOR",           [TKEY_F4] = "\x1BOS",
        [TKEY_F5] = "\x1B[15~",         [TKEY_F6] = "\x1B[17~",
        [TKEY_F7] = "\x1B[18~",         [TKEY_F8] = "\x1B[19~",
        [TKEY_F9] = "\x1B[20~",         [TKEY_F10] = "\x1B[21~",
        [TKEY_F11] = "\x1B[23~",        [TKEY_F12] = "\x1B[24~",
};

const char *
teken_get_sequence(const teken_t *t, unsigned int k)
{

        /* Cons25 mode. */
        if (t->t_stateflags & TS_CONS25 &&
            k < sizeof special_strings_cons25 / sizeof(char *))
                return (special_strings_cons25[k]);

        /* Cursor keys mode. */
        if (t->t_stateflags & TS_CURSORKEYS &&
            k < sizeof special_strings_ckeys / sizeof(char *))
                return (special_strings_ckeys[k]);

        /* Default xterm sequences. */
        if (k < sizeof special_strings_normal / sizeof(char *))
                return (special_strings_normal[k]);

        return (NULL);
}

#include "teken_state.h"

		varnish-cache/bin/varnishtest/teken.c
0		/*-
1		* SPDX-License-Identifier: BSD-2-Clause-FreeBSD
2		*
3		* Copyright (c) 2008-2009 Ed Schouten <ed@FreeBSD.org>
4		* All rights reserved.
5		*
6		* Redistribution and use in source and binary forms, with or without
7		* modification, are permitted provided that the following conditions
8		* are met:
9		* 1. Redistributions of source code must retain the above copyright
10		* notice, this list of conditions and the following disclaimer.
11		* 2. Redistributions in binary form must reproduce the above copyright
12		* notice, this list of conditions and the following disclaimer in the
13		* documentation and/or other materials provided with the distribution.
14		*
15		* THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16		* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17		* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18		* ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19		* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20		* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21		* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22		* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23		* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24		* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25		* SUCH DAMAGE.
26		*
27		* $FreeBSD: head/sys/teken/teken.c 333683 2018-05-16 18:12:49Z cem $
28		*/
29
30		#include "config.h"
31
32		#include <sys/types.h>
33		#include <limits.h>
34		#include <stdint.h>
35		#include <stdio.h>
36		#include <string.h>
37		#define teken_assert(x) assert(x)
38
39		#include "vdef.h"
40		#include "vas.h"
41
42		/* debug messages */
43		#define teken_printf(...)
44
45		/* Private flags for t_stateflags. */
46		#define TS_FIRSTDIGIT 0x0001 /* First numeric digit in escape sequence. */
47		#define TS_INSERT 0x0002 /* Insert mode. */
48		#define TS_AUTOWRAP 0x0004 /* Autowrap. */
49		#define TS_ORIGIN 0x0008 /* Origin mode. */
50		#define TS_WRAPPED 0x0010 /* Next character should be printed on col 0. */
51		#define TS_8BIT 0x0020 /* UTF-8 disabled. */
52		#define TS_CONS25 0x0040 /* cons25 emulation. */
53		#define TS_INSTRING 0x0080 /* Inside string. */
54		#define TS_CURSORKEYS 0x0100 /* Cursor keys mode. */
55
56		/* Character that blanks a cell. */
57		#define BLANK ' '
58
59		#include "teken.h"
60		#include "teken_wcwidth.h"
61		#include "teken_scs.h"
62
63		static teken_state_t teken_state_init;
64
65		/*
66		* Wrappers for hooks.
67		*/
68
69		static inline void
70	18	teken_funcs_bell(const teken_t *t)
71		{
72
73	18	if (t->t_funcs->tf_bell != NULL)
74	0	t->t_funcs->tf_bell(t->t_softc);
75	18	}
76
77		static inline void
78	412824	teken_funcs_cursor(const teken_t *t)
79		{
80
81	412824	teken_assert(t->t_cursor.tp_row < t->t_winsize.tp_row);
82	412824	teken_assert(t->t_cursor.tp_col < t->t_winsize.tp_col);
83
84	412824	teken_assert(t->t_funcs->tf_cursor != NULL);
85	412824	t->t_funcs->tf_cursor(t->t_softc, &t->t_cursor);
86	412824	}
87
88		static inline void
89	373571	teken_funcs_putchar(const teken_t t, const teken_pos_t p, teken_char_t c,
90		const teken_attr_t *a)
91		{
92
93	373571	teken_assert(p->tp_row < t->t_winsize.tp_row);
94	373571	teken_assert(p->tp_col < t->t_winsize.tp_col);
95
96	373571	teken_assert(t->t_funcs->tf_putchar != NULL);
97	373571	t->t_funcs->tf_putchar(t->t_softc, p, c, a);
98	373571	}
99
100		static inline void
101	5335	teken_funcs_fill(const teken_t t, const teken_rect_t r,
102		const teken_char_t c, const teken_attr_t *a)
103		{
104
105	5335	teken_assert(r->tr_end.tp_row > r->tr_begin.tp_row);
106	5335	teken_assert(r->tr_end.tp_row <= t->t_winsize.tp_row);
107	5335	teken_assert(r->tr_end.tp_col > r->tr_begin.tp_col);
108	5335	teken_assert(r->tr_end.tp_col <= t->t_winsize.tp_col);
109
110	5335	teken_assert(t->t_funcs->tf_fill != NULL);
111	5335	t->t_funcs->tf_fill(t->t_softc, r, c, a);
112	5335	}
113
114		static inline void
115	5182	teken_funcs_copy(const teken_t t, const teken_rect_t r, const teken_pos_t *p)
116		{
117
118	5182	teken_assert(r->tr_end.tp_row > r->tr_begin.tp_row);
119	5182	teken_assert(r->tr_end.tp_row <= t->t_winsize.tp_row);
120	5182	teken_assert(r->tr_end.tp_col > r->tr_begin.tp_col);
121	5182	teken_assert(r->tr_end.tp_col <= t->t_winsize.tp_col);
122	5182	teken_assert(p->tp_row + (r->tr_end.tp_row - r->tr_begin.tp_row) <= t->t_winsize.tp_row);
123	5182	teken_assert(p->tp_col + (r->tr_end.tp_col - r->tr_begin.tp_col) <= t->t_winsize.tp_col);
124
125	5182	teken_assert(t->t_funcs->tf_copy != NULL);
126	5182	t->t_funcs->tf_copy(t->t_softc, r, p);
127	5182	}
128
129		static inline void
130	12790	teken_funcs_pre_input(const teken_t *t)
131		{
132
133	12790	if (t->t_funcs->tf_pre_input != NULL)
134	0	t->t_funcs->tf_pre_input(t->t_softc);
135	12790	}
136
137		static inline void
138	12790	teken_funcs_post_input(const teken_t *t)
139		{
140
141	12790	if (t->t_funcs->tf_post_input != NULL)
142	0	t->t_funcs->tf_post_input(t->t_softc);
143	12790	}
144
145		static inline void
146	405	teken_funcs_param(const teken_t *t, int cmd, unsigned int value)
147		{
148
149	405	teken_assert(t->t_funcs->tf_param != NULL);
150	405	t->t_funcs->tf_param(t->t_softc, cmd, value);
151	405	}
152
153		static inline void
154	48	teken_funcs_respond(const teken_t t, const void buf, size_t len)
155		{
156
157	48	teken_assert(t->t_funcs->tf_respond != NULL);
158	48	t->t_funcs->tf_respond(t->t_softc, buf, len);
159	48	}
160
161		#include "teken_subr.h"
162		#include "teken_subr_compat.h"
163
164		/*
165		* Programming interface.
166		*/
167
168		void
169	168	teken_init(teken_t t, const teken_funcs_t tf, void *softc)
170		{
171	168	teken_pos_t tp = { .tp_row = 24, .tp_col = 80 };
172
173	168	t->t_funcs = tf;
174	168	t->t_softc = softc;
175
176	168	t->t_nextstate = teken_state_init;
177	168	t->t_stateflags = 0;
178	168	t->t_utf8_left = 0;
179
180	168	t->t_defattr.ta_format = 0;
181	168	t->t_defattr.ta_fgcolor = TC_WHITE;
182	168	t->t_defattr.ta_bgcolor = TC_BLACK;
183	168	teken_subr_do_reset(t);
184
185	168	teken_set_winsize(t, &tp);
186	168	}
187
188		static void
189	549049	teken_input_char(teken_t *t, teken_char_t c)
190		{
191
192		/*
193		* There is no support for DCS and OSC. Just discard strings
194		* until we receive characters that may indicate string
195		* termination.
196		*/
197	549049	if (t->t_stateflags & TS_INSTRING) {
198	132	switch (c) {
199		case '\x1B':
200	12	t->t_stateflags &= ~TS_INSTRING;
201	12	break;
202		case '\a':
203	0	t->t_stateflags &= ~TS_INSTRING;
204	0	return;
205		default:
206	120	return;
207		}
208	12	}
209
210	548929	switch (c) {
211		case '\0':
212	0	break;
213		case '\a':
214	18	teken_subr_bell(t);
215	18	break;
216		case '\b':
217	2717	teken_subr_backspace(t);
218	2717	break;
219		case '\n':
220		case '\x0B':
221	5363	teken_subr_newline(t);
222	5363	break;
223		case '\x0C':
224	24	teken_subr_newpage(t);
225	24	break;
226		case '\x0E':
227	18	if (t->t_stateflags & TS_CONS25)
228	6	t->t_nextstate(t, c);
229		else
230	12	t->t_curscs = 1;
231	18	break;
232		case '\x0F':
233	270	if (t->t_stateflags & TS_CONS25)
234	6	t->t_nextstate(t, c);
235		else
236	264	t->t_curscs = 0;
237	270	break;
238		case '\r':
239	6646	teken_subr_carriage_return(t);
240	6646	break;
241		case '\t':
242	456	teken_subr_horizontal_tab(t);
243	456	break;
244		default:
245	533417	t->t_nextstate(t, c);
246	533417	break;
247		}
248
249		/* Post-processing assertions. */
250	548929	teken_assert(t->t_cursor.tp_row >= t->t_originreg.ts_begin);
251	548929	teken_assert(t->t_cursor.tp_row < t->t_originreg.ts_end);
252	548929	teken_assert(t->t_cursor.tp_row < t->t_winsize.tp_row);
253	548929	teken_assert(t->t_cursor.tp_col < t->t_winsize.tp_col);
254	548929	teken_assert(t->t_saved_cursor.tp_row < t->t_winsize.tp_row);
255	548929	teken_assert(t->t_saved_cursor.tp_col < t->t_winsize.tp_col);
256	548929	teken_assert(t->t_scrollreg.ts_end <= t->t_winsize.tp_row);
257	548929	teken_assert(t->t_scrollreg.ts_begin < t->t_scrollreg.ts_end);
258		/* Origin region has to be window size or the same as scrollreg. */
259	548929	teken_assert((t->t_originreg.ts_begin == t->t_scrollreg.ts_begin &&
260		t->t_originreg.ts_end == t->t_scrollreg.ts_end) \|\|
261		(t->t_originreg.ts_begin == 0 &&
262		t->t_originreg.ts_end == t->t_winsize.tp_row));
263	549047	}
264
265		static void
266	549136	teken_input_byte(teken_t *t, unsigned char c)
267		{
268
269		/*
270		* UTF-8 handling.
271		*/
272	549136	if ((c & 0x80) == 0x00 \|\| t->t_stateflags & TS_8BIT) {
273		/* One-byte sequence. */
274	549010	t->t_utf8_left = 0;
275	549010	teken_input_char(t, c);
276	549136	} else if ((c & 0xe0) == 0xc0) {
277		/* Two-byte sequence. */
278	6	t->t_utf8_left = 1;
279	6	t->t_utf8_partial = c & 0x1f;
280	126	} else if ((c & 0xf0) == 0xe0) {
281		/* Three-byte sequence. */
282	6	t->t_utf8_left = 2;
283	6	t->t_utf8_partial = c & 0x0f;
284	120	} else if ((c & 0xf8) == 0xf0) {
285		/* Four-byte sequence. */
286	24	t->t_utf8_left = 3;
287	24	t->t_utf8_partial = c & 0x07;
288	114	} else if ((c & 0xc0) == 0x80) {
289	90	if (t->t_utf8_left == 0)
290	0	return;
291	90	t->t_utf8_left--;
292	90	t->t_utf8_partial = (t->t_utf8_partial << 6) \| (c & 0x3f);
293	90	if (t->t_utf8_left == 0) {
294		teken_printf("Got UTF-8 char %x\n", t->t_utf8_partial);
295	36	teken_input_char(t, t->t_utf8_partial);
296	36	}
297	90	}
298	549136	}
299
300		void
301	12790	teken_input(teken_t t, const void buf, size_t len)
302		{
303	12790	const char *c = buf;
304
305	12790	teken_funcs_pre_input(t);
306	561930	while (len-- > 0)
307	549140	teken_input_byte(t, *c++);
308	12790	teken_funcs_post_input(t);
309	12790	}
310
311		const teken_pos_t *
312	492	teken_get_cursor(const teken_t *t)
313		{
314
315	492	return (&t->t_cursor);
316		}
317
318		void
319	168	teken_set_cursor(teken_t t, const teken_pos_t p)
320		{
321
322		/* XXX: bounds checking with originreg! */
323	168	teken_assert(p->tp_row < t->t_winsize.tp_row);
324	168	teken_assert(p->tp_col < t->t_winsize.tp_col);
325
326	168	t->t_cursor = *p;
327	168	}
328
329		const teken_attr_t *
330	168	teken_get_curattr(const teken_t *t)
331		{
332
333	168	return (&t->t_curattr);
334		}
335
336		void
337	168	teken_set_curattr(teken_t t, const teken_attr_t a)
338		{
339
340	168	t->t_curattr = *a;
341	168	}
342
343		const teken_attr_t *
344	168	teken_get_defattr(const teken_t *t)
345		{
346
347	168	return (&t->t_defattr);
348		}
349
350		void
351	168	teken_set_defattr(teken_t t, const teken_attr_t a)
352		{
353
354	168	t->t_curattr = t->t_saved_curattr = t->t_defattr = *a;
355	168	}
356
357		const teken_pos_t *
358	168	teken_get_winsize(const teken_t *t)
359		{
360
361	168	return (&t->t_winsize);
362		}
363
364		static void
365	468	teken_trim_cursor_pos(teken_t t, const teken_pos_t new)
366		{
367		const teken_pos_t *cur;
368
369	468	cur = &t->t_winsize;
370
371	468	if (cur->tp_row < new->tp_row \|\| cur->tp_col < new->tp_col)
372	225	return;
373	243	if (t->t_cursor.tp_row >= new->tp_row)
374	0	t->t_cursor.tp_row = new->tp_row - 1;
375	243	if (t->t_cursor.tp_col >= new->tp_col)
376	12	t->t_cursor.tp_col = new->tp_col - 1;
377	468	}
378
379		void
380	468	teken_set_winsize(teken_t t, const teken_pos_t p)
381		{
382
383	468	teken_trim_cursor_pos(t, p);
384	468	t->t_winsize = *p;
385	468	teken_subr_do_reset(t);
386	468	}
387
388		void
389	0	teken_set_winsize_noreset(teken_t t, const teken_pos_t p)
390		{
391
392	0	teken_trim_cursor_pos(t, p);
393	0	t->t_winsize = *p;
394	0	teken_subr_do_resize(t);
395	0	}
396
397		void
398	0	teken_set_8bit(teken_t *t)
399		{
400
401	0	t->t_stateflags \|= TS_8BIT;
402	0	}
403
404		void
405	0	teken_set_cons25(teken_t *t)
406		{
407
408	0	t->t_stateflags \|= TS_CONS25;
409	0	}
410
411		/*
412		* State machine.
413		*/
414
415		static void
416	92445	teken_state_switch(teken_t t, teken_state_t s)
417		{
418
419	92445	t->t_nextstate = s;
420	92445	t->t_curnum = 0;
421	92445	t->t_stateflags \|= TS_FIRSTDIGIT;
422	92445	}
423
424		static int
425	96561	teken_state_numbers(teken_t *t, teken_char_t c)
426		{
427
428	96561	teken_assert(t->t_curnum < T_NUMSIZE);
429
430	96561	if (c >= '0' && c <= '9') {
431	57222	if (t->t_stateflags & TS_FIRSTDIGIT) {
432		/* First digit. */
433	37443	t->t_stateflags &= ~TS_FIRSTDIGIT;
434	37443	t->t_nums[t->t_curnum] = c - '0';
435	57222	} else if (t->t_nums[t->t_curnum] < UINT_MAX / 100) {
436		/*
437		* There is no need to continue parsing input
438		* once the value exceeds the size of the
439		* terminal. It would only allow for integer
440		* overflows when performing arithmetic on the
441		* cursor position.
442		*
443		* Ignore any further digits if the value is
444		* already UINT_MAX / 100.
445		*/
446	19779	t->t_nums[t->t_curnum] =
447	19779	t->t_nums[t->t_curnum] * 10 + c - '0';
448	19779	}
449	57222	return (1);
450	39339	} else if (c == ';') {
451	11287	if (t->t_stateflags & TS_FIRSTDIGIT)
452	144	t->t_nums[t->t_curnum] = 0;
453
454		/* Only allow a limited set of arguments. */
455	11287	if (++t->t_curnum == T_NUMSIZE) {
456	6	teken_state_switch(t, teken_state_init);
457	6	return (1);
458		}
459
460	11281	t->t_stateflags \|= TS_FIRSTDIGIT;
461	11281	return (1);
462		} else {
463	28052	if (t->t_stateflags & TS_FIRSTDIGIT && t->t_curnum > 0) {
464		/* Finish off the last empty argument. */
465	6	t->t_nums[t->t_curnum] = 0;
466	6	t->t_curnum++;
467	28052	} else if ((t->t_stateflags & TS_FIRSTDIGIT) == 0) {
468		/* Also count the last argument. */
469	26300	t->t_curnum++;
470	26300	}
471		}
472
473	28052	return (0);
474	96561	}
475
476		#define k TC_BLACK
477		#define b TC_BLUE
478		#define y TC_BROWN
479		#define c TC_CYAN
480		#define g TC_GREEN
481		#define m TC_MAGENTA
482		#define r TC_RED
483		#define w TC_WHITE
484		#define K (TC_BLACK \| TC_LIGHT)
485		#define B (TC_BLUE \| TC_LIGHT)
486		#define Y (TC_BROWN \| TC_LIGHT)
487		#define C (TC_CYAN \| TC_LIGHT)
488		#define G (TC_GREEN \| TC_LIGHT)
489		#define M (TC_MAGENTA \| TC_LIGHT)
490		#define R (TC_RED \| TC_LIGHT)
491		#define W (TC_WHITE \| TC_LIGHT)
492
493		/**
494		* The xterm-256 color map has steps of 0x28 (in the range 0-0xff), except
495		* for the first step which is 0x5f. Scale to the range 0-6 by dividing
496		* by 0x28 and rounding down. The range of 0-5 cannot represent the
497		* larger first step.
498		*
499		* This table is generated by the follow rules: