Refactoring/hyperlinks (#588)

Author: seflue

lua/orgmode/objects/link.lua

@@ -0,0 +1,50 @@
+local Url = require('orgmode.objects.url')
+
+---@class Link
+---@field url Url
+---@field desc string | nil
+local Link = {}
+
+---@param str string
+function Link:init(str)
+  local parts = vim.split(str, '][', true)
+  self.url = Url.new(parts[1] or '')
+  self.desc = parts[2]
+end
+
+---@return string
+function Link:to_str()
+  if self.desc then
+    return string.format('[[%s][%s]]', self.url.str, self.desc)
+  else
+    return string.format('[[%s]]', self.url.str)
+  end
+end
+
+---@param str string
+function Link.new(str)
+  local self = setmetatable({}, { __index = Link })
+  self:init(str)
+  return self
+end
+
+---@param line string
+---@param pos number
+---@return Link | nil
+function Link.at_pos(line, pos)
+  local links = {}
+  local found_link = nil
+  local pattern = '%[%[([^%]]+.-)%]%]'
+  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 pos >= from and pos <= to then
+      found_link = link
+      break
+    end
+    table.insert(links, { link = link, from = from, to = to })
+  end
+  return (found_link and Link.new(found_link) or nil)
+end
+
+return Link

lua/orgmode/objects/url.lua

@@ -0,0 +1,167 @@
+local utils = require('orgmode.utils')
+local fs = require('orgmode.utils.fs')
+
+---@class Url
+---@field str string
+local Url = {}
+
+function Url:init(str)
+  self.str = str
+end
+
+function Url.new(str)
+  local self = setmetatable({}, { __index = Url })
+  self:init(str)
+  return self
+end
+
+---@return boolean
+function Url:is_file_line_number()
+  return self:get_linenumber() and true
+end
+
+---@return boolean
+function Url:is_headline()
+  return self:is_file_headline() or self:is_internal_headline()
+end
+
+---@return boolean
+function Url:is_file_headline()
+  return self:is_file() and self:get_headline() and true
+end
+
+function Url:is_custom_id()
+  return self:is_file_custom_id() or self:is_internal_custom_id()
+end
+
+---@return boolean
+function Url:is_file_custom_id()
+  return self:is_file() and self:get_custom_id() and true
+end
+
+---@return boolean
+function Url:is_file_anchor()
+  return self:get_dedicated_target() and true
+end
+
+---@return boolean
+function Url:is_org_link()
+  return (self:get_dedicated_target() or self:get_custom_id() or self:get_headline()) and true
+end
+
+function Url:is_file()
+  return self.str:find('^file:') or self.str:find('^./') or self.str:find('^/')
+end
+
+function Url:is_file_plain()
+  return self:is_file() and not self:is_org_link() and not self:is_file_line_number()
+end
+
+---@return boolean
+function Url:is_http_url()
+  return self:get_http_url() and true
+end
+
+---@return boolean
+function Url:is_internal_headline()
+  return self.str:find('^*') and true
+end
+
+function Url:is_internal_custom_id()
+  return self.str:find('^#')
+end
+
+function Url:is_dedicated_anchor_or_internal_title()
+  return self:get_dedicated_target() ~= nil
+end
+
+---@return string | false
+function Url:extract_path()
+  local url = self
+  if url:is_file_headline() or url:is_file_custom_id() then
+    return url.str:match('^file:([^:]-)::') or url.str:match('^(./[^:]-)::') or url.str:match('^(/[^:]-)::')
+  elseif url:is_file_line_number() then
+    return url.str:match('^file:([^:]-) %+') or url.str:match('^(./[^:]-) %+') or url.str:match('^(/[^:]-) %+')
+  elseif url:is_file_plain() then
+    return url.str:match('^file:([^:]-)$') or url.str:match('^(./[^:]-)$') or url.str:match('^(/[^:]-)$')
+  else
+    return false
+  end
+end
+
+---@return string | false
+function Url:get_file_real_path()
+  local filepath = self:get_filepath()
+  return filepath and fs.get_real_path(filepath)
+end
+
+---@return string | false
+function Url:get_headline()
+  return self.str:match('^file:[^:]+::%*(.-)$')
+    or self.str:match('^./[^:]+::%*(.-)$')
+    or self.str:match('^/[^:]+::%*(.-)$')
+    or self.str:match('^%*(.-)$')
+end
+
+---@return string | false
+function Url:get_custom_id()
+  return self.str:match('^file:[^:]+::#(.-)$')
+    or self.str:match('^./[^:]+::#(.-)$')
+    or self.str:match('^/[^:]+::#(.-)$')
+    or self.str:match('^#(.-)$')
+end
+
+---@return number | false
+function Url:get_linenumber()
+  -- official orgmode convention
+  return self.str:match('^file:[^:]+::(%d+)$')
+    or self.str:match('^./[^:]+::(%d+)$')
+    or self.str:match('^/[^:]+::(%d+)$')
+    -- for backwards compatibility
+    or self.str:match('^file:[^:]+ %+(%d+)$')
+    or self.str:match('^./[^:]+ %+(%d+)$')
+    or self.str:match('^/[^:]+ %+(%d+)$')
+end
+
+---@return string | false
+function Url:get_filepath()
+  return
+    -- for backwards compatibility
+    self.str:match('^file:([^:]+) %+%d+')
+      or self.str:match('^(%./[^:]+) %+%d+')
+      or self.str:match('^(/[^:]+) %+%d+')
+      -- official orgmode convention
+      or self.str:match('^file:([^:]+)::')
+      or self.str:match('^(%./[^:]+)::')
+      or self.str:match('^(/[^:]+)::')
+      or self.str:match('^file:([^:]+)$')
+      or self.str:match('^(%./[^:]+)$')
+      or self.str:match('^(/[^:]+)$')
+      or self.str:match('^(%./)$')
+      or self.str:match('^(/)$')
+end
+--
+---@return string
+function Url:get_headline_completion()
+  return self.str:match('^.+::%*(.*)$') or self.str:match('^%*(.*)$')
+end
+
+---@return string
+function Url:get_custom_id_completion()
+  return self.str:match('^.+::#(.*)$') or self.str:match('^#(.*)$')
+end
+
+---@return string | false
+function Url:get_dedicated_target()
+  return not self:get_filepath()
+    and not self:get_linenumber()
+    and not self:get_headline()
+    and self.str:match('^([%w%s%-%+%=_]+)$')
+end
+
+---@return string | false
+function Url:get_http_url()
+  return self.str:match('^https?://.+$')
+end
+
+return Url

lua/orgmode/org/autocompletion/omni.lua

@@ -1,6 +1,8 @@
 local Files = require('orgmode.parser.files')
 local config = require('orgmode.config')
 local Hyperlinks = require('orgmode.org.hyperlinks')
+local Url = require('orgmode.objects.url')
+local Link = require('orgmode.objects.link')
 
 local data = {
   directives = { '#+title', '#+author', '#+email', '#+name', '#+filetags', '#+archive', '#+options', '#+category' },
@@ -33,7 +35,10 @@ local properties = {
 local links = {
   line_rgx = vim.regex([[\(\(^\|\s\+\)\[\[\)\@<=\(\*\|\#\|file:\)\?\(\(\w\|\/\|\.\|\\\|-\|_\|\d\)\+\)\?]]),
   rgx = vim.regex([[\(\*\|\#\|file:\)\?\(\(\w\|\/\|\.\|\\\|-\|_\|\d\)\+\)\?$]]),
-  fetcher = Hyperlinks.find_matching_links,
+  fetcher = function(url)
+    local hyperlinks, mapper = Hyperlinks.find_matching_links(url)
+    return mapper(hyperlinks)
+  end,
 }
 
 local metadata = {
@@ -86,6 +91,19 @@ local headline_contexts = {
   todo_keywords,
 }
 
+---Determines an URL for link handling. Handles a couple of corner-cases
+---@param base string The string to complete
+---@return string
+local function get_url_str(line, base)
+  local line_base = line:match('%[%[(.-)$') or line
+  line_base = line_base:gsub(base .. '$', '')
+  return (line_base or '') .. (base or '')
+end
+
+--- This function is registered to omnicompletion in ftplugin/org.vim.
+---
+--- If the user want to use it in his completion plugin (like cmp) he has to do
+--- that in the configuration of that plugin.
 ---@return table
 local function omni(findstart, base)
   local line = vim.api.nvim_get_current_line():sub(1, vim.api.nvim_call_function('col', { '.' }) - 1)
@@ -101,7 +119,7 @@ local function omni(findstart, base)
     return -1
   end
 
-  local fetcher_ctx = { base = base, line = line }
+  local url = Url.new(get_url_str(line, base))
   local results = {}
 
   for _, context in ipairs(ctx) do
@@ -112,7 +130,7 @@ local function omni(findstart, base)
     then
       local items = {}
       if context.fetcher then
-        items = context.fetcher(fetcher_ctx)
+        items = context.fetcher(url)
       else
         items = { unpack(context.list) }
       end