Struct Zle 

pub struct Zle {

    pub zleline: Vec<char>,
    pub zlecs: usize,
    pub zlell: usize,
    pub mark: usize,
    pub insmode: bool,
    pub done: bool,
    pub lastchar: i32,
    pub lastchar_wide: i32,
    pub lastchar_wide_valid: bool,
    pub lbindk: Option<Thingy>,
    pub bindk: Option<Thingy>,
    pub lastcmd: WidgetFlags,
    pub zmod: Modifier,
    pub prefixflag: bool,
    pub zle_recursive: i32,
    pub zlereadflags: ZleReadFlags,
    pub zlecontext: ZleContext,
    pub statusline: Option<String>,
    pub stackhist: i32,
    pub stackcs: usize,
    pub vistartchange: u64,
    pub undo_stack: Vec<Change>,
    pub changeno: u64,
    pub keytimeout: u64,
    pub watch_fds: Vec<WatchFd>,
    pub keymaps: KeymapManager,
    pub compwidget: Option<Widget>,
    pub incompctlfunc: bool,
    pub hascompmod: bool,
    pub resetneeded: bool,
    pub vibuf: [Vec<char>; 36],
    pub killring: VecDeque<Vec<char>>,
    pub killringmax: usize,
    pub yanklast: bool,
    pub neg_arg: bool,
    pub mult: i32,
    /* private fields */
}

The main ZLE state

Fields

zleline: Vec<char>

The input line assembled so far

zlecs: usize

Cursor position

zlell: usize

Line length

mark: usize

Mark position

insmode: bool

Insert mode (true) or overwrite mode (false)

done: bool

Done editing flag

lastchar: i32

Last character pressed

lastchar_wide: i32

Last character as wide char (always used in Rust)

lastchar_wide_valid: bool

Whether lastchar_wide is valid

lbindk: Option<Thingy>

Binding for the previous key

bindk: Option<Thingy>

Binding for this key

lastcmd: WidgetFlags

Flags associated with last command

zmod: Modifier

Current modifier status

prefixflag: bool

Prefix command flag

zle_recursive: i32

Recursive edit depth

zlereadflags: ZleReadFlags

Read flags

zlecontext: ZleContext

Context

statusline: Option<String>

Status line

stackhist: i32

History position for buffer stack

stackcs: usize

Cursor position for buffer stack

vistartchange: u64

Vi start change position in undo stack

undo_stack: Vec<Change>

Undo stack

changeno: u64

Current change number

keytimeout: u64

Key timeout in 100ths of a second

watch_fds: Vec<WatchFd>

Watch file descriptors

keymaps: KeymapManager

Keymap manager

compwidget: Option<Widget>

Completion widget

incompctlfunc: bool

In completion function flag

hascompmod: bool

Completion module loaded flag

resetneeded: bool

Needs refresh

vibuf: [Vec<char>; 36]

Vi cut buffers (0-35: 0-9, a-z)

killring: VecDeque<Vec<char>>

Kill ring

killringmax: usize

Kill ring max size

yanklast: bool

Last command was a yank (for yank-pop)

neg_arg: bool

Negative argument flag

mult: i32

Multiplier for commands

Implementations

impl Zle

pub fn init_history(&mut self, max_size: usize)

Initialize history for ZLE

pub fn history_up(&mut self, hist: &mut History)

Go to previous history entry

pub fn history_down(&mut self, hist: &mut History)

Go to next history entry

pub fn history_isearch_backward(&mut self, hist: &mut History)

Incremental search backward

pub fn history_isearch_forward(&mut self, hist: &mut History)

Incremental search forward

pub fn history_search_prefix(&mut self, hist: &mut History)

Search history for prefix

pub fn beginning_of_history(&mut self, hist: &mut History)

Beginning of history - go to first entry Port of beginningofhistory() from zle_hist.c

pub fn end_of_history(&mut self, hist: &mut History)

End of history - go to last entry (current line) Port of endofhistory() from zle_hist.c

pub fn up_line_or_history(&mut self, hist: &mut History)

Up line or history - move up in multi-line buffer or go to previous history Port of uplineorhistory() from zle_hist.c

pub fn down_line_or_history(&mut self, hist: &mut History)

Down line or history - move down in multi-line buffer or go to next history Port of downlineorhistory() from zle_hist.c

pub fn history_search_backward(&mut self, hist: &mut History)

History search backward - search for entries starting with current prefix Port of historysearchbackward() from zle_hist.c

pub fn history_search_forward(&mut self, hist: &mut History)

History search forward - search for entries starting with current prefix Port of historysearchforward() from zle_hist.c

pub fn insert_last_word(&mut self, hist: &History)

Insert last word from previous history entry Port of insertlastword() from zle_hist.c

pub fn push_line(&mut self)

Push current line to buffer stack Port of pushline() from zle_hist.c

pub fn accept_line_and_down_history( &mut self, hist: &mut History, ) -> Option<String>

Accept line and go to next history (for walking through history executing each) Port of acceptlineanddownhistory() from zle_hist.c

pub fn vi_fetch_history(&mut self, hist: &mut History, num: usize)

Vi fetch history - go to specific history entry by number Port of vifetchhistory() from zle_hist.c

pub fn vi_history_search_backward(&mut self, hist: &mut History, pattern: &str)

Vi history search backward Port of vihistorysearchbackward() from zle_hist.c

pub fn vi_history_search_forward(&mut self, hist: &mut History, pattern: &str)

Vi history search forward Port of vihistorysearchforward() from zle_hist.c

pub fn vi_repeat_search(&mut self, hist: &mut History)

Vi repeat search Port of virepeatsearch() from zle_hist.c

pub fn vi_rev_repeat_search(&mut self, hist: &mut History)

Vi reverse repeat search Port of virevrepeatsearch() from zle_hist.c

pub fn set_local_history(&mut self, _local: bool)

Set local history mode Port of setlocalhistory() from zle_hist.c

pub fn remember_edits(&mut self, hist: &mut History)

Remember current line edits for history navigation Port of remember_edits() from zle_hist.c

pub fn forget_edits(&mut self, _hist: &mut History)

Forget remembered edits Port of forget_edits() from zle_hist.c

impl Zle

pub fn new() -> Zle

pub fn zsetterm(&mut self) -> Result<(), Error>

Set up terminal for ZLE

pub fn ungetbyte(&mut self, ch: u8)

Unget a byte back to the input buffer

pub fn ungetbytes(&mut self, s: &[u8])

Unget multiple bytes

pub fn raw_getbyte(&mut self, do_keytmout: bool) -> Option<u8>

Read a raw byte from input with optional timeout

pub fn getbyte(&mut self, do_keytmout: bool) -> Option<u8>

Get a byte from input, handling timeout

pub fn getfullchar(&mut self, do_keytmout: bool) -> Option<char>

Get a full (possibly wide) character - always returns char in Rust

pub fn redrawhook(&mut self)

Redraw hook

pub fn zlecore(&mut self)

Core ZLE loop

pub fn zleread( &mut self, lprompt: &str, rprompt: &str, flags: ZleReadFlags, context: ZleContext, ) -> Result<String, Error>

Main entry point for line reading

pub fn initmodifier(&mut self)

Initialize ZLE modifiers

pub fn handleprefixes(&mut self)

Handle prefix commands

pub fn trashzle(&mut self)

Trash the ZLE display

pub fn resetprompt(&mut self)

Reset prompt

pub fn reexpandprompt(&mut self)

Re-expand prompt

pub fn recursive_edit(&mut self) -> i32

Recursive edit

pub fn finish_line(&mut self)

Mark line as done (accept)

pub fn abort_line(&mut self)

Abort input

impl Zle

pub fn save_keymap(&mut self) -> SavedKeymap

Save current keymap state Port of savekeymap() from zle_main.c

pub fn restore_keymap(&mut self, saved: SavedKeymap)

Restore keymap state Port of restorekeymap() from zle_main.c

pub fn describe_key_briefly(&mut self)

Describe key briefly Port of describekeybriefly() from zle_main.c

pub fn whereis(&self, widget_name: &str) -> Vec<String>

Where is command Port of whereis() from zle_main.c

pub fn exec_immortal(&mut self, name: &str) -> bool

Execute an immortal (built-in) function Port of execimmortal() from zle_main.c

pub fn exec_zle_func(&mut self, name: &str, _args: &[String]) -> i32

Execute a ZLE function by name Port of execzlefunc() from zle_main.c

pub fn break_read(&mut self)

Break read (for signals) Port of breakread() from zle_main.c

pub fn before_trap(&mut self)

Handle before trap Port of zlebeforetrap() from zle_main.c

pub fn after_trap(&mut self)

Handle after trap Port of zleaftertrap() from zle_main.c

pub fn zle_reset_prompt(&mut self)

ZLE reset prompt Port of zle_resetprompt() from zle_main.c

pub fn prompt(&self) -> &str

The prompt string

pub fn set_prompt(&mut self, prompt: &str)

Set prompt

pub fn get_mult(&self) -> i32

Get repeat count

pub fn toggle_neg_arg(&mut self)

Toggle negative argument flag

pub fn is_neg(&self) -> bool

Check if negative argument

pub fn is_vicmd(&self) -> bool

Vi command mode flag

pub fn is_viins(&self) -> bool

Vi insert mode flag

pub fn is_emacs(&self) -> bool

Emacs mode flag

pub fn was_yank(&self) -> bool

Check if last command was yank

impl Zle

pub fn self_insert(&mut self, c: char)

Self insert - insert the typed character Port of selfinsert() from zle_misc.c

pub fn self_insert_unmeta(&mut self, c: char)

Self insert unmeta - insert character with meta bit stripped Port of selfinsertunmeta() from zle_misc.c

pub fn accept_line(&self) -> String

Accept line - return the current line for execution Port of acceptline() from zle_misc.c

pub fn accept_and_hold(&self) -> String

Accept and hold - accept line but keep it in the buffer Port of acceptandhold() from zle_misc.c

pub fn quoted_insert(&mut self, c: char)

Quoted insert - insert next char literally Port of quotedinsert() from zle_misc.c

pub fn bracketed_paste(&mut self, text: &str)

Bracketed paste - handle paste mode Port of bracketedpaste() from zle_misc.c

pub fn delete_char(&mut self)

Delete char under cursor Port of deletechar() from zle_misc.c

pub fn backward_delete_char(&mut self)

Delete char before cursor Port of backwarddeletechar() from zle_misc.c

pub fn kill_line(&mut self)

Kill from cursor to end of line Port of killline() from zle_misc.c

pub fn backward_kill_line(&mut self)

Kill from beginning of line to cursor Port of backwardkillline() from zle_misc.c

pub fn kill_buffer(&mut self)

Kill entire buffer Port of killbuffer() from zle_misc.c

pub fn kill_whole_line(&mut self)

Kill whole line (including newlines in multi-line mode) Port of killwholeline() from zle_misc.c

pub fn exchange_point_and_mark(&mut self)

Exchange point and mark

pub fn set_mark_here(&mut self)

Set mark at current position

pub fn copy_region_as_kill(&mut self)

Copy region as kill Port of copyregionaskill() from zle_misc.c

pub fn kill_region(&mut self)

Kill region (between point and mark) Port of killregion() from zle_misc.c

pub fn yank(&mut self)

Yank - insert from kill ring Port of yank() from zle_misc.c

pub fn yank_pop(&mut self)

Yank pop - cycle through kill ring Port of yankpop() from zle_misc.c

pub fn transpose_chars(&mut self)

Transpose chars Port of transposechars() from zle_misc.c

pub fn capitalize_word(&mut self)

Capitalize word

pub fn downcase_word(&mut self)

Downcase word

pub fn upcase_word(&mut self)

Upcase word

pub fn transpose_words(&mut self)

Transpose words Port of transpose words logic

pub fn quote_line(&mut self)

Quote line Port of quoteline() from zle_misc.c

pub fn quote_region(&mut self)

Quote region Port of quoteregion() from zle_misc.c

pub fn what_cursor_position(&self) -> String

What cursor position - display cursor info Port of whatcursorposition() from zle_misc.c

pub fn universal_argument(&mut self)

Universal argument - multiply next command Port of universalargument() from zle_misc.c

pub fn digit_argument(&mut self, digit: u8)

Digit argument - accumulate numeric argument Port of digitargument() from zle_misc.c

pub fn neg_argument(&mut self)

Negative argument Port of negargument() from zle_misc.c

pub fn undefined_key(&self)

Undefined key - beep Port of undefinedkey() from zle_misc.c

pub fn send_break(&mut self)

Send break - abort current operation Port of sendbreak() from zle_misc.c

pub fn vi_put_after(&mut self)

Vi put after cursor Port of viputafter() from zle_misc.c

pub fn vi_put_before(&mut self)

Vi put before cursor Port of viputbefore() from zle_misc.c

pub fn overwrite_mode(&mut self)

Overwrite mode toggle Port of overwritemode() from zle_misc.c

pub fn copy_prev_word(&mut self)

Copy previous word Port of copyprevword() from zle_misc.c

pub fn copy_prev_shell_word(&mut self)

Copy previous shell word (respects quoting) Port of copyprevshellword() from zle_misc.c

pub fn pound_insert(&mut self)

Pound insert - comment toggle for vi mode Port of poundinsert() from zle_misc.c

impl Zle

pub fn move_to_bol(&mut self)

Move cursor to start of current physical line

pub fn move_to_eol(&mut self)

Move cursor to end of current physical line

pub fn move_up(&mut self) -> bool

Move cursor up one line

pub fn move_down(&mut self) -> bool

Move cursor down one line

pub fn current_column(&self) -> usize

Get current column (0-indexed)

pub fn current_line(&self) -> usize

Get current line number (0-indexed)

pub fn count_lines(&self) -> usize

Count total lines

impl Zle

pub fn get_buffer(&self) -> String

Get BUFFER parameter

pub fn set_buffer(&mut self, s: &str)

Set BUFFER parameter

pub fn get_cursor(&self) -> usize

Get CURSOR parameter

pub fn set_cursor(&mut self, pos: usize)

Set CURSOR parameter

pub fn get_lbuffer(&self) -> String

Get LBUFFER (text before cursor)

pub fn set_lbuffer(&mut self, s: &str)

Set LBUFFER

pub fn get_rbuffer(&self) -> String

Get RBUFFER (text after cursor)

pub fn set_rbuffer(&mut self, s: &str)

Set RBUFFER

pub fn get_cutbuffer(&self) -> String

Get CUTBUFFER (kill ring top)

pub fn set_cutbuffer(&mut self, s: &str)

Set CUTBUFFER

pub fn get_mark(&self) -> usize

Get MARK parameter

pub fn set_mark(&mut self, pos: usize)

Set MARK parameter

pub fn get_bufferlines(&self) -> usize

Get BUFFERLINES (number of lines)

pub fn get_pending(&self) -> usize

Get PENDING (number of bytes waiting)

pub fn get_keymap(&self) -> &str

Get current keymap name

pub fn get_numeric(&self) -> Option<i32>

Get NUMERIC (numeric argument if set)

pub fn is_insert_mode(&self) -> bool

Check if in insert mode

pub fn is_region_active(&self) -> bool

Check if region is active

pub fn get_zle_state(&self) -> String

Get ZLE_STATE string

impl Zle

pub fn zrefresh(&mut self)

Main refresh function - redraws the screen Port of zrefresh() from zle_refresh.c

pub fn full_refresh(&mut self) -> Result<(), Error>

Full screen refresh - clears and redraws everything

pub fn partial_refresh(&mut self) -> Result<(), Error>

Partial refresh (optimize for minimal updates)

pub fn clearscreen(&mut self)

Clear the screen Port of clearscreen() from zle_refresh.c

pub fn redisplay(&mut self)

Redisplay the current line Port of redisplay() from zle_refresh.c

pub fn moveto(&mut self, row: usize, col: usize)

Move cursor to position Port of moveto() from zle_refresh.c

pub fn tc_downcurs(&mut self, count: usize)

Move cursor down Port of tc_downcurs() from zle_refresh.c

pub fn tc_rightcurs(&mut self, count: usize)

Move cursor right Port of tc_rightcurs() from zle_refresh.c

pub fn scrollwindow(&mut self, lines: i32)

Scroll window up Port of scrollwindow() from zle_refresh.c

pub fn singlerefresh(&mut self)

Single line refresh Port of singlerefresh() from zle_refresh.c

pub fn refreshline(&mut self, _line: usize)

Refresh a single line Port of refreshline() from zle_refresh.c

pub fn zwcputc(&self, c: char)

Write a wide character Port of zwcputc() from zle_refresh.c

pub fn zwcwrite(&self, s: &str)

Write a string of wide characters Port of zwcwrite() from zle_refresh.c

impl Zle

pub fn select_text_object( &self, obj_type: TextObjectType, kind: TextObjectKind, ) -> Option<TextObject>

Select a text object

impl Zle

pub fn complete_word(&mut self, state: &mut CompletionState)

Complete word - trigger completion Port of completeword() from zle_tricky.c

pub fn menu_complete(&mut self, state: &mut CompletionState)

Menu complete - cycle through completions Port of menucomplete() from zle_tricky.c

pub fn reverse_menu_complete(&mut self, state: &mut CompletionState)

Reverse menu complete - cycle backwards Port of reversemenucomplete() from zle_tricky.c

pub fn expand_or_complete(&mut self, state: &mut CompletionState)

Expand or complete - try expansion first, then completion Port of expandorcomplete() from zle_tricky.c

pub fn expand_or_complete_prefix(&mut self, state: &mut CompletionState)

Expand or complete prefix - expand/complete keeping suffix Port of expandorcompleteprefix() from zle_tricky.c

pub fn list_choices(&mut self, state: &mut CompletionState)

List choices - show available completions Port of listchoices() from zle_tricky.c

pub fn list_expand(&mut self)

List expand - list possible expansions Port of listexpand() from zle_tricky.c

pub fn expand_word(&mut self)

Expand word - expand current word (glob, history, etc) Port of expandword() from zle_tricky.c

pub fn expand_history(&mut self)

Expand history - expand history references Port of expandhistory() / doexpandhist() from zle_tricky.c

pub fn magic_space(&mut self)

Magic space - expand history then insert space Port of magicspace() from zle_tricky.c

pub fn delete_char_or_list(&mut self, state: &mut CompletionState)

Delete char or list - delete if there’s text, else list completions Port of deletecharorlist() from zle_tricky.c

pub fn accept_and_menu_complete( &mut self, state: &mut CompletionState, ) -> Option<String>

Accept and menu complete Port of acceptandmenucomplete() from zle_tricky.c

pub fn spell_word(&mut self)

Spell word - check spelling Port of spellword() from zle_tricky.c

impl Zle

pub fn insert_str(&mut self, s: &str)

Insert string at cursor position

pub fn insert_chars(&mut self, chars: &[char])

Insert chars at cursor position

pub fn delete_chars(&mut self, n: usize)

Delete n characters at cursor position

pub fn backspace_chars(&mut self, n: usize)

Delete n characters before cursor

pub fn get_line(&self) -> String

Get the line as a string

pub fn set_line(&mut self, s: &str)

Set the line from a string

pub fn clear_line(&mut self)

Clear the line

pub fn get_region(&self) -> &[char]

Get region between point and mark

pub fn cut_to_buffer(&mut self, buf: usize, append: bool)

Cut to named buffer

pub fn paste_from_buffer(&mut self, buf: usize, after: bool)

Paste from named buffer

impl Zle

pub fn find_bol(&self, pos: usize) -> usize

Find beginning of line from position Port of findbol() from zle_utils.c

pub fn find_eol(&self, pos: usize) -> usize

Find end of line from position Port of findeol() from zle_utils.c

pub fn find_line(&self, pos: usize) -> usize

Find line number for position Port of findline() from zle_utils.c

pub fn size_line(&mut self, needed: usize)

Ensure line has enough space Port of sizeline() from zle_utils.c

pub fn space_in_line(&mut self, pos: usize, count: usize)

Make space in line at position Port of spaceinline() from zle_utils.c

pub fn shift_chars(&mut self, from: usize, count: i32)

Shift characters in line Port of shiftchars() from zle_utils.c

pub fn fore_del(&mut self, count: usize, flags: CutFlags)

Delete forward Port of foredel() from zle_utils.c

pub fn back_del(&mut self, count: usize, flags: CutFlags)

Delete backward Port of backdel() from zle_utils.c

pub fn fore_kill(&mut self, count: usize, append: bool)

Kill forward Port of forekill() from zle_utils.c

pub fn back_kill(&mut self, count: usize, append: bool)

Kill backward Port of backkill() from zle_utils.c

pub fn cut_text(&mut self, start: usize, end: usize, dir: CutDirection)

Cut text to buffer Port of cut() / cuttext() from zle_utils.c

pub fn set_last_line(&mut self)

Set the last line (for history) Port of setlastline() from zle_utils.c

pub fn show_msg(&self, msg: &str)

Show a message Port of showmsg() from zle_utils.c

pub fn handle_feep(&self)

Handle a feep (beep/error) Port of handlefeep() from zle_utils.c

pub fn add_to_line(&mut self, pos: usize, text: &str)

Add text to line at position Port of zleaddtoline() from zle_utils.c

pub fn line_as_string(&self) -> String

Get line as string Port of zlelineasstring() from zle_utils.c

pub fn string_as_line(&mut self, s: &str)

Set line from string Port of stringaszleline() from zle_utils.c

pub fn get_zle_line(&self) -> &[char]

Get ZLE line Port of zlegetline() from zle_utils.c

pub fn get_zle_query(&self) -> Option<String>

Get ZLE query (for menu selection etc) Port of getzlequery() from zle_utils.c

pub fn handle_suffix(&mut self)

Handle suffix (for completion) Port of handlesuffix() from zle_utils.c

impl Zle

Position save/restore Port of zle_save_positions() / zle_restore_positions() from zle_utils.c

pub fn save_positions(&self) -> SavedPositions

pub fn restore_positions(&mut self, saved: &SavedPositions)

impl Zle

pub fn vi_get_arg(&self) -> i32

Get numeric argument (mult)

pub fn vi_find_char(&mut self, forward: bool, skip: bool)

Handle vi find character (f/F/t/T)

pub fn vi_match_bracket(&mut self)

Vi percent match (find matching bracket)

pub fn vi_replace_mode(&mut self)

Vi replace mode (R command)

pub fn vi_swap_case(&mut self)

Vi swap case

pub fn vi_undo(&mut self)

Vi undo (u command)

pub fn vi_visual_mode(&mut self)

Vi visual mode

pub fn vi_visual_line_mode(&mut self)

Vi visual line mode

pub fn vi_visual_block_mode(&mut self)

Vi visual block mode

pub fn vi_set_mark(&mut self, name: char)

Vi set mark

pub fn vi_goto_mark(&mut self, name: char)

Vi goto mark

pub fn vi_record_change(&mut self, key: u8)

Record keys for vi repeat

pub fn vi_repeat_change(&mut self)

Replay last change (dot command)

impl Zle

pub fn find_word_start(&self, style: WordStyle) -> usize

Find the start of the current/previous word

pub fn find_word_end(&self, style: WordStyle) -> usize

Find the end of the current/next word

pub fn get_current_word(&self, style: WordStyle) -> &[char]

Get the current word

Trait Implementations

impl Default for Zle

fn default() -> Zle

Returns the “default value” for a type.