merge trunk
[emacs.git] / lisp / facemenu.el
blob743115839b231b853ead176fe47776497c6a2ac4
1 ;;; facemenu.el --- create a face menu for interactively adding fonts to text
3 ;; Copyright (C) 1994-1996, 2001-2012 Free Software Foundation, Inc.
5 ;; Author: Boris Goldowsky <boris@gnu.org>
6 ;; Keywords: faces
7 ;; Package: emacs
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation, either version 3 of the License, or
14 ;; (at your option) any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
24 ;;; Commentary:
26 ;; This file defines a menu of faces (bold, italic, etc) which allows you to
27 ;; set the face used for a region of the buffer. Some faces also have
28 ;; keybindings, which are shown in the menu.
30 ;; The menu also contains submenus for indentation and justification-changing
31 ;; commands.
33 ;;; Usage:
34 ;; Selecting a face from the menu or typing the keyboard equivalent will
35 ;; change the region to use that face. If you use transient-mark-mode and the
36 ;; region is not active, the face will be remembered and used for the next
37 ;; insertion. It will be forgotten if you move point or make other
38 ;; modifications before inserting or typing anything.
40 ;; Faces can be selected from the keyboard as well.
41 ;; The standard keybindings are M-o (or ESC o) + letter:
42 ;; M-o i = "set italic", M-o b = "set bold", etc.
44 ;;; Customization:
45 ;; An alternative set of keybindings that may be easier to type can be set up
46 ;; using "Alt" or "Hyper" keys. This requires that you either have or create
47 ;; an Alt or Hyper key on your keyboard. On my keyboard, there is a key
48 ;; labeled "Alt", but to make it act as an Alt key I have to put this command
49 ;; into my .xinitrc:
50 ;; xmodmap -e "add Mod3 = Alt_L"
51 ;; Or, I can make it into a Hyper key with this:
52 ;; xmodmap -e "keysym Alt_L = Hyper_L" -e "add Mod2 = Hyper_L"
53 ;; Check with local X-perts for how to do it on your system.
54 ;; Then you can define your keybindings with code like this in your .emacs:
55 ;; (setq facemenu-keybindings
56 ;; '((default . [?\H-d])
57 ;; (bold . [?\H-b])
58 ;; (italic . [?\H-i])
59 ;; (bold-italic . [?\H-l])
60 ;; (underline . [?\H-u])))
61 ;; (facemenu-update)
62 ;; (setq facemenu-keymap global-map)
63 ;; (define-key global-map [?\H-c] 'facemenu-set-foreground) ; set fg color
64 ;; (define-key global-map [?\H-C] 'facemenu-set-background) ; set bg color
66 ;; The order of the faces that appear in the menu and their keybindings can be
67 ;; controlled by setting the variables `facemenu-keybindings' and
68 ;; `facemenu-new-faces-at-end'. List faces that you want to use in documents
69 ;; in `facemenu-listed-faces'.
71 ;;; Known Problems:
72 ;; Bold and Italic do not combine to create bold-italic if you select them
73 ;; both, although most other combinations (eg bold + underline + some color)
74 ;; do the intuitive thing.
76 ;; There is at present no way to display what the faces look like in
77 ;; the menu itself.
79 ;; `list-faces-display' shows the faces in a different order than
80 ;; this menu, which could be confusing. I do /not/ sort the list
81 ;; alphabetically, because I like the default order: it puts the most
82 ;; basic, common fonts first.
84 ;; Please send me any other problems, comments or ideas.
86 ;;; Code:
88 (eval-when-compile
89 (require 'help)
90 (require 'button))
92 ;; Global bindings:
93 (define-key global-map [C-down-mouse-2] 'facemenu-menu)
94 (define-key global-map "\M-o" 'facemenu-keymap)
96 (defgroup facemenu nil
97 "Create a face menu for interactively adding fonts to text."
98 :group 'faces
99 :prefix "facemenu-")
101 (defcustom facemenu-keybindings
102 (mapcar 'purecopy
103 '((default . "d")
104 (bold . "b")
105 (italic . "i")
106 (bold-italic . "l") ; {bold} intersect {italic} = {l}
107 (underline . "u")))
108 "Alist of interesting faces and keybindings.
109 Each element is itself a list: the car is the name of the face,
110 the next element is the key to use as a keyboard equivalent of the menu item;
111 the binding is made in `facemenu-keymap'.
113 The faces specifically mentioned in this list are put at the top of
114 the menu, in the order specified. All other faces which are defined
115 in `facemenu-listed-faces' are listed after them, but get no
116 keyboard equivalents.
118 If you change this variable after loading facemenu.el, you will need to call
119 `facemenu-update' to make it take effect."
120 :type '(repeat (cons face string))
121 :group 'facemenu)
123 (defcustom facemenu-new-faces-at-end t
124 "Where in the menu to insert newly-created faces.
125 This should be nil to put them at the top of the menu, or t to put them
126 just before \"Other\" at the end."
127 :type 'boolean
128 :group 'facemenu)
130 (defvar facemenu-unlisted-faces
131 `(modeline region secondary-selection highlight scratch-face
132 ,(purecopy "^font-lock-") ,(purecopy "^gnus-") ,(purecopy "^message-")
133 ,(purecopy "^ediff-") ,(purecopy "^term-") ,(purecopy "^vc-")
134 ,(purecopy "^widget-") ,(purecopy "^custom-") ,(purecopy "^vm-"))
135 "*List of faces that are of no interest to the user.")
136 (make-obsolete-variable 'facemenu-unlisted-faces 'facemenu-listed-faces
137 "22.1,\n and has no effect on the Face menu")
139 (defcustom facemenu-listed-faces nil
140 "List of faces to include in the Face menu.
141 Each element should be a symbol, the name of a face.
142 The \"basic \" faces in `facemenu-keybindings' are automatically
143 added to the Face menu, and need not be in this list.
145 This value takes effect when you load facemenu.el. If the
146 list includes symbols which are not defined as faces, they
147 are ignored; however, subsequently defining or creating
148 those faces adds them to the menu then. You can call
149 `facemenu-update' to recalculate the menu contents, such as
150 if you change the value of this variable,
152 If this variable is t, all faces that you apply to text
153 using the face menu commands (even by name), and all faces
154 that you define or create, are added to the menu. You may
155 find it useful to set this variable to t temporarily while
156 you define some faces, so that they will be added. However,
157 if the value is no longer t and you call `facemenu-update',
158 it will remove any faces not explicitly in the list."
159 :type '(choice (const :tag "List all faces" t)
160 (const :tag "None" nil)
161 (repeat symbol))
162 :group 'facemenu
163 :version "22.1")
165 (defvar facemenu-face-menu
166 (let ((map (make-sparse-keymap "Face")))
167 (define-key map "o" (cons (purecopy "Other...") 'facemenu-set-face))
168 map)
169 "Menu keymap for faces.")
170 (defalias 'facemenu-face-menu facemenu-face-menu)
171 (put 'facemenu-face-menu 'menu-enable '(facemenu-enable-faces-p))
173 (defvar facemenu-foreground-menu
174 (let ((map (make-sparse-keymap "Foreground Color")))
175 (define-key map "o" (cons (purecopy "Other...") 'facemenu-set-foreground))
176 map)
177 "Menu keymap for foreground colors.")
178 (defalias 'facemenu-foreground-menu facemenu-foreground-menu)
179 (put 'facemenu-foreground-menu 'menu-enable '(facemenu-enable-faces-p))
181 (defvar facemenu-background-menu
182 (let ((map (make-sparse-keymap "Background Color")))
183 (define-key map "o" (cons (purecopy "Other...") 'facemenu-set-background))
184 map)
185 "Menu keymap for background colors.")
186 (defalias 'facemenu-background-menu facemenu-background-menu)
187 (put 'facemenu-background-menu 'menu-enable '(facemenu-enable-faces-p))
189 ;;; Condition for enabling menu items that set faces.
190 (defun facemenu-enable-faces-p ()
191 ;; Enable the facemenu if facemenu-add-face-function is defined
192 ;; (e.g. in Tex-mode and SGML mode), or if font-lock is off.
193 (or (not (and font-lock-mode font-lock-defaults))
194 facemenu-add-face-function))
196 (defvar facemenu-special-menu
197 (let ((map (make-sparse-keymap "Special")))
198 (define-key map [?s] (cons (purecopy "Remove Special")
199 'facemenu-remove-special))
200 (define-key map [?t] (cons (purecopy "Intangible")
201 'facemenu-set-intangible))
202 (define-key map [?v] (cons (purecopy "Invisible")
203 'facemenu-set-invisible))
204 (define-key map [?r] (cons (purecopy "Read-Only")
205 'facemenu-set-read-only))
206 map)
207 "Menu keymap for non-face text-properties.")
208 (defalias 'facemenu-special-menu facemenu-special-menu)
210 (defvar facemenu-justification-menu
211 (let ((map (make-sparse-keymap "Justification")))
212 (define-key map [?c] (cons (purecopy "Center") 'set-justification-center))
213 (define-key map [?b] (cons (purecopy "Full") 'set-justification-full))
214 (define-key map [?r] (cons (purecopy "Right") 'set-justification-right))
215 (define-key map [?l] (cons (purecopy "Left") 'set-justification-left))
216 (define-key map [?u] (cons (purecopy "Unfilled") 'set-justification-none))
217 map)
218 "Submenu for text justification commands.")
219 (defalias 'facemenu-justification-menu facemenu-justification-menu)
221 (defvar facemenu-indentation-menu
222 (let ((map (make-sparse-keymap "Indentation")))
223 (define-key map [decrease-right-margin]
224 (cons (purecopy "Indent Right Less") 'decrease-right-margin))
225 (define-key map [increase-right-margin]
226 (cons (purecopy "Indent Right More") 'increase-right-margin))
227 (define-key map [decrease-left-margin]
228 (cons (purecopy "Indent Less") 'decrease-left-margin))
229 (define-key map [increase-left-margin]
230 (cons (purecopy "Indent More") 'increase-left-margin))
231 map)
232 "Submenu for indentation commands.")
233 (defalias 'facemenu-indentation-menu facemenu-indentation-menu)
235 ;; This is split up to avoid an overlong line in loaddefs.el.
236 (defvar facemenu-menu nil
237 "Facemenu top-level menu keymap.")
238 (setq facemenu-menu (make-sparse-keymap "Text Properties"))
239 (let ((map facemenu-menu))
240 (define-key map [dc] (cons (purecopy "Display Colors") 'list-colors-display))
241 (define-key map [df] (cons (purecopy "Display Faces") 'list-faces-display))
242 (define-key map [dp] (cons (purecopy "Describe Properties")
243 'describe-text-properties))
244 (define-key map [ra] (list 'menu-item (purecopy "Remove Text Properties")
245 'facemenu-remove-all
246 :enable 'mark-active))
247 (define-key map [rm] (list 'menu-item (purecopy "Remove Face Properties")
248 'facemenu-remove-face-props
249 :enable 'mark-active))
250 (define-key map [s1] (list (purecopy "--"))))
251 (let ((map facemenu-menu))
252 (define-key map [in] (cons (purecopy "Indentation")
253 'facemenu-indentation-menu))
254 (define-key map [ju] (cons (purecopy "Justification")
255 'facemenu-justification-menu))
256 (define-key map [s2] (list (purecopy "--")))
257 (define-key map [sp] (cons (purecopy "Special Properties")
258 'facemenu-special-menu))
259 (define-key map [bg] (cons (purecopy "Background Color")
260 'facemenu-background-menu))
261 (define-key map [fg] (cons (purecopy "Foreground Color")
262 'facemenu-foreground-menu))
263 (define-key map [fc] (cons (purecopy "Face")
264 'facemenu-face-menu)))
265 (defalias 'facemenu-menu facemenu-menu)
267 (defvar facemenu-keymap
268 (let ((map (make-sparse-keymap "Set face")))
269 (define-key map "o" (cons (purecopy "Other...") 'facemenu-set-face))
270 (define-key map "\M-o" 'font-lock-fontify-block)
271 map)
272 "Keymap for face-changing commands.
273 `Facemenu-update' fills in the keymap according to the bindings
274 requested in `facemenu-keybindings'.")
275 (defalias 'facemenu-keymap facemenu-keymap)
278 (defcustom facemenu-add-face-function nil
279 "Function called at beginning of text to change or nil.
280 This function is passed the FACE to set and END of text to change, and must
281 return a string which is inserted. It may set `facemenu-end-add-face'."
282 :type '(choice (const :tag "None" nil)
283 function)
284 :group 'facemenu)
286 (defcustom facemenu-end-add-face nil
287 "String to insert or function called at end of text to change or nil.
288 This function is passed the FACE to set, and must return a string which is
289 inserted."
290 :type '(choice (const :tag "None" nil)
291 string
292 function)
293 :group 'facemenu)
295 (defcustom facemenu-remove-face-function nil
296 "When non-nil, this is a function called to remove faces.
297 This function is passed the START and END of text to change.
298 May also be t meaning to use `facemenu-add-face-function'."
299 :type '(choice (const :tag "None" nil)
300 (const :tag "Use add-face" t)
301 function)
302 :group 'facemenu)
304 ;;; Internal Variables
306 (defvar facemenu-color-alist nil
307 "Alist of colors, used for completion.
308 If this is nil, then the value of (defined-colors) is used.")
310 (defun facemenu-update ()
311 "Add or update the \"Face\" menu in the menu bar.
312 You can call this to update things if you change any of the menu configuration
313 variables."
314 (interactive)
316 ;; Add each defined face to the menu.
317 (facemenu-iterate 'facemenu-add-new-face
318 (facemenu-complete-face-list facemenu-keybindings)))
320 (defun facemenu-set-face (face &optional start end)
321 "Apply FACE to the region or next character typed.
323 If the region is active (normally true except in Transient
324 Mark mode) and nonempty, and there is no prefix argument,
325 this command applies FACE to the region. Otherwise, it applies FACE
326 to the faces to use for the next character
327 inserted. (Moving point or switching buffers before typing
328 a character to insert cancels the specification.)
330 If FACE is `default', to \"apply\" it means clearing
331 the list of faces to be used. For any other value of FACE,
332 to \"apply\" it means putting FACE at the front of the list
333 of faces to be used, and removing any faces further
334 along in the list that would be completely overridden by
335 preceding faces (including FACE).
337 This command can also add FACE to the menu of faces,
338 if `facemenu-listed-faces' says to do that."
339 (interactive (list (progn
340 (barf-if-buffer-read-only)
341 (read-face-name "Use face"))
342 (if (and mark-active (not current-prefix-arg))
343 (region-beginning))
344 (if (and mark-active (not current-prefix-arg))
345 (region-end))))
346 (facemenu-add-new-face face)
347 (facemenu-add-face face start end))
349 (defun facemenu-set-foreground (color &optional start end)
350 "Set the foreground COLOR of the region or next character typed.
351 This command reads the color in the minibuffer.
353 If the region is active (normally true except in Transient Mark mode)
354 and there is no prefix argument, this command sets the region to the
355 requested face.
357 Otherwise, this command specifies the face for the next character
358 inserted. Moving point or switching buffers before
359 typing a character to insert cancels the specification."
360 (interactive (list (progn
361 (barf-if-buffer-read-only)
362 (read-color "Foreground color: "))
363 (if (and mark-active (not current-prefix-arg))
364 (region-beginning))
365 (if (and mark-active (not current-prefix-arg))
366 (region-end))))
367 (facemenu-set-face-from-menu
368 (facemenu-add-new-color color 'facemenu-foreground-menu)
369 start end))
371 (defun facemenu-set-background (color &optional start end)
372 "Set the background COLOR of the region or next character typed.
373 This command reads the color in the minibuffer.
375 If the region is active (normally true except in Transient Mark mode)
376 and there is no prefix argument, this command sets the region to the
377 requested face.
379 Otherwise, this command specifies the face for the next character
380 inserted. Moving point or switching buffers before
381 typing a character to insert cancels the specification."
382 (interactive (list (progn
383 (barf-if-buffer-read-only)
384 (read-color "Background color: "))
385 (if (and mark-active (not current-prefix-arg))
386 (region-beginning))
387 (if (and mark-active (not current-prefix-arg))
388 (region-end))))
389 (facemenu-set-face-from-menu
390 (facemenu-add-new-color color 'facemenu-background-menu)
391 start end))
393 (defun facemenu-set-face-from-menu (face start end)
394 "Set the FACE of the region or next character typed.
395 This function is designed to be called from a menu; FACE is determined
396 using the event type of the menu entry. If FACE is a symbol whose
397 name starts with \"fg:\" or \"bg:\", then this functions sets the
398 foreground or background to the color specified by the rest of the
399 symbol's name. Any other symbol is considered the name of a face.
401 If the region is active (normally true except in Transient Mark mode)
402 and there is no prefix argument, this command sets the region to the
403 requested face.
405 Otherwise, this command specifies the face for the next character
406 inserted. Moving point or switching buffers before typing a character
407 to insert cancels the specification."
408 (interactive (list last-command-event
409 (if (and mark-active (not current-prefix-arg))
410 (region-beginning))
411 (if (and mark-active (not current-prefix-arg))
412 (region-end))))
413 (barf-if-buffer-read-only)
414 (facemenu-add-face
415 (let ((fn (symbol-name face)))
416 (if (string-match "\\`\\([fb]\\)g:\\(.+\\)" fn)
417 (list (list (if (string= (match-string 1 fn) "f")
418 :foreground
419 :background)
420 (match-string 2 fn)))
421 face))
422 start end))
424 (defun facemenu-set-invisible (start end)
425 "Make the region invisible.
426 This sets the `invisible' text property; it can be undone with
427 `facemenu-remove-special'."
428 (interactive "r")
429 (add-text-properties start end '(invisible t)))
431 (defun facemenu-set-intangible (start end)
432 "Make the region intangible: disallow moving into it.
433 This sets the `intangible' text property; it can be undone with
434 `facemenu-remove-special'."
435 (interactive "r")
436 (add-text-properties start end '(intangible t)))
438 (defun facemenu-set-read-only (start end)
439 "Make the region unmodifiable.
440 This sets the `read-only' text property; it can be undone with
441 `facemenu-remove-special'."
442 (interactive "r")
443 (add-text-properties start end '(read-only t)))
445 (defun facemenu-remove-face-props (start end)
446 "Remove `face' and `mouse-face' text properties."
447 (interactive "*r") ; error if buffer is read-only despite the next line.
448 (let ((inhibit-read-only t))
449 (remove-text-properties
450 start end '(face nil mouse-face nil))))
452 (defun facemenu-remove-all (start end)
453 "Remove all text properties from the region."
454 (interactive "*r") ; error if buffer is read-only despite the next line.
455 (let ((inhibit-read-only t))
456 (set-text-properties start end nil)))
458 (defun facemenu-remove-special (start end)
459 "Remove all the \"special\" text properties from the region.
460 These special properties include `invisible', `intangible' and `read-only'."
461 (interactive "*r") ; error if buffer is read-only despite the next line.
462 (let ((inhibit-read-only t))
463 (remove-text-properties
464 start end '(invisible nil intangible nil read-only nil))))
466 (defalias 'facemenu-read-color 'read-color)
468 (defcustom list-colors-sort nil
469 "Color sort order for `list-colors-display'.
470 `nil' means default implementation-dependent order (defined in `x-colors').
471 `name' sorts by color name.
472 `rgb' sorts by red, green, blue components.
473 `(rgb-dist . COLOR)' sorts by the RGB distance to the specified color.
474 `hsv' sorts by hue, saturation, value.
475 `(hsv-dist . COLOR)' sorts by the HSV distance to the specified color
476 and excludes grayscale colors."
477 :type '(choice (const :tag "Unsorted" nil)
478 (const :tag "Color Name" name)
479 (const :tag "Red-Green-Blue" rgb)
480 (cons :tag "Distance on RGB cube"
481 (const :tag "Distance from Color" rgb-dist)
482 (color :tag "Source Color Name"))
483 (const :tag "Hue-Saturation-Value" hsv)
484 (cons :tag "Distance on HSV cylinder"
485 (const :tag "Distance from Color" hsv-dist)
486 (color :tag "Source Color Name")))
487 :group 'facemenu
488 :version "24.1")
490 (defun list-colors-sort-key (color)
491 "Return a list of keys for sorting colors depending on `list-colors-sort'.
492 COLOR is the name of the color. When return value is nil,
493 filter out the color from the output."
494 (require 'color)
495 (cond
496 ((null list-colors-sort) color)
497 ((eq list-colors-sort 'name)
498 (downcase color))
499 ((eq list-colors-sort 'rgb)
500 (color-values color))
501 ((eq (car-safe list-colors-sort) 'rgb-dist)
502 (color-distance color (cdr list-colors-sort)))
503 ((eq list-colors-sort 'hsv)
504 (apply 'color-rgb-to-hsv (color-name-to-rgb color)))
505 ((eq (car-safe list-colors-sort) 'hsv-dist)
506 (let* ((c-rgb (color-name-to-rgb color))
507 (c-hsv (apply 'color-rgb-to-hsv c-rgb))
508 (o-hsv (apply 'color-rgb-to-hsv
509 (color-name-to-rgb (cdr list-colors-sort)))))
510 (unless (and (eq (nth 0 c-rgb) (nth 1 c-rgb)) ; exclude grayscale
511 (eq (nth 1 c-rgb) (nth 2 c-rgb)))
512 ;; 3D Euclidean distance (sqrt is not needed for sorting)
513 (+ (expt (- 180 (abs (- 180 (abs (- (nth 0 c-hsv) ; wrap hue
514 (nth 0 o-hsv)))))) 2)
515 (expt (- (nth 1 c-hsv) (nth 1 o-hsv)) 2)
516 (expt (- (nth 2 c-hsv) (nth 2 o-hsv)) 2)))))))
518 (defun list-colors-display (&optional list buffer-name callback)
519 "Display names of defined colors, and show what they look like.
520 If the optional argument LIST is non-nil, it should be a list of
521 colors to display. Otherwise, this command computes a list of
522 colors that the current display can handle. Customize
523 `list-colors-sort' to change the order in which colors are shown.
525 If the optional argument BUFFER-NAME is nil, it defaults to *Colors*.
527 If the optional argument CALLBACK is non-nil, it should be a
528 function to call each time the user types RET or clicks on a
529 color. The function should accept a single argument, the color name."
530 (interactive)
531 (when (and (null list) (> (display-color-cells) 0))
532 (setq list (list-colors-duplicates (defined-colors)))
533 (when list-colors-sort
534 ;; Schwartzian transform with `(color key1 key2 key3 ...)'.
535 (setq list (mapcar
536 'car
537 (sort (delq nil (mapcar
538 (lambda (c)
539 (let ((key (list-colors-sort-key
540 (car c))))
541 (when key
542 (cons c (if (consp key) key
543 (list key))))))
544 list))
545 (lambda (a b)
546 (let* ((a-keys (cdr a))
547 (b-keys (cdr b))
548 (a-key (car a-keys))
549 (b-key (car b-keys)))
550 ;; Skip common keys at the beginning of key lists.
551 (while (and a-key b-key (equal a-key b-key))
552 (setq a-keys (cdr a-keys) a-key (car a-keys)
553 b-keys (cdr b-keys) b-key (car b-keys)))
554 (cond
555 ((and (numberp a-key) (numberp b-key))
556 (< a-key b-key))
557 ((and (stringp a-key) (stringp b-key))
558 (string< a-key b-key)))))))))
559 (when (memq (display-visual-class) '(gray-scale pseudo-color direct-color))
560 ;; Don't show more than what the display can handle.
561 (let ((lc (nthcdr (1- (display-color-cells)) list)))
562 (if lc
563 (setcdr lc nil)))))
564 (unless buffer-name
565 (setq buffer-name "*Colors*"))
566 (with-help-window buffer-name
567 (with-current-buffer standard-output
568 (erase-buffer)
569 (list-colors-print list callback)
570 (set-buffer-modified-p nil)
571 (setq truncate-lines t)))
572 (when callback
573 (pop-to-buffer buffer-name)
574 (message "Click on a color to select it.")))
576 (defun list-colors-print (list &optional callback)
577 (let ((callback-fn
578 (if callback
579 `(lambda (button)
580 (funcall ,callback (button-get button 'color-name))))))
581 (dolist (color list)
582 (if (consp color)
583 (if (cdr color)
584 (setq color (sort color (lambda (a b)
585 (string< (downcase a)
586 (downcase b))))))
587 (setq color (list color)))
588 (let* ((opoint (point))
589 (color-values (color-values (car color)))
590 (light-p (>= (apply 'max color-values)
591 (* (car (color-values "white")) .5))))
592 (insert (car color))
593 (indent-to 22)
594 (put-text-property opoint (point) 'face `(:background ,(car color)))
595 (put-text-property
596 (prog1 (point)
597 (insert " ")
598 ;; Insert all color names.
599 (insert (mapconcat 'identity color ",")))
600 (point)
601 'face (list :foreground (car color)))
602 (insert (propertize " " 'display '(space :align-to (- right 9))))
603 (insert " ")
604 (insert (propertize
605 (apply 'format "#%02x%02x%02x"
606 (mapcar (lambda (c) (lsh c -8))
607 color-values))
608 'mouse-face 'highlight
609 'help-echo
610 (let ((hsv (apply 'color-rgb-to-hsv
611 (color-name-to-rgb (car color)))))
612 (format "H:%d S:%d V:%d"
613 (nth 0 hsv) (nth 1 hsv) (nth 2 hsv)))))
614 (when callback
615 (make-text-button
616 opoint (point)
617 'follow-link t
618 'mouse-face (list :background (car color)
619 :foreground (if light-p "black" "white"))
620 'color-name (car color)
621 'action callback-fn)))
622 (insert "\n"))
623 (goto-char (point-min))))
626 (defun list-colors-duplicates (&optional list)
627 "Return a list of colors with grouped duplicate colors.
628 If a color has no duplicates, then the element of the returned list
629 has the form '(COLOR-NAME). The element of the returned list with
630 duplicate colors has the form '(COLOR-NAME DUPLICATE-COLOR-NAME ...).
631 This function uses the predicate `facemenu-color-equal' to compare
632 color names. If the optional argument LIST is non-nil, it should
633 be a list of colors to display. Otherwise, this function uses
634 a list of colors that the current display can handle."
635 (let* ((list (mapcar 'list (or list (defined-colors))))
636 (l list))
637 (while (cdr l)
638 (if (and (facemenu-color-equal (car (car l)) (car (car (cdr l))))
639 ;; On MS-Windows, there are logical colors that might have
640 ;; the same value but different names and meanings. For
641 ;; example, `SystemMenuText' (the color w32 uses for the
642 ;; text in menu entries) and `SystemWindowText' (the default
643 ;; color w32 uses for the text in windows and dialogs) may
644 ;; be the same display color and be adjacent in the list.
645 ;; These system colors all have names prefixed with "System",
646 ;; which is hardcoded in w32fns.c (SYSTEM_COLOR_PREFIX).
647 ;; This makes them different to any other color. Bug#9722
648 (not (and (eq system-type 'windows-nt)
649 (string-match-p "^System" (car (car l))))))
650 (progn
651 (setcdr (car l) (cons (car (car (cdr l))) (cdr (car l))))
652 (setcdr l (cdr (cdr l))))
653 (setq l (cdr l))))
654 list))
656 (defun facemenu-color-equal (a b)
657 "Return t if colors A and B are the same color.
658 A and B should be strings naming colors.
659 This function queries the display system to find out what the color
660 names mean. It returns nil if the colors differ or if it can't
661 determine the correct answer."
662 (cond ((equal a b) t)
663 ((equal (color-values a) (color-values b)))))
666 (defvar facemenu-self-insert-data nil)
668 (defun facemenu-post-self-insert-function ()
669 (when (and (car facemenu-self-insert-data)
670 (eq last-command (cdr facemenu-self-insert-data)))
671 (put-text-property (1- (point)) (point)
672 'face (car facemenu-self-insert-data))
673 (setq facemenu-self-insert-data nil))
674 (remove-hook 'post-self-insert-hook 'facemenu-post-self-insert-function))
676 (defun facemenu-set-self-insert-face (face)
677 "Arrange for the next self-inserted char to have face `face'."
678 (setq facemenu-self-insert-data (cons face this-command))
679 (add-hook 'post-self-insert-hook 'facemenu-post-self-insert-function))
681 (defun facemenu-add-face (face &optional start end)
682 "Add FACE to text between START and END.
683 If START is nil or START to END is empty, add FACE to next typed character
684 instead. For each section of that region that has a different face property,
685 FACE will be consed onto it, and other faces that are completely hidden by
686 that will be removed from the list.
687 If `facemenu-add-face-function' and maybe `facemenu-end-add-face' are non-nil,
688 they are used to set the face information.
690 As a special case, if FACE is `default', then the region is left with NO face
691 text property. Otherwise, selecting the default face would not have any
692 effect. See `facemenu-remove-face-function'."
693 (interactive "*xFace: \nr")
694 (cond
695 ((and (eq face 'default)
696 (not (eq facemenu-remove-face-function t)))
697 (if facemenu-remove-face-function
698 (funcall facemenu-remove-face-function start end)
699 (if (and start (< start end))
700 (remove-text-properties start end '(face default))
701 (facemenu-set-self-insert-face 'default))))
702 (facemenu-add-face-function
703 (save-excursion
704 (if end (goto-char end))
705 (save-excursion
706 (if start (goto-char start))
707 (insert-before-markers
708 (funcall facemenu-add-face-function face end)))
709 (if facemenu-end-add-face
710 (insert (if (stringp facemenu-end-add-face)
711 facemenu-end-add-face
712 (funcall facemenu-end-add-face face))))))
713 ((and start (< start end))
714 (let ((part-start start) part-end)
715 (while (not (= part-start end))
716 (setq part-end (next-single-property-change part-start 'face
717 nil end))
718 (let ((prev (get-text-property part-start 'face)))
719 (put-text-property part-start part-end 'face
720 (if (null prev)
721 face
722 (facemenu-active-faces
723 (cons face
724 (if (listp prev)
725 prev
726 (list prev)))
727 ;; Specify the selected frame
728 ;; because nil would mean to use
729 ;; the new-frame default settings,
730 ;; and those are usually nil.
731 (selected-frame)))))
732 (setq part-start part-end))))
734 (facemenu-set-self-insert-face
735 (if (eq last-command (cdr facemenu-self-insert-data))
736 (cons face (if (listp (car facemenu-self-insert-data))
737 (car facemenu-self-insert-data)
738 (list (car facemenu-self-insert-data))))
739 face))))
740 (unless (facemenu-enable-faces-p)
741 (message "Font-lock mode will override any faces you set in this buffer")))
743 (defun facemenu-active-faces (face-list &optional frame)
744 "Return from FACE-LIST those faces that would be used for display.
745 This means each face attribute is not specified in a face earlier in FACE-LIST
746 and such a face is therefore active when used to display text.
747 If the optional argument FRAME is given, use the faces in that frame; otherwise
748 use the selected frame. If t, then the global, non-frame faces are used."
749 (let* ((mask-atts (copy-sequence
750 (if (consp (car face-list))
751 (face-attributes-as-vector (car face-list))
752 (or (internal-lisp-face-p (car face-list) frame)
753 (check-face (car face-list))))))
754 (active-list (list (car face-list)))
755 (face-list (cdr face-list))
756 (mask-len (length mask-atts)))
757 (while face-list
758 (if (let ((face-atts
759 (if (consp (car face-list))
760 (face-attributes-as-vector (car face-list))
761 (or (internal-lisp-face-p (car face-list) frame)
762 (check-face (car face-list)))))
763 (i mask-len)
764 (useful nil))
765 (while (>= (setq i (1- i)) 0)
766 (and (not (memq (aref face-atts i) '(nil unspecified)))
767 (memq (aref mask-atts i) '(nil unspecified))
768 (aset mask-atts i (setq useful t))))
769 useful)
770 (setq active-list (cons (car face-list) active-list)))
771 (setq face-list (cdr face-list)))
772 (nreverse active-list)))
774 (defun facemenu-add-new-face (face)
775 "Add FACE (a face) to the Face menu if `facemenu-listed-faces' says so.
776 This is called whenever you create a new face, and at other times."
777 (let* (name
778 symbol
779 menu docstring
780 (key (cdr (assoc face facemenu-keybindings)))
781 function menu-val)
782 (if (symbolp face)
783 (setq name (symbol-name face)
784 symbol face)
785 (setq name face
786 symbol (intern name)))
787 (setq menu 'facemenu-face-menu)
788 (setq docstring
789 (purecopy (format "Select face `%s' for subsequent insertion.
790 If the mark is active and there is no prefix argument,
791 apply face `%s' to the region instead.
792 This command was defined by `facemenu-add-new-face'."
793 name name)))
794 (cond ((facemenu-iterate ; check if equivalent face is already in the menu
795 (lambda (m) (and (listp m)
796 (symbolp (car m))
797 ;; Avoid error in face-equal
798 ;; when a non-face is erroneously present.
799 (facep (car m))
800 (face-equal (car m) symbol)))
801 (cdr (symbol-function menu))))
802 ;; Faces with a keyboard equivalent. These go at the front.
803 (key
804 (setq function (intern (concat "facemenu-set-" name)))
805 (fset function
806 `(lambda ()
807 ,docstring
808 (interactive)
809 (facemenu-set-face
810 (quote ,symbol)
811 (if (and mark-active (not current-prefix-arg))
812 (region-beginning))
813 (if (and mark-active (not current-prefix-arg))
814 (region-end)))))
815 (define-key 'facemenu-keymap key (cons name function))
816 (define-key menu key (cons name function)))
817 ;; Faces with no keyboard equivalent. Figure out where to put it:
818 ((or (eq t facemenu-listed-faces)
819 (memq symbol facemenu-listed-faces))
820 (setq key (vector symbol)
821 function 'facemenu-set-face-from-menu
822 menu-val (symbol-function menu))
823 (if (and facemenu-new-faces-at-end
824 (> (length menu-val) 3))
825 (define-key-after menu-val key (cons name function)
826 (car (nth (- (length menu-val) 3) menu-val)))
827 (define-key menu key (cons name function))))))
828 nil) ; Return nil for facemenu-iterate
830 (defun facemenu-add-new-color (color menu)
831 "Add COLOR (a color name string) to the appropriate Face menu.
832 MENU should be `facemenu-foreground-menu' or `facemenu-background-menu'.
833 Return the event type (a symbol) of the added menu entry.
835 This is called whenever you use a new color."
836 (let (symbol)
837 (unless (color-defined-p color)
838 (error "Color `%s' undefined" color))
839 (cond ((eq menu 'facemenu-foreground-menu)
840 (setq symbol (intern (concat "fg:" color))))
841 ((eq menu 'facemenu-background-menu)
842 (setq symbol (intern (concat "bg:" color))))
843 (t (error "MENU should be `facemenu-foreground-menu' or `facemenu-background-menu'")))
844 (unless (facemenu-iterate ; Check if color is already in the menu.
845 (lambda (m) (and (listp m)
846 (eq (car m) symbol)))
847 (cdr (symbol-function menu)))
848 ;; Color is not in the menu. Figure out where to put it.
849 (let ((key (vector symbol))
850 (function 'facemenu-set-face-from-menu)
851 (menu-val (symbol-function menu)))
852 (if (and facemenu-new-faces-at-end
853 (> (length menu-val) 3))
854 (define-key-after menu-val key (cons color function)
855 (car (nth (- (length menu-val) 3) menu-val)))
856 (define-key menu key (cons color function)))))
857 symbol))
859 (defun facemenu-complete-face-list (&optional oldlist)
860 "Return list of all faces that look different.
861 Starts with given ALIST of faces, and adds elements only if they display
862 differently from any face already on the list.
863 The faces on ALIST will end up at the end of the returned list, in reverse
864 order."
865 (let ((list (nreverse (mapcar 'car oldlist))))
866 (facemenu-iterate
867 (lambda (new-face)
868 (if (not (memq new-face list))
869 (setq list (cons new-face list)))
870 nil)
871 (nreverse (face-list)))
872 list))
874 (defun facemenu-iterate (func list)
875 "Apply FUNC to each element of LIST until one returns non-nil.
876 Returns the non-nil value it found, or nil if all were nil."
877 (while (and list (not (funcall func (car list))))
878 (setq list (cdr list)))
879 (car list))
881 (facemenu-update)
883 (provide 'facemenu)
885 ;;; facemenu.el ends here