Add api for agenda

Author: kristijanhusak

lua/orgmode/agenda/filter.lua

@@ -127,7 +127,8 @@ function AgendaFilter:_matches_include(headline)
 end
 
 ---@param filter string
-function AgendaFilter:parse(filter)
+---@param skip_check? boolean do not check if given values exist in the current view
+function AgendaFilter:parse(filter, skip_check)
   filter = filter or ''
   self.value = filter
   self.tags = {}
@@ -144,15 +145,18 @@ function AgendaFilter:parse(filter)
     end
     local val = vim.trim(tag_cat)
     if val ~= '' then
-      if self.available_tags[val] then
+      if self.available_tags[val] or skip_check then
         table.insert(self.tags, { operator = operator, value = val })
-      elseif self.available_categories[val] then
+      elseif self.available_categories[val] or skip_check then
         table.insert(self.categories, { operator = operator, value = val })
       end
     end
   end
   self.term = search_term or ''
   self.applying = true
+  if skip_check then
+    self.parsed = true
+  end
 end
 
 function AgendaFilter:reset()

lua/orgmode/agenda/init.lua

@@ -31,46 +31,43 @@ function Agenda:new(opts)
   return data
 end
 
-function Agenda:agenda()
-  self:open_window()
-  local view = AgendaView:new({ filters = self.filters }):build()
+function Agenda:agenda(opts)
+  local view = AgendaView:new(vim.tbl_deep_extend('force', opts or {}, {
+    filters = self.filters,
+  })):build()
   self.views = { view }
   return self:_render()
 end
 
 -- TODO: Introduce searching ALL/DONE
 function Agenda:todos()
-  self:open_window()
   local view = AgendaTodosView:new({ filters = self.filters }):build()
   self.views = { view }
   return self:_render()
 end
 
 function Agenda:search()
-  self:open_window()
   local view = AgendaSearchView:new({ filters = self.filters }):build()
   self.views = { view }
   return self:_render()
 end
 
-function Agenda:tags()
-  self:open_window()
-  local view = AgendaTagsView:new({ filters = self.filters }):build()
+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()
 end
 
 function Agenda:tags_todo()
-  self:open_window()
-  local view = AgendaTagsView:new({ todo_only = true, filters = self.filters }):build()
-  self.views = { view }
-  return self:_render()
+  return self:tags({ todo_only = true })
 end
 
 function Agenda:open_window()
   local opened = self:is_opened()
   if opened then
-    return
+    return opened
   end
 
   utils.open_window('orgagenda', math.max(34, config.org_agenda_min_height), config.win_split_mode)
@@ -79,6 +76,7 @@ function Agenda:open_window()
   vim.cmd([[setlocal buftype=nofile bufhidden=wipe nobuflisted nolist noswapfile nowrap nospell]])
   vim.w.org_window_pos = vim.fn.win_screenpos(0)
   config:setup_mappings('agenda')
+  return vim.fn.win_getid()
 end
 
 function Agenda:prompt()
@@ -109,7 +107,7 @@ function Agenda:prompt()
       label = 'Like m, but only TODO entries',
       key = 'M',
       action = function()
-        return self:tags_todo()
+        return self:tags({ todo_only = true })
       end,
     },
     {
@@ -135,7 +133,7 @@ function Agenda:_render(skip_rebuild)
   end
   local opened = self:is_opened()
   if not opened then
-    self:open_window()
+    opened = self:open_window()
   end
   vim.cmd(vim.fn.win_id2win(opened) .. 'wincmd w')
   if vim.w.org_window_split_mode == 'horizontal' then

lua/orgmode/api/agenda.lua

@@ -0,0 +1,74 @@
+local Date = require('orgmode.objects.date')
+local orgmode = require('orgmode')
+
+---@class OrgAgenda
+local OrgAgenda = {}
+
+---@alias OrgAgendaFilter string see Filters to apply to the current view. See `:help orgmode-org_agenda_filter` for more information
+
+local function get_date(date, name)
+  if not date then
+    return nil
+  end
+  if type(date) == Date then
+    return date
+  end
+  if type(date) == 'string' then
+    return Date.from_string(date)
+  end
+
+  error(('Invalid format for "%s" date in Org Agenda'):format(name))
+end
+
+---@class OrgAgendaOptions
+---@field filters? OrgAgendaFilter
+---@field from? string | Date
+---@field span? number | 'day' | 'week' | 'month' | 'year'
+
+---@param options? OrgAgendaOptions
+function OrgAgenda.agenda(options)
+  options = options or {}
+  local org = orgmode.instance()
+  org:init()
+  if options.filters and options.filters ~= '' then
+    org.agenda.filters:parse(options.filters, true)
+  end
+  local from = get_date(options.from, 'from')
+  org.agenda:agenda({
+    from = from,
+    span = options.span,
+  })
+end
+
+---@class OrgAgendaTodosOptions
+---@field filters? OrgAgendaFilter
+
+---@param options? OrgAgendaTodosOptions
+function OrgAgenda.todos(options)
+  options = options or {}
+  local org = orgmode.instance()
+  org:init()
+  if options.filters and options.filters ~= '' then
+    org.agenda.filters:parse(options.filters, true)
+  end
+  org.agenda:todos()
+end
+
+---@class OrgAgendaTagsOptions
+---@field filters? OrgAgendaFilter
+---@field todo_only? boolean
+
+---@param options? OrgAgendaTagsOptions
+function OrgAgenda.tags(options)
+  options = options or {}
+  local org = orgmode.instance()
+  org:init()
+  if options.filters and options.filters ~= '' then
+    org.agenda.filters:parse(options.filters, true)
+  end
+  org.agenda:tags({
+    todo_only = options.todo_only,
+  })
+end
+
+return OrgAgenda

lua/orgmode/parser/files.lua

@@ -309,6 +309,7 @@ function Files.ensure_loaded()
   if Files.loaded then
     return true
   end
+  Files.load()
   vim.wait(5000, function()
     return Files.loaded
   end, 5)

scripts/gendoc.lua

@@ -10,6 +10,7 @@ minidoc.generate(
     'lua/orgmode/api/init.lua',
     'lua/orgmode/api/file.lua',
     'lua/orgmode/api/headline.lua',
+    'lua/orgmode/api/agenda.lua',
     'lua/orgmode/api/position.lua',
   },
   'doc/orgmode_api.txt'