1 ;;; facemenu.el --- create a face menu for interactively adding fonts to text
2 ;; Copyright (c) 1994, 1995 Free Software Foundation, Inc.
4 ;; Author: Boris Goldowsky <boris@gnu.ai.mit.edu>
7 ;; This file is part of GNU Emacs.
9 ;; GNU Emacs is free software; you can redistribute it and/or modify
10 ;; it under the terms of the GNU General Public License as published by
11 ;; the Free Software Foundation; either version 2, or (at your option)
14 ;; GNU Emacs is distributed in the hope that it will be useful,
15 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
16 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 ;; GNU General Public License for more details.
19 ;; You should have received a copy of the GNU General Public License
20 ;; along with GNU Emacs; see the file COPYING. If not, write to
21 ;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
24 ;; This file defines a menu of faces (bold, italic, etc) which allows you to
25 ;; set the face used for a region of the buffer. Some faces also have
26 ;; keybindings, which are shown in the menu. Faces with names beginning with
27 ;; "fg:" or "bg:", as in "fg:red", are treated specially.
28 ;; Such faces are assumed to consist only of a foreground (if "fg:") or
29 ;; background (if "bg:") color. They are thus put into the color submenus
30 ;; rather than the general Face submenu. These faces can also be
31 ;; automatically created by selecting the "Other..." menu items in the
32 ;; "Foreground" and "Background" submenus.
34 ;; The menu also contains submenus for indentation and justification-changing
38 ;; Selecting a face from the menu or typing the keyboard equivalent will
39 ;; change the region to use that face. If you use transient-mark-mode and the
40 ;; region is not active, the face will be remembered and used for the next
41 ;; insertion. It will be forgotten if you move point or make other
42 ;; modifications before inserting or typing anything.
44 ;; Faces can be selected from the keyboard as well.
45 ;; The standard keybindings are M-g (or ESC g) + letter:
46 ;; M-g i = "set italic", M-g b = "set bold", etc.
49 ;; An alternative set of keybindings that may be easier to type can be set up
50 ;; using "Alt" or "Hyper" keys. This requires that you either have or create
51 ;; an Alt or Hyper key on your keyboard. On my keyboard, there is a key
52 ;; labeled "Alt", but to make it act as an Alt key I have to put this command
54 ;; xmodmap -e "add Mod3 = Alt_L"
55 ;; Or, I can make it into a Hyper key with this:
56 ;; xmodmap -e "keysym Alt_L = Hyper_L" -e "add Mod2 = Hyper_L"
57 ;; Check with local X-perts for how to do it on your system.
58 ;; Then you can define your keybindings with code like this in your .emacs:
59 ;; (setq facemenu-keybindings
60 ;; '((default . [?\H-d])
63 ;; (bold-italic . [?\H-l])
64 ;; (underline . [?\H-u])))
65 ;; (setq facemenu-keymap global-map)
66 ;; (setq facemenu-key nil)
67 ;; (define-key global-map [?\H-c] 'facemenu-set-foreground) ; set fg color
68 ;; (define-key global-map [?\H-C] 'facemenu-set-background) ; set bg color
69 ;; (require 'facemenu)
71 ;; The order of the faces that appear in the menu and their keybindings can be
72 ;; controlled by setting the variables `facemenu-keybindings' and
73 ;; `facemenu-new-faces-at-end'. List faces that you don't use in documents
74 ;; (eg, `region') in `facemenu-unlisted-faces'.
77 ;; Bold and Italic do not combine to create bold-italic if you select them
78 ;; both, although most other combinations (eg bold + underline + some color)
79 ;; do the intuitive thing.
81 ;; There is at present no way to display what the faces look like in
84 ;; `list-faces-display' shows the faces in a different order than
85 ;; this menu, which could be confusing. I do /not/ sort the list
86 ;; alphabetically, because I like the default order: it puts the most
87 ;; basic, common fonts first.
89 ;; Please send me any other problems, comments or ideas.
95 ;;; Provide some binding for startup:
96 ;;;###autoload (define-key global-map "\M-g" 'facemenu-keymap)
97 ;;;###autoload (autoload 'facemenu-keymap "facemenu" "Keymap for face-changing commands." t 'keymap)
99 (defvar facemenu-key "\M-g"
100 "Prefix key to use for facemenu commands.")
102 (defvar facemenu-keybindings
106 (bold-italic . "l") ; {bold} intersect {italic} = {l}
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 except for those in `facemenu-unlisted-faces', are listed after them,
116 but get no 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.")
121 (defvar facemenu-new-faces-at-end t
122 "Where in the menu to insert newly-created faces.
123 This should be nil to put them at the top of the menu, or t to put them
124 just before \"Other\" at the end.")
126 (defvar facemenu-unlisted-faces
127 '(modeline region secondary-selection highlight scratch-face)
128 "List of faces not to include in the Face menu.
129 You can set this list before loading facemenu.el, or add a face to it before
130 creating that face if you do not want it to be listed. If you change the
131 variable so as to eliminate faces that have already been added to the menu,
132 call `facemenu-update' to recalculate the menu contents.
134 If this variable is t, no faces will be added to the menu. This is useful for
135 temporarily turning off the feature that automatically adds faces to the menu
136 when they are created.")
139 (defvar facemenu-face-menu
140 (let ((map (make-sparse-keymap "Face")))
141 (define-key map "o" (cons "Other..." 'facemenu-set-face))
143 "Menu keymap for faces.")
145 (defalias 'facemenu-face-menu facemenu-face-menu)
148 (defvar facemenu-foreground-menu
149 (let ((map (make-sparse-keymap "Foreground Color")))
150 (define-key map "o" (cons "Other..." 'facemenu-set-foreground))
152 "Menu keymap for foreground colors.")
154 (defalias 'facemenu-foreground-menu facemenu-foreground-menu)
157 (defvar facemenu-background-menu
158 (let ((map (make-sparse-keymap "Background Color")))
159 (define-key map "o" (cons "Other..." 'facemenu-set-background))
161 "Menu keymap for background colors")
163 (defalias 'facemenu-background-menu facemenu-background-menu)
166 (defvar facemenu-special-menu
167 (let ((map (make-sparse-keymap "Special")))
168 (define-key map [?s] (cons "Remove Special" 'facemenu-remove-special))
169 (define-key map [?t] (cons "Intangible" 'facemenu-set-intangible))
170 (define-key map [?v] (cons "Invisible" 'facemenu-set-invisible))
171 (define-key map [?r] (cons "Read-Only" 'facemenu-set-read-only))
173 "Menu keymap for non-face text-properties.")
175 (defalias 'facemenu-special-menu facemenu-special-menu)
178 (defvar facemenu-justification-menu
179 (let ((map (make-sparse-keymap "Justification")))
180 (define-key map [?c] (cons "Center" 'set-justification-center))
181 (define-key map [?b] (cons "Full" 'set-justification-full))
182 (define-key map [?r] (cons "Right" 'set-justification-right))
183 (define-key map [?l] (cons "Left" 'set-justification-left))
184 (define-key map [?u] (cons "Unfilled" 'set-justification-none))
186 "Submenu for text justification commands.")
188 (defalias 'facemenu-justification-menu facemenu-justification-menu)
191 (defvar facemenu-indentation-menu
192 (let ((map (make-sparse-keymap "Indentation")))
193 (define-key map [decrease-right-margin]
194 (cons "Indent Right Less" 'decrease-right-margin))
195 (define-key map [increase-right-margin]
196 (cons "Indent Right More" 'increase-right-margin))
197 (define-key map [decrease-left-margin]
198 (cons "Indent Less" 'decrease-left-margin))
199 (define-key map [increase-left-margin]
200 (cons "Indent More" 'increase-left-margin))
202 "Submenu for indentation commands.")
204 (defalias 'facemenu-indentation-menu facemenu-indentation-menu)
206 ;; This is split up to avoid an overlong line in loaddefs.el.
208 (defvar facemenu-menu nil
209 "Facemenu top-level menu keymap.")
211 (setq facemenu-menu (make-sparse-keymap "Text Properties"))
213 (let ((map facemenu-menu))
214 (define-key map [dc] (cons "Display Colors" 'list-colors-display))
215 (define-key map [df] (cons "Display Faces" 'list-faces-display))
216 (define-key map [dp] (cons "List Properties" 'list-text-properties-at))
217 (define-key map [ra] (cons "Remove All" 'facemenu-remove-all))
218 (define-key map [rm] (cons "Remove Properties" 'facemenu-remove-props))
219 (define-key map [s1] (list "-----------------")))
221 (let ((map facemenu-menu))
222 (define-key map [in] (cons "Indentation" 'facemenu-indentation-menu))
223 (define-key map [ju] (cons "Justification" 'facemenu-justification-menu))
224 (define-key map [s2] (list "-----------------"))
225 (define-key map [sp] (cons "Special Properties" 'facemenu-special-menu))
226 (define-key map [bg] (cons "Background Color" 'facemenu-background-menu))
227 (define-key map [fg] (cons "Foreground Color" 'facemenu-foreground-menu))
228 (define-key map [fc] (cons "Face" 'facemenu-face-menu)))
230 (defalias 'facemenu-menu facemenu-menu)
232 (defvar facemenu-keymap
233 (let ((map (make-sparse-keymap "Set face")))
234 (define-key map "o" (cons "Other..." 'facemenu-set-face))
236 "Keymap for face-changing commands.
237 `Facemenu-update' fills in the keymap according to the bindings
238 requested in `facemenu-keybindings'.")
239 (defalias 'facemenu-keymap facemenu-keymap)
241 ;;; Internal Variables
243 (defvar facemenu-color-alist nil
244 ;; Don't initialize here; that doesn't work if preloaded.
245 "Alist of colors, used for completion.
246 If null, `facemenu-read-color' will set it.")
248 (defun facemenu-update ()
249 "Add or update the \"Face\" menu in the menu bar.
250 You can call this to update things if you change any of the menu configuration
255 (define-key global-map [C-down-mouse-2] 'facemenu-menu)
256 (if facemenu-key (define-key global-map facemenu-key 'facemenu-keymap))
258 ;; Add each defined face to the menu.
259 (facemenu-iterate 'facemenu-add-new-face
260 (facemenu-complete-face-list facemenu-keybindings)))
263 (defun facemenu-set-face (face &optional start end)
264 "Add FACE to the region or next character typed.
265 It will be added to the top of the face list; any faces lower on the list that
266 will not show through at all will be removed.
268 Interactively, the face to be used is read with the minibuffer.
270 If the region is active and there is no prefix argument,
271 this command sets the region to the requested face.
273 Otherwise, this command specifies the face for the next character
274 inserted. Moving point or switching buffers before
275 typing a character to insert cancels the specification."
276 (interactive (list (read-face-name "Use face: ")))
277 (barf-if-buffer-read-only)
278 (facemenu-add-new-face face)
279 (if (and mark-active (not current-prefix-arg))
280 (let ((start (or start (region-beginning)))
281 (end (or end (region-end))))
282 (facemenu-add-face face start end))
283 (facemenu-self-insert-face face)))
286 (defun facemenu-set-foreground (color &optional start end)
287 "Set the foreground color of the region or next character typed.
288 The color is prompted for. A face named `fg:color' is used \(or created).
289 If the region is active, it will be set to the requested face. If
290 it is inactive \(even if mark-even-if-inactive is set) the next
291 character that is typed \(via `self-insert-command') will be set to
292 the selected face. Moving point or switching buffers before
293 typing a character cancels the request."
294 (interactive (list (facemenu-read-color "Foreground color: ")))
295 (let ((face (intern (concat "fg:" color))))
296 (or (facemenu-get-face face)
297 (error "Unknown color: %s" color))
298 (facemenu-set-face face start end)))
301 (defun facemenu-set-background (color &optional start end)
302 "Set the background color of the region or next character typed.
303 The color is prompted for. A face named `bg:color' is used \(or created).
304 If the region is active, it will be set to the requested face. If
305 it is inactive \(even if mark-even-if-inactive is set) the next
306 character that is typed \(via `self-insert-command') will be set to
307 the selected face. Moving point or switching buffers before
308 typing a character cancels the request."
309 (interactive (list (facemenu-read-color "Background color: ")))
310 (let ((face (intern (concat "bg:" color))))
311 (or (facemenu-get-face face)
312 (error "Unknown color: %s" color))
313 (facemenu-set-face face start end)))
316 (defun facemenu-set-face-from-menu (face start end)
317 "Set the face of the region or next character typed.
318 This function is designed to be called from a menu; the face to use
319 is the menu item's name.
321 If the region is active and there is no prefix argument,
322 this command sets the region to the requested face.
324 Otherwise, this command specifies the face for the next character
325 inserted. Moving point or switching buffers before
326 typing a character to insert cancels the specification."
327 (interactive (list last-command-event
328 (if (and mark-active (not current-prefix-arg))
330 (if (and mark-active (not current-prefix-arg))
332 (barf-if-buffer-read-only)
333 (facemenu-get-face face)
335 (facemenu-add-face face start end)
336 (facemenu-self-insert-face face)))
338 (defun facemenu-self-insert-face (face)
339 (setq self-insert-face (if (eq last-command self-insert-face-command)
340 (cons face (if (listp self-insert-face)
342 (list self-insert-face)))
344 self-insert-face-command this-command))
347 (defun facemenu-set-invisible (start end)
348 "Make the region invisible.
349 This sets the `invisible' text property; it can be undone with
350 `facemenu-remove-special'."
352 (put-text-property start end 'invisible t))
355 (defun facemenu-set-intangible (start end)
356 "Make the region intangible: disallow moving into it.
357 This sets the `intangible' text property; it can be undone with
358 `facemenu-remove-special'."
360 (put-text-property start end 'intangible t))
363 (defun facemenu-set-read-only (start end)
364 "Make the region unmodifiable.
365 This sets the `read-only' text property; it can be undone with
366 `facemenu-remove-special'."
368 (put-text-property start end 'read-only t))
371 (defun facemenu-remove-props (start end)
372 "Remove all text properties that facemenu added to region."
373 (interactive "*r") ; error if buffer is read-only despite the next line.
374 (let ((inhibit-read-only t))
375 (remove-text-properties
376 start end '(face nil invisible nil intangible nil
377 read-only nil category nil))))
380 (defun facemenu-remove-all (start end)
381 "Remove all text properties from the region."
382 (interactive "*r") ; error if buffer is read-only despite the next line.
383 (let ((inhibit-read-only t))
384 (set-text-properties start end nil)))
387 (defun facemenu-remove-special (start end)
388 "Remove all the \"special\" text properties from the region.
389 These special properties include `invisible', `intangible' and `read-only'."
390 (interactive "*r") ; error if buffer is read-only despite the next line.
391 (let ((inhibit-read-only t))
392 (remove-text-properties
393 start end '(invisible nil intangible nil read-only nil))))
396 (defun list-text-properties-at (p)
397 "Pop up a buffer listing text-properties at LOCATION."
399 (let ((props (text-properties-at p)))
402 (with-output-to-temp-buffer "*Text Properties*"
403 (princ (format "Text properties at %d:\n\n" p))
405 (princ (format "%-20s %S\n"
406 (car props) (car (cdr props))))
407 (setq props (cdr (cdr props))))))))
410 (defun facemenu-read-color (&optional prompt)
411 "Read a color using the minibuffer."
412 (let ((col (completing-read (or prompt "Color: ")
413 (or facemenu-color-alist
414 (if (or (eq window-system 'x) (eq window-system 'win32))
415 (mapcar 'list (x-defined-colors))))
422 (defun list-colors-display (&optional list)
423 "Display names of defined colors, and show what they look like.
424 If the optional argument LIST is non-nil, it should be a list of
425 colors to display. Otherwise, this command computes a list
426 of colors that the current display can handle."
428 (if (and (null list) (or (eq window-system 'x) (eq window-system 'win32)))
430 (setq list (x-defined-colors))
431 ;; Delete duplicate colors.
434 (if (facemenu-color-equal (car l) (car (cdr l)))
435 (setcdr l (cdr (cdr l)))
436 (setq l (cdr l)))))))
437 (with-output-to-temp-buffer "*Colors*"
439 (set-buffer standard-output)
440 (let ((facemenu-unlisted-faces t)
446 (put-text-property s (point) 'face
448 (intern (concat "bg:" (car list)))))
450 (insert " " (car list) "\n")
451 (put-text-property s (point) 'face
453 (intern (concat "fg:" (car list)))))
454 (setq list (cdr list)))))))
456 (defun facemenu-color-equal (a b)
457 "Return t if colors A and B are the same color.
458 A and B should be strings naming colors.
459 This function queries the window-system server to find out what the
460 color names mean. It returns nil if the colors differ or if it can't
461 determine the correct answer."
462 (cond ((equal a b) t)
463 ((and (or (eq window-system 'x) (eq window-system 'win32))
464 (equal (x-color-values a) (x-color-values b))))))
466 (defun facemenu-add-face (face start end)
467 "Add FACE to text between START and END.
468 For each section of that region that has a different face property, FACE will
469 be consed onto it, and other faces that are completely hidden by that will be
470 removed from the list.
472 As a special case, if FACE is `default', then the region is left with NO face
473 text property. Otherwise, selecting the default face would not have any
475 (interactive "*xFace:\nr")
476 (if (eq face 'default)
477 (remove-text-properties start end '(face default))
478 (let ((part-start start) part-end)
479 (while (not (= part-start end))
480 (setq part-end (next-single-property-change part-start 'face nil end))
481 (let ((prev (get-text-property part-start 'face)))
482 (put-text-property part-start part-end 'face
485 (facemenu-active-faces
487 (if (listp prev) prev (list prev)))))))
488 (setq part-start part-end)))))
490 (defun facemenu-active-faces (face-list &optional frame)
491 "Return from FACE-LIST those faces that would be used for display.
492 This means each face attribute is not specified in a face earlier in FACE-LIST
493 and such a face is therefore active when used to display text.
494 If the optional argument FRAME is given, use the faces in that frame; otherwise
495 use the selected frame. If t, then the global, non-frame faces are used."
496 (let* ((mask-atts (copy-sequence (internal-get-face (car face-list) frame)))
497 (active-list (list (car face-list)))
498 (face-list (cdr face-list))
499 (mask-len (length mask-atts)))
501 (if (let ((face-atts (internal-get-face (car face-list) frame))
502 (i mask-len) (useful nil))
503 (while (> (setq i (1- i)) 1)
504 (and (aref face-atts i) (not (aref mask-atts i))
505 (aset mask-atts i (setq useful t))))
507 (setq active-list (cons (car face-list) active-list)))
508 (setq face-list (cdr face-list)))
509 (nreverse active-list)))
511 (defun facemenu-get-face (symbol)
512 "Make sure FACE exists.
513 If not, it is created. If it is created and is of the form `fg:color', then
514 set the foreground to that color. If of the form `bg:color', set the
515 background. In any case, add it to the appropriate menu. Returns the face,
516 or nil if given a bad color."
517 (if (or (internal-find-face symbol)
518 (let* ((face (make-face symbol))
519 (name (symbol-name symbol))
520 (color (substring name 3)))
521 (cond ((string-match "^fg:" name)
522 (set-face-foreground face color)
523 (and (or (eq window-system 'x) (eq window-system 'win32)) (x-color-defined-p color)))
524 ((string-match "^bg:" name)
525 (set-face-background face color)
526 (and (or (eq window-system 'x) (eq window-system 'win32)) (x-color-defined-p color)))
530 (defun facemenu-add-new-face (face)
531 "Add a FACE to the appropriate Face menu.
532 Automatically called when a new face is created."
533 (let* ((name (symbol-name face))
534 (menu (cond ((string-match "^fg:" name)
535 (setq name (substring name 3))
536 'facemenu-foreground-menu)
537 ((string-match "^bg:" name)
538 (setq name (substring name 3))
539 'facemenu-background-menu)
540 (t 'facemenu-face-menu)))
541 (key (cdr (assoc face facemenu-keybindings)))
543 (cond ((eq t facemenu-unlisted-faces))
544 ((memq face facemenu-unlisted-faces))
545 (key ; has a keyboard equivalent. These go at the front.
546 (setq function (intern (concat "facemenu-set-" name)))
548 (` (lambda () (interactive)
549 (facemenu-set-face (quote (, face))))))
550 (define-key 'facemenu-keymap key (cons name function))
551 (define-key menu key (cons name function)))
552 ((facemenu-iterate ; check if equivalent face is already in the menu
553 (lambda (m) (and (listp m)
555 (face-equal (car m) face)))
556 (cdr (symbol-function menu))))
557 (t ; No keyboard equivalent. Figure out where to put it:
558 (setq key (vector face)
559 function 'facemenu-set-face-from-menu
560 menu-val (symbol-function menu))
561 (if (and facemenu-new-faces-at-end
562 (> (length menu-val) 3))
563 (define-key-after menu-val key (cons name function)
564 (car (nth (- (length menu-val) 3) menu-val)))
565 (define-key menu key (cons name function))))))
566 nil) ; Return nil for facemenu-iterate
568 (defun facemenu-complete-face-list (&optional oldlist)
569 "Return list of all faces that are look different.
570 Starts with given ALIST of faces, and adds elements only if they display
571 differently from any face already on the list.
572 The faces on ALIST will end up at the end of the returned list, in reverse
574 (let ((list (nreverse (mapcar 'car oldlist))))
577 (if (not (memq new-face list))
578 (setq list (cons new-face list)))
580 (nreverse (face-list)))
583 (defun facemenu-iterate (func iterate-list)
584 "Apply FUNC to each element of LIST until one returns non-nil.
585 Returns the non-nil value it found, or nil if all were nil."
586 (while (and iterate-list (not (funcall func (car iterate-list))))
587 (setq iterate-list (cdr iterate-list)))
592 ;;; facemenu.el ends here