add support for launching preview via lsp

Author: wisp3rwind

lua/typst-preview/commands.lua

@@ -6,19 +6,12 @@ local servers = require 'typst-preview.servers'
 
 local M = {}
 
----Scroll all preview to cursor position.
-function M.sync_with_cursor()
-  for _, ser in pairs(servers.get_all()) do
-    servers.sync_with_cursor(ser)
-  end
-end
-
 ---Create user commands
 function M.create_commands()
   local function preview_off()
     local path = utils.get_buf_path(0)
 
-    if path ~= '' and servers.remove(config.opts.get_main_file(path)) then
+    if path ~= '' and servers.remove{path=config.opts.get_main_file(path)} then
       utils.print 'Preview stopped'
     else
       utils.print 'Preview not running'
@@ -38,16 +31,20 @@ function M.create_commands()
   ---@param mode mode?
   local function preview_on(mode)
     -- check if binaries are available and tell them to fetch first
-    for _, bin in pairs(fetch.bins_to_fetch()) do
-      if
-        not config.opts.dependencies_bin[bin.name] and not fetch.up_to_date(bin)
-      then
-        utils.notify(
-          bin.name
-            .. ' not found or out of date\nPlease run :TypstPreviewUpdate first!',
-          vim.log.levels.ERROR
-        )
-        return
+    if config.opts.use_lsp then
+      -- FIXME: Check for tinymist to be connected
+    else
+      for _, bin in pairs(fetch.bins_to_fetch()) do
+        if
+          not config.opts.dependencies_bin[bin.name] and not fetch.up_to_date(bin)
+        then
+          utils.notify(
+            bin.name
+              .. ' not found or out of date\nPlease run :TypstPreviewUpdate first!',
+            vim.log.levels.ERROR
+          )
+          return
+        end
       end
     end
 
@@ -58,15 +55,13 @@ function M.create_commands()
 
     mode = mode or 'document'
 
-    local ser = servers.get(path)
-    if ser == nil or ser[mode] == nil then
-      servers.init(path, mode, function(s)
-        events.listen(s)
-      end)
+    local _, ser = next(servers.get{path=path, mode=mode})
+    if ser == nil then
+      servers.init(path, mode, function(s) end)
     else
-      local s = ser[mode]
+      -- FIXME: try to ping the server to see whether it's really still alive
       print 'Opening another frontend'
-      utils.visit(s.link)
+      utils.visit(ser.link)
     end
   end
 
@@ -93,10 +88,7 @@ function M.create_commands()
       if path == nil then
         return
       end
-      local sers = servers.get(path)
-      if sers ~= nil then
-        mode = servers.get_last_mode(path)
-      end
+      mode = servers.get_last_mode(path)
     end
 
     preview_on(mode)
@@ -113,7 +105,7 @@ function M.create_commands()
       return
     end
 
-    if servers.get(path) ~= nil then
+    if next(servers.get{path=path}) ~= nil then
       preview_off()
     else
       preview_on(servers.get_last_mode(path))
@@ -130,7 +122,7 @@ function M.create_commands()
     config.set_follow_cursor(not config.get_follow_cursor())
   end, {})
   vim.api.nvim_create_user_command('TypstPreviewSyncCursor', function()
-    M.sync_with_cursor()
+    servers.scroll_preview()
   end, {})
 end
 

lua/typst-preview/config.lua

@@ -20,6 +20,7 @@ local M = {
     get_main_file = function(path)
       return path
     end,
+    use_lsp = false,
   },
 }
 

lua/typst-preview/events/editor.lua

@@ -11,25 +11,24 @@ function M.register_autocmds(bufnr)
   local autocmds = {
     {
       event = { 'TextChanged', 'TextChangedI', 'TextChangedP', 'InsertLeave' },
-      callback = function(ser, _)
+      callback = function(_ev)
         servers.update_memory_file(
-          ser,
           utils.get_buf_path(bufnr),
           utils.get_buf_content(bufnr)
         )
       end,
     },
     {
       event = { 'CursorMoved' },
-      callback = function(ser, _)
+      callback = function(_ev)
         if not config.get_follow_cursor() then
           return
         end
         local line = vim.api.nvim_win_get_cursor(0)[1]
         if last_line ~= line then
           -- No scroll when on the same line in insert mode
           last_line = line
-          servers.sync_with_cursor(ser)
+          servers.scroll_preview()
         end
       end,
     },
@@ -40,11 +39,7 @@ function M.register_autocmds(bufnr)
       {
         event = autocmd.event,
         opts = {
-          callback = function(ev)
-            for _, ser in pairs(servers.get_all()) do
-              autocmd.callback(ser, ev)
-            end
-          end,
+          callback = autocmd.callback,
           buffer = bufnr,
         },
       },

lua/typst-preview/events/init.lua

@@ -1,19 +1,26 @@
+local config = require 'typst-preview.config'
 local event_server = require 'typst-preview.events.server'
 local utils = require 'typst-preview.utils'
 local editor = require 'typst-preview.events.editor'
 local servers = require 'typst-preview.servers'
 
 local M = {}
 
----Listen to Server's event
----All buffers are already watched via auto command
----@param s Server
-function M.listen(s)
-  event_server.add_listeners(s)
-end
-
----Register autocmds to register autocmds for filetype
+---Setup listeners for server -> editor communication, and register filetype
+---autocmds that setup listeners for editor -> server communication.
 function M.init()
+  -- Listen to Server's event
+  servers.listen_scroll(event_server.on_editor_scroll_to)
+
+  if config.opts.use_lsp then
+    -- When using tinymist via vim.lsp, we don't need to update document state
+    -- nvim already handles it in that case.
+    -- FIXME: Do we still want to use the VimLeavePre autocmd below? Or is it
+    -- sufficient that nvim shuts down tinymist?
+    return
+  end
+
+  -- Register autocmds to register autocmds for filetype
   utils.create_autocmds('typst-preview-all-autocmds', {
     {
       event = 'FileType',

lua/typst-preview/events/server.lua

@@ -3,42 +3,40 @@ local utils = require 'typst-preview.utils'
 
 local M = {}
 
----Register event listener
----@param s Server
-function M.add_listeners(s)
-  servers.listen_scroll(s, function(event)
-    local function editorScrollTo()
-      utils.debug(event.end_.row .. ' ' .. event.end_.column)
-      s.suppress = true
-      local row = event.end_.row + 1
-      local max_row = vim.fn.line '$'
-      if row < 1 then
-        row = 1
-      end
-      if row > max_row then
-        row = max_row
-      end
-      local column = event.end_.column - 1
-      local max_column = vim.fn.col '$' - 1
-      if column < 0 then
-        column = 0
-      end
-      if column > max_column then
-        column = max_column
-      end
-      vim.api.nvim_win_set_cursor(0, { row, column })
-      vim.defer_fn(function()
-        s.suppress = false
-      end, 100)
+---@param jump OnEditorJumpData
+function M.on_editor_scroll_to(jump)
+  local function editorScrollTo()
+    -- FIXME: What was the original reasoning for this throttling? Is it still
+    -- needed? How to best implement for LSP?
+    -- s.suppress = true
+    local row = jump.end_.row + 1
+    local max_row = vim.fn.line '$'
+    if row < 1 then
+      row = 1
     end
-
-    if event.filepath ~= utils.get_buf_path(0) then
-      vim.cmd('e ' .. event.filepath)
-      vim.defer_fn(editorScrollTo, 100)
-    else
-      editorScrollTo()
+    if row > max_row then
+      row = max_row
+    end
+    local column = jump.end_.column - 1
+    local max_column = vim.fn.col '$' - 1
+    if column < 0 then
+      column = 0
     end
-  end)
+    if column > max_column then
+      column = max_column
+    end
+    vim.api.nvim_win_set_cursor(0, { row, column })
+    -- vim.defer_fn(function()
+    --   s.suppress = false
+    -- end, 100)
+  end
+
+  if jump.filepath ~= utils.get_buf_path(0) then
+    vim.cmd('e ' .. jump.filepath)
+    vim.defer_fn(editorScrollTo, 100)
+  else
+    editorScrollTo()
+  end
 end
 
 return M

lua/typst-preview/fetch.lua

@@ -198,6 +198,13 @@ end
 ---@param quiet boolean
 ---@param callback function|nil
 function M.fetch(quiet, callback)
+  if config.opts.use_lsp then
+    if callback ~= nil then
+      callback()
+    end
+    return
+  end
+
   if callback == nil then
     callback = function() end
   end

lua/typst-preview/servers/base.lua

@@ -0,0 +1,71 @@
+local M = {}
+
+-- Tinymist API types
+
+---@class PreviewResult
+---@field staticServerAddr string|nil
+---@field staticServerPort number|nil
+---@field dataPlanePort number|nil
+---@field isPrimary boolean|nil
+
+---@class JumpInfo
+---@field filepath string
+---@field start number[] | nil
+---@field end number[] | nil
+
+-- Parsed JumpInfo
+
+---@class Location
+---@field row number
+---@field column number
+
+---@class OnEditorJumpData
+---@field filepath string
+---@field start Location
+---@field end_ Location
+
+-- Server and related types
+
+---@alias mode 'document'|'slide'
+
+---@class (exact) Server
+---@field path string Unsaved buffer will not be previewable.
+---@field mode mode
+---@field link string
+---@field suppress boolean Prevent server initiated event to trigger editor initiated events.
+---@field close fun()
+---@field scroll_to fun(data)
+---@field update_memory_file fun(data)
+---@field remove_memory_file fun(data)
+
+function M.new_server(path, mode, link)
+  return {
+    path = path,
+    mode = mode,
+    link = link,
+    suppress = false,
+    close = function() end,
+    scroll_to = function() end,
+    update_memory_file = function() end,
+    remove_memory_file = function() end,
+  }
+end
+
+---@class(exact) ServerFilter
+---@field path? string
+---@field mode? mode
+---@field task_id? string
+
+---@param server Server
+---@param filter ServerFilter
+---@return boolean
+function M.server_matches(server, filter)
+  for k, v in pairs(filter) do
+    if server[k] ~= v then
+      return false
+    end
+  end
+  return true
+end
+
+return M