rustyline/
config.rs

1//! Customize line editor
2use crate::Result;
3use std::default::Default;
4
5/// User preferences
6#[derive(Clone, Copy, Debug, PartialEq, Eq)]
7pub struct Config {
8    /// Maximum number of entries in History.
9    max_history_size: usize, // history_max_entries
10    history_duplicates: HistoryDuplicates,
11    history_ignore_space: bool,
12    completion_type: CompletionType,
13    /// When listing completion alternatives, only display
14    /// one screen of possibilities at a time.
15    completion_prompt_limit: usize,
16    /// Duration (milliseconds) Rustyline will wait for a character when
17    /// reading an ambiguous key sequence.
18    keyseq_timeout: Option<u16>,
19    /// Emacs or Vi mode
20    edit_mode: EditMode,
21    /// If true, each nonblank line returned by `readline` will be
22    /// automatically added to the history.
23    auto_add_history: bool,
24    /// Beep or Flash or nothing
25    bell_style: BellStyle,
26    /// if colors should be enabled.
27    color_mode: ColorMode,
28    /// Whether to use stdio or not
29    behavior: Behavior,
30    /// Horizontal space taken by a tab.
31    tab_stop: usize,
32    /// Indentation size for indent/dedent commands
33    indent_size: usize,
34    /// Check if cursor position is at leftmost before displaying prompt
35    check_cursor_position: bool,
36    /// Bracketed paste on unix platform
37    enable_bracketed_paste: bool,
38    /// Whether to disable or not the signals in termios
39    enable_signals: bool,
40}
41
42impl Config {
43    /// Returns a `Config` builder.
44    #[must_use]
45    pub fn builder() -> Builder {
46        Builder::new()
47    }
48
49    /// Tell the maximum length (i.e. number of entries) for the history.
50    #[must_use]
51    pub fn max_history_size(&self) -> usize {
52        self.max_history_size
53    }
54
55    pub(crate) fn set_max_history_size(&mut self, max_size: usize) {
56        self.max_history_size = max_size;
57    }
58
59    /// Tell if lines which match the previous history entry are saved or not
60    /// in the history list.
61    ///
62    /// By default, they are ignored.
63    #[must_use]
64    pub fn history_duplicates(&self) -> HistoryDuplicates {
65        self.history_duplicates
66    }
67
68    pub(crate) fn set_history_ignore_dups(&mut self, yes: bool) {
69        self.history_duplicates = if yes {
70            HistoryDuplicates::IgnoreConsecutive
71        } else {
72            HistoryDuplicates::AlwaysAdd
73        };
74    }
75
76    /// Tell if lines which begin with a space character are saved or not in
77    /// the history list.
78    ///
79    /// By default, they are saved.
80    #[must_use]
81    pub fn history_ignore_space(&self) -> bool {
82        self.history_ignore_space
83    }
84
85    pub(crate) fn set_history_ignore_space(&mut self, yes: bool) {
86        self.history_ignore_space = yes;
87    }
88
89    /// Completion behaviour.
90    ///
91    /// By default, `CompletionType::Circular`.
92    #[must_use]
93    pub fn completion_type(&self) -> CompletionType {
94        self.completion_type
95    }
96
97    /// When listing completion alternatives, only display
98    /// one screen of possibilities at a time (used for `CompletionType::List`
99    /// mode).
100    #[must_use]
101    pub fn completion_prompt_limit(&self) -> usize {
102        self.completion_prompt_limit
103    }
104
105    /// Duration (milliseconds) Rustyline will wait for a character when
106    /// reading an ambiguous key sequence (used for `EditMode::Vi` mode on unix
107    /// platform).
108    ///
109    /// By default, no timeout (-1) or 500ms if `EditMode::Vi` is activated.
110    #[must_use]
111    pub fn keyseq_timeout(&self) -> Option<u16> {
112        self.keyseq_timeout
113    }
114
115    /// Emacs or Vi mode
116    #[must_use]
117    pub fn edit_mode(&self) -> EditMode {
118        self.edit_mode
119    }
120
121    /// Tell if lines are automatically added to the history.
122    ///
123    /// By default, they are not.
124    #[must_use]
125    pub fn auto_add_history(&self) -> bool {
126        self.auto_add_history
127    }
128
129    /// Bell style: beep, flash or nothing.
130    #[must_use]
131    pub fn bell_style(&self) -> BellStyle {
132        self.bell_style
133    }
134
135    /// Tell if colors should be enabled.
136    ///
137    /// By default, they are except if stdout is not a TTY.
138    #[must_use]
139    pub fn color_mode(&self) -> ColorMode {
140        self.color_mode
141    }
142
143    pub(crate) fn set_color_mode(&mut self, color_mode: ColorMode) {
144        self.color_mode = color_mode;
145    }
146
147    /// Whether to use stdio or not
148    ///
149    /// By default, stdio is used.
150    #[must_use]
151    pub fn behavior(&self) -> Behavior {
152        self.behavior
153    }
154
155    pub(crate) fn set_behavior(&mut self, behavior: Behavior) {
156        self.behavior = behavior;
157    }
158
159    /// Horizontal space taken by a tab.
160    ///
161    /// By default, 8.
162    #[must_use]
163    pub fn tab_stop(&self) -> usize {
164        self.tab_stop
165    }
166
167    pub(crate) fn set_tab_stop(&mut self, tab_stop: usize) {
168        self.tab_stop = tab_stop;
169    }
170
171    /// Check if cursor position is at leftmost before displaying prompt.
172    ///
173    /// By default, we don't check.
174    #[must_use]
175    pub fn check_cursor_position(&self) -> bool {
176        self.check_cursor_position
177    }
178
179    /// Indentation size used by indentation commands
180    ///
181    /// By default, 2.
182    #[must_use]
183    pub fn indent_size(&self) -> usize {
184        self.indent_size
185    }
186
187    pub(crate) fn set_indent_size(&mut self, indent_size: usize) {
188        self.indent_size = indent_size;
189    }
190
191    /// Bracketed paste on unix platform
192    ///
193    /// By default, it's enabled.
194    #[must_use]
195    pub fn enable_bracketed_paste(&self) -> bool {
196        self.enable_bracketed_paste
197    }
198
199    /// Enable or disable signals in termios
200    ///
201    /// By default, it's disabled.
202    #[must_use]
203    pub fn enable_signals(&self) -> bool {
204        self.enable_signals
205    }
206
207    pub(crate) fn set_enable_signals(&mut self, enable_signals: bool) {
208        self.enable_signals = enable_signals;
209    }
210}
211
212impl Default for Config {
213    fn default() -> Self {
214        Self {
215            max_history_size: 100,
216            history_duplicates: HistoryDuplicates::IgnoreConsecutive,
217            history_ignore_space: false,
218            completion_type: CompletionType::Circular, // TODO Validate
219            completion_prompt_limit: 100,
220            keyseq_timeout: None,
221            edit_mode: EditMode::Emacs,
222            auto_add_history: false,
223            bell_style: BellStyle::default(),
224            color_mode: ColorMode::Enabled,
225            behavior: Behavior::default(),
226            tab_stop: 8,
227            indent_size: 2,
228            check_cursor_position: false,
229            enable_bracketed_paste: true,
230            enable_signals: false,
231        }
232    }
233}
234
235/// Beep or flash or nothing
236#[derive(Clone, Copy, Debug, PartialEq, Eq)]
237pub enum BellStyle {
238    /// Beep
239    Audible,
240    /// Silent
241    None,
242    /// Flash screen (not supported)
243    Visible,
244}
245
246/// `Audible` by default on unix (overridden by current Terminal settings).
247/// `None` on windows.
248impl Default for BellStyle {
249    #[cfg(any(windows, target_arch = "wasm32"))]
250    fn default() -> Self {
251        Self::None
252    }
253
254    #[cfg(unix)]
255    fn default() -> Self {
256        Self::Audible
257    }
258}
259
260/// History filter
261#[derive(Clone, Copy, Debug, PartialEq, Eq)]
262pub enum HistoryDuplicates {
263    /// No filter
264    AlwaysAdd,
265    /// a line will not be added to the history if it matches the previous entry
266    IgnoreConsecutive,
267}
268
269/// Tab completion style
270#[derive(Clone, Copy, Debug, PartialEq, Eq)]
271#[non_exhaustive]
272pub enum CompletionType {
273    /// Complete the next full match (like in Vim by default)
274    Circular,
275    /// Complete till longest match.
276    /// When more than one match, list all matches
277    /// (like in Bash/Readline).
278    List,
279
280    /// Complete the match using fuzzy search and selection
281    /// (like fzf and plugins)
282    /// Currently only available for unix platforms as dependency on
283    /// skim->tuikit Compile with `--features=fuzzy` to enable
284    #[cfg(all(unix, feature = "with-fuzzy"))]
285    Fuzzy,
286}
287
288/// Style of editing / Standard keymaps
289#[derive(Clone, Copy, Debug, PartialEq, Eq)]
290#[non_exhaustive]
291pub enum EditMode {
292    /// Emacs keymap
293    Emacs,
294    /// Vi keymap
295    Vi,
296}
297
298/// Colorization mode
299#[derive(Clone, Copy, Debug, PartialEq, Eq)]
300#[non_exhaustive]
301pub enum ColorMode {
302    /// Activate highlighting if platform/terminal is supported.
303    Enabled,
304    /// Activate highlighting even if platform is not supported (windows < 10).
305    Forced,
306    /// Deactivate highlighting even if platform/terminal is supported.
307    Disabled,
308}
309
310/// Should the editor use stdio
311#[derive(Clone, Copy, Debug, Default, PartialEq, Eq)]
312#[non_exhaustive]
313pub enum Behavior {
314    /// Use stdin / stdout
315    #[default]
316    Stdio,
317    /// Use terminal-style interaction whenever possible, even if 'stdin' and/or
318    /// 'stdout' are not terminals.
319    PreferTerm,
320    // TODO
321    // Use file-style interaction, reading input from the given file.
322    // useFile
323}
324
325/// Configuration builder
326#[derive(Clone, Debug, Default)]
327pub struct Builder {
328    p: Config,
329}
330
331impl Builder {
332    /// Returns a `Config` builder.
333    #[must_use]
334    pub fn new() -> Self {
335        Self {
336            p: Config::default(),
337        }
338    }
339
340    /// Set the maximum length for the history.
341    pub fn max_history_size(mut self, max_size: usize) -> Result<Self> {
342        self.set_max_history_size(max_size)?;
343        Ok(self)
344    }
345
346    /// Tell if lines which match the previous history entry are saved or not
347    /// in the history list.
348    ///
349    /// By default, they are ignored.
350    pub fn history_ignore_dups(mut self, yes: bool) -> Result<Self> {
351        self.set_history_ignore_dups(yes)?;
352        Ok(self)
353    }
354
355    /// Tell if lines which begin with a space character are saved or not in
356    /// the history list.
357    ///
358    /// By default, they are saved.
359    #[must_use]
360    pub fn history_ignore_space(mut self, yes: bool) -> Self {
361        self.set_history_ignore_space(yes);
362        self
363    }
364
365    /// Set `completion_type`.
366    #[must_use]
367    pub fn completion_type(mut self, completion_type: CompletionType) -> Self {
368        self.set_completion_type(completion_type);
369        self
370    }
371
372    /// The number of possible completions that determines when the user is
373    /// asked whether the list of possibilities should be displayed.
374    #[must_use]
375    pub fn completion_prompt_limit(mut self, completion_prompt_limit: usize) -> Self {
376        self.set_completion_prompt_limit(completion_prompt_limit);
377        self
378    }
379
380    /// Timeout for ambiguous key sequences in milliseconds.
381    /// Currently, it is used only to distinguish a single ESC from an ESC
382    /// sequence.
383    /// After seeing an ESC key, wait at most `keyseq_timeout_ms` for another
384    /// byte.
385    #[must_use]
386    pub fn keyseq_timeout(mut self, keyseq_timeout_ms: Option<u16>) -> Self {
387        self.set_keyseq_timeout(keyseq_timeout_ms);
388        self
389    }
390
391    /// Choose between Emacs or Vi mode.
392    #[must_use]
393    pub fn edit_mode(mut self, edit_mode: EditMode) -> Self {
394        self.set_edit_mode(edit_mode);
395        self
396    }
397
398    /// Tell if lines are automatically added to the history.
399    ///
400    /// By default, they are not.
401    #[must_use]
402    pub fn auto_add_history(mut self, yes: bool) -> Self {
403        self.set_auto_add_history(yes);
404        self
405    }
406
407    /// Set bell style: beep, flash or nothing.
408    #[must_use]
409    pub fn bell_style(mut self, bell_style: BellStyle) -> Self {
410        self.set_bell_style(bell_style);
411        self
412    }
413
414    /// Forces colorization on or off.
415    ///
416    /// By default, colorization is on except if stdout is not a TTY.
417    #[must_use]
418    pub fn color_mode(mut self, color_mode: ColorMode) -> Self {
419        self.set_color_mode(color_mode);
420        self
421    }
422
423    /// Whether to use stdio or not
424    ///
425    /// By default, stdio is used.
426    #[must_use]
427    pub fn behavior(mut self, behavior: Behavior) -> Self {
428        self.set_behavior(behavior);
429        self
430    }
431
432    /// Horizontal space taken by a tab.
433    ///
434    /// By default, `8`
435    #[must_use]
436    pub fn tab_stop(mut self, tab_stop: usize) -> Self {
437        self.set_tab_stop(tab_stop);
438        self
439    }
440
441    /// Check if cursor position is at leftmost before displaying prompt.
442    ///
443    /// By default, we don't check.
444    #[must_use]
445    pub fn check_cursor_position(mut self, yes: bool) -> Self {
446        self.set_check_cursor_position(yes);
447        self
448    }
449
450    /// Indentation size
451    ///
452    /// By default, `2`
453    #[must_use]
454    pub fn indent_size(mut self, indent_size: usize) -> Self {
455        self.set_indent_size(indent_size);
456        self
457    }
458
459    /// Enable or disable bracketed paste on unix platform
460    ///
461    /// By default, it's enabled.
462    #[must_use]
463    pub fn bracketed_paste(mut self, enabled: bool) -> Self {
464        self.enable_bracketed_paste(enabled);
465        self
466    }
467
468    /// Enable or disable signals in termios
469    ///
470    /// By default, it's disabled.
471    #[must_use]
472    pub fn enable_signals(mut self, enable_signals: bool) -> Self {
473        self.p.set_enable_signals(enable_signals);
474        self
475    }
476
477    /// Builds a `Config` with the settings specified so far.
478    #[must_use]
479    pub fn build(self) -> Config {
480        self.p
481    }
482}
483
484impl Configurer for Builder {
485    fn config_mut(&mut self) -> &mut Config {
486        &mut self.p
487    }
488}
489
490/// Trait for component that holds a `Config`.
491pub trait Configurer {
492    /// `Config` accessor.
493    fn config_mut(&mut self) -> &mut Config;
494
495    /// Set the maximum length for the history.
496    fn set_max_history_size(&mut self, max_size: usize) -> Result<()> {
497        self.config_mut().set_max_history_size(max_size);
498        Ok(())
499    }
500
501    /// Tell if lines which match the previous history entry are saved or not
502    /// in the history list.
503    ///
504    /// By default, they are ignored.
505    fn set_history_ignore_dups(&mut self, yes: bool) -> Result<()> {
506        self.config_mut().set_history_ignore_dups(yes);
507        Ok(())
508    }
509
510    /// Tell if lines which begin with a space character are saved or not in
511    /// the history list.
512    ///
513    /// By default, they are saved.
514    fn set_history_ignore_space(&mut self, yes: bool) {
515        self.config_mut().set_history_ignore_space(yes);
516    }
517    /// Set `completion_type`.
518    fn set_completion_type(&mut self, completion_type: CompletionType) {
519        self.config_mut().completion_type = completion_type;
520    }
521
522    /// The number of possible completions that determines when the user is
523    /// asked whether the list of possibilities should be displayed.
524    fn set_completion_prompt_limit(&mut self, completion_prompt_limit: usize) {
525        self.config_mut().completion_prompt_limit = completion_prompt_limit;
526    }
527
528    /// Timeout for ambiguous key sequences in milliseconds.
529    fn set_keyseq_timeout(&mut self, keyseq_timeout_ms: Option<u16>) {
530        self.config_mut().keyseq_timeout = keyseq_timeout_ms;
531    }
532
533    /// Choose between Emacs or Vi mode.
534    fn set_edit_mode(&mut self, edit_mode: EditMode) {
535        self.config_mut().edit_mode = edit_mode;
536        match edit_mode {
537            EditMode::Emacs => self.set_keyseq_timeout(None), // no timeout
538            EditMode::Vi => self.set_keyseq_timeout(Some(500)),
539        }
540    }
541
542    /// Tell if lines are automatically added to the history.
543    ///
544    /// By default, they are not.
545    fn set_auto_add_history(&mut self, yes: bool) {
546        self.config_mut().auto_add_history = yes;
547    }
548
549    /// Set bell style: beep, flash or nothing.
550    fn set_bell_style(&mut self, bell_style: BellStyle) {
551        self.config_mut().bell_style = bell_style;
552    }
553
554    /// Forces colorization on or off.
555    ///
556    /// By default, colorization is on except if stdout is not a TTY.
557    fn set_color_mode(&mut self, color_mode: ColorMode) {
558        self.config_mut().set_color_mode(color_mode);
559    }
560
561    /// Whether to use stdio or not
562    ///
563    /// By default, stdio is used.
564    fn set_behavior(&mut self, behavior: Behavior) {
565        self.config_mut().set_behavior(behavior);
566    }
567
568    /// Horizontal space taken by a tab.
569    ///
570    /// By default, `8`
571    fn set_tab_stop(&mut self, tab_stop: usize) {
572        self.config_mut().set_tab_stop(tab_stop);
573    }
574
575    /// Check if cursor position is at leftmost before displaying prompt.
576    ///
577    /// By default, we don't check.
578    fn set_check_cursor_position(&mut self, yes: bool) {
579        self.config_mut().check_cursor_position = yes;
580    }
581    /// Indentation size for indent/dedent commands
582    ///
583    /// By default, `2`
584    fn set_indent_size(&mut self, size: usize) {
585        self.config_mut().set_indent_size(size);
586    }
587
588    /// Enable or disable bracketed paste on unix platform
589    ///
590    /// By default, it's enabled.
591    fn enable_bracketed_paste(&mut self, enabled: bool) {
592        self.config_mut().enable_bracketed_paste = enabled;
593    }
594
595    /// Enable or disable signals in termios
596    ///
597    /// By default, it's disabled.
598    fn set_enable_signals(&mut self, enable_signals: bool) {
599        self.config_mut().set_enable_signals(enable_signals);
600    }
601}
rustyline/config.rs

rustyline/
config.rs
