Fix up coding system.
[bpt/emacs.git] / lisp / facemenu.el
index 772aa39..6586b77 100644 (file)
@@ -1,5 +1,6 @@
 ;;; facemenu.el --- create a face menu for interactively adding fonts to text
-;; Copyright (c) 1994, 1995 Free Software Foundation, Inc.
+
+;; Copyright (c) 1994, 1995, 1996 Free Software Foundation, Inc.
 
 ;; Author: Boris Goldowsky <boris@gnu.ai.mit.edu>
 ;; Keywords: faces
 ;; 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, 675 Mass Ave, Cambridge, MA 02139, USA.
+;; 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
 ;;      (italic      . [?\H-i])
 ;;      (bold-italic . [?\H-l])
 ;;      (underline   . [?\H-u])))
+;;   (facemenu-update)
 ;;   (setq facemenu-keymap global-map)
-;;   (setq facemenu-key nil)
 ;;   (define-key global-map [?\H-c] 'facemenu-set-foreground) ; set fg color
 ;;   (define-key global-map [?\H-C] 'facemenu-set-background) ; set bg color
-;;   (require 'facemenu)
 ;;
 ;; The order of the faces that appear in the menu and their keybindings can be
 ;; controlled by setting the variables `facemenu-keybindings' and
 ;;; 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-key global-map [C-down-mouse-2] 'facemenu-menu)
+(define-key global-map "\M-g" 'facemenu-keymap)
 
-(defvar facemenu-key "\M-g"
-  "Prefix key to use for facemenu commands.")
+(defgroup facemenu nil
+  "Create a face menu for interactively adding fonts to text"
+  :group 'faces
+  :prefix "facemenu-")
 
-(defvar facemenu-keybindings
+(defcustom facemenu-keybindings
   '((default     . "d")
     (bold        . "b")
     (italic      . "i")
   "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 binding is made in `facemenu-keymap'.
 
 The faces specifically mentioned in this list are put at the top of
 the menu, in the order specified.  All other faces which are defined,
@@ -116,25 +124,32 @@ 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.")
+`facemenu-update' to make it take effect."
+  :type '(repeat (cons face string))
+  :group 'facemenu)
 
-(defvar facemenu-new-faces-at-end t
-  "Where in the menu to insert newly-created faces.
+(defcustom facemenu-new-faces-at-end t
+  "*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 them
-just before \"Other\" at the end.")
-
-(defvar facemenu-unlisted-faces
-  '(modeline region secondary-selection highlight scratch-face
-    font-lock-comment-face font-lock-string-face font-lock-keyword-face
-    font-lock-function-name-face font-lock-variable-name-face
-    font-lock-type-face font-lock-reference-face)
-  "List of faces not to include in the Face menu.
-Set this before loading facemenu.el, or call `facemenu-update' after
-changing it.
+just before \"Other\" at the end."
+  :type 'boolean
+  :group 'facemenu)
+
+(defcustom facemenu-unlisted-faces
+  '(modeline region secondary-selection highlight scratch-face)
+  "*List of faces not to include in the Face menu.
+You can set this list before loading facemenu.el, or add a face to it before
+creating that face if you do not want it to be listed.  If you change the
+variable 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 for
 temporarily turning off the feature that automatically adds faces to the menu
-when they are created.")
+when they are created."
+  :type '(choice (const :tag "Don't add" t)
+                (const :tag "None" nil)
+                (repeat face))
+  :group 'facemenu)
 
 ;;;###autoload
 (defvar facemenu-face-menu
@@ -239,6 +254,33 @@ when they are created.")
 requested in `facemenu-keybindings'.")
 (defalias 'facemenu-keymap facemenu-keymap)
 
+
+(defcustom facemenu-add-face-function nil
+  "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 must
+return a string which is inserted.  It may set `facemenu-end-add-face'."
+  :type '(choice (const :tag "None" nil)
+                function)
+  :group 'facemenu)
+
+(defcustom facemenu-end-add-face nil
+  "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 is
+inserted."
+  :type '(choice (const :tag "None" nil)
+                string
+                function)
+  :group 'facemenu)
+
+(defcustom facemenu-remove-face-function nil
+  "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
 
 (defvar facemenu-color-alist nil
@@ -251,10 +293,6 @@ If null, `facemenu-read-color' will set it.")
 You can call this to update things if you change any of the menu configuration
 variables."
   (interactive)
-  
-  ;; Global bindings:
-  (define-key global-map [C-down-mouse-2] 'facemenu-menu)
-  (if facemenu-key (define-key global-map facemenu-key 'facemenu-keymap))
 
   ;; Add each defined face to the menu.
   (facemenu-iterate 'facemenu-add-new-face
@@ -281,7 +319,7 @@ typing a character to insert cancels the specification."
       (let ((start (or start (region-beginning)))
            (end (or end (region-end))))
        (facemenu-add-face face start end))
-    (facemenu-self-insert-face face)))
+    (facemenu-add-face face)))
 
 ;;;###autoload
 (defun facemenu-set-foreground (color &optional start end)
@@ -334,15 +372,7 @@ typing a character to insert cancels the specification."
   (facemenu-get-face face)
   (if start 
       (facemenu-add-face face start end)
-    (facemenu-self-insert-face face)))
-
-(defun facemenu-self-insert-face (face)
-  (setq self-insert-face (if (eq last-command self-insert-face-command)
-                            (cons face (if (listp self-insert-face)
-                                           self-insert-face
-                                         (list self-insert-face)))
-                          face)
-       self-insert-face-command this-command))
+    (facemenu-add-face face)))
 
 ;;;###autoload
 (defun facemenu-set-invisible (start end)
@@ -350,7 +380,7 @@ typing a character to insert cancels the specification."
 This sets the `invisible' text property; it can be undone with
 `facemenu-remove-special'."
   (interactive "r")
-  (put-text-property start end 'invisible t))
+  (add-text-properties start end '(invisible t)))
 
 ;;;###autoload
 (defun facemenu-set-intangible (start end)
@@ -358,7 +388,7 @@ This sets the `invisible' text property; it can be undone with
 This sets the `intangible' text property; it can be undone with
 `facemenu-remove-special'."
   (interactive "r")
-  (put-text-property start end 'intangible t))
+  (add-text-properties start end '(intangible t)))
 
 ;;;###autoload
 (defun facemenu-set-read-only (start end)
@@ -366,7 +396,7 @@ This sets the `intangible' text property; it can be undone with
 This sets the `read-only' text property; it can be undone with
 `facemenu-remove-special'."
   (interactive "r")
-  (put-text-property start end 'read-only t))
+  (add-text-properties start end '(read-only t)))
 
 ;;;###autoload
 (defun facemenu-remove-props (start end)
@@ -397,22 +427,42 @@ These special properties include `invisible', `intangible' and `read-only'."
 (defun list-text-properties-at (p)
   "Pop up a buffer listing text-properties at LOCATION."
   (interactive "d")
-  (let ((props (text-properties-at p)))
+  (let ((props (text-properties-at p))
+       category
+       str)
     (if (null props)
        (message "None")
-      (with-output-to-temp-buffer "*Text Properties*"
-       (princ (format "Text properties at %d:\n\n" p))
-       (while props
-         (princ (format "%-20s %S\n"
-                        (car props) (car (cdr props))))
-         (setq props (cdr (cdr props))))))))
+      (if (and (not (cdr (cdr props)))
+              (not (eq (car props) 'category))
+              (< (length (setq str (format "Text property at %d:  %s  %S"
+                                           p (car props) (car (cdr props)))))
+                 (frame-width)))
+         (message "%s" str)
+       (with-output-to-temp-buffer "*Text Properties*"
+         (princ (format "Text properties at %d:\n\n" p))
+         (while props
+           (if (eq (car props) 'category)
+               (setq category (car (cdr props))))
+           (princ (format "%-20s %S\n"
+                          (car props) (car (cdr props))))
+           (setq props (cdr (cdr props))))
+         (if category
+             (progn
+               (setq props (symbol-plist category))
+               (princ (format "\nCategory %s:\n\n" category))
+               (while props
+                 (princ (format "%-20s %S\n"
+                                (car props) (car (cdr props))))
+                 (if (eq (car props) 'category)
+                     (setq category (car (cdr props))))
+                 (setq props (cdr (cdr props)))))))))))
 
 ;;;###autoload
 (defun facemenu-read-color (&optional prompt)
   "Read a color using the minibuffer."
   (let ((col (completing-read (or prompt "Color: ") 
                              (or facemenu-color-alist
-                                 (if (or (eq window-system 'x) (eq window-system 'win32))
+                                 (if window-system
                                      (mapcar 'list (x-defined-colors))))
                              nil t)))
     (if (equal "" col)
@@ -426,7 +476,7 @@ If the optional argument LIST is non-nil, it should be a list of
 colors to display.  Otherwise, this command computes a list
 of colors that the current display can handle."
   (interactive)
-  (if (and (null list) (or (eq window-system 'x) (eq window-system 'win32)))
+  (if (and (null list) window-system)
       (progn
        (setq list (x-defined-colors))
        ;; Delete duplicate colors.
@@ -461,55 +511,86 @@ This function queries the window-system server to find out what the
 color names mean.  It returns nil if the colors differ or if it can't
 determine the correct answer."
   (cond ((equal a b) t)
-       ((and (or (eq window-system 'x) (eq window-system 'win32))
-             (equal (x-color-values a) (x-color-values b))))))
+       ((and (memq window-system '(x w32))
+             (equal (x-color-values a) (x-color-values b))))
+       ((eq window-system 'pc)
+        (and (x-color-defined-p a) (x-color-defined-p b)
+             (eq (msdos-color-translate a) (msdos-color-translate b))))))
 
-(defun facemenu-add-face (face start end)
+(defun facemenu-add-face (face &optional start end)
   "Add FACE to text between START and END.
-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 by that will be
-removed from the list.
+If START is `nil' or START to END is empty, add FACE to next typed character
+instead.  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 by
+that 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 face
 text property.  Otherwise, selecting the default face would not have any
-effect."
-  (interactive "*xFace:\nr")
-  (if (eq face 'default)
-      (remove-text-properties start end '(face default))
-    (let ((part-start start) part-end)
-      (while (not (= part-start end))
-       (setq part-end (next-single-property-change part-start 'face nil end))
-       (let ((prev (get-text-property part-start 'face)))
-         (put-text-property part-start part-end 'face
-                            (if (null prev)
-                                face
-                              (facemenu-discard-redundant-faces
-                               (cons face
-                                     (if (listp prev) prev (list prev)))))))
-       (setq part-start part-end)))))
-
-(defun facemenu-discard-redundant-faces (face-list &optional mask)
-  "Remove from FACE-LIST any faces that won't show at all.
-This means they have no non-nil elements that aren't also non-nil in an
-earlier face."
-  (let ((useful nil))
-    (cond ((null face-list) nil)
-         ((null mask)
-          (cons (car face-list)
-                (facemenu-discard-redundant-faces
-                 (cdr face-list) 
-                 (copy-sequence (internal-get-face (car face-list))))))
-         ((let ((i (length mask))
-                (face (internal-get-face (car face-list))))
-            (while (>= (setq i (1- i)) 0)
-              (if (and (aref face i)
-                       (not (aref mask i)))
-                  (progn (setq useful t)
-                         (aset mask i t))))
-            useful)
-          (cons (car face-list)
-                (facemenu-discard-redundant-faces (cdr face-list) mask)))
-         (t (facemenu-discard-redundant-faces (cdr face-list) mask)))))
+effect.  See `facemenu-remove-face-function'."
+  (interactive "*xFace: \nr")
+  (if (and (eq face 'default)
+          (not (eq facemenu-remove-face-function t)))
+      (if facemenu-remove-face-function
+         (funcall facemenu-remove-face-function start end)
+       (if (and start (< start end))
+           (remove-text-properties start end '(face default))
+         (setq self-insert-face 'default
+               self-insert-face-command this-command)))
+    (if facemenu-add-face-function
+       (save-excursion
+         (if end (goto-char end))
+         (save-excursion
+           (if start (goto-char start))
+           (insert-before-markers
+            (funcall facemenu-add-face-function face end)))
+         (if facemenu-end-add-face
+             (insert (if (stringp facemenu-end-add-face)
+                         facemenu-end-add-face
+                       (funcall facemenu-end-add-face face)))))
+      (if (and start (< start end))
+         (let ((part-start start) part-end)
+           (while (not (= part-start end))
+             (setq part-end (next-single-property-change part-start 'face
+                                                         nil end))
+             (let ((prev (get-text-property part-start 'face)))
+               (put-text-property part-start part-end 'face
+                                  (if (null prev)
+                                      face
+                                    (facemenu-active-faces
+                                     (cons face
+                                           (if (listp prev)
+                                               prev
+                                             (list prev)))))))
+             (setq part-start part-end)))
+       (setq self-insert-face (if (eq last-command self-insert-face-command)
+                                  (cons face (if (listp self-insert-face)
+                                                 self-insert-face
+                                               (list self-insert-face)))
+                                face)
+             self-insert-face-command this-command)))))
+
+(defun facemenu-active-faces (face-list &optional frame)
+  "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-LIST
+and such a face is therefore active when used to display text.
+If the optional argument FRAME is given, use the faces in that frame; otherwise
+use the selected frame.  If t, then the global, non-frame faces are used."
+  (let* ((mask-atts (copy-sequence (internal-get-face (car face-list) frame)))
+        (active-list (list (car face-list)))
+        (face-list (cdr face-list))
+        (mask-len (length mask-atts)))
+    (while face-list
+      (if (let ((face-atts (internal-get-face (car face-list) frame))
+               (i mask-len) (useful nil))
+           (while (> (setq i (1- i)) 1)
+             (and (aref face-atts i) (not (aref mask-atts i))
+                  (aset mask-atts i (setq useful t))))
+           useful)
+         (setq active-list (cons (car face-list) active-list)))
+      (setq face-list (cdr face-list)))
+    (nreverse active-list)))
 
 (defun facemenu-get-face (symbol)
   "Make sure FACE exists.
@@ -523,10 +604,12 @@ or nil if given a bad color."
                 (color (substring name 3)))
            (cond ((string-match "^fg:" name)
                   (set-face-foreground face color)
-                  (and (or (eq window-system 'x) (eq window-system 'win32)) (x-color-defined-p color)))
+                  (and window-system
+                       (x-color-defined-p color)))
                  ((string-match "^bg:" name)
                   (set-face-background face color)
-                  (and (or (eq window-system 'x) (eq window-system 'win32)) (x-color-defined-p color)))
+                  (and window-system
+                       (x-color-defined-p color)))
                  (t))))
       symbol))
 
@@ -534,22 +617,35 @@ or nil if given a bad color."
   "Add a FACE to the appropriate Face menu.
 Automatically called when a new face is created."
   (let* ((name (symbol-name face))
-        (menu (cond ((string-match "^fg:" name) 
-                     (setq name (substring name 3))
-                     'facemenu-foreground-menu)
-                    ((string-match "^bg:" name) 
-                     (setq name (substring name 3))
-                     'facemenu-background-menu)
-                    (t 'facemenu-face-menu)))
+        menu docstring
         (key (cdr (assoc face facemenu-keybindings)))
         function menu-val)
+    (cond ((string-match "^fg:" name) 
+          (setq name (substring name 3))
+          (setq docstring
+                (format "Select foreground color %s for subsequent insertion."
+                        name))
+          (setq menu 'facemenu-foreground-menu))
+         ((string-match "^bg:" name) 
+          (setq name (substring name 3))
+          (setq docstring
+                (format "Select background color %s for subsequent insertion."
+                        name))
+          (setq menu 'facemenu-background-menu))
+         (t
+          (setq docstring
+                (format "Select face `%s' for subsequent insertion."
+                        name))
+          (setq menu 'facemenu-face-menu)))
     (cond ((eq t facemenu-unlisted-faces))
          ((memq face facemenu-unlisted-faces))
          (key ; has a keyboard equivalent.  These go at the front.
           (setq function (intern (concat "facemenu-set-" name)))
           (fset function
-                (` (lambda () (interactive)
-                     (facemenu-set-face (quote (, face))))))
+                `(lambda ()
+                   ,docstring
+                   (interactive)
+                   (facemenu-set-face (quote ,face))))
           (define-key 'facemenu-keymap key (cons name function))
           (define-key menu key (cons name function)))
          ((facemenu-iterate ; check if equivalent face is already in the menu
@@ -569,7 +665,7 @@ Automatically called when a new face is created."
   nil) ; Return nil for facemenu-iterate
 
 (defun facemenu-complete-face-list (&optional oldlist)
-  "Return list of all faces that are look different.
+  "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