Add support for fast access to TODO states. Closes #63.

kristijanhusak · kristijanhusak · commit e49da78d9a7e · 2021-08-06T23:04:58.000+02:00
diff --git a/DOCS.md b/DOCS.md
@@ -44,10 +44,19 @@ Example: `~/Dropbox/org/notes.org`
 List of "unfinished" and "finished" states.<br />
 `|` is used as a separator between "unfinished" and "finished".<br />
 If `|` is omitted, only last entry in array is considered a "finished" state.<br />
-Examples:
+To use [Fast access to TODO States](https://orgmode.org/manual/Fast-access-to-TODO-states.html#Fast-access-to-TODO-states)
+set a fast access key to at least one of the entries.<br />
+
+Examples (without the fast access):
   * `{'TODO', 'NEXT', '|', 'DONE'}`
   * `{'TODO', 'WAITING', '|', 'DONE', 'DELEGATED'}`
 
+Examples (With fast access):
+  * `{'TODO(t)', 'NEXT(n)', '|', 'DONE(d)'}`
+  * `{'TODO(t)', 'NEXT', '|', 'DONE'}` - will work same as above. Only one todo keyword needs to have fast access key, others will be parsed from first char.
+
+NOTE: Make sure fast access keys do not overlap. If that happens, first entry in list gets it.
+
 #### **org_todo_keyword_faces**
 *type*: `table<string, string>`<br />
 *default value*: `{}`<br />
@@ -480,10 +489,10 @@ Decrease date under cursor by 1 day
 Change date under cursor. Opens calendar to select new date
 #### **org_todo**
 *mapped to*: `cit`<br />
-Cycle todo keyword forward on current headline  ()
+Cycle todo keyword forward on current headline or open fast access to TODO states prompt (see [org_todo_keywords](#org_todo_keywords)) if it's enabled.
 #### **org_todo_prev**
 *mapped to*: `ciT`<br />
-Cycle todo keyword forward on current headline  ()
+Cycle todo keyword backward on current headline.
 #### **org_toggle_checkbox**
 *mapped to*: `<C-Space>`<br />
 Toggle current line checkbox state
diff --git a/doc/orgmode.txt b/doc/orgmode.txt
@@ -147,10 +147,19 @@ default value: `{'TODO', '|', 'DONE'}`
 List of "unfinished" and "finished" states.
 `|` is used as a separator between "unfinished" and "finished".
 If `|` is omitted, only last entry in array is considered a "finished" state.
-Examples:
+To use Fast access to TODO States (https://orgmode.org/manual/Fast-access-to-TODO-states.html#Fast-access-to-TODO-states)
+set a fast access key to at least one of the entries.
+
+Examples (without the fast access):
   * `{'TODO', 'NEXT', '|', 'DONE'}`
   * `{'TODO', 'WAITING', '|', 'DONE', 'DELEGATED'}`
 
+Examples (With fast access):
+  * `{'TODO(t)', 'NEXT(n)', '|', 'DONE(d)'}`
+  * `{'TODO(t)', 'NEXT', '|', 'DONE'}` - will work same as above. Only one todo keyword needs to have fast access key, others will be parsed from first char.
+
+NOTE: Make sure fast access keys do not overlap. If that happens, first entry in list gets it.
+
 ORG_TODO_KEYWORD_FACES                            *orgmode-org_todo_keyword_faces*
 
 type: `table<string, string>`
@@ -646,12 +655,12 @@ Change date under cursor. Opens calendar to select new date
 ORG_TODO                                                        *orgmode-org_todo*
 
 mapped to: `cit`
-Cycle todo keyword forward on current headline  ()
+Cycle todo keyword forward on current headline or open fast access to TODO states prompt (see org_todo_keywords (#org_todo_keywords)) if it's enabled.
 
 ORG_TODO_PREV                                              *orgmode-org_todo_prev*
 
 mapped to: `ciT`
-Cycle todo keyword forward on current headline  ()
+Cycle todo keyword backward on current headline.
 
 ORG_TOGGLE_CHECKBOX                                  *orgmode-org_toggle_checkbox*
 
diff --git a/lua/orgmode/config/init.lua b/lua/orgmode/config/init.lua
@@ -4,12 +4,15 @@ local defaults = require('orgmode.config.defaults')
 local mappings = require('orgmode.config.mappings')
 
 ---@class Config
+---@field opts table
+---@field todo_keywords table
 local Config = {}
 
 ---@param opts? table
 function Config:new(opts)
   local data = {
     opts = vim.tbl_deep_extend('force', defaults, opts or {}),
+    todo_keywords = nil,
   }
   setmetatable(data, self)
   return data
@@ -25,6 +28,7 @@ end
 ---@param opts table
 ---@return Config
 function Config:extend(opts)
+  self.todo_keywords = nil
   self.opts = vim.tbl_deep_extend('force', self.opts, opts or {})
   return self
 end
@@ -93,19 +97,39 @@ function Config:get_agenda_span()
 end
 
 function Config:get_todo_keywords()
-  local types = { TODO = {}, DONE = {}, ALL = {} }
+  if self.todo_keywords then
+    return vim.deepcopy(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 = {}, FAST_ACCESS = {}, has_fast_access = false }
   local type = 'TODO'
   for _, word in ipairs(self.opts.org_todo_keywords) do
     if word == '|' then
       type = 'DONE'
     else
-      table.insert(types[type], word)
-      table.insert(types.ALL, word)
+      local data = parse_todo(word)
+      if not types.has_fast_access and data.custom_shortcut then
+        types.has_fast_access = true
+      end
+      table.insert(types[type], data.value)
+      table.insert(types.ALL, data.value)
+      table.insert(types.FAST_ACCESS, {
+        value = data.value,
+        type = type,
+        shortcut = data.shortcut,
+      })
     end
   end
   if #types.DONE == 0 then
     types.DONE = { table.remove(types.TODO, #types.TODO) }
   end
+  self.todo_keywords = types
   return types
 end
 
diff --git a/lua/orgmode/objects/todo_state.lua b/lua/orgmode/objects/todo_state.lua
@@ -1,7 +1,9 @@
 local config = require('orgmode.config')
+local highlights = require('orgmode.colors.highlights')
 
 ---@class TodoState
 ---@field current_state string
+---@field hl_map table
 ---@field todos table
 local TodoState = {}
 
@@ -11,20 +13,54 @@ function TodoState:new(data)
   opts.current_state = data.current_state or ''
   local todo_keywords = config:get_todo_keywords()
   opts.todos = {
-    TODO = vim.tbl_add_reverse_lookup(todo_keywords.TODO),
-    DONE = vim.tbl_add_reverse_lookup(todo_keywords.DONE),
-    ALL = vim.tbl_add_reverse_lookup(todo_keywords.ALL),
+    TODO = vim.tbl_add_reverse_lookup({ unpack(todo_keywords.TODO) }),
+    DONE = vim.tbl_add_reverse_lookup({ unpack(todo_keywords.DONE) }),
+    ALL = vim.tbl_add_reverse_lookup({ unpack(todo_keywords.ALL) }),
+    FAST_ACCESS = todo_keywords.FAST_ACCESS,
+    has_fast_access = todo_keywords.has_fast_access,
   }
+  opts.hl_map = highlights.get_agenda_hl_map()
   setmetatable(opts, self)
   self.__index = self
   return opts
 end
 
+---@return boolean
+function TodoState:has_fast_access()
+  return self.todos.has_fast_access
+end
+
+function TodoState:open_fast_access()
+  local output = {}
+
+  for _, todo in ipairs(self.todos.FAST_ACCESS) do
+    table.insert(output, { string.format('[%s] ', todo.shortcut) })
+    table.insert(output, { todo.value, self.hl_map[todo.value] or self.hl_map[todo.type] })
+    table.insert(output, { '  ' })
+  end
+
+  table.insert(output, { '\n' })
+  vim.api.nvim_echo(output, true, {})
+  local char = vim.fn.nr2char(vim.fn.getchar())
+  vim.cmd([[redraw!]])
+  if char == ' ' then
+    self.current_state = ''
+    return { value = '', type = '' }
+  end
+  for _, todo in ipairs(self.todos.FAST_ACCESS) do
+    if char == todo.shortcut then
+      self.current_state = todo.value
+      return { value = todo.value, type = todo.type, hl = self.hl_map[todo.value] or self.hl_map[todo.type] }
+    end
+  end
+end
+
 ---@return table
 function TodoState:get_next()
   if self.current_state == '' then
     self.current_state = self.todos.ALL[1]
-    return { value = self.todos.ALL[1], type = 'TODO' }
+    local val = self.todos.ALL[1]
+    return { value = val, type = 'TODO', hl = self.hl_map[val] or self.hl_map.TODO }
   end
   local current_item_index = self.todos.ALL[self.current_state]
   local next_state = self.todos.ALL[current_item_index + 1]
@@ -35,15 +71,15 @@ function TodoState:get_next()
   self.current_state = next_state
   local type = self.todos.TODO[next_state] and 'TODO' or 'DONE'
 
-  return { value = next_state, type = type }
+  return { value = next_state, type = type, hl = self.hl_map[next_state] or self.hl_map[type] }
 end
 
 ---@return table
 function TodoState:get_prev()
   if self.current_state == '' then
     local last_item = self.todos.ALL[#self.todos.ALL]
     self.current_state = last_item
-    return { value = last_item, type = 'DONE' }
+    return { value = last_item, type = 'DONE', hl = self.hl_map[last_item] or self.hl_map.DONE }
   end
   local current_item_index = self.todos.ALL[self.current_state]
   local prev_state = self.todos.ALL[current_item_index - 1]
@@ -54,11 +90,12 @@ function TodoState:get_prev()
   self.current_state = prev_state
   local type = self.todos.TODO[prev_state] and 'TODO' or 'DONE'
 
-  return { value = prev_state, type = type }
+  return { value = prev_state, type = type, hl = self.hl_map[prev_state] or self.hl_map[type] }
 end
 
 function TodoState:get_todo()
-  return { value = self.todos.TODO[1], type = 'TODO' }
+  local first = self.todos.TODO[1]
+  return { value = first, type = 'TODO', hl = self.hl_map[first] or self.hl_map.TODO }
 end
 
 return TodoState
diff --git a/lua/orgmode/org/mappings.lua b/lua/orgmode/org/mappings.lua
@@ -146,7 +146,10 @@ function OrgMappings:todo_next_state()
   local item = Files.get_current_file():get_closest_headline()
   local was_done = item:is_done()
   local old_state = item.todo_keyword.value
-  self:_change_todo_state('next')
+  local changed = self:_change_todo_state('next', true)
+  if not changed then
+    return
+  end
   item = Files.get_current_file():get_closest_headline()
   if not item:is_done() and not was_done then
     return item
@@ -168,7 +171,7 @@ function OrgMappings:todo_next_state()
     self:_replace_date(date:apply_repeater())
   end
 
-  self:_change_todo_state('reset')
+  self:_change_todo_state('reset', true)
   local state_change = string.format(
     '- State "%s" from "%s" [%s]',
     item.todo_keyword.value,
@@ -387,17 +390,34 @@ function OrgMappings:outline_up_heading()
 end
 
 ---@param direction string
-function OrgMappings:_change_todo_state(direction)
+---@param skip_fast_access boolean
+---@return string
+function OrgMappings:_change_todo_state(direction, use_fast_access)
   local item = Files.get_current_file():get_closest_headline()
   local todo = item.todo_keyword
   local todo_state = TodoState:new({ current_state = todo.value })
   local next_state = nil
-  if direction == 'next' then
-    next_state = todo_state:get_next()
-  elseif direction == 'prev' then
-    next_state = todo_state:get_prev()
-  elseif direction == 'reset' then
-    next_state = todo_state:get_todo()
+  if use_fast_access and todo_state:has_fast_access() then
+    next_state = todo_state:open_fast_access()
+  else
+    if direction == 'next' then
+      next_state = todo_state:get_next()
+    elseif direction == 'prev' then
+      next_state = todo_state:get_prev()
+    elseif direction == 'reset' then
+      next_state = todo_state:get_todo()
+    end
+  end
+
+  if not next_state then
+    return false
+  end
+
+  if next_state.value == todo.value then
+    if todo.value ~= '' then
+      utils.echo_info('TODO state was already ', { { next_state.value, next_state.hl } })
+    end
+    return false
   end
 
   local linenr = item.range.start_line
@@ -412,6 +432,7 @@ function OrgMappings:_change_todo_state(direction)
   end
   local new_line = vim.fn.getline(linenr):gsub('^' .. stars .. '%s+' .. old_state, stars .. ' ' .. new_state)
   vim.fn.setline(linenr, new_line)
+  return true
 end
 
 ---@param date Date
diff --git a/lua/orgmode/utils.lua b/lua/orgmode/utils.lua
@@ -44,21 +44,35 @@ function utils.open(target)
 end
 
 ---@param msg string
-function utils.echo_warning(msg)
-  vim.cmd([[redraw!]])
-  return vim.api.nvim_echo({ { string.format('[orgmode] %s', msg), 'WarningMsg' } }, true, {})
+---@param additional_msg table
+function utils.echo_warning(msg, additional_msg)
+  return utils._echo(msg, 'WarningMsg', additional_msg)
 end
 
 ---@param msg string
-function utils.echo_error(msg)
-  vim.cmd([[redraw!]])
-  return vim.api.nvim_echo({ { string.format('[orgmode] %s', msg), 'ErrorMsg' } }, true, {})
+---@param additional_msg table
+function utils.echo_error(msg, additional_msg)
+  return utils._echo(msg, 'ErrorMsg', additional_msg)
 end
 
 ---@param msg string
-function utils.echo_info(msg)
+---@param additional_msg table
+function utils.echo_info(msg, additional_msg)
+  return utils._echo(msg, nil, additional_msg)
+end
+
+---@private
+function utils._echo(msg, hl, additional_msg)
   vim.cmd([[redraw!]])
-  return vim.api.nvim_echo({ { string.format('[orgmode] %s', msg) } }, true, {})
+  local msg_item = { string.format('[orgmode] %s', msg) }
+  if hl then
+    table.insert(msg_item, hl)
+  end
+  local msg_list = { msg_item }
+  if additional_msg then
+    msg_list = utils.concat(msg_list, additional_msg)
+  end
+  return vim.api.nvim_echo(msg_list, true, {})
 end
 
 ---@param word string
diff --git a/tests/plenary/object/todo_state_spec.lua b/tests/plenary/object/todo_state_spec.lua
