feat(actions): Return context data from the conflict nav actions

The conflict navigation actions now return relevant data, like:
  - The total number of conflicts
  - The index of the current conflict
  - The content of the current conflict
  - A list of all conflicts

For more info, see |diffview-actions-jumpto_conflict|.

(fixes #265)

Author: sindrets

doc/diffview.txt

@@ -859,6 +859,23 @@ goto_file_tab                                   *diffview-actions-goto_file_tab*
         |diffview-file-inference| for details on how the file target is
         determined.
 
+jumpto_conflict({num}, {use_delta})             *diffview-actions-jumpto_conflict*
+        Contexts: `diff_view`, `file_panel`
+
+        Jump to a conflict marker in the current file.
+
+        Parameters: ~
+            {num} (integer)
+                The 1-based index of the conflict to jump to.
+            {use_delta} (boolean)
+                If true: treat {num} like a relative offset from the current
+                cursor position. I.e. `1` would jump one conflict forward, `-2`
+                would jump 2 conflicts backwards.
+
+        Return: ~
+            If the current file contains any conflicts, the action returns a
+            |diffview.ConflictCount| table.
+
 listing_style                                   *diffview-actions-listing_style*
         Contexts: `file_panel`
 
@@ -870,6 +887,10 @@ next_conflict                                   *diffview-actions-next_conflict*
 
         Moves the cursor to the next conflict marker in the current file.
 
+        Return: ~
+            If the current file contains any conflicts, the action returns a
+            |diffview.ConflictCount| table.
+
 next_entry                                      *diffview-actions-next_entry*
         Contexts: `view`, `panel`
 
@@ -902,6 +923,10 @@ prev_conflict                                   *diffview-actions-prev_conflict*
 
         Moves the cursor to the previous conflict marker in the current file.
 
+        Return: ~
+            If the current file contains any conflicts, the action returns a
+            |diffview.ConflictCount| table.
+
 prev_entry                                      *diffview-actions-prev_entry*
         Contexts: `view`, `panel`
 
@@ -1007,6 +1032,7 @@ actions:
 
         • |diffview-actions-focus_entry|
         • |diffview-actions-goto_file_edit|
+        • |diffview-actions-jumpto_conflict|
         • |diffview-actions-view_windo|
 
 USER AUTOCOMMANDS                               *diffview-user-autocmds*
@@ -1257,7 +1283,7 @@ CDiffView                                       *diffview.api.views.diff.diff_vi
 
 FileDict                                        *diffview.git.FileDict*
 
-        Fields:~
+        Fields: ~
             {working} (FileData[])
             {staged}  (FileData[])
             {conflicting} (FileData[])
@@ -1310,7 +1336,7 @@ LogOptions                                      *diffview.git.LogOptions*
 
         Table controlling the options passed to git-log.
 
-        Fields:~
+        Fields: ~
             NOTE: All these options are described in far more detail in the
             man page for git-log. See `:Man git-log(1)` for more information.
 
@@ -1389,5 +1415,20 @@ LogOptions                                      *diffview.git.LogOptions*
                 the specified pattern (extended regular expression) in a
                 file.
 
+ConflictCount                          *diffview.ConflictCount*
+
+        Fields: ~
+            {total} (integer)
+                The total number of conflicts in the current file.
+
+            {current} (integer)
+                The index of the current conflict.
+
+            {cur_conflict} (table?)
+                The current conflict, if the cursor is currently in a conflict
+                region.
+
+            {conflicts} (table[])
+                List of all conflicts in the current file.
 
  vim:tw=78:ts=8:ft=help:norl:

lua/diffview/actions.lua

@@ -157,8 +157,16 @@ function M.goto_file_tab()
   end
 end
 
----Jump to the next merge conflict marker.
-function M.next_conflict()
+---@class diffview.ConflictCount
+---@field total integer
+---@field current integer
+---@field cur_conflict? ConflictRegion
+---@field conflicts ConflictRegion[]
+
+---@param num integer
+---@param use_delta? boolean
+---@return diffview.ConflictCount?
+function M.jumpto_conflict(num, use_delta)
   local view = lib.get_current_view()
 
   if view and view:instanceof(StandardView.__get()) then
@@ -167,13 +175,29 @@ function M.next_conflict()
     local curfile = main.file
 
     if main:is_valid() and curfile:is_valid() then
-      local conflicts, _, cur_idx = vcs_utils.parse_conflicts(
+      local next_idx
+      local conflicts, cur, cur_idx = vcs_utils.parse_conflicts(
         api.nvim_buf_get_lines(curfile.bufnr, 0, -1, false),
         main.id
       )
 
       if #conflicts > 0 then
-        local next_idx = math.min(cur_idx, #conflicts) % #conflicts + 1
+        if not use_delta then
+          next_idx = utils.clamp(num, 1, #conflicts)
+        else
+          local delta = num
+
+          if not cur and delta < 0 and cur_idx <= #conflicts then
+            delta = delta + 1
+          end
+
+          if (delta < 0 and cur_idx < 1) or (delta > 0 and cur_idx > #conflicts) then
+            cur_idx = utils.clamp(cur_idx, 1, #conflicts)
+          end
+
+          next_idx = (cur_idx + delta - 1) % #conflicts + 1
+        end
+
         local next_conflict = conflicts[next_idx]
         local curwin = api.nvim_get_current_win()
 
@@ -183,40 +207,28 @@ function M.next_conflict()
         end)
 
         api.nvim_echo({{ ("Conflict [%d/%d]"):format(next_idx, #conflicts) }}, false, {})
+
+        return {
+          total = #conflicts,
+          current = next_idx,
+          cur_conflict = next_conflict,
+          conflicts = conflicts,
+        }
       end
     end
   end
 end
 
+---Jump to the next merge conflict marker.
+---@return diffview.ConflictCount?
+function M.next_conflict()
+  return M.jumpto_conflict(1, true)
+end
+
 ---Jump to the previous merge conflict marker.
+---@return diffview.ConflictCount?
 function M.prev_conflict()
-  local view = lib.get_current_view()
-
-  if view and view:instanceof(StandardView.__get()) then
-    ---@cast view StandardView
-    local main = view.cur_layout:get_main_win()
-    local curfile = main.file
-
-    if main:is_valid() and curfile:is_valid() then
-      local conflicts, _, cur_idx = vcs_utils.parse_conflicts(
-        api.nvim_buf_get_lines(curfile.bufnr, 0, -1, false),
-        main.id
-      )
-
-      if #conflicts > 0 then
-        local prev_idx = (math.max(cur_idx, 1) - 2) % #conflicts + 1
-        local prev_conflict = conflicts[prev_idx]
-        local curwin = api.nvim_get_current_win()
-
-        api.nvim_win_call(main.id, function()
-          api.nvim_win_set_cursor(main.id, { prev_conflict.first, 0 })
-          if curwin ~= main.id then view.cur_layout:sync_scroll() end
-        end)
-
-        api.nvim_echo({{ ("Conflict [%d/%d]"):format(prev_idx, #conflicts) }}, false, {})
-      end
-    end
-  end
+  return M.jumpto_conflict(-1, true)
 end
 
 ---Execute `cmd` for each target window in the current view. If no targets