diff options
-rw-r--r-- | doc/colorizer.txt | 122 | ||||
-rw-r--r-- | doc/index.html | 4 | ||||
-rw-r--r-- | doc/modules/colorizer.buffer.html | 2 | ||||
-rw-r--r-- | doc/modules/colorizer.color.html | 2 | ||||
-rw-r--r-- | doc/modules/colorizer.html | 2 | ||||
-rw-r--r-- | doc/modules/colorizer.matcher.html | 2 | ||||
-rw-r--r-- | doc/modules/colorizer.sass.html | 2 | ||||
-rw-r--r-- | doc/modules/colorizer.tailwind.html | 2 | ||||
-rw-r--r-- | doc/modules/colorizer.trie.html | 2 | ||||
-rw-r--r-- | doc/modules/colorizer.utils.html | 326 | ||||
-rw-r--r-- | lua/colorizer/utils.lua | 4 |
11 files changed, 459 insertions, 11 deletions
diff --git a/doc/colorizer.txt b/doc/colorizer.txt index 8dcaa11..0aaf865 100644 --- a/doc/colorizer.txt +++ b/doc/colorizer.txt @@ -706,4 +706,126 @@ Trie implementation in luajit. todo: write documentation +============================================================================== +UTILS *colorizer.utils-introduction* + +Helper utils + + +============================================================================== +LUA API *colorizer.utils-lua-api* + +Functions: ~ + |byte_is_alphanumeric| - Obvious. + + |byte_is_hex| - Obvious. + + |byte_is_valid_colorchar| - Valid colorchars are alphanumeric and - ( + tailwind colors ) + + |get_last_modified| - Get last modified time of a file + + |merge| - Merge two tables. + + |parse_hex| - Obvious. + + |percent_or_hex| - Obvious. + + |watch_file| - Watch a file for changes and execute callback + + +byte_is_alphanumeric({byte}) *colorizer.utils.byte_is_alphanumeric* + Obvious. + + Parameters: ~ + {byte} - number + + returns:~ + boolean + + + +byte_is_hex({byte}) *colorizer.utils.byte_is_hex* + Obvious. + + Parameters: ~ + {byte} - number + + returns:~ + boolean + + + +byte_is_valid_colorchar({byte}) *colorizer.utils.byte_is_valid_colorchar* + Valid colorchars are alphanumeric and - ( tailwind colors ) + + Parameters: ~ + {byte} - number + + returns:~ + boolean + + + +get_last_modified({path}) *colorizer.utils.get_last_modified* + Get last modified time of a file + + Parameters: ~ + {path} - string: file path + + returns:~ + number or nil: modified time + + + +merge({...}) *colorizer.utils.merge* + Merge two tables. + + + todo: Remove this and use `vim.tbl_deep_extend` + + + Parameters: ~ + {...} - + + returns:~ + table + + + +parse_hex({byte}) *colorizer.utils.parse_hex* + Obvious. + + Parameters: ~ + {byte} - number + + returns:~ + number + + + +percent_or_hex({v}) *colorizer.utils.percent_or_hex* + Obvious. + + Parameters: ~ + {v} - string + + returns:~ + number or nil + + + +watch_file({path}, {callback}, {...}) *colorizer.utils.watch_file* + Watch a file for changes and execute callback + + Parameters: ~ + {path} - string: File path + {callback} - function: Callback to execute + {...} - array: params for callback + + returns:~ + function or nil + + + vim:tw=80:ts=8:noet:ft=help:norl: diff --git a/doc/index.html b/doc/index.html index bbc15d1..0db74d8 100644 --- a/doc/index.html +++ b/doc/index.html @@ -38,7 +38,7 @@ <li><a href="modules/colorizer.sass.html">sass</a></li> <li><a href="modules/colorizer.tailwind.html">tailwind</a></li> <li><a href="modules/colorizer.trie.html">trie</a></li> - <li><a href="modules/utils.html">utils</a></li> + <li><a href="modules/colorizer.utils.html">utils</a></li> </ul> </div> @@ -78,7 +78,7 @@ <td class="summary">Trie implementation in luajit.</td> </tr> <tr> - <td class="name" nowrap><a href="modules/utils.html">utils</a></td> + <td class="name" nowrap><a href="modules/colorizer.utils.html">colorizer.utils</a></td> <td class="summary">Helper utils</td> </tr> </table> diff --git a/doc/modules/colorizer.buffer.html b/doc/modules/colorizer.buffer.html index a120996..fc0888e 100644 --- a/doc/modules/colorizer.buffer.html +++ b/doc/modules/colorizer.buffer.html @@ -47,7 +47,7 @@ <li><a href="../modules/colorizer.sass.html">sass</a></li> <li><a href="../modules/colorizer.tailwind.html">tailwind</a></li> <li><a href="../modules/colorizer.trie.html">trie</a></li> - <li><a href="../modules/utils.html">utils</a></li> + <li><a href="../modules/colorizer.utils.html">utils</a></li> </ul> </div> diff --git a/doc/modules/colorizer.color.html b/doc/modules/colorizer.color.html index b36a8aa..74d4e55 100644 --- a/doc/modules/colorizer.color.html +++ b/doc/modules/colorizer.color.html @@ -45,7 +45,7 @@ <li><a href="../modules/colorizer.sass.html">sass</a></li> <li><a href="../modules/colorizer.tailwind.html">tailwind</a></li> <li><a href="../modules/colorizer.trie.html">trie</a></li> - <li><a href="../modules/utils.html">utils</a></li> + <li><a href="../modules/colorizer.utils.html">utils</a></li> </ul> </div> diff --git a/doc/modules/colorizer.html b/doc/modules/colorizer.html index fe2d381..9e56230 100644 --- a/doc/modules/colorizer.html +++ b/doc/modules/colorizer.html @@ -47,7 +47,7 @@ <li><a href="../modules/colorizer.sass.html">sass</a></li> <li><a href="../modules/colorizer.tailwind.html">tailwind</a></li> <li><a href="../modules/colorizer.trie.html">trie</a></li> - <li><a href="../modules/utils.html">utils</a></li> + <li><a href="../modules/colorizer.utils.html">utils</a></li> </ul> </div> diff --git a/doc/modules/colorizer.matcher.html b/doc/modules/colorizer.matcher.html index 9b2b67e..dd142eb 100644 --- a/doc/modules/colorizer.matcher.html +++ b/doc/modules/colorizer.matcher.html @@ -45,7 +45,7 @@ <li><a href="../modules/colorizer.sass.html">sass</a></li> <li><a href="../modules/colorizer.tailwind.html">tailwind</a></li> <li><a href="../modules/colorizer.trie.html">trie</a></li> - <li><a href="../modules/utils.html">utils</a></li> + <li><a href="../modules/colorizer.utils.html">utils</a></li> </ul> </div> diff --git a/doc/modules/colorizer.sass.html b/doc/modules/colorizer.sass.html index 56c8c63..dc4f6f4 100644 --- a/doc/modules/colorizer.sass.html +++ b/doc/modules/colorizer.sass.html @@ -45,7 +45,7 @@ <li><strong>sass</strong></li> <li><a href="../modules/colorizer.tailwind.html">tailwind</a></li> <li><a href="../modules/colorizer.trie.html">trie</a></li> - <li><a href="../modules/utils.html">utils</a></li> + <li><a href="../modules/colorizer.utils.html">utils</a></li> </ul> </div> diff --git a/doc/modules/colorizer.tailwind.html b/doc/modules/colorizer.tailwind.html index 09e17ce..c6048ac 100644 --- a/doc/modules/colorizer.tailwind.html +++ b/doc/modules/colorizer.tailwind.html @@ -45,7 +45,7 @@ <li><a href="../modules/colorizer.sass.html">sass</a></li> <li><strong>tailwind</strong></li> <li><a href="../modules/colorizer.trie.html">trie</a></li> - <li><a href="../modules/utils.html">utils</a></li> + <li><a href="../modules/colorizer.utils.html">utils</a></li> </ul> </div> diff --git a/doc/modules/colorizer.trie.html b/doc/modules/colorizer.trie.html index cc64359..f2bbd89 100644 --- a/doc/modules/colorizer.trie.html +++ b/doc/modules/colorizer.trie.html @@ -41,7 +41,7 @@ <li><a href="../modules/colorizer.sass.html">sass</a></li> <li><a href="../modules/colorizer.tailwind.html">tailwind</a></li> <li><strong>trie</strong></li> - <li><a href="../modules/utils.html">utils</a></li> + <li><a href="../modules/colorizer.utils.html">utils</a></li> </ul> </div> diff --git a/doc/modules/colorizer.utils.html b/doc/modules/colorizer.utils.html new file mode 100644 index 0000000..a787177 --- /dev/null +++ b/doc/modules/colorizer.utils.html @@ -0,0 +1,326 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> +<html> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/> +<head> + <title>colorizer Docs</title> + <link rel="stylesheet" href="../ldoc.css" type="text/css" /> +</head> +<body> + +<div id="container"> + +<div id="product"> + <div id="product_logo"></div> + <div id="product_name"><big><b></b></big></div> + <div id="product_description"></div> +</div> <!-- id="product" --> + + +<div id="main"> + + +<!-- Menu --> + +<div id="navigation"> +<br/> +<h1>colorizer</h1> + +<ul> + <li><a href="../index.html">Index</a></li> +</ul> + +<h2>Contents</h2> +<ul> +<li><a href="#Functions">Functions</a></li> +</ul> + + +<h2>Modules</h2> +<ul class="nowrap"> + <li><a href="../modules/colorizer.html">colorizer</a></li> + <li><a href="../modules/colorizer.buffer.html">buffer</a></li> + <li><a href="../modules/colorizer.color.html">color</a></li> + <li><a href="../modules/colorizer.matcher.html">matcher</a></li> + <li><a href="../modules/colorizer.sass.html">sass</a></li> + <li><a href="../modules/colorizer.tailwind.html">tailwind</a></li> + <li><a href="../modules/colorizer.trie.html">trie</a></li> + <li><strong>utils</strong></li> +</ul> + +</div> + +<div id="content"> + +<h1>Module <code>colorizer.utils</code></h1> +<p>Helper utils</p> +<p> + +</p> + + +<h2><a href="#Functions">Functions</a></h2> +<table class="function_list"> + <tr> + <td class="name" nowrap><a href="#byte_is_alphanumeric">byte_is_alphanumeric (byte)</a></td> + <td class="summary">Obvious.</td> + </tr> + <tr> + <td class="name" nowrap><a href="#byte_is_hex">byte_is_hex (byte)</a></td> + <td class="summary">Obvious.</td> + </tr> + <tr> + <td class="name" nowrap><a href="#byte_is_valid_colorchar">byte_is_valid_colorchar (byte)</a></td> + <td class="summary">Valid colorchars are alphanumeric and - ( tailwind colors )</td> + </tr> + <tr> + <td class="name" nowrap><a href="#get_last_modified">get_last_modified (path)</a></td> + <td class="summary">Get last modified time of a file</td> + </tr> + <tr> + <td class="name" nowrap><a href="#merge">merge (...)</a></td> + <td class="summary">Merge two tables.</td> + </tr> + <tr> + <td class="name" nowrap><a href="#parse_hex">parse_hex (byte)</a></td> + <td class="summary">Obvious.</td> + </tr> + <tr> + <td class="name" nowrap><a href="#percent_or_hex">percent_or_hex (v)</a></td> + <td class="summary">Obvious.</td> + </tr> + <tr> + <td class="name" nowrap><a href="#watch_file">watch_file (path, callback, ...)</a></td> + <td class="summary">Watch a file for changes and execute callback</td> + </tr> +</table> + +<br/> +<br/> + + + <h2 class="section-header "><a name="Functions"></a>Functions</h2> + + <dl class="function"> + <dt> + <a name = "byte_is_alphanumeric"></a> + <strong>byte_is_alphanumeric (byte)</strong> + </dt> + <dd> + Obvious. + + + <h3>Parameters:</h3> + <ul> + <li><span class="parameter">byte</span> + number + </li> + </ul> + + <h3>Returns:</h3> + <ol> + + boolean + </ol> + + + + +</dd> + <dt> + <a name = "byte_is_hex"></a> + <strong>byte_is_hex (byte)</strong> + </dt> + <dd> + Obvious. + + + <h3>Parameters:</h3> + <ul> + <li><span class="parameter">byte</span> + number + </li> + </ul> + + <h3>Returns:</h3> + <ol> + + boolean + </ol> + + + + +</dd> + <dt> + <a name = "byte_is_valid_colorchar"></a> + <strong>byte_is_valid_colorchar (byte)</strong> + </dt> + <dd> + Valid colorchars are alphanumeric and - ( tailwind colors ) + + + <h3>Parameters:</h3> + <ul> + <li><span class="parameter">byte</span> + number + </li> + </ul> + + <h3>Returns:</h3> + <ol> + + boolean + </ol> + + + + +</dd> + <dt> + <a name = "get_last_modified"></a> + <strong>get_last_modified (path)</strong> + </dt> + <dd> + Get last modified time of a file + + + <h3>Parameters:</h3> + <ul> + <li><span class="parameter">path</span> + string: file path + </li> + </ul> + + <h3>Returns:</h3> + <ol> + + number|nil: modified time + </ol> + + + + +</dd> + <dt> + <a name = "merge"></a> + <strong>merge (...)</strong> + </dt> + <dd> + Merge two tables. </p> + +<p> todo: Remove this and use <code>vim.tbl_deep_extend</code> + + + <h3>Parameters:</h3> + <ul> + <li><span class="parameter">...</span> + + + + </li> + </ul> + + <h3>Returns:</h3> + <ol> + + table + </ol> + + + + +</dd> + <dt> + <a name = "parse_hex"></a> + <strong>parse_hex (byte)</strong> + </dt> + <dd> + Obvious. + + + <h3>Parameters:</h3> + <ul> + <li><span class="parameter">byte</span> + number + </li> + </ul> + + <h3>Returns:</h3> + <ol> + + number + </ol> + + + + +</dd> + <dt> + <a name = "percent_or_hex"></a> + <strong>percent_or_hex (v)</strong> + </dt> + <dd> + Obvious. + + + <h3>Parameters:</h3> + <ul> + <li><span class="parameter">v</span> + string + </li> + </ul> + + <h3>Returns:</h3> + <ol> + + number|nil + </ol> + + + + +</dd> + <dt> + <a name = "watch_file"></a> + <strong>watch_file (path, callback, ...)</strong> + </dt> + <dd> + Watch a file for changes and execute callback + + + <h3>Parameters:</h3> + <ul> + <li><span class="parameter">path</span> + string: File path + </li> + <li><span class="parameter">callback</span> + function: Callback to execute + </li> + <li><span class="parameter">...</span> + array: params for callback + </li> + </ul> + + <h3>Returns:</h3> + <ol> + + function|nil + </ol> + + + + +</dd> +</dl> + + +</div> <!-- id="content" --> +</div> <!-- id="main" --> +<div id="about"> +<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i> +<i style="float:right;">Last updated - September </i> +</div> <!-- id="about" --> +</div> <!-- id="container" --> +</body> +</html> diff --git a/lua/colorizer/utils.lua b/lua/colorizer/utils.lua index 22fa6eb..282e405 100644 --- a/lua/colorizer/utils.lua +++ b/lua/colorizer/utils.lua @@ -1,5 +1,5 @@ ---Helper utils ---@module utils +--@module colorizer.utils local bit, ffi = require "bit", require "ffi" local band, bor, rshift, lshift = bit.band, bit.bor, bit.rshift, bit.lshift @@ -64,7 +64,7 @@ function utils.byte_is_hex(byte) return band(BYTE_CATEGORY[byte], CATEGORY_HEX) ~= 0 end ----Obvious. +---Valid colorchars are alphanumeric and - ( tailwind colors ) ---@param byte number ---@return boolean function utils.byte_is_valid_colorchar(byte) |