lisp/cus-face.el

   1 ;;; cus-face.el --- customization support for faces
   2 ;;
   3 ;; Copyright (C) 1996, 1997, 1999, 2000 Free Software Foundation, Inc.
   4 ;;
   5 ;; Author: Per Abrahamsen <abraham@dina.kvl.dk>
   6 ;; Keywords: help, faces
   7 ;; Version: Emacs
   8
   9 ;; This file is part of GNU Emacs.
  10
  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 2, or (at your option)
  14 ;; any later version.
  15
  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.
  20
  21 ;; You should have received a copy of the GNU General Public License
  22 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
  23 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  24 ;; Boston, MA 02111-1307, USA.
  25
  26 ;;; Commentary:
  27 ;;
  28 ;; See `custom.el'.
  29
  30 ;;; Code:
  31
  32 (defalias 'custom-facep 'facep)
  33
  34 ;;; Declaring a face.
  35
  36 ;;;###autoload
  37 (defun custom-declare-face (face spec doc &rest args)
  38   "Like `defface', but FACE is evaluated as a normal argument."
  39   (unless (get face 'face-defface-spec)
  40     (when (fboundp 'facep)
  41       (unless (facep face)
  42         ;; If the user has already created the face, respect that.
  43         (let ((value (or (get face 'saved-face) spec))
  44               (frames (frame-list))
  45               frame)
  46           ;; Create global face.
  47           (make-empty-face face)
  48           ;; Create frame-local faces
  49           (while frames
  50             (setq frame (car frames)
  51                   frames (cdr frames))
  52             (face-spec-set face value frame)))
  53         ;; When making a face after frames already exist
  54         (if (memq window-system '(x w32))
  55             (make-face-x-resource-internal face))))
  56     ;; Don't record SPEC until we see it causes no errors.
  57     (put face 'face-defface-spec spec)
  58     (when (and doc (null (face-documentation face)))
  59       (set-face-documentation face (purecopy doc)))
  60     (custom-handle-all-keywords face args 'custom-face)
  61     (run-hooks 'custom-define-hook))
  62   face)
  63
  64 ;;; Face attributes.
  65
  66 (defconst custom-face-attributes
  67   '((:family
  68      (string :tag "Font Family"
  69              :help-echo "Font family or fontset alias name."))
  70
  71     (:width
  72      (choice :tag "Width"
  73              :help-echo "Font width."
  74              :value normal              ; default
  75              (const :tag "compressed" condensed)
  76              (const :tag "condensed" condensed)
  77              (const :tag "demiexpanded" semi-expanded)
  78              (const :tag "expanded" expanded)
  79              (const :tag "extracondensed" extra-condensed)
  80              (const :tag "extraexpanded" extra-expanded)
  81              (const :tag "medium" normal)
  82              (const :tag "narrow" condensed)
  83              (const :tag "normal" normal)
  84              (const :tag "regular" normal)
  85              (const :tag "semicondensed" semi-condensed)
  86              (const :tag "semiexpanded" semi-expanded)
  87              (const :tag "ultracondensed" ultra-condensed)
  88              (const :tag "ultraexpanded" ultra-expanded)
  89              (const :tag "wide" extra-expanded)))
  90
  91     (:height
  92      (choice :tag "Height"
  93              :help-echo "Face's font height."
  94              :value 1.0                 ; default
  95              (integer :tag "Height in 1/10 pt")
  96              (number :tag "Scale" 1.0)))
  97
  98     (:weight
  99      (choice :tag "Weight"
 100              :help-echo "Font weight."
 101              :value normal              ; default
 102              (const :tag "black" ultra-bold)
 103              (const :tag "bold" bold)
 104              (const :tag "book" semi-light)
 105              (const :tag "demibold" semi-bold)
 106              (const :tag "extralight" extra-light)
 107              (const :tag "extrabold" extra-bold)
 108              (const :tag "heavy" extra-bold)
 109              (const :tag "light" light)
 110              (const :tag "medium" normal)
 111              (const :tag "normal" normal)
 112              (const :tag "regular" normal)
 113              (const :tag "semibold" semi-bold)
 114              (const :tag "semilight" semi-light)
 115              (const :tag "ultralight" ultra-light)
 116              (const :tag "ultrabold" ultra-bold)))
 117
 118     (:slant
 119      (choice :tag "Slant"
 120              :help-echo "Font slant."
 121              :value normal              ; default
 122              (const :tag "italic" italic)
 123              (const :tag "oblique" oblique)
 124              (const :tag "normal" normal)))
 125
 126     (:underline
 127      (choice :tag "Underline"
 128              :help-echo "Control text underlining."
 129              (const :tag "Off" nil)
 130              (const :tag "On" t)
 131              (color :tag "Colored")))
 132
 133     (:overline
 134      (choice :tag "Overline"
 135              :help-echo "Control text overlining."
 136              (const :tag "Off" nil)
 137              (const :tag "On" t)
 138              (color :tag "Colored")))
 139
 140     (:strike-through
 141      (choice :tag "Strike-through"
 142              :help-echo "Control text strike-through."
 143              (const :tag "Off" nil)
 144              (const :tag "On" t)
 145              (color :tag "Colored")))
 146
 147     (:box
 148      ;; Fixme: this can probably be done better.
 149      (choice :tag "Box around text"
 150              :help-echo "Control box around text."
 151              (const :tag "Off" nil)
 152              (list :tag "Box"
 153                    :value (:line-width 2 :color "grey75" :style released-button)
 154                    (const :format "" :value :line-width)
 155                    (integer :tag "Width")
 156                    (const :format "" :value :color)
 157                    (choice :tag "Color" (const :tag "*" nil) color)
 158                    (const :format "" :value :style)
 159                    (choice :tag "Style"
 160                            (const :tag "Raised" released-button)
 161                            (const :tag "Sunken" pressed-button)
 162                            (const :tag "None" nil))))
 163      ;; filter to make value suitable for customize
 164      (lambda (real-value)
 165        (and real-value
 166             (let ((lwidth
 167                    (or (and (consp real-value)
 168                             (plist-get real-value :line-width))
 169                        (and (integerp real-value) real-value)
 170                        1))
 171                   (color
 172                    (or (and (consp real-value) (plist-get real-value :color))
 173                        (and (stringp real-value) real-value)
 174                        nil))
 175                   (style
 176                    (and (consp real-value) (plist-get real-value :style))))
 177               (list :line-width lwidth :color color :style style))))
 178      ;; filter to make customized-value suitable for storing
 179      (lambda (cus-value)
 180        (and cus-value
 181             (let ((lwidth (plist-get cus-value :line-width))
 182                   (color (plist-get cus-value :color))
 183                   (style (plist-get cus-value :style)))
 184               (cond ((and (null color) (null style))
 185                      lwidth)
 186                     ((and (null lwidth) (null style))
 187                      ;; actually can't happen, because LWIDTH is always an int
 188                      color)
 189                     (t
 190                      ;; Keep as a plist, but remove null entries
 191                      (nconc (and lwidth `(:line-width ,lwidth))
 192                             (and color  `(:color ,color))
 193                             (and style  `(:style ,style)))))))))
 194
 195     (:inverse-video
 196      (choice :tag "Inverse-video"
 197              :help-echo "Control whether text should be in inverse-video."
 198              (const :tag "Off" nil)
 199              (const :tag "On" t)))
 200
 201     (:foreground
 202      (color :tag "Foreground"
 203             :help-echo "Set foreground color."))
 204
 205     (:background
 206      (color :tag "Background"
 207             :help-echo "Set background color."))
 208
 209     (:stipple
 210      (choice :tag "Stipple"
 211              :help-echo "Background bit-mask"
 212              (const :tag "None" nil)
 213              (file :tag "File"
 214                    :help-echo "Name of bitmap file."
 215                    :must-match t)))
 216
 217     (:inherit
 218      (repeat :tag "Inherit"
 219              :help-echo "List of faces to inherit attributes from."
 220              (face :Tag "Face" default))
 221      ;; filter to make value suitable for customize
 222      (lambda (real-value)
 223        (cond ((or (null real-value) (eq real-value 'unspecified))
 224               nil)
 225              ((symbolp real-value)
 226               (list real-value))
 227              (t
 228               real-value)))
 229      ;; filter to make customized-value suitable for storing
 230      (lambda (cus-value)
 231        (if (and (consp cus-value) (null (cdr cus-value)))
 232            (car cus-value)
 233          cus-value))))
 234
 235   "Alist of face attributes.
 236
 237 The elements are of the form (KEY TYPE PRE-FILTER POST-FILTER),
 238 where KEY is the name of the attribute, TYPE is a widget type for
 239 editing the attribute, PRE-FILTER is a function to make the attribute's
 240 value suitable for the customization widget, and POST-FILTER is a
 241 function to make the customized value suitable for storing.  PRE-FILTER
 242 and POST-FILTER are optional.
 243
 244 The PRE-FILTER should take a single argument, the attribute value as
 245 stored, and should return a value for customization (using the
 246 customization type TYPE).
 247
 248 The POST-FILTER should also take a single argument, the value after
 249 being customized, and should return a value suitable for setting the
 250 given face attribute.")
 251
 252
 253 (defun custom-face-attributes-get (face frame)
 254   "For FACE on FRAME, return an alternating list describing its attributes.
 255 The list has the form (KEYWORD VALUE KEYWORD VALUE...).
 256 Each keyword should be listed in `custom-face-attributes'.
 257
 258 If FRAME is nil, use the global defaults for FACE."
 259   (let ((attrs custom-face-attributes)
 260         plist)
 261     (while attrs
 262       (let* ((attribute (car (car attrs)))
 263              (value (face-attribute face attribute frame)))
 264         (setq attrs (cdr attrs))
 265         (unless (or (eq value 'unspecified)
 266                     (and (null value) (memq attribute '(:inherit))))
 267           (setq plist (cons attribute (cons value plist))))))
 268     plist))
 269
 270 ;;; Initializing.
 271
 272 ;;;###autoload
 273 (defun custom-set-faces (&rest args)
 274   "Initialize faces according to user preferences.
 275 The arguments should be a list where each entry has the form:
 276
 277   (FACE SPEC [NOW [COMMENT]])
 278
 279 SPEC is stored as the saved value for FACE.
 280 If NOW is present and non-nil, FACE is created now, according to SPEC.
 281 COMMENT is a string comment about FACE.
 282
 283 See `defface' for the format of SPEC."
 284   (while args
 285     (let ((entry (car args)))
 286       (if (listp entry)
 287           (let ((face (nth 0 entry))
 288                 (spec (nth 1 entry))
 289                 (now (nth 2 entry))
 290                 (comment (nth 3 entry)))
 291             (put face 'saved-face spec)
 292             (put face 'saved-face-comment comment)
 293             (when now
 294               (put face 'force-face t))
 295             (when (or now (facep face))
 296               (put face 'face-comment comment)
 297               (make-empty-face face)
 298               (face-spec-set face spec))
 299             (setq args (cdr args)))
 300         ;; Old format, a plist of FACE SPEC pairs.
 301         (let ((face (nth 0 args))
 302               (spec (nth 1 args)))
 303           (put face 'saved-face spec))
 304         (setq args (cdr (cdr args)))))))
 305
 306 ;;; The End.
 307
 308 (provide 'cus-face)
 309
 310 ;;; cus-face.el ends here