From 5b0e381a261b1450735f4eddac55aeb956c13713 Mon Sep 17 00:00:00 2001
From: Josh Rahm <joshuarahm@gmail.com>
Date: Sun, 21 Aug 2022 22:01:00 -0600
Subject: feat(userreg): Add user-defined registers to Neovim.
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

This change unlocks additional registers for Neovim by allowing a user
to define their own behavior for non-builtin registers.

This is accopmlished through a new option 'userregfunc'

The 'userregfunc' defines the function to call when handling a register
for which there is no builtin functionality.

The 'userregfunc' function should take 3 arguments:

   action - Either "yank" or "put"
   register - The character corresponding to the register
   content - In the case of action == "yank", the dictionary describing
             the yanked content, with the following keys:

             {type} - Either "char", "line" or "block"
             {lines} - The lines being yanked as a list
             {width} - The width in case of "block" mode.
             {additional_data} - Additional data (can be returned in
             "put" mode)

   In case of "put" this function should return the content to put. This
   content can be either:

     * A dictionary in the same template as content above.
     * A list of strings. This will be assumed to be "line" mode.
     * A string. This will be assumed to be "char" mode.

An example of a "null" 'userregfunc' that provides an implementation
identical to traditional vim registers would be:

      let s:contents = {}
      function! MyUserregFunction(action, register, content) abort
         if a:action == "put"
           return get(s:contents, a:register, "")
        else
           let s:contents[a:register] = a:content
        endif
      endfunction
      set userregfun=MyUserregFunction

  It is important to note that any valid unicode character can now be a
  register, including something like @☺.

  This change also addresses the multibyte parsing issues surrounding

  let @a = 'xyz'
  let @🔨 = 'hammer'
---
 src/nvim/options.lua | 9 +++++++++
 1 file changed, 9 insertions(+)

(limited to 'src/nvim/options.lua')

diff --git a/src/nvim/options.lua b/src/nvim/options.lua
index 2f941f5d0c..89de495d7a 100644
--- a/src/nvim/options.lua
+++ b/src/nvim/options.lua
@@ -2690,6 +2690,15 @@ return {
       varname='p_ut',
       defaults={if_true=4000}
     },
+    {
+      full_name='userregfunc', abbreviation='urf',
+      type='string', scope={'buffer'},
+      secure=true,
+      vi_def=true,
+      alloced=true,
+      varname='p_urf',
+      defaults={if_true=""}
+    },
     {
       full_name='varsofttabstop', abbreviation='vsts',
       short_desc=N_("list of numbers of spaces that <Tab> uses while editing"),
-- 
cgit 


From 242f75745009b3a0a2108d98ce6c02b6e13aac3f Mon Sep 17 00:00:00 2001
From: Josh Rahm <joshuarahm@gmail.com>
Date: Sun, 21 Aug 2022 23:12:54 -0600
Subject: feat(userreg): normalize userregfunc option format

---
 src/nvim/options.lua | 4 +---
 1 file changed, 1 insertion(+), 3 deletions(-)

(limited to 'src/nvim/options.lua')

diff --git a/src/nvim/options.lua b/src/nvim/options.lua
index 89de495d7a..044054916b 100644
--- a/src/nvim/options.lua
+++ b/src/nvim/options.lua
@@ -2692,10 +2692,8 @@ return {
     },
     {
       full_name='userregfunc', abbreviation='urf',
+      short_desc=N_("Function used to define behavior of user-defined registers."),
       type='string', scope={'buffer'},
-      secure=true,
-      vi_def=true,
-      alloced=true,
       varname='p_urf',
       defaults={if_true=""}
     },
-- 
cgit