Skip to content

12Me21/12term

Repository files navigation

WORK IN PROGRESS!!

Much of the X and pseudoterminal code was originally borrowed from st (https://st.suckless.org/)
This probably complicates licensing, but fortunately I don't care :)

the goal is to match the behavior of xterm (minus some complex features that aren't used much)

(I hope to perhaps add image support eventually, using the kitty graphics protocol.)

Starting ~June 6th, i've been writing this terminal using itself (with emacs of course)

# Compiling

run `make`.

install with `sudo make install` (at your own risk!)

# Dependencies

┏━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━┓
┃   Name     ┃     apt           ┃   pacman   ┃
┡━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━┩
│ X11        │ libx11-dev        │ libx11     │
│ Xrender    │ libxrender-dev    │ libxrender │
│ FreeType   │ libfreetype-dev   │ freetype2  │
│ Fontconfig │ libfontconfig-dev │ fontconfig │
└────────────┴───────────────────┴────────────┘

# Configuration

See `xresources-example.ad`

# References:

- st source code (https://st.suckless.org/)
- https://invisible-island.net/xterm/ctlseqs/ctlseqs.html
- xterm source code + behavior (https://invisible-island.net/xterm/)
- https://sw.kovidgoyal.net/kitty/protocol-extensions.html
- foot terminal source code (https://codeberg.org/dnkl/foot/)
- https://en.wikipedia.org/wiki/ANSI_escape_code (this page sucks but a lot of people probably read it so it's good to support the stuff listed there)

# Xft history

for many years, xft didn't support fonts with colored glyphs (i.e. emojis), but recently a patch was released which fixes this.
I don't think the patch will be merged within my lifetime (not to mention actually added to package managers), so I switched to my own custom compiled-in version of xft

# Char widths

In terminals, not every character uses a single "cell". Some wide characters use 2, while others are rendered on top of the previous character and don't take up any space themselves.
This is significant because it means: __after printing a character, the cursor may move either 0, 1, or 2 spaces (as well as wrapping to the next line)__
For programs which rely on cursor position (shell prompts, text editors, 'graphical' interfaces, etc.) it is VERY important that they use the same width lookup tables as the terminal itself, otherwise the text onscreen will become corrupted.

For this reason, most programs use the same `wcwidth` library function to look up character widths.
However, some people have decided that it is more "correct" to include their own hardcoded table, which causes rendering to fail on any terminal which doesn't have the exact same version of this table.

# Resizing

When the window is resized, existing text is "anchored" at the lower left corner. ("southwest resize gravity")
This behavior is taken from xterm, and I think it makes sense: your cursor is usually near the bottom of the screen (except after clearing it), and this preserves that.
maybe I'll add an option for northwest gravity if anyone wants it

Currently when changing the window's width, lines will be truncated, or it'll add empty space on the right side.
I'll add support for re-wrapping eventually.