X-Git-Url: https://code.delx.au/gnu-emacs/blobdiff_plain/5f0cfe8bfffdae441ecfa85a4575c022422731ac..5e2fd70ae44c72f41bf2aa2badc9ceb3b6e64d95:/lisp/cus-face.el diff --git a/lisp/cus-face.el b/lisp/cus-face.el index 1d986d42ea..53ad08498f 100644 --- a/lisp/cus-face.el +++ b/lisp/cus-face.el @@ -1,11 +1,10 @@ -;;; cus-face.el -- customization support for faces. +;;; cus-face.el --- customization support for faces ;; -;; Copyright (C) 1996, 1997 Free Software Foundation, Inc. +;; Copyright (C) 1996, 1997, 1999, 2000, 2001, 2002, 2003, 2004, +;; 2005, 2006 Free Software Foundation, Inc. ;; ;; Author: Per Abrahamsen ;; Keywords: help, faces -;; Version: Emacs -;; X-URL: http://www.dina.kvl.dk/~abraham/custom/ ;; This file is part of GNU Emacs. @@ -21,8 +20,8 @@ ;; 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. +;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, +;; Boston, MA 02110-1301, USA. ;;; Commentary: ;; @@ -30,131 +29,357 @@ ;;; Code: +(defalias 'custom-facep 'facep) + ;;; Declaring a face. ;;;###autoload (defun custom-declare-face (face spec doc &rest args) "Like `defface', but FACE is evaluated as a normal argument." (unless (get face 'face-defface-spec) - (put face 'face-defface-spec spec) (when (fboundp 'facep) (unless (facep face) ;; If the user has already created the face, respect that. - (let ((value (or (get face 'saved-face) spec)) - (frames (frame-list)) - frame) + (let ((value (or (get face 'saved-face) spec))) ;; Create global face. (make-empty-face face) - ;; Create frame local faces - (while frames - (setq frame (car frames) - frames (cdr frames)) - (face-spec-set face value frame))))) - (when (and doc (null (face-doc-string face))) - (set-face-doc-string face doc)) + ;; Create frame-local faces + (dolist (frame (frame-list)) + (face-spec-set face value frame))) + ;; When making a face after frames already exist + (if (memq window-system '(x w32 mac)) + (make-face-x-resource-internal face)))) + ;; Don't record SPEC until we see it causes no errors. + (put face 'face-defface-spec spec) + (push (cons 'defface face) current-load-list) + (when (and doc (null (face-documentation face))) + (set-face-documentation face (purecopy doc))) (custom-handle-all-keywords face args 'custom-face) (run-hooks 'custom-define-hook)) face) -;;; Font Attributes. +;;; Face attributes. +;;;###autoload (defconst custom-face-attributes - '((:bold (toggle :format "%[Bold%]: %v\n" - :help-echo "Control whether a bold font should be used.") - set-face-bold-p - face-bold-p) - (:italic (toggle :format "%[Italic%]: %v\n" - :help-echo "\ -Control whether an italic font should be used.") - set-face-italic-p - face-italic-p) - (:underline (toggle :format "%[Underline%]: %v\n" - :help-echo "\ -Control whether the text should be underlined.") - set-face-underline-p - face-underline-p) - (:foreground (color :tag "Foreground" - :value "black" - :help-echo "Set foreground color.") - set-face-foreground - face-foreground) - (:background (color :tag "Background" - :value "white" - :help-echo "Set background color.") - set-face-background - face-background) - (:stipple (editable-field :format "Stipple: %v" - :help-echo "Name of background bitmap file.") - set-face-stipple - face-stipple)) - "Alist of face attributes. -The elements are of the form (KEY TYPE SET GET), -where KEY is the name of the attribute, -TYPE is a widget type for editing the attibute, -SET is a function for setting the attribute value, -and GET is a function for getiing the attribute value. - -The SET function should take three arguments, the face to modify, the -value of the attribute, and optionally the frame where the face should -be changed. - -The GET function should take two arguments, the face to examine, and -optionally the frame where the face should be examined.") + '((:family + (string :tag "Font Family" + :help-echo "Font family or fontset alias name.")) + + (:width + (choice :tag "Width" + :help-echo "Font width." + :value normal ; default + (const :tag "compressed" condensed) + (const :tag "condensed" condensed) + (const :tag "demiexpanded" semi-expanded) + (const :tag "expanded" expanded) + (const :tag "extracondensed" extra-condensed) + (const :tag "extraexpanded" extra-expanded) + (const :tag "medium" normal) + (const :tag "narrow" condensed) + (const :tag "normal" normal) + (const :tag "regular" normal) + (const :tag "semicondensed" semi-condensed) + (const :tag "semiexpanded" semi-expanded) + (const :tag "ultracondensed" ultra-condensed) + (const :tag "ultraexpanded" ultra-expanded) + (const :tag "wide" extra-expanded))) + + (:height + (choice :tag "Height" + :help-echo "Face's font height." + :value 1.0 ; default + (integer :tag "Height in 1/10 pt") + (number :tag "Scale" 1.0))) + + (:weight + (choice :tag "Weight" + :help-echo "Font weight." + :value normal ; default + (const :tag "black" ultra-bold) + (const :tag "bold" bold) + (const :tag "book" semi-light) + (const :tag "demibold" semi-bold) + (const :tag "extralight" extra-light) + (const :tag "extrabold" extra-bold) + (const :tag "heavy" extra-bold) + (const :tag "light" light) + (const :tag "medium" normal) + (const :tag "normal" normal) + (const :tag "regular" normal) + (const :tag "semibold" semi-bold) + (const :tag "semilight" semi-light) + (const :tag "ultralight" ultra-light) + (const :tag "ultrabold" ultra-bold))) + + (:slant + (choice :tag "Slant" + :help-echo "Font slant." + :value normal ; default + (const :tag "italic" italic) + (const :tag "oblique" oblique) + (const :tag "normal" normal))) + + (:underline + (choice :tag "Underline" + :help-echo "Control text underlining." + (const :tag "Off" nil) + (const :tag "On" t) + (color :tag "Colored"))) + + (:overline + (choice :tag "Overline" + :help-echo "Control text overlining." + (const :tag "Off" nil) + (const :tag "On" t) + (color :tag "Colored"))) + + (:strike-through + (choice :tag "Strike-through" + :help-echo "Control text strike-through." + (const :tag "Off" nil) + (const :tag "On" t) + (color :tag "Colored"))) + + (:box + ;; Fixme: this can probably be done better. + (choice :tag "Box around text" + :help-echo "Control box around text." + (const :tag "Off" nil) + (list :tag "Box" + :value (:line-width 2 :color "grey75" :style released-button) + (const :format "" :value :line-width) + (integer :tag "Width") + (const :format "" :value :color) + (choice :tag "Color" (const :tag "*" nil) color) + (const :format "" :value :style) + (choice :tag "Style" + (const :tag "Raised" released-button) + (const :tag "Sunken" pressed-button) + (const :tag "None" nil)))) + ;; filter to make value suitable for customize + (lambda (real-value) + (and real-value + (let ((lwidth + (or (and (consp real-value) + (plist-get real-value :line-width)) + (and (integerp real-value) real-value) + 1)) + (color + (or (and (consp real-value) (plist-get real-value :color)) + (and (stringp real-value) real-value) + nil)) + (style + (and (consp real-value) (plist-get real-value :style)))) + (list :line-width lwidth :color color :style style)))) + ;; filter to make customized-value suitable for storing + (lambda (cus-value) + (and cus-value + (let ((lwidth (plist-get cus-value :line-width)) + (color (plist-get cus-value :color)) + (style (plist-get cus-value :style))) + (cond ((and (null color) (null style)) + lwidth) + ((and (null lwidth) (null style)) + ;; actually can't happen, because LWIDTH is always an int + color) + (t + ;; Keep as a plist, but remove null entries + (nconc (and lwidth `(:line-width ,lwidth)) + (and color `(:color ,color)) + (and style `(:style ,style))))))))) + + (:inverse-video + (choice :tag "Inverse-video" + :help-echo "Control whether text should be in inverse-video." + (const :tag "Off" nil) + (const :tag "On" t))) + + (:foreground + (color :tag "Foreground" + :help-echo "Set foreground color (name or #RRGGBB hex spec).")) + + (:background + (color :tag "Background" + :help-echo "Set background color (name or #RRGGBB hex spec).")) + + (:stipple + (choice :tag "Stipple" + :help-echo "Background bit-mask" + (const :tag "None" nil) + (file :tag "File" + :help-echo "Name of bitmap file." + :must-match t))) + + (:inherit + (repeat :tag "Inherit" + :help-echo "List of faces to inherit attributes from." + (face :Tag "Face" default)) + ;; filter to make value suitable for customize + (lambda (real-value) + (cond ((or (null real-value) (eq real-value 'unspecified)) + nil) + ((symbolp real-value) + (list real-value)) + (t + real-value))) + ;; filter to make customized-value suitable for storing + (lambda (cus-value) + (if (and (consp cus-value) (null (cdr cus-value))) + (car cus-value) + cus-value)))) + + "Alist of face attributes. + +The elements are of the form (KEY TYPE PRE-FILTER POST-FILTER), +where KEY is the name of the attribute, TYPE is a widget type for +editing the attribute, PRE-FILTER is a function to make the attribute's +value suitable for the customization widget, and POST-FILTER is a +function to make the customized value suitable for storing. PRE-FILTER +and POST-FILTER are optional. + +The PRE-FILTER should take a single argument, the attribute value as +stored, and should return a value for customization (using the +customization type TYPE). + +The POST-FILTER should also take a single argument, the value after +being customized, and should return a value suitable for setting the +given face attribute.") (defun custom-face-attributes-get (face frame) "For FACE on FRAME, return an alternating list describing its attributes. The list has the form (KEYWORD VALUE KEYWORD VALUE...). Each keyword should be listed in `custom-face-attributes'. -We include only those attributes that differ from the default face. If FRAME is nil, use the global defaults for FACE." - (let ((atts custom-face-attributes) - att result get) - (while atts - (setq att (car atts) - atts (cdr atts) - get (nth 3 att)) - (when get - (let ((answer (funcall get face frame))) - (if (and (not (equal answer (funcall get 'default frame))) - (widget-apply (nth 1 att) :match answer)) - (setq result (cons (nth 0 att) (cons answer result))))))) - result)) + (let ((attrs custom-face-attributes) + plist) + (while attrs + (let* ((attribute (car (car attrs))) + (value (face-attribute face attribute frame))) + (setq attrs (cdr attrs)) + (unless (or (eq value 'unspecified) + (and (null value) (memq attribute '(:inherit)))) + (setq plist (cons attribute (cons value plist)))))) + plist)) ;;; Initializing. ;;;###autoload (defun custom-set-faces (&rest args) "Initialize faces according to user preferences. +This associates the settings with the `user' theme. The arguments should be a list where each entry has the form: - (FACE SPEC [NOW]) + (FACE SPEC [NOW [COMMENT]]) + +SPEC is stored as the saved value for FACE, as well as the value for the +`user' theme. The `user' theme is one of the default themes known to Emacs. +See `custom-known-themes' for more information on the known themes. +See `custom-theme-set-faces' for more information on the interplay +between themes and faces. +See `defface' for the format of SPEC. + +If NOW is present and non-nil, FACE is created now, according to SPEC. +COMMENT is a string comment about FACE." + (apply 'custom-theme-set-faces 'user args)) + +(defun custom-theme-set-faces (theme &rest args) + "Initialize faces for theme THEME. +The arguments should be a list where each entry has the form: + + (FACE SPEC [NOW [COMMENT]]) + +SPEC is stored as the saved value for FACE, as well as the value for the +`user' theme. The `user' theme is one of the default themes known to Emacs. +See `custom-known-themes' for more information on the known themes. +See `custom-theme-set-faces' for more information on the interplay +between themes and faces. +See `defface' for the format of SPEC. -SPEC is stored as the saved value for FACE. If NOW is present and non-nil, FACE is created now, according to SPEC. +COMMENT is a string comment about FACE. + +Several properties of THEME and FACE are used in the process: + +If THEME property `theme-immediate' is non-nil, this is equivalent of +providing the NOW argument to all faces in the argument list: FACE is +created now. The only difference is FACE property `force-face': if NOW +is non-nil, FACE property `force-face' is set to the symbol `rogue', else +if THEME property `theme-immediate' is non-nil, FACE property `force-face' +is set to the symbol `immediate'. + +SPEC itself is saved in FACE property `saved-face' and it is stored in +FACE's list property `theme-face' \(using `custom-push-theme')." + (custom-check-theme theme) + (let ((immediate (get theme 'theme-immediate))) + (while args + (let ((entry (car args))) + (if (listp entry) + (let ((face (nth 0 entry)) + (spec (nth 1 entry)) + (now (nth 2 entry)) + (comment (nth 3 entry)) + oldspec) + ;; If FACE is actually an alias, customize the face it + ;; is aliased to. + (if (get face 'face-alias) + (setq face (get face 'face-alias))) -See `defface' for the format of SPEC." - (while args - (let ((entry (car args))) - (if (listp entry) - (let ((face (nth 0 entry)) - (spec (nth 1 entry)) - (now (nth 2 entry))) - (put face 'saved-face spec) - (when now - (put face 'force-face t)) - (when (or now (facep face)) - (make-empty-face face) - (face-spec-set face spec)) + (setq oldspec (get face 'theme-face)) + (when (not (and oldspec (eq 'user (caar oldspec)))) + (put face 'saved-face spec) + (put face 'saved-face-comment comment)) + + (custom-push-theme 'theme-face face theme 'set spec) + (when (or now immediate) + (put face 'force-face (if now 'rogue 'immediate))) + (when (or now immediate (facep face)) + (unless (facep face) + (make-empty-face face)) + (put face 'face-comment comment) + (face-spec-set face spec)) (setq args (cdr args))) ;; Old format, a plist of FACE SPEC pairs. (let ((face (nth 0 args)) (spec (nth 1 args))) - (put face 'saved-face spec)) - (setq args (cdr (cdr args))))))) + (if (get face 'face-alias) + (setq face (get face 'face-alias))) + (put face 'saved-face spec) + (custom-push-theme 'theme-face face theme 'set spec)) + (setq args (cdr (cdr args)))))))) + +;; XEmacs compability function. In XEmacs, when you reset a Custom +;; Theme, you have to specify the theme to reset it to. We just apply +;; the next theme. +;;;###autoload +(defun custom-theme-reset-faces (theme &rest args) + "Reset the specs in THEME of some faces to their specs in other themes. +Each of the arguments ARGS has this form: + + (FACE IGNORED) + +This means reset FACE. The argument IGNORED is ignored." + (custom-check-theme theme) + (dolist (arg args) + (custom-push-theme 'theme-face (car arg) theme 'reset))) + +;;;###autoload +(defun custom-reset-faces (&rest args) + "Reset the specs of some faces to their specs in specified themes. +This creates settings in the `user' theme. + +Each of the arguments ARGS has this form: + + (FACE FROM-THEME) + +This means reset FACE to its value in FROM-THEME." + (apply 'custom-theme-reset-faces 'user args)) ;;; The End. (provide 'cus-face) -;; cus-face.el ends here +;;; arch-tag: 9a5c4b63-0d27-4c92-a5af-f2c7ed764c2b +;;; cus-face.el ends here