feat oklch (#160)

* feat(oklch): add support for this css function

You can now see and enable oklch highlighting.

* docs(oklch): add

Update documentation with script.

Author: xav-ie

README.md

@@ -146,9 +146,10 @@ library to do custom highlighting themselves.
       AARRGGBB = false, -- 0xAARRGGBB hex codes
       rgb_fn = false, -- CSS rgb() and rgba() functions
       hsl_fn = false, -- CSS hsl() and hsla() functions
+      oklch_fn = false, -- CSS oklch() function
       css = false, -- Enable all CSS *features*:
-      -- names, RGB, RGBA, RRGGBB, RRGGBBAA, AARRGGBB, rgb_fn, hsl_fn
-      css_fn = false, -- Enable all CSS *functions*: rgb_fn, hsl_fn
+      -- names, RGB, RGBA, RRGGBB, RRGGBBAA, AARRGGBB, rgb_fn, hsl_fn, oklch_fn
+      css_fn = false, -- Enable all CSS *functions*: rgb_fn, hsl_fn, oklch_fn
       -- Tailwind colors.  boolean|'normal'|'lsp'|'both'.  True sets to 'normal'
       tailwind = false, -- Enable tailwind colors
       tailwind_opts = { -- Options for highlighting tailwind names
@@ -227,7 +228,7 @@ require("colorizer").setup({
 require("colorizer").setup({
   filetypes = {
     "*", -- Highlight all files, but customize some others.
-    css = { rgb_fn = true }, -- Enable parsing rgb(...) functions in css.
+    css = { rgb_fn = true, oklch_fn = true }, -- Enable parsing rgb(...) and oklch(...) functions in css.
     html = { names = false }, -- Disable parsing "names" like Blue or Gray
   },
 })
@@ -284,22 +285,22 @@ require("colorizer").setup({
 In `user_default_options`, there are 2 types of options
 
 1. Individual options - `names`, `names_opts`, `names_custom`, `RGB`, `RGBA`,
-   `RRGGBB`, `RRGGBBAA`, `hsl_fn`, `rgb_fn`, `RRGGBBAA`, `AARRGGBB`, `tailwind`,
+   `RRGGBB`, `RRGGBBAA`, `hsl_fn`, `rgb_fn`, `oklch_fn`, `RRGGBBAA`, `AARRGGBB`, `tailwind`,
    `sass`, `xterm`
 
 1. Alias options - `css`, `css_fn`
 
-If `css_fn` is true `hsl_fn`, `rgb_fn` becomes `true`
+If `css_fn` is true `hsl_fn`, `rgb_fn`, `oklch_fn` becomes `true`
 
-If `css` is true `names`, `RGB`, `RGBA`, `RRGGBB`, `RRGGBBAA`, `hsl_fn`, `rgb_fn`
+If `css` is true `names`, `RGB`, `RGBA`, `RRGGBB`, `RRGGBBAA`, `hsl_fn`, `rgb_fn`, `oklch_fn`
 becomes `true`
 
 These options have a priority, Individual options have the highest priority,
 then alias options
 
 For alias, `css_fn` has more priority over `css`
 
-e.g: Here `RGB`, `RGBA`, `RRGGBB`, `RRGGBBAA`, `AARRGGBB`, `hsl_fn`, `rgb_fn` is
+e.g: Here `RGB`, `RGBA`, `RRGGBB`, `RRGGBBAA`, `AARRGGBB`, `hsl_fn`, `rgb_fn`, `oklch_fn` is
 enabled but not `names`
 
 ```lua
@@ -312,7 +313,7 @@ require("colorizer").setup({
 ```
 
 e.g: Here `names`, `RGB`, `RGBA`, `RRGGBB`, `RRGGBBAA`, `AARRGGBB` is enabled but
-not `rgb_fn` and `hsl_fn`
+not `rgb_fn`, `hsl_fn`, and `oklch_fn`
 
 ```lua
 require("colorizer").setup({

doc/colorizer.txt

@@ -342,6 +342,8 @@ Functions: ~
     |is_bright| - Determines whether a color is bright, helping decide text
     color.
 
+    |oklch_to_rgb| - Converts an OKLCH color value to RGB.
+
 
 hsl_to_rgb({h}, {s}, {l})                           *colorizer.color.hsl_to_rgb*
     Converts an HSL color value to RGB.
@@ -405,6 +407,33 @@ is_bright({r}, {g}, {b})                             *colorizer.color.is_bright*
 
 
 
+oklch_to_rgb({L}, {C}, {H})                       *colorizer.color.oklch_to_rgb*
+    Converts an OKLCH color value to RGB.
+
+     OKLCH is a perceptual color space that provides better uniformity than HSL.
+     Accepts lightness, chroma, and hue values and converts them to RGB.
+
+     References:
+       - OKLCH/OKLab specification: https://bottosson.github.io/posts/oklab/
+       - W3C CSS Color Module Level 4: https://www.w3.org/TR/css-color-4/#ok-lab
+       - Conversion algorithms:
+	 https://developer.mozilla.org/en-US/docs/Web/CSS/color_value/oklch
+
+
+
+    Parameters: ~
+	{L} -  number: Lightness, in the range [0, 1].
+	{C} -  number: Chroma, typically in the range [0, 0.4] but can be
+	higher.
+	{H} -  number: Hue, in degrees [0, 360].
+
+    returns:~
+	number or nil,number or nil,number or nil: Returns red, green, and blue
+	values
+	 scaled to [0, 255], or nil if any input value is out of range.
+
+
+
 ==============================================================================
 CONFIG                                           *colorizer.config-introduction*
 
@@ -508,12 +537,13 @@ user_default_options                     *colorizer.config.user_default_options*
 
     Individual Options: Options like `names`, `RGB`, `RRGGBB`, `RRGGBBAA`,
     `hsl_fn`, `rgb_fn`,
-    `AARRGGBB`, `tailwind`, and `sass` can be enabled or disabled independently.
+    `oklch_fn`, `AARRGGBB`, `tailwind`, and `sass` can be enabled or disabled
+    independently.
 
     Alias Options: `css` and `css_fn` enable multiple options at once.
-      - `css_fn = true` enables `hsl_fn` and `rgb_fn`.
-      - `css = true` enables `names`, `RGB`, `RRGGBB`, `RRGGBBAA`, `hsl_fn`, and
-	`rgb_fn`.
+      - `css_fn = true` enables `hsl_fn`, `rgb_fn`, and `oklch_fn`.
+      - `css = true` enables `names`, `RGB`, `RRGGBB`, `RRGGBBAA`, `hsl_fn`,
+	`rgb_fn`, and `oklch_fn`.
 
     Option Priority: Individual options have higher priority than aliases.
     If both `css` and `css_fn` are true, `css_fn` has more priority over `css`.
@@ -533,9 +563,11 @@ user_default_options                     *colorizer.config.user_default_options*
 	{AARRGGBB} -  boolean: Enables `0xAARRGGBB` hex codes.
 	{rgb_fn} -  boolean: Enables CSS `rgb()` and `rgba()` functions.
 	{hsl_fn} -  boolean: Enables CSS `hsl()` and `hsla()` functions.
-	{css} -  boolean: Enables all CSS features (`rgb_fn`, `hsl_fn`, `names`,
-	`RGB`, `RRGGBB`).
-	{css_fn} -  boolean: Enables all CSS functions (`rgb_fn`, `hsl_fn`).
+	{oklch_fn} -  boolean: Enables CSS `oklch()` function.
+	{css} -  boolean: Enables all CSS features (`rgb_fn`, `hsl_fn`,
+	`oklch_fn`, `names`, `RGB`, `RRGGBB`).
+	{css_fn} -  boolean: Enables all CSS functions (`rgb_fn`, `hsl_fn`,
+	`oklch_fn`).
 	{tailwind} -  boolean|string: Enables Tailwind CSS colors (e.g.,
 	`"normal"`, `"lsp"`, `"both"`).
 	{tailwind_opts} -  table: Tailwind options for updating names cache, etc
@@ -595,10 +627,11 @@ ud_opts                                               *colorizer.config.ud_opts*
    - `AARRGGBB` (boolean): Enables support for `0xAARRGGBB` hex codes.
    - `rgb_fn` (boolean): Enables CSS `rgb()` and `rgba()` functions.
    - `hsl_fn` (boolean): Enables CSS `hsl()` and `hsla()` functions.
+   - `oklch_fn` (boolean): Enables CSS `oklch()` function.
    - `css` (boolean): Enables all CSS-related features (e.g., `names`, `RGB`,
-     `RRGGBB`, `hsl_fn`, `rgb_fn`).
+     `RRGGBB`, `hsl_fn`, `rgb_fn`, `oklch_fn`).
    - `css_fn` (boolean): Enables all CSS function-related features (e.g.,
-     `rgb_fn`, `hsl_fn`).
+     `rgb_fn`, `hsl_fn`, `oklch_fn`).
    - `tailwind` (boolean|string): Enables Tailwind CSS colors. Accepts `true`,
      `"normal"`, `"lsp"`, or `"both"`.
    - `tailwind_opts` (table): Tailwind options for updating names cache, etc
@@ -879,6 +912,50 @@ parser({line}, {i}, {m_opts})                    *colorizer.parser.names.parser*
 
 
 
+==============================================================================
+OKLCH                                      *colorizer.parser.oklch-introduction*
+
+This module provides a parser for identifying and converting `oklch()` CSS
+functions to RGB hexadecimal format.
+
+OKLCH is a perceptual color space that provides better uniformity than HSL.
+It supports lightness as both decimal (0-1) and percentage (0-100%),
+chroma values, hue in degrees, and optional alpha transparency.
+This function is useful for syntax highlighting or color recognition in a text
+editor.
+
+==============================================================================
+LUA API                                         *colorizer.parser.oklch-lua-api*
+
+Functions: ~
+    |parser| - Parses `oklch()` CSS functions and converts them to RGB
+    hexadecimal format.
+
+
+parser({line}, {i}, {_})                         *colorizer.parser.oklch.parser*
+    Parses `oklch()` CSS functions and converts them to RGB hexadecimal format.
+
+     This function matches `oklch()` functions within a line of text, extracting
+     and converting
+     the lightness, chroma, and hue to an RGB color. It handles lightness as
+     decimal or percentage,
+     and an optional alpha (transparency) value.
+
+
+    Parameters: ~
+	{line} -  string: The line of text to parse
+	{i} -  number: The starting index within the line where parsing should
+	begin
+	{_} -  table: Parsing options (unused, included for API consistency)
+
+    returns:~
+	number or nil: The end index of the parsed `oklch` function within the
+	line, or `nil` if no match was found.
+	string or nil: The RGB hexadecimal color (e.g., "ff0000" for red), or
+	`nil` if parsing failed
+
+
+
 ==============================================================================
 RGBA_HEX                                *colorizer.parser.rgba_hex-introduction*
 
@@ -1032,10 +1109,11 @@ Functions: ~
 parser({line}, {i})                              *colorizer.parser.xterm.parser*
     Parses xterm color codes and converts them to RGB hex format.
 
-     This function matches both #xNN format (decimal, 0-255) and ANSI escape
-     sequences \e[38;5;NNNm
-     for xterm 256-color palette. It returns the corresponding RGB hex string
-     from the xterm color palette.
+     This function matches following color codes:
+       1. #xNN format (decimal, 0-255).
+       2. ANSI escape sequences \e[38;5;NNNm for xterm 256-color palette.
+       3. ANSI escape sequences \e[X;Ym for xterm 16-color palette.
+     It returns the corresponding RGB hex string from the xterm color palette.
 
 
     Parameters: ~

doc/index.html

@@ -41,6 +41,7 @@ <h2>Modules</h2>
   <li><a href="modules/colorizer.parser.rgb_hex.html">parser.rgb_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.oklch.html">parser.oklch</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.parser.xterm.html">parser.xterm</a></li>
@@ -95,6 +96,10 @@ <h2>Modules</h2>
 		<td class="name"  nowrap><a href="modules/colorizer.parser.names.html">colorizer.parser.names</a></td>
 		<td class="summary">This module provides a parser that identifies named colors from a given line of text.</td>
 	</tr>
+	<tr>
+		<td class="name"  nowrap><a href="modules/colorizer.parser.oklch.html">colorizer.parser.oklch</a></td>
+		<td class="summary">This module provides a parser for identifying and converting `oklch()` CSS functions to RGB hexadecimal format.</td>
+	</tr>
 	<tr>
 		<td class="name"  nowrap><a href="modules/colorizer.parser.rgb.html">colorizer.parser.rgb</a></td>
 		<td class="summary">This module provides a parser for identifying and converting `rgb()` and `rgba()` CSS functions to RGB hexadecimal format.</td>
@@ -133,7 +138,7 @@ <h2>Modules</h2>
 </div> <!-- id="main" -->
 <div id="about">
 <i>generated by <a href="http://github.com/lunarmodules/LDoc">LDoc 1.5.0</a></i>
-<i style="float:right;">Last updated - July </i>
+<i style="float:right;">Last updated - October </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

doc/modules/colorizer.buffer.html

@@ -48,6 +48,7 @@ <h2>Modules</h2>
   <li><a href="../modules/colorizer.parser.rgb_hex.html">parser.rgb_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.oklch.html">parser.oklch</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.parser.xterm.html">parser.xterm</a></li>
@@ -234,7 +235,7 @@ <h3>Returns:</h3>
 </div> <!-- id="main" -->
 <div id="about">
 <i>generated by <a href="http://github.com/lunarmodules/LDoc">LDoc 1.5.0</a></i>
-<i style="float:right;">Last updated - July </i>
+<i style="float:right;">Last updated - October </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

doc/modules/colorizer.color.html

@@ -48,6 +48,7 @@ <h2>Modules</h2>
   <li><a href="../modules/colorizer.parser.rgb_hex.html">parser.rgb_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.oklch.html">parser.oklch</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.parser.xterm.html">parser.xterm</a></li>
@@ -81,6 +82,10 @@ <h2><a href="#Functions">Functions</a></h2>
 	<td class="name" nowrap><a href="#is_bright">is_bright (r, g, b)</a></td>
 	<td class="summary">Determines whether a color is bright, helping decide text color.</td>
 	</tr>
+	<tr>
+	<td class="name" nowrap><a href="#oklch_to_rgb">oklch_to_rgb (L, C, H)</a></td>
+	<td class="summary">Converts an OKLCH color value to RGB.</td>
+	</tr>
 </table>
 
 <br/>
@@ -195,6 +200,45 @@ <h3>Returns:</h3>
 
 
 
+</dd>
+    <dt>
+    <a name = "oklch_to_rgb"></a>
+    <strong>oklch_to_rgb (L, C, H)</strong>
+    </dt>
+    <dd>
+    Converts an OKLCH color value to RGB.
+ OKLCH is a perceptual color space that provides better uniformity than HSL.
+ Accepts lightness, chroma, and hue values and converts them to RGB.
+<p> References:
+   - OKLCH/OKLab specification: https://bottosson.github.io/posts/oklab/
+   - W3C CSS Color Module Level 4: https://www.w3.org/TR/css-color-4/#ok-lab
+   - Conversion algorithms: https://developer.mozilla.org/en-US/docs/Web/CSS/color_value/oklch
+
+
+
+    <h3>Parameters:</h3>
+    <ul>
+        <li><span class="parameter">L</span>
+         number: Lightness, in the range [0, 1].
+        </li>
+        <li><span class="parameter">C</span>
+         number: Chroma, typically in the range [0, 0.4] but can be higher.
+        </li>
+        <li><span class="parameter">H</span>
+         number: Hue, in degrees [0, 360].
+        </li>
+    </ul>
+
+    <h3>Returns:</h3>
+    <ol>
+
+        number|nil,number|nil,number|nil: Returns red, green, and blue values
+         scaled to [0, 255], or nil if any input value is out of range.
+    </ol>
+
+
+
+
 </dd>
 </dl>
 
@@ -203,7 +247,7 @@ <h3>Returns:</h3>
 </div> <!-- id="main" -->
 <div id="about">
 <i>generated by <a href="http://github.com/lunarmodules/LDoc">LDoc 1.5.0</a></i>
-<i style="float:right;">Last updated - July </i>
+<i style="float:right;">Last updated - October </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

doc/modules/colorizer.config.html

@@ -49,6 +49,7 @@ <h2>Modules</h2>
   <li><a href="../modules/colorizer.parser.rgb_hex.html">parser.rgb_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.oklch.html">parser.oklch</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.parser.xterm.html">parser.xterm</a></li>
@@ -259,10 +260,10 @@ <h2 class="section-header "><a name="Tables"></a>Tables</h2>
 This table defines individual options and alias options, allowing configuration of
 colorizer's behavior for different color formats (e.g., `#RGB`, `#RRGGBB`, `#AARRGGBB`, etc.).
 <p>Individual Options: Options like `names`, `RGB`, `RRGGBB`, `RRGGBBAA`, `hsl_fn`, `rgb_fn`,
-`AARRGGBB`, `tailwind`, and `sass` can be enabled or disabled independently.
+`oklch_fn`, `AARRGGBB`, `tailwind`, and `sass` can be enabled or disabled independently.
 <p>Alias Options: `css` and `css_fn` enable multiple options at once.
-  - `css_fn = true` enables `hsl_fn` and `rgb_fn`.
-  - `css = true` enables `names`, `RGB`, `RRGGBB`, `RRGGBBAA`, `hsl_fn`, and `rgb_fn`.
+  - `css_fn = true` enables `hsl_fn`, `rgb_fn`, and `oklch_fn`.
+  - `css = true` enables `names`, `RGB`, `RRGGBB`, `RRGGBBAA`, `hsl_fn`, `rgb_fn`, and `oklch_fn`.
 <p>Option Priority: Individual options have higher priority than aliases.
 If both `css` and `css_fn` are true, `css_fn` has more priority over `css`.
 
@@ -300,11 +301,14 @@ <h3>Fields:</h3>
         <li><span class="parameter">hsl_fn</span>
          boolean: Enables CSS `hsl()` and `hsla()` functions.
         </li>
+        <li><span class="parameter">oklch_fn</span>
+         boolean: Enables CSS `oklch()` function.
+        </li>
         <li><span class="parameter">css</span>
-         boolean: Enables all CSS features (`rgb_fn`, `hsl_fn`, `names`, `RGB`, `RRGGBB`).
+         boolean: Enables all CSS features (`rgb_fn`, `hsl_fn`, `oklch_fn`, `names`, `RGB`, `RRGGBB`).
         </li>
         <li><span class="parameter">css_fn</span>
-         boolean: Enables all CSS functions (`rgb_fn`, `hsl_fn`).
+         boolean: Enables all CSS functions (`rgb_fn`, `hsl_fn`, `oklch_fn`).
         </li>
         <li><span class="parameter">tailwind</span>
          boolean|string: Enables Tailwind CSS colors (e.g., `"normal"`, `"lsp"`, `"both"`).
@@ -414,8 +418,9 @@ <h3>Fields:</h3>
    - `AARRGGBB` (boolean): Enables support for `0xAARRGGBB` hex codes.
    - `rgb_fn` (boolean): Enables CSS `rgb()` and `rgba()` functions.
    - `hsl_fn` (boolean): Enables CSS `hsl()` and `hsla()` functions.
-   - `css` (boolean): Enables all CSS-related features (e.g., `names`, `RGB`, `RRGGBB`, `hsl_fn`, `rgb_fn`).
-   - `css_fn` (boolean): Enables all CSS function-related features (e.g., `rgb_fn`, `hsl_fn`).
+   - `oklch_fn` (boolean): Enables CSS `oklch()` function.
+   - `css` (boolean): Enables all CSS-related features (e.g., `names`, `RGB`, `RRGGBB`, `hsl_fn`, `rgb_fn`, `oklch_fn`).
+   - `css_fn` (boolean): Enables all CSS function-related features (e.g., `rgb_fn`, `hsl_fn`, `oklch_fn`).
    - `tailwind` (boolean|string): Enables Tailwind CSS colors. Accepts `true`, `"normal"`, `"lsp"`, or `"both"`.
    - `tailwind_opts` (table): Tailwind options for updating names cache, etc
       - `update_names` (boolean): Updates Tailwind "normal" names cache from LSP results.  This provides a smoother highlighting experience when tailwind = "both" is used.  Highlighting on non-tailwind lsp buffers (like cmp) becomes more consistent.
@@ -460,7 +465,7 @@ <h3>Fields:</h3>
 </div> <!-- id="main" -->
 <div id="about">
 <i>generated by <a href="http://github.com/lunarmodules/LDoc">LDoc 1.5.0</a></i>
-<i style="float:right;">Last updated - July </i>
+<i style="float:right;">Last updated - October </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>