Refactor: Redraw as-needed (#45)

* Implement as-needed redraw

* Run lua-format

* Fix missing case for setting timer_going

* Make redraw timing more precise

Author: wbthomason

lua/lsp-status.lua

@@ -7,7 +7,7 @@ local default_config = {
   indicator_info = '🛈',
   indicator_hint = '❗',
   indicator_ok = '',
-  spinner_frames = { '⣾', '⣽', '⣻', '⢿', '⡿', '⣟', '⣯', '⣷' },
+  spinner_frames = {'⣾', '⣽', '⣻', '⢿', '⡿', '⣟', '⣯', '⣷'},
   status_symbol = ' 🇻',
   select_symbol = nil,
   update_interval = 100
@@ -19,7 +19,7 @@ local messages = {}
 -- Diagnostics
 --- Get all diagnostics for the current buffer.
 --- Convenience function to retrieve all diagnostic counts for the current buffer.
---@returns `{ 'Error': error_count, 'Warning': warning_count', 'Info': info_count, 'Hint': hint_count `}
+-- @returns `{ 'Error': error_count, 'Warning': warning_count', 'Info': info_count, 'Hint': hint_count `}
 local function diagnostics() -- luacheck: no unused
   error() -- Stub for docs
 end
@@ -32,16 +32,13 @@ local messaging = require('lsp-status/messaging')
 -- LSP extensions
 local pyls_ms = require('lsp-status/extensions/pyls_ms')
 local clangd = require('lsp-status/extensions/clangd')
-local extension_callbacks = {
-  pyls_ms = pyls_ms,
-  clangd = clangd
-}
+local extension_callbacks = {pyls_ms = pyls_ms, clangd = clangd}
 
 -- Find current enclosing function
 local current_function = require('lsp-status/current_function')
 
 -- Out-of-the-box statusline component
-local timer = require('lsp-status/timer')
+local redraw = require('lsp-status/redraw')
 local statusline = require('lsp-status/statusline')
 
 --- Configure lsp-status.nvim.
@@ -59,7 +56,7 @@ local statusline = require('lsp-status/statusline')
 --- - `spinner_frames`: Animation frames for progress spinner in `status`. Default: { '⣾', '⣽', '⣻', '⢿', '⡿', '⣟', '⣯', '⣷' },
 --- - `status_symbol`: Symbol to start the statusline segment in `status`. Default: ' 🇻',
 ---
---@param config: (required, table) Table of values; keys are as listed above. Accept defaults by
+-- @param config: (required, table) Table of values; keys are as listed above. Accept defaults by
 --- omitting the relevant key.
 local function config(user_config)
   _config = vim.tbl_extend('keep', user_config, _config, default_config)
@@ -68,7 +65,7 @@ local function config(user_config)
   messaging._init(messages, _config)
   if _config.current_function then current_function._init(messages, _config) end
   statusline._init(messages, _config)
-  timer._init(messages, _config)
+  redraw._init(messages, _config)
   statusline = vim.tbl_extend('keep', statusline, statusline._get_component_functions())
 end
 
@@ -77,25 +74,22 @@ end
 --- registers the server with `lsp-status` for progress message handling and current function
 --- updating
 ---
---@param client: (required, vim.lsp.client)
+-- @param client: (required, vim.lsp.client)
 local function on_attach(client)
   -- Register the client for messages
   messaging.register_client(client.id, client.name)
   vim.api.nvim_command('augroup lsp_aucmds')
   vim.api.nvim_command('au! * <buffer>')
-  vim.api.nvim_command('au User LspDiagnosticsChanged let g:lsp_status_redraw = v:true')
+  vim.api.nvim_command('au User LspDiagnosticsChanged lua require("lsp-status/redraw").redraw()')
 
   -- If the client is a documentSymbolProvider, set up an autocommand
   -- to update the containing symbol
   if _config.current_function and client.resolved_capabilities.document_symbol then
     vim.api.nvim_command(
-      'au CursorHold <buffer> lua require("lsp-status").update_current_function()'
-    )
+      'au CursorHold <buffer> lua require("lsp-status").update_current_function()')
   end
 
   vim.api.nvim_command('augroup END')
-
-  timer.register_timer()
 end
 
 config(_config)
@@ -130,7 +124,7 @@ end
 --- Normal messages are tables of the form
 --- `{ name = Server name, content = Message contents }`
 ---
---@returns list of messages
+-- @returns list of messages
 local function messages() -- luacheck: no unused
   error()
 end
@@ -144,8 +138,8 @@ end
 --- Register a new server to receive messages.
 --- Generally, you don't need to call this manually - `on_attach` sets it up for you
 ---
---@param id: (required, number) Client ID
---@param name: (required, string) Client name
+-- @param id: (required, number) Client ID
+-- @param name: (required, string) Client name
 local function register_client(id, name) -- luacheck: no unused
   error()
 end
@@ -156,7 +150,7 @@ end
 --- Usable out of the box, but intended more as an example/template for modification to customize
 --- to your own needs
 ---
---@returns: statusline component string
+-- @returns: statusline component string
 local function status() -- luacheck: no unused
   error()
 end

lua/lsp-status/current_function.lua

@@ -1,6 +1,7 @@
 -- Utilities
 local lsp_util = require('vim.lsp.util')
 local util = require('lsp-status/util')
+local redraw = require('lsp-status/redraw')
 
 local _config = {}
 
@@ -21,7 +22,7 @@ local function current_function_callback(_, _, result, _, _)
     end)
 
   if not function_symbols or #function_symbols == 0 then
-    vim.g.lsp_status_redraw = true
+    redraw.redraw()
     return
   end
 
@@ -38,7 +39,7 @@ local function current_function_callback(_, _, result, _, _)
       end
 
       vim.b.lsp_current_function = fn_name
-      vim.g.lsp_status_redraw = true
+      redraw.redraw()
       return
     end
   end

lua/lsp-status/extensions/clangd.lua

@@ -1,4 +1,5 @@
 local util = require('lsp-status/util')
+local redraw = require('lsp-status/redraw')
 
 local messages = {}
 
@@ -12,7 +13,7 @@ local handlers = {
   ['textDocument/clangd.fileStatus'] = function(_, _, statusMessage, client_id)
     ensure_init(client_id)
     messages[client_id].status = {uri = statusMessage.uri, content = statusMessage.state}
-    vim.g.lsp_status_redraw = true
+    redraw.redraw()
   end
 }
 

lua/lsp-status/extensions/pyls_ms.lua

@@ -1,5 +1,5 @@
 local util = require('lsp-status/util')
-local statusline = require('lsp-status/statusline')
+local redraw = require('lsp-status/redraw')
 
 local messages = {}
 ---@private
@@ -12,7 +12,7 @@ local handlers = {
   ['python/setStatusBarMessage'] = function(_, _, message, client_id)
     ensure_init(client_id)
     messages[client_id].static_message = {content = message[1]}
-    vim.g.lsp_status_redraw = true
+    redraw.redraw()
   end,
   ['python/beginProgress'] = function(_, _, _, client_id)
     ensure_init(client_id)
@@ -23,11 +23,11 @@ local handlers = {
   ['python/reportProgress'] = function(_, _, message, client_id)
     messages[client_id].progress[1].spinner = messages[client_id].progress[1].spinner + 1
     messages[client_id].progress[1].title = message[1]
-    vim.g.lsp_status_redraw = true
+    redraw.redraw()
   end,
   ['python/endProgress'] = function(_, _, _, client_id)
     messages[client_id].progress[1] = nil
-    vim.g.lsp_status_redraw = true
+    redraw.redraw()
   end
 }
 

lua/lsp-status/messaging.lua

@@ -1,4 +1,5 @@
 local util = require('lsp-status/util')
+local redraw = require('lsp-status/redraw')
 
 local clients = {}
 local messages = {}
@@ -30,8 +31,8 @@ local function progress_callback(_, _, msg, client_id)
       if messages[client_id].progress[msg.token] == nil then
         vim.api.nvim_command('echohl WarningMsg')
         vim.api.nvim_command(
-          'echom "[lsp-status] Received `end` message with no corresponding `begin` from  '
-            .. clients[client_id] .. '!"')
+          'echom "[lsp-status] Received `end` message with no corresponding `begin` from  ' ..
+            clients[client_id] .. '!"')
         vim.api.nvim_command('echohl None')
       else
         messages[client_id].progress[msg.token].message = val.message
@@ -43,7 +44,7 @@ local function progress_callback(_, _, msg, client_id)
     table.insert(messages[client_id], {content = val, show_once = true, shown = 0})
   end
 
-  vim.g.lsp_status_redraw = true
+  redraw.redraw()
 end
 
 -- Process messages
@@ -93,9 +94,7 @@ local function get_messages()
   return new_messages
 end
 
-local function register_progress()
-  vim.lsp.handlers['$/progress'] = progress_callback
-end
+local function register_progress() vim.lsp.handlers['$/progress'] = progress_callback end
 
 -- Client registration for messages
 local function register_client(id, name)

lua/lsp-status/redraw.lua

@@ -0,0 +1,30 @@
+local config = {}
+local function init(_, _config) config = vim.tbl_extend('force', config, _config) end
+
+local last_redraw = nil
+local timer_going = false
+
+local function redraw_callback(now)
+  last_redraw = now or vim.loop.now()
+  vim.api.nvim_command('redrawstatus!')
+  timer_going = false
+end
+
+local wrapped_redraw_callback = vim.schedule_wrap(redraw_callback)
+local timer = vim.loop.new_timer()
+local function redraw()
+  local now = vim.loop.now()
+  if last_redraw == nil or now - last_redraw >= config.update_interval then
+    vim.loop.timer_stop(timer)
+    timer_going = false
+    redraw_callback(now)
+  elseif not timer_going then
+    timer_going = true
+    vim.loop.timer_start(timer, config.update_interval + last_redraw - now, 0,
+                         wrapped_redraw_callback)
+  end
+end
+
+local M = {redraw = redraw, _init = init}
+
+return M

lua/lsp-status/statusline.lua

@@ -118,13 +118,9 @@ local function get_component_functions()
   return {errors = _errors, warnings = _warnings, hints = _hints, info = _info}
 end
 
--- Status line component for nvim-lsp
-local function lsp_status() return vim.g.lsp_status_statusline or '' end
-
 local M = {
   _init = init,
-  status = lsp_status,
-  get_lsp_statusline = get_lsp_statusline,
+  status = get_lsp_statusline,
   _get_component_functions = get_component_functions
 }