Struct TextDocument 

pub struct TextDocument {
    pub keep_indent: Cell<bool>,
    pub auto_indent: Cell<bool>,
    pub placeholders: RwSignal<HashMap<EditorId, String>>,
    /* private fields */
}

A simple text document that holds content in a rope.
This can be used as a base structure for common operations.

Fields

keep_indent: Cell<bool>

Whether to keep the indent of the previous line when inserting a new line

auto_indent: Cell<bool>

Whether to automatically indent the new line via heuristics

placeholders: RwSignal<HashMap<EditorId, String>>

Implementations

impl TextDocument

pub fn new(cx: Scope, text: impl Into<Rope>) -> TextDocument

pub fn add_pre_command( &self, id: EditorId, pre_command: impl Fn(PreCommand<'_>) -> CommandExecuted + 'static, )

pub fn clear_pre_commands(&self)

pub fn add_on_update(&self, on_update: impl Fn(OnUpdate<'_>) + 'static)

pub fn clear_on_updates(&self)

pub fn add_placeholder(&self, editor_id: EditorId, placeholder: String)

Trait Implementations

impl Clone for TextDocument

fn clone(&self) -> TextDocument

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl CommonAction for TextDocument

fn exec_motion_mode( &self, _ed: &Editor, cursor: &mut Cursor, motion_mode: MotionMode, range: Range<usize>, is_vertical: bool, register: &mut Register, )

fn do_edit( &self, ed: &Editor, cursor: &mut Cursor, cmd: &EditCommand, modal: bool, register: &mut Register, smart_tab: bool, ) -> bool

Perform an edit.
Returns true if there was any change.

impl Debug for TextDocument

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Document for TextDocument

fn text(&self) -> Rope

Get the text of the document
Note: typically you should call Document::rope_text as that provides more checks and utility functions.

fn cache_rev(&self) -> RwSignal<u64>

fn preedit(&self) -> PreeditData

fn run_command( &self, ed: &Editor, cmd: &Command, count: Option<usize>, modifiers: Modifiers, ) -> CommandExecuted

Run a command on the document.
The ed will contain this document (at some level, if it was wrapped then it may not be directly Rc<Self>)

fn receive_char(&self, ed: &Editor, c: &str)

fn edit( &self, iter: &mut dyn Iterator<Item = (Selection, &str)>, edit_type: EditType, )

Perform the edit(s) on this document.
This intentionally does not require an Editor as this is primarily intended for use by code that wants to modify the document from ‘outside’ the usual keybinding/command logic.

fn rope_text(&self) -> RopeTextVal

fn find_unmatched(&self, offset: usize, previous: bool, ch: char) -> usize

Find the next/previous offset of the match of the given character.
This is intended for use by the Movement::NextUnmatched and Movement::PreviousUnmatched commands.

fn find_matching_pair(&self, offset: usize) -> usize

Find the offset of the matching pair character.
This is intended for use by the Movement::MatchPairs command.

fn preedit_phantom( &self, under_line: Option<Color>, line: usize, ) -> Option<PhantomText>

fn compute_screen_lines( &self, editor: &Editor, base: RwSignal<ScreenLinesBase>, ) -> ScreenLines

Compute the visible screen lines.
Note: you should typically not need to implement this, unless you have some custom behavior. Unfortunately this needs an &self to be a trait object. So don’t call .update on Self

fn edit_single(&self, selection: Selection, content: &str, edit_type: EditType)

Perform a single edit.

impl DocumentPhantom for TextDocument

fn phantom_text( &self, edid: EditorId, styling: &EditorStyle, line: usize, ) -> PhantomTextLine

fn has_multiline_phantom(&self, edid: EditorId, _styling: &EditorStyle) -> bool

fn before_phantom_col( &self, edid: EditorId, styling: &EditorStyle, line: usize, col: usize, ) -> usize

Translate a column position into the position it would be before combining with the phantom text.