feat(ts): add link and timestamp tree-sitter captures

Author: kristijanhusak

lua/orgmode/colors/highlighter/markup/dates.lua

@@ -171,17 +171,4 @@ function OrgDates:prepare_highlights(highlights)
   return extmarks
 end
 
----@param item OrgMarkupNode
----@return boolean
-function OrgDates:has_valid_parent(item)
-  ---At this point we know that node has 2 valid parents
-  local parent = item.node:parent():parent()
-
-  if parent and parent:type() == 'value' then
-    return parent:parent() and parent:parent():type() == 'property' or false
-  end
-
-  return false
-end
-
 return OrgDates

lua/orgmode/colors/highlighter/markup/init.lua

@@ -22,8 +22,6 @@ end
 function OrgMarkup:_init_highlighters()
   self.parsers = {
     emphasis = require('orgmode.colors.highlighter.markup.emphasis'):new({ markup = self }),
-    link = require('orgmode.colors.highlighter.markup.link'):new({ markup = self }),
-    date = require('orgmode.colors.highlighter.markup.dates'):new({ markup = self }),
     footnote = require('orgmode.colors.highlighter.markup.footnotes'):new({ markup = self }),
     latex = require('orgmode.colors.highlighter.markup.latex'):new({ markup = self }),
   }
@@ -72,9 +70,7 @@ end
 function OrgMarkup:get_node_highlights(root_node, source, line)
   local result = {
     emphasis = {},
-    link = {},
     latex = {},
-    date = {},
     footnote = {},
   }
   ---@type OrgMarkupNode[]
@@ -230,7 +226,7 @@ function OrgMarkup:has_valid_parent(item)
     return false
   end
 
-  if parent:type() == 'paragraph' then
+  if parent:type() == 'paragraph' or parent:type() == 'link_desc' then
     return true
   end
 
@@ -248,8 +244,8 @@ function OrgMarkup:has_valid_parent(item)
     return true
   end
 
-  if self.parsers[item.type].has_valid_parent then
-    return self.parsers[item.type]:has_valid_parent(item)
+  if parent:type() == 'value' then
+    return p and p:type() == 'property' or false
   end
 
   return false

lua/orgmode/config/init.lua

@@ -405,38 +405,15 @@ function Config:setup_ts_predicates()
   end, { force = true, all = false })
 
   vim.treesitter.query.add_predicate('org-is-valid-priority?', function(match, _, source, predicate)
+    ---@type TSNode | nil
     local node = match[predicate[2]]
     local type = predicate[3]
     if not node then
       return false
     end
 
     local text = vim.treesitter.get_node_text(node, source)
-    local is_valid = valid_priorities[text] and valid_priorities[text].type == type
-    if not is_valid then
-      return false
-    end
-    local priority_text = '[#' .. text .. ']'
-    local full_node_text = vim.treesitter.get_node_text(node:parent(), source)
-    if priority_text ~= full_node_text then
-      return false
-    end
-
-    local prev_sibling = node:parent():prev_sibling()
-    -- If first child, consider it valid
-    if not prev_sibling then
-      return true
-    end
-
-    -- If prev sibling has more prev siblings, it means that the prev_sibling is not a todo keyword
-    -- so this priority is not valid
-    if prev_sibling:prev_sibling() then
-      return false
-    end
-
-    local todo_text = vim.treesitter.get_node_text(prev_sibling, source)
-    local is_prev_sibling_todo_keyword = todo_keywords[todo_text] and true or false
-    return is_prev_sibling_todo_keyword
+    return valid_priorities[text] and valid_priorities[text].type == type
   end, { force = true, all = false })
 
   vim.treesitter.query.add_directive('org-set-block-language!', function(match, _, bufnr, pred, metadata)

lua/orgmode/files/elements/logbook.lua

@@ -1,6 +1,5 @@
 local Range = require('orgmode.files.elements.range')
 local utils = require('orgmode.utils')
-local config = require('orgmode.config')
 local Date = require('orgmode.objects.date')
 local Duration = require('orgmode.objects.duration')
 

lua/orgmode/files/file.lua

@@ -735,21 +735,17 @@ memoize('get_links')
 ---@return OrgHyperlink[]
 function OrgFile:get_links()
   self:parse(true)
-  local ts_query = ts_utils.get_query([[
-      (paragraph (expr) @links)
-      (drawer (contents (expr) @links))
-      (headline (item (expr)) @links)
+  local links = {}
+  local matches = self:get_ts_matches([[
+    (link) @link
+    (link_desc) @link
   ]])
 
-  local links = {}
-  local processed_lines = {}
-  for _, match in ts_query:iter_captures(self.root, self:get_source()) do
-    local line = match:start()
-    if not processed_lines[line] then
-      vim.list_extend(links, Hyperlink.all_from_line(self.lines[line + 1], line + 1))
-      processed_lines[line] = true
-    end
+  local source = self:get_source()
+  for _, match in ipairs(matches) do
+    table.insert(links, Hyperlink.from_node(match.link.node, source))
   end
+
   return links
 end
 

lua/orgmode/files/headline.lua

@@ -67,26 +67,21 @@ end
 memoize('get_priority')
 ---@return string, TSNode | nil
 function Headline:get_priority()
-  local _, todo_node = self:get_todo()
   local item = self:_get_child_node('item')
 
-  local priority_node = item and item:named_child(1)
+  local priority_node = item and item:field('priority')[1]
 
-  if not todo_node then
-    priority_node = item and item:named_child(0)
+  if not priority_node then
+    return '', nil
   end
 
-  if priority_node then
-    local text = self.file:get_node_text(priority_node)
-    local priority = text:match('%[#(%w+)%]')
-    if priority then
-      local priorities = config:get_priorities()
-      if priorities[priority] then
-        return priority, priority_node
-      end
-    end
+  local value = self.file:get_node_text(priority_node:field('value')[1])
+
+  if not value then
+    return '', nil
   end
-  return '', nil
+
+  return value, priority_node
 end
 
 ---@param amount number
@@ -424,15 +419,6 @@ function Headline:get_title()
   return title, offset
 end
 
-function Headline:get_title_with_priority()
-  local priority = self:get_priority()
-  local title = self:get_title()
-  if priority ~= '' then
-    return ('[#%s] %s'):format(priority, self:get_title())
-  end
-  return title
-end
-
 memoize('get_own_properties')
 ---@return table<string, string>, TSNode | nil
 function Headline:get_own_properties()

lua/orgmode/org/links/hyperlink.lua

@@ -1,5 +1,6 @@
 local OrgLinkUrl = require('orgmode.org.links.url')
 local Range = require('orgmode.files.elements.range')
+local ts_utils = require('orgmode.utils.treesitter')
 
 ---@class OrgHyperlink
 ---@field url OrgLinkUrl
@@ -21,61 +22,26 @@ function OrgHyperlink:new(str, range)
   return this
 end
 
----@return string
-function OrgHyperlink:to_str()
-  if self.desc then
-    return string.format('[[%s][%s]]', self.url:to_string(), self.desc)
-  else
-    return string.format('[[%s]]', self.url:to_string())
-  end
-end
-
----@param line string
----@param pos number
----@return OrgHyperlink | nil, { from: number, to: number } | nil
-function OrgHyperlink.at_pos(line, pos)
-  local links = {}
-  local found_link = nil
-  local position
-  for link in line:gmatch(pattern) do
-    local start_from = #links > 0 and links[#links].to or nil
-    local from, to = line:find(pattern, start_from)
-    local current_pos = { from = from, to = to }
-    if pos >= from and pos <= to then
-      found_link = link
-      position = current_pos
-      break
-    end
-    table.insert(links, current_pos)
-  end
-  if not found_link then
-    return nil, nil
-  end
-  return OrgHyperlink:new(found_link), position
+---@param node TSNode
+---@param source number | string
+---@return OrgHyperlink
+function OrgHyperlink.from_node(node, source)
+  local url = node:field('url')[1]
+  local desc = node:field('desc')[1]
+  local this = setmetatable({}, { __index = OrgHyperlink })
+  this.url = OrgLinkUrl:new(vim.treesitter.get_node_text(url, source))
+  this.desc = desc and vim.treesitter.get_node_text(desc, source)
+  this.range = Range.from_node(node)
+  return this
 end
 
----@return OrgHyperlink | nil, { from: number, to: number } | nil
+---@return OrgHyperlink | nil
 function OrgHyperlink.at_cursor()
-  local line = vim.fn.getline('.')
-  local col = vim.fn.col('.') or 0
-  return OrgHyperlink.at_pos(line, col)
-end
-
----@return OrgHyperlink[]
-function OrgHyperlink.all_from_line(line, line_number)
-  local links = {}
-  for link in line:gmatch(pattern) do
-    local start_from = #links > 0 and links[#links].to or nil
-    local from, to = line:find(pattern, start_from)
-    if from and to then
-      local range = Range.from_line(line_number)
-      range.start_col = from
-      range.end_col = to
-      table.insert(links, OrgHyperlink:new(link, range))
-    end
+  local link_node = ts_utils.closest_node(ts_utils.get_node(), { 'link', 'link_desc' })
+  if not link_node then
+    return nil
   end
-
-  return links
+  return OrgHyperlink.from_node(link_node, vim.api.nvim_get_current_buf())
 end
 
 return OrgHyperlink

lua/orgmode/org/links/init.lua

@@ -141,11 +141,11 @@ function OrgLinks:insert_link(link_location, desc)
     local target_col = #link_location + #link_description + 2
 
     -- check if currently on link
-    local link, position = OrgHyperlink.at_cursor()
-    if link and position then
-      insert_from = position.from - 1
-      insert_to = position.to + 1
-      target_col = target_col + position.from
+    local link = OrgHyperlink.at_cursor()
+    if link then
+      insert_from = link.range.start_col - 1
+      insert_to = link.range.end_col + 1
+      target_col = target_col + link.range.start_col
     elseif vim.fn.mode() == 'v' then
       local start_pos = vim.fn.getpos('v')
       local end_pos = vim.fn.getpos('.')

lua/orgmode/utils/treesitter/init.lua

@@ -63,16 +63,22 @@ function M.closest_headline_node(cursor)
   return M.find_headline(node)
 end
 
+---@param node TSNode | nil
+---@param node_type string | string[]
 ---@return TSNode | nil
-function M.closest_node(node, type)
+function M.closest_node(node, node_type)
   if not node then
     return nil
   end
-  if node:type() == type then
-    return node
+  local types = type(node_type) == 'table' and node_type or { node_type }
+
+  for _, t in ipairs(types) do
+    if node:type() == t then
+      return node
+    end
   end
 
-  return M.closest_node(node:parent(), type)
+  return M.closest_node(node:parent(), types)
 end
 
 ---@param node? TSNode

lua/orgmode/utils/treesitter/install.lua

@@ -145,7 +145,8 @@ end
 
 ---@param type? 'install' | 'update' | 'reinstall''
 function M.run(type)
-  local url = 'https://github.com/nvim-orgmode/tree-sitter-org'
+  -- local url = 'https://github.com/nvim-orgmode/tree-sitter-org'
+  local url = '/home/kristijan/github/tree-sitter-org'
   local compiler = vim.tbl_filter(function(exe)
     return exe ~= vim.NIL and vim.fn.executable(exe) == 1
   end, M.compilers)[1]

queries/org/highlights.scm

@@ -11,11 +11,11 @@
 (headline (stars) @stars (#org-is-headline-level? @stars "8")) @org.headline.level8
 (item . (expr) @org.keyword.todo @nospell (#org-is-todo-keyword? @org.keyword.todo "TODO"))
 (item . (expr) @org.keyword.done @nospell (#org-is-todo-keyword? @org.keyword.done "DONE"))
-(item (expr "[" "#" "str" @_priority "]") @org.priority.highest (#org-is-valid-priority? @_priority "highest"))
-(item (expr "[" "#" "str" @_priority "]") @org.priority.high (#org-is-valid-priority? @_priority "high"))
-(item (expr "[" "#" "str" @_priority "]") @org.priority.default (#org-is-valid-priority? @_priority "default"))
-(item (expr "[" "#" "str" @_priority "]") @org.priority.low (#org-is-valid-priority? @_priority "low"))
-(item (expr "[" "#" "str" @_priority "]") @org.priority.lowest (#org-is-valid-priority? @_priority "lowest"))
+(item priority: (priority value: (expr) @_priority) @org.priority.highest (#org-is-valid-priority? @_priority "highest"))
+(item priority: (priority value: (expr) @_priority) @org.priority.high (#org-is-valid-priority? @_priority "high"))
+(item priority: (priority value: (expr) @_priority) @org.priority.default (#org-is-valid-priority? @_priority "default"))
+(item priority: (priority value: (expr) @_priority) @org.priority.low (#org-is-valid-priority? @_priority "low"))
+(item priority: (priority value: (expr) @_priority) @org.priority.lowest (#org-is-valid-priority? @_priority "lowest"))
 (list (listitem (paragraph) @spell))
 (body (paragraph) @spell)
 (bullet) @org.bullet
@@ -42,3 +42,8 @@
 (table (row (cell (contents) @org.table.heading)))
 (table (hr) @org.table.delimiter)
 (fndef label: (expr) @org.footnote (#offset! @org.footnote 0 -4 0 1))
+(link) @org.hyperlink
+(link_desc) @org.hyperlink
+(link "[[" @_link_open "]]" @_link_close (#set! conceal ""))
+(link_desc "[[" @_link_open "][" @_link_separator "]]" @_link_close (#set! conceal ""))
+((link_desc url: (expr)+ @_link_url (#set! @_link_url conceal "")) @_link (#set! @_link url @_link_url))

queries/org/images.scm

@@ -1 +1,4 @@
-((expr "[") @image (#org-set-link! @image))
+(link url: (expr) @image.src
+  (#gsub! @image.src "^file:" "")
+  (#match? @image.src "(png|jpg|jpeg|gif|bmp|webp|tiff|heic|avif|mp4|mov|avi|mkv|webm|pdf)$")
+)

syntax/orgagenda.vim

@@ -5,6 +5,39 @@ syn match org_hyperlinkBracketsLeft	contained "\[\{2}"     conceal
 syn match org_hyperlinkURL				    contained "[^][]*\]\[" conceal
 syn match org_hyperlinkBracketsRight	contained "\]\{2}"     conceal
 
+syn match org_timestamp /\(<\d\d\d\d-\d\d-\d\d \k\k\k>\)/
+"<2003-09-16 Tue 12:00>
+syn match org_timestamp /\(<\d\d\d\d-\d\d-\d\d \k\k\k \d\d:\d\d>\)/
+"<2003-09-16 Tue 12:00 +1d>
+syn match org_timestamp /\(<\d\d\d\d-\d\d-\d\d \k\k\k \d\d:\d\d [+-]\d\+\w>\)/
+"<2003-09-16 Tue 12:00 +1d -1y>
+syn match org_timestamp /\(<\d\d\d\d-\d\d-\d\d \k\k\k \d\d:\d\d [+-]\d\+\w [+-]\d\+\w>\)/
+"<2003-09-16 Tue 12:00-12:30>
+syn match org_timestamp /\(<\d\d\d\d-\d\d-\d\d \k\k\k \d\d:\d\d-\d\d:\d\d>\)/
+
+"<2003-09-16 Tue>--<2003-09-16 Tue>
+syn match org_timestamp /\(<\d\d\d\d-\d\d-\d\d \k\k\k>--<\d\d\d\d-\d\d-\d\d \k\k\k>\)/
+"<2003-09-16 Tue 12:00>--<2003-09-16 Tue 12:00>
+syn match org_timestamp /\(<\d\d\d\d-\d\d-\d\d \k\k\k \d\d:\d\d>--<\d\d\d\d-\d\d-\d\d \k\k\k \d\d:\d\d>\)/
+
+"[2003-09-16 Tue]
+syn match org_timestamp_inactive /\(\[\d\d\d\d-\d\d-\d\d \k\k\k\]\)/
+"[2003-09-16 Tue 12:00]
+syn match org_timestamp_inactive /\(\[\d\d\d\d-\d\d-\d\d \k\k\k \d\d:\d\d\]\)/
+
+"[2003-09-16 Tue 12:00 +1d]
+syn match org_timestamp_inactive /\(\[\d\d\d\d-\d\d-\d\d \k\k\k \d\d:\d\d [+-]\d\+\w\]\)/
+"[2003-09-16 Tue 12:00 +1d -1y]
+syn match org_timestamp_inactive /\(\[\d\d\d\d-\d\d-\d\d \k\k\k \d\d:\d\d [+-]\d\+\w [+-]\d\+\w\]\)/
+
+"[2003-09-16 Tue]--[2003-09-16 Tue]
+syn match org_timestamp_inactive /\(\[\d\d\d\d-\d\d-\d\d \k\k\k\]--\[\d\d\d\d-\d\d-\d\d \k\k\k\]\)/
+"[2003-09-16 Tue 12:00]--[2003-09-16 Tue 12:00]
+syn match org_timestamp_inactive /\(\[\d\d\d\d-\d\d-\d\d \k\k\k \d\d:\d\d\]--\[\d\d\d\d-\d\d-\d\d \k\k\k \d\d:\d\d\]\)/
+
+hi default link org_timestamp @org.timestamp.active
+hi default link org_timestamp_inactive @org.timestamp.inactive
+
 hi default link @org.agenda.day Statement
 hi default link @org.agenda.today @org.bold
 hi default link @org.agenda.weekend @org.bold