lisp/font-lock.el: Remove obsolete code.
[emacs.git] / lisp / facemenu.el
blobfffe09a84a5a6c1a701f206623545a62cf174808
1 ;;; facemenu.el --- create a face menu for interactively adding fonts to text
3 ;; Copyright (C) 1994-1996, 2001-2011 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] (cons (purecopy "Remove Text Properties")
245 'facemenu-remove-all))
246 (define-key map [rm] (cons (purecopy "Remove Face Properties")
247 'facemenu-remove-face-props))
248 (define-key map [s1] (list (purecopy "--"))))
249 (let ((map facemenu-menu))
250 (define-key map [in] (cons (purecopy "Indentation")
251 'facemenu-indentation-menu))
252 (define-key map [ju] (cons (purecopy "Justification")
253 'facemenu-justification-menu))
254 (define-key map [s2] (list (purecopy "--")))
255 (define-key map [sp] (cons (purecopy "Special Properties")
256 'facemenu-special-menu))
257 (define-key map [bg] (cons (purecopy "Background Color")
258 'facemenu-background-menu))
259 (define-key map [fg] (cons (purecopy "Foreground Color")
260 'facemenu-foreground-menu))
261 (define-key map [fc] (cons (purecopy "Face")
262 'facemenu-face-menu)))
263 (defalias 'facemenu-menu facemenu-menu)
265 (defvar facemenu-keymap
266 (let ((map (make-sparse-keymap "Set face")))
267 (define-key map "o" (cons (purecopy "Other...") 'facemenu-set-face))
268 (define-key map "\M-o" 'font-lock-fontify-block)
269 map)
270 "Keymap for face-changing commands.
271 `Facemenu-update' fills in the keymap according to the bindings
272 requested in `facemenu-keybindings'.")
273 (defalias 'facemenu-keymap facemenu-keymap)
276 (defcustom facemenu-add-face-function nil
277 "Function called at beginning of text to change or nil.
278 This function is passed the FACE to set and END of text to change, and must
279 return a string which is inserted. It may set `facemenu-end-add-face'."
280 :type '(choice (const :tag "None" nil)
281 function)
282 :group 'facemenu)
284 (defcustom facemenu-end-add-face nil
285 "String to insert or function called at end of text to change or nil.
286 This function is passed the FACE to set, and must return a string which is
287 inserted."
288 :type '(choice (const :tag "None" nil)
289 string
290 function)
291 :group 'facemenu)
293 (defcustom facemenu-remove-face-function nil
294 "When non-nil, this is a function called to remove faces.
295 This function is passed the START and END of text to change.
296 May also be t meaning to use `facemenu-add-face-function'."
297 :type '(choice (const :tag "None" nil)
298 (const :tag "Use add-face" t)
299 function)
300 :group 'facemenu)
302 ;;; Internal Variables
304 (defvar facemenu-color-alist nil
305 "Alist of colors, used for completion.
306 If this is nil, then the value of (defined-colors) is used.")
308 (defun facemenu-update ()
309 "Add or update the \"Face\" menu in the menu bar.
310 You can call this to update things if you change any of the menu configuration
311 variables."
312 (interactive)
314 ;; Add each defined face to the menu.
315 (facemenu-iterate 'facemenu-add-new-face
316 (facemenu-complete-face-list facemenu-keybindings)))
318 (defun facemenu-set-face (face &optional start end)
319 "Apply FACE to the region or next character typed.
321 If the region is active (normally true except in Transient
322 Mark mode) and nonempty, and there is no prefix argument,
323 this command applies FACE to the region. Otherwise, it applies FACE
324 to the faces to use for the next character
325 inserted. (Moving point or switching buffers before typing
326 a character to insert cancels the specification.)
328 If FACE is `default', to \"apply\" it means clearing
329 the list of faces to be used. For any other value of FACE,
330 to \"apply\" it means putting FACE at the front of the list
331 of faces to be used, and removing any faces further
332 along in the list that would be completely overridden by
333 preceding faces (including FACE).
335 This command can also add FACE to the menu of faces,
336 if `facemenu-listed-faces' says to do that."
337 (interactive (list (progn
338 (barf-if-buffer-read-only)
339 (read-face-name "Use face"))
340 (if (and mark-active (not current-prefix-arg))
341 (region-beginning))
342 (if (and mark-active (not current-prefix-arg))
343 (region-end))))
344 (facemenu-add-new-face face)
345 (facemenu-add-face face start end))
347 (defun facemenu-set-foreground (color &optional start end)
348 "Set the foreground COLOR of the region or next character typed.
349 This command reads the color in the minibuffer.
351 If the region is active (normally true except in Transient Mark mode)
352 and there is no prefix argument, this command sets the region to the
353 requested face.
355 Otherwise, this command specifies the face for the next character
356 inserted. Moving point or switching buffers before
357 typing a character to insert cancels the specification."
358 (interactive (list (progn
359 (barf-if-buffer-read-only)
360 (read-color "Foreground color: "))
361 (if (and mark-active (not current-prefix-arg))
362 (region-beginning))
363 (if (and mark-active (not current-prefix-arg))
364 (region-end))))
365 (facemenu-set-face-from-menu
366 (facemenu-add-new-color color 'facemenu-foreground-menu)
367 start end))
369 (defun facemenu-set-background (color &optional start end)
370 "Set the background COLOR of the region or next character typed.
371 This command reads the color in the minibuffer.
373 If the region is active (normally true except in Transient Mark mode)
374 and there is no prefix argument, this command sets the region to the
375 requested face.
377 Otherwise, this command specifies the face for the next character
378 inserted. Moving point or switching buffers before
379 typing a character to insert cancels the specification."
380 (interactive (list (progn
381 (barf-if-buffer-read-only)
382 (read-color "Background color: "))
383 (if (and mark-active (not current-prefix-arg))
384 (region-beginning))
385 (if (and mark-active (not current-prefix-arg))
386 (region-end))))
387 (facemenu-set-face-from-menu
388 (facemenu-add-new-color color 'facemenu-background-menu)
389 start end))
391 (defun facemenu-set-face-from-menu (face start end)
392 "Set the FACE of the region or next character typed.
393 This function is designed to be called from a menu; FACE is determined
394 using the event type of the menu entry. If FACE is a symbol whose
395 name starts with \"fg:\" or \"bg:\", then this functions sets the
396 foreground or background to the color specified by the rest of the
397 symbol's name. Any other symbol is considered the name of a face.
399 If the region is active (normally true except in Transient Mark mode)
400 and there is no prefix argument, this command sets the region to the
401 requested face.
403 Otherwise, this command specifies the face for the next character
404 inserted. Moving point or switching buffers before typing a character
405 to insert cancels the specification."
406 (interactive (list last-command-event
407 (if (and mark-active (not current-prefix-arg))
408 (region-beginning))
409 (if (and mark-active (not current-prefix-arg))
410 (region-end))))
411 (barf-if-buffer-read-only)
412 (facemenu-add-face
413 (let ((fn (symbol-name face)))
414 (if (string-match "\\`\\([fb]\\)g:\\(.+\\)" fn)
415 (list (list (if (string= (match-string 1 fn) "f")
416 :foreground
417 :background)
418 (match-string 2 fn)))
419 face))
420 start end))
422 (defun facemenu-set-invisible (start end)
423 "Make the region invisible.
424 This sets the `invisible' text property; it can be undone with
425 `facemenu-remove-special'."
426 (interactive "r")
427 (add-text-properties start end '(invisible t)))
429 (defun facemenu-set-intangible (start end)
430 "Make the region intangible: disallow moving into it.
431 This sets the `intangible' text property; it can be undone with
432 `facemenu-remove-special'."
433 (interactive "r")
434 (add-text-properties start end '(intangible t)))
436 (defun facemenu-set-read-only (start end)
437 "Make the region unmodifiable.
438 This sets the `read-only' text property; it can be undone with
439 `facemenu-remove-special'."
440 (interactive "r")
441 (add-text-properties start end '(read-only t)))
443 (defun facemenu-remove-face-props (start end)
444 "Remove `face' and `mouse-face' text properties."
445 (interactive "*r") ; error if buffer is read-only despite the next line.
446 (let ((inhibit-read-only t))
447 (remove-text-properties
448 start end '(face nil mouse-face nil))))
450 (defun facemenu-remove-all (start end)
451 "Remove all text properties from the region."
452 (interactive "*r") ; error if buffer is read-only despite the next line.
453 (let ((inhibit-read-only t))
454 (set-text-properties start end nil)))
456 (defun facemenu-remove-special (start end)
457 "Remove all the \"special\" text properties from the region.
458 These special properties include `invisible', `intangible' and `read-only'."
459 (interactive "*r") ; error if buffer is read-only despite the next line.
460 (let ((inhibit-read-only t))
461 (remove-text-properties
462 start end '(invisible nil intangible nil read-only nil))))
464 (defalias 'facemenu-read-color 'read-color)
466 (defcustom list-colors-sort nil
467 "Color sort order for `list-colors-display'.
468 `nil' means default implementation-dependent order (defined in `x-colors').
469 `name' sorts by color name.
470 `rgb' sorts by red, green, blue components.
471 `(rgb-dist . COLOR)' sorts by the RGB distance to the specified color.
472 `hsv' sorts by hue, saturation, value.
473 `(hsv-dist . COLOR)' sorts by the HSV distance to the specified color
474 and excludes grayscale colors."
475 :type '(choice (const :tag "Unsorted" nil)
476 (const :tag "Color Name" name)
477 (const :tag "Red-Green-Blue" rgb)
478 (cons :tag "Distance on RGB cube"
479 (const :tag "Distance from Color" rgb-dist)
480 (color :tag "Source Color Name"))
481 (const :tag "Hue-Saturation-Value" hsv)
482 (cons :tag "Distance on HSV cylinder"
483 (const :tag "Distance from Color" hsv-dist)
484 (color :tag "Source Color Name")))
485 :group 'facemenu
486 :version "24.1")
488 (defun list-colors-sort-key (color)
489 "Return a list of keys for sorting colors depending on `list-colors-sort'.
490 COLOR is the name of the color. When return value is nil,
491 filter out the color from the output."
492 (require 'color)
493 (cond
494 ((null list-colors-sort) color)
495 ((eq list-colors-sort 'name)
496 (downcase color))
497 ((eq list-colors-sort 'rgb)
498 (color-values color))
499 ((eq (car-safe list-colors-sort) 'rgb-dist)
500 (color-distance color (cdr list-colors-sort)))
501 ((eq list-colors-sort 'hsv)
502 (apply 'color-rgb-to-hsv (color-name-to-rgb color)))
503 ((eq (car-safe list-colors-sort) 'hsv-dist)
504 (let* ((c-rgb (color-name-to-rgb color))
505 (c-hsv (apply 'color-rgb-to-hsv c-rgb))
506 (o-hsv (apply 'color-rgb-to-hsv
507 (color-name-to-rgb (cdr list-colors-sort)))))
508 (unless (and (eq (nth 0 c-rgb) (nth 1 c-rgb)) ; exclude grayscale
509 (eq (nth 1 c-rgb) (nth 2 c-rgb)))
510 ;; 3D Euclidean distance (sqrt is not needed for sorting)
511 (+ (expt (- 180 (abs (- 180 (abs (- (nth 0 c-hsv) ; wrap hue
512 (nth 0 o-hsv)))))) 2)
513 (expt (- (nth 1 c-hsv) (nth 1 o-hsv)) 2)
514 (expt (- (nth 2 c-hsv) (nth 2 o-hsv)) 2)))))))
516 (defun list-colors-display (&optional list buffer-name callback)
517 "Display names of defined colors, and show what they look like.
518 If the optional argument LIST is non-nil, it should be a list of
519 colors to display. Otherwise, this command computes a list of
520 colors that the current display can handle.
522 If the optional argument BUFFER-NAME is nil, it defaults to
523 *Colors*.
525 If the optional argument CALLBACK is non-nil, it should be a
526 function to call each time the user types RET or clicks on a
527 color. The function should accept a single argument, the color
528 name.
530 You can change the color sort order by customizing `list-colors-sort'."
531 (interactive)
532 (when (and (null list) (> (display-color-cells) 0))
533 (setq list (list-colors-duplicates (defined-colors)))
534 (when list-colors-sort
535 ;; Schwartzian transform with `(color key1 key2 key3 ...)'.
536 (setq list (mapcar
537 'car
538 (sort (delq nil (mapcar
539 (lambda (c)
540 (let ((key (list-colors-sort-key
541 (car c))))
542 (when key
543 (cons c (if (consp key) key
544 (list key))))))
545 list))
546 (lambda (a b)
547 (let* ((a-keys (cdr a))
548 (b-keys (cdr b))
549 (a-key (car a-keys))
550 (b-key (car b-keys)))
551 ;; Skip common keys at the beginning of key lists.
552 (while (and a-key b-key (equal a-key b-key))
553 (setq a-keys (cdr a-keys) a-key (car a-keys)
554 b-keys (cdr b-keys) b-key (car b-keys)))
555 (cond
556 ((and (numberp a-key) (numberp b-key))
557 (< a-key b-key))
558 ((and (stringp a-key) (stringp b-key))
559 (string< a-key b-key)))))))))
560 (when (memq (display-visual-class) '(gray-scale pseudo-color direct-color))
561 ;; Don't show more than what the display can handle.
562 (let ((lc (nthcdr (1- (display-color-cells)) list)))
563 (if lc
564 (setcdr lc nil)))))
565 (unless buffer-name
566 (setq buffer-name "*Colors*"))
567 (with-help-window buffer-name
568 (with-current-buffer standard-output
569 (erase-buffer)
570 (list-colors-print list callback)
571 (set-buffer-modified-p nil)
572 (setq truncate-lines t)))
573 (when callback
574 (pop-to-buffer buffer-name)
575 (message "Click on a color to select it.")))
577 (defun list-colors-print (list &optional callback)
578 (let ((callback-fn
579 (if callback
580 `(lambda (button)
581 (funcall ,callback (button-get button 'color-name))))))
582 (dolist (color list)
583 (if (consp color)
584 (if (cdr color)
585 (setq color (sort color (lambda (a b)
586 (string< (downcase a)
587 (downcase b))))))
588 (setq color (list color)))
589 (let* ((opoint (point))
590 (color-values (color-values (car color)))
591 (light-p (>= (apply 'max color-values)
592 (* (car (color-values "white")) .5))))
593 (insert (car color))
594 (indent-to 22)
595 (put-text-property opoint (point) 'face `(:background ,(car color)))
596 (put-text-property
597 (prog1 (point)
598 (insert " ")
599 ;; Insert all color names.
600 (insert (mapconcat 'identity color ",")))
601 (point)
602 'face (list :foreground (car color)))
603 (insert (propertize " " 'display '(space :align-to (- right 9))))
604 (insert " ")
605 (insert (propertize
606 (apply 'format "#%02x%02x%02x"
607 (mapcar (lambda (c) (lsh c -8))
608 color-values))
609 'mouse-face 'highlight
610 'help-echo
611 (let ((hsv (apply 'color-rgb-to-hsv
612 (color-name-to-rgb (car color)))))
613 (format "H:%d S:%d V:%d"
614 (nth 0 hsv) (nth 1 hsv) (nth 2 hsv)))))
615 (when callback
616 (make-text-button
617 opoint (point)
618 'follow-link t
619 'mouse-face (list :background (car color)
620 :foreground (if light-p "black" "white"))
621 'color-name (car color)
622 'action callback-fn)))
623 (insert "\n"))
624 (goto-char (point-min))))
627 (defun list-colors-duplicates (&optional list)
628 "Return a list of colors with grouped duplicate colors.
629 If a color has no duplicates, then the element of the returned list
630 has the form '(COLOR-NAME). The element of the returned list with
631 duplicate colors has the form '(COLOR-NAME DUPLICATE-COLOR-NAME ...).
632 This function uses the predicate `facemenu-color-equal' to compare
633 color names. If the optional argument LIST is non-nil, it should
634 be a list of colors to display. Otherwise, this function uses
635 a list of colors that the current display can handle."
636 (let* ((list (mapcar 'list (or list (defined-colors))))
637 (l list))
638 (while (cdr l)
639 (if (and (facemenu-color-equal (car (car l)) (car (car (cdr l))))
640 (not (if (fboundp 'w32-default-color-map)
641 (not (assoc (car (car l)) (w32-default-color-map))))))
642 (progn
643 (setcdr (car l) (cons (car (car (cdr l))) (cdr (car l))))
644 (setcdr l (cdr (cdr l))))
645 (setq l (cdr l))))
646 list))
648 (defun facemenu-color-equal (a b)
649 "Return t if colors A and B are the same color.
650 A and B should be strings naming colors.
651 This function queries the display system to find out what the color
652 names mean. It returns nil if the colors differ or if it can't
653 determine the correct answer."
654 (cond ((equal a b) t)
655 ((equal (color-values a) (color-values b)))))
658 (defvar facemenu-self-insert-data nil)
660 (defun facemenu-post-self-insert-function ()
661 (when (and (car facemenu-self-insert-data)
662 (eq last-command (cdr facemenu-self-insert-data)))
663 (put-text-property (1- (point)) (point)
664 'face (car facemenu-self-insert-data))
665 (setq facemenu-self-insert-data nil))
666 (remove-hook 'post-self-insert-hook 'facemenu-post-self-insert-function))
668 (defun facemenu-set-self-insert-face (face)
669 "Arrange for the next self-inserted char to have face `face'."
670 (setq facemenu-self-insert-data (cons face this-command))
671 (add-hook 'post-self-insert-hook 'facemenu-post-self-insert-function))
673 (defun facemenu-add-face (face &optional start end)
674 "Add FACE to text between START and END.
675 If START is nil or START to END is empty, add FACE to next typed character
676 instead. For each section of that region that has a different face property,
677 FACE will be consed onto it, and other faces that are completely hidden by
678 that will be removed from the list.
679 If `facemenu-add-face-function' and maybe `facemenu-end-add-face' are non-nil,
680 they are used to set the face information.
682 As a special case, if FACE is `default', then the region is left with NO face
683 text property. Otherwise, selecting the default face would not have any
684 effect. See `facemenu-remove-face-function'."
685 (interactive "*xFace: \nr")
686 (cond
687 ((and (eq face 'default)
688 (not (eq facemenu-remove-face-function t)))
689 (if facemenu-remove-face-function
690 (funcall facemenu-remove-face-function start end)
691 (if (and start (< start end))
692 (remove-text-properties start end '(face default))
693 (facemenu-set-self-insert-face 'default))))
694 (facemenu-add-face-function
695 (save-excursion
696 (if end (goto-char end))
697 (save-excursion
698 (if start (goto-char start))
699 (insert-before-markers
700 (funcall facemenu-add-face-function face end)))
701 (if facemenu-end-add-face
702 (insert (if (stringp facemenu-end-add-face)
703 facemenu-end-add-face
704 (funcall facemenu-end-add-face face))))))
705 ((and start (< start end))
706 (let ((part-start start) part-end)
707 (while (not (= part-start end))
708 (setq part-end (next-single-property-change part-start 'face
709 nil end))
710 (let ((prev (get-text-property part-start 'face)))
711 (put-text-property part-start part-end 'face
712 (if (null prev)
713 face
714 (facemenu-active-faces
715 (cons face
716 (if (listp prev)
717 prev
718 (list prev)))
719 ;; Specify the selected frame
720 ;; because nil would mean to use
721 ;; the new-frame default settings,
722 ;; and those are usually nil.
723 (selected-frame)))))
724 (setq part-start part-end))))
726 (facemenu-set-self-insert-face
727 (if (eq last-command (cdr facemenu-self-insert-data))
728 (cons face (if (listp (car facemenu-self-insert-data))
729 (car facemenu-self-insert-data)
730 (list (car facemenu-self-insert-data))))
731 face))))
732 (unless (facemenu-enable-faces-p)
733 (message "Font-lock mode will override any faces you set in this buffer")))
735 (defun facemenu-active-faces (face-list &optional frame)
736 "Return from FACE-LIST those faces that would be used for display.
737 This means each face attribute is not specified in a face earlier in FACE-LIST
738 and such a face is therefore active when used to display text.
739 If the optional argument FRAME is given, use the faces in that frame; otherwise
740 use the selected frame. If t, then the global, non-frame faces are used."
741 (let* ((mask-atts (copy-sequence
742 (if (consp (car face-list))
743 (face-attributes-as-vector (car face-list))
744 (or (internal-lisp-face-p (car face-list) frame)
745 (check-face (car face-list))))))
746 (active-list (list (car face-list)))
747 (face-list (cdr face-list))
748 (mask-len (length mask-atts)))
749 (while face-list
750 (if (let ((face-atts
751 (if (consp (car face-list))
752 (face-attributes-as-vector (car face-list))
753 (or (internal-lisp-face-p (car face-list) frame)
754 (check-face (car face-list)))))
755 (i mask-len)
756 (useful nil))
757 (while (>= (setq i (1- i)) 0)
758 (and (not (memq (aref face-atts i) '(nil unspecified)))
759 (memq (aref mask-atts i) '(nil unspecified))
760 (aset mask-atts i (setq useful t))))
761 useful)
762 (setq active-list (cons (car face-list) active-list)))
763 (setq face-list (cdr face-list)))
764 (nreverse active-list)))
766 (defun facemenu-add-new-face (face)
767 "Add FACE (a face) to the Face menu if `facemenu-listed-faces' says so.
768 This is called whenever you create a new face, and at other times."
769 (let* (name
770 symbol
771 menu docstring
772 (key (cdr (assoc face facemenu-keybindings)))
773 function menu-val)
774 (if (symbolp face)
775 (setq name (symbol-name face)
776 symbol face)
777 (setq name face
778 symbol (intern name)))
779 (setq menu 'facemenu-face-menu)
780 (setq docstring
781 (purecopy (format "Select face `%s' for subsequent insertion.
782 If the mark is active and there is no prefix argument,
783 apply face `%s' to the region instead.
784 This command was defined by `facemenu-add-new-face'."
785 name name)))
786 (cond ((facemenu-iterate ; check if equivalent face is already in the menu
787 (lambda (m) (and (listp m)
788 (symbolp (car m))
789 ;; Avoid error in face-equal
790 ;; when a non-face is erroneously present.
791 (facep (car m))
792 (face-equal (car m) symbol)))
793 (cdr (symbol-function menu))))
794 ;; Faces with a keyboard equivalent. These go at the front.
795 (key
796 (setq function (intern (concat "facemenu-set-" name)))
797 (fset function
798 `(lambda ()
799 ,docstring
800 (interactive)
801 (facemenu-set-face
802 (quote ,symbol)
803 (if (and mark-active (not current-prefix-arg))
804 (region-beginning))
805 (if (and mark-active (not current-prefix-arg))
806 (region-end)))))
807 (define-key 'facemenu-keymap key (cons name function))
808 (define-key menu key (cons name function)))
809 ;; Faces with no keyboard equivalent. Figure out where to put it:
810 ((or (eq t facemenu-listed-faces)
811 (memq symbol facemenu-listed-faces))
812 (setq key (vector symbol)
813 function 'facemenu-set-face-from-menu
814 menu-val (symbol-function menu))
815 (if (and facemenu-new-faces-at-end
816 (> (length menu-val) 3))
817 (define-key-after menu-val key (cons name function)
818 (car (nth (- (length menu-val) 3) menu-val)))
819 (define-key menu key (cons name function))))))
820 nil) ; Return nil for facemenu-iterate
822 (defun facemenu-add-new-color (color menu)
823 "Add COLOR (a color name string) to the appropriate Face menu.
824 MENU should be `facemenu-foreground-menu' or `facemenu-background-menu'.
825 Return the event type (a symbol) of the added menu entry.
827 This is called whenever you use a new color."
828 (let (symbol docstring)
829 (unless (color-defined-p color)
830 (error "Color `%s' undefined" color))
831 (cond ((eq menu 'facemenu-foreground-menu)
832 (setq docstring
833 (format "Select foreground color %s for subsequent insertion."
834 color)
835 symbol (intern (concat "fg:" color))))
836 ((eq menu 'facemenu-background-menu)
837 (setq docstring
838 (format "Select background color %s for subsequent insertion."
839 color)
840 symbol (intern (concat "bg:" color))))
841 (t (error "MENU should be `facemenu-foreground-menu' or `facemenu-background-menu'")))
842 (unless (facemenu-iterate ; Check if color is already in the menu.
843 (lambda (m) (and (listp m)
844 (eq (car m) symbol)))
845 (cdr (symbol-function menu)))
846 ;; Color is not in the menu. Figure out where to put it.
847 (let ((key (vector symbol))
848 (function 'facemenu-set-face-from-menu)
849 (menu-val (symbol-function menu)))
850 (if (and facemenu-new-faces-at-end
851 (> (length menu-val) 3))
852 (define-key-after menu-val key (cons color function)
853 (car (nth (- (length menu-val) 3) menu-val)))
854 (define-key menu key (cons color function)))))
855 symbol))
857 (defun facemenu-complete-face-list (&optional oldlist)
858 "Return list of all faces that look different.
859 Starts with given ALIST of faces, and adds elements only if they display
860 differently from any face already on the list.
861 The faces on ALIST will end up at the end of the returned list, in reverse
862 order."
863 (let ((list (nreverse (mapcar 'car oldlist))))
864 (facemenu-iterate
865 (lambda (new-face)
866 (if (not (memq new-face list))
867 (setq list (cons new-face list)))
868 nil)
869 (nreverse (face-list)))
870 list))
872 (defun facemenu-iterate (func list)
873 "Apply FUNC to each element of LIST until one returns non-nil.
874 Returns the non-nil value it found, or nil if all were nil."
875 (while (and list (not (funcall func (car list))))
876 (setq list (cdr list)))
877 (car list))
879 (facemenu-update)
881 (provide 'facemenu)
883 ;;; facemenu.el ends here