Add support for arbitrary keystrokes to fall back to for deletions (#90)

LunarWatcher · Sep 12, 2024 · 6971bcc · 6971bcc
1 parent 2c18fa6
commit 6971bcc
Show file tree

Hide file tree

Showing 5 changed files with 43 additions and 14 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,6 +1,9 @@
 # 4.0.3
 `g:AutoPairsVersion = 40003`
 
+## Added 
+* Support for arbitrary underlying deletion keybinds ([#90](https://github.com/LunarWatcher/auto-pairs/issues/90))
+
 ## Fixed
 * Made `g:AutoPairsExperimentalAutocmd` actually reflect the new default-enabled state
 

diff --git a/autoload/autopairs.vim b/autoload/autopairs.vim
@@ -247,10 +247,11 @@ func! autopairs#AutoPairsInsert(key, ...)
     return a:key
 endf
 
-func! autopairs#AutoPairsDelete()
+func! autopairs#AutoPairsDelete(...)
+    let fallbackEvent = get(a:, 1, "\<BS>")
     if !b:autopairs_enabled || b:AutoPairsIgnoreSingle
         let b:AutoPairsIgnoreSingle = 0
-        return "\<BS>"
+        return fallbackEvent
     end
 
     let [before, after, ig] = autopairs#Strings#getline(b:AutoPairsMultilineBackspace)
@@ -270,7 +271,7 @@ func! autopairs#AutoPairsDelete()
                     if a[0] == ' '
                         return "\<BS>\<DELETE>"
                     else
-                        return "\<BS>"
+                        return fallbackEvent
                     end
                 end
                 return autopairs#Strings#backspace(b) .. autopairs#Strings#delete(a)
@@ -302,7 +303,7 @@ func! autopairs#AutoPairsDelete()
                         let b ..= getline(line('.') - offset) .. ' '
                         let offset += 1
                         if (line('.') - offset <= 0)
-                            return "\<BS>"
+                            return fallbackEvent
                         endif
                     endwhile
                     let a = matchstr(getline(line('.') - offset), autopairs#Utils#escape(open, opt) .. '\v\s*$') .. ' '
@@ -313,7 +314,7 @@ func! autopairs#AutoPairsDelete()
             end
         endfor
     endif
-    return "\<BS>"
+    return fallbackEvent
 endf
 
 " Fast wrap the word in brackets

diff --git a/doc/AutoPairs.txt b/doc/AutoPairs.txt
@@ -774,7 +774,7 @@ Default: 0
 
 Map <BS> to delete brackets and quotes in pair, executes:
 
-    inoremap <buffer> <silent> <BS> <C-R>=AutoPairsDelete()<CR>
+    inoremap <buffer> <silent> <BS> <C-R>=autopairs#AutoPairsDelete()<CR>
 
 ------------------------------------------------------------------------------
                                                  *g:AutoPairsMultilineBackspace*

diff --git a/test/ComplexTests.vimspec b/test/ComplexTests.vimspec
@@ -16,8 +16,8 @@ Describe Complex use of maps
                                           " sends some random signal crap
         call Expect("<\<Delete>]").ToMatch("<]")
         %d
-        exec "normal i<\<ESC>"
-        exec "normal ^\<Right>i>\<ESC>"
+        exec "normal i<"
+        exec "normal ^\<Right>i>"
         call Expect('').CheckBuff("<>")
     End
 End
diff --git a/test/DeleteTest.vimspec b/test/DeleteTest.vimspec
@@ -21,17 +21,42 @@ Describe <BS> tests
         call autopairs#AutoPairsInit()
 
         call Expect("()\<BS>").ToMatch("")
-        let b:AutoPairsBSAfter = 0
-
-        call Expect("()\<BS>").ToMatch("(")
+        let b:AutoPairsBSIn = 0
+        call Expect("(\<BS>").ToMatch(")")
     End
-    It should delete in when instructed
+    It should allow mapping other default events
         new | only!
         call autopairs#AutoPairsInit()
+        inoremap <silent><expr> <Delete> autopairs#AutoPairsDelete("\<Delete>")
+        inoremap <silent><expr> <C-w> autopairs#AutoPairsDelete("\<C-w>")
+
+        call Expect("(\<Delete>").ToMatch("")
+        " This is sort of dumb, but eh, it's an edge-case
+        call Expect("()\<Delete>").ToMatch("")
+
+
+        call Expect("(\<C-w>").ToMatch("")
+        call Expect("()\<C-w>").ToMatch("")
+        call Expect("Word Two\<C-w>").ToMatch("Word ")
+
+        call Expect("(Hello\<Ignore>\<C-w>").ToMatch("()")
+        call Expect("(Hello\<Ignore>\<C-w>\<Ignore>\<C-w>").ToMatch("")
+        " Just for good measure
+        call Expect("[(Hello\<Ignore>\<C-w>\<Ignore>\<C-w>").ToMatch("[]")
+
+        iunmap <C-w>
+        iunmap <Delete>
+    End
+    " Not sure if this is strictly speaking necessary or not
+    It should not break <BS> with other maps
+        inoremap <silent><expr> <Delete> autopairs#AutoPairsDelete("\<Delete>")
+        inoremap <silent><expr> <C-w> autopairs#AutoPairsDelete("\<C-w>")
 
         call Expect("(\<BS>").ToMatch("")
-        let b:AutoPairsBSIn = 0
-        call Expect("(\<BS>").ToMatch(")")
+        call Expect("[\<BS>").ToMatch("")
+
+        iunmap <C-w>
+        iunmap <Delete>
     End
 
 End