Add support for digraphs

book/src/SUMMARY.md

@@ -13,6 +13,7 @@
   - [Key Remapping](./remapping.md)
   - [Hooks](./hooks.md)
   - [Languages](./languages.md)
+  - [Digraphs](./digraphs.md)
 - [Guides](./guides/README.md)
   - [Adding Languages](./guides/adding_languages.md)
   - [Adding Textobject Queries](./guides/textobject.md)

book/src/digraphs.md

@@ -0,0 +1,14 @@
+# Digraphs
+
+By default, special characters can be input using the `insert_digraphs` (or `C-K`) command while in insert mode. Custom digraphs can be added to the `editor.digraphs` section of the config:
+
+```toml
+[editor.digraphs]
+ka = "か"
+ku = { symbols = "く", description = "The japanese character Ku" }
+shrug = "¯\\_(ツ)_/¯"
+```
+
+## Defaults
+
+TBD

book/src/keymap.md

@@ -322,6 +322,7 @@ undo-able "save point" until you return to normal mode.
 | `PageDown`                | Move one page down          | `page_down`             |
 | `Alt->`                   | Go to end of buffer         | `goto_file_end`         |
 | `Alt-<`                   | Go to start of buffer       | `goto_file_start`       |
+| `Ctrl-K`                  | Insert digraph              | `insert_digraph`        |
 
 ## Select / extend mode
 

helix-term/src/commands.rs

@@ -430,6 +430,7 @@ impl MappableCommand {
         record_macro, "Record macro",
         replay_macro, "Replay macro",
         command_palette, "Open command palette",
+        insert_digraph, "Insert unicode characters with prompt",
     );
 }
 
@@ -4687,3 +4688,50 @@ fn replay_macro(cx: &mut Context) {
         cx.editor.macro_replaying.pop();
     }));
 }
+
+fn insert_digraph(cx: &mut Context) {
+    ui::prompt(
+        cx,
+        "digraph:".into(),
+        Some('K'), //todo: decide on register to use
+        move |editor, input| {
+            editor
+                .config()
+                .digraphs
+                .search(input)
+                .take(10)
+                .map(|entry| {
+                    // todo: Prompt does not currently allow additional text as part
+                    // of it's suggestions. Show the user the symbol and description
+                    // once prompt has been made more robust
+                    #[allow(clippy::useless_format)]
+                    ((0..), Cow::from(format!("{}", entry.sequence)))
+                })
+                .collect()
+        },
+        move |cx, input, event| {
+            match event {
+                PromptEvent::Validate => (),
+                _ => return,
+            }
+            let config = cx.editor.config();
+            let symbols = if let Some(entry) = config.digraphs.get(input) {
+                &entry.symbols
+            } else {
+                cx.editor.set_error("Digraph not found");
+                return;
+            };
+
+            let (view, doc) = current!(cx.editor);
+            let selection = doc.selection(view.id);
+            let mut changes = Vec::with_capacity(selection.len());
+
+            for range in selection.ranges() {
+                changes.push((range.from(), range.from(), Some(symbols.clone().into())));
+            }
+            let trans = Transaction::change(doc.text(), changes.into_iter());
+            doc.apply(&trans, view.id);
+            doc.append_changes_to_history(view.id);
+        },
+    )
+}

helix-term/src/keymap/default.rs

@@ -379,6 +379,8 @@ pub fn default() -> HashMap<Mode, Keymap> {
 
         "C-x" => completion,
         "C-r" => insert_register,
+
+        "C-K" => insert_digraph,
     });
     hashmap!(
         Mode::Normal => Keymap::new(normal),