Allow gamut mapping method to be configurable

Author: facelessuser

CHANGES.md

@@ -2,7 +2,12 @@
 
 ## 6.2.0
 
-- **NEW**: Upgrade ColorAide to 2.0.1.
+- **NEW**: Since browsers do not and may not introduce Color Level 4  
+  gamut mapping at until some future spec, make gamut mapping approach  
+  configurable. Use clipping by default to match browsers as this is  
+  likely what people expect even if it is not an ideal approach. Use  
+  `gamut_map` option to manually control the approach.
+- **NEW**: Upgrade ColorAide to 2.0.2.
 - **FIX**: Fix regression where contrast logic could not adjust to a  
   given contrast due to a property access.
 

ch_mixin.py

@@ -23,6 +23,7 @@ def setup_gamut_style(self):
         ch_settings = sublime.load_settings('color_helper.sublime-settings')
         self.show_out_of_gamut_preview = ch_settings.get('show_out_of_gamut_preview', True)
         self.gamut_space = ch_settings.get('gamut_space', 'srgb')
+        self.gamut_map = ch_settings.get('gamut_map', 'lch-chroma')
         if self.gamut_space not in GAMUT_SPACES:
             self.gamut_space = 'srgb'
 
@@ -34,7 +35,7 @@ def setup_image_border(self):
         if border_color is not None:
             try:
                 border_color = self.base(border_color)
-                border_color.fit(self.gamut_space)
+                border_color.fit(self.gamut_space, method=self.gamut_map)
             except Exception:
                 border_color = None
 
@@ -187,15 +188,15 @@ def get_preview(self, color):
         if not color.in_gamut(check_space):
             message = 'preview out of gamut'
             if self.show_out_of_gamut_preview:
-                pcolor = color.convert(self.gamut_space, fit=True)
+                pcolor = color.convert(self.gamut_space, fit=self.gamut_map)
                 preview1 = pcolor.clone().set('alpha', 1)
                 preview2 = pcolor
             else:
                 preview1 = self.out_of_gamut
                 preview2 = self.out_of_gamut
                 preview_border = self.out_of_gamut_border
         else:
-            pcolor = color.convert(self.gamut_space, fit=True)
+            pcolor = color.convert(self.gamut_space, fit=self.gamut_map)
             preview1 = pcolor.clone().set('alpha', 1)
             preview2 = pcolor
 

ch_panel.py

@@ -245,7 +245,7 @@ def color_picker(self, color):
 
         if self.os_color_picker:
             self.view.hide_popup()
-            new_color = native_picker(self.base(color).convert("srgb", fit=True))
+            new_color = native_picker(self.base(color).convert("srgb", fit=self.gamut_map))
             if new_color is not None:
                 sublime.set_timeout(
                     lambda c=new_color.to_string(**util.COLOR_FULL_PREC): self.view.run_command(

ch_picker.py

@@ -69,7 +69,7 @@ def setup(self, color, mode, controls, on_done, on_cancel):
         self.setup_controls(controls)
         color.convert(self.mode, in_place=True)
         if not color.in_gamut():
-            color.fit()
+            color.fit(method=self.gamut_map)
         else:
             color.clip()
         # Ensure hue is between 0 - 360.

ch_preview.py

@@ -271,6 +271,7 @@ def setup_gamut_options(self):
 
         self.show_out_of_gamut_preview = ch_settings.get('show_out_of_gamut_preview', True)
         self.gamut_space = ch_settings.get('gamut_space', 'srgb')
+        self.gamut_map = ch_settings.get('gamut_map', 'lch-chroma')
         if self.gamut_space not in util.GAMUT_SPACES:
             self.gamut_space = 'srgb'
         self.out_of_gamut = self.base("transparent").convert(self.gamut_space)
@@ -423,7 +424,7 @@ def do_search(self, force=False):
                         mdpopups.scope2style(self.view, self.view.scope_name(pt))['background']
                     ).convert("hsl")
                     hsl['lightness'] = hsl['lightness'] + (0.3 if hsl.luminance() < 0.5 else -0.3)
-                    preview_border = hsl.convert(self.gamut_space, fit=True).set('alpha', 1)
+                    preview_border = hsl.convert(self.gamut_space, fit=self.gamut_map).set('alpha', 1)
 
                     color = self.base(obj.color)
                     title = ''
@@ -434,15 +435,15 @@ def do_search(self, force=False):
                     if not color.in_gamut(check_space):
                         title = ' title="Preview out of gamut"'
                         if self.show_out_of_gamut_preview:
-                            pcolor = color.convert(self.gamut_space, fit=True)
+                            pcolor = color.convert(self.gamut_space, fit=self.gamut_map)
                             preview1 = pcolor.clone().set('alpha', 1)
                             preview2 = pcolor
                         else:
                             preview1 = self.out_of_gamut
                             preview2 = self.out_of_gamut
                             preview_border = self.out_of_gamut_border
                     else:
-                        pcolor = color.convert(self.gamut_space, fit=True)
+                        pcolor = color.convert(self.gamut_space, fit=self.gamut_map)
                         preview1 = pcolor.clone().set('alpha', 1)
                         preview2 = pcolor
 

ch_tool_blend.py

@@ -185,10 +185,10 @@ def preview(self, text):
                 else:
                     check_space = self.gamut_space
                 if not pcolor.in_gamut(check_space):
-                    pcolor.fit(self.gamut_space)
+                    pcolor.fit(self.gamut_space, method=self.gamut_map)
                     message = '<br><em style="font-size: 0.9em;">* preview out of gamut</em>'
                     color_string = "<strong>Gamut Mapped</strong>: {}<br>".format(pcolor.to_string())
-                pcolor.convert(self.gamut_space, fit=True, in_place=True)
+                pcolor.convert(self.gamut_space, fit=self.gamut_map, in_place=True)
                 color_string += "<strong>Color</strong>: {}".format(color.to_string(**util.DEFAULT))
                 preview = pcolor.clone().set('alpha', 1)
                 preview_alpha = pcolor

ch_tool_colormod.py

@@ -106,7 +106,7 @@ def preview(self, text):
                     check_space = self.gamut_space
                 if not pcolor.in_gamut(check_space):
                     message = '<br><em style="font-size: 0.9em;">* preview out of gamut</em>'
-                pcolor.convert(self.gamut_space, fit=True, in_place=True)
+                pcolor.convert(self.gamut_space, fit=self.gamut_map, in_place=True)
                 preview = pcolor.clone().set('alpha', 1)
                 preview_alpha = pcolor
                 preview_border = self.default_border

ch_tool_contrast.py

@@ -83,7 +83,7 @@ def parse_color(base, string, start=0, second=False):
     return color, ratio, more
 
 
-def evaluate(base, string):
+def evaluate(base, string, gamut_map):
     """Evaluate color."""
 
     colors = []
@@ -114,11 +114,11 @@ def evaluate(base, string):
 
         # Package up the color, or the two reference colors along with the mixed.
         if first:
-            colors.append(first.fit('srgb'))
+            colors.append(first.fit('srgb', method=gamut_map))
         if second:
             if second[-1] < 1.0:
                 second[-1] = 1.0
-            colors.append(second.fit('srgb'))
+            colors.append(second.fit('srgb', method=gamut_map))
             if ratio:
                 if first[-1] < 1.0:
                     first = first.compose(second, space="srgb", out_space=first.space())
@@ -193,7 +193,7 @@ def preview(self, text):
         style = self.get_html_style()
 
         try:
-            colors = evaluate(self.base, text)
+            colors = evaluate(self.base, text, self.gamut_map)
             html = mdpopups.md2html(self.view, DEF_RATIO.format(style))
             if len(colors) >= 3:
                 lum2 = colors[1].luminance()

ch_tool_diff.py

@@ -112,7 +112,7 @@ def evaluate(base, string):
             if method == 'euclidean':
                 delta = 'Distance: {}'.format(colors[0].distance(colors[1]))
             else:
-                delta = 'Delta E {}: {}'.format(method, colors[0].delta_e(colors[1].to_string(), method=method))
+                delta = 'Delta E {}: {}'.format(method, colors[0].delta_e(colors[1], method=method))
 
     except Exception:
         delta = 'Delta E 2000: 0'
@@ -186,10 +186,10 @@ def preview(self, text):
                 else:
                     check_space = self.gamut_space
                 if not orig.in_gamut(check_space):
-                    orig.fit(self.gamut_space)
+                    orig.fit(self.gamut_space, method=self.gamut_map)
                     message = '<br><em style="font-size: 0.9em;">* preview out of gamut</em>'
                     color_string = "<strong>Gamut Mapped</strong>: {}<br>".format(orig.to_string())
-                orig.convert(self.gamut_space, fit=True, in_place=True)
+                orig.convert(self.gamut_space, fit=self.gamut_map, in_place=True)
                 color_string += "<strong>Color</strong>: {}".format(color.to_string(**util.DEFAULT))
                 preview = orig.clone().set('alpha', 1)
                 preview_alpha = orig

ch_tool_edit.py

@@ -222,10 +222,10 @@ def preview(self, text):
                 else:
                     check_space = self.gamut_space
                 if not pcolor.in_gamut(check_space):
-                    pcolor.fit(self.gamut_space)
+                    pcolor.fit(self.gamut_space, method=self.gamut_map)
                     message = '<br><em style="font-size: 0.9em;">* preview out of gamut</em>'
                     color_string = "<strong>Gamut Mapped</strong>: {}<br>".format(pcolor.to_string())
-                pcolor.convert(self.gamut_space, fit=True, in_place=True)
+                pcolor.convert(self.gamut_space, fit=self.gamut_map, in_place=True)
                 color_string += "<strong>Color</strong>: {}".format(color.to_string(**util.DEFAULT))
                 preview = pcolor.clone().set('alpha', 1)
                 preview_alpha = pcolor