Print evaluation output to buffer (#79)

* Simplify work around cleanup

It's simper if the nrepl keeps track of the connection internal id, which is something it might want to do anyways.

* Fix duplicated call to accessor fn

* Rename local table and local vars

For better expressing their (new) intent.

* Allow supplying connection id or ip-port tuple

* Allow for reverse lookup on connections

* Allow reverse lookup for sessions

* Print input and output text to output window

Only if enabled, will pass through if buffer doesn't exist.

Author: hkupty

lua/acid/connections.lua

@@ -24,33 +24,15 @@ connections.add = function(addr)
   return ulid
 end
 
-connections.remove = function(pwd, addr)
-  -- If removed address is current to a pwd
-  local key = connections.current[pwd]
-  local conn = connections.store[key]
-
-  -- Double-check if address is correct
-  if key ~= nil and conn ~= nil and conn[2] == addr[2] and conn[1] == addr[1] then
-    -- Then remove it from current pwd
-    connections.current[pwd] = nil
-    -- Remove it's definition
-    connections.store[key] = nil
-
-    -- And remove all other addresses that point to it
-    for ix, v in pairs(connections.current) do
-      if v == key then
-        connections.current[ix] = nil
-      end
-    end
-  else
-    -- Else, remove it from the connections if no address points to it
-    for i, v in pairs(connections.store) do
-      if v[2] == addr[2] and v[1] == addr[1] then
-        connections.store[i] = nil
-      end
+connections.remove = function(key)
+  -- Remove all addresses that point to id
+  for ix, v in pairs(connections.current) do
+    if v == key then
+      connections.current[ix] = nil
     end
   end
 
+  connections.store[key] = nil
 end
 
 --- Elects selected connection as primary (thus default) for a certain address
@@ -103,6 +85,16 @@ connections.search = function(pwd)
   return nil
 end
 
+connections.reverse_lookup = function(conn)
+  for k, v in pairs(connections.store) do
+    if v[2] == conn[2] and v[1] == conn[1] then
+      return k
+    end
+  end
+
+  return nil
+end
+
 connections.attempt_get = function(pwd)
   local conn = connections.get(pwd)
   if conn == nil then

lua/acid/core.lua

@@ -3,6 +3,7 @@
 --- low-level connection handler.
 -- @module acid.core
 -- @todo merge with acid and acid.connections
+local output = require("acid.output")
 local connections = require("acid.connections")
 local utils = require("acid.utils")
 local log = require("acid.log")
@@ -12,24 +13,39 @@ local core = {
 }
 
 --- Forward messages to the nrepl and registers the handler.
--- @tparam[opt] {string,string} conn Ip and Port tuple. Will try to get one if nil.
+-- @tparam[opt] {string,string} connection Ip and Port tuple. Will try to get one if nil.
 -- @tparam table obj Payload to be sent to the nrepl.
 -- @tparam function handler Handler function to deal with the response.
-core.send = function(conn, obj, handler)
+core.send = function(connection, obj, handler)
+  local conn, conn_id
   if handler == nil then
     vim.api.nvim_err_writeln("Please provide a handler for that operation.")
     return
   end
 
   local pwd = vim.api.nvim_call_function("getcwd", {})
 
-  conn = conn or connections.attempt_get(pwd)
+  local ctp = type(connection)
+  if ctp == "string" then
+    conn_id = connection
+    conn = connections.store[connection]
+  elseif ctp == "table" then
+    conn = connection
+    conn_id = connections.reverse_lookup(connection)
+  elseif connection == nil then
+    conn_id = connections.peek()
+    conn = connections.store[conn_id]
+  end
 
   if conn == nil then
     log.msg("No active connection to a nrepl session. Aborting")
     return
   end
 
+  if obj.code ~= nil then
+    output.draw(conn_id, {(obj.ns or "") .. "=> " .. obj.code})
+  end
+
   if obj.id == nil then
     obj.id = utils.ulid()
   end

lua/acid/features.lua

@@ -98,6 +98,7 @@ features.eval_expr = function(mode, replace, ns)
     end}))
   else
     midlws = middlewares
+      .output{}
       .print{}
       .clipboard{}
       .virtualtext(coord)

lua/acid/middlewares/output.lua

@@ -0,0 +1,43 @@
+-- luacheck: globals vim
+local do_print = {}
+local output = require("acid.output")
+local sessions = require("acid.sessions")
+local utils = require("acid.utils")
+local log = require("acid.log")
+
+output.middleware = function(config)
+  return function(middleware)
+    return function(data)
+      local session = data.session
+      local conn_id = sessions.reverse_lookup(session)
+
+      if data.out ~= nil then
+        local out = {}
+        data.out:gsub("[^\n]+", function(dt) table.insert(out, dt) end)
+        output.draw(conn_id, out)
+      end
+      if data.value ~= nil then
+        output.draw(conn_id, {"=> " .. data.value})
+      end
+      if data.ex ~= nil then
+        output.draw(conn_id, {"!! " .. data.ex})
+      end
+      if data.err ~= nil then
+        local out = {}
+        data.err:gsub("[^\n]+", function(dt) table.insert(out, "!! " .. dt) end)
+        output.draw(conn_id, out)
+      end
+
+      if config.accessor ~= nil then
+        local msg = config.accessor(data)
+        if msg ~= nil and msg ~= "" then
+          output.draw(conn_id, {"<> " .. msg})
+        end
+      end
+
+      return middleware(data)
+    end
+  end
+end
+
+return output

lua/acid/middlewares/print.lua

@@ -22,7 +22,7 @@ do_print.middleware = function(config)
       if config.accessor ~= nil then
         local msg = config.accessor(data)
         if msg ~= nil and msg ~= "" then
-          log.msg(config.accessor(data))
+          log.msg(msg)
         end
       end
 

lua/acid/nrepl.lua

@@ -6,8 +6,9 @@ local nvim = vim.api
 local log = require("acid.log")
 local utils = require("acid.utils")
 local connections = require("acid.connections")
+local output = require("acid.output")
 
-local pending = {}
+local job_mapping = {}
 local nrepl = {}
 
 local deps = {
@@ -104,6 +105,7 @@ nrepl.default_middlewares = {'nrepl/nrepl', 'cider/cider-nrepl', 'refactor-nrepl
 -- @tparam[opt] string obj.connect -c parameter for the nrepl process
 -- @tparam[opt] string obj.bind -b parameter for the nrepl process
 -- @tparam[opt] boolean obj.skip_autocmd don't fire an autocmd after starting this repl
+-- @tparam[opt] boolean obj.disable_output_capture disables output capturing.
 -- @treturn boolean Whether it was possible to spawn a nrepl process
 nrepl.start = function(obj)
   local pwd = obj.pwd or vim.api.nvim_call_function("getcwd", {})
@@ -148,25 +150,23 @@ nrepl.start = function(obj)
      addr = conn
    }
 
-  local ix = connections.add(conn)
+  local conn_id = connections.add(conn)
 
-  pending[ret] = {pwd = pwd, ix = ix}
+  nrepl.cache[pwd].id = conn_id
+
+  job_mapping[ret] = {pwd = pwd, conn = conn_id, init = false}
+  if obj.disable_output_capture == false then
+    output.buffer(conn_id)
+  end
   return true
 end
 
 --- Stops a nrepl process managed by acid
 -- @tparam table obj Configuration for the nrepl process to be stopped
 -- @tparam string obj.pwd Path where the nrepl process was started
 nrepl.stop = function(obj)
-  local pwd = obj.pwd
-
-  if not utils.ends_with(pwd, "/") then
-    pwd = pwd .. "/"
-  end
-
-  nvim.nvim_call_function("jobstop", {nrepl.cache[pwd].job})
-  connections.unselect(pwd)
-  connections.remove(pwd, nrepl.cache[pwd].addr)
+  nvim.nvim_call_function("jobstop", {nrepl.cache[obj.pwd].job})
+  connections.remove(nrepl.cache[obj.pwd].id)
   nrepl.cache[obj.pwd] = nil
 end
 
@@ -185,21 +185,25 @@ nrepl.handle = {
   _store = {},
   stdout = function(dt, ch)
     nrepl.handle._store[ch] = nrepl.handle._store[ch] or {}
-    if pending[ch] ~= nil then
+    local job = job_mapping[ch]
+
+    if not job.init then
       for _, ln in ipairs(dt) do
         if string.sub(ln, 1, 20) == "nREPL server started" then
-          local opts = pending[ch]
           local port = ln:match("%d+")
-          connections.store[opts.ix][2] = port
-          connections.select(opts.pwd, opts.ix)
-          pending[ch] = nil
-          if not nrepl.cache[opts.pwd].skip_autocmd then
+          connections.store[job.conn][2] = port
+          connections.select(job.pwd, job.conn)
+          job_mapping[ch].init = true
+          if not nrepl.cache[job.pwd].skip_autocmd then
             log.msg("Connected on port", tostring(port))
             vim.api.nvim_command("doautocmd User AcidConnected")
           end
+          break
         end
       end
     end
+
+    output.draw(job.conn, dt)
     table.insert(nrepl.handle._store[ch], dt)
   end,
   stderr = function(dt, ch)

lua/acid/output.lua

@@ -0,0 +1,68 @@
+-- luacheck: globals vim
+
+local output = {}
+
+local location = function(opts)
+  local width = vim.api.nvim_get_option("columns")
+  local height = vim.api.nvim_get_option("lines")
+  return {
+    relative = "editor",
+    width = opts.width or 60,
+    height = height,
+    row = 0,
+    focusable = false,
+    col = width - (opts.width or 60)
+  }
+end
+
+output.conn_to_buf = {}
+
+output.buffer = function(conn)
+  local buf = output.conn_to_buf[conn]
+  if buf == nil then
+    buf = vim.api.nvim_create_buf(false, true)
+    vim.api.nvim_buf_set_option(buf, "bufhidden", "wipe")
+    output.conn_to_buf[conn] = buf
+  end
+
+  return buf
+end
+
+output.window = function(conn, opts)
+  local buf =  output.buffer(conn)
+  local winnr = vim.fn.bufwinnr(buf)
+  local winid
+
+  if winnr == -1 then
+    winid = vim.api.nvim_open_win(buf, true, location(opts or {}))
+    vim.api.nvim_win_set_option(winid, "breakindent", true)
+    vim.api.nvim_win_set_option(winid, "number", false)
+    vim.api.nvim_win_set_option(winid, "relativenumber", false)
+    vim.api.nvim_win_set_option(winid, "fillchars", "eob: ")
+  else
+    winid = vim.fn.win_getid()
+  end
+  vim.api.nvim_set_current_win(winid)
+end
+
+output.close_window = function(conn, opts)
+  local buf = output.buffer(conn)
+  local winnr = vim.fn.bufwinnr(buf)
+
+  if winnr ~= -1 then
+    local winid = vim.fn.win_getid()
+    vim.api.nvim_win_close(winid, true)
+  end
+end
+
+
+output.draw = function(conn, lines)
+  local buf = output.conn_to_buf[conn]
+  if buf == nil then
+    return
+  end
+
+  vim.api.nvim_buf_set_lines(buf, -1, -1, false, lines)
+end
+
+return output

lua/acid/sessions.lua

@@ -47,5 +47,15 @@ sessions.new_session = function(connection_ix)
   core.send(conn, clone.payload(), handler)
 end
 
+sessions.reverse_lookup = function(session_id)
+  for k, v in pairs(sessions.store) do
+    for _, v2 in ipairs(v.list) do
+      if v2 == session_id then
+        return k
+      end
+    end
+  end
+end
+
 
 return sessions