refactor(todo_keywords): Extract todo keywords parsing from config class (#697)

Author: kristijanhusak

lua/orgmode/colors/highlights.lua

@@ -154,22 +154,40 @@ function M.define_todo_keyword_faces()
   local opts = {
     underline = {
       type = vim.o.termguicolors and 'gui' or 'cterm',
-      valid = 'on',
+      is_valid = function(value)
+        return value == 'on'
+      end,
       result = 'underline',
     },
     weight = {
       type = vim.o.termguicolors and 'gui' or 'cterm',
-      valid = 'bold',
+      is_valid = function(value)
+        return value == 'bold'
+      end,
     },
     foreground = {
       type = vim.o.termguicolors and 'guifg' or 'ctermfg',
+      is_valid = function(value)
+        if vim.o.termguicolors then
+          return true
+        end
+        return value:sub(1, 1) ~= '#'
+      end,
     },
     background = {
       type = vim.o.termguicolors and 'guibg' or 'ctermbg',
+      is_valid = function(value)
+        if vim.o.termguicolors then
+          return true
+        end
+        return value:sub(1, 1) ~= '#'
+      end,
     },
     slant = {
       type = vim.o.termguicolors and 'gui' or 'cterm',
-      valid = 'italic',
+      is_valid = function(value)
+        return value == 'italic'
+      end,
     },
   }
 
@@ -185,7 +203,7 @@ function M.define_todo_keyword_faces()
         local opt_value = vim.trim(faces[2])
         opt_value = opt_value:gsub('^"*', ''):gsub('"*$', '')
         local opt = opts[opt_name]
-        if opt and (not opt.valid or opt.valid == opt_value) then
+        if opt and opt.is_valid(opt_value) then
           if not hl_opts[opt.type] then
             hl_opts[opt.type] = {}
           end

lua/orgmode/config/_meta.lua

@@ -4,10 +4,11 @@ local fs = require('orgmode.utils.fs')
 local defaults = require('orgmode.config.defaults')
 ---@type table<string, OrgMapEntry>
 local mappings = require('orgmode.config.mappings')
+local TodoKeywords = require('orgmode.objects.todo_keywords')
 
 ---@class OrgConfig:OrgDefaultConfig
 ---@field opts table
----@field todo_keywords table
+---@field todo_keywords OrgTodoKeywords
 local Config = {}
 
 ---@param opts? table
@@ -183,48 +184,13 @@ end
 ---@return OrgTodoKeywords
 function Config:get_todo_keywords()
   if self.todo_keywords then
-    return vim.deepcopy(self.todo_keywords)
+    return self.todo_keywords
   end
-  local parse_todo = function(val)
-    local value, shortcut = val:match('(.*)%((.)[^%)]*%)$')
-    if value and shortcut then
-      return { value = value, shortcut = shortcut, custom_shortcut = true }
-    end
-    return { value = val, shortcut = val:sub(1, 1):lower(), custom_shortcut = false }
-  end
-  local types = { TODO = {}, DONE = {}, ALL = {}, KEYS = {}, FAST_ACCESS = {}, has_fast_access = false }
-  local type = 'TODO'
-  local has_separator = vim.tbl_contains(self.opts.org_todo_keywords, '|')
-  local index = 1
-  for i, word in ipairs(self.opts.org_todo_keywords) do
-    if word == '|' then
-      type = 'DONE'
-    else
-      if not has_separator and i == #self.opts.org_todo_keywords then
-        type = 'DONE'
-      end
-      local data = parse_todo(word)
-      if data.custom_shortcut then
-        types.has_fast_access = true
-      end
-      table.insert(types[type], data.value)
-      table.insert(types.ALL, data.value)
-      types.KEYS[data.value] = {
-        type = type,
-        shortcut = data.shortcut,
-        len = data.value:len(),
-        index = index,
-      }
-      table.insert(types.FAST_ACCESS, {
-        value = data.value,
-        type = type,
-        shortcut = data.shortcut,
-      })
-      index = index + 1
-    end
-  end
-  self.todo_keywords = types
-  return types
+  self.todo_keywords = TodoKeywords:new({
+    org_todo_keywords = self.opts.org_todo_keywords,
+    org_todo_keyword_faces = self.opts.org_todo_keyword_faces,
+  })
+  return self.todo_keywords
 end
 
 --- Setup mappings for a given category and buffer
@@ -340,7 +306,7 @@ function Config:get_priorities()
 end
 
 function Config:setup_ts_predicates()
-  local todo_keywords = self:get_todo_keywords().KEYS
+  local todo_keywords = self:get_todo_keywords():keys()
   local valid_priorities = self:get_priorities()
 
   vim.treesitter.query.add_predicate('org-is-todo-keyword?', function(match, _, source, predicate)

lua/orgmode/config/init.lua

@@ -306,22 +306,22 @@ memoize('get_todo')
 --- and it's type (todo or done)
 --- @return string | nil, TSNode | nil, string | nil
 function Headline:get_todo()
-  local todo_keywords = config:get_todo_keywords()
-  local keywords_info = todo_keywords.KEYS
-
   -- A valid keyword can only be the first child
   local first_item_node = self:_get_child_node('item')
   local todo_node = first_item_node and first_item_node:named_child(0)
   if not todo_node then
     return nil, nil, nil
   end
 
+  local todo_keywords = config:get_todo_keywords()
+
   local text = self.file:get_node_text(todo_node)
-  if not keywords_info[text] then
+  local keyword_by_value = todo_keywords:find(text)
+  if not keyword_by_value then
     return nil, nil, nil
   end
 
-  return text, todo_node, keywords_info[text].type
+  return text, todo_node, keyword_by_value.type
 end
 
 ---@return boolean

lua/orgmode/files/headline.lua

@@ -0,0 +1,143 @@
+local utils = require('orgmode.utils')
+local TodoKeyword = require('orgmode.objects.todo_keywords.todo_keyword')
+
+---@class OrgTodoKeywords
+---@field org_todo_keywords string[]
+---@field org_todo_keyword_faces table<string, string>
+---@field todo_keywords OrgTodoKeyword[]
+local TodoKeywords = {}
+TodoKeywords.__index = TodoKeywords
+
+---@param opts { org_todo_keywords: string[], org_todo_keyword_faces: table<string, string> }
+---@return OrgTodoKeywords
+function TodoKeywords:new(opts)
+  local this = setmetatable({
+    org_todo_keywords = opts.org_todo_keywords,
+    org_todo_keyword_faces = opts.org_todo_keyword_faces,
+  }, self)
+  this:_parse()
+  return this
+end
+
+---Return a lookup table of all todo keywords by value.
+---@return table<string, OrgTodoKeyword>
+function TodoKeywords:keys()
+  local result = {}
+  for _, keyword in ipairs(self.todo_keywords) do
+    result[keyword.value] = keyword
+  end
+  return result
+end
+
+---@return boolean
+function TodoKeywords:has_fast_access()
+  return utils.find(self.todo_keywords, function(todo_keyword)
+    return todo_keyword.has_fast_access
+  end) and true or false
+end
+
+---@param keyword string
+---@return OrgTodoKeyword | nil
+function TodoKeywords:find(keyword)
+  return utils.find(self.todo_keywords, function(todo_keyword)
+    return todo_keyword.value == keyword
+  end)
+end
+
+---@param type OrgTodoKeywordType
+---@return OrgTodoKeyword
+function TodoKeywords:first_by_type(type)
+  for _, keyword in ipairs(self.todo_keywords) do
+    if type == keyword.type then
+      return keyword
+    end
+  end
+  return self.todo_keywords[#self.todo_keywords]
+end
+
+---@return OrgTodoKeyword[]
+function TodoKeywords:all()
+  return self.todo_keywords
+end
+
+---@return OrgTodoKeyword
+function TodoKeywords:first()
+  return self.todo_keywords[1]
+end
+
+---@return OrgTodoKeyword
+function TodoKeywords:last()
+  return self.todo_keywords[#self.todo_keywords]
+end
+
+---@return string[]
+function TodoKeywords:all_values()
+  return vim.tbl_map(function(todo_keyword)
+    return todo_keyword.value
+  end, self.todo_keywords)
+end
+
+---@private
+function TodoKeywords:_parse()
+  local todo, done = self:_split_todo_and_done()
+  local list = {}
+  for i, keyword in ipairs(todo) do
+    local todo_keyword = TodoKeyword:new({
+      type = 'TODO',
+      keyword = keyword,
+      index = i,
+    })
+    todo_keyword.hl = self:_get_hl(todo_keyword.value, 'TODO')
+    table.insert(list, todo_keyword)
+  end
+
+  for i, keyword in ipairs(done) do
+    local todo_keyword = TodoKeyword:new({
+      type = 'DONE',
+      keyword = keyword,
+      index = #todo + i,
+    })
+    todo_keyword.hl = self:_get_hl(todo_keyword.value, 'DONE')
+    table.insert(list, todo_keyword)
+  end
+
+  self.todo_keywords = list
+end
+
+---@private
+---@param keyword string
+---@param type OrgTodoKeywordType
+---@return string
+function TodoKeywords:_get_hl(keyword, type)
+  if not self.org_todo_keyword_faces[keyword] then
+    return type == 'TODO' and '@org.keyword.todo' or '@org.keyword.done'
+  end
+  return ('@org.keyword.face.%s'):format(keyword:gsub('%-', ''))
+end
+
+---@private
+---@return string[], string[]
+function TodoKeywords:_split_todo_and_done()
+  local keywords = self.org_todo_keywords
+  local has_separator = vim.tbl_contains(keywords, '|')
+  if not has_separator then
+    return { unpack(keywords, 1, #keywords - 1) }, { keywords[#keywords] }
+  end
+
+  local type = 'TODO'
+  local by_type = {
+    TODO = {},
+    DONE = {},
+  }
+  for _, keyword in ipairs(keywords) do
+    if keyword == '|' then
+      type = 'DONE'
+    else
+      table.insert(by_type[type], keyword)
+    end
+  end
+
+  return by_type.TODO, by_type.DONE
+end
+
+return TodoKeywords

lua/orgmode/objects/todo_keywords/init.lua

@@ -0,0 +1,54 @@
+---@alias OrgTodoKeywordType 'TODO' | 'DONE'
+
+---@class OrgTodoKeyword
+---@field keyword string
+---@field index number
+---@field type OrgTodoKeywordType
+---@field value string
+---@field shortcut string
+---@field hl string
+---@field has_fast_access boolean
+local TodoKeyword = {}
+TodoKeyword.__index = TodoKeyword
+
+---@param opts { type: OrgTodoKeywordType, keyword: string, index: number }
+---@return OrgTodoKeyword
+function TodoKeyword:new(opts)
+  local this = setmetatable({
+    keyword = opts.keyword,
+    type = opts.type,
+    index = opts.index,
+    has_fast_access = false,
+  }, self)
+  this:parse()
+  return this
+end
+
+function TodoKeyword:empty()
+  return setmetatable({
+    keyword = '',
+    value = '',
+    type = '',
+    index = 1,
+    has_fast_access = false,
+    hl = '',
+  }, self)
+end
+
+function TodoKeyword:is_empty()
+  return self.keyword == ''
+end
+
+function TodoKeyword:parse()
+  self.value = self.keyword
+  self.shortcut = self.keyword:sub(1, 1):lower()
+
+  local value, shortcut = self.keyword:match('(.*)%((.)[^%)]*%)$')
+  if value and shortcut then
+    self.value = value
+    self.shortcut = shortcut
+    self.has_fast_access = true
+  end
+end
+
+return TodoKeyword