Changes to allow Windows backspace keybindings

examples/example.rs

@@ -6,7 +6,7 @@ use rustyline::error::ReadlineError;
 use rustyline::highlight::{Highlighter, MatchingBracketHighlighter};
 use rustyline::hint::{Hinter, HistoryHinter};
 use rustyline::validate::{self, MatchingBracketValidator, Validator};
-use rustyline::{Cmd, CompletionType, Config, Context, EditMode, Editor, KeyPress};
+use rustyline::{Cmd, CompletionType, Config, Context, EditMode, Editor, KeyPress, Movement, Word};
 use rustyline_derive::Helper;
 
 #[derive(Helper)]
@@ -83,7 +83,7 @@ fn main() -> rustyline::Result<()> {
     let config = Config::builder()
         .history_ignore_space(true)
         .completion_type(CompletionType::List)
-        .edit_mode(EditMode::Emacs)
+        .edit_mode(EditMode::Vi)
         .output_stream(OutputStreamType::Stdout)
         .build();
     let h = MyHelper {
@@ -97,6 +97,9 @@ fn main() -> rustyline::Result<()> {
     rl.set_helper(Some(h));
     rl.bind_sequence(KeyPress::Meta('N'), Cmd::HistorySearchForward);
     rl.bind_sequence(KeyPress::Meta('P'), Cmd::HistorySearchBackward);
+    rl.bind_sequence(KeyPress::ControlBackspace, Cmd::Kill(Movement::BackwardWord(1, Word::Vi)));
+    rl.bind_sequence(KeyPress::MetaBackspace, Cmd::Kill(Movement::BackwardChar(1)));
+    rl.bind_sequence(KeyPress::ShiftBackspace, Cmd::Kill(Movement::BackwardChar(1)));
     if rl.load_history("history.txt").is_err() {
         println!("No previous history.");
     }

src/keys.rs

@@ -24,6 +24,8 @@ pub enum KeyPress {
     ControlRight,
     /// Ctrl-↑
     ControlUp,
+    /// Control Backspace
+    ControlBackspace,
     /// Ctrl-char
     Ctrl(char),
     /// ⌦
@@ -46,6 +48,8 @@ pub enum KeyPress {
     Left,
     /// Escape-char or Alt-char
     Meta(char),
+    /// Alt Backspace
+    MetaBackspace,
     /// `KeyPress::Char('\0')`
     Null,
     /// ⇟
@@ -54,6 +58,8 @@ pub enum KeyPress {
     PageUp,
     /// → arrow key
     Right,
+    /// Shift Backspace
+    ShiftBackspace,
     /// Shift-↓
     ShiftDown,
     /// Shift-←

src/lib.rs

@@ -40,7 +40,7 @@ use std::path::Path;
 use std::result;
 use std::sync::{Arc, Mutex, RwLock};
 
-use log::debug;
+use log::{warn, debug};
 use unicode_width::UnicodeWidthStr;
 
 use crate::tty::{RawMode, Renderer, Term, Terminal};
@@ -888,7 +888,22 @@ impl<H: Helper> Editor<H> {
     /// Bind a sequence to a command.
     pub fn bind_sequence(&mut self, key_seq: KeyPress, cmd: Cmd) -> Option<Cmd> {
         if let Ok(mut bindings) = self.custom_bindings.write() {
-            bindings.insert(key_seq, cmd)
+            let key = if let KeyPress::Char(ref c) = key_seq {
+                if c.is_control() {
+                    keys::char_to_key_press(*c)
+                } else {
+                    key_seq
+                }
+            } else if let KeyPress::Ctrl(ref c) = key_seq {
+                if c.is_control() {
+                    keys::char_to_key_press(*c);
+                    warn!(target: "rustyline", "KeyPress::Ctrl({:?}) may not work on unix", c)
+                }
+                key_seq
+            } else {
+                key_seq
+            };
+            bindings.insert(key, cmd)        
         } else {
             None
         }

src/tty/windows.rs

@@ -179,6 +179,17 @@ impl RawReader for ConsoleRawReader {
                             KeyPress::Down
                         });
                     }
+                    winuser::VK_BACK => {
+                        return Ok(if ctrl {
+                            KeyPress::ControlBackspace
+                        } else if shift {
+                            KeyPress::ShiftBackspace
+                        } else if meta {
+                            KeyPress::MetaBackspace
+                        } else {
+                            KeyPress::Backspace
+                        });
+                    }
                     winuser::VK_DELETE => return Ok(KeyPress::Delete),
                     winuser::VK_HOME => return Ok(KeyPress::Home),
                     winuser::VK_END => return Ok(KeyPress::End),
@@ -220,13 +231,21 @@ impl RawReader for ConsoleRawReader {
                 };
                 let c = rc?;
                 if meta {
-                    return Ok(KeyPress::Meta(c));
+                    let mut key = keys::char_to_key_press(c);
+                    if key == KeyPress::Backspace && meta {
+                        key = KeyPress::MetaBackspace;
+                    } else {
+                        key = KeyPress::Meta(c);
+                    }
+                    return Ok(key);
                 } else {
                     let mut key = keys::char_to_key_press(c);
                     if key == KeyPress::Tab && shift {
                         key = KeyPress::BackTab;
                     } else if key == KeyPress::Char(' ') && ctrl {
                         key = KeyPress::Ctrl(' ');
+                    } else if key == KeyPress::Backspace && ctrl {
+                        key = KeyPress::ControlBackspace;
                     }
                     return Ok(key);
                 }