ui: introduce horizontal layouts

this commit introduces two new layout options:
"top", "bottom".

when utilizing these layout options more space is available for details
about the symbol.

we now use this space to show the file the symbol is defined in.

a few UI tweaks are made as well for aesthetics.

closes #6

Signed-off-by: ldelossa <louis.delos@gmail.com>

Author: ldelossa

doc/calltree.txt

@@ -128,13 +128,13 @@ This does not stop you from mapping *calltree-commands* to your own liking.
 
 The default buffer mapping is set via lua and should feel familiar if you use vim folds.
 
-    local opts = {silent=true}
-    vim.api.nvim_buf_set_keymap(M.buffer_handle, "n", "zo", ":CTExpand<CR>", opts)
-    vim.api.nvim_buf_set_keymap(M.buffer_handle, "n", "zc", ":CTCollapse<CR>", opts)
-    vim.api.nvim_buf_set_keymap(M.buffer_handle, "n", "<CR>", ":CTJump<CR>", opts)
-    vim.api.nvim_buf_set_keymap(M.buffer_handle, "n", "f", ":CTFocus<CR>", opts)
-    vim.api.nvim_buf_set_keymap(M.buffer_handle, "n", "i", ":CTHover<CR>", opts)
-    vim.api.nvim_buf_set_keymap(M.buffer_handle, "n", "s", ":CTSwitch<CR>", opts)
+    vim.api.nvim_buf_set_keymap(buffer_handle, "n", "zo", ":CTExpand<CR>", opts)
+    vim.api.nvim_buf_set_keymap(buffer_handle, "n", "zc", ":CTCollapse<CR>", opts)
+    vim.api.nvim_buf_set_keymap(buffer_handle, "n", "<CR>", ":CTJump<CR>", opts)
+    vim.api.nvim_buf_set_keymap(buffer_handle, "n", "f", ":CTFocus<CR>", opts)
+    vim.api.nvim_buf_set_keymap(buffer_handle, "n", "i", ":CTHover<CR>", opts)
+    vim.api.nvim_buf_set_keymap(buffer_handle, "n", "s", ":CTSwitch<CR>", opts)
+    vim.api.nvim_buf_set_keymap(buffer_handle, "n", "?", ":lua require('calltree.ui').help(true)<CR>", opts)
 
 ====================================================================================
 CONFIG                                                             *calltree-config*
@@ -148,6 +148,12 @@ The config table is described below:
         -- where the calltree ui will spawn
         -- "left" (default) - Spawn calltree as the left most vertical window.
         -- "right"          - Spawn calltree as the left most vertical window.
+        -- "top"            - Spawn calltree as the bottom most horizontal window
+        --                    more details about the symbol will be shown with this
+        --                    layout.
+        -- "bottom"         - Spawn calltree as the top most horizontal window
+        --                    more details about the symbol will be shown with this
+        --                    layout.
         layout = "left",
         -- the initial size of the calltree ui
         -- int              - An integer used in the initial "resize" command for

lua/calltree.lua

@@ -88,7 +88,11 @@ function M.setup(user_config)
     end
 
     -- sanatize the config
-    if (M.config.layout ~= "left") and (M.config.layout ~= "left") then
+    if (M.config.layout ~= "left") 
+        and (M.config.layout ~= "right") 
+        and (M.config.layout ~= "top")
+        and (M.config.layout ~= "bottom") 
+    then
         M.config.layout = "left"
     end
     if M.config.layout_size < 10 then

lua/calltree/lsp/util.lua

@@ -10,4 +10,16 @@ M.multi_client_request = function(clients, method, params, handler, bufnr)
     end
 end
 
+function M.relative_path_from_uri(uri) 
+    local cwd = vim.fn.getcwd()
+    local uri_path = vim.fn.substitute(uri, "file://", "", "")
+    local idx = vim.fn.stridx(uri_path, cwd)
+    if idx == -1 then
+        -- we can't resolve a relative path, just give the
+        -- full path to the file.
+        return uri_path, false
+    end
+    return vim.fn.substitute(uri_path, cwd .. "/", "", ""), true
+end
+
 return M

lua/calltree/ui/buffer.lua

@@ -51,7 +51,7 @@ function M._setup_buffer(direction, buffer_handle)
     vim.api.nvim_buf_set_keymap(buffer_handle, "n", "zc", ":CTCollapse<CR>", opts)
     vim.api.nvim_buf_set_keymap(buffer_handle, "n", "<CR>", ":CTJump<CR>", opts)
     vim.api.nvim_buf_set_keymap(buffer_handle, "n", "f", ":CTFocus<CR>", opts)
-    vim.api.nvim_buf_set_keymap(buffer_handle, "n", "h", ":CTHover<CR>", opts)
+    vim.api.nvim_buf_set_keymap(buffer_handle, "n", "i", ":CTHover<CR>", opts)
     vim.api.nvim_buf_set_keymap(buffer_handle, "n", "s", ":CTSwitch<CR>", opts)
     vim.api.nvim_buf_set_keymap(buffer_handle, "n", "?", ":lua require('calltree.ui').help(true)<CR>", opts)
 

lua/calltree/ui/jumps.lua

@@ -23,14 +23,22 @@ function M.jump_neighbor(location, layout, node)
     local cur_win = vim.api.nvim_get_current_win()
     if layout == "left" then
         vim.cmd('wincmd l')
-    else
+    elseif layout == "right" then
         vim.cmd('wincmd h')
+    elseif layout == "top" then
+        vim.cmd('wincmd j')
+    elseif layout == "bottom" then
+        vim.cmd('wincmd k')
     end
     if cur_win == vim.api.nvim_get_current_win() then
         if layout == "left" then
             vim.cmd("botright vsplit")
-        else
+        elseif layout == "right" then
             vim.cmd("topleft vsplit")
+        elseif layout == "top" then
+            vim.cmd("botleft split")
+        elseif layout == "bottom" then
+            vim.cmd("botleft split")
         end
     end
     vim.lsp.util.jump_to_location(location)

lua/calltree/ui/marshal.lua

@@ -1,11 +1,13 @@
 local tree = require('calltree.tree')
 local ct = require('calltree')
+local lsp_util = require('calltree.lsp.util')
 
 local M = {}
 
 M.glyphs = {
     expanded= "▼",
-    collapsed= "▶"
+    collapsed= "▶",
+    separator = "•"
 }
 
 -- marshal_node takes a node and marshals
@@ -32,12 +34,26 @@ function M.marshal_node(node)
         str = str .. " "
     end
 
-    str = str .. glyph .. " " .. node.name .. " "
+    -- ▶ Func1
+    str = str .. glyph .. " " .. node.name
     if ct.config.icons ~= "none" then
-        str = str .. ct.active_icon_set[kind]
+        -- ▶ Func1[]
+        str = str .. "[" .. ct.active_icon_set[kind] .. "]" .. " "
     else
-        str = str .. "•" .. " " .. kind
+        -- ▶ Func1 • [Function]
+        str = str .. M.glyphs.separator .. " " .. "[" .. kind .. "]" .. " "
     end
+
+    if ct.config.layout == "bottom" or 
+        ct.config.layout == "top" then
+        -- now we got all the room in the world, add detail
+        path = lsp_util.relative_path_from_uri(node.call_hierarchy_obj.uri)
+        -- ▶ Func1[] • relative/path/to/file
+        -- or
+        -- ▶ Func1 • [Function] • relative/path/to/file
+        str = str .. M.glyphs.separator .. " " .. path
+    end
+
     return str
 end
 
@@ -61,7 +77,7 @@ function M.marshal_line(line)
     -- just your normal string parsing to carve out the symbol portion
     -- of the line.
     local symbol_and_type = vim.fn.strcharpart(line, depth+2)
-    local symbol_end_idx = vim.fn.stridx(symbol_and_type, " ")
+    local symbol_end_idx = vim.fn.stridx(symbol_and_type, "[")
     local symbol = vim.fn.strpart(symbol_and_type, 0, symbol_end_idx)
 
     for _, node in ipairs(tree.depth_table[depth]) do

lua/calltree/ui/window.lua

@@ -35,13 +35,27 @@ function M._setup_window(buf_handle, win_handle, win_tabpage, config)
 
         if config.layout == "left" then
             vim.cmd("topleft vsplit")
-        else
+            vim.cmd("vertical resize " ..
+                        config.layout_size)
+        elseif config.layout == "right" then
             vim.cmd("botright vsplit")
+            vim.cmd("vertical resize " ..
+                        config.layout_size)
+        elseif config.layout == "top" then
+            vim.cmd("topleft split")
+            vim.cmd("resize " ..
+                        config.layout_size)
+        elseif config.layout == "bottom" then
+            vim.cmd("botright split")
+            vim.cmd("resize " ..
+                        config.layout_size)
+        else
+            -- we should never get here but what ever.
+            vim.cmd("topleft vsplit")
+            vim.cmd("vertical resize " ..
+                        config.layout_size)
         end
 
-        vim.cmd("vertical resize " ..
-                    config.layout_size)
-
         win_handle = vim.api.nvim_get_current_win()
         win_tabpage = vim.api.nvim_win_get_tabpage(win_handle)
         vim.api.nvim_win_set_buf(win_handle, buf_handle)