Go to file
Levi Neuwirth dd581cd90c docs: frame the PTY terminate diagnostic (revision 4)
A docs-only PR (#172) failed Test (macos-latest / luajit) on
acc28_child_input_and_the_c_c_escape_work_unchanged_in_a_panel with
"kill: EPERM: Operation not permitted" raised out of terminate. A docs
diff cannot cause that, main was green at the PR's exact base, and three
other PRs passed the same job.

This framing reaches revision 4 after three review rounds, and what it
proposes is much smaller than what it started with. Revisions 1 to 3 each
proposed a tolerance rule -- treat some errno as success -- and each was
unsound in the same way: they concluded something about a process from
something that was not about that process. Revision 1 concluded from an
errno alone, which says only that a syscall failed. Revision 2 concluded
from the spawned leader while a PTY signal targets the tty's foreground
process group, which diverges from the leader exactly when job control is
in use. Revision 3 corrected EPERM but kept group-directed ESRCH, which
proves only that the selected foreground group vanished, not that the
leader exited.

So no tolerance rule lands. The disposition is preserved exactly: every
failing call still fails, with no state transition and no ledger arming.
What lands is that the failure explains itself, recording the target
source and value, the spawn-time pgid or leader pid, the errno, and the
leader's real try_wait state as five separate facts. Every candidate fix
is decidable from those together and none is decidable from the errno
alone.

Two claims are stated more narrowly than earlier revisions had them.
Consulting try_wait reaps an exited child and caches its status, so this
is not "strictly additive" -- it is "no disposition change", with an
event-count test pinning that poll_one still emits exactly one exit
event. And the test seam injects the kill attempt's result only, never
the observation, so the real ChildHandle::try_wait runs against the real
child; a stubbed observation would bypass the path under test.

Parked with their reasons: all tolerance rules, terminate becoming
idempotent for an already-reaped process (an independent fix answering a
different failure), and signal_target's read-then-kill of tcgetpgrp,
which is the most likely real fix site.

The lane closes when this lands rather than waiting for the flake to
recur; the next occurrence carries its own evidence under whoever's PR.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01HZjWMjwPXhPbt9upku9mCk
2026-07-25 21:12:51 -04:00
.github/workflows fix(gpu): F-004 AltGr strip → Ctrl+Alt only; run pmacs-protocol tests in CI 2026-07-03 14:38:19 -04:00
audit V0.2-prerequisite pull-forward + M10.11 clean audit round 2026-05-18 10:31:31 -04:00
builtin fix(dired): correct the reporting-channel claim #161 falsified 2026-07-25 16:14:06 -04:00
docs docs: frame the PTY terminate diagnostic (revision 4) 2026-07-25 21:12:51 -04:00
pmacs-gpu Merge remote-tracking branch 'githubsucks/main' into inline-math-slice 2026-07-25 17:29:35 -04:00
pmacs-protocol Implement session-scoped GPU initial targets 2026-07-23 19:03:25 -04:00
proptest-regressions M10.10 ship gate 2026-05-13 16:28:46 -04:00
scripts dev: scripts/bite — machine-checkable bite-verification 2026-07-12 17:09:41 +01:00
src Merge pull request #157 from levineuwirth/crdt-undo-repro 2026-07-25 23:10:46 +00:00
tests Merge canonical main (#166) into the dired Stage 1 lane 2026-07-25 16:41:21 -04:00
.gitignore audit remediation: workspace clippy gate + stale metadata + cruft (F-001/F-013/F-015) 2026-07-03 10:31:17 -04:00
AGENTS.md docs: add COHERENCE.md as a required doc, audited against the codebase 2026-07-25 11:37:21 -04:00
CHANGELOG.md docs(changelog): remove dangling prerequisite links 2026-07-22 19:54:07 -04:00
CLAUDE.md docs: add COHERENCE.md as a required doc, audited against the codebase 2026-07-25 11:37:21 -04:00
COHERENCE.md docs: record the inline-math slice (#158) as landed 2026-07-25 18:16:31 -04:00
Cargo.lock Merge canonical main (8c86d34) into the inline-math slice 2026-07-25 14:32:48 -04:00
Cargo.toml feat(syntax): bundle the Lean 4 grammar (Arc 8 Stage 1, Q#LN1-3) 2026-07-25 09:49:01 -04:00
LICENSE-APACHE Initial commit: v0.1.0 2026-05-03 19:51:06 -04:00
LICENSE-MIT Initial commit: v0.1.0 2026-05-03 19:51:06 -04:00
README.md fix(gpu): preserve session isolation during target publish 2026-07-23 21:25:33 -04:00
build.rs Initial commit: v0.1.0 2026-05-03 19:51:06 -04:00
rust-toolchain.toml rust-toolchain.toml: add rust-analyzer component (pin regression fix) 2026-05-18 11:58:46 -04:00
rustfmt.toml Initial commit: v0.1.0 2026-05-03 19:51:06 -04:00

README.md

Pmacs

Parallel Emacs --- a Rust-cored, Lua-scripted editor in the Emacs tradition.

Pmacs runs the editor's hot path (rope, buffers, views, async runtime, process supervision) in Rust, and exposes the rest --- commands, keymaps, hooks, packages --- through an embedded Lua VM. The design follows Emacs in shape (configurable, introspectable, programmable from inside) but discards the single-threaded substrate; workers, message bus, and a coroutine-based async surface are core primitives, not bolt-ons.

The editor is partitioned into a long-lived instance (the daemon that owns buffers, processes, and language services) and thin frontends that attach over a typed protocol (currently v20). Two frontends ship today:

  • a TUI (crossterm cell grid), attachable locally over a Unix socket or remotely over SSH, with reconnect-on-drop modeled on mosh; and
  • pmacs-gpu, a GPU frontend (wgpu + winit + glyphon) that renders from a semantic projection of editor state --- style spans, decorations, inlay adornments --- rather than a character grid, and edits optimistically against a local CRDT replica for latency-free typing.

Buffers are optionally CRDT-backed (loro, behind --features crdt), so multiple frontends --- TUI and GPU, local and remote --- can edit the same buffers concurrently with live cursor/selection presence.

Status

v1.0.0 --- stable core, active development. The v1.0 gate (the instance/frontend partition, the Lua surface, and a REPL package audited to use zero direct Rust core access) shipped some time ago. Development since has expanded the semantic frontend protocol from v6 through v20, brought the GPU frontend near input/render parity with the TUI, and completed the LSP, editing, persistence, themes, and terminal arcs. Recent work added major modes and modeline detection, a typed configuration registry, composable statuslines, multi-language syntax processing, and cross-frontend tab-width parity. Current direction lives in docs/roadmap-2026-07.md. Public contributions are open: use, evaluate, file issues, and send pull requests.

Highlights

Editing & UI. CUA-style region editing plus Emacs kill/yank and kill-ring bindings; linear undo/redo; query-replace; incremental substring and regex search (C-s / C-r / C-M-s); comment, auto-indent, auto-pair, transpose, case, line, and region operations; line-number gutter with absolute, relative, and hybrid modes; diagnostic signs; context menu; OS clipboard integration (OSC 52 in the TUI, native in the GPU); minibuffer completion with persisted history; buffer-list and compilation modes; self-navigable help. Named ui.* theme faces, live GPU font selection, and composable per-window statusline providers keep chrome and modelines runtime-configurable. Saves are atomic (temp + rename + parent fsync, mode-preserving).

Language intelligence. The async LSP client provides diagnostics, rename with prepareRename, cross-file definitions, hover, signature help, references, document symbols, code actions, formatting, semantic tokens, and inline inlay hints. Preconfigured servers cover Rust, C/C++, Python, Go, JavaScript/TypeScript, Lua, Bash, TOML, Zig, Dockerfile, CMake, JSON, and YAML. Bundled tree-sitter grammars include those languages plus Markdown, Make, and CUDA; nested Markdown fences and frontmatter use multi-language injections, and locals-query processing distinguishes shadowed builtins. Bounded Emacs and Vim modelines join extensions, exact filenames, and shebangs in one fresh-load language decision. That decision initializes the buffer's major mode, drives syntax/LSP/pairing/comment behavior, and enables mode-scoped keymaps. A persistent project-symbol index (.pmacs/index.json) rides the same worker infrastructure.

Collaboration & frontends. With --features crdt, buffers are CRDT-backed and any number of frontends attach to one daemon and edit concurrently; peers see each other's cursors and selections as translucent washes. The TUI and GPU frontends both host owned full-screen terminal sessions; protocol-v19 terminal frames preserve the fixed-cell VT screen while each frontend owns its scroll/selection/input context. The GPU frontend also provides a live minimap, wavy diagnostic squiggles, a status band, and optimistic local editing that rebases in-flight edits through authoritative frames. Buffer text, syntax, diagnostics, carets, hits, and minimap geometry now share one eight-column tab projection without mutating source bytes.

Extensibility. The pmacs.* Lua namespaces cover buffers, windows, commands, global/mode/buffer keymaps, hooks, themes, statusline providers, tree-sitter, LSP stores, async workers, and a PTY-aware process supervisor. The typed, introspectable pmacs.config registry supports global and buffer-local values, listeners, startup-only settings, and describe-setting. A package manager installs from git (github:owner/repo, version/branch/commit pins) with transitive dependency resolution and a SHA-256 lockfile. Pmacs is also an MCP client: packages can spawn MCP servers and consume their tools, resources, and prompts --- AI integrations are packages over a transport, not a built-in feature. The bundled REPL package is written entirely against the public Lua API.

Running

Single-process TUI:

pmacs [FILE]                 # TUI; -nw reserved for when a GUI default lands

GPU frontend (one command; the root binary starts or reuses the daemon):

pmacs --gpu                         # default instance; no initial file
pmacs --gpu README.md               # default instance; open one file
pmacs --gpu --socket NAME FILE      # named instance; bare NAME →
                                    #   <runtime>/pmacs/NAME.sock
pmacs --gpu -- --leading-dash       # `--` ends option parsing

pmacs --gpu requires the root pmacs binary to be built with the crdt feature. It discovers a sibling pmacs-gpu binary first, then falls back to pmacs-gpu on PATH. When FILE is present, the daemon loads or creates it and completes startup hooks before the GPU window appears. Closing the window detaches only that frontend; the daemon remains available for later GPU or TUI attaches.

Daemon + attached TUI frontends:

pmacs --daemon --socket NAME        # foreground daemon
pmacs --attach --socket NAME        # TUI frontend; F12 detaches
pmacs --attach user@host            # remote TUI over SSH

For debugging an already-running daemon, the low-level GPU command stays available and never auto-starts or replaces anything:

pmacs-gpu --attach /absolute/path/to/pmacs.sock

pmacs --attach also understands ssh:user@host/instance, local:/path.sock, and bare hostnames (treated as SSH). See pmacs --help for the full matrix.

User configuration is plain Lua at $XDG_CONFIG_HOME/pmacs/init.lua (default ~/.config/pmacs/init.lua), loaded after the builtin runtime so plain assignments override defaults --- keybindings, pmacs.lsp.config, theme overrides, and package installs all live there.

Build

Builds on the toolchain pinned in rust-toolchain.toml (Rust 1.95.0, edition 2024); rustup selects it automatically.

# Coherent root + GPU release build. The package-qualified feature keeps
# the separate pmacs-gpu package feature-free while enabling CRDT in pmacs.
cargo build --release --workspace --features pmacs/crdt

target/release/pmacs --gpu README.md # one-command managed GPU file launch
cargo run --release -- --version     # default-run selects the pmacs binary
cargo test --workspace              # unit + integration tests (all crates)
cargo fmt --check
cargo clippy --workspace --all-targets -- -D warnings   # incl. pmacs-gpu

Feature matrix

Cargo features fall into two independent axes. Do not use --all-features — it enables both Lua flavors at once, which cannot build (see below).

Feature Axis Notes
luajit Lua flavor Default. LuaJIT backend via mlua (vendored).
lua54 Lua flavor Lua 5.4 fallback for hosts without LuaJIT (big-endian, …).
crdt Buffer Opt-in CRDT-backed buffer mode (adds the loro dep). v1.0 builds enable it; orthogonal to the flavor.

Exactly one Lua flavor must be enabledluajit or lua54, never both (and never neither). They map to mlua's mutually-exclusive Lua backends, so --all-features (or --features luajit,lua54, or --no-default-features with no flavor) fails in the mlua-sys build script with "You can enable only one of the features: …". That check lives in a dependency cargo builds first, so pmacs can't replace it with a friendlier error — the fix is to build a specific flavor. Supported build lines:

cargo build --release                                   # luajit (default)
cargo build --release --no-default-features --features lua54
cargo build --release --features crdt                   # luajit + crdt
cargo build --release --no-default-features --features lua54,crdt

CI, cargo hack, and distro tooling should iterate the flavors explicitly (--no-default-features --features <flavor>[,crdt]) rather than reaching for --all-features. Both flavors pass the full test suite; CI runs the matrix on every push.

Release-only perf gates (M5 keystroke-to-render, M6 ingest/RSS/cancel and scrollback navigation/search) are #[ignore]'d during normal test runs and exercised in CI under dedicated jobs. The GPU frontend has headless render tests (offscreen wgpu, pixels read back) that run in CI under lavapipe and skip gracefully on machines without a Vulkan adapter (PMACS_REQUIRE_GPU=1 turns a missing adapter into a hard failure).

Runtime requirements

The pmacs binary depends on a small set of POSIX command-line tools at runtime. The dependency exists because the project enforces #![forbid(unsafe_code)] everywhere, including in tests; calls that would otherwise need unsafe (PTY raw-mode setup, signal name translation) are routed through trampolines that exec these tools.

  • /bin/sh (POSIX shell). Used for the PTY raw-mode trampoline: /bin/sh -c 'stty raw -echo </dev/tty 2>/dev/null; exec "$@"' -- configures the controlling TTY's line discipline before exec'ing the actual subprocess. Required by the REPL package and any other caller that spawns a process in raw PTY mode.
  • stty (coreutils). The line-discipline configurator invoked by the trampoline above.
  • coreutils more broadly. The M6 process-supervisor tests spawn cat, yes, and which; absent these the test suite (not the editor itself) degrades. which is also used by the M6.5 shell-locator helper to find bash / zsh / fish for per-shell integration tests. The M7.2 fetcher's timeout test uses sleep.
  • git (added in M7.2). Required for any package operation: the package fetcher shells out to git to clone, fetch, and resolve refs, with a deterministic environment (GIT_TERMINAL_PROMPT=0, GIT_CONFIG_NOSYSTEM=1, LC_ALL=C, inherited GIT_* variables stripped). Authentication for private repositories rides the user's existing git configuration (credential helpers, SSH agent), so packagers do not need a separate auth story. Pre-M7 builds without package operations do not need git.
  • tar (added in M7.3). Required for pmacs.packages.install: the installer materializes a snapshot via git archive --format=tar piped into tar -x -C <dest>, which keeps the on-disk install directory self-contained (no .git linkage back to the bare cache, no working-tree state). GNU tar and bsdtar both work. Pre-M7 builds and any path that doesn't call pmacs.packages.install{...} do not need tar.

Distribution packagers should ensure these are runtime dependencies of the pmacs package. On a typical Linux distribution, busybox or GNU coreutils plus a shell of any kind satisfies the requirement; on macOS the system shell and /usr/bin/stty are both standard.

The Lua VM (LuaJIT or Lua 5.4) is statically vendored via mlua's vendored feature, so there is no external Lua dependency at runtime.

The GPU frontend additionally needs a Vulkan-capable driver stack (any real GPU driver, or lavapipe for software rendering); its font (JetBrains Mono, OFL-licensed) is bundled into the binary.

Layout

The workspace has three first-party crates:

src/                 pmacs — the core + TUI + daemon
  rope.rs              persistent byte-sequence backing every buffer
  buffer.rs            buffer + view chain + undo/redo
  editor_core.rs       cursor + commands + edit dispatch
  crdt.rs              loro-backed CRDT buffer state (feature `crdt`)
  daemon.rs            instance side of the frontend partition
  attach.rs            frontend side; transports + reconnect
  semantic_render.rs   semantic-frame producer (StyleSpans, Decorations, …)
  lsp.rs               language-server client
  diag.rs, highlight.rs  diagnostic + syntax/semantic-token rendering
  syntax.rs            tree-sitter integration
  search.rs            incremental search (substring + regex)
  minibuffer.rs        prompt, completion, persisted history
  menu.rs              context-menu model
  file_io.rs           atomic saves + external-modification detection
  async_runtime.rs     worker pool + message bus
  process.rs           PTY-aware process supervisor
  ansi.rs              ECMA-48 parser
  project.rs, project_index.rs  project detection + symbol index
  packages/            resolver, fetcher, installer, lockfile, loader
  mcp.rs               MCP client (packages speak to MCP servers)
  lua_bindings/        pmacs.* Lua surface installers
  text_view.rs         cell-grid renderer
  frontend.rs          crossterm TUI
  main.rs              entry point (TUI / daemon / attach modes)

pmacs-protocol/      wire types + framing codec shared by all frontends
pmacs-gpu/           the GPU frontend (wgpu + winit + glyphon)

builtin/             Lua runtime shipped with the binary
  commands/default.lua  named commands for every editor primitive
  keymaps/default.lua   default key bindings
  hooks/default.lua     built-in hook definitions
  menus/default.lua     context-menu items
  runtime/              async, lsp, syntax, mcp, fs runtimes
  packages/repl/        the bundled REPL package

docs/                design notes, framing docs, and the roadmap
tests/               integration tests (acceptance gates per milestone)

License

Dual-licensed under either of:

at your option.