Toggleterm: improve focusing and scrolling capabilities (#250)

* toggleterm: add scroll_on_error

add the option to only scroll when the operation failed. Together with
'auto_scroll = false' this is a nice alternative.

update the documentation for auto_scroll as it was slightly incorrect.
On long lasting operations you can notice that it scrolls an new input
received.

* toggleterm: add auto_focus

default it to true (this was the behavior all the time) but now it's
possible to disable it which would let the cursor stay in the editor.

* toggleterm: add focus_on_error

An addition similar to scroll_on_error. This lets the user select
auto_scroll = false and then the terminal will only get the focus when
an error occurred.

* dap: add initCommands

Author: deeedob

lua/cmake-tools/const.lua

@@ -41,7 +41,10 @@ local const = {
       toggleterm = {
         direction = "float", -- 'vertical' | 'horizontal' | 'tab' | 'float'
         close_on_exit = false, -- whether close the terminal when exit
-        auto_scroll = true, -- whether auto scroll to the bottom
+        auto_scroll = true, -- auto scroll on new input
+        scroll_on_error = false, -- scroll to bottom on error
+        auto_focus = true, -- auto focus the terminal on activation
+        focus_on_error = false, -- focus on error
         singleton = true, -- single instance, autocloses the opened one, if present
       },
       overseer = {
@@ -85,7 +88,10 @@ local const = {
       toggleterm = {
         direction = "float", -- 'vertical' | 'horizontal' | 'tab' | 'float'
         close_on_exit = false, -- whether close the terminal when exit
-        auto_scroll = true, -- whether auto scroll to the bottom
+        auto_scroll = true, -- auto scroll on new input
+        scroll_on_error = false, -- scroll to bottom on error
+        auto_focus = true, -- auto focus the terminal on activation
+        focus_on_error = false, -- focus on error
         singleton = true, -- single instance, autocloses the opened one, if present
       },
       overseer = {

lua/cmake-tools/init.lua

@@ -1386,6 +1386,20 @@ function cmake.register_dap_function()
         end)
       end
 
+      local initCmds = function()
+        local commands = {}
+        local sources = { vim.env.HOME .. "/.lldbinit", vim.fn.getcwd() .. "/.lldbinit" }
+        for idx, source in ipairs(sources) do
+          local file = io.open(source, "r")
+          if file then
+            local command = "command source " .. source
+            table.insert(commands, command)
+            file:close()
+          end
+        end
+        return commands
+      end
+
       if opt.target then
         -- explicit target requested. use that instead of the configured one
         return cmake.build({ target = opt.target }, function()
@@ -1397,6 +1411,7 @@ function cmake.register_dap_function()
             cwd = cmake.get_launch_path(opt.target),
             args = opt.args and opt.args or config.target_settings[opt.target].args,
             env = env,
+            initCommands = initCmds,
           }
           -- close cmake console
           cmake.close_executor()
@@ -1436,6 +1451,7 @@ function cmake.register_dap_function()
                 cwd = cmake.get_launch_path(cmake.get_launch_target()),
                 args = cmake:get_launch_args(),
                 env = env,
+                initCommands = initCmds,
               }
               -- close cmake console
               cmake.close_executor()

lua/cmake-tools/toggleterm.lua

@@ -67,15 +67,32 @@ function _toggleterm.run(cmd, env_script, env, args, cwd, opts, on_exit, on_outp
       on_output(data)
     end, -- callback for processing output on stdout
     on_stderr = function(t, job, data, name)
+      if opts.scroll_on_error then
+        _toggleterm.term:scroll_bottom()
+      end
       on_output(nil, data)
     end, -- callback for processing output on stderr
     on_exit = function(t, job, exit_code, name)
       on_exit(exit_code)
+      if exit_code ~= 0 then -- operation failed
+        if opts.scroll_on_error then
+          _toggleterm.term:scroll_bottom()
+        end
+        if opts.focus_on_error then
+          vim.cmd("wincmd p")
+        end
+      end
       _toggleterm.chan_id = nil
       _toggleterm.cmd = nil
     end, -- function to run when terminal process exits
   })
-  _toggleterm.term:toggle()
+  if not _toggleterm.term:is_open() then
+    _toggleterm.term:open()
+    if not opts.auto_focus then -- focus back on editor
+      vim.cmd("wincmd p")
+      vim.cmd("stopinsert!")
+    end
+  end
   _toggleterm.chan_id = _toggleterm.term.job_id
 end