diff --git a/doc/colorizer.txt b/doc/colorizer.txt
index 4e25bb6..cc609c6 100644
--- a/doc/colorizer.txt
+++ b/doc/colorizer.txt
@@ -86,7 +86,9 @@ Functions: ~
|rehighlight| - Rehighlight the buffer if colorizer is active
- |is_buffer_attached| - Check if attached to a buffer
+ |get_attached_bufnr| - Get attached bufnr
+
+ |is_buffer_attached| - Check if buffer is attached to colorizer
|reload_all_buffers| - Reload all of the currently active highlighted
buffers.
@@ -134,20 +136,32 @@ rehighlight({bufnr}, {options}, {options_local}, {use_local_lines})
-is_buffer_attached({bufnr}) *colorizer.is_buffer_attached*
- Check if attached to a buffer
+get_attached_bufnr({bufnr}) *colorizer.get_attached_bufnr*
+ Get attached bufnr
Parameters: ~
{bufnr} - number|nil: buffer number (0 for current)
returns:~
- number: returns bufnr if attached, otherwise -1
+ number: Returns attached bufnr. Returns -1 if buffer is not attached to
+ colorizer.
See also:~
|colorizer.buffer.highlight|
+is_buffer_attached({bufnr}) *colorizer.is_buffer_attached*
+ Check if buffer is attached to colorizer
+
+ Parameters: ~
+ {bufnr} - number|nil: buffer number (0 for current)
+
+ returns:~
+ boolean: Returns `true` if buffer is attached to colorizer.
+
+
+
reload_all_buffers() *colorizer.reload_all_buffers*
Reload all of the currently active highlighted buffers.
@@ -178,6 +192,9 @@ detach_from_buffer({bufnr}) *colorizer.detach_from_buffer*
Parameters: ~
{bufnr} - number|nil: buffer number (0 for current)
+ returns:~
+ number: returns -1 if buffer is not attached, otherwise returns bufnr
+
setup({opts}) *colorizer.setup*
diff --git a/doc/modules/colorizer.html b/doc/modules/colorizer.html
index b47e072..50b5e70 100644
--- a/doc/modules/colorizer.html
+++ b/doc/modules/colorizer.html
@@ -155,8 +155,12 @@
Rehighlight the buffer if colorizer is active |
+ get_attached_bufnr (bufnr) |
+ Get attached bufnr |
+
+
is_buffer_attached (bufnr) |
- Check if attached to a buffer |
+ Check if buffer is attached to colorizer |
reload_all_buffers () |
@@ -251,11 +255,11 @@ Returns:
-
- is_buffer_attached (bufnr)
+
+ get_attached_bufnr (bufnr)
- Check if attached to a buffer
+ Get attached bufnr
Parameters:
@@ -268,7 +272,7 @@ Parameters:
Returns:
- number: returns bufnr if attached, otherwise -1
+ number: Returns attached bufnr. Returns -1 if buffer is not attached to colorizer.
@@ -278,6 +282,31 @@ See also:
+
+
+
+ is_buffer_attached (bufnr)
+
+
+ Check if buffer is attached to colorizer
+
+
+ Parameters:
+
+ - bufnr
+ number|nil: buffer number (0 for current)
+
+
+
+ Returns:
+
+
+ boolean: Returns `true` if buffer is attached to colorizer.
+
+
+
+
+
@@ -354,6 +383,11 @@ Parameters:
+ Returns:
+
+
+ number: returns -1 if buffer is not attached, otherwise returns bufnr
+
diff --git a/lua/colorizer.lua b/lua/colorizer.lua
index 45deea8..19b35c7 100644
--- a/lua/colorizer.lua
+++ b/lua/colorizer.lua
@@ -171,11 +171,11 @@ function M.rehighlight(bufnr, options, options_local, use_local_lines)
return returns
end
----Check if attached to a buffer
+---Get attached bufnr
---@param bufnr number|nil: buffer number (0 for current)
----@return number: returns bufnr if attached, otherwise -1
+---@return number: Returns attached bufnr. Returns -1 if buffer is not attached to colorizer.
---@see colorizer.buffer.highlight
-function M.is_buffer_attached(bufnr)
+function M.get_attached_bufnr(bufnr)
if bufnr == 0 or not bufnr then
bufnr = utils.bufme(bufnr)
else
@@ -195,11 +195,18 @@ function M.is_buffer_attached(bufnr)
return bufnr
end
+---Check if buffer is attached to colorizer
+---@param bufnr number|nil: buffer number (0 for current)
+---@return boolean: Returns `true` if buffer is attached to colorizer.
+function M.is_buffer_attached(bufnr)
+ return M.get_attached_bufnr(bufnr) > -1
+end
+
--- Return buffer options if buffer is attached to colorizer.
---@param bufnr number: Buffer number (0 for current)
---@return table|nil
local function get_attached_buffer_options(bufnr)
- local attached_bufnr = M.is_buffer_attached(bufnr)
+ local attached_bufnr = M.get_attached_bufnr(bufnr)
if attached_bufnr > -1 then
return colorizer_state.buffer_options[attached_bufnr]
end
@@ -383,9 +390,10 @@ end
--- Stop highlighting the current buffer.
---@param bufnr number|nil: buffer number (0 for current)
+---@return number: returns -1 if buffer is not attached, otherwise returns bufnr
function M.detach_from_buffer(bufnr)
bufnr = utils.bufme(bufnr)
- bufnr = M.is_buffer_attached(bufnr)
+ bufnr = M.get_attached_bufnr(bufnr)
if bufnr < 0 then
return -1
end
@@ -407,6 +415,7 @@ function M.detach_from_buffer(bufnr)
end
-- because now the buffer is not visible, so delete its information
colorizer_state.buffer_options[bufnr] = nil
+ return bufnr
end
---Easy to use function if you want the full setup without fine grained control.
diff --git a/lua/colorizer/usercmds.lua b/lua/colorizer/usercmds.lua
index 1ee481b..32dd478 100644
--- a/lua/colorizer/usercmds.lua
+++ b/lua/colorizer/usercmds.lua
@@ -32,7 +32,7 @@ function M.make(cmds)
ColorizerDetachFromBuffer = wrap("ColorizerDetachFromBuffer", c.detach_from_buffer),
ColorizerReloadAllBuffers = wrap("ColorizerReloadAllBuffers", c.reload_all_buffers),
ColorizerToggle = wrap("ColorizerToggle", function()
- if c.is_buffer_attached() < 0 then
+ if not c.is_buffer_attached() then
c.attach_to_buffer()
else
c.detach_from_buffer()