feat(indent): Always check for b:org_indent_mode if available (#669)

Author: kristijanhusak

lua/orgmode/config/init.lua

@@ -394,6 +394,7 @@ function Config:ts_highlights_enabled()
       return false
     end
 
+    ---@diagnostic disable-next-line: param-type-mismatch
     if type(hl_module.disable) == 'table' and vim.tbl_contains(hl_module.disable, 'org') then
       return false
     end
@@ -413,33 +414,26 @@ function Config:respect_blank_before_new_entry(content, option, prepend_content)
   return content
 end
 
----@param amount number
----@return string
-function Config:get_indent(amount)
-  if self.org_adapt_indentation then
-    return string.rep(' ', amount)
+---Check if buffer should apply indentation
+---@param bufnr number
+---@return boolean
+function Config:should_indent(bufnr)
+  if bufnr > -1 and vim.b[bufnr].org_indent_mode then
+    return not self.opts.org_indent_mode_turns_off_org_adapt_indentation
   end
-  return ''
+
+  return self.org_adapt_indentation
 end
 
----@param content string|string[]
 ---@param amount number
----@return string|string[]
-function Config:apply_indent(content, amount)
-  local indent = self:get_indent(amount)
-
-  if indent == '' then
-    return content
-  end
-
-  if type(content) ~= 'table' then
-    return indent .. content
+---@param bufnr number
+---@return string
+function Config:get_indent(amount, bufnr)
+  if self:should_indent(bufnr) then
+    return string.rep(' ', amount)
   end
 
-  for i, line in ipairs(content) do
-    content[i] = indent .. line
-  end
-  return content
+  return ''
 end
 
 ---@param bufnr number

lua/orgmode/files/elements/logbook.lua

@@ -159,7 +159,7 @@ end
 ---@param headline OrgHeadline
 function Logbook.new_from_headline(headline)
   local append_line = headline:get_append_line()
-  local indent = config:get_indent(headline:get_level() + 1)
+  local indent = headline:get_indent()
 
   local date = Date.now({ active = false })
   local content = {

lua/orgmode/files/elements/table/init.lua

@@ -86,7 +86,7 @@ function Table:reformat()
     return false
   end
   local _, start_col = self.node:range()
-  local indent = config:get_indent(start_col)
+  local indent = config:get_indent(start_col, vim.api.nvim_get_current_buf())
   local contents = vim.tbl_map(function(line)
     return ('%s%s'):format(indent, line)
   end, self:draw())
@@ -104,7 +104,7 @@ function Table:handle_cr()
 
   local line = vim.fn.line('.') or 0
   local indent_amount = vim.fn.indent(line) or 0
-  local indent = config:get_indent(indent_amount)
+  local indent = config:get_indent(indent_amount, vim.api.nvim_get_current_buf())
   vim.api.nvim_buf_set_lines(0, line, line, true, { ('%s|'):format(indent) })
   local tbl = Table.from_current_node({ line, vim.fn.col('.') })
   if tbl then

lua/orgmode/files/headline.lua

@@ -87,11 +87,11 @@ function Headline:promote(amount, recursive, dryRun)
       if line:sub(1, 1) == '*' then
         lines[i] = line:sub(1 + amount)
       elseif vim.trim(line:sub(1, amount)) == '' then
-        if config.org_adapt_indentation then
+        if config:should_indent(self.file:bufnr()) then
           lines[i] = line:sub(1 + amount)
         else
           line, _ = line:gsub('^%s+', '')
-          local indent_amount = indent.indentexpr(start_line + i)
+          local indent_amount = indent.indentexpr(start_line + i, self.file:bufnr())
           lines[i] = string.rep(' ', indent_amount) .. line
         end
       end
@@ -113,11 +113,11 @@ function Headline:demote(amount, recursive, dryRun)
       if line:sub(1, 1) == '*' then
         lines[i] = string.rep('*', amount) .. line
       else
-        if config.org_adapt_indentation then
-          lines[i] = config:apply_indent(line, amount)
+        if config:should_indent(self.file:bufnr()) then
+          lines[i] = self:_apply_indent(line, amount)
         else
           line, _ = line:gsub('^%s+', '')
-          local indent_amount = indent.indentexpr(start_line + i)
+          local indent_amount = indent.indentexpr(start_line + i, self.file:bufnr())
           lines[i] = string.rep(' ', indent_amount) .. line
         end
       end
@@ -384,7 +384,7 @@ function Headline:set_property(name, value)
   local properties = self:get_properties()
   if not properties then
     local append_line = self:get_append_line()
-    local property_drawer = self:_apply_indent({ ':PROPERTIES:', ':END:' })
+    local property_drawer = self:_apply_indent({ ':PROPERTIES:', ':END:' }) --[[ @as string[] ]]
     vim.api.nvim_buf_set_lines(0, append_line, append_line, false, property_drawer)
     properties = self:refresh():get_properties()
   end
@@ -395,7 +395,9 @@ function Headline:set_property(name, value)
     return self:_set_node_text(property_node, property)
   end
   local property_end = properties and properties:end_()
-  vim.api.nvim_buf_set_lines(0, property_end - 1, property_end - 1, false, self:_apply_indent(property))
+
+  local new_line = self:_apply_indent(property) --[[@as string]]
+  vim.api.nvim_buf_set_lines(0, property_end - 1, property_end - 1, false, { new_line })
   return self:refresh()
 end
 
@@ -782,7 +784,7 @@ function Headline:get_drawer_append_line(name)
 
   if not drawer then
     local append_line = self:get_append_line()
-    local new_drawer = self:_apply_indent({ ':' .. name .. ':', ':END:' })
+    local new_drawer = self:_apply_indent({ ':' .. name .. ':', ':END:' }) --[[ @as string[] ]]
     vim.api.nvim_buf_set_lines(0, append_line, append_line, false, new_drawer)
     drawer = self:get_drawer(name)
   end
@@ -806,6 +808,12 @@ function Headline:get_headline_line_content()
   return line
 end
 
+---@param amount? number
+---@return string
+function Headline:get_indent(amount)
+  return config:get_indent(amount or self:get_level() + 1, self.file:bufnr())
+end
+
 function Headline:is_same(other_headline)
   return self.file.filename == other_headline.filename
     and self:get_headline_line_content() == other_headline:get_headline_line_content()
@@ -829,9 +837,8 @@ function Headline:_add_date(type, date, active)
   local _, date_nodes, has_plan_dates = self:get_plan_dates()
   local text = type .. ': ' .. date:to_wrapped_string(active)
   if not has_plan_dates then
-    local indentation = config:get_indent(self:get_level() + 1)
     local start_line = self:node():start()
-    vim.fn.append(start_line + 1, ('%s%s'):format(indentation, text))
+    vim.fn.append(start_line + 1, self:_apply_indent(text))
     return self:refresh()
   end
   if date_nodes[type] then
@@ -869,13 +876,23 @@ function Headline:_remove_date(type)
 end
 
 ---@param text string[]|string
----@return string[]
-function Headline:_apply_indent(text)
-  local indented = config:apply_indent(text, self:get_level() + 1)
-  if type(indented) == 'string' then
-    return { indented }
+---@param amount? number
+function Headline:_apply_indent(text, amount)
+  local indent_text = self:get_indent(amount)
+
+  if indent_text == '' then
+    return text
   end
-  return indented
+
+  if type(text) ~= 'table' then
+    return indent_text .. text
+  end
+
+  for i, line in ipairs(text) do
+    text[i] = indent_text .. line
+  end
+
+  return text
 end
 
 function Headline:_get_child_node(name)

lua/orgmode/org/indent.lua

@@ -4,8 +4,8 @@ local ts_utils = require('orgmode.utils.treesitter')
 ---@type Query
 local query = nil
 
-local function get_indent_pad(linenr)
-  if config.org_adapt_indentation then
+local function get_indent_pad(linenr, bufnr)
+  if config:should_indent(bufnr) then
     local headline = ts_utils.closest_headline_node({ linenr, 0 })
     if not headline then
       return 0
@@ -16,7 +16,7 @@ local function get_indent_pad(linenr)
   return 0
 end
 
-local function get_indent_for_match(matches, linenr, mode)
+local function get_indent_for_match(matches, linenr, mode, bufnr)
   linenr = linenr or vim.v.lnum
   mode = mode or vim.fn.mode()
   local prev_linenr = vim.fn.prevnonblank(linenr - 1)
@@ -25,7 +25,7 @@ local function get_indent_for_match(matches, linenr, mode)
   local indent = 0
 
   if not match and not prev_line_match then
-    return indent + get_indent_pad(linenr)
+    return indent + get_indent_pad(linenr, bufnr)
   end
 
   match = match or {}
@@ -50,7 +50,7 @@ local function get_indent_for_match(matches, linenr, mode)
       end
     end
     -- If the first_line_indent wasn't found then this is the root of the list, as such we just pad accordingly
-    indent = first_line_indent or (0 + get_indent_pad(linenr))
+    indent = first_line_indent or (0 + get_indent_pad(linenr, bufnr))
     -- If the current line is hanging content as part of the listitem but not on the same line we want to indent it
     -- such that it's in line with the general content body, not the bullet.
     --
@@ -69,7 +69,7 @@ local function get_indent_for_match(matches, linenr, mode)
     -- After the first line of a listitem, we have to add the overhang to the
     -- listitem's own base indent. After all further lines, we can simply copy
     -- the indentation.
-    indent = get_indent_for_match(matches, prev_linenr)
+    indent = get_indent_for_match(matches, prev_linenr, mode, bufnr)
     if prev_linenr == prev_line_match.line_nr then
       indent = indent + prev_line_match.overhang
     end
@@ -81,7 +81,7 @@ local function get_indent_for_match(matches, linenr, mode)
     return match.indent
   end
 
-  return indent + get_indent_pad(linenr)
+  return indent + get_indent_pad(linenr, bufnr)
 end
 
 local get_matches = ts_utils.memoize_by_buf_tick(function(bufnr)
@@ -90,6 +90,7 @@ local get_matches = ts_utils.memoize_by_buf_tick(function(bufnr)
     return {}
   end
   local matches = {}
+  local mode = vim.fn.mode()
   local root = tree[1]:root()
   for _, match, _ in query:iter_matches(root, bufnr, 0, -1) do
     for id, node in pairs(match) do
@@ -150,13 +151,13 @@ local get_matches = ts_utils.memoize_by_buf_tick(function(bufnr)
         -- block header and footer. This keeps code correctly indented in `BEGIN_SRC` blocks as well as ensuring
         -- `BEGIN_EXAMPLE` blocks don't have their indentation changed inside of them.
         local parent_linenr = parent:start() + 1
-        local parent_indent = get_indent_for_match(matches, parent:start() + 1)
+        local parent_indent = get_indent_for_match(matches, parent:start() + 1, mode, bufnr)
 
         -- We want to align to the listitem body, not the bullet
         if parent:type() == 'listitem' then
           parent_indent = parent_indent + matches[parent_linenr].overhang
         else
-          parent_indent = get_indent_pad(range.start.line + 1)
+          parent_indent = get_indent_pad(range.start.line + 1, bufnr)
         end
 
         local curr_header_indent = vim.fn.indent(range.start.line + 1)
@@ -270,18 +271,18 @@ end
 --
 -- TLDR: The caching avoids some inconsistent race conditions with getting the Treesitter matches.
 local buf_indentexpr_cache = {}
-local function indentexpr(linenr, mode)
+local function indentexpr(linenr, bufnr)
   linenr = linenr or vim.v.lnum
-  mode = mode or vim.fn.mode()
+  local mode = vim.fn.mode()
   query = query or vim.treesitter.query.get('org', 'org_indent')
 
-  local bufnr = vim.api.nvim_get_current_buf()
+  bufnr = bufnr or vim.api.nvim_get_current_buf()
   local indentexpr_cache = buf_indentexpr_cache[bufnr] or { prev_linenr = -1 }
   if indentexpr_cache.prev_linenr ~= linenr - 1 or not mode:lower():find('n') then
-    indentexpr_cache.matches = get_matches(0)
+    indentexpr_cache.matches = get_matches(bufnr)
   end
 
-  local new_indent = get_indent_for_match(indentexpr_cache.matches, linenr, mode)
+  local new_indent = get_indent_for_match(indentexpr_cache.matches, linenr, mode, bufnr)
   local match = indentexpr_cache.matches[linenr]
   if match then
     match.indent = new_indent

lua/orgmode/org/mappings.lua

@@ -60,7 +60,7 @@ function OrgMappings:archive()
   local lines = headline:get_lines()
   local properties_node = headline:get_properties()
   local append_line = headline:get_append_line() - start_line
-  local indent = config:get_indent(headline:get_level() + 1)
+  local indent = headline:get_indent()
 
   local archive_props = {
     ('%s:ARCHIVE_TIME: %s'):format(indent, Date.now():to_string()),
@@ -439,7 +439,7 @@ function OrgMappings:_todo_change_state(direction)
   local log_note = config.org_log_done == 'note'
   local log_time = config.org_log_done == 'time'
   local should_log_time = log_note or log_time
-  local indent = config:get_indent(headline:get_level() + 1)
+  local indent = headline:get_indent()
 
   local get_note = function(note)
     if note == nil then