Struct modalkit::editing::buffer::EditBuffer

pub struct EditBuffer<I: ApplicationInfo> { /* private fields */ }

A text buffer.

Implementations

impl<I> EditBuffer<I>

where I: ApplicationInfo,

pub fn from_rope(id: I::ContentId, text: EditRope) -> Self

Create a new buffer given its initial contents as an EditRope.

pub fn from_str(id: I::ContentId, text: &str) -> Self

Create a new buffer given its initial contents.

pub fn new(id: I::ContentId) -> Self

Create a new empty buffer.

pub fn id(&self) -> I::ContentId

Get this buffer’s content identifier.

pub fn is_blank(&self) -> bool

Indicates whether this buffer contains only whitespace.

pub fn get(&self) -> &EditRope

Return a reference to the contents of this buffer.

pub fn get_text(&self) -> String

Return the contents of this buffer as a String.

pub fn set_text<T: Into<EditRope>>(&mut self, t: T)

Replace the contents of this buffer with t.

This also resets buffer-associated state, like marks and history.

pub fn append_text<T: Into<EditRope>>(&mut self, t: T) -> Range<usize>

Append text to this buffer.

pub fn reset(&mut self) -> EditRope

Clear the buffer of its current content, and return it.

This also resets buffer-associated state, like marks and history.

pub fn reset_text(&mut self) -> String

Clear the buffer of its current content, and return it as a String.

This also resets buffer-associated state, like marks and history.

pub fn get_completions(&self, gid: CursorGroupId) -> Option<CompletionList>

Get completion candidates for the give cursor group to show the user.

pub fn get_cursor_word( &self, gid: CursorGroupId, style: &WordStyle ) -> Option<String>

Returns the text currently that the cursor group’s leader is currently positioned over.

pub fn get_selected_word(&self, gid: CursorGroupId) -> Option<String>

Returns the text currently selected by the cursor group’s leader.

pub fn set_group(&mut self, gid: CursorGroupId, group: CursorGroup)

Set the leader and member of a cursor group.

pub fn set_leader(&mut self, id: CursorGroupId, cursor: Cursor)

Move the Cursor for the leader of a cursor group.

pub fn get_leader(&mut self, id: CursorGroupId) -> Cursor

Get the Cursor for the leader of a cursor group.

pub fn get_followers(&self, id: CursorGroupId) -> Vec<Cursor>

Get the cursors of the followers within a cursor group.

pub fn get_follower_selections(&self, id: CursorGroupId) -> Option<Selections>

Get the Selections for the followers within a cursor group.

pub fn get_leader_selection(&mut self, id: CursorGroupId) -> Option<Selection>

Get the Selection for the leader of a cursor group.

pub fn get_group_selections(&self, id: CursorGroupId) -> Option<Selections>

Get the Selections for everyone within a cursor group.

pub fn create_group(&mut self) -> CursorGroupId

Create a new cursor group.

pub fn lines(&self, line: usize) -> LineIterator<'_>

Iterate over the lines in the buffer starting at line.

pub fn lines_at(&self, line: usize, column: usize) -> LineIterator<'_>

Iterate over the lines in the buffer starting at column within line.

pub fn get_lines(&self) -> usize

Returns how many lines are within this buffer.

pub fn get_columns(&self, y: usize) -> usize

Returns how many columns are on a given line.

pub fn get_line_info<T: Send + Sync + 'static>(&self, line: usize) -> Option<&T>

Fetch a reference to the information of type T on a given line.

pub fn get_line_info_mut<T: Send + Sync + 'static>( &mut self, line: usize ) -> Option<&mut T>

Fetch a mutable reference to the information of type T on a given line.

pub fn set_line_info<T: Send + Sync + 'static>(&mut self, line: usize, info: T)

Update the information of type T on a given line.

pub fn clamp_state( &self, state: &mut CursorState, ctx: &(CursorGroupId, &'_ ViewportContext<Cursor>, &'_ EditContext) )

Clamp the line and column of the cursors in a CursorState so that they refer to a valid point within the buffer.

pub fn clamp( &self, cursor: &mut Cursor, ctx: &(CursorGroupId, &'_ ViewportContext<Cursor>, &'_ EditContext) )

Clamp the line and column of a cursor so that it refers to a valid point within the buffer.

pub fn selection_intervals(&self, gid: CursorGroupId) -> HighlightInfo

Returns an IntervalTree containing the selections for a cursor group.

pub fn follower_intervals(&self, gid: CursorGroupId) -> FollowersInfo

Returns an IntervalTree containing the followers of a cursor group.

Trait Implementations

impl<'a, I> Editable<(CursorGroupId, &'a ViewportContext<Cursor>, &'a EditContext), Store<I>, I> for EditBuffer<I>

where I: ApplicationInfo,

fn editor_command( &mut self, act: &EditorAction, ctx: &(CursorGroupId, &'a ViewportContext<Cursor>, &'a EditContext), store: &mut Store<I> ) -> EditResult<EditInfo, I>

Execute an editor action.

impl<'a, I> EditorActions<(CursorGroupId, &'a ViewportContext<Cursor>, &'a EditContext), Store<I>, I> for EditBuffer<I>

where I: ApplicationInfo,

fn edit( &mut self, action: &EditAction, target: &EditTarget, ictx: &(CursorGroupId, &'a ViewportContext<Cursor>, &'a EditContext), store: &mut Store<I> ) -> EditResult<EditInfo, I>

Perform an editing operation over the targeted text.

fn mark( &mut self, name: Mark, ctx: &(CursorGroupId, &'a ViewportContext<Cursor>, &'a EditContext), store: &mut Store<I> ) -> EditResult<EditInfo, I>

Create or update a cursor mark based on the leader’s cursor position.

fn complete( &mut self, comptype: &CompletionType, selection: &CompletionSelection, display: &CompletionDisplay, ctx: &(CursorGroupId, &'a ViewportContext<Cursor>, &'a EditContext), store: &mut Store<I> ) -> EditResult<EditInfo, I>

Complete the text before the cursor group leader.

fn insert_text( &mut self, act: &InsertTextAction, ctx: &(CursorGroupId, &'a ViewportContext<Cursor>, &'a EditContext), store: &mut Store<I> ) -> EditResult<EditInfo, I>

Insert text relative to the current cursor position.

fn selection_command( &mut self, act: &SelectionAction, ctx: &(CursorGroupId, &'a ViewportContext<Cursor>, &'a EditContext), store: &mut Store<I> ) -> EditResult<EditInfo, I>

Modify the current selection.

fn cursor_command( &mut self, act: &CursorAction, ctx: &(CursorGroupId, &'a ViewportContext<Cursor>, &'a EditContext), store: &mut Store<I> ) -> EditResult<EditInfo, I>

Perform an action over a cursor group.

fn history_command( &mut self, act: &HistoryAction, ctx: &(CursorGroupId, &'a ViewportContext<Cursor>, &'a EditContext), store: &mut Store<I> ) -> EditResult<EditInfo, I>

Move to a different point in the buffer’s editing history.

impl<'a, I> Jumpable<(CursorGroupId, &'a ViewportContext<Cursor>, &'a EditContext), I> for EditBuffer<I>

where I: ApplicationInfo,

fn jump( &mut self, list: PositionList, dir: MoveDir1D, count: usize, ctx: &(CursorGroupId, &'a ViewportContext<Cursor>, &'a EditContext) ) -> UIResult<usize, I>

Move through a PositionList in MoveDir1D direction count times.

impl<'a, I> Searchable<(CursorGroupId, &'a ViewportContext<Cursor>, &'a EditContext), Store<I>, I> for EditBuffer<I>

where I: ApplicationInfo,

fn search( &mut self, dir: MoveDirMod, count: Count, ctx: &(CursorGroupId, &'a ViewportContext<Cursor>, &'a EditContext), store: &mut Store<I> ) -> UIResult<EditInfo, I>

Search for the n^th result in MoveDirMod direction.