Merge #5079 from ZyX-I/shada-save-current-pos

shada: Save current cursor position before saving jumps

3 files changed, 86 insertions, 38 deletions

diff --git a/src/clint.py b/src/clint.py
index 07733d211e..76982144fb 100755
--- a/src/clint.py
+++ b/src/clint.py
@@ -2516,6 +2516,10 @@ def CheckSpacing(filename, clean_lines, linenum, nesting_state, error):
 
     cast_line = re.sub(r'^# *define +\w+\([^)]*\)', '', line)
     match = Search(r'(?<!\bkvec_t)'
+                   r'(?<!\bkvec_withinit_t)'
+                   r'(?<!\bklist_t)'
+                   r'(?<!\bkliter_t)'
+                   r'(?<!\bkhash_t)'
                    r'\((?:const )?(?:struct )?[a-zA-Z_]\w*(?: *\*(?:const)?)*\)'
                    r' +'
                    r'-?(?:\*+|&)?(?:\w+|\+\+|--|\()', cast_line)
diff --git a/src/nvim/shada.c b/src/nvim/shada.c
index 867c697a9a..64610ae8f8 100644
--- a/src/nvim/shada.c
+++ b/src/nvim/shada.c
@@ -148,6 +148,9 @@ KHASH_SET_INIT_STR(strset)
 /// Common prefix for all ignorable “write” errors
 #define WERR "E574: "
 
+/// Callback function for add_search_pattern
+typedef void (*SearchPatternGetter)(SearchPattern *);
+
 /// Flags for shada_read_file and children
 typedef enum {
   kShaDaWantInfo = 1,       ///< Load non-mark information
@@ -2323,8 +2326,9 @@ static inline ShaDaWriteResult shada_read_when_writing(
 /// @param[in]  removable_bufs  Buffers which are ignored
 ///
 /// @return  ShadaEntry  List of buffers to save, kSDItemBufferList entry.
-static ShadaEntry shada_get_buflist(khash_t(bufset) *const removable_bufs)
-  FUNC_ATTR_NONNULL_ALL FUNC_ATTR_WARN_UNUSED_RESULT
+static inline ShadaEntry shada_get_buflist(
+    khash_t(bufset) *const removable_bufs)
+  FUNC_ATTR_NONNULL_ALL FUNC_ATTR_WARN_UNUSED_RESULT FUNC_ATTR_ALWAYS_INLINE
 {
   int max_bufs = get_shada_parameter('%');
   size_t buf_count = 0;
@@ -2368,6 +2372,62 @@ static ShadaEntry shada_get_buflist(khash_t(bufset) *const removable_bufs)
   return buflist_entry;
 }
 
+/// Save search pattern to PossiblyFreedShadaEntry
+///
+/// @param[out]  ret_pse  Location where result will be saved.
+/// @param[in]  get_pattern  Function used to get pattern.
+/// @param[in]  is_substitute_pattern  True if pattern in question is substitute
+///                                    pattern. Also controls whether some
+///                                    fields should be initialized to default
+///                                    or values from get_pattern.
+/// @param[in]  search_last_used  Result of search_was_last_used().
+/// @param[in]  search_highlighted  True if search pattern was highlighted by
+///                                 &hlsearch and this information should be
+///                                 saved.
+static inline void add_search_pattern(PossiblyFreedShadaEntry *const ret_pse,
+                                      const SearchPatternGetter get_pattern,
+                                      const bool is_substitute_pattern,
+                                      const bool search_last_used,
+                                      const bool search_highlighted)
+  FUNC_ATTR_ALWAYS_INLINE
+{
+  const ShadaEntry defaults = sd_default_values[kSDItemSearchPattern];
+  SearchPattern pat;
+  get_pattern(&pat);
+  if (pat.pat != NULL) {
+    *ret_pse = (PossiblyFreedShadaEntry) {
+      .can_free_entry = false,
+      .data = {
+        .type = kSDItemSearchPattern,
+        .timestamp = pat.timestamp,
+        .data = {
+          .search_pattern = {
+            .magic = pat.magic,
+            .smartcase = !pat.no_scs,
+            .has_line_offset = (is_substitute_pattern
+                                ? defaults.data.search_pattern.has_line_offset
+                                : pat.off.line),
+            .place_cursor_at_end = (
+                is_substitute_pattern
+                ? defaults.data.search_pattern.place_cursor_at_end
+                : pat.off.end),
+            .offset = (is_substitute_pattern
+                       ? defaults.data.search_pattern.offset
+                       : pat.off.off),
+            .is_last_used = (is_substitute_pattern ^ search_last_used),
+            .is_substitute_pattern = is_substitute_pattern,
+            .highlighted = ((is_substitute_pattern ^ search_last_used)
+                            && search_highlighted),
+            .pat = (char *)pat.pat,
+            .additional_data = pat.additional_data,
+            .search_backward = (!is_substitute_pattern && pat.off.dir == '?'),
+          }
+        }
+      }
+    };
+  }
+}
+
 /// Write ShaDa file
 ///
 /// @param[in]  sd_writer  Structure containing file writer definition.
@@ -2529,45 +2589,14 @@ static ShaDaWriteResult shada_write(ShaDaWriteDef *const sd_writer,
   const bool search_highlighted = !(no_hlsearch
                                     || find_shada_parameter('h') != NULL);
   const bool search_last_used = search_was_last_used();
-#define ADD_SEARCH_PAT(func, wms_attr, hlo, pcae, o, is_sub) \
-  do { \
-    SearchPattern pat; \
-    func(&pat); \
-    if (pat.pat != NULL) { \
-      wms->wms_attr = (PossiblyFreedShadaEntry) { \
-        .can_free_entry = false, \
-        .data = { \
-          .type = kSDItemSearchPattern, \
-          .timestamp = pat.timestamp, \
-          .data = { \
-            .search_pattern = { \
-              .magic = pat.magic, \
-              .smartcase = !pat.no_scs, \
-              .has_line_offset = hlo, \
-              .place_cursor_at_end = pcae, \
-              .offset = o, \
-              .is_last_used = (is_sub ^ search_last_used), \
-              .is_substitute_pattern = is_sub, \
-              .highlighted = ((is_sub ^ search_last_used) \
-                              && search_highlighted), \
-              .pat = (char *) pat.pat, \
-              .additional_data = pat.additional_data, \
-              .search_backward = (!is_sub && pat.off.dir == '?'), \
-            } \
-          } \
-        } \
-      }; \
-    } \
-  } while (0)
 
   // Initialize search pattern
-  ADD_SEARCH_PAT(get_search_pattern, search_pattern, pat.off.line, \
-                 pat.off.end, pat.off.off, false);
+  add_search_pattern(&wms->search_pattern, &get_search_pattern, false,
+                     search_last_used, search_highlighted);
 
   // Initialize substitute search pattern
-  ADD_SEARCH_PAT(get_substitute_pattern, sub_search_pattern, false, false, 0,
-                 true);
-#undef ADD_SEARCH_PAT
+  add_search_pattern(&wms->sub_search_pattern, &get_substitute_pattern, true,
+                     search_last_used, search_highlighted);
 
   // Initialize substitute replacement string
   {
@@ -2590,10 +2619,12 @@ static ShaDaWriteResult shada_write(ShaDaWriteDef *const sd_writer,
 
   // Initialize jump list
   const void *jump_iter = NULL;
+  setpcmark();
+  cleanup_jumplist();
   do {
     xfmark_T fm;
-    cleanup_jumplist();
     jump_iter = mark_jumplist_iter(jump_iter, curwin, &fm);
+
     const buf_T *const buf = (fm.fmark.fnum == 0
                               ? NULL
                               : buflist_findnr(fm.fmark.fnum));
diff --git a/test/functional/shada/marks_spec.lua b/test/functional/shada/marks_spec.lua
index b7c0f61f57..36d2c665d7 100644
--- a/test/functional/shada/marks_spec.lua
+++ b/test/functional/shada/marks_spec.lua
@@ -153,6 +153,19 @@ describe('ShaDa support code', function()
     eq(saved, redir_exec('jumps'))
   end)
 
+  it('when dumping jump list also dumps current position', function()
+    nvim_command('edit ' .. testfilename)
+    nvim_command('normal! G')
+    nvim_command('split ' .. testfilename_2)
+    nvim_command('normal! G')
+    nvim_command('wshada')
+    nvim_command('quit')
+    nvim_command('rshada')
+    nvim_command('normal! \15')  -- <C-o>
+    eq(testfilename_2, funcs.bufname('%'))
+    eq({2, 0}, curwinmeths.get_cursor())
+  end)
+
   it('is able to dump and restore jump list with different times (slow!)',
   function()
     nvim_command('edit ' .. testfilename_2)