diff options
author | akianonymus <anonymus.aki@gmail.com> | 2023-02-27 14:30:10 +0530 |
---|---|---|
committer | akianonymus <anonymus.aki@gmail.com> | 2023-02-27 16:01:48 +0530 |
commit | dde3084106a70b9a79d48f426f6d6fec6fd203f7 (patch) | |
tree | f1b06f0921e9eaf98bcc94f4d86d9f4d7226cb54 /doc | |
parent | fix: virtualtext on nonfocused window update | #41 (diff) |
Separate parsers into individual files
Diffstat (limited to 'doc')
-rw-r--r-- | doc/colorizer.txt | 231 | ||||
-rw-r--r-- | doc/index.html | 27 | ||||
-rw-r--r-- | doc/modules/colorizer.buffer.html | 5 | ||||
-rw-r--r-- | doc/modules/colorizer.color.html | 187 | ||||
-rw-r--r-- | doc/modules/colorizer.html | 5 | ||||
-rw-r--r-- | doc/modules/colorizer.matcher.html | 5 | ||||
-rw-r--r-- | doc/modules/colorizer.parser.argb_hex.html | 124 | ||||
-rw-r--r-- | doc/modules/colorizer.parser.hsl.html | 127 | ||||
-rw-r--r-- | doc/modules/colorizer.parser.names.html | 120 | ||||
-rw-r--r-- | doc/modules/colorizer.parser.rgb.html | 127 | ||||
-rw-r--r-- | doc/modules/colorizer.parser.rgba_hex.html | 127 | ||||
-rw-r--r-- | doc/modules/colorizer.sass.html | 5 | ||||
-rw-r--r-- | doc/modules/colorizer.tailwind.html | 5 | ||||
-rw-r--r-- | doc/modules/colorizer.trie.html | 5 | ||||
-rw-r--r-- | doc/modules/colorizer.utils.html | 5 |
15 files changed, 840 insertions, 265 deletions
diff --git a/doc/colorizer.txt b/doc/colorizer.txt index a7d21b5..491e5b5 100644 --- a/doc/colorizer.txt +++ b/doc/colorizer.txt @@ -412,34 +412,124 @@ default_namespace *colorizer.buffer.default_namespace* ============================================================================== COLOR *colorizer.color-introduction* -Helper functions to parse different colour formats +Helper color functions ============================================================================== LUA API *colorizer.color-lua-api* Functions: ~ - |argb_hex_parser| - parse for 0xaarrggbb and return rgb hex. - |hsl_to_rgb| - Converts an HSL color value to RGB. - |hsl_function_parser| - Parse for hsl() hsla() css function and return rgb - hex. - |hue_to_rgb| - Convert hsl colour values to rgb. |is_bright| - Determine whether to use black or white text. - |name_parser| - Grab all the colour values from `vim.api.nvim_get_color_map` - and create a lookup table. - |rgb_function_parser| - Parse for rgb() rgba() css function and return rgb - hex. +hsl_to_rgb({h}, {s}, {l}) *colorizer.color.hsl_to_rgb* + Converts an HSL color value to RGB. + + Parameters: ~ + {h} - number: Hue + {s} - number: Saturation + {l} - number: Lightness + + returns:~ + number or nil,number or nil,number or nil + + + +hue_to_rgb({p}, {q}, {t}) *colorizer.color.hue_to_rgb* + Convert hsl colour values to rgb. + + Source: https://gist.github.com/mjackson/5311256 + + + Parameters: ~ + {p} - number + {q} - number + {t} - number + + returns:~ + number + + + +is_bright({r}, {g}, {b}) *colorizer.color.is_bright* + Determine whether to use black or white text. + + + ref: https://stackoverflow.com/a/1855903/837964 + https://stackoverflow.com/questions/596216/formula-to-determine-brightness-of-rgb-color + + + Parameters: ~ + {r} - number: Red + {g} - number: Green + {b} - number: Blue + + + +============================================================================== +MATCHER *colorizer.matcher-introduction* + +Helper functions for colorizer to enable required parsers + + +============================================================================== +LUA API *colorizer.matcher-lua-api* + +Functions: ~ + |compile| - Form a trie stuct with the given prefixes + + |make| - Parse the given options and return a function with enabled parsers. + + +compile({matchers}, {matchers_trie}) *colorizer.matcher.compile* + Form a trie stuct with the given prefixes + + Parameters: ~ + {matchers} - table: List of prefixes, {"rgb", "hsl"} + {matchers_trie} - table: Table containing information regarding + non-trie based parsers + + returns:~ + function: function which will just parse the line for enabled parsers + + + +make({options}) *colorizer.matcher.make* + Parse the given options and return a function with enabled parsers. + + if no parsers enabled then return false + Do not try make the function again if it is present in the cache - |rgba_hex_parser| - parse for #rrggbbaa and return rgb hex. + Parameters: ~ + {options} - table: options created in `colorizer.setup` -argb_hex_parser({line}, {i}) *colorizer.color.argb_hex_parser* + returns:~ + function or boolean: function which will just parse the line for enabled + parsers + + + +============================================================================== +ARGB_HEX *colorizer.parser.argb_hex-introduction* + +Helper function to parse argb + + +============================================================================== +LUA API *colorizer.parser.argb_hex-lua-api* + +Functions: ~ + |parser.argb_hex_parser| - parse for 0xaarrggbb and return rgb hex. + + + + *colorizer.parser.argb_hex.parser.argb_hex_parser* +parser.argb_hex_parser({line}, {i}) parse for 0xaarrggbb and return rgb hex. a format used in android apps @@ -455,20 +545,23 @@ argb_hex_parser({line}, {i}) *colorizer.color.argb_hex_parser* -hsl_to_rgb({h}, {s}, {l}) *colorizer.color.hsl_to_rgb* - Converts an HSL color value to RGB. +============================================================================== +HSL *colorizer.parser.hsl-introduction* - Parameters: ~ - {h} - number: Hue - {s} - number: Saturation - {l} - number: Lightness +Helper function to parse argb - returns:~ - number or nil,number or nil,number or nil + +============================================================================== +LUA API *colorizer.parser.hsl-lua-api* + +Functions: ~ + |parser.hsl_function_parser| - Parse for hsl() hsla() css function and + return rgb hex. -hsl_function_parser({line}, {i}, {opts}) *colorizer.color.hsl_function_parser* + *colorizer.parser.hsl.parser.hsl_function_parser* +parser.hsl_function_parser({line}, {i}, {opts}) Parse for hsl() hsla() css function and return rgb hex. For more info: @@ -486,38 +579,23 @@ hsl_function_parser({line}, {i}, {opts}) *colorizer.color.hsl_function_parser* -hue_to_rgb({p}, {q}, {t}) *colorizer.color.hue_to_rgb* - Convert hsl colour values to rgb. - - Source: https://gist.github.com/mjackson/5311256 - - - Parameters: ~ - {p} - number - {q} - number - {t} - number - - returns:~ - number - - - -is_bright({r}, {g}, {b}) *colorizer.color.is_bright* - Determine whether to use black or white text. +============================================================================== +NAMES *colorizer.parser.names-introduction* +Helper function to parse argb - ref: https://stackoverflow.com/a/1855903/837964 - https://stackoverflow.com/questions/596216/formula-to-determine-brightness-of-rgb-color +============================================================================== +LUA API *colorizer.parser.names-lua-api* - Parameters: ~ - {r} - number: Red - {g} - number: Green - {b} - number: Blue +Functions: ~ + |parser.name_parser| - Grab all the colour values from + `vim.api.nvim_get_color_map` and create a lookup table. -name_parser({line}, {i}, {opts}) *colorizer.color.name_parser* + *colorizer.parser.names.parser.name_parser* +parser.name_parser({line}, {i}, {opts}) Grab all the colour values from `vim.api.nvim_get_color_map` and create a lookup table. @@ -531,25 +609,22 @@ name_parser({line}, {i}, {opts}) *colorizer.color.name_parser* -rgb_function_parser({line}, {i}, {opts}) *colorizer.color.rgb_function_parser* - Parse for rgb() rgba() css function and return rgb hex. +============================================================================== +RGBA_HEX *colorizer.parser.rgba_hex-introduction* - For more info: - https://developer.mozilla.org/en-US/docs/Web/CSS/color_value/rgb +Helper function to parse argb - Parameters: ~ - {line} - string: Line to parse - {i} - number: Index of line from where to start parsing - {opts} - table: Values passed from matchers like prefix +============================================================================== +LUA API *colorizer.parser.rgba_hex-lua-api* - returns:~ - number or nil: Index of line where the rgb/rgba function ended - string or nil: rgb hex value +Functions: ~ + |parser.rgba_hex_parser| - parse for #rrggbbaa and return rgb hex. -rgba_hex_parser({line}, {i}, {opts}) *colorizer.color.rgba_hex_parser* + *colorizer.parser.rgba_hex.parser.rgba_hex_parser* +parser.rgba_hex_parser({line}, {i}, {opts}) parse for #rrggbbaa and return rgb hex. a format used in android apps @@ -567,46 +642,36 @@ rgba_hex_parser({line}, {i}, {opts}) *colorizer.color.rgba_hex_parser* ============================================================================== -MATCHER *colorizer.matcher-introduction* +RGB *colorizer.parser.rgb-introduction* -Helper functions for colorizer to enable required parsers +Helper function to parse argb ============================================================================== -LUA API *colorizer.matcher-lua-api* +LUA API *colorizer.parser.rgb-lua-api* Functions: ~ - |compile| - Form a trie stuct with the given prefixes + |parser.rgb_function_parser| - Parse for rgb() rgba() css function and + return rgb hex. - |make| - Parse the given options and return a function with enabled parsers. -compile({matchers}, {matchers_trie}) *colorizer.matcher.compile* - Form a trie stuct with the given prefixes - - Parameters: ~ - {matchers} - table: List of prefixes, {"rgb", "hsl"} - {matchers_trie} - table: Table containing information regarding - non-trie based parsers - - returns:~ - function: function which will just parse the line for enabled parsers - - - -make({options}) *colorizer.matcher.make* - Parse the given options and return a function with enabled parsers. + *colorizer.parser.rgb.parser.rgb_function_parser* +parser.rgb_function_parser({line}, {i}, {opts}) + Parse for rgb() rgba() css function and return rgb hex. - if no parsers enabled then return false - Do not try make the function again if it is present in the cache + For more info: + https://developer.mozilla.org/en-US/docs/Web/CSS/color_value/rgb Parameters: ~ - {options} - table: options created in `colorizer.setup` + {line} - string: Line to parse + {i} - number: Index of line from where to start parsing + {opts} - table: Values passed from matchers like prefix returns:~ - function or boolean: function which will just parse the line for enabled - parsers + number or nil: Index of line where the rgb/rgba function ended + string or nil: rgb hex value diff --git a/doc/index.html b/doc/index.html index 7735382..3070ca2 100644 --- a/doc/index.html +++ b/doc/index.html @@ -35,6 +35,11 @@ <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.parser.argb_hex.html">parser.argb_hex</a></li> + <li><a href="modules/colorizer.parser.hsl.html">parser.hsl</a></li> + <li><a href="modules/colorizer.parser.names.html">parser.names</a></li> + <li><a href="modules/colorizer.parser.rgb.html">parser.rgb</a></li> + <li><a href="modules/colorizer.parser.rgba_hex.html">parser.rgba_hex</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> @@ -59,13 +64,33 @@ </tr> <tr> <td class="name" nowrap><a href="modules/colorizer.color.html">colorizer.color</a></td> - <td class="summary">Helper functions to parse different colour formats</td> + <td class="summary">Helper color functions</td> </tr> <tr> <td class="name" nowrap><a href="modules/colorizer.matcher.html">colorizer.matcher</a></td> <td class="summary">Helper functions for colorizer to enable required parsers</td> </tr> <tr> + <td class="name" nowrap><a href="modules/colorizer.parser.argb_hex.html">colorizer.parser.argb_hex</a></td> + <td class="summary">Helper function to parse argb</td> + </tr> + <tr> + <td class="name" nowrap><a href="modules/colorizer.parser.hsl.html">colorizer.parser.hsl</a></td> + <td class="summary">Helper function to parse argb</td> + </tr> + <tr> + <td class="name" nowrap><a href="modules/colorizer.parser.names.html">colorizer.parser.names</a></td> + <td class="summary">Helper function to parse argb</td> + </tr> + <tr> + <td class="name" nowrap><a href="modules/colorizer.parser.rgb.html">colorizer.parser.rgb</a></td> + <td class="summary">Helper function to parse argb</td> + </tr> + <tr> + <td class="name" nowrap><a href="modules/colorizer.parser.rgba_hex.html">colorizer.parser.rgba_hex</a></td> + <td class="summary">Helper function to parse argb</td> + </tr> + <tr> <td class="name" nowrap><a href="modules/colorizer.sass.html">colorizer.sass</a></td> <td class="summary">Helper functions to parse sass color variables</td> </tr> diff --git a/doc/modules/colorizer.buffer.html b/doc/modules/colorizer.buffer.html index 6bce06a..53de887 100644 --- a/doc/modules/colorizer.buffer.html +++ b/doc/modules/colorizer.buffer.html @@ -44,6 +44,11 @@ <li><strong>buffer</strong></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.parser.argb_hex.html">parser.argb_hex</a></li> + <li><a href="../modules/colorizer.parser.hsl.html">parser.hsl</a></li> + <li><a href="../modules/colorizer.parser.names.html">parser.names</a></li> + <li><a href="../modules/colorizer.parser.rgb.html">parser.rgb</a></li> + <li><a href="../modules/colorizer.parser.rgba_hex.html">parser.rgba_hex</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> diff --git a/doc/modules/colorizer.color.html b/doc/modules/colorizer.color.html index 5947611..37a92cd 100644 --- a/doc/modules/colorizer.color.html +++ b/doc/modules/colorizer.color.html @@ -42,6 +42,11 @@ <li><a href="../modules/colorizer.buffer.html">buffer</a></li> <li><strong>color</strong></li> <li><a href="../modules/colorizer.matcher.html">matcher</a></li> + <li><a href="../modules/colorizer.parser.argb_hex.html">parser.argb_hex</a></li> + <li><a href="../modules/colorizer.parser.hsl.html">parser.hsl</a></li> + <li><a href="../modules/colorizer.parser.names.html">parser.names</a></li> + <li><a href="../modules/colorizer.parser.rgb.html">parser.rgb</a></li> + <li><a href="../modules/colorizer.parser.rgba_hex.html">parser.rgba_hex</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> @@ -53,7 +58,7 @@ <div id="content"> <h1>Module <code>colorizer.color</code></h1> -<p>Helper functions to parse different colour formats</p> +<p>Helper color functions</p> <p> </p> @@ -62,18 +67,10 @@ <h2><a href="#Functions">Functions</a></h2> <table class="function_list"> <tr> - <td class="name" nowrap><a href="#argb_hex_parser">argb_hex_parser (line, i)</a></td> - <td class="summary">parse for 0xaarrggbb and return rgb hex.</td> - </tr> - <tr> <td class="name" nowrap><a href="#hsl_to_rgb">hsl_to_rgb (h, s, l)</a></td> <td class="summary">Converts an HSL color value to RGB.</td> </tr> <tr> - <td class="name" nowrap><a href="#hsl_function_parser">hsl_function_parser (line, i, opts)</a></td> - <td class="summary">Parse for hsl() hsla() css function and return rgb hex.</td> - </tr> - <tr> <td class="name" nowrap><a href="#hue_to_rgb">hue_to_rgb (p, q, t)</a></td> <td class="summary">Convert hsl colour values to rgb.</td> </tr> @@ -81,18 +78,6 @@ <td class="name" nowrap><a href="#is_bright">is_bright (r, g, b)</a></td> <td class="summary">Determine whether to use black or white text.</td> </tr> - <tr> - <td class="name" nowrap><a href="#name_parser">name_parser (line, i, opts)</a></td> - <td class="summary">Grab all the colour values from <code>vim.api.nvim_get_color_map</code> and create a lookup table.</td> - </tr> - <tr> - <td class="name" nowrap><a href="#rgb_function_parser">rgb_function_parser (line, i, opts)</a></td> - <td class="summary">Parse for rgb() rgba() css function and return rgb hex.</td> - </tr> - <tr> - <td class="name" nowrap><a href="#rgba_hex_parser">rgba_hex_parser (line, i, opts)</a></td> - <td class="summary">parse for #rrggbbaa and return rgb hex.</td> - </tr> </table> <br/> @@ -103,37 +88,6 @@ <dl class="function"> <dt> - <a name = "argb_hex_parser"></a> - <strong>argb_hex_parser (line, i)</strong> - </dt> - <dd> - parse for 0xaarrggbb and return rgb hex. - a format used in android apps - - - <h3>Parameters:</h3> - <ul> - <li><span class="parameter">line</span> - string: line to parse - </li> - <li><span class="parameter">i</span> - number: index of line from where to start parsing - </li> - </ul> - - <h3>Returns:</h3> - <ol> - <li> - number|nil: index of line where the hex value ended</li> - <li> - string|nil: rgb hex value</li> - </ol> - - - - -</dd> - <dt> <a name = "hsl_to_rgb"></a> <strong>hsl_to_rgb (h, s, l)</strong> </dt> @@ -165,40 +119,6 @@ </dd> <dt> - <a name = "hsl_function_parser"></a> - <strong>hsl_function_parser (line, i, opts)</strong> - </dt> - <dd> - Parse for hsl() hsla() css function and return rgb hex. - For more info: https://developer.mozilla.org/en-US/docs/Web/CSS/color_value/hsl - - - <h3>Parameters:</h3> - <ul> - <li><span class="parameter">line</span> - string: Line to parse - </li> - <li><span class="parameter">i</span> - number: Index of line from where to start parsing - </li> - <li><span class="parameter">opts</span> - table: Values passed from matchers like prefix - </li> - </ul> - - <h3>Returns:</h3> - <ol> - <li> - number|nil: Index of line where the hsla/hsl function ended</li> - <li> - string|nil: rgb hex value</li> - </ol> - - - - -</dd> - <dt> <a name = "hue_to_rgb"></a> <strong>hue_to_rgb (p, q, t)</strong> </dt> @@ -259,101 +179,6 @@ </dd> - <dt> - <a name = "name_parser"></a> - <strong>name_parser (line, i, opts)</strong> - </dt> - <dd> - Grab all the colour values from <code>vim.api.nvim_get_color_map</code> and create a lookup table. - COLOR_MAP is used to store the colour values - - - <h3>Parameters:</h3> - <ul> - <li><span class="parameter">line</span> - string: Line to parse - </li> - <li><span class="parameter">i</span> - number: Index of line from where to start parsing - </li> - <li><span class="parameter">opts</span> - table: Currently contains whether tailwind is enabled or not - </li> - </ul> - - - - - -</dd> - <dt> - <a name = "rgb_function_parser"></a> - <strong>rgb_function_parser (line, i, opts)</strong> - </dt> - <dd> - Parse for rgb() rgba() css function and return rgb hex. - For more info: https://developer.mozilla.org/en-US/docs/Web/CSS/color_value/rgb - - - <h3>Parameters:</h3> - <ul> - <li><span class="parameter">line</span> - string: Line to parse - </li> - <li><span class="parameter">i</span> - number: Index of line from where to start parsing - </li> - <li><span class="parameter">opts</span> - table: Values passed from matchers like prefix - </li> - </ul> - - <h3>Returns:</h3> - <ol> - <li> - number|nil: Index of line where the rgb/rgba function ended</li> - <li> - string|nil: rgb hex value</li> - </ol> - - - - -</dd> - <dt> - <a name = "rgba_hex_parser"></a> - <strong>rgba_hex_parser (line, i, opts)</strong> - </dt> - <dd> - parse for #rrggbbaa and return rgb hex. - a format used in android apps - - - <h3>Parameters:</h3> - <ul> - <li><span class="parameter">line</span> - string: line to parse - </li> - <li><span class="parameter">i</span> - number: index of line from where to start parsing - </li> - <li><span class="parameter">opts</span> - table: Containing minlen, maxlen, valid_lengths - </li> - </ul> - - <h3>Returns:</h3> - <ol> - <li> - number|nil: index of line where the hex value ended</li> - <li> - string|nil: rgb hex value</li> - </ol> - - - - -</dd> </dl> diff --git a/doc/modules/colorizer.html b/doc/modules/colorizer.html index 1d338e1..ad89e1b 100644 --- a/doc/modules/colorizer.html +++ b/doc/modules/colorizer.html @@ -44,6 +44,11 @@ <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.parser.argb_hex.html">parser.argb_hex</a></li> + <li><a href="../modules/colorizer.parser.hsl.html">parser.hsl</a></li> + <li><a href="../modules/colorizer.parser.names.html">parser.names</a></li> + <li><a href="../modules/colorizer.parser.rgb.html">parser.rgb</a></li> + <li><a href="../modules/colorizer.parser.rgba_hex.html">parser.rgba_hex</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> diff --git a/doc/modules/colorizer.matcher.html b/doc/modules/colorizer.matcher.html index 3034bb2..971193b 100644 --- a/doc/modules/colorizer.matcher.html +++ b/doc/modules/colorizer.matcher.html @@ -42,6 +42,11 @@ <li><a href="../modules/colorizer.buffer.html">buffer</a></li> <li><a href="../modules/colorizer.color.html">color</a></li> <li><strong>matcher</strong></li> + <li><a href="../modules/colorizer.parser.argb_hex.html">parser.argb_hex</a></li> + <li><a href="../modules/colorizer.parser.hsl.html">parser.hsl</a></li> + <li><a href="../modules/colorizer.parser.names.html">parser.names</a></li> + <li><a href="../modules/colorizer.parser.rgb.html">parser.rgb</a></li> + <li><a href="../modules/colorizer.parser.rgba_hex.html">parser.rgba_hex</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> diff --git a/doc/modules/colorizer.parser.argb_hex.html b/doc/modules/colorizer.parser.argb_hex.html new file mode 100644 index 0000000..52b4387 --- /dev/null +++ b/doc/modules/colorizer.parser.argb_hex.html @@ -0,0 +1,124 @@ +<!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><strong>parser.argb_hex</strong></li> + <li><a href="../modules/colorizer.parser.hsl.html">parser.hsl</a></li> + <li><a href="../modules/colorizer.parser.names.html">parser.names</a></li> + <li><a href="../modules/colorizer.parser.rgb.html">parser.rgb</a></li> + <li><a href="../modules/colorizer.parser.rgba_hex.html">parser.rgba_hex</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><a href="../modules/colorizer.utils.html">utils</a></li> +</ul> + +</div> + +<div id="content"> + +<h1>Module <code>colorizer.parser.argb_hex</code></h1> +<p>Helper function to parse argb</p> +<p> + +</p> + + +<h2><a href="#Functions">Functions</a></h2> +<table class="function_list"> + <tr> + <td class="name" nowrap><a href="#parser.argb_hex_parser">parser.argb_hex_parser (line, i)</a></td> + <td class="summary">parse for 0xaarrggbb and return rgb hex.</td> + </tr> +</table> + +<br/> +<br/> + + + <h2 class="section-header "><a name="Functions"></a>Functions</h2> + + <dl class="function"> + <dt> + <a name = "parser.argb_hex_parser"></a> + <strong>parser.argb_hex_parser (line, i)</strong> + </dt> + <dd> + parse for 0xaarrggbb and return rgb hex. + a format used in android apps + + + <h3>Parameters:</h3> + <ul> + <li><span class="parameter">line</span> + string: line to parse + </li> + <li><span class="parameter">i</span> + number: index of line from where to start parsing + </li> + </ul> + + <h3>Returns:</h3> + <ol> + <li> + number|nil: index of line where the hex value ended</li> + <li> + string|nil: rgb hex value</li> + </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 - February </i> +</div> <!-- id="about" --> +</div> <!-- id="container" --> +</body> +</html> diff --git a/doc/modules/colorizer.parser.hsl.html b/doc/modules/colorizer.parser.hsl.html new file mode 100644 index 0000000..b42e253 --- /dev/null +++ b/doc/modules/colorizer.parser.hsl.html @@ -0,0 +1,127 @@ +<!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.parser.argb_hex.html">parser.argb_hex</a></li> + <li><strong>parser.hsl</strong></li> + <li><a href="../modules/colorizer.parser.names.html">parser.names</a></li> + <li><a href="../modules/colorizer.parser.rgb.html">parser.rgb</a></li> + <li><a href="../modules/colorizer.parser.rgba_hex.html">parser.rgba_hex</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><a href="../modules/colorizer.utils.html">utils</a></li> +</ul> + +</div> + +<div id="content"> + +<h1>Module <code>colorizer.parser.hsl</code></h1> +<p>Helper function to parse argb</p> +<p> + +</p> + + +<h2><a href="#Functions">Functions</a></h2> +<table class="function_list"> + <tr> + <td class="name" nowrap><a href="#parser.hsl_function_parser">parser.hsl_function_parser (line, i, opts)</a></td> + <td class="summary">Parse for hsl() hsla() css function and return rgb hex.</td> + </tr> +</table> + +<br/> +<br/> + + + <h2 class="section-header "><a name="Functions"></a>Functions</h2> + + <dl class="function"> + <dt> + <a name = "parser.hsl_function_parser"></a> + <strong>parser.hsl_function_parser (line, i, opts)</strong> + </dt> + <dd> + Parse for hsl() hsla() css function and return rgb hex. + For more info: https://developer.mozilla.org/en-US/docs/Web/CSS/color_value/hsl + + + <h3>Parameters:</h3> + <ul> + <li><span class="parameter">line</span> + string: Line to parse + </li> + <li><span class="parameter">i</span> + number: Index of line from where to start parsing + </li> + <li><span class="parameter">opts</span> + table: Values passed from matchers like prefix + </li> + </ul> + + <h3>Returns:</h3> + <ol> + <li> + number|nil: Index of line where the hsla/hsl function ended</li> + <li> + string|nil: rgb hex value</li> + </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 - February </i> +</div> <!-- id="about" --> +</div> <!-- id="container" --> +</body> +</html> diff --git a/doc/modules/colorizer.parser.names.html b/doc/modules/colorizer.parser.names.html new file mode 100644 index 0000000..d826dee --- /dev/null +++ b/doc/modules/colorizer.parser.names.html @@ -0,0 +1,120 @@ +<!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.parser.argb_hex.html">parser.argb_hex</a></li> + <li><a href="../modules/colorizer.parser.hsl.html">parser.hsl</a></li> + <li><strong>parser.names</strong></li> + <li><a href="../modules/colorizer.parser.rgb.html">parser.rgb</a></li> + <li><a href="../modules/colorizer.parser.rgba_hex.html">parser.rgba_hex</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><a href="../modules/colorizer.utils.html">utils</a></li> +</ul> + +</div> + +<div id="content"> + +<h1>Module <code>colorizer.parser.names</code></h1> +<p>Helper function to parse argb</p> +<p> + +</p> + + +<h2><a href="#Functions">Functions</a></h2> +<table class="function_list"> + <tr> + <td class="name" nowrap><a href="#parser.name_parser">parser.name_parser (line, i, opts)</a></td> + <td class="summary">Grab all the colour values from <code>vim.api.nvim_get_color_map</code> and create a lookup table.</td> + </tr> +</table> + +<br/> +<br/> + + + <h2 class="section-header "><a name="Functions"></a>Functions</h2> + + <dl class="function"> + <dt> + <a name = "parser.name_parser"></a> + <strong>parser.name_parser (line, i, opts)</strong> + </dt> + <dd> + Grab all the colour values from <code>vim.api.nvim_get_color_map</code> and create a lookup table. + COLOR_MAP is used to store the colour values + + + <h3>Parameters:</h3> + <ul> + <li><span class="parameter">line</span> + string: Line to parse + </li> + <li><span class="parameter">i</span> + number: Index of line from where to start parsing + </li> + <li><span class="parameter">opts</span> + table: Currently contains whether tailwind is enabled or not + </li> + </ul> + + + + + +</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 - February </i> +</div> <!-- id="about" --> +</div> <!-- id="container" --> +</body> +</html> diff --git a/doc/modules/colorizer.parser.rgb.html b/doc/modules/colorizer.parser.rgb.html new file mode 100644 index 0000000..0e30612 --- /dev/null +++ b/doc/modules/colorizer.parser.rgb.html @@ -0,0 +1,127 @@ +<!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.parser.argb_hex.html">parser.argb_hex</a></li> + <li><a href="../modules/colorizer.parser.hsl.html">parser.hsl</a></li> + <li><a href="../modules/colorizer.parser.names.html">parser.names</a></li> + <li><strong>parser.rgb</strong></li> + <li><a href="../modules/colorizer.parser.rgba_hex.html">parser.rgba_hex</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><a href="../modules/colorizer.utils.html">utils</a></li> +</ul> + +</div> + +<div id="content"> + +<h1>Module <code>colorizer.parser.rgb</code></h1> +<p>Helper function to parse argb</p> +<p> + +</p> + + +<h2><a href="#Functions">Functions</a></h2> +<table class="function_list"> + <tr> + <td class="name" nowrap><a href="#parser.rgb_function_parser">parser.rgb_function_parser (line, i, opts)</a></td> + <td class="summary">Parse for rgb() rgba() css function and return rgb hex.</td> + </tr> +</table> + +<br/> +<br/> + + + <h2 class="section-header "><a name="Functions"></a>Functions</h2> + + <dl class="function"> + <dt> + <a name = "parser.rgb_function_parser"></a> + <strong>parser.rgb_function_parser (line, i, opts)</strong> + </dt> + <dd> + Parse for rgb() rgba() css function and return rgb hex. + For more info: https://developer.mozilla.org/en-US/docs/Web/CSS/color_value/rgb + + + <h3>Parameters:</h3> + <ul> + <li><span class="parameter">line</span> + string: Line to parse + </li> + <li><span class="parameter">i</span> + number: Index of line from where to start parsing + </li> + <li><span class="parameter">opts</span> + table: Values passed from matchers like prefix + </li> + </ul> + + <h3>Returns:</h3> + <ol> + <li> + number|nil: Index of line where the rgb/rgba function ended</li> + <li> + string|nil: rgb hex value</li> + </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 - February </i> +</div> <!-- id="about" --> +</div> <!-- id="container" --> +</body> +</html> diff --git a/doc/modules/colorizer.parser.rgba_hex.html b/doc/modules/colorizer.parser.rgba_hex.html new file mode 100644 index 0000000..3e7187e --- /dev/null +++ b/doc/modules/colorizer.parser.rgba_hex.html @@ -0,0 +1,127 @@ +<!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.parser.argb_hex.html">parser.argb_hex</a></li> + <li><a href="../modules/colorizer.parser.hsl.html">parser.hsl</a></li> + <li><a href="../modules/colorizer.parser.names.html">parser.names</a></li> + <li><a href="../modules/colorizer.parser.rgb.html">parser.rgb</a></li> + <li><strong>parser.rgba_hex</strong></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><a href="../modules/colorizer.utils.html">utils</a></li> +</ul> + +</div> + +<div id="content"> + +<h1>Module <code>colorizer.parser.rgba_hex</code></h1> +<p>Helper function to parse argb</p> +<p> + +</p> + + +<h2><a href="#Functions">Functions</a></h2> +<table class="function_list"> + <tr> + <td class="name" nowrap><a href="#parser.rgba_hex_parser">parser.rgba_hex_parser (line, i, opts)</a></td> + <td class="summary">parse for #rrggbbaa and return rgb hex.</td> + </tr> +</table> + +<br/> +<br/> + + + <h2 class="section-header "><a name="Functions"></a>Functions</h2> + + <dl class="function"> + <dt> + <a name = "parser.rgba_hex_parser"></a> + <strong>parser.rgba_hex_parser (line, i, opts)</strong> + </dt> + <dd> + parse for #rrggbbaa and return rgb hex. + a format used in android apps + + + <h3>Parameters:</h3> + <ul> + <li><span class="parameter">line</span> + string: line to parse + </li> + <li><span class="parameter">i</span> + number: index of line from where to start parsing + </li> + <li><span class="parameter">opts</span> + table: Containing minlen, maxlen, valid_lengths + </li> + </ul> + + <h3>Returns:</h3> + <ol> + <li> + number|nil: index of line where the hex value ended</li> + <li> + string|nil: rgb hex value</li> + </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 - February </i> +</div> <!-- id="about" --> +</div> <!-- id="container" --> +</body> +</html> diff --git a/doc/modules/colorizer.sass.html b/doc/modules/colorizer.sass.html index cf0d133..0f93f28 100644 --- a/doc/modules/colorizer.sass.html +++ b/doc/modules/colorizer.sass.html @@ -42,6 +42,11 @@ <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.parser.argb_hex.html">parser.argb_hex</a></li> + <li><a href="../modules/colorizer.parser.hsl.html">parser.hsl</a></li> + <li><a href="../modules/colorizer.parser.names.html">parser.names</a></li> + <li><a href="../modules/colorizer.parser.rgb.html">parser.rgb</a></li> + <li><a href="../modules/colorizer.parser.rgba_hex.html">parser.rgba_hex</a></li> <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> diff --git a/doc/modules/colorizer.tailwind.html b/doc/modules/colorizer.tailwind.html index 346a21a..76ea36f 100644 --- a/doc/modules/colorizer.tailwind.html +++ b/doc/modules/colorizer.tailwind.html @@ -42,6 +42,11 @@ <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.parser.argb_hex.html">parser.argb_hex</a></li> + <li><a href="../modules/colorizer.parser.hsl.html">parser.hsl</a></li> + <li><a href="../modules/colorizer.parser.names.html">parser.names</a></li> + <li><a href="../modules/colorizer.parser.rgb.html">parser.rgb</a></li> + <li><a href="../modules/colorizer.parser.rgba_hex.html">parser.rgba_hex</a></li> <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> diff --git a/doc/modules/colorizer.trie.html b/doc/modules/colorizer.trie.html index 9071219..ba03d80 100644 --- a/doc/modules/colorizer.trie.html +++ b/doc/modules/colorizer.trie.html @@ -38,6 +38,11 @@ <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.parser.argb_hex.html">parser.argb_hex</a></li> + <li><a href="../modules/colorizer.parser.hsl.html">parser.hsl</a></li> + <li><a href="../modules/colorizer.parser.names.html">parser.names</a></li> + <li><a href="../modules/colorizer.parser.rgb.html">parser.rgb</a></li> + <li><a href="../modules/colorizer.parser.rgba_hex.html">parser.rgba_hex</a></li> <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> diff --git a/doc/modules/colorizer.utils.html b/doc/modules/colorizer.utils.html index 5ebd197..f9654af 100644 --- a/doc/modules/colorizer.utils.html +++ b/doc/modules/colorizer.utils.html @@ -42,6 +42,11 @@ <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.parser.argb_hex.html">parser.argb_hex</a></li> + <li><a href="../modules/colorizer.parser.hsl.html">parser.hsl</a></li> + <li><a href="../modules/colorizer.parser.names.html">parser.names</a></li> + <li><a href="../modules/colorizer.parser.rgb.html">parser.rgb</a></li> + <li><a href="../modules/colorizer.parser.rgba_hex.html">parser.rgba_hex</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> |