HelenOS sources

root/uspace/lib/vt/include/vt/vt100.h

/* [<][>][^][v][top][bottom][index][help] */

INCLUDED FROM


/*
 * Copyright (c) 2024 Jiri Svoboda
 * Copyright (c) 2011 Martin Decky
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * - Redistributions of source code must retain the above copyright
 *   notice, this list of conditions and the following disclaimer.
 * - 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.
 * - The name of the author may not be used to endorse or promote products
 *   derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``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 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.
 */

/** @addtogroup libvt
 * @{
 */

#ifndef LIBVT_VT100_H_
#define LIBVT_VT100_H_

#include <io/charfield.h>
#include <io/keycode.h>
#include <io/pos_event.h>
#include <ipc/common.h>
#include <uchar.h>

/** Buffer size when creating actual VT100 commands.
 *
 * This is absurdly large but since we accept numbers via sysarg_t,
 * we make it big enough for the largest value to be on the safe side
 * (and to silence compiler too).
 *
 * TODO: find out if VT100 has some hard limits or perhaps simply cut-out
 * values larger than 16 bits or something.
 */
#define MAX_CONTROL 64

typedef enum {
        CI_BLACK   = 0,
        CI_RED     = 1,
        CI_GREEN   = 2,
        CI_BROWN   = 3,
        CI_BLUE    = 4,
        CI_MAGENTA = 5,
        CI_CYAN    = 6,
        CI_WHITE   = 7
} sgr_color_index_t;

typedef enum {
        SGR_RESET       = 0,
        SGR_BOLD        = 1,
        SGR_UNDERLINE   = 4,
        SGR_BLINK       = 5,
        SGR_REVERSE     = 7,
        SGR_FGCOLOR     = 30,
        SGR_BGCOLOR     = 40
} sgr_command_t;

typedef struct {
        void (*putuchar)(void *, char32_t);
        void (*control_puts)(void *, const char *);
        void (*flush)(void *);
        void (*key)(void *, keymod_t, keycode_t, char);
        void (*pos_event)(void *, pos_event_t *);
} vt100_cb_t;

/** VT100 decoding state */
typedef enum {
        /** Base state */
        vts_base,
        /** Prefix 1b */
        vts_1b,
        /** Prefix 1b 4f */
        vts_1b4f,
        /** Prefix 1b 5b */
        vts_1b5b,
        /** Prefix 1b 5b 31 */
        vts_1b5b31,
        /** Prefix 1b 5b 31 35 */
        vts_1b5b3135,
        /** Prefix 1b 5b 31 37 */
        vts_1b5b3137,
        /** Prefix 1b 5b 31 38 */
        vts_1b5b3138,
        /** Prefix 1b 5b 31 39 */
        vts_1b5b3139,
        /** Prefix 1b 5b 31 3b */
        vts_1b5b313b,
        /** Prefix 1b 5b 31 3b 32 */
        vts_1b5b313b32,
        /** Prefix 1b 5b 31 3b 33 */
        vts_1b5b313b33,
        /** Prefix 1b 5b 32 */
        vts_1b5b32,
        /** Prefix 1b 5b 32 30 */
        vts_1b5b3230,
        /** Prefix 1b 5b 32 31 */
        vts_1b5b3231,
        /** Prefix 1b 5b 32 33 */
        vts_1b5b3233,
        /** Prefix 1b 5b 32 34 */
        vts_1b5b3234,
        /** Prefix 1b 5b 32 35 */
        vts_1b5b3235,
        /** Prefix 1b 5b 32 38 */
        vts_1b5b3238,
        /** Prefix 1b 5b 35 */
        vts_1b5b35,
        /** Prefix 1b 5b 33 */
        vts_1b5b33,
        /** Prefix 1b 5b 36 */
        vts_1b5b36,
        /** Prefix 1b 5b 3c - mouse report */
        vts_1b5b3c
} vt100_state_t;

enum {
        INNUM_MAX = 3
};

/** VT100 instance */
typedef struct {
        /** Number of columns */
        sysarg_t cols;
        /** Number of rows */
        sysarg_t rows;

        /** Current column */
        sysarg_t cur_col;
        /** Current row */
        sysarg_t cur_row;
        /** Current attributes */
        char_attrs_t cur_attrs;

        /** Enable RGB color */
        bool enable_rgb;

        /** Callback functions */
        vt100_cb_t *cb;
        /** Argument to callback functions */
        void *arg;

        /** Input decoding state */
        vt100_state_t state;
        /** Decoded numeric parameters */
        uint16_t innum[INNUM_MAX];
        /** Index of current numeric parameter */
        unsigned inncnt;
} vt100_t;

extern sgr_color_index_t color_map[];

extern vt100_t *vt100_create(void *, sysarg_t, sysarg_t,
    vt100_cb_t *);
extern void vt100_resize(vt100_t *, sysarg_t, sysarg_t);
extern void vt100_destroy(vt100_t *);

extern errno_t vt100_yield(vt100_t *);
extern errno_t vt100_claim(vt100_t *);
extern void vt100_get_dimensions(vt100_t *, sysarg_t *, sysarg_t *);

extern void vt100_cls(vt100_t *);
extern void vt100_set_pos(vt100_t *, sysarg_t, sysarg_t);
extern void vt100_goto(vt100_t *, sysarg_t, sysarg_t);
extern void vt100_sgr(vt100_t *, unsigned int);
extern void vt100_set_sgr(vt100_t *, char_attrs_t);
extern void vt100_set_attr(vt100_t *, char_attrs_t);
extern void vt100_cursor_visibility(vt100_t *, bool);
extern void vt100_set_button_reporting(vt100_t *, bool);
extern void vt100_set_title(vt100_t *, const char *);
extern void vt100_putuchar(vt100_t *, char32_t);
extern void vt100_flush(vt100_t *);

extern void vt100_rcvd_char(vt100_t *, char);

#endif

/** @}
 */

/* [<][>][^][v][top][bottom][index][help] */
HelenOS homepage, sources at GitHub