Expose api for manipulating headline scheduled and deadline date

Author: kristijanhusak

lua/orgmode/api/headline.lua

@@ -3,6 +3,8 @@ local utils = require('orgmode.utils')
 local ts_org = require('orgmode.treesitter')
 local OrgPosition = require('orgmode.api.position')
 local PriorityState = require('orgmode.objects.priority_state')
+local Date = require('orgmode.objects.date')
+local Calendar = require('orgmode.objects.calendar')
 
 ---@class OrgHeadline
 ---@field title string headline title without todo keyword, tags and priority. Ex. `* TODO I am a headline  :SOMETAG:` returns `I am a headline`
@@ -122,6 +124,77 @@ function OrgHeadline:set_priority(priority)
   end)
 end
 
+--- Set deadline date
+---@param date? Date|string|nil If ommited, opens the datepicker. Empty string removes the date. String must follow org date convention (YYYY-MM-DD HH:mm...)
+---@return Promise
+function OrgHeadline:set_deadline(date)
+  return self:_do_action(function()
+    local headline = ts_org.closest_headline()
+    local deadline_date = headline:deadline()
+    if not date then
+      return Calendar.new({ date = deadline_date or Date.today() }).open():next(function(new_date)
+        if not new_date then
+          return
+        end
+        return headline:set_deadline_date(new_date)
+      end)
+    end
+
+    if type(date) == 'string' then
+      if date == '' then
+        return headline:remove_deadline_date()
+      end
+      local date_instance = Date.from_string(date)
+      if date_instance then
+        return headline:set_deadline_date(date_instance)
+      end
+      error('Invalid string format for deadline date')
+    end
+
+    if Date.is_date_instance(date) then
+      return headline:set_deadline_date(date)
+    end
+
+    error('Invalid argument to set_deadline')
+  end)
+end
+
+
+--- Set scheduled date
+---@param date? Date|string|nil If ommited, opens the datepicker. Empty string removes the date. String must follow org date convention (YYYY-MM-DD HH:mm...)
+---@return Promise
+function OrgHeadline:set_scheduled(date)
+  return self:_do_action(function()
+    local headline = ts_org.closest_headline()
+    local scheduled_date = headline:scheduled()
+    if not date then
+      return Calendar.new({ date = scheduled_date or Date.today() }).open():next(function(new_date)
+        if not new_date then
+          return
+        end
+        return headline:set_scheduled_date(new_date)
+      end)
+    end
+
+    if type(date) == 'string' then
+      if date == '' then
+        return headline:remove_scheduled_date()
+      end
+      local date_instance = Date.from_string(date)
+      if date_instance then
+        return headline:set_scheduled_date(date_instance)
+      end
+      error('Invalid string format for schedule date')
+    end
+
+    if Date.is_date_instance(date) then
+      return headline:set_scheduled_date(date)
+    end
+
+    error('Invalid argument to set_scheduled')
+  end)
+end
+
 ---@param action function
 ---@private
 function OrgHeadline:_do_action(action)

lua/orgmode/objects/date.lua

@@ -889,6 +889,11 @@ local function parse_all_from_line(line, lnum)
   return dates
 end
 
+---@param value any
+local function is_date_instance(value)
+  return getmetatable(value) == Date
+end
+
 return {
   parse_parts = parse_parts,
   from_org_date = from_org_date,
@@ -897,6 +902,7 @@ return {
   today = today,
   parse_all_from_line = parse_all_from_line,
   is_valid_date = is_valid_date,
+  is_date_instance = is_date_instance,
   from_match = from_match,
   pattern = pattern,
 }

lua/orgmode/org/mappings.lua

@@ -749,28 +749,26 @@ function OrgMappings:outline_up_heading()
 end
 
 function OrgMappings:org_deadline()
-  local item = Files.get_closest_headline()
-  local deadline_date = item:get_deadline_date()
+  local headline = ts_org.closest_headline()
+  local deadline_date = headline:deadline()
   return Calendar.new({ date = deadline_date or Date.today() }).open():next(function(new_date)
     if not new_date then
       return
     end
-    item:remove_closed_date()
-    item = Files.get_closest_headline()
-    item:add_deadline_date(new_date)
+    headline:remove_closed_date()
+    headline:set_deadline_date(new_date)
   end)
 end
 
 function OrgMappings:org_schedule()
-  local item = Files.get_closest_headline()
-  local scheduled_date = item:get_scheduled_date()
+  local headline = ts_org.closest_headline()
+  local scheduled_date = headline:scheduled()
   return Calendar.new({ date = scheduled_date or Date.today() }).open():next(function(new_date)
     if not new_date then
       return
     end
-    item:remove_closed_date()
-    item = Files.get_closest_headline()
-    item:add_scheduled_date(new_date)
+    headline:remove_closed_date()
+    headline:set_scheduled_date(new_date)
   end)
 end
 

lua/orgmode/treesitter/headline.lua

@@ -1,9 +1,12 @@
 local ts_utils = require('nvim-treesitter.ts_utils')
 local tree_utils = require('orgmode.utils.treesitter')
 local Date = require('orgmode.objects.date')
+local Range = require('orgmode.parser.range')
 local config = require('orgmode.config')
 local query = vim.treesitter.query
 
+---@class Headline
+---@field headline userdata
 local Headline = {}
 
 ---@param headline_node userdata tree sitter headline node
@@ -14,6 +17,7 @@ function Headline:new(headline_node)
   return data
 end
 
+---@return userdata stars node
 function Headline:stars()
   return self.headline:field('stars')[1]
 end
@@ -28,6 +32,7 @@ function Headline:priority()
   return self:parse('%[#(%w+)%]')
 end
 
+---@return userdata, string
 function Headline:tags()
   local node = self.headline:field('tags')[1]
   local text = ''
@@ -37,6 +42,7 @@ function Headline:tags()
   return node, text
 end
 
+---@param tags string
 function Headline:set_tags(tags)
   local predecessor = nil
   for _, node in ipairs(ts_utils.get_named_children(self.headline)) do
@@ -76,6 +82,7 @@ function Headline:align_tags()
   end
 end
 
+---@param priority string
 function Headline:set_priority(priority)
   local current_priority = self:priority()
   if current_priority then
@@ -96,6 +103,7 @@ function Headline:set_priority(priority)
   tree_utils.set_node_text(stars, ('%s [#%s]'):format(text, priority))
 end
 
+---@param keyword string
 function Headline:set_todo(keyword)
   local current_todo = self:todo()
   if current_todo then
@@ -128,14 +136,15 @@ function Headline:todo()
   local text = query.get_node_text(todo_node, 0)
   for _, word in ipairs(keywords) do
     -- there may be multiple substitutions necessary
-    escaped_word = vim.pesc(word)
+    local escaped_word = vim.pesc(word)
     local todo = text:match(escaped_word)
     if todo then
       return todo_node, word, vim.tbl_contains(done_keywords, word)
     end
   end
 end
 
+---@return userdata
 function Headline:plan()
   local section = self.headline:parent()
   for _, node in ipairs(ts_utils.get_named_children(section)) do
@@ -145,6 +154,7 @@ function Headline:plan()
   end
 end
 
+---@return Table<string, userdata>
 function Headline:dates()
   local plan = self:plan()
   local dates = {}
@@ -160,6 +170,7 @@ function Headline:dates()
   return dates
 end
 
+---@return userdata[]
 function Headline:repeater_dates()
   return vim.tbl_filter(function(entry)
     local timestamp = entry:field('timestamp')[1]
@@ -171,37 +182,44 @@ function Headline:repeater_dates()
   end, self:dates())
 end
 
+---@return Date|nil
+function Headline:deadline()
+  return self:_get_date('DEADLINE')
+end
+
+---@return Date|nil
+function Headline:scheduled()
+  return self:_get_date('SCHEDULED')
+end
+
+---@param date Date
+function Headline:set_deadline_date(date)
+  return self:_add_date('DEADLINE', date, true)
+end
+
+---@param date Date
+function Headline:set_scheduled_date(date)
+  return self:_add_date('SCHEDULED', date, true)
+end
+
 function Headline:add_closed_date()
   local dates = self:dates()
   if dates['CLOSED'] then
     return
   end
-  local closed_text = 'CLOSED: ' .. Date.now():to_wrapped_string(false)
-  if vim.tbl_isempty(dates) then
-    local indent = config:get_indent(self:level() + 1)
-    local start_line = self.headline:start()
-    return vim.api.nvim_call_function('append', {
-      start_line + 1,
-      string.format('%s%s', indent, closed_text),
-    })
-  end
-  local keys = vim.tbl_keys(dates)
-  local last_child = dates['DEADLINE'] or dates['SCHEDULED'] or dates[keys[#keys]]
-  local ptext = query.get_node_text(last_child, 0)
-  local text = ptext .. ' ' .. closed_text
-  tree_utils.set_node_text(last_child, text)
+  return self:_add_date('CLOSED', Date.now(), false)
 end
 
 function Headline:remove_closed_date()
-  local dates = self:dates()
-  if vim.tbl_count(dates) == 0 or not dates['CLOSED'] then
-    return
-  end
-  local line_nr = dates['CLOSED']:start() + 1
-  tree_utils.set_node_text(dates['CLOSED'], '', true)
-  if vim.trim(vim.fn.getline(line_nr)) == '' then
-    return vim.api.nvim_call_function('deletebufline', { vim.api.nvim_get_current_buf(), line_nr })
-  end
+  return self:_remove_date('CLOSED')
+end
+
+function Headline:remove_deadline_date()
+  return self:_remove_date('DEADLINE')
+end
+
+function Headline:remove_scheduled_date()
+  return self:_remove_date('SCHEDULED')
 end
 
 function Headline:cookie()
@@ -251,4 +269,70 @@ function Headline:parse(pattern)
   return matching_nodes[1], match
 end
 
+---@param type string | "DEADLINE" | "SCHEDULED" | "CLOSED"
+---@return Date|nil
+function Headline:_get_date(type)
+  local dates = self:dates()
+  local date_node = dates[type]
+  if not date_node then
+    return nil
+  end
+  local timestamp_node = date_node:field('timestamp')[1]
+  if not timestamp_node then
+    return nil
+  end
+  local parsed_date = Date.from_org_date(query.get_node_text(timestamp_node, 0), {
+    range = Range.from_node(timestamp_node),
+  })
+  return parsed_date and parsed_date[1] or nil
+end
+
+---@param type string | "DEADLINE" | "SCHEDULED" | "CLOSED"
+---@param date Date
+---@param active? boolean
+---@private
+function Headline:_add_date(type, date, active)
+  local dates = self:dates()
+  local text = type .. ': ' .. date:to_wrapped_string(active)
+  if vim.tbl_isempty(dates) then
+    local indent = config:get_indent(self:level() + 1)
+    local start_line = self.headline:start()
+    return vim.api.nvim_call_function('append', {
+      start_line + 1,
+      string.format('%s%s', indent, text),
+    })
+  end
+  if dates[type] then
+    return tree_utils.set_node_text(dates[type], text, true)
+  end
+
+  local keys = vim.tbl_keys(dates)
+  local other_types = vim.tbl_filter(function(t)
+    return t ~= type
+  end, { 'DEADLINE', 'SCHEDULED', 'CLOSED' })
+  local last_child = dates[keys[#keys]]
+  for _, date_type in ipairs(other_types) do
+    if dates[date_type] then
+      last_child = dates[date_type]
+      break
+    end
+  end
+  local ptext = query.get_node_text(last_child, 0)
+  tree_utils.set_node_text(last_child, ptext .. ' ' .. text)
+end
+
+---@param type string | "DEADLINE" | "SCHEDULED" | "CLOSED"
+---@private
+function Headline:_remove_date(type)
+  local dates = self:dates()
+  if vim.tbl_count(dates) == 0 or not dates[type] then
+    return
+  end
+  local line_nr = dates[type]:start() + 1
+  tree_utils.set_node_text(dates[type], '', true)
+  if vim.trim(vim.fn.getline(line_nr)) == '' then
+    return vim.api.nvim_call_function('deletebufline', { vim.api.nvim_get_current_buf(), line_nr })
+  end
+end
+
 return Headline

lua/orgmode/treesitter/init.lua

@@ -2,6 +2,7 @@ local tree_utils = require('orgmode.utils.treesitter')
 local Headline = require('orgmode.treesitter.headline')
 local Listitem = require('orgmode.treesitter.listitem')
 
+---@return Headline
 local function closest_headline()
   local ts_headline = tree_utils.closest_headline()
   if not ts_headline then