Bump fork to version 9.1.1

.github/workflows/rust.yml

@@ -0,0 +1,44 @@
+name: Rust
+
+on:
+  push:
+    branches: [master]
+    paths:
+      - '**.rs'
+      - '**.toml'
+      - '.github/workflows/rust.yml'
+  pull_request:
+    paths:
+      - '**.rs'
+      - '**.toml'
+      - '.github/workflows/rust.yml'
+      - '*.md'
+env:
+  RUST_BACKTRACE: 1
+jobs:
+  build:
+
+    strategy:
+      matrix:
+        os: [ubuntu-latest, windows-latest]
+
+    runs-on: ${{ matrix.os }}
+
+    steps:
+    - uses: actions/checkout@v2
+    - uses: hecrj/setup-rust-action@v1
+      with:
+        components: rustfmt, clippy
+    - name: Build
+      run: cargo build --workspace --all-targets
+    - name: Run tests
+      run: cargo test --workspace --all-targets
+    - name: Run doctests
+      run: cargo test --workspace --doc
+    - name: Test features
+      if: matrix.os != 'windows-latest'
+      run: cargo test --workspace --all-targets --all-features
+    - name: Clippy
+      run: cargo clippy --workspace -- -D warnings
+    - name: Format
+      run: cargo fmt --all -- --check

.gitignore

@@ -1,12 +1,3 @@
-# Compiled files
-*.o
-*.so
-*.rlib
-*.dll
-
-# Executables
-*.exe
-
 # Generated by Cargo
 /target/
 Cargo.lock

BUGS.md

@@ -4,7 +4,7 @@ Know issues
 
 We would like to introduce an incremental parsing phase (see `tree-sitter`).
 Because, when you have tokens (which may be as simple as words) or an AST,
-completion / suggestion / highlting / validation become easy.
+completion / suggestion / highlighting / validation become easy.
 So we need to send events to a lexer/parser, update `Document` accordingly.
 And fix `Completer` / `Hinter` / `Highlighter` API such as they have access to `Document`.
 
@@ -16,6 +16,10 @@ Currently, performance is poor because, most of the time, we refresh the whole l
 We would like to transform events on prompt/line/hint into partial repaint.
 
 See `termwiz` design (`Surface`).
+See `replxx` refresh delay (`_lastRefreshTime`) or `python-prompt-toolkit` max_render_postpone_time.
+https://docs.rs/xi-unicode/0.3.0/xi_unicode/struct.LineBreakIterator.html
+https://github.com/xi-editor/xi-editor/blob/master/rust/core-lib/src/linewrap.rs
+[vt100](https://docs.rs/vt100/0.12.0/vt100/struct.Screen.html#method.contents_diff)
 
 ## Action / Command
 
@@ -24,3 +28,19 @@ To do so, we need to refactor current key event dispatch.
 
 See `replxx` design (`ACTION_RESULT`, `action_trait_t`).
 
+## Line wrapping (should be fixed with versions >= 6.1.2)
+
+On Unix platform, we assume that `auto_right_margin` (`am`) is enabled.
+And on Windows, we activate `ENABLE_WRAP_AT_EOL_OUTPUT`.
+But on Windows 10, `ENABLE_WRAP_AT_EOL_OUTPUT` and `ENABLE_VIRTUAL_TERMINAL_PROCESSING` seems to be incompatible.
+
+## Colors
+
+We assume that ANSI colors are supported.
+Which is not the case on Windows (except on Windows 10)!
+
+## Emoji
+
+https://github.com/kkawakam/rustyline/issues/184
+https://docs.rs/xi-unicode/0.3.0/xi_unicode/trait.EmojiExt.html
+https://docs.rs/termwiz/0.11.0/termwiz/cell/fn.grapheme_column_width.html

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "rustyline"
-version = "5.0.5"
+version = "9.1.1"
 authors = ["Katsu Kawakami <kkawa1570@gmail.com>"]
 edition = "2018"
 description = "Rustyline, a readline implementation based on Antirez's Linenoise"
@@ -12,41 +12,55 @@ license = "MIT"
 categories = ["command-line-interface"]
 
 [badges]
-travis-ci = { repository = "kkawakam/rustyline" }
-appveyor = { repository = "kkawakam/rustyline" }
 maintenance = { status = "actively-developed" }
 
 [workspace]
 members = ["rustyline-derive"]
 
 [dependencies]
-cfg-if = "0.1"
-dirs = { version = "2.0", optional = true }
+bitflags = "1.3"
+cfg-if = "1.0"
+# For file completion
+# https://rustsec.org/advisories/RUSTSEC-2020-0053.html
+dirs-next = { version = "2.0", optional = true }
+# For History
+fd-lock = "3.0.0"
 libc = "0.2"
 log = "0.4"
 unicode-width = "0.1"
 unicode-segmentation = "1.0"
 memchr = "2.0"
+# For custom bindings
+# https://rustsec.org/advisories/RUSTSEC-2021-0003.html
+smallvec = "1.6.1"
+radix_trie = "0.2"
+regex = { version = "1.5.4", optional = true }
 
 [target.'cfg(unix)'.dependencies]
-nix = "0.14"
-utf8parse = "0.1"
+nix = "0.23"
+utf8parse = "0.2"
+skim = { version = "0.9", optional = true }
 
 [target.'cfg(windows)'.dependencies]
-winapi = { version = "0.3", features = ["consoleapi", "handleapi", "minwindef", "processenv", "winbase", "wincon", "winuser"] }
+winapi = { version = "0.3", features = ["consoleapi", "handleapi", "minwindef", "processenv", "std", "winbase", "wincon", "winuser"] }
+scopeguard = "1.1"
+clipboard-win = "4.2.1"
 
 [dev-dependencies]
-env_logger = "0.7"
-tempdir = "0.3"
+doc-comment = "0.3"
+env_logger = { version = "0.9", default-features = false }
+tempfile = "3.1.0"
 assert_matches = "1.2"
-rustyline-derive = { version = "0.2.0", path = "rustyline-derive" }
+rustyline-derive = { version = "0.6.0", path = "rustyline-derive" }
 
 [features]
 default = ["with-dirs"]
-with-dirs = ["dirs"]
+with-dirs = ["dirs-next"]
+with-fuzzy = ["skim"]
+case_insensitive_history_search = ["regex"]
 
 [package.metadata.docs.rs]
-features = ["with-dirs"]
+features = ["with-dirs", "with-fuzzy"]
 all-features = false
 no-default-features = true
 default-target = "x86_64-unknown-linux-gnu"

CustomBinding.md

@@ -0,0 +1,68 @@
+## Related topics
+
+* [Multiple commands for a keybinding](https://github.com/kkawakam/rustyline/issues/306) and
+  [Conditional Bind Sequences](https://github.com/kkawakam/rustyline/issues/269) : original issues
+* [Conditional Bind Sequences](https://github.com/kkawakam/rustyline/pull/293) : incomplete proposal
+* [Add `Cmd::Yield` for complex custom bindings](https://github.com/kkawakam/rustyline/pull/342) : another proposal
+* [Initial invoke trait and auto-indent example](https://github.com/kkawakam/rustyline/pull/466) : a validator is like a custom action triggered indirectly.
+
+And other issues that should be solved if our design is good:
+* [Extend Meta-F,Alt+Right feature for hint partial completion](https://github.com/kkawakam/rustyline/pull/430)
+* [Use Arrow-Up to search history with prefix](https://github.com/kkawakam/rustyline/issues/423)
+* [Execute Arbitrary Command Via Keybinding](https://github.com/kkawakam/rustyline/issues/418)
+* [Use Ctrl-E for hint completion](https://github.com/kkawakam/rustyline/pull/407)
+* [Add History Search Behaviour](https://github.com/kkawakam/rustyline/pull/424)
+* ...
+
+## Conditions / Filters
+See https://python-prompt-toolkit.readthedocs.io/en/master/pages/advanced_topics/key_bindings.html?highlight=filter#attaching-a-filter-condition
+
+Some keys/commands may behave differently depending on:
+ * edit mode (emacs vs vi)
+ * vi input mode (insert vs replace vs command modes)
+ * empty line
+ * cursor position
+ * repeat count
+ * original key pressed (when same command is bound to different key)
+ * hint
+ * ...
+
+## More input
+Some keys/commands may ask for more input.
+I am not sure this point should be tackle here.
+
+## Multiple / complex actions
+For one key/command, we may want to perform multiple actions.
+We should ask the undo manager to start a "transaction" before first action and commit it after the last action.
+Should we do something specific with the kill ring ?
+We should refresh / repaint only when all actions are performed (or if ask explicitly?) depending on cumulated action impacts.
+...
+
+## Misc
+
+```rust
+/// Command / action result
+#[derive(Debug, Clone, PartialEq, Copy)]
+#[non_exhaustive]
+pub enum ActionResult {
+    // Interrupt / reject user input
+    // => Err should be fine
+    //Bail,
+    ///
+    Continue,
+    /// Accept user input (except if `Validator` disagrees)
+    Return,
+}
+```
+```rust
+bitflags::bitflags! {
+    #[doc = "Action invocation impacts"]
+    pub struct Impacts: u8 {
+        const PUSH_CHAR = 0b0000_0001;
+        const BEEP = 0b0000_0010;
+        const MOVE_CURSOR = 0b0000_0100; // State::move_cursor
+        const REFRESH = 0b0000_1000; // State::refresh_line
+        const CLEAR_SREEN = 0b0001_0000; // State::clear_screen
+    }
+}
+```

History.md

@@ -0,0 +1,35 @@
+# Config
+  max_history_size
+
+# Current session
+
+* we should remember (index) of the first line inserted by this session.
+    - if no line has been inserted => do nothing on save
+    - reset this index after saving successfully.
+* we should remember (path and timestamp) of the file used to initialize/`load` history.
+    - if path used to save history is the same:
+        + if timestamp is still the same => we can append only new lines if history has not been truncated.
+        + update timestamp after saving successfully.
+* we should remember (path and timestamp) of the file used to persist/`save` history.
+    - reset them if `load` is then called with a different path
+    - update them if `load` is then called with same path.
+    - update them after saving successfully
+    - if path used to save history is the same:
+        + if timestamp is still the same => we can append only new lines if history has not been truncated.
+
+```
+HistoryInfo
+  first_add_index: Option<usize>, // first line inserted by this session
+  truncated: bool //
+  path_info: Option<PathInfo>,
+```
+```
+PathInfo
+  path: Path,
+  modified: SystemTime,
+```
+
+---
+With `termwiz`, you can define your own `History` backend.
+`termwiz` does not specify anything how the history is persisted.
+Only how to access / search history entry.

Incremental.md

@@ -0,0 +1,52 @@
+## Incremental computation
+
+We would like to avoid redrawing all row(s) when an event occurs.
+Currently, we redraw all row(s) except when:
+  * a character is inserted at the end of input (and there is no hint and no `highlight_char`),
+  * only the cursor is moved (input is not touched and no `highlight_char`).
+
+Ideally, we would like to redraw only impacted row(s) / cell(s).
+
+### Observable values
+
+Currently, we assume that highlighting does not impact layout / rendered text size.
+So only the following observables impact layout:
+  * prompt (interactive search, [input mode indicator](https://github.com/kkawakam/rustyline/pull/369)),
+  * [input mode](https://github.com/kkawakam/rustyline/pull/369),
+  * line(s) buffer,
+  * cursor position,
+  * hint / input validation message,
+  * screen size (line wrapping),
+  * [prompt continuation](https://github.com/kkawakam/rustyline/pull/372)s,
+  * row/wrap count.
+
+Some other values may impact layout but they are/should be constant:
+  * tab stop,
+
+### Line wrapping and highlighting
+
+Currently, there is no word wrapping (only grapheme wrapping).
+But we highlight the whole input at once.
+So there is no issue: for example, even if a keyword is wrapped, style is preserved.
+
+With [prompt continuation](https://github.com/kkawakam/rustyline/pull/372)s,
+we (will) interleave user input with continuations.
+So we need to preserve style.
+
+TODO How prompt_toolkit handle this problem ?
+Maybe using ANSI sequence directly was a bad idea. If `Highlighter` returns style ranges,
+applying style on input slice is easy (and also supporting styles on Windows < 10). 
+
+### Impacts
+
+Current granularity:
+ * PUSH_CHAR at end of input
+ * BEEP
+ * MOVE_CURSOR
+ * REFRESH whole input / rows
+ * CLEAR_SCREEN (+REFRESH)
+
+Wanted additional granurality:
+  * PUSH_STRING at end of input
+  * REFRESH_DIRTY only rows / cells
+