cscope: db: feat: ability to provide custom script to build DB (#67)

- if db_build_cmd.script == "default" then only primary DB will be built using cscope binary.
- Custom script can be provided.
  - e.g. user script will be called as following -
  - `/user/provided/script -d <db1>::<pre_path1> -d <db2>::<pre_path2> ...`

Author: dhananjaylatkar

README.md

@@ -35,7 +35,12 @@ Heavily inspired by emacs' [xcscope.el](https://github.com/dkogan/xcscope.el).
 - `:Cs db add <space sepatated files>` add db file(s) to cscope search.
 - `:Cs db rm <space sepatated files>` remove db file(s) from cscope search.
 - `:Cs db show` show all db connections.
-- `:Cs db build` (re)builds db for primary db.
+- `:Cs db build` (re)builds db.
+  - If `db_build_cmd.script == "default"` then only primary DB will be built using cscope binary.
+    - e.g. `cscope -f ${db_file} ${db_build_cmd.args}` OR `gtags-cscope ${db_build_cmd.args}`
+  - Custom script can be provided using `db_build_cmd.script`. Example script is [here](https://github.com/dhananjaylatkar/cscope_maps.nvim/pull/67)
+    - e.g. user script will be called as following -
+    - `${db_build_cmd.script} ${db_build_cmd.args} -d <db1>::<pre_path1> -d <db2>::<pre_path2> ...`
 - `vim.g.cscope_maps_statusline_indicator` can be used in statusline to indicate ongoing db build.
 - DB path grammar
   - `db_file::db_pre_path` db_pre_path (prefix path) will be appended to cscope results.
@@ -108,8 +113,8 @@ _cscope_maps_ comes with following defaults:
     qf_window_pos = "bottom", -- "bottom", "right", "left" or "top"
     -- "true" does not open picker for single result, just JUMP
     skip_picker_for_single_result = false, -- "false" or "true"
-    -- these args are directly passed to "cscope -f <db_file> <args>"
-    db_build_cmd_args = { "-bqkv" },
+    -- custom script can be used for db build
+	db_build_cmd = { script = "default", args = { "-bqkv" } },
     -- statusline indicator, default is cscope executable
     statusline_indicator = nil,
     -- try to locate db_file in parent dir(s)
@@ -212,4 +217,3 @@ under cursor
 ```lua
 vim.keymap.set({ "n", "v" }, "<C-c><C-g>", "<cmd>Cs f g<cr>")
 ```
-

doc/cscope_maps.txt

@@ -1,4 +1,4 @@
-*cscope_maps.txt*      For Neovim >= v0.10.0     Last change: 2024 November 01
+*cscope_maps.txt*      For Neovim >= v0.10.0      Last change: 2025 January 12
 
 ==============================================================================
 Table of Contents                              *cscope_maps-table-of-contents*
@@ -54,7 +54,12 @@ CSCOPE DB ~
 - `:Cs db add <space sepatated files>` add db file(s) to cscope search.
 - `:Cs db rm <space sepatated files>` remove db file(s) from cscope search.
 - `:Cs db show` show all db connections.
-- `:Cs db build` (re)builds db for primary db.
+- `:Cs db build` (re)builds db.
+    - If `db_build_cmd.script == "default"` then only primary DB will be built using cscope binary.
+        - e.g. `cscope -f ${db_file} ${db_build_cmd.args}` OR `gtags-cscope ${db_build_cmd.args}`
+    - Custom script can be provided using `db_build_cmd.script`. Example script is here <https://github.com/dhananjaylatkar/cscope_maps.nvim/pull/67>
+        - e.g. user script will be called as following -
+        - `${db_build_cmd.script} ${db_build_cmd.args} -d <db1>::<pre_path1> -d <db2>::<pre_path2> ...`
 - `vim.g.cscope_maps_statusline_indicator` can be used in statusline to indicate ongoing db build.
 - DB path grammar
     - `db_file::db_pre_path` db_pre_path (prefix path) will be appended to cscope results.
@@ -131,8 +136,8 @@ _cscope_maps_ comes with following defaults:
         qf_window_pos = "bottom", -- "bottom", "right", "left" or "top"
         -- "true" does not open picker for single result, just JUMP
         skip_picker_for_single_result = false, -- "false" or "true"
-        -- these args are directly passed to "cscope -f <db_file> <args>"
-        db_build_cmd_args = { "-bqkv" },
+        -- custom script can be used for db build
+        db_build_cmd = { script = "default", args = { "-bqkv" } },
         -- statusline indicator, default is cscope executable
         statusline_indicator = nil,
         -- try to locate db_file in parent dir(s)

lua/cscope/db.lua

@@ -132,4 +132,55 @@ M.print_conns = function()
 	end
 end
 
+---Create command to build DB
+---1. If script is default then use opt.exec
+---2. If custom script is provided then use that with "-d <db>::<pre_path>" args
+M.get_build_cmd = function(opts)
+	local cmd = {}
+
+	if opts.db_build_cmd.script == "default" then
+		if opts.exec == "cscope" then
+			cmd = { "cscope", "-f", M.primary_conn().file }
+		else -- "gtags-cscope"
+			cmd = { "gtags-cscope" }
+		end
+
+		vim.list_extend(cmd, opts.db_build_cmd.args)
+		return cmd
+	end
+
+	-- custom script
+	cmd = { opts.db_build_cmd.script }
+	vim.list_extend(cmd, opts.db_build_cmd.args)
+
+	for _, conn in ipairs(M.conns) do
+		vim.list_extend(cmd, { "-d", string.format("%s::%s", conn.file, conn.pre_path) })
+	end
+
+	return cmd
+end
+
+M.build = function(opts)
+	if vim.g.cscope_maps_statusline_indicator then
+		log.warn("db build is already in progress")
+		return
+	end
+
+	local cmd = M.get_build_cmd(opts)
+
+	local on_exit = function(obj)
+		vim.g.cscope_maps_statusline_indicator = nil
+		if obj.code == 0 then
+			-- print("cscope: [build] out: " .. obj.stdout)
+			print("cscope: database built successfully")
+		else
+			-- print("cscope: [build] out: " .. obj.stderr)
+			print("cscope: database build failed")
+		end
+	end
+
+	vim.g.cscope_maps_statusline_indicator = opts.statusline_indicator or opts.exec
+	vim.system(cmd, { text = true }, on_exit)
+end
+
 return M

lua/cscope/init.lua

@@ -17,7 +17,7 @@ local M = {}
 ---@field qf_window_size? integer
 ---@field qf_window_pos? string
 ---@field skip_picker_for_single_result? boolean
----@field db_build_cmd_args? table
+---@field db_build_cmd? table
 ---@field statusline_indicator? string|nil
 ---@field project_rooter? CsProjectRooterConfig
 M.opts = {
@@ -27,7 +27,7 @@ M.opts = {
 	qf_window_size = 5,
 	qf_window_pos = "bottom",
 	skip_picker_for_single_result = false,
-	db_build_cmd_args = { "-bqkv" },
+	db_build_cmd = { script = "default", args = { "-bqkv" } },
 	statusline_indicator = nil,
 	project_rooter = {
 		enable = false,
@@ -273,63 +273,6 @@ M.cstag = function(symbol)
 	return RC.NO_RESULTS
 end
 
-M.db_build_output = function(err, data)
-	if err then
-		print("cscope: [build] err: " .. err)
-	end
-	if data then
-		print("cscope: [build] out: " .. data)
-	end
-end
-
-M.db_build = function()
-	local stdout = vim.loop.new_pipe(false)
-	local stderr = vim.loop.new_pipe(false)
-	local db_build_cmd_args = vim.tbl_deep_extend("force", M.opts.db_build_cmd_args, {})
-	local cur_path = vim.fn.getcwd()
-	local db_conn = db.primary_conn() -- TODO: extend support to all db conns
-	local db_file = db_conn.file
-	local db_root = utils.get_path_parent(db_file)
-
-	if vim.g.cscope_maps_statusline_indicator then
-		log.warn("db build is already in progress")
-		return
-	end
-
-	if M.opts.exec == "cscope" then
-		table.insert(db_build_cmd_args, "-f")
-		table.insert(db_build_cmd_args, db_file)
-	end
-
-	vim.cmd("cd " .. db_root)
-
-	local handle = nil
-	vim.g.cscope_maps_statusline_indicator = M.opts.statusline_indicator or M.opts.exec
-	handle = vim.loop.spawn(
-		M.opts.exec,
-		{
-			args = db_build_cmd_args,
-			stdio = { nil, stdout, stderr },
-		},
-		vim.schedule_wrap(function(code, _) -- on exit
-			stdout:read_stop()
-			stderr:read_stop()
-			stdout:close()
-			stderr:close()
-			handle:close()
-			if code == 0 then
-				log.info("database built successfully")
-			else
-				log.warn("database build failed")
-			end
-			vim.g.cscope_maps_statusline_indicator = nil
-			vim.cmd("cd " .. cur_path)
-		end)
-	)
-	vim.loop.read_start(stdout, M.db_build_output)
-	vim.loop.read_start(stderr, M.db_build_output)
-end
-
 M.db_update = function(op, files)
 	if op == "a" then
 		for _, f in ipairs(files) do
@@ -402,7 +345,7 @@ M.run = function(args)
 
 		local op = args[2]:sub(1, 1)
 		if op == "b" then
-			M.db_build()
+			db.build(M.opts)
 		elseif op == "a" or op == "r" then
 			-- collect all args
 			local files = {}
@@ -574,6 +517,21 @@ M.setup = function(opts)
 		end
 	end
 
+	if vim.fn.executable(M.opts.db_build_cmd.script) ~= 1 then
+		log.warn("db_build script is not found. Using default")
+		M.opts.db_build_cmd.script = "default"
+	end
+
+	if M.opts.db_build_cmd_args then
+		M.opts.db_build_cmd.args = M.opts.db_build_cmd_args
+		log.warn(
+			string.format(
+				[[db_build_cmd_args is deprecated. Use 'db_build_cmd = { args = %s }']],
+				vim.inspect(M.opts.db_build_cmd_args)
+			)
+		)
+	end
+
 	-- if project rooter is enabled,
 	-- 1. get root of project and update primary conn
 	-- 2. if change_cwd is enabled, change into it (?)