Merge pull request #3 from desdic/20240227func

feature: Added function to make it easier to make a UI

Author: desdic

README.md

@@ -127,29 +127,33 @@ Correct. I'm not planning on creating a UI but if you really want one you can ea
 Example using telescope
 
 ```lua
+    local mindex = 0
+    local generate_finder = function()
+        mindex = 0
+        return require("telescope.finders").new_table({
+            results = require("marlin").get_indexes(),
+            entry_maker = function(entry)
+                mindex = mindex + 1
+                return {
+                    value = entry,
+                    ordinal = mindex .. ":" .. entry.filename,
+                    lnum = entry.row,
+                    col = entry.col + 1,
+                    filename = entry.filename,
+                    display = mindex .. ":" .. entry.filename .. ":" .. entry.row .. ":" .. entry.col,
+                }
+            end,
+        })
+    end
+
     vim.keymap.set("n", "<Leader>fx", function()
         local conf = require("telescope.config").values
         local action_state = require("telescope.actions.state")
-        local results = require("marlin").get_indexes()
 
-        local index = 0
         require("telescope.pickers")
             .new({}, {
                 prompt_title = "Marlin",
-                finder = require("telescope.finders").new_table({
-                    results = results,
-                    entry_maker = function(entry)
-                        index = index + 1
-                        return {
-                            value = entry,
-                            ordinal = index ..":" .. entry.filename,
-                            lnum = entry.row,
-                            col = entry.col + 1,
-                            filename = entry.filename,
-                            display = index .. ":" .. entry.filename .. ":" .. entry.row .. ":" .. entry.col,
-                        }
-                    end,
-                }),
+                finder = generate_finder(),
                 previewer = conf.grep_previewer({}),
                 sorter = conf.generic_sorter({}),
                 attach_mappings = function(_, map)
@@ -159,6 +163,18 @@ Example using telescope
                             require("marlin").remove(selection.filename)
                         end)
                     end)
+                    map("i", "+", function(bufnr)
+                        local current_picker = action_state.get_current_picker(bufnr)
+                        local selection = current_picker:get_selection()
+                        require("marlin").move_up(selection.filename)
+                        current_picker:refresh(generate_finder(), {})
+                    end)
+                    map("i", "-", function(bufnr)
+                        local current_picker = action_state.get_current_picker(bufnr)
+                        local selection = current_picker:get_selection()
+                        require("marlin").move_down(selection.filename)
+                        current_picker:refresh(generate_finder(), {})
+                    end)
                     return true
                 end,
             })

lua/marlin/init.lua

@@ -28,9 +28,9 @@
 ---@field add fun(filename?: string): nil -- add file
 ---@field cur_index fun(): number -- get index of current file
 ---@field get_indexes fun(): marlin.file[] -- get indexes
----@field move fun(table: marlin.file[], direction: marlin.movefun): nil
----@field move_down fun(): nil -- move index down
----@field move_up fun(): nil -- move index up
+---@field move fun(table: marlin.file[], direction: marlin.movefun, filename?: string): nil
+---@field move_down fun(filename?: string): nil -- move index down
+---@field move_up fun(filename?: string): nil -- move index up
 ---@field num_indexes fun(): number -- get number of indexes
 ---@field open fun(index: number, opts: any?): nil -- open index
 ---@field open_all fun(): nil
@@ -182,17 +182,34 @@ marlin.get_indexes = function()
     return marlin.project_files["files"]
 end
 
+--- Return index of a filename
+---
+---@param filename string
+---
+---@return number|nil returns index of file or nil
+---
+---@usage `require("marlin").get_fileindex("/full/path/to/filename")`
+marlin.get_fileindex = function(filename)
+    if filename then
+        for idx, data in ipairs(marlin.project_files["files"]) do
+            if data["filename"] == filename then
+                return idx
+            end
+        end
+    end
+    return nil
+end
 --- Generic move function for moving indexes
 ---
 ---@param table string[] index table
 ---@param direction marlin.movefun
-marlin.move = function(table, direction)
+marlin.move = function(table, direction, filename)
     local indexes = marlin.num_indexes()
     if indexes < 2 then
         return
     end
 
-    local cur_index = marlin.cur_index()
+    local cur_index = marlin.get_fileindex(filename) or marlin.cur_index()
     direction(table, cur_index, indexes)
 end
 
@@ -217,15 +234,15 @@ end
 --- Move current index down
 ---
 ---@usage `require('marlin').move_down()`
-marlin.move_down = function()
-    marlin.move(marlin.project_files["files"], down)
+marlin.move_down = function(filename)
+    marlin.move(marlin.project_files["files"], down, filename)
 end
 
 --- Move current index up
 ---
 ---@usage `require('marlin').move_up()`
-marlin.move_up = function()
-    marlin.move(marlin.project_files["files"], up)
+marlin.move_up = function(filename)
+    marlin.move(marlin.project_files["files"], up, filename)
 end
 
 --- Return number of indexes for current project