Replace syscons terminal renderer by a new renderer that uses libteken.
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)
2009-01-01 13:26:53 +00:00
|
|
|
#-
|
|
|
|
|
# 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$
|
|
|
|
|
|
|
|
|
|
# File format is as follows:
|
|
|
|
|
# Abbr Abbreviation of sequence name
|
|
|
|
|
# Name Sequence name (will be converted to C function name)
|
|
|
|
|
# Sequence Bytes that form the sequence
|
2018-05-29 08:41:44 +00:00
|
|
|
# Args Standard value of arguments passed to this sequence
|
Replace syscons terminal renderer by a new renderer that uses libteken.
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)
2009-01-01 13:26:53 +00:00
|
|
|
# - `n' non-zero number (0 gets converted to 1)
|
|
|
|
|
# - `r' regular numeric argument
|
|
|
|
|
# - `v' means a variable number of arguments
|
|
|
|
|
|
2018-05-29 08:41:44 +00:00
|
|
|
# Abbr Name Sequence Args
|
2018-05-28 23:20:08 +00:00
|
|
|
CBT Cursor Backward Tabulation ^[ [ Z n
|
|
|
|
|
CHT Cursor Forward Tabulation ^[ [ I n
|
|
|
|
|
CNL Cursor Next Line ^[ [ E n
|
|
|
|
|
CPL Cursor Previous Line ^[ [ F n
|
|
|
|
|
CPR Cursor Position Report ^[ [ n r
|
|
|
|
|
CUB Cursor Backward ^[ [ D n
|
|
|
|
|
CUD Cursor Down ^[ [ B n
|
|
|
|
|
CUD Cursor Down ^[ [ e n
|
|
|
|
|
CUF Cursor Forward ^[ [ C n
|
|
|
|
|
CUF Cursor Forward ^[ [ a n
|
|
|
|
|
CUP Cursor Position ^[ [ H n n
|
|
|
|
|
CUP Cursor Position ^[ [ f n n
|
|
|
|
|
CUU Cursor Up ^[ [ A n
|
|
|
|
|
DA1 Primary Device Attributes ^[ [ c r
|
|
|
|
|
DA2 Secondary Device Attributes ^[ [ > c r
|
|
|
|
|
DC Delete character ^[ [ P n
|
|
|
|
|
DCS Device Control String ^[ P
|
|
|
|
|
DECALN Alignment test ^[ # 8
|
|
|
|
|
DECDHL Double Height Double Width Line Top ^[ # 3
|
|
|
|
|
DECDHL Double Height Double Width Line Bottom ^[ # 4
|
|
|
|
|
DECDWL Single Height Double Width Line ^[ # 6
|
|
|
|
|
DECKPAM Keypad application mode ^[ =
|
|
|
|
|
DECKPNM Keypad numeric mode ^[ >
|
|
|
|
|
DECRC Restore cursor ^[ 8
|
|
|
|
|
DECRC Restore cursor ^[ [ u
|
|
|
|
|
DECRM Reset DEC mode ^[ [ ? l r
|
|
|
|
|
DECSC Save cursor ^[ 7
|
|
|
|
|
DECSC Save cursor ^[ [ s
|
|
|
|
|
DECSCUSR Set Cursor Style ^[ [ SP q r
|
|
|
|
|
DECSM Set DEC mode ^[ [ ? h r
|
|
|
|
|
DECSTBM Set top and bottom margins ^[ [ r r r
|
|
|
|
|
DECSWL Single Height Single Width Line ^[ # 5
|
|
|
|
|
DL Delete line ^[ [ M n
|
|
|
|
|
DSR Device Status Report ^[ [ ? n r
|
|
|
|
|
ECH Erase character ^[ [ X n
|
|
|
|
|
ED Erase display ^[ [ J r
|
|
|
|
|
EL Erase line ^[ [ K r
|
|
|
|
|
G0SCS0 G0 SCS Special Graphics ^[ ( 0
|
|
|
|
|
G0SCS1 G0 SCS US ASCII ^[ ( 1
|
|
|
|
|
G0SCS2 G0 SCS Special Graphics ^[ ( 2
|
|
|
|
|
G0SCSA G0 SCS UK National ^[ ( A
|
|
|
|
|
G0SCSB G0 SCS US ASCII ^[ ( B
|
|
|
|
|
G1SCS0 G1 SCS Special Graphics ^[ ) 0
|
|
|
|
|
G1SCS1 G1 SCS US ASCII ^[ ) 1
|
|
|
|
|
G1SCS2 G1 SCS Special Graphics ^[ ) 2
|
|
|
|
|
G1SCSA G1 SCS UK National ^[ ) A
|
|
|
|
|
G1SCSB G1 SCS US ASCII ^[ ) B
|
|
|
|
|
HPA Horizontal Position Absolute ^[ [ G n
|
|
|
|
|
HPA Horizontal Position Absolute ^[ [ ` n
|
|
|
|
|
HTS Horizontal Tab Set ^[ H
|
|
|
|
|
ICH Insert character ^[ [ @ n
|
|
|
|
|
IL Insert line ^[ [ L n
|
|
|
|
|
IND Index ^[ D
|
|
|
|
|
NEL Next line ^[ E
|
|
|
|
|
OSC Operating System Command ^[ ]
|
|
|
|
|
RI Reverse index ^[ M
|
|
|
|
|
RIS Reset to Initial State ^[ c
|
|
|
|
|
RM Reset Mode ^[ [ l r
|
|
|
|
|
SD Pan Up ^[ [ T n
|
|
|
|
|
SGR Set Graphic Rendition ^[ [ m v
|
|
|
|
|
SM Set Mode ^[ [ h r
|
|
|
|
|
ST String Terminator ^[ \\
|
|
|
|
|
SU Pan Down ^[ [ S n
|
|
|
|
|
TBC Tab Clear ^[ [ g r
|
|
|
|
|
VPA Vertical Position Absolute ^[ [ d n
|
Replace syscons terminal renderer by a new renderer that uses libteken.
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)
2009-01-01 13:26:53 +00:00
|
|
|
|
|
|
|
|
# Cons25 compatibility sequences
|
2018-05-28 23:20:08 +00:00
|
|
|
C25BLPD Cons25 set bell pitch duration ^[ [ = B r r
|
|
|
|
|
C25BORD Cons25 set border ^[ [ = A r
|
|
|
|
|
C25DBG Cons25 set default background ^[ [ = G r
|
|
|
|
|
C25DFG Cons25 set default foreground ^[ [ = F r
|
|
|
|
|
C25GCS Cons25 set global cursor shape ^[ [ = C v
|
|
|
|
|
C25LCT Cons25 set local cursor type ^[ [ = S r
|
|
|
|
|
C25MODE Cons25 set terminal mode ^[ [ = T r
|
|
|
|
|
C25SGR Cons25 set graphic rendition ^[ [ x r r
|
|
|
|
|
C25VTSW Cons25 switch virtual terminal ^[ [ z r
|
Replace syscons terminal renderer by a new renderer that uses libteken.
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)
2009-01-01 13:26:53 +00:00
|
|
|
|
|
|
|
|
# VT52 compatibility
|
2018-05-29 08:41:44 +00:00
|
|
|
#DECID VT52 DECID ^[ Z
|
2018-10-21 08:29:36 +00:00
|
|
|
|
|
|
|
|
# ECMA-48
|
|
|
|
|
REP Repeat last graphic char ^[ [ b n
|
