Crate hjkl_engine 

Vim-mode editor engine built on top of hjkl_buffer.

Exposes an Editor that is fully toolkit-agnostic. Covers the bulk of vim’s normal / insert / visual / visual-line / visual-block modes, text-object operators, dot-repeat, and ex-command handling (:s/foo/bar/g, :w, :q, :noh, …). Rendering goes through hjkl_buffer::BufferView; selection / gutter highlights are painted in the same single-pass as text. TUI/crossterm adapters live in the hjkl-engine-tui companion crate.

Imported wholesale from sqeel-vim with full git history. The trait extraction (Selection / SelectionSet / View + Host sub-traits) lands progressively under crate::types. Pre-1.0 churn — the public surface may change in patch bumps. See docs.rs for the canonical API reference.

The legacy public surface is intentionally narrow:

• Editor — the editor widget.
• VimMode — mode enum used by host apps.
• [ex::run] / [ex::ExEffect] — drive ex-mode commands.

Re-exports

pub use input::Input;

pub use input::Key;

pub use input::decode_macro;

pub use input::from_planned as decode_planned_input;

pub use selection_shift::Sel;

pub use selection_shift::shift_position;

pub use selection_shift::shift_sel;

pub use keymap_motion::MotionKind;

pub use substitute::SubstError;

pub use substitute::SubstFlags;

pub use substitute::SubstituteCmd;

pub use substitute::SubstituteMatch;

pub use substitute::SubstituteOutcome;

pub use substitute::apply_collected_matches;

pub use substitute::apply_substitute;

pub use substitute::collect_substitute_matches;

pub use substitute::parse_substitute;

pub use types::Attrs;

pub use types::BufferEdit;

pub use types::BufferId;

pub use types::Color;

pub use types::Cursor;

pub use types::CursorShape;

pub use types::DefaultHost;

pub use types::EditorSnapshot;

pub use types::EngineError;

pub use types::FoldProvider;

pub use types::Highlight;

pub use types::HighlightKind;

pub use types::Host;

pub use types::Input as PlannedInput;

pub use types::Mode;

pub use types::Modifiers;

pub use types::MouseEvent;

pub use types::MouseKind;

pub use types::NoopFoldProvider;

pub use types::OptionValue;

pub use types::Options;

pub use types::Query;

pub use types::RenderFrame;

pub use types::Search;

pub use types::Selection;

pub use types::SelectionKind;

pub use types::SelectionSet;

pub use types::SnapshotMode;

pub use types::SpecialKey;

pub use types::Style;

pub use types::View;

pub use types::WrapMode;

pub use abbrev::Abbrev;

pub use abbrev::AbbrevTrigger;

pub use search::SearchPrompt;

pub use tag::matching_tag_pair;

pub use types::InsertDir;

pub use types::ScrollDir;

Modules

abbrev

Engine-owned abbreviation types.

buf_helpers

Trait-surface cast helpers shared between [crate::editor] and the discipline crates (hjkl-vim) that drive it.

input

Backend-agnostic key input types used by the vim engine.

keymap_motion

motions

Vim-shaped cursor motions, computed over the SPEC trait surface.

rope_util

Pure rope helpers — no editor, host, or vim state involved.

search

Engine-owned search state + execution helpers.

selection_shift

Keep selections valid across an edit (#63).

substitute

Public substitute command parser and applicator.

tag

HTML/XML tag matching — discipline-agnostic buffer substrate.

types

Core types for the engine trait surface.

Structs

BufferFoldProvider

FoldProvider adapter wrapping a &hjkl_buffer::View. Lets engine call sites ask the buffer’s fold storage about visible rows without reaching into View::next_visible_row &c. directly.

BufferFoldProviderMut

Mutable FoldProvider adapter wrapping a &mut hjkl_buffer::View. Engine call sites that need to dispatch a FoldOp (vim’s z… keystrokes, the :fold* Ex commands, edit-pipeline invalidation) construct this on the fly from &mut self.buffer and call FoldProvider::apply / FoldProvider::invalidate_range on it.

ChangeBank

Per-buffer changelist bank: g;/g, history plus the '. / `. “last change” mark. Shared via Arc<Mutex<ChangeBank>> across every window’s Editor viewing the SAME buffer — vim’s changelist and last-change mark are per-buffer, not per-window, so an edit made in one split must be visible to g; / `. from any other split on that buffer (audit B3).

ContentEdit

Engine-native representation of a single buffer mutation in the shape tree-sitter’s InputEdit consumes. Emitted by hjkl_engine::Editor::mutate_edit and drained by hosts via hjkl_engine::Editor::take_content_edits so the syntax layer can fan edits into a retained tree without the engine taking a tree-sitter dependency.

Edit

A pending or applied edit. Multi-cursor edits fan out to Vec<EngineEdit> ordered in reverse byte offset so each entry’s positions remain valid after the prior entry applies.

Editor

InsertSession

LastVisual

Saved visual-mode anchor + cursor for gv (re-enters the last visual selection). mode carries which visual flavour to restore; anchor / cursor mean different things per flavour:

NoDiscipline

Default discipline for an Editor that has not had a real discipline installed: no FSM, always reports CoarseMode::Normal. Editors that receive vim/vscode/etc. input install their discipline at construction (e.g. hjkl_vim::install_vim_discipline).

Pos

Grapheme-indexed position. line is zero-based row; col is zero-based grapheme column within that line.

Registers

SearchBank

Session-global search state: the last committed //? pattern, its direction, and the search-prompt history. Shared across every window’s Editor via Arc<Mutex<SearchBank>> — see Editor::set_search_arc.

Settings

Vim-style options surfaced by :set. New fields land here as individual ex commands gain :set plumbing.

Slot

SnapshotFoldProvider

Owned-snapshot FoldProvider adapter. Carries a copy of the buffer’s fold list (one Vec<Fold> clone — fold lists are tiny in practice) plus the buffer’s row_count, so the call site can hold the snapshot for fold queries while passing &mut hjkl_buffer::View to a motion function that needs cursor mutation.

Viewport

Visible region of a buffer — the runtime viewport state the host owns and mutates per render frame.

Enums

CoarseMode

Discipline-agnostic coarse mode for app chrome (status badge, cursor shape). Unlike VimMode — which names vim-specific states — CoarseMode is a minimal projection: “are we inserting text, selecting, or idle?”

CursorScrollTarget

Where the cursor should land in the viewport after a z-family scroll (zz / zt / zb).

FoldOp

A fold operation dispatched by the engine’s z… keystrokes, :fold* ex commands, and the edit-pipeline’s “edits inside a fold open it” invalidation.

FsmMode

The FSM-internal mode discriminator used by Editor::fsm_mode() and Editor::set_fsm_mode(). Re-exported as FsmMode to avoid clashing with the types::Mode buffer-side enum that is already exported as Mode.

InsertEntry

InsertReason

LastChange

Information needed to replay a mutating change via ..

LspIntent

Host-observable LSP requests triggered by editor bindings. The hjkl-engine crate doesn’t talk to an LSP itself — it just raises an intent that the TUI layer picks up and routes to sqls.

MarkJump

Return value from the engine’s try_goto_mark_* methods. Tells the caller (app layer) whether a cross-buffer switch is required.

Motion

Operator

Pending

RangeKind

Classification determines how operators treat the range end.

UndoGranularity

Controls the granularity of per-insert-session undo steps.

ViewMode

A read-only view layered over the real input VimMode. Unlike a vim mode (which decides how keystrokes are interpreted), a ViewMode only changes what the buffer presents — input is still interpreted as Normal.

VimMode

Coarse vim-mode a host app can display in its status line.

Traits

DisciplineState

Discipline-private FSM state, stored type-erased on the Editor.

Type Aliases

GlobalMarks

Uppercase (global) vim marks, keyed by 'A'–'Z'; values are (buffer_id, row, col). Shared across every window’s Editor via Arc<Mutex<GlobalMarks>> — see Editor::set_global_marks_arc. Named so the app host can spell the shared-bank type without repeating the nested generic (mirrors crate::Registers).