;;; facemenu.el --- create a face menu for interactively adding fonts to text;; Copyright (c) 1994, 1995, 1996 Free Software Foundation, Inc.;; Author: Boris Goldowsky <boris@gnu.ai.mit.edu>;; Keywords: faces;; This file is part of GNU Emacs.;; GNU Emacs is free software; you can redistribute it and/or modify;; it under the terms of the GNU General Public License as published by;; the Free Software Foundation; either version 2, or (at your option);; any later version.;; GNU Emacs is distributed in the hope that it will be useful,;; but WITHOUT ANY WARRANTY; without even the implied warranty of;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the;; GNU General Public License for more details.;; You should have received a copy of the GNU General Public License;; along with GNU Emacs; see the file COPYING. If not, write to the;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,;; Boston, MA 02111-1307, USA.;;; Commentary:;; This file defines a menu of faces (bold, italic, etc) which allows you to;; set the face used for a region of the buffer. Some faces also have;; keybindings, which are shown in the menu. Faces with names beginning with;; "fg:" or "bg:", as in "fg:red", are treated specially.;; Such faces are assumed to consist only of a foreground (if "fg:") or;; background (if "bg:") color. They are thus put into the color submenus;; rather than the general Face submenu. These faces can also be;; automatically created by selecting the "Other..." menu items in the;; "Foreground" and "Background" submenus.;;;; The menu also contains submenus for indentation and justification-changing;; commands.;;; Usage:;; Selecting a face from the menu or typing the keyboard equivalent will;; change the region to use that face. If you use transient-mark-mode and the;; region is not active, the face will be remembered and used for the next;; insertion. It will be forgotten if you move point or make other;; modifications before inserting or typing anything.;;;; Faces can be selected from the keyboard as well. ;; The standard keybindings are M-g (or ESC g) + letter:;; M-g i = "set italic", M-g b = "set bold", etc.;;; Customization:;; An alternative set of keybindings that may be easier to type can be set up;; using "Alt" or "Hyper" keys. This requires that you either have or create;; an Alt or Hyper key on your keyboard. On my keyboard, there is a key;; labeled "Alt", but to make it act as an Alt key I have to put this command;; into my .xinitrc:;; xmodmap -e "add Mod3 = Alt_L";; Or, I can make it into a Hyper key with this:;; xmodmap -e "keysym Alt_L = Hyper_L" -e "add Mod2 = Hyper_L";; Check with local X-perts for how to do it on your system.;; Then you can define your keybindings with code like this in your .emacs:;; (setq facemenu-keybindings;; '((default . [?\H-d]);; (bold . [?\H-b]);; (italic . [?\H-i]);; (bold-italic . [?\H-l]);; (underline . [?\H-u])));; (facemenu-update);; (setq facemenu-keymap global-map);; (define-key global-map [?\H-c] 'facemenu-set-foreground) ; set fg color;; (define-key global-map [?\H-C] 'facemenu-set-background) ; set bg color;;;; The order of the faces that appear in the menu and their keybindings can be;; controlled by setting the variables `facemenu-keybindings' and;; `facemenu-new-faces-at-end'. List faces that you don't use in documents;; (eg, `region') in `facemenu-unlisted-faces'.;;; Known Problems:;; Bold and Italic do not combine to create bold-italic if you select them;; both, although most other combinations (eg bold + underline + some color);; do the intuitive thing.;;;; There is at present no way to display what the faces look like in;; the menu itself.;;;; `list-faces-display' shows the faces in a different order than;; this menu, which could be confusing. I do /not/ sort the list;; alphabetically, because I like the default order: it puts the most;; basic, common fonts first.;;;; Please send me any other problems, comments or ideas.;;; Code:(provide'facemenu);;; Provide some binding for startup:;;;###autoload (define-key global-map "\M-g" 'facemenu-keymap);;;###autoload (autoload 'facemenu-keymap "facemenu" "Keymap for face-changing commands." t 'keymap);; Global bindings:(define-keyglobal-map[C-down-mouse-2]'facemenu-menu)(define-keyglobal-map"\M-g"'facemenu-keymap)(defgroupfacemenunil"Create a face menu for interactively adding fonts to text":group'faces:prefix"facemenu-")(defcustomfacemenu-keybindings'((default."d")(bold."b")(italic."i")(bold-italic."l"); {bold} intersect {italic} = {l}(underline."u"))"Alist of interesting faces and keybindings. Each element is itself a list: the car is the name of the face,the next element is the key to use as a keyboard equivalent of the menu item;the binding is made in `facemenu-keymap'.The faces specifically mentioned in this list are put at the top ofthe menu, in the order specified. All other faces which are defined,except for those in `facemenu-unlisted-faces', are listed after them, but get no keyboard equivalents.If you change this variable after loading facemenu.el, you will need to call`facemenu-update' to make it take effect.":type'(repeat(consfacestring)):group'facemenu)(defcustomfacemenu-new-faces-at-endt"*Where in the menu to insert newly-created faces.This should be nil to put them at the top of the menu, or t to put themjust before \"Other\" at the end.":type'boolean:group'facemenu)(defcustomfacemenu-unlisted-faces'(modelineregionsecondary-selectionhighlightscratch-face"^font-lock-""^gnus-""^message-""^ediff-""^term-""^vc-""^widget-""^custom-""^vm-")"*List of faces not to include in the Face menu.Each element may be either a symbol, which is the name of a face, or a string,which is a regular expression to be matched against face names. Matchingfaces will not be added to the menu.You can set this list before loading facemenu.el, or add a face to it beforecreating that face if you do not want it to be listed. If you change thevariable so as to eliminate faces that have already been added to the menu,call `facemenu-update' to recalculate the menu contents.If this variable is t, no faces will be added to the menu. This is useful fortemporarily turning off the feature that automatically adds faces to the menuwhen they are created.":type'(choice(const:tag"Don't add"t)(const:tag"None"nil)(repeat(choicesymbolregexp))):group'facemenu);;;###autoload(defvarfacemenu-face-menu(let((map(make-sparse-keymap"Face")))(define-keymap"o"(cons"Other..."'facemenu-set-face))map)"Menu keymap for faces.");;;###autoload(defalias'facemenu-face-menufacemenu-face-menu);;;###autoload(defvarfacemenu-foreground-menu(let((map(make-sparse-keymap"Foreground Color")))(define-keymap"o"(cons"Other..."'facemenu-set-foreground))map)"Menu keymap for foreground colors.");;;###autoload(defalias'facemenu-foreground-menufacemenu-foreground-menu);;;###autoload(defvarfacemenu-background-menu(let((map(make-sparse-keymap"Background Color")))(define-keymap"o"(cons"Other..."'facemenu-set-background))map)"Menu keymap for background colors");;;###autoload(defalias'facemenu-background-menufacemenu-background-menu);;;###autoload(defvarfacemenu-special-menu(let((map(make-sparse-keymap"Special")))(define-keymap[?s](cons"Remove Special"'facemenu-remove-special))(define-keymap[?t](cons"Intangible"'facemenu-set-intangible))(define-keymap[?v](cons"Invisible"'facemenu-set-invisible))(define-keymap[?r](cons"Read-Only"'facemenu-set-read-only))map)"Menu keymap for non-face text-properties.");;;###autoload(defalias'facemenu-special-menufacemenu-special-menu);;;###autoload(defvarfacemenu-justification-menu(let((map(make-sparse-keymap"Justification")))(define-keymap[?c](cons"Center"'set-justification-center))(define-keymap[?b](cons"Full"'set-justification-full))(define-keymap[?r](cons"Right"'set-justification-right))(define-keymap[?l](cons"Left"'set-justification-left))(define-keymap[?u](cons"Unfilled"'set-justification-none))map)"Submenu for text justification commands.");;;###autoload(defalias'facemenu-justification-menufacemenu-justification-menu);;;###autoload(defvarfacemenu-indentation-menu(let((map(make-sparse-keymap"Indentation")))(define-keymap[decrease-right-margin](cons"Indent Right Less"'decrease-right-margin))(define-keymap[increase-right-margin](cons"Indent Right More"'increase-right-margin))(define-keymap[decrease-left-margin](cons"Indent Less"'decrease-left-margin))(define-keymap[increase-left-margin](cons"Indent More"'increase-left-margin))map)"Submenu for indentation commands.");;;###autoload(defalias'facemenu-indentation-menufacemenu-indentation-menu);; This is split up to avoid an overlong line in loaddefs.el.;;;###autoload(defvarfacemenu-menunil"Facemenu top-level menu keymap.");;;###autoload(setqfacemenu-menu(make-sparse-keymap"Text Properties"));;;###autoload(let((mapfacemenu-menu))(define-keymap[dc](cons"Display Colors"'list-colors-display))(define-keymap[df](cons"Display Faces"'list-faces-display))(define-keymap[dp](cons"List Properties"'list-text-properties-at))(define-keymap[ra](cons"Remove All"'facemenu-remove-all))(define-keymap[rm](cons"Remove Properties"'facemenu-remove-props))(define-keymap[s1](list"-----------------")));;;###autoload(let((mapfacemenu-menu))(define-keymap[in](cons"Indentation"'facemenu-indentation-menu))(define-keymap[ju](cons"Justification"'facemenu-justification-menu))(define-keymap[s2](list"-----------------"))(define-keymap[sp](cons"Special Properties"'facemenu-special-menu))(define-keymap[bg](cons"Background Color"'facemenu-background-menu))(define-keymap[fg](cons"Foreground Color"'facemenu-foreground-menu))(define-keymap[fc](cons"Face"'facemenu-face-menu)));;;###autoload(defalias'facemenu-menufacemenu-menu)(defvarfacemenu-keymap(let((map(make-sparse-keymap"Set face")))(define-keymap"o"(cons"Other..."'facemenu-set-face))map)"Keymap for face-changing commands.`Facemenu-update' fills in the keymap according to the bindingsrequested in `facemenu-keybindings'.")(defalias'facemenu-keymapfacemenu-keymap)(defcustomfacemenu-add-face-functionnil"Function called at beginning of text to change or `nil'.This function is passed the FACE to set and END of text to change, and mustreturn a string which is inserted. It may set `facemenu-end-add-face'.":type'(choice(const:tag"None"nil)function):group'facemenu)(defcustomfacemenu-end-add-facenil"String to insert or function called at end of text to change or `nil'.This function is passed the FACE to set, and must return a string which isinserted.":type'(choice(const:tag"None"nil)stringfunction):group'facemenu)(defcustomfacemenu-remove-face-functionnil"When non-nil, this is a function called to remove faces.This function is passed the START and END of text to change.May also be `t' meaning to use `facemenu-add-face-function'.":type'(choice(const:tag"None"nil)(const:tag"Use add-face"t)function):group'facemenu);;; Internal Variables(defvarfacemenu-color-alistnil;; Don't initialize here; that doesn't work if preloaded."Alist of colors, used for completion.If null, `facemenu-read-color' will set it.")(defunfacemenu-update()"Add or update the \"Face\" menu in the menu bar.You can call this to update things if you change any of the menu configurationvariables."(interactive);; Add each defined face to the menu.(facemenu-iterate'facemenu-add-new-face(facemenu-complete-face-listfacemenu-keybindings)));;;###autoload(defunfacemenu-set-face(face&optionalstartend)"Add FACE to the region or next character typed.It will be added to the top of the face list; any faces lower on the list thatwill not show through at all will be removed.Interactively, the face to be used is read with the minibuffer.If the region is active and there is no prefix argument,this command sets the region to the requested face.Otherwise, this command specifies the face for the next characterinserted. Moving point or switching buffers beforetyping a character to insert cancels the specification."(interactive(list(read-face-name"Use face: ")))(barf-if-buffer-read-only)(facemenu-add-new-faceface)(if(andmark-active(notcurrent-prefix-arg))(let((start(orstart(region-beginning)))(end(orend(region-end))))(facemenu-add-facefacestartend))(facemenu-add-faceface)));;;###autoload(defunfacemenu-set-foreground(color&optionalstartend)"Set the foreground color of the region or next character typed.The color is prompted for. A face named `fg:color' is used \(or created).If the region is active, it will be set to the requested face. Ifit is inactive \(even if mark-even-if-inactive is set) the nextcharacter that is typed \(via `self-insert-command') will be set tothe selected face. Moving point or switching buffers beforetyping a character cancels the request."(interactive(list(facemenu-read-color"Foreground color: ")))(let((face(intern(concat"fg:"color))))(or(facemenu-get-faceface)(error"Unknown color: %s"color))(facemenu-set-facefacestartend)));;;###autoload(defunfacemenu-set-background(color&optionalstartend)"Set the background color of the region or next character typed.The color is prompted for. A face named `bg:color' is used \(or created).If the region is active, it will be set to the requested face. Ifit is inactive \(even if mark-even-if-inactive is set) the nextcharacter that is typed \(via `self-insert-command') will be set tothe selected face. Moving point or switching buffers beforetyping a character cancels the request."(interactive(list(facemenu-read-color"Background color: ")))(let((face(intern(concat"bg:"color))))(or(facemenu-get-faceface)(error"Unknown color: %s"color))(facemenu-set-facefacestartend)));;;###autoload(defunfacemenu-set-face-from-menu(facestartend)"Set the face of the region or next character typed.This function is designed to be called from a menu; the face to useis the menu item's name.If the region is active and there is no prefix argument,this command sets the region to the requested face.Otherwise, this command specifies the face for the next characterinserted. Moving point or switching buffers beforetyping a character to insert cancels the specification."(interactive(listlast-command-event(if(andmark-active(notcurrent-prefix-arg))(region-beginning))(if(andmark-active(notcurrent-prefix-arg))(region-end))))(barf-if-buffer-read-only)(facemenu-get-faceface)(ifstart(facemenu-add-facefacestartend)(facemenu-add-faceface)));;;###autoload(defunfacemenu-set-invisible(startend)"Make the region invisible.This sets the `invisible' text property; it can be undone with`facemenu-remove-special'."(interactive"r")(add-text-propertiesstartend'(invisiblet)));;;###autoload(defunfacemenu-set-intangible(startend)"Make the region intangible: disallow moving into it.This sets the `intangible' text property; it can be undone with`facemenu-remove-special'."(interactive"r")(add-text-propertiesstartend'(intangiblet)));;;###autoload(defunfacemenu-set-read-only(startend)"Make the region unmodifiable.This sets the `read-only' text property; it can be undone with`facemenu-remove-special'."(interactive"r")(add-text-propertiesstartend'(read-onlyt)));;;###autoload(defunfacemenu-remove-props(startend)"Remove all text properties that facemenu added to region."(interactive"*r"); error if buffer is read-only despite the next line.(let((inhibit-read-onlyt))(remove-text-propertiesstartend'(facenilinvisiblenilintangiblenilread-onlynilcategorynil))));;;###autoload(defunfacemenu-remove-all(startend)"Remove all text properties from the region."(interactive"*r"); error if buffer is read-only despite the next line.(let((inhibit-read-onlyt))(set-text-propertiesstartendnil)));;;###autoload(defunfacemenu-remove-special(startend)"Remove all the \"special\" text properties from the region.These special properties include `invisible', `intangible' and `read-only'."(interactive"*r"); error if buffer is read-only despite the next line.(let((inhibit-read-onlyt))(remove-text-propertiesstartend'(invisiblenilintangiblenilread-onlynil))));;;###autoload(defunlist-text-properties-at(p)"Pop up a buffer listing text-properties at LOCATION."(interactive"d")(let((props(text-properties-atp))categorystr)(if(nullprops)(message"None")(if(and(not(cdr(cdrprops)))(not(eq(carprops)'category))(<(length(setqstr(format"Text property at %d: %s %S"p(carprops)(car(cdrprops)))))(frame-width)))(message"%s"str)(with-output-to-temp-buffer"*Text Properties*"(princ(format"Text properties at %d:\n\n"p))(whileprops(if(eq(carprops)'category)(setqcategory(car(cdrprops))))(princ(format"%-20s %S\n"(carprops)(car(cdrprops))))(setqprops(cdr(cdrprops))))(ifcategory(progn(setqprops(symbol-plistcategory))(princ(format"\nCategory %s:\n\n"category))(whileprops(princ(format"%-20s %S\n"(carprops)(car(cdrprops))))(if(eq(carprops)'category)(setqcategory(car(cdrprops))))(setqprops(cdr(cdrprops)))))))))));;;###autoload(defunfacemenu-read-color(&optionalprompt)"Read a color using the minibuffer."(let((col(completing-read(orprompt"Color: ")(orfacemenu-color-alist(ifwindow-system(mapcar'list(x-defined-colors))))nilt)))(if(equal""col)nilcol)));;;###autoload(defunlist-colors-display(&optionallist)"Display names of defined colors, and show what they look like.If the optional argument LIST is non-nil, it should be a list ofcolors to display. Otherwise, this command computes a listof colors that the current display can handle."(interactive)(if(and(nulllist)window-system)(progn(setqlist(x-defined-colors));; Delete duplicate colors.(let((llist))(while(cdrl)(if(facemenu-color-equal(carl)(car(cdrl)))(setcdrl(cdr(cdrl)))(setql(cdrl)))))))(with-output-to-temp-buffer"*Colors*"(save-excursion(set-bufferstandard-output)(let(s)(whilelist(setqs(point))(insert(carlist))(indent-to20)(put-text-propertys(point)'face(cons'background-color(carlist)))(setqs(point))(insert" "(carlist)"\n")(put-text-propertys(point)'face(cons'foreground-color(carlist)))(setqlist(cdrlist)))))))(defunfacemenu-color-equal(ab)"Return t if colors A and B are the same color.A and B should be strings naming colors.This function queries the window-system server to find out what thecolor names mean. It returns nil if the colors differ or if it can'tdetermine the correct answer."(cond((equalab)t)((and(memqwindow-system'(xw32))(equal(x-color-valuesa)(x-color-valuesb))))((eqwindow-system'pc)(and(x-color-defined-pa)(x-color-defined-pb)(eq(msdos-color-translatea)(msdos-color-translateb))))))(defunfacemenu-add-face(face&optionalstartend)"Add FACE to text between START and END.If START is `nil' or START to END is empty, add FACE to next typed characterinstead. For each section of that region that has a different face property,FACE will be consed onto it, and other faces that are completely hidden bythat will be removed from the list.If `facemenu-add-face-function' and maybe `facemenu-end-add-face' are non-`nil'they are used to set the face information.As a special case, if FACE is `default', then the region is left with NO facetext property. Otherwise, selecting the default face would not have anyeffect. See `facemenu-remove-face-function'."(interactive"*xFace: \nr")(if(and(eqface'default)(not(eqfacemenu-remove-face-functiont)))(iffacemenu-remove-face-function(funcallfacemenu-remove-face-functionstartend)(if(andstart(<startend))(remove-text-propertiesstartend'(facedefault))(setqself-insert-face'defaultself-insert-face-commandthis-command)))(iffacemenu-add-face-function(save-excursion(ifend(goto-charend))(save-excursion(ifstart(goto-charstart))(insert-before-markers(funcallfacemenu-add-face-functionfaceend)))(iffacemenu-end-add-face(insert(if(stringpfacemenu-end-add-face)facemenu-end-add-face(funcallfacemenu-end-add-faceface)))))(if(andstart(<startend))(let((part-startstart)part-end)(while(not(=part-startend))(setqpart-end(next-single-property-changepart-start'facenilend))(let((prev(get-text-propertypart-start'face)))(put-text-propertypart-startpart-end'face(if(nullprev)face(facemenu-active-faces(consface(if(listpprev)prev(listprev)))))))(setqpart-startpart-end)))(setqself-insert-face(if(eqlast-commandself-insert-face-command)(consface(if(listpself-insert-face)self-insert-face(listself-insert-face)))face)self-insert-face-commandthis-command)))))(defunfacemenu-active-faces(face-list&optionalframe)"Return from FACE-LIST those faces that would be used for display.This means each face attribute is not specified in a face earlier in FACE-LISTand such a face is therefore active when used to display text.If the optional argument FRAME is given, use the faces in that frame; otherwiseuse the selected frame. If t, then the global, non-frame faces are used."(let*((mask-atts(copy-sequence(internal-get-face(carface-list)frame)))(active-list(list(carface-list)))(face-list(cdrface-list))(mask-len(lengthmask-atts)))(whileface-list(if(let((face-atts(internal-get-face(carface-list)frame))(imask-len)(usefulnil))(while(>(setqi(1-i))1)(and(arefface-attsi)(not(arefmask-attsi))(asetmask-attsi(setqusefult))))useful)(setqactive-list(cons(carface-list)active-list)))(setqface-list(cdrface-list)))(nreverseactive-list)))(defunfacemenu-get-face(symbol)"Make sure FACE exists.If not, create it and add it to the appropriate menu. Return the symbol.If a window system is in use, and this function creates a face named`fg:color', then it sets the foreground to that color. Likewise, `bg:color'means to set the background. In either case, if the color is undefined,no color is set and a warning is issued."(let((name(symbol-namesymbol))foreground)(cond((internal-find-facesymbol))((andwindow-system(or(setqforeground(string-match"^fg:"name))(string-match"^bg:"name)))(let((face(make-facesymbol))(color(substringname3)))(if(x-color-defined-pcolor)(ifforeground(set-face-foregroundfacecolor)(set-face-backgroundfacecolor))(message"Color \"%s\" undefined"color))))(t(make-facesymbol))))symbol)(defunfacemenu-add-new-face(face)"Add a FACE to the appropriate Face menu.Automatically called when a new face is created."(let*((name(symbol-nameface))menudocstring(key(cdr(assocfacefacemenu-keybindings)))functionmenu-val)(cond((string-match"^fg:"name)(setqname(substringname3))(setqdocstring(format"Select foreground color %s for subsequent insertion."name))(setqmenu'facemenu-foreground-menu))((string-match"^bg:"name)(setqname(substringname3))(setqdocstring(format"Select background color %s for subsequent insertion."name))(setqmenu'facemenu-background-menu))(t(setqdocstring(format"Select face `%s' for subsequent insertion."name))(setqmenu'facemenu-face-menu)))(cond((eqtfacemenu-unlisted-faces))((memqfacefacemenu-unlisted-faces));; test against regexps in facemenu-unlisted-faces((let((unlistedfacemenu-unlisted-faces)(matchednil))(while(andunlisted(notmatched))(if(and(stringp(carunlisted))(string-match(carunlisted)name))(setqmatchedt)(setqunlisted(cdrunlisted))))matched))(key; has a keyboard equivalent. These go at the front.(setqfunction(intern(concat"facemenu-set-"name)))(fsetfunction`(lambda(),docstring(interactive)(facemenu-set-face(quote,face))))(define-key'facemenu-keymapkey(consnamefunction))(define-keymenukey(consnamefunction)))((facemenu-iterate; check if equivalent face is already in the menu(lambda(m)(and(listpm)(symbolp(carm))(face-equal(carm)face)))(cdr(symbol-functionmenu))))(t; No keyboard equivalent. Figure out where to put it:(setqkey(vectorface)function'facemenu-set-face-from-menumenu-val(symbol-functionmenu))(if(andfacemenu-new-faces-at-end(>(lengthmenu-val)3))(define-key-aftermenu-valkey(consnamefunction)(car(nth(-(lengthmenu-val)3)menu-val)))(define-keymenukey(consnamefunction))))))nil); Return nil for facemenu-iterate(defunfacemenu-complete-face-list(&optionaloldlist)"Return list of all faces that look different.Starts with given ALIST of faces, and adds elements only if they display differently from any face already on the list.The faces on ALIST will end up at the end of the returned list, in reverse order."(let((list(nreverse(mapcar'caroldlist))))(facemenu-iterate(lambda(new-face)(if(not(memqnew-facelist))(setqlist(consnew-facelist)))nil)(nreverse(face-list)))list))(defunfacemenu-iterate(funciterate-list)"Apply FUNC to each element of LIST until one returns non-nil.Returns the non-nil value it found, or nil if all were nil."(while(anditerate-list(not(funcallfunc(cariterate-list))))(setqiterate-list(cdriterate-list)))(cariterate-list))(facemenu-update);;; facemenu.el ends here