├── LICENSE
├── README.md
└── readline.kak


/LICENSE:
--------------------------------------------------------------------------------
 1 | MIT License
 2 | 
 3 | Copyright (c) 2019 Gregory L. Chamberlain
 4 | 
 5 | Permission is hereby granted, free of charge, to any person obtaining a copy
 6 | of this software and associated documentation files (the "Software"), to deal
 7 | in the Software without restriction, including without limitation the rights
 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 | 
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 | 
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 | SOFTWARE.
22 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | # Readline-style mappings for Kakoune
 2 | 
 3 | This plugin implements many line-editing shortcuts in
 4 | [Kakoune](https://kakoune.org), emulating
 5 | [Readline](http://www.gnu.org/software/readline/) as
 6 | closely as possible. See the readline(1) man page for explanations of
 7 | what they do.
 8 | 
 9 | ## Installation
10 | 
11 | ### Using `plug.kak`
12 | 
13 | Suggested configuration:
14 | 
15 | ``` kak
16 | # ~/.config/kak/kakrc
17 | plug chambln/kakoune-readline config %{
18 |     map global insert <tab> <c-n>
19 |     map global insert <s-tab> <c-p>
20 |     map global insert <c-p> <up>
21 |     map global insert <c-n> <down>
22 |     hook global WinCreate .* readline-enable
23 | }
24 | ```
25 | 
26 | Use `<a-tab>` to insert a tab character; or omit the config clause if
27 | you’d rather not use tab for completion.
28 | 
29 | ### Manual
30 | 
31 | Put a copy of or link to `readline.kak` anywhere within your
32 | `~/.config/kak/autoload/` directory.
33 | 
34 | ### Usage
35 | 
36 | Manually enable Readline mappings in the current window:
37 | 
38 |     :readline-enable<ret>
39 | 
40 | Enable Readline mappings for the `sh` filetype:
41 | 
42 | ``` kak
43 | # ~/.config/kak/kakrc
44 | hook global WinSetOption filetype=sh %{
45 |     readline-enable
46 |     hook window WinSetOption filetype=.* readline-disable
47 | }
48 | ```
49 | 
50 | Always use Readline mappings:
51 | 
52 | ``` kak
53 | # ~/.config/kak/kakrc
54 | hook global WinCreate .* readline-enable
55 | ```
56 | 
57 | ## To-do
58 | 
59 |   - Implement `reverse-search-history (C-r)` and `forward-search-history
60 |     (C-s)`.
61 |   - Maybe respect `%opt{extra_word_chars}`?
62 | 
63 | ## Bugs and notes
64 | 
65 |   - `<c-a-h>` kills two words backward if the cursor is exactly one
66 |     character into the latter, e.g. `one two t|hree four` becomes `one
67 |     |hree four` where `|` represents the cursor.
68 | 
69 |   - `transpose-char` and `transpose-word` traverse line breaks.
70 | 
71 |   - If the cursor is in the middle of the word,
72 |     `delete-horizontal-space` deletes whitespace after it.
73 | 
74 |   - The `<c-u>` (`unix-line-discard`) mapping overrides Kakoune’s
75 |     default:
76 |     
77 |         <c-u>
78 |             commit changes up to now as a single undo group
79 | 


--------------------------------------------------------------------------------
/readline.kak:
--------------------------------------------------------------------------------
  1 | # See LICENSE file for copyright and license details.
  2 | 
  3 | provide-module readline %{
  4 | 
  5 |     define-command -hidden readline-forward-word %{
  6 |         # Expects to be called from insert mode.
  7 |         try %{
  8 |             execute-keys '<a-;><a-/>.<ret><a-;>/[a-zA-Z0-9]+<ret><right>'
  9 |         }
 10 |     }
 11 | 
 12 |     define-command -hidden readline-backward-word %{
 13 |         # Expects to be called from insert mode.
 14 |         try %{
 15 |             execute-keys '<a-;><a-/>[A-Za-z0-9]+<ret><a-:><a-;><a-;><a-;>;'
 16 |         }
 17 |     }
 18 | 
 19 |     define-command -hidden readline-unix-word-rubout %{
 20 |         # Expects to be called from insert mode.
 21 |         try %{
 22 |             execute-keys '<a-;><a-/>\S+\s*<ret><a-;>d'
 23 |         }
 24 |     }
 25 | 
 26 |     define-command -hidden readline-transpose-chars %{
 27 |         # Expects to be called from insert mode.
 28 |         execute-keys '<a-;>;'
 29 |         try %{
 30 |             execute-keys '<a-;>s$<ret>'                   # Fail unless cursor is at line end.
 31 |             execute-keys '<left><left><a-;>d<a-;>p<end>'  # Transpose characters at line end.
 32 |         } catch %{
 33 |             execute-keys '<a-;>s^.<ret>'                  # Fail unless cursor is at line start.
 34 |             execute-keys '<a-;>d<left><a-;>P<right>'      # Move character to end of line above.
 35 |         } catch %{
 36 |             execute-keys '<left><a-;>d<a-;>p<right><right>'  # Transpose characters.
 37 |         }
 38 |     }
 39 | 
 40 |     define-command -hidden readline-transpose-words %{
 41 |         # Expects to be called from insert mode.
 42 |         readline-forward-word
 43 |         execute-keys -itersel '<a-;><a-?>[^A-Za-z0-9]+<ret><a-;><a-?><ret><a-;>s[A-Za-z0-9]+<ret><a-;><a-)><a-;>)<a-;><space><a-;><a-:><right>'
 44 |     }
 45 | 
 46 |     define-command readline-enable %{
 47 |         map window insert <c-a> <home> -docstring beginning-of-line
 48 |         map window insert <c-e> <end> -docstring end-of-line
 49 |         map window insert <c-f> <right> -docstring forward-char
 50 |         map window insert <c-b> <left> -docstring backward-char
 51 |         map window insert <a-f> '<a-;>: readline-forward-word<ret>' -docstring forward-word
 52 |         map window insert <a-b> '<a-;>: readline-backward-word<ret>' -docstring backward-word
 53 |         map window insert <c-l> '<a-;>vt' -docstring clear-screen
 54 |         map window insert <c-d> <del> -docstring delete-char
 55 |         map window insert <c-h> <backspace> -docstring backward-delete-char
 56 |         map window insert <c-q> <c-v> -docstring quoted-insert
 57 |         map window insert <a-tab> '<a-;>: execute-keys <lt>tab<gt><ret>' -docstring tab-insert
 58 |         map window insert <c-t> '<a-;>: readline-transpose-chars<ret>' -docstring transpose-chars
 59 |         map window insert <a-t> '<a-;>: readline-transpose-words<ret>' -docstring transpose-words
 60 |         map window insert <a-u> '<a-;>;<a-;>W<a-;>~<right>' -docstring upcase-word
 61 |         map window insert <a-l> '<a-;>;<a-;>W<a-;>`<right>' -docstring downcase-word
 62 |         map window insert <a-c> '<a-;>;<a-;>~<right><a-;>W<a-;>`<right>' -docstring capitalize-word
 63 |         map window insert <c-k> '<a-;>;<a-;>Gl<a-;>"_d' -docstring kill-line
 64 |         map window insert <c-u> '<a-;>;<a-;>h<a-;>Gh<a-;>"_d' -docstring unix-line-discard
 65 |         map window insert <a-d> '<a-;>;<a-;>E<a-;>"_d' -docstring kill-word
 66 |         map window insert <a-backspace> '<left><a-;>B<a-;>"_d' -docstring backward-kill-word
 67 |         map window insert <a-c-h> '<left><a-;>B<a-;>"_d' -docstring backward-kill-word
 68 |         map window insert <c-w> '<a-;>: readline-unix-word-rubout<ret>' -docstring unix-word-rubout
 69 |         map window insert <a-\> '<esc><a-a><space>c' -docstring delete-horizontal-space
 70 |         map window insert <c-y> '<c-r>"' -docstring yank
 71 |         map window prompt <c-y> '<c-r>"' -docstring yank
 72 |         map window prompt <c-g> <esc> -docstring abort
 73 |         map window insert <a-#> '<a-;>: comment-line<ret><down>' -docstring insert-comment
 74 |         map window insert <a-ret> <esc> -docstring vi-editing-mode
 75 |     }
 76 | 
 77 |     define-command readline-disable %{
 78 |         unmap window insert <c-a> <home>
 79 |         unmap window insert <c-e> <end>
 80 |         unmap window insert <c-f> <right>
 81 |         unmap window insert <c-b> <left>
 82 |         unmap window insert <a-f> '<a-;>: readline-forward-word<ret>'
 83 |         unmap window insert <a-b> '<a-;>: readline-backward-word<ret>'
 84 |         unmap window insert <c-l> '<a-;>vt'
 85 |         unmap window insert <c-d> <del>
 86 |         unmap window insert <c-h> <backspace>
 87 |         unmap window insert <c-q> <c-v>
 88 |         unmap window insert <a-tab> '<a-;>: execute-keys <lt>tab<gt><ret>'
 89 |         unmap window insert <c-t> '<a-;>: readline-transpose-chars<ret>'
 90 |         unmap window insert <a-t> '<a-;>: readline-transpose-words<ret>'
 91 |         unmap window insert <a-u> '<a-;>;<a-;>W<a-;>~<right>'
 92 |         unmap window insert <a-l> '<a-;>;<a-;>W<a-;>`<right>'
 93 |         unmap window insert <a-c> '<a-;>;<a-;>~<right><a-;>W<a-;>`<right>'
 94 |         unmap window insert <c-k> '<a-;>;<a-;>Gl<a-;>"_d'
 95 |         unmap window insert <c-u> '<a-;>;<a-;>h<a-;>Gh<a-;>"_d'
 96 |         unmap window insert <a-d> '<a-;>;<a-;>E<a-;>"_d'
 97 |         unmap window insert <a-backspace> '<left><a-;>B<a-;>"_d'
 98 |         unmap window insert <a-c-h> '<left><a-;>B<a-;>"_d'
 99 |         unmap window insert <c-w> '<a-;>: readline-unix-word-rubout<ret>'
100 |         unmap window insert <a-\> '<esc><a-a><space>c'
101 |         unmap window insert <c-y> '<c-r>"'
102 |         unmap window prompt <c-y> '<c-r>"'
103 |         unmap window prompt <c-g> <esc>
104 |         unmap window insert <a-#> '<a-;>: comment-line<ret><down>'
105 |         unmap window insert <a-ret> <esc>
106 |     }
107 | 
108 | }
109 | 
110 | require-module readline
111 | 


--------------------------------------------------------------------------------