Fix wrong tag offset in agenda (#444)

closes #433

Author: jgollenz

lua/orgmode/agenda/init.lua

@@ -25,49 +25,54 @@ function Agenda:new(opts)
     views = {},
     content = {},
     highlights = {},
+    win_width = utils.winwidth(),
   }
   setmetatable(data, self)
   self.__index = self
   return data
 end
 
-function Agenda:agenda(opts)
-  local view = AgendaView:new(vim.tbl_deep_extend('force', opts or {}, {
+---@param View table
+---@param opts? table
+function Agenda:open_agenda_view(View, opts)
+  self:open_window()
+  self.win_width = utils.winwidth()
+  local view = View:new(vim.tbl_deep_extend('force', opts or {}, {
     filters = self.filters,
+    win_width = self.win_width,
   })):build()
   self.views = { view }
   return self:_render()
 end
 
+function Agenda:agenda(opts)
+  self:open_agenda_view(AgendaView, opts)
+end
+
 -- TODO: Introduce searching ALL/DONE
 function Agenda:todos()
-  local view = AgendaTodosView:new({ filters = self.filters }):build()
-  self.views = { view }
-  return self:_render()
+  self:open_agenda_view(AgendaTodosView)
 end
 
 function Agenda:search()
-  local view = AgendaSearchView:new({ filters = self.filters }):build()
-  self.views = { view }
-  return self:_render()
+  self:open_agenda_view(AgendaSearchView)
 end
 
 function Agenda:tags(opts)
-  local view = AgendaTagsView:new(vim.tbl_deep_extend('force', opts or {}, {
-    filters = self.filters,
-  })):build()
-  self.views = { view }
-  return self:_render()
+  self:open_agenda_view(AgendaTagsView, opts)
 end
 
 function Agenda:tags_todo()
   return self:tags({ todo_only = true })
 end
 
+---@return number|nil window id
 function Agenda:open_window()
-  local opened = self:is_opened()
-  if opened then
-    return opened
+  -- if an agenda window is already open, return it
+  for _, win in ipairs(vim.api.nvim_list_wins()) do
+    if vim.api.nvim_buf_get_option(vim.api.nvim_win_get_buf(win), 'filetype') == 'orgagenda' then
+      return win
+    end
   end
 
   utils.open_window('orgagenda', math.max(34, config.org_agenda_min_height), config.win_split_mode)
@@ -131,11 +136,8 @@ function Agenda:_render(skip_rebuild)
       utils.concat(self.highlights, view.highlights)
     end
   end
-  local opened = self:is_opened()
-  if not opened then
-    opened = self:open_window()
-  end
-  vim.cmd(vim.fn.win_id2win(opened) .. 'wincmd w')
+  local win = self:open_window()
+  vim.cmd(vim.fn.win_id2win(win) .. 'wincmd w')
   if vim.w.org_window_split_mode == 'horizontal' then
     local win_height = math.max(math.min(34, #self.content), config.org_agenda_min_height)
     if vim.w.org_window_pos and vim.deep_equal(vim.fn.win_screenpos(0), vim.w.org_window_pos) then
@@ -180,15 +182,6 @@ function Agenda:redo(preserve_cursor_pos)
   end))
 end
 
-function Agenda:is_opened()
-  for _, win in ipairs(vim.api.nvim_list_wins()) do
-    if vim.api.nvim_buf_get_option(vim.api.nvim_win_get_buf(win), 'filetype') == 'orgagenda' then
-      return win
-    end
-  end
-  return false
-end
-
 function Agenda:advance_span(direction)
   return self:_call_view_and_render('advance_span', direction, vim.v.count1)
 end

lua/orgmode/agenda/views/agenda.lua

@@ -64,6 +64,7 @@ end
 ---@field start_day string
 ---@field header string
 ---@field filters AgendaFilter
+---@field win_width number
 local AgendaView = {}
 
 function AgendaView:new(opts)
@@ -81,7 +82,9 @@ function AgendaView:new(opts)
     start_on_weekday = opts.org_agenda_start_on_weekday or config.org_agenda_start_on_weekday,
     start_day = opts.org_agenda_start_day or config.org_agenda_start_day,
     header = opts.org_agenda_overriding_header,
+    win_width = opts.win_width or utils.winwidth(),
   }
+
   setmetatable(data, self)
   self.__index = self
   data:_set_date_range()
@@ -199,8 +202,13 @@ function AgendaView:build()
     local category_len = math.max(11, (longest_items.category + 1))
     local date_len = math.min(11, longest_items.label)
 
+    -- print(win_width)
+
     for _, agenda_item in ipairs(agenda_items) do
-      table.insert(content, AgendaView.build_agenda_item_content(agenda_item, category_len, date_len, #content))
+      table.insert(
+        content,
+        AgendaView.build_agenda_item_content(agenda_item, category_len, date_len, #content, self.win_width)
+      )
     end
   end
 
@@ -267,7 +275,7 @@ end
 
 ---@param agenda_item AgendaItem
 ---@return table
-function AgendaView.build_agenda_item_content(agenda_item, longest_category, longest_date, line_nr)
+function AgendaView.build_agenda_item_content(agenda_item, longest_category, longest_date, line_nr, win_width)
   local headline = agenda_item.headline
   local category = '  ' .. utils.pad_right(string.format('%s:', headline:get_category()), longest_category)
   local date = agenda_item.label
@@ -282,10 +290,9 @@ function AgendaView.build_agenda_item_content(agenda_item, longest_category, lon
   todo_keyword = todo_padding .. todo_keyword
   local line = string.format('%s%s%s %s', category, date, todo_keyword, headline.title)
   local todo_keyword_pos = string.format('%s%s%s', category, date, todo_padding):len()
-  local winwidth = utils.winwidth()
   if #headline.tags > 0 then
     local tags_string = headline:tags_to_string()
-    local padding_length = math.max(1, winwidth - vim.api.nvim_strwidth(line) - vim.api.nvim_strwidth(tags_string))
+    local padding_length = math.max(1, win_width - vim.api.nvim_strwidth(line) - vim.api.nvim_strwidth(tags_string))
     local indent = string.rep(' ', padding_length)
     line = string.format('%s%s%s', line, indent, tags_string)
   end

lua/orgmode/agenda/views/search.lua

@@ -2,6 +2,7 @@ local AgendaFilter = require('orgmode.agenda.filter')
 local AgendaTodosView = require('orgmode.agenda.views.todos')
 local Files = require('orgmode.parser.files')
 local Range = require('orgmode.parser.range')
+local utils = require('orgmode.utils')
 
 ---@class AgendaSearchView
 ---@field items table[]
@@ -10,6 +11,7 @@ local Range = require('orgmode.parser.range')
 ---@field header string
 ---@field search string
 ---@field filters AgendaFilter
+---@field win_width number
 local AgendaSearchView = {}
 
 function AgendaSearchView:new(opts)
@@ -21,6 +23,7 @@ function AgendaSearchView:new(opts)
     search = opts.search or '',
     filters = opts.filters or AgendaFilter:new(),
     header = opts.org_agenda_overriding_header,
+    win_width = opts.win_width or utils.winwidth(),
   }
 
   setmetatable(data, self)
@@ -51,7 +54,7 @@ function AgendaSearchView:build()
   }
 
   self.active_view = 'search'
-  AgendaTodosView.generate_view(self.items, self.content, self.filters)
+  AgendaTodosView.generate_view(self.items, self.content, self.filters, self.win_width)
   return self
 end
 

lua/orgmode/agenda/views/tags.lua

@@ -13,6 +13,7 @@ local utils = require('orgmode.utils')
 ---@field search string
 ---@field filters AgendaFilter
 ---@field todo_only boolean
+---@field win_width number
 local AgendaTagsView = {}
 
 function AgendaTagsView:new(opts)
@@ -25,6 +26,7 @@ function AgendaTagsView:new(opts)
     todo_only = opts.todo_only or false,
     filters = opts.filters or AgendaFilter:new(),
     header = opts.org_agenda_overriding_header,
+    win_width = opts.win_width or utils.winwidth(),
   }
 
   setmetatable(data, self)
@@ -59,7 +61,7 @@ function AgendaTagsView:build()
   }
 
   self.active_view = self.todo_only and 'tags_todo' or 'tags'
-  AgendaTodosView.generate_view(self.items, self.content, self.filters)
+  AgendaTodosView.generate_view(self.items, self.content, self.filters, self.win_width)
 
   return self
 end

lua/orgmode/agenda/views/todos.lua

@@ -22,6 +22,7 @@ end
 ---@field header string
 ---@field search string
 ---@field filters AgendaFilter
+---@field win_width number
 local AgendaTodosView = {}
 
 function AgendaTodosView:new(opts)
@@ -33,6 +34,7 @@ function AgendaTodosView:new(opts)
     search = opts.search or '',
     filters = opts.filters or AgendaFilter:new(),
     header = opts.org_agenda_overriding_header,
+    win_width = opts.win_width or utils.winwidth(),
   }
 
   setmetatable(data, self)
@@ -53,11 +55,11 @@ function AgendaTodosView:build()
   self.content = { { line_content = 'Global list of TODO items of type: ALL' } }
   self.highlights = {}
   self.active_view = 'todos'
-  self.generate_view(self.items, self.content, self.filters)
+  self.generate_view(self.items, self.content, self.filters, self.win_width)
   return self
 end
 
-function AgendaTodosView.generate_view(items, content, filters)
+function AgendaTodosView.generate_view(items, content, filters, win_width)
   items = sort_todos(items)
   local offset = #content
   local longest_category = utils.reduce(items, function(acc, todo)
@@ -66,22 +68,21 @@ function AgendaTodosView.generate_view(items, content, filters)
 
   for i, headline in ipairs(items) do
     if filters:matches(headline) then
-      table.insert(content, AgendaTodosView.generate_todo_item(headline, longest_category, i + offset))
+      table.insert(content, AgendaTodosView.generate_todo_item(headline, longest_category, i + offset, win_width))
     end
   end
 
   return { items = items, content = content }
 end
 
-function AgendaTodosView.generate_todo_item(headline, longest_category, line_nr)
+function AgendaTodosView.generate_todo_item(headline, longest_category, line_nr, win_width)
   local category = '  ' .. utils.pad_right(string.format('%s:', headline:get_category()), longest_category + 1)
   local todo_keyword = headline.todo_keyword.value
   local todo_keyword_padding = todo_keyword ~= '' and ' ' or ''
   local line = string.format('  %s%s%s %s', category, todo_keyword_padding, todo_keyword, headline.title)
-  local winwidth = utils.winwidth()
   if #headline.tags > 0 then
     local tags_string = headline:tags_to_string()
-    local padding_length = math.max(1, winwidth - vim.api.nvim_strwidth(line) - vim.api.nvim_strwidth(tags_string))
+    local padding_length = math.max(1, win_width - vim.api.nvim_strwidth(line) - vim.api.nvim_strwidth(tags_string))
     local indent = string.rep(' ', padding_length)
     line = string.format('%s%s%s', line, indent, tags_string)
   end

lua/orgmode/utils/init.lua

@@ -476,12 +476,19 @@ end
 function utils.winwidth(winnr)
   winnr = winnr or 0
   local winwidth = vim.api.nvim_win_get_width(winnr)
-  local window_numbers = vim.api.nvim_win_get_option(winnr, 'number')
-  local window_relnumbers = vim.api.nvim_win_get_option(winnr, 'relativenumber')
-  if window_numbers or window_relnumbers then
-    winwidth = winwidth - vim.wo.numberwidth
+
+  local win_id
+  if winnr == 0 then -- use current window
+    win_id = vim.fn.win_getid()
+  else
+    win_id = vim.fn.win_getid(winnr)
   end
-  return winwidth
+
+  local wininfo = vim.fn.getwininfo(win_id)[1]
+  -- this encapsulates both signcolumn & numbercolumn (:h wininfo)
+  local gutter_width = wininfo and wininfo.textoff or 0
+
+  return winwidth - gutter_width
 end
 
 ---@param name string