mirror of
https://github.com/opnsense/src.git
synced 2026-02-09 22:06:55 -05:00
b4b1c5169d
Some time ago I started working on a library called libteken, which is
terminal emulator. It does not buffer any screen contents, but only
keeps terminal state, such as cursor position, attributes, etc. It
should implement all escape sequences that are implemented by the
cons25 terminal emulator, but also a fair amount of sequences that are
present in VT100 and xterm.
A lot of random notes, which could be of interest to users/developers:
- Even though I'm leaving the terminal type set to `cons25', users can
do experiments with placing `xterm-color' in /etc/ttys. Because we
only implement a subset of features of xterm, this may cause
artifacts. We should consider extending libteken, because in my
opinion xterm is the way to go. Some missing features:
- Keypad application mode (DECKPAM)
- Character sets (SCS)
- libteken is filled with a fair amount of assertions, but unfortunately
we cannot go into the debugger anymore if we fail them. I've done
development of this library almost entirely in userspace. In
sys/dev/syscons/teken there are two applications that can be helpful
when debugging the code:
- teken_demo: a terminal emulator that can be started from a regular
xterm that emulates a terminal using libteken. This application can
be very useful to debug any rendering issues.
- teken_stress: a stress testing application that emulates random
terminal output. libteken has literally survived multiple terabytes
of random input.
- libteken also includes support for UTF-8, but unfortunately our input
layer and font renderer don't support this. If users want to
experiment with UTF-8 support, they can enable `TEKEN_UTF8' in
teken.h. If you recompile your kernel or the teken_demo application,
you can hold some nice experiments.
- I've left PC98 the way it is right now. The PC98 platform has a custom
syscons renderer, which supports some form of localised input. Maybe
we should port PC98 to libteken by the time syscons supports UTF-8?
- I've removed the `dumb' terminal emulator. It has been broken for
years. It hasn't survived the `struct proc' -> `struct thread'
conversion.
- To prevent confusion among people that want to hack on libteken:
unlike syscons, the state machines that parse the escape sequences are
machine generated. This means that if you want to add new escape
sequences, you have to add an entry to the `sequences' file. This will
cause new entries to be added to `teken_state.h'.
- Any rendering artifacts that didn't occur prior to this commit are by
accident. They should be reported to me, so I can fix them.
Discussed on: current@, hackers@
Discussed with: philip (at 25C3)
126 lines
3 KiB
C
126 lines
3 KiB
C
/*-
|
|
* Copyright (c) 1999 Kazutaka YOKOTA <yokota@zodiac.mech.utsunomiya-u.ac.jp>
|
|
* 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 as
|
|
* the first lines of this file unmodified.
|
|
* 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 AUTHORS ``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 AUTHORS 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.
|
|
*
|
|
*/
|
|
|
|
#include <sys/cdefs.h>
|
|
__FBSDID("$FreeBSD$");
|
|
|
|
#include "opt_syscons.h"
|
|
|
|
#include <sys/param.h>
|
|
#include <sys/systm.h>
|
|
#include <sys/kernel.h>
|
|
#include <sys/consio.h>
|
|
|
|
#include <dev/syscons/syscons.h>
|
|
|
|
SET_DECLARE(scterm_set, sc_term_sw_t);
|
|
|
|
/* exported subroutines */
|
|
|
|
void
|
|
sc_move_cursor(scr_stat *scp, int x, int y)
|
|
{
|
|
if (x < 0)
|
|
x = 0;
|
|
if (y < 0)
|
|
y = 0;
|
|
if (x >= scp->xsize)
|
|
x = scp->xsize - 1;
|
|
if (y >= scp->ysize)
|
|
y = scp->ysize - 1;
|
|
scp->xpos = x;
|
|
scp->ypos = y;
|
|
scp->cursor_pos = scp->ypos*scp->xsize + scp->xpos;
|
|
}
|
|
|
|
void
|
|
sc_clear_screen(scr_stat *scp)
|
|
{
|
|
(*scp->tsw->te_clear)(scp);
|
|
scp->cursor_oldpos = scp->cursor_pos;
|
|
sc_remove_cutmarking(scp);
|
|
}
|
|
|
|
/* terminal emulator manager routines */
|
|
|
|
static LIST_HEAD(, sc_term_sw) sc_term_list =
|
|
LIST_HEAD_INITIALIZER(sc_term_list);
|
|
|
|
int
|
|
sc_term_add(sc_term_sw_t *sw)
|
|
{
|
|
LIST_INSERT_HEAD(&sc_term_list, sw, link);
|
|
return 0;
|
|
}
|
|
|
|
int
|
|
sc_term_remove(sc_term_sw_t *sw)
|
|
{
|
|
LIST_REMOVE(sw, link);
|
|
return 0;
|
|
}
|
|
|
|
sc_term_sw_t
|
|
*sc_term_match(char *name)
|
|
{
|
|
sc_term_sw_t **list;
|
|
sc_term_sw_t *p;
|
|
|
|
if (!LIST_EMPTY(&sc_term_list)) {
|
|
LIST_FOREACH(p, &sc_term_list, link) {
|
|
if ((strcmp(name, p->te_name) == 0)
|
|
|| (strcmp(name, "*") == 0)) {
|
|
return p;
|
|
}
|
|
}
|
|
} else {
|
|
SET_FOREACH(list, scterm_set) {
|
|
p = *list;
|
|
if ((strcmp(name, p->te_name) == 0)
|
|
|| (strcmp(name, "*") == 0)) {
|
|
return p;
|
|
}
|
|
}
|
|
}
|
|
|
|
return NULL;
|
|
}
|
|
|
|
sc_term_sw_t
|
|
*sc_term_match_by_number(int index)
|
|
{
|
|
sc_term_sw_t *p;
|
|
|
|
if (index <= 0)
|
|
return NULL;
|
|
LIST_FOREACH(p, &sc_term_list, link) {
|
|
if (--index <= 0)
|
|
return p;
|
|
}
|
|
|
|
return NULL;
|
|
}
|