1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361
|
;;; shr-color.el --- Simple HTML Renderer color management -*- lexical-binding:t -*-
;; Copyright (C) 2010-2025 Free Software Foundation, Inc.
;; Author: Julien Danjou <julien@danjou.info>
;; Keywords: html
;; This file is part of GNU Emacs.
;; GNU Emacs is free software: you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
;; GNU General Public License for more details.
;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>.
;;; Commentary:
;; This package handles colors display for shr.
;;; Code:
(require 'color)
(eval-when-compile (require 'cl-lib))
(defgroup shr-color nil
"Simple HTML Renderer colors."
:group 'shr)
(defcustom shr-color-visible-luminance-min 40
"Minimum luminance distance between two colors to be considered visible.
Must be between 0 and 100."
:type 'number)
(defcustom shr-color-visible-distance-min 5
"Minimum color distance between two colors to be considered visible.
This value is used to compare result for `ciede2000'. It's an
absolute value without any unit."
:type 'integer)
(defconst shr-color-html-colors-alist
'(("AliceBlue" . "#F0F8FF")
("AntiqueWhite" . "#FAEBD7")
("Aqua" . "#00FFFF")
("Aquamarine" . "#7FFFD4")
("Azure" . "#F0FFFF")
("Beige" . "#F5F5DC")
("Bisque" . "#FFE4C4")
("Black" . "#000000")
("BlanchedAlmond" . "#FFEBCD")
("Blue" . "#0000FF")
("BlueViolet" . "#8A2BE2")
("Brown" . "#A52A2A")
("BurlyWood" . "#DEB887")
("CadetBlue" . "#5F9EA0")
("Chartreuse" . "#7FFF00")
("Chocolate" . "#D2691E")
("Coral" . "#FF7F50")
("CornflowerBlue" . "#6495ED")
("Cornsilk" . "#FFF8DC")
("Crimson" . "#DC143C")
("Cyan" . "#00FFFF")
("DarkBlue" . "#00008B")
("DarkCyan" . "#008B8B")
("DarkGoldenRod" . "#B8860B")
("DarkGray" . "#A9A9A9")
("DarkGrey" . "#A9A9A9")
("DarkGreen" . "#006400")
("DarkKhaki" . "#BDB76B")
("DarkMagenta" . "#8B008B")
("DarkOliveGreen" . "#556B2F")
("Darkorange" . "#FF8C00")
("DarkOrchid" . "#9932CC")
("DarkRed" . "#8B0000")
("DarkSalmon" . "#E9967A")
("DarkSeaGreen" . "#8FBC8F")
("DarkSlateBlue" . "#483D8B")
("DarkSlateGray" . "#2F4F4F")
("DarkSlateGrey" . "#2F4F4F")
("DarkTurquoise" . "#00CED1")
("DarkViolet" . "#9400D3")
("DeepPink" . "#FF1493")
("DeepSkyBlue" . "#00BFFF")
("DimGray" . "#696969")
("DimGrey" . "#696969")
("DodgerBlue" . "#1E90FF")
("FireBrick" . "#B22222")
("FloralWhite" . "#FFFAF0")
("ForestGreen" . "#228B22")
("Fuchsia" . "#FF00FF")
("Gainsboro" . "#DCDCDC")
("GhostWhite" . "#F8F8FF")
("Gold" . "#FFD700")
("GoldenRod" . "#DAA520")
("Gray" . "#808080")
("Grey" . "#808080")
("Green" . "#008000")
("GreenYellow" . "#ADFF2F")
("HoneyDew" . "#F0FFF0")
("HotPink" . "#FF69B4")
("IndianRed" . "#CD5C5C")
("Indigo" . "#4B0082")
("Ivory" . "#FFFFF0")
("Khaki" . "#F0E68C")
("Lavender" . "#E6E6FA")
("LavenderBlush" . "#FFF0F5")
("LawnGreen" . "#7CFC00")
("LemonChiffon" . "#FFFACD")
("LightBlue" . "#ADD8E6")
("LightCoral" . "#F08080")
("LightCyan" . "#E0FFFF")
("LightGoldenRodYellow" . "#FAFAD2")
("LightGray" . "#D3D3D3")
("LightGrey" . "#D3D3D3")
("LightGreen" . "#90EE90")
("LightPink" . "#FFB6C1")
("LightSalmon" . "#FFA07A")
("LightSeaGreen" . "#20B2AA")
("LightSkyBlue" . "#87CEFA")
("LightSlateGray" . "#778899")
("LightSlateGrey" . "#778899")
("LightSteelBlue" . "#B0C4DE")
("LightYellow" . "#FFFFE0")
("Lime" . "#00FF00")
("LimeGreen" . "#32CD32")
("Linen" . "#FAF0E6")
("Magenta" . "#FF00FF")
("Maroon" . "#800000")
("MediumAquaMarine" . "#66CDAA")
("MediumBlue" . "#0000CD")
("MediumOrchid" . "#BA55D3")
("MediumPurple" . "#9370DB")
("MediumSeaGreen" . "#3CB371")
("MediumSlateBlue" . "#7B68EE")
("MediumSpringGreen" . "#00FA9A")
("MediumTurquoise" . "#48D1CC")
("MediumVioletRed" . "#C71585")
("MidnightBlue" . "#191970")
("MintCream" . "#F5FFFA")
("MistyRose" . "#FFE4E1")
("Moccasin" . "#FFE4B5")
("NavajoWhite" . "#FFDEAD")
("Navy" . "#000080")
("OldLace" . "#FDF5E6")
("Olive" . "#808000")
("OliveDrab" . "#6B8E23")
("Orange" . "#FFA500")
("OrangeRed" . "#FF4500")
("Orchid" . "#DA70D6")
("PaleGoldenRod" . "#EEE8AA")
("PaleGreen" . "#98FB98")
("PaleTurquoise" . "#AFEEEE")
("PaleVioletRed" . "#DB7093")
("PapayaWhip" . "#FFEFD5")
("PeachPuff" . "#FFDAB9")
("Peru" . "#CD853F")
("Pink" . "#FFC0CB")
("Plum" . "#DDA0DD")
("PowderBlue" . "#B0E0E6")
("Purple" . "#800080")
("RebeccaPurple" . "#663399")
("Red" . "#FF0000")
("RosyBrown" . "#BC8F8F")
("RoyalBlue" . "#4169E1")
("SaddleBrown" . "#8B4513")
("Salmon" . "#FA8072")
("SandyBrown" . "#F4A460")
("SeaGreen" . "#2E8B57")
("SeaShell" . "#FFF5EE")
("Sienna" . "#A0522D")
("Silver" . "#C0C0C0")
("SkyBlue" . "#87CEEB")
("SlateBlue" . "#6A5ACD")
("SlateGray" . "#708090")
("SlateGrey" . "#708090")
("Snow" . "#FFFAFA")
("SpringGreen" . "#00FF7F")
("SteelBlue" . "#4682B4")
("Tan" . "#D2B48C")
("Teal" . "#008080")
("Thistle" . "#D8BFD8")
("Tomato" . "#FF6347")
("Turquoise" . "#40E0D0")
("Violet" . "#EE82EE")
("Wheat" . "#F5DEB3")
("White" . "#FFFFFF")
("WhiteSmoke" . "#F5F5F5")
("Yellow" . "#FFFF00")
("YellowGreen" . "#9ACD32"))
"Alist of HTML colors.
Each entry should have the form (COLOR-NAME . HEXADECIMAL-COLOR).")
(defun shr-color-relative-to-absolute (number)
"Convert a relative NUMBER to absolute.
If NUMBER is absolute, return NUMBER.
This will convert \"80 %\" to 204, \"100 %\" to 255 but \"123\" to \"123\"."
(let ((string-length (- (length number) 1)))
;; Is this a number with %?
(if (eq (elt number string-length) ?%)
(/ (* (string-to-number (substring number 0 string-length)) 255) 100)
(string-to-number number))))
(defun shr-color-hue-to-rgb (x y h)
"Convert X Y H to RGB value."
(when (< h 0) (cl-incf h))
(when (> h 1) (cl-decf h))
(cond ((< h (/ 6.0)) (+ x (* (- y x) h 6)))
((< h 0.5) y)
((< h (/ 2.0 3.0)) (+ x (* (- y x) (- (/ 2.0 3.0) h) 6)))
(t x)))
(defun shr-color-hsl-to-rgb-fractions (h s l)
"Convert H S L to fractional RGB values."
(let (m1 m2)
(if (<= l 0.5)
(setq m2 (* l (+ s 1)))
(setq m2 (- (+ l s) (* l s))))
(setq m1 (- (* l 2) m2))
(list (shr-color-hue-to-rgb m1 m2 (+ h (/ 3.0)))
(shr-color-hue-to-rgb m1 m2 h)
(shr-color-hue-to-rgb m1 m2 (- h (/ 3.0))))))
(defun shr-color->hexadecimal (color)
"Convert any color format to hexadecimal representation.
Like rgb() or hsl()."
(when color
(cond
;; Hexadecimal color: #abc or #aabbcc
((string-match
"\\(#[[:xdigit:]]\\{3\\}[[:xdigit:]]\\{3\\}?\\)"
color)
(match-string 1 color))
;; rgb() or rgba() colors
((or (string-match
"rgb(\s*\\([0-9]\\{1,3\\}\\(?:\s*%\\)?\\)\s*,\s*\\([0-9]\\{1,3\\}\\(?:\s*%\\)?\\)\s*,\s*\\([0-9]\\{1,3\\}\\(?:\s*%\\)?\\)\s*)"
color)
(string-match
"rgba(\s*\\([0-9]\\{1,3\\}\\(?:\s*%\\)?\\)\s*,\s*\\([0-9]\\{1,3\\}\\(?:\s*%\\)?\\)\s*,\s*\\([0-9]\\{1,3\\}\\(?:\s*%\\)?\\)\s*,\s*[0-9]*\\.?[0-9]+\s*%?\s*)"
color))
(format "#%02X%02X%02X"
(shr-color-relative-to-absolute (match-string-no-properties 1 color))
(shr-color-relative-to-absolute (match-string-no-properties 2 color))
(shr-color-relative-to-absolute (match-string-no-properties 3 color))))
;; hsl() or hsla() colors
((or (string-match
"hsl(\s*\\([0-9]\\{1,3\\}\\)\s*,\s*\\([0-9]\\{1,3\\}\\)\s*%\s*,\s*\\([0-9]\\{1,3\\}\\)\s*%\s*)"
color)
(string-match
"hsla(\s*\\([0-9]\\{1,3\\}\\)\s*,\s*\\([0-9]\\{1,3\\}\\)\s*%\s*,\s*\\([0-9]\\{1,3\\}\\)\s*%\s*,\s*[0-9]*\\.?[0-9]+\s*%?\s*)"
color))
(let ((h (/ (string-to-number (match-string-no-properties 1 color)) 360.0))
(s (/ (string-to-number (match-string-no-properties 2 color)) 100.0))
(l (/ (string-to-number (match-string-no-properties 3 color)) 100.0)))
(pcase-let ((`(,r ,g ,b) (shr-color-hsl-to-rgb-fractions h s l)))
(color-rgb-to-hex r g b 2))))
;; Color names
((cdr (assoc-string color shr-color-html-colors-alist t)))
;; Unrecognized color :(
(t
nil))))
(defun shr-color-set-minimum-interval (val1 val2 min max interval
&optional fixed)
"Set minimum interval between VAL1 and VAL2 to INTERVAL.
The values are bound by MIN and MAX.
If FIXED is t, then VAL1 will not be touched."
(let ((diff (abs (- val1 val2))))
(unless (>= diff interval)
(if fixed
(let* ((missing (- interval diff))
;; If val2 > val1, try to increase val2
;; That's the "good direction"
(val2-good-direction
(if (> val2 val1)
(min max (+ val2 missing))
(max min (- val2 missing))))
(diff-val2-good-direction-val1 (abs (- val2-good-direction val1))))
(if (>= diff-val2-good-direction-val1 interval)
(setq val2 val2-good-direction)
;; Good-direction is not so good, compute bad-direction
(let* ((val2-bad-direction
(if (> val2 val1)
(max min (- val1 interval))
(min max (+ val1 interval))))
(diff-val2-bad-direction-val1 (abs (- val2-bad-direction val1))))
(if (>= diff-val2-bad-direction-val1 interval)
(setq val2 val2-bad-direction)
;; Still not good, pick the best and prefer good direction
(setq val2
(if (>= diff-val2-good-direction-val1 diff-val2-bad-direction-val1)
val2-good-direction
val2-bad-direction))))))
;; No fixed, move val1 and val2
(let ((missing (/ (- interval diff) 2.0)))
(if (< val1 val2)
(setq val1 (max min (- val1 missing))
val2 (min max (+ val2 missing)))
(setq val2 (max min (- val2 missing))
val1 (min max (+ val1 missing))))
(setq diff (abs (- val1 val2))) ; Recompute diff
(unless (>= diff interval)
;; Not ok, we hit a boundary
(let ((missing (- interval diff)))
(cond ((= val1 min)
(setq val2 (+ val2 missing)))
((= val2 min)
(setq val1 (+ val1 missing)))
((= val1 max)
(setq val2 (- val2 missing)))
((= val2 max)
(setq val1 (- val1 missing)))))))))
(list val1 val2)))
(defun shr-color-visible (bg fg &optional fixed-background)
"Check that BG and FG colors are visible if they are drawn on each other.
Return (bg fg) if they are. If they are too similar, two new
colors are returned instead.
If FIXED-BACKGROUND is set, and if the color are not visible, a
new background color will not be computed. Only the foreground
color will be adapted to be visible on BG."
;; Convert fg and bg to CIE Lab
(let ((fg-norm (color-name-to-rgb fg))
(bg-norm (color-name-to-rgb bg)))
(if (or (null fg-norm)
(null bg-norm))
(list bg fg)
(let* ((fg-lab (apply #'color-srgb-to-lab fg-norm))
(bg-lab (apply #'color-srgb-to-lab bg-norm))
;; Compute color distance using CIE DE 2000
(fg-bg-distance (color-cie-de2000 fg-lab bg-lab))
;; Compute luminance distance (subtract L component)
(luminance-distance (abs (- (car fg-lab) (car bg-lab)))))
(if (and (>= fg-bg-distance shr-color-visible-distance-min)
(>= luminance-distance shr-color-visible-luminance-min))
(list bg fg)
;; Not visible, try to change luminance to make them visible
(let ((Ls (shr-color-set-minimum-interval
(car bg-lab) (car fg-lab) 0 100
shr-color-visible-luminance-min fixed-background)))
(unless fixed-background
(setcar bg-lab (car Ls)))
(setcar fg-lab (cadr Ls))
(list
(if fixed-background
bg
(apply #'format "#%02x%02x%02x"
(mapcar (lambda (x) (* (max (min 1 x) 0) 255))
(apply #'color-lab-to-srgb bg-lab))))
(apply #'format "#%02x%02x%02x"
(mapcar (lambda (x) (* (max (min 1 x) 0) 255))
(apply #'color-lab-to-srgb fg-lab))))))))))
(provide 'shr-color)
;;; shr-color.el ends here
|