Hojun-Cho/strans
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Simplify build system

Browse Source
This commit is contained in:
Hojun-Cho
2026-08-12 14:23:41 +09:00
parent 2ae87a3926
commit 5ae0945015
129 changed files with 161 additions and 50148 deletions
Download Patch File Download Diff File Expand all files Collapse all files

189
README.md
View File

@@ -1,135 +1,118 @@
# strans
An input method daemon for CJK text entry on X11 and Wayland.
Inspired by 9front's ktrans. Threads communicate via CSP channels.
## Dependencies
- plan9port
- Python 3 (for generated-map checks)
- dbus-1
- wayland-client, libxkbcommon (for Wayland support)
- gtk+-3.0 (optional, for GTK IM module)
A small input method daemon for Japanese, Korean, Vietnamese, emoji, and
symbols on X11 and Wayland. Inspired by 9front's ktrans.
## Build
make
cd xim && make # XIM adapter
cd gtk && make docker && make install # GTK IM module
The recommended build needs only Docker and Make on the host:
Unit tests use the sibling `cutest` Git repository as a submodule and do not
require the Wayland, D-Bus, GTK, or X11 development packages. Repository
mirrors must provide the same sibling; initialize it after cloning with
`git submodule update --init`:
```sh
make docker
```
make check # generated map + unit tests
make test TESTARGS=hangul # filtered unit tests only
make verify-map # generated-map check only
This creates an Arch Linux build image, compiles all runtime components in one
disposable container, and writes three artifacts into the source tree:
The suite covers the fixed-size UTF-8 string, hash table, trie fixtures,
Japanese/Hangul/Telex state transitions, dictionary candidates, engine
selection state, IPC request fields, and production map loading. Tests use
explicit case tables, boundary values, and small regressions for repaired core
contracts. Full IPC and GUI protocol stacks require separate integration checks.
```text
strans daemon, IBus and Wayland frontend
xim/strans-xim XIM frontend
gtk/im-strans.so GTK 3 frontend
```
The build starts clean so host and container object files are never mixed. It
removes existing build and test outputs; the `strans-build` dependency image is
kept as a cache. No development packages are required on the host.
Void Linux runtime dependencies:
```sh
sudo xbps-install -S dbus-libs wayland libxkbcommon libxcb xcb-imdkit gtk+3
```
For a native Arch Linux build, use `Dockerfile` as the dependency and Plan 9
setup checklist, then run `make`. Build the benchmark separately with
`make bench`.
## Run
./strans map font &
Start the daemon:
For XIM apps:
```sh
./strans map font &
```
./xim/strans-xim &
XMODIFIERS=@im=strans xterm
For XIM applications:
For GTK apps:
```sh
./xim/strans-xim &
export XMODIFIERS=@im=strans
xterm
```
GTK_IM_MODULE=strans gedit
For GTK 3 applications:
For IBus apps (kitty, foot, etc.):
```sh
sudo make -C gtk install
GTK_IM_MODULE=strans gedit
```
GLFW_IM_MODULE=ibus kitty
For IBus clients such as kitty:
For Wayland apps (text-input-v3 clients on wlroots compositors):
```sh
GLFW_IM_MODULE=ibus kitty
```
# nothing to set; the compositor relays text-input-v3 to strans
Wayland needs no environment variable. Start `strans` after a wlroots
compositor that supports input-method-v2. Neither ibus-daemon nor fcitx is
required.
Strans itself is the IBus endpoint and the Wayland input-method-v2 client;
no ibus-daemon or fcitx5 needed. Start strans after the compositor.
## Keys
## Usage
Input modes are selected with Ctrl and one letter:
Switch input modes with Ctrl + key:
```text
Ctrl+N Hiragana
Ctrl+K Katakana
Ctrl+S Hangul
Ctrl+T English
Ctrl+V Vietnamese Telex
Ctrl+E Emoji and symbol search
Ctrl+P Toggle popup preedit
```
N Hiragana
K Katakana
S Hangul
T English
V Vietnamese (Telex)
P Toggle preedit echo
Use `1`-`9` or the arrow keys to select a candidate. Tab moves through
candidates, Enter commits, and Escape cancels.
Type romanized input. Select candidates with 1-9 or arrow keys.
Outside one-shot search, Tab or Enter commits.
Emoji search is temporary and returns to the previous input mode:
### Emoji and symbols
```text
Ctrl+E → smile → Enter → 😀
```
Ctrl+E starts a one-shot symbol search; it is not a mode. Any current preedit
is committed, then the previous language is kept for the next input. Type an
English alias or the phonetic keys of the current layout (Korean aliases work,
for example). The candidate list is shown even when Ctrl+P has hidden normal
preedit echo.
## Tests
안녕 → Ctrl+E → smile → Enter → 😀
Tests use the sibling `cutest` repository as a submodule. Its relative URL
expects repository mirrors and forks to provide the same sibling. Initialize
it once, then run the checks in the build container:
There is no auto-insert. Enter commits the first candidate (or the current
one); arrows and Tab move, and Esc cancels. Bare 1 through 9 select an existing
numbered row; a bare digit with no such row and 0 remain query text. Digit
aliases are kept in matching slots, so `^1`, `_2`, and `<3` produce `¹`, `₂`,
and `♥`.
```sh
git submodule update --init
make docker-check
```
`map/emoji.src` is the source of truth: each UTF-8 TSV row is a result followed
by one or more tab-separated aliases. Aliases may be multilingual and ASCII
letters are case-insensitive. Results and aliases are limited to 64 Unicode
code points; results cannot contain whitespace. Run `map/mkemoji > map/emoji.dict`
after editing it; `make verify-map` checks the generated dictionary and the
Telex map.
The native `make check` command needs plan9port and Python 3, but not the GUI
development packages. Use `make test TESTARGS=hangul` or
`make docker-check TESTARGS=hangul` to filter unit tests. After editing
`map/emoji.src`, regenerate and verify the dictionary with:
😀 웃음 웃다 스마일 smile grin
```sh
map/mkemoji > map/emoji.dict
make verify-map
```
## Architecture
## Design
Threads communicate via CSP channels:
- [imthread](strans.c): keystroke processing, transliteration
- [dictthread](dict.c): dictionary lookup
- [drawthread](win.c): preedit window rendering
- [srvthread](srv.c): IPC via unix socket
- [ibusthread](ibus.c): IBus D-Bus endpoint for GLFW/kitty
- [waylandthread](wayland.c): Wayland input-method-v2 + virtual-keyboard-v1
Adapters (strans-xim, im-strans.so) bridge X11/GTK events.
## Files
strans.c input method engine
dict.c dictionary queries
win.c xcb window management
font.c truetype rendering (stb_truetype)
wayland.c wayland input-method-v2 adapter
map/ transliteration tables
font/ bundled CJK fonts
input-method-unstable-v2-*.{c,h} wayland-scanner output, vendored
virtual-keyboard-unstable-v1-*.{c,h}
The two Wayland protocols (input-method-v2, virtual-keyboard-v1) are
wlroots-only and not in the upstream wayland-protocols package, so the
generated client code is vendored. Regenerate with wayland-scanner if
the XML upstream ever changes (it hasn't in years).
## References
- https://git.9front.org/plan9front/plan9front/HEAD/info.html
- https://np.mkv.li/kor/9front-ktrans-%ED%95%9C%EA%B8%80-%EB%98%91%EB%B0%94%EB%A1%9C-%EB%A7%8C%EB%93%A4%EA%B8%B0/
- https://en.wikipedia.org/wiki/Telex_(input_method)
- https://gist.github.com/hieuthi/0f5adb7d3f79e7fb67e0e499004bf558
`strans` owns the input engine and candidate window. The XIM and GTK frontends
forward keys to it over a Unix socket; the IBus and Wayland frontends are built
into the daemon. Internal threads communicate through CSP channels.