caretline 0.3.0

A replayable, drivable text-editing engine: Helix's editing model in a pure Elm architecture. The whole editor is one serializable state; every input is a message.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53

//! caretline: a standalone text-editing engine.
//!
//! The editing model is Helix's (vendored under [`helix`]): a rope, multi-range
//! [`Selection`](helix::Selection)s of anchor and head, every edit a
//! [`Transaction`](helix::Transaction) that maps selections through its changes, an undo
//! [`History`](helix::history::History) tree, grapheme-correct motion, and the
//! `DocumentFormatter` for soft wrap.
//!
//! Around it is a strict Elm architecture:
//!
//! - [`State`] holds everything: text, selection (with the goal column), scroll, viewport,
//!   clipboard register, history, config. It serializes to JSON and back without loss.
//! - [`Msg`] is every input, [`Effect`] every output. Both are plain values.
//! - [`update`] is pure and deterministic: no clock, randomness or I/O. Time arrives in
//!   [`Msg::Tick`].
//! - [`view`] is pure: state in, a cell grid ([`Frame`]) out.
//! - [`keymap`](keymap::keymap) is a pure function from a key to an optional message.
//!
//! So a session is its initial state plus its messages, and replaying them reproduces it
//! exactly ([`trace`]). [`Session`] keeps one (state, revision, trace) and [`protocol`]
//! answers JSON requests against it.

pub mod commands;
pub mod diff;
pub mod helix;
pub mod host;
pub mod keymap;
pub mod layout;
pub mod marks;
pub mod msg;
pub mod outline;
pub mod protocol;
pub mod session;
pub mod state;
pub mod trace;
pub mod update;
pub mod view;
pub mod views;
pub mod external;

pub use commands::{command_msg, commands, default_keymap, Binding, Category, CommandInfo, Platform};
pub use host::{Ctx, Deco, Decoration, Edit, Host, MarkOp};
pub use marks::{MarkAttrs, Mark, MarkId, Marks};
pub use outline::{BlockInfo, Kind, NewBlock, Outline, OutlineConfig};
pub use keymap::{keymap, keymap_for, outline_keymap, parse_keys, script_to_msgs, script_to_msgs_for, Key, KeyCode, Mods};
pub use external::ExtChange;
pub use msg::{By, Dir, Effect, Msg};
pub use session::Session;
pub use state::{Config, Document, ExternalUndo, Follow, Scroll, State, View, ViewConfig, Viewport};
pub use update::{replay, update};
pub use views::update_doc;
pub use layout::OutlineLayout;
pub use view::{view, Frame};