1 ;;; faces.el --- Lisp faces
3 ;; Copyright (C) 1992, 1993, 1994, 1995, 1996, 1998, 1999, 2000, 2001, 2002
4 ;; Free Software Foundation, Inc.
9 ;; This file is part of GNU Emacs.
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)
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.
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.
32 ;; Warning suppression -- can't require x-win in batch:
33 (autoload 'xw-defined-colors
"x-win"))
36 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
38 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
40 (defgroup font-selection nil
41 "Influencing face font selection."
45 (defcustom face-font-selection-order
46 '(:width
:height
:weight
:slant
)
47 "*A list specifying how face font selection chooses fonts.
48 Each of the four symbols `:width', `:height', `:weight', and `:slant'
49 must appear once in the list, and the list must not contain any other
50 elements. Font selection tries to find a best matching font for
51 those face attributes first that appear first in the list. For
52 example, if `:slant' appears before `:height', font selection first
53 tries to find a font with a suitable slant, even if this results in
54 a font height that isn't optimal."
55 :tag
"Font selection order."
56 :type
'(list symbol symbol symbol symbol
)
57 :group
'font-selection
58 :set
#'(lambda (symbol value
)
59 (set-default symbol value
)
60 (internal-set-font-selection-order value
)))
63 ;; This is defined originally in xfaces.c.
64 (defcustom face-font-family-alternatives
66 ("helv" "helvetica" "arial" "fixed"))
67 "*Alist of alternative font family names.
68 Each element has the form (FAMILY ALTERNATIVE1 ALTERNATIVE2 ...).
69 If fonts of family FAMILY can't be loaded, try ALTERNATIVE1, then
71 :tag
"Alternative font families to try."
72 :type
'(repeat (repeat string
))
73 :group
'font-selection
74 :set
#'(lambda (symbol value
)
75 (set-default symbol value
)
76 (internal-set-alternative-font-family-alist value
)))
79 ;; This is defined originally in xfaces.c.
80 (defcustom face-font-registry-alternatives
81 (if (eq system-type
'windows-nt
)
82 '(("iso8859-1" "ms-oemlatin")
83 ("gb2312.1980" "gb2312")
84 ("jisx0208.1990" "jisx0208.1983" "jisx0208.1978")
85 ("ksc5601.1989" "ksx1001.1992" "ksc5601.1987")
86 ("muletibetan-2" "muletibetan-0"))
87 '(("gb2312.1980" "gb2312.80&gb8565.88" "gbk*")
88 ("jisx0208.1990" "jisx0208.1983" "jisx0208.1978")
89 ("ksc5601.1989" "ksx1001.1992" "ksc5601.1987")
90 ("muletibetan-2" "muletibetan-0")))
91 "*Alist of alternative font registry names.
92 Each element has the form (REGISTRY ALTERNATIVE1 ALTERNATIVE2 ...).
93 If fonts of registry REGISTRY can be loaded, font selection
94 tries to find a best matching font among all fonts of registry
95 REGISTRY, ALTERNATIVE1, ALTERNATIVE2, and etc."
96 :tag
"Alternative font registries to try."
97 :type
'(repeat (repeat string
))
99 :group
'font-selection
100 :set
#'(lambda (symbol value
)
101 (set-default symbol value
)
102 (internal-set-alternative-font-registry-alist value
)))
106 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
107 ;;; Creation, copying.
108 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
112 "Return a list of all defined face names."
113 (mapcar #'car face-new-frame-defaults
))
116 ;;; ### If not frame-local initialize by what X resources?
118 (defun make-face (face &optional no-init-from-resources
)
119 "Define a new face with name FACE, a symbol.
120 NO-INIT-FROM-RESOURCES non-nil means don't initialize frame-local
121 variants of FACE from X resources. (X resources recognized are found
122 in the global variable `face-x-resources'.) If FACE is already known
123 as a face, leave it unmodified. Value is FACE."
124 (interactive "SMake face: ")
126 ;; Make frame-local faces (this also makes the global one).
127 (dolist (frame (frame-list))
128 (internal-make-lisp-face face frame
))
129 ;; Add the face to the face menu.
130 (when (fboundp 'facemenu-add-new-face
)
131 (facemenu-add-new-face face
))
132 ;; Define frame-local faces for all frames from X resources.
133 (unless no-init-from-resources
134 (make-face-x-resource-internal face
)))
138 (defun make-empty-face (face)
139 "Define a new, empty face with name FACE.
140 If the face already exists, it is left unmodified. Value is FACE."
141 (interactive "SMake empty face: ")
142 (make-face face
'no-init-from-resources
))
145 (defun copy-face (old-face new-face
&optional frame new-frame
)
146 "Define a face just like OLD-FACE, with name NEW-FACE.
148 If NEW-FACE already exists as a face, it is modified to be like
149 OLD-FACE. If it doesn't already exist, it is created.
151 If the optional argument FRAME is given as a frame, NEW-FACE is
152 changed on FRAME only.
153 If FRAME is t, the frame-independent default specification for OLD-FACE
154 is copied to NEW-FACE.
155 If FRAME is nil, copying is done for the frame-independent defaults
156 and for each existing frame.
158 If the optional fourth argument NEW-FRAME is given,
159 copy the information from face OLD-FACE on frame FRAME
160 to NEW-FACE on frame NEW-FRAME."
161 (let ((inhibit-quit t
))
164 (dolist (frame (frame-list))
165 (copy-face old-face new-face frame
))
166 (copy-face old-face new-face t
))
167 (internal-copy-lisp-face old-face new-face frame new-frame
))
172 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
173 ;;; Obsolete functions
174 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
176 ;; The functions in this section are defined because Lisp packages use
177 ;; them, despite the prefix `internal-' suggesting that they are
178 ;; private to the face implementation.
180 (defun internal-find-face (name &optional frame
)
181 "Retrieve the face named NAME.
182 Return nil if there is no such face.
183 If the optional argument FRAME is given, this gets the face NAME for
184 that frame; otherwise, it uses the selected frame.
185 If FRAME is the symbol t, then the global, non-frame face is returned.
186 If NAME is already a face, it is simply returned.
188 This function is defined for compatibility with Emacs 20.2. It
189 should not be used anymore."
191 (make-obsolete 'internal-find-face
'facep
"21.1")
194 (defun internal-get-face (name &optional frame
)
195 "Retrieve the face named NAME; error if there is none.
196 If the optional argument FRAME is given, this gets the face NAME for
197 that frame; otherwise, it uses the selected frame.
198 If FRAME is the symbol t, then the global, non-frame face is returned.
199 If NAME is already a face, it is simply returned.
201 This function is defined for compatibility with Emacs 20.2. It
202 should not be used anymore."
205 (make-obsolete 'internal-get-face
"See `facep' and `check-face'." "21.1")
208 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
209 ;;; Predicates, type checks.
210 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
213 "Return non-nil if FACE is a face name."
214 (internal-lisp-face-p face
))
217 (defun check-face (face)
218 "Signal an error if FACE doesn't name a face.
221 (error "Not a face: %s" face
))
225 ;; The ID returned is not to be confused with the internally used IDs
226 ;; of realized faces. The ID assigned to Lisp faces is used to
227 ;; support faces in display table entries.
229 (defun face-id (face &optional frame
)
230 "Return the interNal ID of face with name FACE.
231 If optional argument FRAME is nil or omitted, use the selected frame."
236 (defun face-equal (face1 face2
&optional frame
)
237 "Non-nil if faces FACE1 and FACE2 are equal.
238 Faces are considered equal if all their attributes are equal.
239 If the optional argument FRAME is given, report on face FACE in that frame.
240 If FRAME is t, report on the defaults for face FACE (for new frames).
241 If FRAME is omitted or nil, use the selected frame."
242 (internal-lisp-face-equal-p face1 face2 frame
))
245 (defun face-differs-from-default-p (face &optional frame
)
246 "Non-nil if FACE displays differently from the default face.
247 If the optional argument FRAME is given, report on face FACE in that frame.
248 If FRAME is t, report on the defaults for face FACE (for new frames).
249 If FRAME is omitted or nil, use the selected frame.
250 A face is considered to be ``the same'' as the default face if it is
251 actually specified in the same way (equal attributes) or if it is
252 fully-unspecified, and thus inherits the attributes of any face it
253 is displayed on top of."
254 (cond ((eq frame t
) (setq frame nil
))
255 ((null frame
) (setq frame
(selected-frame))))
256 (let* ((v1 (internal-lisp-face-p face frame
))
257 (n (if v1
(length v1
) 0))
258 (v2 (internal-lisp-face-p 'default frame
))
261 (error "Not a face: %S" face
))
263 (or (eq 'unspecified
(aref v1 i
))
264 (equal (aref v1 i
) (aref v2 i
))))
269 (defun face-nontrivial-p (face &optional frame
)
270 "True if face FACE has some non-nil attribute.
271 If the optional argument FRAME is given, report on face FACE in that frame.
272 If FRAME is t, report on the defaults for face FACE (for new frames).
273 If FRAME is omitted or nil, use the selected frame."
274 (not (internal-lisp-face-empty-p face frame
)))
278 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
279 ;;; Setting face attributes from X resources.
280 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
282 (defcustom face-x-resources
283 '((:family
(".attributeFamily" .
"Face.AttributeFamily"))
284 (:width
(".attributeWidth" .
"Face.AttributeWidth"))
285 (:height
(".attributeHeight" .
"Face.AttributeHeight"))
286 (:weight
(".attributeWeight" .
"Face.AttributeWeight"))
287 (:slant
(".attributeSlant" .
"Face.AttributeSlant"))
288 (:foreground
(".attributeForeground" .
"Face.AttributeForeground"))
289 (:background
(".attributeBackground" .
"Face.AttributeBackground"))
290 (:overline
(".attributeOverline" .
"Face.AttributeOverline"))
291 (:strike-through
(".attributeStrikeThrough" .
"Face.AttributeStrikeThrough"))
292 (:box
(".attributeBox" .
"Face.AttributeBox"))
293 (:underline
(".attributeUnderline" .
"Face.AttributeUnderline"))
294 (:inverse-video
(".attributeInverse" .
"Face.AttributeInverse"))
296 (".attributeStipple" .
"Face.AttributeStipple")
297 (".attributeBackgroundPixmap" .
"Face.AttributeBackgroundPixmap"))
298 (:bold
(".attributeBold" .
"Face.AttributeBold"))
299 (:italic
(".attributeItalic" .
"Face.AttributeItalic"))
300 (:font
(".attributeFont" .
"Face.AttributeFont"))
301 (:inherit
(".attributeInherit" .
"Face.AttributeInherit")))
302 "*List of X resources and classes for face attributes.
303 Each element has the form (ATTRIBUTE ENTRY1 ENTRY2...) where ATTRIBUTE is
304 the name of a face attribute, and each ENTRY is a cons of the form
305 \(RESOURCE . CLASS) with RESOURCE being the resource and CLASS being the
306 X resource class for the attribute."
307 :type
'(repeat (cons symbol
(repeat (cons string string
))))
311 (defun set-face-attribute-from-resource (face attribute resource class frame
)
312 "Set FACE's ATTRIBUTE from X resource RESOURCE, class CLASS on FRAME.
313 Value is the attribute value specified by the resource, or nil
314 if not present. This function displays a message if the resource
315 specifies an invalid attribute."
316 (let* ((face-name (face-name face
))
317 (value (internal-face-x-get-resource (concat face-name resource
)
321 (internal-set-lisp-face-attribute-from-resource
322 face attribute
(downcase value
) frame
)
324 (message "Face %s, frame %s: invalid attribute %s %s from X resource"
325 face-name frame attribute value
))))
329 (defun set-face-attributes-from-resources (face frame
)
330 "Set attributes of FACE from X resources for FRAME."
331 (when (memq (framep frame
) '(x w32 mac
))
332 (dolist (definition face-x-resources
)
333 (let ((attribute (car definition
)))
334 (dolist (entry (cdr definition
))
335 (set-face-attribute-from-resource face attribute
(car entry
)
336 (cdr entry
) frame
))))))
339 (defun make-face-x-resource-internal (face &optional frame
)
340 "Fill frame-local FACE on FRAME from X resources.
341 FRAME nil or not specified means do it for all frames."
343 (dolist (frame (frame-list))
344 (set-face-attributes-from-resources face frame
))
345 (set-face-attributes-from-resources face frame
)))
349 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
350 ;;; Retrieving face attributes.
351 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
353 (defun face-name (face)
354 "Return the name of face FACE."
355 (symbol-name (check-face face
)))
358 (defun face-attribute (face attribute
&optional frame inherit
)
359 "Return the value of FACE's ATTRIBUTE on FRAME.
360 If the optional argument FRAME is given, report on face FACE in that frame.
361 If FRAME is t, report on the defaults for face FACE (for new frames).
362 If FRAME is omitted or nil, use the selected frame.
364 If INHERIT is nil, only attributes directly defined by FACE are considered,
365 so the return value may be `unspecified', or a relative value.
366 If INHERIT is non-nil, FACE's definition of ATTRIBUTE is merged with the
367 faces specified by its `:inherit' attribute; however the return value
368 may still be `unspecified' or relative.
369 If INHERIT is a face or a list of faces, then the result is further merged
370 with that face (or faces), until it becomes specified and absolute.
372 To ensure that the return value is always specified and absolute, use a
373 value of `default' for INHERIT; this will resolve any unspecified or
374 relative values by merging with the `default' face (which is always
375 completely specified)."
376 (let ((value (internal-get-lisp-face-attribute face attribute frame
)))
377 (when (and inherit
(face-attribute-relative-p attribute value
))
378 ;; VALUE is relative, so merge with inherited faces
379 (let ((inh-from (face-attribute face
:inherit frame
)))
380 (unless (or (null inh-from
) (eq inh-from
'unspecified
))
382 (face-attribute-merged-with attribute value inh-from frame
)))))
385 (face-attribute-relative-p attribute value
))
386 ;; We should merge with INHERIT as well
387 (setq value
(face-attribute-merged-with attribute value inherit frame
)))
390 (defun face-attribute-merged-with (attribute value faces
&optional frame
)
391 "Merges ATTRIBUTE, initially VALUE, with faces from FACES until absolute.
392 FACES may be either a single face or a list of faces.
393 \[This is an internal function]"
394 (cond ((not (face-attribute-relative-p attribute value
))
399 (face-attribute-merged-with
401 (face-attribute-merged-with attribute value
(car faces
) frame
)
405 (merge-face-attribute attribute
407 (face-attribute faces attribute frame t
)))))
410 (defmacro face-attribute-specified-or
(value &rest body
)
411 "Return VALUE, unless it's `unspecified', in which case evaluate BODY and return the result."
412 (let ((temp (make-symbol "value")))
413 `(let ((,temp
,value
))
414 (if (not (eq ,temp
'unspecified
))
418 (defun face-foreground (face &optional frame inherit
)
419 "Return the foreground color name of FACE, or nil if unspecified.
420 If the optional argument FRAME is given, report on face FACE in that frame.
421 If FRAME is t, report on the defaults for face FACE (for new frames).
422 If FRAME is omitted or nil, use the selected frame.
424 If INHERIT is nil, only a foreground color directly defined by FACE is
425 considered, so the return value may be nil.
426 If INHERIT is t, and FACE doesn't define a foreground color, then any
427 foreground color that FACE inherits through its `:inherit' attribute
428 is considered as well; however the return value may still be nil.
429 If INHERIT is a face or a list of faces, then it is used to try to
430 resolve an unspecified foreground color.
432 To ensure that a valid color is always returned, use a value of
433 `default' for INHERIT; this will resolve any unspecified values by
434 merging with the `default' face (which is always completely specified)."
435 (face-attribute-specified-or (face-attribute face
:foreground frame inherit
)
438 (defun face-background (face &optional frame inherit
)
439 "Return the background color name of FACE, or nil if unspecified.
440 If the optional argument FRAME is given, report on face FACE in that frame.
441 If FRAME is t, report on the defaults for face FACE (for new frames).
442 If FRAME is omitted or nil, use the selected frame.
444 If INHERIT is nil, only a background color directly defined by FACE is
445 considered, so the return value may be nil.
446 If INHERIT is t, and FACE doesn't define a background color, then any
447 background color that FACE inherits through its `:inherit' attribute
448 is considered as well; however the return value may still be nil.
449 If INHERIT is a face or a list of faces, then it is used to try to
450 resolve an unspecified background color.
452 To ensure that a valid color is always returned, use a value of
453 `default' for INHERIT; this will resolve any unspecified values by
454 merging with the `default' face (which is always completely specified)."
455 (face-attribute-specified-or (face-attribute face
:background frame inherit
)
458 (defun face-stipple (face &optional frame inherit
)
459 "Return the stipple pixmap name of FACE, or nil if unspecified.
460 If the optional argument FRAME is given, report on face FACE in that frame.
461 If FRAME is t, report on the defaults for face FACE (for new frames).
462 If FRAME is omitted or nil, use the selected frame.
464 If INHERIT is nil, only a stipple directly defined by FACE is
465 considered, so the return value may be nil.
466 If INHERIT is t, and FACE doesn't define a stipple, then any stipple
467 that FACE inherits through its `:inherit' attribute is considered as
468 well; however the return value may still be nil.
469 If INHERIT is a face or a list of faces, then it is used to try to
470 resolve an unspecified stipple.
472 To ensure that a valid stipple or nil is always returned, use a value of
473 `default' for INHERIT; this will resolve any unspecified values by merging
474 with the `default' face (which is always completely specified)."
475 (face-attribute-specified-or (face-attribute face
:stipple frame inherit
)
479 (defalias 'face-background-pixmap
'face-stipple
)
482 (defun face-underline-p (face &optional frame
)
483 "Return non-nil if FACE is underlined.
484 If the optional argument FRAME is given, report on face FACE in that frame.
485 If FRAME is t, report on the defaults for face FACE (for new frames).
486 If FRAME is omitted or nil, use the selected frame."
487 (eq (face-attribute face
:underline frame
) t
))
490 (defun face-inverse-video-p (face &optional frame
)
491 "Return non-nil if FACE is in inverse video on FRAME.
492 If the optional argument FRAME is given, report on face FACE in that frame.
493 If FRAME is t, report on the defaults for face FACE (for new frames).
494 If FRAME is omitted or nil, use the selected frame."
495 (eq (face-attribute face
:inverse-video frame
) t
))
498 (defun face-bold-p (face &optional frame
)
499 "Return non-nil if the font of FACE is bold on FRAME.
500 If the optional argument FRAME is given, report on face FACE in that frame.
501 If FRAME is t, report on the defaults for face FACE (for new frames).
502 If FRAME is omitted or nil, use the selected frame.
503 Use `face-attribute' for finer control."
504 (let ((bold (face-attribute face
:weight frame
)))
505 (memq bold
'(semi-bold bold extra-bold ultra-bold
))))
508 (defun face-italic-p (face &optional frame
)
509 "Return non-nil if the font of FACE is italic on FRAME.
510 If the optional argument FRAME is given, report on face FACE in that frame.
511 If FRAME is t, report on the defaults for face FACE (for new frames).
512 If FRAME is omitted or nil, use the selected frame.
513 Use `face-attribute' for finer control."
514 (let ((italic (face-attribute face
:slant frame
)))
515 (memq italic
'(italic oblique
))))
519 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
520 ;;; Face documentation.
521 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
523 (defun face-documentation (face)
524 "Get the documentation string for FACE."
525 (get face
'face-documentation
))
528 (defun set-face-documentation (face string
)
529 "Set the documentation string for FACE to STRING."
530 ;; Perhaps the text should go in DOC.
531 (put face
'face-documentation
(purecopy string
)))
534 (defalias 'face-doc-string
'face-documentation
)
535 (defalias 'set-face-doc-string
'set-face-documentation
)
539 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
540 ;; Setting face attributes.
541 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
544 (defun set-face-attribute (face frame
&rest args
)
545 "Set attributes of FACE on FRAME from ARGS.
547 FRAME nil means change attributes on all frames. FRAME t means change
548 the default for new frames (this is done automatically each time an
549 attribute is changed on all frames).
551 ARGS must come in pairs ATTRIBUTE VALUE. ATTRIBUTE must be a valid
552 face attribute name. All attributes can be set to `unspecified';
553 this fact is not further mentioned below.
555 The following attributes are recognized:
559 VALUE must be a string specifying the font family, e.g. ``courier'',
560 or a fontset alias name. If a font family is specified, wild-cards `*'
565 VALUE specifies the relative proportionate width of the font to use.
566 It must be one of the symbols `ultra-condensed', `extra-condensed',
567 `condensed', `semi-condensed', `normal', `semi-expanded', `expanded',
568 `extra-expanded', or `ultra-expanded'.
572 VALUE must be either an integer specifying the height of the font to use
573 in 1/10 pt, a floating point number specifying the amount by which to
574 scale any underlying face, or a function, which is called with the old
575 height (from the underlying face), and should return the new height.
579 VALUE specifies the weight of the font to use. It must be one of the
580 symbols `ultra-bold', `extra-bold', `bold', `semi-bold', `normal',
581 `semi-light', `light', `extra-light', `ultra-light'.
585 VALUE specifies the slant of the font to use. It must be one of the
586 symbols `italic', `oblique', `normal', `reverse-italic', or
589 `:foreground', `:background'
591 VALUE must be a color name, a string.
595 VALUE specifies whether characters in FACE should be underlined. If
596 VALUE is t, underline with foreground color of the face. If VALUE is
597 a string, underline with that color. If VALUE is nil, explicitly
602 VALUE specifies whether characters in FACE should be overlined. If
603 VALUE is t, overline with foreground color of the face. If VALUE is a
604 string, overline with that color. If VALUE is nil, explicitly don't
609 VALUE specifies whether characters in FACE should be drawn with a line
610 striking through them. If VALUE is t, use the foreground color of the
611 face. If VALUE is a string, strike-through with that color. If VALUE
612 is nil, explicitly don't strike through.
616 VALUE specifies whether characters in FACE should have a box drawn
617 around them. If VALUE is nil, explicitly don't draw boxes. If
618 VALUE is t, draw a box with lines of width 1 in the foreground color
619 of the face. If VALUE is a string, the string must be a color name,
620 and the box is drawn in that color with a line width of 1. Otherwise,
621 VALUE must be a property list of the form `(:line-width WIDTH
622 :color COLOR :style STYLE)'. If a keyword/value pair is missing from
623 the property list, a default value will be used for the value, as
624 specified below. WIDTH specifies the width of the lines to draw; it
625 defaults to 1. If WIDTH is negative, the absolute value is the width
626 of the lines, and draw top/bottom lines inside the characters area,
627 not around it. COLOR is the name of the color to draw in, default is
628 the foreground color of the face for simple boxes, and the background
629 color of the face for 3D boxes. STYLE specifies whether a 3D box
630 should be draw. If STYLE is `released-button', draw a box looking
631 like a released 3D button. If STYLE is `pressed-button' draw a box
632 that appears like a pressed button. If STYLE is nil, the default if
633 the property list doesn't contain a style specification, draw a 2D
638 VALUE specifies whether characters in FACE should be displayed in
639 inverse video. VALUE must be one of t or nil.
643 If VALUE is a string, it must be the name of a file of pixmap data.
644 The directories listed in the `x-bitmap-file-path' variable are
645 searched. Alternatively, VALUE may be a list of the form (WIDTH
646 HEIGHT DATA) where WIDTH and HEIGHT are the size in pixels, and DATA
647 is a string containing the raw bits of the bitmap. VALUE nil means
648 explicitly don't use a stipple pattern.
650 For convenience, attributes `:family', `:width', `:height', `:weight',
651 and `:slant' may also be set in one step from an X font name:
655 Set font-related face attributes from VALUE. VALUE must be a valid
656 XLFD font name. If it is a font name pattern, the first matching font
659 For compatibility with Emacs 20, keywords `:bold' and `:italic' can
660 be used to specify that a bold or italic font should be used. VALUE
661 must be t or nil in that case. A value of `unspecified' is not allowed.
665 VALUE is the name of a face from which to inherit attributes, or a list
666 of face names. Attributes from inherited faces are merged into the face
667 like an underlying face would be, with higher priority than underlying faces."
668 (let ((where (if (null frame
) 0 frame
)))
669 (setq args
(purecopy args
))
671 (internal-set-lisp-face-attribute face
(car args
)
672 (purecopy (cadr args
))
674 (setq args
(cdr (cdr args
))))))
677 (defun make-face-bold (face &optional frame noerror
)
678 "Make the font of FACE be bold, if possible.
679 FRAME nil or not specified means change face on all frames.
680 Argument NOERROR is ignored and retained for compatibility.
681 Use `set-face-attribute' for finer control of the font weight."
682 (interactive (list (read-face-name "Make which face bold")))
683 (set-face-attribute face frame
:weight
'bold
))
686 (defun make-face-unbold (face &optional frame noerror
)
687 "Make the font of FACE be non-bold, if possible.
688 FRAME nil or not specified means change face on all frames.
689 Argument NOERROR is ignored and retained for compatibility."
690 (interactive (list (read-face-name "Make which face non-bold")))
691 (set-face-attribute face frame
:weight
'normal
))
694 (defun make-face-italic (face &optional frame noerror
)
695 "Make the font of FACE be italic, if possible.
696 FRAME nil or not specified means change face on all frames.
697 Argument NOERROR is ignored and retained for compatibility.
698 Use `set-face-attribute' for finer control of the font slant."
699 (interactive (list (read-face-name "Make which face italic")))
700 (set-face-attribute face frame
:slant
'italic
))
703 (defun make-face-unitalic (face &optional frame noerror
)
704 "Make the font of FACE be non-italic, if possible.
705 FRAME nil or not specified means change face on all frames.
706 Argument NOERROR is ignored and retained for compatibility."
707 (interactive (list (read-face-name "Make which face non-italic")))
708 (set-face-attribute face frame
:slant
'normal
))
711 (defun make-face-bold-italic (face &optional frame noerror
)
712 "Make the font of FACE be bold and italic, if possible.
713 FRAME nil or not specified means change face on all frames.
714 Argument NOERROR is ignored and retained for compatibility.
715 Use `set-face-attribute' for finer control of font weight and slant."
716 (interactive (list (read-face-name "Make which face bold-italic")))
717 (set-face-attribute face frame
:weight
'bold
:slant
'italic
))
720 (defun set-face-font (face font
&optional frame
)
721 "Change font-related attributes of FACE to those of FONT (a string).
722 FRAME nil or not specified means change face on all frames.
723 This sets the attributes `:family', `:width', `:height', `:weight',
724 and `:slant'. When called interactively, prompt for the face and font."
725 (interactive (read-face-and-attribute :font
))
726 (set-face-attribute face frame
:font font
))
729 ;; Implementation note: Emulating gray background colors with a
730 ;; stipple pattern is now part of the face realization process, and is
731 ;; done in C depending on the frame on which the face is realized.
733 (defun set-face-background (face color
&optional frame
)
734 "Change the background color of face FACE to COLOR (a string).
735 FRAME nil or not specified means change face on all frames.
736 When called interactively, prompt for the face and color."
737 (interactive (read-face-and-attribute :background
))
738 (set-face-attribute face frame
:background
(or color
'unspecified
)))
741 (defun set-face-foreground (face color
&optional frame
)
742 "Change the foreground color of face FACE to COLOR (a string).
743 FRAME nil or not specified means change face on all frames.
744 When called interactively, prompt for the face and color."
745 (interactive (read-face-and-attribute :foreground
))
746 (set-face-attribute face frame
:foreground
(or color
'unspecified
)))
749 (defun set-face-stipple (face stipple
&optional frame
)
750 "Change the stipple pixmap of face FACE to STIPPLE.
751 FRAME nil or not specified means change face on all frames.
752 STIPPLE should be a string, the name of a file of pixmap data.
753 The directories listed in the `x-bitmap-file-path' variable are searched.
755 Alternatively, STIPPLE may be a list of the form (WIDTH HEIGHT DATA)
756 where WIDTH and HEIGHT are the size in pixels,
757 and DATA is a string, containing the raw bits of the bitmap."
758 (interactive (read-face-and-attribute :stipple
))
759 (set-face-attribute face frame
:stipple
(or stipple
'unspecified
)))
762 (defun set-face-underline (face underline
&optional frame
)
763 "Specify whether face FACE is underlined.
764 UNDERLINE nil means FACE explicitly doesn't underline.
765 UNDERLINE non-nil means FACE explicitly does underlining
766 with the same of the foreground color.
767 If UNDERLINE is a string, underline with the color named UNDERLINE.
768 FRAME nil or not specified means change face on all frames.
769 Use `set-face-attribute' to ``unspecify'' underlining."
771 (let ((list (read-face-and-attribute :underline
)))
772 (list (car list
) (eq (car (cdr list
)) t
))))
773 (set-face-attribute face frame
:underline underline
))
776 (defun set-face-underline-p (face underline-p
&optional frame
)
777 "Specify whether face FACE is underlined.
778 UNDERLINE-P nil means FACE explicitly doesn't underline.
779 UNDERLINE-P non-nil means FACE explicitly does underlining.
780 FRAME nil or not specified means change face on all frames.
781 Use `set-face-attribute' to ``unspecify'' underlining."
783 (let ((list (read-face-and-attribute :underline
)))
784 (list (car list
) (eq (car (cdr list
)) t
))))
785 (set-face-attribute face frame
:underline underline-p
))
788 (defun set-face-inverse-video-p (face inverse-video-p
&optional frame
)
789 "Specify whether face FACE is in inverse video.
790 INVERSE-VIDEO-P non-nil means FACE displays explicitly in inverse video.
791 INVERSE-VIDEO-P nil means FACE explicitly is not in inverse video.
792 FRAME nil or not specified means change face on all frames.
793 Use `set-face-attribute' to ``unspecify'' the inverse video attribute."
795 (let ((list (read-face-and-attribute :inverse-video
)))
796 (list (car list
) (eq (car (cdr list
)) t
))))
797 (set-face-attribute face frame
:inverse-video inverse-video-p
))
800 (defun set-face-bold-p (face bold-p
&optional frame
)
801 "Specify whether face FACE is bold.
802 BOLD-P non-nil means FACE should explicitly display bold.
803 BOLD-P nil means FACE should explicitly display non-bold.
804 FRAME nil or not specified means change face on all frames.
805 Use `set-face-attribute' or `modify-face' for finer control."
807 (make-face-unbold face frame
)
808 (make-face-bold face frame
)))
811 (defun set-face-italic-p (face italic-p
&optional frame
)
812 "Specify whether face FACE is italic.
813 ITALIC-P non-nil means FACE should explicitly display italic.
814 ITALIC-P nil means FACE should explicitly display non-italic.
815 FRAME nil or not specified means change face on all frames.
816 Use `set-face-attribute' or `modify-face' for finer control."
818 (make-face-unitalic face frame
)
819 (make-face-italic face frame
)))
822 (defalias 'set-face-background-pixmap
'set-face-stipple
)
825 (defun invert-face (face &optional frame
)
826 "Swap the foreground and background colors of FACE.
827 If FRAME is omitted or nil, it means change face on all frames.
828 If FACE specifies neither foreground nor background color,
829 set its foreground and background to the background and foreground
830 of the default face. Value is FACE."
831 (interactive (list (read-face-name "Invert face")))
832 (let ((fg (face-attribute face
:foreground frame
))
833 (bg (face-attribute face
:background frame
)))
834 (if (not (and (eq fg
'unspecified
) (eq bg
'unspecified
)))
835 (set-face-attribute face frame
:foreground bg
:background fg
)
836 (set-face-attribute face frame
838 (face-attribute 'default
:background frame
)
840 (face-attribute 'default
:foreground frame
))))
844 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
845 ;;; Interactively modifying faces.
846 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
848 (defun read-face-name (prompt &optional string-describing-default multiple
)
849 "Read a face, defaulting to the face or faces on the char after point.
850 If it has a `read-face-name' property, that overrides the `face' property.
851 PROMPT describes what you will do with the face (don't end in a space).
852 STRING-DESCRIBING-DEFAULT describes what default you will use
853 if this function returns nil.
854 If MULTIPLE is non-nil, return a list of faces (possibly only one).
855 Otherwise, return a single face."
856 (let ((faceprop (or (get-char-property (point) 'read-face-name
)
857 (get-char-property (point) 'face
)))
859 ;; Make a list of the named faces that the `face' property uses.
864 (if (symbolp faceprop
)
865 (setq faces
(list faceprop
))))
866 ;; If there are none, try to get a face name from the buffer.
867 (if (and (null faces
)
868 (memq (intern-soft (thing-at-point 'symbol
)) (face-list)))
869 (setq faces
(list (intern-soft (thing-at-point 'symbol
)))))
871 ;; If we only want one, and the default is more than one,
872 ;; discard the unwanted ones now.
875 (setq faces
(list (car faces
)))))
879 (if (or faces string-describing-default
)
880 (format "%s (default %s): " prompt
881 (if faces
(mapconcat 'symbol-name faces
", ")
882 string-describing-default
))
883 (format "%s: " prompt
))
884 obarray
'custom-facep t
))
885 ;; Canonicalize the output.
890 (list (intern input
))
892 ;; Return either a list of faces or just one face.
898 (defun face-valid-attribute-values (attribute &optional frame
)
899 "Return valid values for face attribute ATTRIBUTE.
900 The optional argument FRAME is used to determine available fonts
901 and colors. If it is nil or not specified, the selected frame is
902 used. Value is an alist of (NAME . VALUE) if ATTRIBUTE expects a value
903 out of a set of discrete values. Value is `integerp' if ATTRIBUTE expects
909 (mapcar #'(lambda (x) (cons (car x
) (car x
)))
910 (x-font-family-list))
911 ;; Only one font on TTYs.
912 (list (cons "default" "default"))))
913 ((:width
:weight
:slant
:inverse-video
)
914 (mapcar #'(lambda (x) (cons (symbol-name x
) x
))
915 (internal-lisp-face-attribute-values attribute
)))
916 ((:underline
:overline
:strike-through
:box
)
918 (nconc (mapcar #'(lambda (x) (cons (symbol-name x
) x
))
919 (internal-lisp-face-attribute-values attribute
))
920 (mapcar #'(lambda (c) (cons c c
))
921 (x-defined-colors frame
)))
922 (mapcar #'(lambda (x) (cons (symbol-name x
) x
))
923 (internal-lisp-face-attribute-values attribute
))))
924 ((:foreground
:background
)
925 (mapcar #'(lambda (c) (cons c c
))
926 (defined-colors frame
)))
930 (and (memq window-system
'(x w32 mac
))
933 (mapcar (lambda (dir)
934 (and (file-readable-p dir
)
935 (file-directory-p dir
)
936 (directory-files dir
)))
937 x-bitmap-file-path
)))))
939 (cons '("none" . nil
)
940 (mapcar #'(lambda (c) (cons (symbol-name c
) c
))
943 (error "Internal error")))))
944 (if (and (listp valid
) (not (memq attribute
'(:inherit
))))
945 (nconc (list (cons "unspecified" 'unspecified
)) valid
)
949 (defvar face-attribute-name-alist
950 '((:family .
"font family")
951 (:width .
"character set width")
952 (:height .
"height in 1/10 pt")
955 (:underline .
"underline")
956 (:overline .
"overline")
957 (:strike-through .
"strike-through")
959 (:inverse-video .
"inverse-video display")
960 (:foreground .
"foreground color")
961 (:background .
"background color")
962 (:stipple .
"background stipple")
963 (:inherit .
"inheritance"))
964 "An alist of descriptive names for face attributes.
965 Each element has the form (ATTRIBUTE-NAME . DESCRIPTION) where
966 ATTRIBUTE-NAME is a face attribute name (a keyword symbol), and
967 DESCRIPTION is a descriptive name for ATTRIBUTE-NAME.")
970 (defun face-descriptive-attribute-name (attribute)
971 "Return a descriptive name for ATTRIBUTE."
972 (cdr (assq attribute face-attribute-name-alist
)))
975 (defun face-read-string (face default name
&optional completion-alist
)
976 "Interactively read a face attribute string value.
977 FACE is the face whose attribute is read. If non-nil, DEFAULT is the
978 default string to return if no new value is entered. NAME is a
979 descriptive name of the attribute for prompting. COMPLETION-ALIST is an
980 alist of valid values, if non-nil.
982 Entering nothing accepts the default string DEFAULT.
983 Value is the new attribute value."
984 ;; Capitalize NAME (we don't use `capitalize' because that capitalizes
985 ;; each word in a string separately).
986 (setq name
(concat (upcase (substring name
0 1)) (substring name
1)))
987 (let* ((completion-ignore-case t
)
988 (value (completing-read
990 (format "%s for face `%s' (default %s): "
992 (format "%s for face `%s': " name face
))
994 (if (equal value
"") default value
)))
997 (defun face-read-integer (face default name
)
998 "Interactively read an integer face attribute value.
999 FACE is the face whose attribute is read. DEFAULT is the default
1000 value to return if no new value is entered. NAME is a descriptive
1001 name of the attribute for prompting. Value is the new attribute value."
1003 (face-read-string face
1004 (format "%s" default
)
1006 (list (cons "unspecified" 'unspecified
)))))
1007 (cond ((equal new-value
"unspecified")
1009 ((member new-value
'("unspecified-fg" "unspecified-bg"))
1012 (string-to-int new-value
)))))
1015 (defun read-face-attribute (face attribute
&optional frame
)
1016 "Interactively read a new value for FACE's ATTRIBUTE.
1017 Optional argument FRAME nil or unspecified means read an attribute value
1018 of a global face. Value is the new attribute value."
1019 (let* ((old-value (face-attribute face attribute frame
))
1020 (attribute-name (face-descriptive-attribute-name attribute
))
1021 (valid (face-valid-attribute-values attribute frame
))
1023 ;; Represent complex attribute values as strings by printing them
1024 ;; out. Stipple can be a vector; (WIDTH HEIGHT DATA). Box can be
1025 ;; a list `(:width WIDTH :color COLOR)' or `(:width WIDTH :shadow
1027 (when (and (or (eq attribute
:stipple
)
1028 (eq attribute
:box
))
1029 (or (consp old-value
)
1030 (vectorp old-value
)))
1031 (setq old-value
(prin1-to-string old-value
)))
1032 (cond ((listp valid
)
1034 (or (car (rassoc old-value valid
))
1035 (format "%s" old-value
))))
1037 (face-read-string face default attribute-name valid
))
1038 (if (equal new-value default
)
1039 ;; Nothing changed, so don't bother with all the stuff
1040 ;; below. In particular, this avoids a non-tty color
1041 ;; from being canonicalized for a tty when the user
1042 ;; just uses the default.
1043 (setq new-value old-value
)
1044 ;; Terminal frames can support colors that don't appear
1045 ;; explicitly in VALID, using color approximation code
1046 ;; in tty-colors.el.
1047 (when (and (memq attribute
'(:foreground
:background
))
1048 (not (memq window-system
'(x w32 mac
)))
1049 (not (member new-value
1051 "unspecified-fg" "unspecified-bg"))))
1052 (setq new-value
(car (tty-color-desc new-value frame
))))
1053 (when (assoc new-value valid
)
1054 (setq new-value
(cdr (assoc new-value valid
)))))))
1055 ((eq valid
'integerp
)
1056 (setq new-value
(face-read-integer face old-value attribute-name
)))
1057 (t (error "Internal error")))
1058 ;; Convert stipple and box value text we read back to a list or
1059 ;; vector if it looks like one. This makes the assumption that a
1060 ;; pixmap file name won't start with an open-paren.
1061 (when (and (or (eq attribute
:stipple
)
1062 (eq attribute
:box
))
1064 (string-match "^[[(]" new-value
))
1065 (setq new-value
(read new-value
)))
1069 (defun read-face-font (face &optional frame
)
1070 "Read the name of a font for FACE on FRAME.
1071 If optional argument FRAME Is nil or omitted, use the selected frame."
1072 (let ((completion-ignore-case t
))
1073 (completing-read (format "Set font attributes of face `%s' from font: " face
)
1074 (mapcar 'list
(x-list-fonts "*" nil frame
)))))
1077 (defun read-all-face-attributes (face &optional frame
)
1078 "Interactively read all attributes for FACE.
1079 If optional argument FRAME Is nil or omitted, use the selected frame.
1080 Value is a property list of attribute names and new values."
1082 (dolist (attribute face-attribute-name-alist result
)
1083 (setq result
(cons (car attribute
)
1084 (cons (read-face-attribute face
(car attribute
) frame
)
1087 (defun modify-face (&optional face foreground background stipple
1088 bold-p italic-p underline-p inverse-p frame
)
1089 "Modify attributes of faces interactively.
1090 If optional argument FRAME is nil or omitted, modify the face used
1091 for newly created frame, i.e. the global face.
1092 For non-interactive use, `set-face-attribute' is preferred.
1093 When called from elisp, if FACE is nil, all arguments but FRAME are ignored
1094 and the face and its settings are obtained by querying the user."
1097 (set-face-attribute face frame
1098 :foreground
(or foreground
'unspecified
)
1099 :background
(or background
'unspecified
)
1103 :underline underline-p
1104 :inverse-video inverse-p
)
1105 (setq face
(read-face-name "Modify face"))
1106 (apply #'set-face-attribute face frame
1107 (read-all-face-attributes face frame
))))
1109 (defun read-face-and-attribute (attribute &optional frame
)
1110 "Read face name and face attribute value.
1111 ATTRIBUTE is the attribute whose new value is read.
1112 FRAME nil or unspecified means read attribute value of global face.
1113 Value is a list (FACE NEW-VALUE) where FACE is the face read
1114 \(a symbol), and NEW-VALUE is value read."
1115 (cond ((eq attribute
:font
)
1116 (let* ((prompt "Set font-related attributes of face")
1117 (face (read-face-name prompt
))
1118 (font (read-face-font face frame
)))
1121 (let* ((attribute-name (face-descriptive-attribute-name attribute
))
1122 (prompt (format "Set %s of face" attribute-name
))
1123 (face (read-face-name prompt
))
1124 (new-value (read-face-attribute face attribute frame
)))
1125 (list face new-value
)))))
1129 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1131 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1133 (defvar list-faces-sample-text
1134 "abcdefghijklmnopqrstuvwxyz ABCDEFGHIJKLMNOPQRSTUVWXYZ"
1135 "*Text string to display as the sample text for `list-faces-display'.")
1138 ;; The name list-faces would be more consistent, but let's avoid a
1139 ;; conflict with Lucid, which uses that name differently.
1141 (defun list-faces-display ()
1142 "List all faces, using the same sample text in each.
1143 The sample text is a string that comes from the variable
1144 `list-faces-sample-text'."
1146 (let ((faces (sort (face-list) #'string-lessp
))
1148 (frame (selected-frame))
1149 disp-frame window face-name
)
1150 (with-output-to-temp-buffer "*Faces*"
1152 (set-buffer standard-output
)
1153 (setq truncate-lines t
)
1155 (substitute-command-keys
1158 (if (display-mouse-p) "\\[help-follow-mouse] or ")
1159 "\\[help-follow] on a face name to customize it\n"
1160 "or on its sample text for a description of the face.\n\n")))
1161 (setq help-xref-stack nil
)
1163 (setq face
(car faces
))
1164 (setq faces
(cdr faces
))
1165 (setq face-name
(symbol-name face
))
1166 (insert (format "%25s " face-name
))
1167 ;; Hyperlink to a customization buffer for the face. Using
1168 ;; the help xref mechanism may not be the best way.
1171 (search-backward face-name
)
1172 (help-xref-button 0 'help-customize-face face
)))
1174 (line-beg (line-beginning-position)))
1175 (insert list-faces-sample-text
)
1176 ;; Hyperlink to a help buffer for the face.
1179 (search-backward list-faces-sample-text
)
1180 (help-xref-button 0 'help-face face
)))
1182 (put-text-property beg
(1- (point)) 'face face
)
1183 ;; Make all face commands default to the proper face
1184 ;; anywhere in the line.
1185 (put-text-property line-beg
(1- (point)) 'read-face-name face
)
1186 ;; If the sample text has multiple lines, line up all of them.
1192 (goto-char (point-min)))
1193 (print-help-return-message))
1194 ;; If the *Faces* buffer appears in a different frame,
1195 ;; copy all the face definitions from FRAME,
1196 ;; so that the display will reflect the frame that was selected.
1197 (setq window
(get-buffer-window (get-buffer "*Faces*") t
))
1198 (setq disp-frame
(if window
(window-frame window
)
1199 (car (frame-list))))
1200 (or (eq frame disp-frame
)
1201 (let ((faces (face-list)))
1203 (copy-face (car faces
) (car faces
) frame disp-frame
)
1204 (setq faces
(cdr faces
)))))))
1206 (defun describe-face (face &optional frame
)
1207 "Display the properties of face FACE on FRAME.
1208 Interactively, FACE defaults to the faces of the character after point
1209 and FRAME defaults to the selected frame.
1211 If the optional argument FRAME is given, report on face FACE in that frame.
1212 If FRAME is t, report on the defaults for face FACE (for new frames).
1213 If FRAME is omitted or nil, use the selected frame."
1214 (interactive (list (read-face-name "Describe face" "= `default' face" t
)))
1215 (let* ((attrs '((:family .
"Family")
1217 (:height .
"Height")
1218 (:weight .
"Weight")
1220 (:foreground .
"Foreground")
1221 (:background .
"Background")
1222 (:underline .
"Underline")
1223 (:overline .
"Overline")
1224 (:strike-through .
"Strike-through")
1226 (:inverse-video .
"Inverse")
1227 (:stipple .
"Stipple")
1228 (:font .
"Font or fontset")
1229 (:inherit .
"Inherit")))
1230 (max-width (apply #'max
(mapcar #'(lambda (x) (length (cdr x
)))
1232 (help-setup-xref (list #'describe-face face
) (interactive-p))
1234 (setq face
'default
))
1235 (if (not (listp face
))
1236 (setq face
(list face
)))
1237 (with-output-to-temp-buffer (help-buffer)
1239 (set-buffer standard-output
)
1241 (insert "Face: " (symbol-name f
))
1243 (insert " undefined face.\n")
1244 (let ((customize-label "customize this face"))
1245 (princ (concat " (" customize-label
")\n"))
1246 (insert "Documentation: "
1247 (or (face-documentation f
)
1248 "not documented as a face.")
1250 (with-current-buffer standard-output
1253 (concat "\\(" customize-label
"\\)") nil t
)
1254 (help-xref-button 1 'help-customize-face f
)))
1256 (let ((attr (face-attribute f
(car a
) frame
)))
1257 (insert (make-string (- max-width
(length (cdr a
))) ?\
)
1258 (cdr a
) ": " (format "%s" attr
) "\n")))))
1260 (print-help-return-message))))
1263 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1264 ;;; Face specifications (defface).
1265 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1267 ;; Parameter FRAME Is kept for call compatibility to with previous
1268 ;; face implementation.
1270 (defun face-attr-construct (face &optional frame
)
1271 "Return a defface-style attribute list for FACE on FRAME.
1272 Value is a property list of pairs ATTRIBUTE VALUE for all specified
1273 face attributes of FACE where ATTRIBUTE is the attribute name and
1274 VALUE is the specified value of that attribute."
1276 (dolist (entry face-attribute-name-alist result
)
1277 (let* ((attribute (car entry
))
1278 (value (face-attribute face attribute
)))
1279 (unless (eq value
'unspecified
)
1280 (setq result
(nconc (list attribute value
) result
)))))))
1283 (defun face-spec-set-match-display (display frame
)
1284 "Non-nil if DISPLAY matches FRAME.
1285 DISPLAY is part of a spec such as can be used in `defface'.
1286 If FRAME is nil, the current FRAME is used."
1287 (let* ((conjuncts display
)
1288 conjunct req options
1289 ;; t means we have succeeded against all the conjuncts in
1290 ;; DISPLAY that have been tested so far.
1292 (if (eq conjuncts t
)
1293 (setq conjuncts nil
))
1294 (while (and conjuncts match
)
1295 (setq conjunct
(car conjuncts
)
1296 conjuncts
(cdr conjuncts
)
1298 options
(cdr conjunct
)
1299 match
(cond ((eq req
'type
)
1300 (or (memq window-system options
)
1301 ;; FIXME: This should be revisited to use
1302 ;; display-graphic-p, provided that the
1303 ;; color selection depends on the number
1304 ;; of supported colors, and all defface's
1305 ;; are changed to look at number of colors
1306 ;; instead of (type graphic) etc.
1307 (and (null window-system
)
1308 (memq 'tty options
))
1309 (and (memq 'motif options
)
1311 (and (memq 'lucid options
)
1312 (featurep 'x-toolkit
)
1313 (not (featurep 'motif
)))
1314 (and (memq 'x-toolkit options
)
1315 (featurep 'x-toolkit
))))
1317 (memq (frame-parameter frame
'display-type
) options
))
1318 ((eq req
'background
)
1319 (memq (frame-parameter frame
'background-mode
)
1322 (display-supports-face-attributes-p options frame
))
1323 (t (error "Unknown req `%S' with options `%S'"
1328 (defun face-spec-choose (spec &optional frame
)
1329 "Choose the proper attributes for FRAME, out of SPEC.
1330 If SPEC is nil, return nil."
1332 (setq frame
(selected-frame)))
1336 (let* ((entry (pop tail
))
1337 (display (car entry
))
1338 (attrs (cdr entry
)))
1339 (when (face-spec-set-match-display display frame
)
1340 (setq result
(if (null (cdr attrs
)) ;; was (listp (car attrs))
1341 ;; Old-style entry, the attribute list is the
1346 (setq all result result nil
)
1348 (if all
(append result all
) result
)))
1351 (defun face-spec-reset-face (face &optional frame
)
1352 "Reset all attributes of FACE on FRAME to unspecified."
1353 (let ((attrs face-attribute-name-alist
))
1355 (let ((attr-and-name (car attrs
)))
1356 (set-face-attribute face frame
(car attr-and-name
) 'unspecified
))
1357 (setq attrs
(cdr attrs
)))))
1360 (defun face-spec-set (face spec
&optional frame
)
1361 "Set FACE's attributes according to the first matching entry in SPEC.
1362 FRAME is the frame whose frame-local face is set. FRAME nil means
1363 do it on all frames. See `defface' for information about SPEC.
1364 If SPEC is nil, do nothing."
1365 (let ((attrs (face-spec-choose spec frame
)))
1367 (face-spec-reset-face face frame
))
1369 (let ((attribute (car attrs
))
1370 (value (car (cdr attrs
))))
1371 ;; Support some old-style attribute names and values.
1373 (:bold
(setq attribute
:weight value
(if value
'bold
'normal
)))
1374 (:italic
(setq attribute
:slant value
(if value
'italic
'normal
)))
1375 ((:foreground
:background
)
1376 ;; Compatibility with 20.x. Some bogus face specs seem to
1377 ;; exist containing things like `:foreground nil'.
1378 (if (null value
) (setq value
'unspecified
)))
1379 (t (unless (assq attribute face-x-resources
)
1380 (setq attribute nil
))))
1382 (set-face-attribute face frame attribute value
)))
1383 (setq attrs
(cdr (cdr attrs
))))))
1386 (defun face-attr-match-p (face attrs
&optional frame
)
1387 "Return t if attributes of FACE match values in plist ATTRS.
1388 Optional parameter FRAME is the frame whose definition of FACE
1389 is used. If nil or omitted, use the selected frame."
1391 (setq frame
(selected-frame)))
1392 (let ((list face-attribute-name-alist
)
1394 (while (and match
(not (null list
)))
1395 (let* ((attr (car (car list
)))
1397 (if (plist-member attrs attr
)
1398 (plist-get attrs attr
)
1400 (value-now (face-attribute face attr frame
)))
1401 (setq match
(equal specified-value value-now
))
1402 (setq list
(cdr list
))))
1405 (defun face-spec-match-p (face spec
&optional frame
)
1406 "Return t if FACE, on FRAME, matches what SPEC says it should look like."
1407 (face-attr-match-p face
(face-spec-choose spec frame
) frame
))
1409 (defsubst face-default-spec
(face)
1410 "Return the default face-spec for FACE, ignoring any user customization.
1411 If there is no default for FACE, return nil."
1412 (get face
'face-defface-spec
))
1414 (defsubst face-user-default-spec
(face)
1415 "Return the user's customized face-spec for FACE, or the default if none.
1416 If there is neither a user setting nor a default for FACE, return nil."
1417 (or (get face
'saved-face
)
1418 (face-default-spec face
)))
1421 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1422 ;;; Frame-type independent color support.
1423 ;;; We keep the old x-* names as aliases for back-compatibility.
1424 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1426 (defun defined-colors (&optional frame
)
1427 "Return a list of colors supported for a particular frame.
1428 The argument FRAME specifies which frame to try.
1429 The value may be different for frames on different display types.
1430 If FRAME doesn't support colors, the value is nil."
1431 (if (memq (framep (or frame
(selected-frame))) '(x w32 mac
))
1432 (xw-defined-colors frame
)
1433 (mapcar 'car
(tty-color-alist frame
))))
1434 (defalias 'x-defined-colors
'defined-colors
)
1436 (defun color-defined-p (color &optional frame
)
1437 "Return non-nil if color COLOR is supported on frame FRAME.
1438 If FRAME is omitted or nil, use the selected frame.
1439 If COLOR is the symbol `unspecified' or one of the strings
1440 \"unspecified-fg\" or \"unspecified-bg\", the value is nil."
1441 (if (member color
'(unspecified "unspecified-bg" "unspecified-fg"))
1443 (if (member (framep (or frame
(selected-frame))) '(x w32 mac
))
1444 (xw-color-defined-p color frame
)
1445 (numberp (tty-color-translate color frame
)))))
1446 (defalias 'x-color-defined-p
'color-defined-p
)
1448 (defun color-values (color &optional frame
)
1449 "Return a description of the color named COLOR on frame FRAME.
1450 The value is a list of integer RGB values--\(RED GREEN BLUE\).
1451 These values appear to range from 0 65535; white is \(65535 65535 65535\).
1452 If FRAME is omitted or nil, use the selected frame.
1453 If FRAME cannot display COLOR, the value is nil.
1454 If COLOR is the symbol `unspecified' or one of the strings
1455 \"unspecified-fg\" or \"unspecified-bg\", the value is nil."
1456 (if (member color
'(unspecified "unspecified-fg" "unspecified-bg"))
1458 (if (memq (framep (or frame
(selected-frame))) '(x w32 mac
))
1459 (xw-color-values color frame
)
1460 (tty-color-values color frame
))))
1461 (defalias 'x-color-values
'color-values
)
1463 (defun display-color-p (&optional display
)
1464 "Return t if DISPLAY supports color.
1465 The optional argument DISPLAY specifies which display to ask about.
1466 DISPLAY should be either a frame or a display name (a string).
1467 If omitted or nil, that stands for the selected frame's display."
1468 (if (memq (framep-on-display display
) '(x w32 mac
))
1469 (xw-display-color-p display
)
1470 (tty-display-color-p display
)))
1471 (defalias 'x-display-color-p
'display-color-p
)
1473 (defun display-grayscale-p (&optional display
)
1474 "Return non-nil if frames on DISPLAY can display shades of gray."
1475 (let ((frame-type (framep-on-display display
)))
1477 ((memq frame-type
'(x w32 mac
))
1478 (x-display-grayscale-p display
))
1480 (> (tty-color-gray-shades display
) 2)))))
1482 (defun display-supports-face-attributes-p (attributes &optional display
)
1483 "Return non-nil if all the face attributes in ATTRIBUTES are supported.
1484 The optional argument DISPLAY can be a display name, a frame, or
1485 nil (meaning the selected frame's display)
1487 The definition of `supported' is somewhat heuristic, but basically means
1488 that a face containing all the attributes in ATTRIBUTES, when merged
1489 with the default face for display, can be represented in a way that's
1491 (1) different in appearance than the default face, and
1492 (2) `close in spirit' to what the attributes specify, if not exact.
1494 Point (2) implies that a `:weight black' attribute will be satisified by
1495 any display that can display bold, and a `:foreground \"yellow\"' as long
1496 as it can display a yellowish color, but `:slant italic' will _not_ be
1497 satisified by the tty display code's automatic substitution of a `dim'
1500 (if (framep display
)
1502 (car (frames-on-display-list display
)))))
1503 ;; For now, we assume that non-tty displays can support everything.
1504 ;; Later, we should add the ability to query about specific fonts,
1506 (or (memq (framep frame
) '(x w32 mac
))
1507 (tty-supports-face-attributes-p attributes frame
))))
1510 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1511 ;;; Background mode.
1512 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1514 (defcustom frame-background-mode nil
1515 "*The brightness of the background.
1516 Set this to the symbol `dark' if your background color is dark, `light' if
1517 your background is light, or nil (default) if you want Emacs to
1518 examine the brightness for you. Don't set this variable with `setq';
1519 this won't have the expected effect."
1521 :set
#'(lambda (var value
)
1522 (set-default var value
)
1523 (mapc 'frame-set-background-mode
(frame-list)))
1524 :initialize
'custom-initialize-changed
1525 :type
'(choice (choice-item dark
)
1527 (choice-item :tag
"default" nil
)))
1530 (defun frame-set-background-mode (frame)
1531 "Set up display-dependent faces on FRAME.
1532 Display-dependent faces are those which have different definitions
1533 according to the `background-mode' and `display-type' frame parameters."
1536 (x-get-resource ".backgroundMode" "BackgroundMode")))
1537 (bg-color (frame-parameter frame
'background-color
))
1539 (cond (frame-background-mode)
1541 (intern (downcase bg-resource
)))
1542 ((and (null window-system
) (null bg-color
))
1543 ;; No way to determine this automatically (?).
1545 ;; Unspecified frame background color can only happen
1547 ((member bg-color
'(unspecified "unspecified-bg"))
1549 ((equal bg-color
"unspecified-fg") ; inverted colors
1551 ((>= (apply '+ (x-color-values bg-color frame
))
1552 ;; Just looking at the screen, colors whose
1553 ;; values add up to .6 of the white total
1554 ;; still look dark to me.
1555 (* (apply '+ (x-color-values "white" frame
)) .6))
1559 (cond ((null window-system
)
1560 (if (tty-display-color-p frame
) 'color
'mono
))
1561 ((x-display-color-p frame
)
1563 ((x-display-grayscale-p frame
)
1567 (frame-parameter frame
'background-mode
))
1569 (frame-parameter frame
'display-type
)))
1571 (unless (and (eq bg-mode old-bg-mode
) (eq display-type old-display-type
))
1572 (let ((locally-modified-faces nil
))
1573 ;; Before modifying the frame parameters, we collect a list of
1574 ;; faces that don't match what their face-spec says they should
1575 ;; look like; we then avoid changing these faces below. A
1576 ;; negative list is used on the assumption that most faces will
1577 ;; be unmodified, so we can avoid consing in the common case.
1578 (dolist (face (face-list))
1579 (when (not (face-spec-match-p face
1580 (face-user-default-spec face
)
1582 (push face locally-modified-faces
)))
1583 ;; Now change to the new frame parameters
1584 (modify-frame-parameters frame
1585 (list (cons 'background-mode bg-mode
)
1586 (cons 'display-type display-type
)))
1587 ;; For all named faces, choose face specs matching the new frame
1588 ;; parameters, unless they have been locally modified.
1589 (dolist (face (face-list))
1590 (unless (memq face locally-modified-faces
)
1591 (face-spec-set face
(face-user-default-spec face
) frame
)))))))
1594 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1596 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1598 (defun x-handle-named-frame-geometry (parameters)
1599 "Add geometry parameters for a named frame to parameter list PARAMETERS.
1600 Value is the new parameter list."
1601 (let* ((name (or (cdr (assq 'name parameters
))
1602 (cdr (assq 'name default-frame-alist
))))
1603 (x-resource-name name
)
1604 (res-geometry (if name
(x-get-resource "geometry" "Geometry"))))
1606 (let ((parsed (x-parse-geometry res-geometry
)))
1607 ;; If the resource specifies a position, call the position
1608 ;; and size "user-specified".
1609 (when (or (assq 'top parsed
)
1610 (assq 'left parsed
))
1611 (setq parsed
(append '((user-position . t
) (user-size . t
)) parsed
)))
1612 ;; Put the geometry parameters at the end. Copy
1613 ;; default-frame-alist so that they go after it.
1614 (setq parameters
(append parameters default-frame-alist parsed
))))
1618 (defun x-handle-reverse-video (frame parameters
)
1619 "Handle the reverse-video frame parameter and X resource.
1620 `x-create-frame' does not handle this one."
1621 (when (cdr (or (assq 'reverse parameters
)
1622 (assq 'reverse default-frame-alist
)
1623 (let ((resource (x-get-resource "reverseVideo"
1626 (cons nil
(member (downcase resource
)
1627 '("on" "true")))))))
1628 (let* ((params (frame-parameters frame
))
1629 (bg (cdr (assq 'foreground-color params
)))
1630 (fg (cdr (assq 'background-color params
))))
1631 (modify-frame-parameters frame
1632 (list (cons 'foreground-color fg
)
1633 (cons 'background-color bg
)))
1634 (if (equal bg
(cdr (assq 'border-color params
)))
1635 (modify-frame-parameters frame
1636 (list (cons 'border-color fg
))))
1637 (if (equal bg
(cdr (assq 'mouse-color params
)))
1638 (modify-frame-parameters frame
1639 (list (cons 'mouse-color fg
))))
1640 (if (equal bg
(cdr (assq 'cursor-color params
)))
1641 (modify-frame-parameters frame
1642 (list (cons 'cursor-color fg
)))))))
1645 (defun x-create-frame-with-faces (&optional parameters
)
1646 "Create a frame from optional frame parameters PARAMETERS.
1647 Parameters not specified by PARAMETERS are taken from
1648 `default-frame-alist'. If PARAMETERS specify a frame name,
1649 handle X geometry resources for that name. If either PARAMETERS
1650 or `default-frame-alist' contains a `reverse' parameter, or
1651 the X resource ``reverseVideo'' is present, handle that.
1652 Value is the new frame created."
1653 (setq parameters
(x-handle-named-frame-geometry parameters
))
1654 (let ((visibility-spec (assq 'visibility parameters
))
1655 (frame-list (frame-list))
1656 (frame (x-create-frame (cons '(visibility . nil
) parameters
)))
1660 (x-handle-reverse-video frame parameters
)
1661 (frame-set-background-mode frame
)
1662 (face-set-after-frame-default frame
)
1663 (if (or (null frame-list
) (null visibility-spec
))
1664 (make-frame-visible frame
)
1665 (modify-frame-parameters frame
(list visibility-spec
)))
1668 (delete-frame frame
)))
1672 (defun face-set-after-frame-default (frame)
1673 "Set frame-local faces of FRAME from face specs and resources.
1674 Initialize colors of certain faces from frame parameters."
1675 (dolist (face (face-list))
1676 (when (not (equal face
'default
))
1677 (face-spec-set face
(face-user-default-spec face
) frame
)
1678 (internal-merge-in-global-face face frame
)
1679 (when (and (memq window-system
'(x w32 mac
))
1680 (or (not (boundp 'inhibit-default-face-x-resources
))
1681 (not (eq face
'default
))))
1682 (make-face-x-resource-internal face frame
))))
1684 ;; Initialize attributes from frame parameters.
1685 (let ((params '((foreground-color default
:foreground
)
1686 (background-color default
:background
)
1687 (border-color border
:background
)
1688 (cursor-color cursor
:background
)
1689 (scroll-bar-foreground scroll-bar
:foreground
)
1690 (scroll-bar-background scroll-bar
:background
)
1691 (mouse-color mouse
:background
))))
1692 (dolist (param params
)
1693 (let ((frame-param (frame-parameter frame
(nth 0 param
)))
1694 (face (nth 1 param
))
1695 (attr (nth 2 param
)))
1696 (when (and frame-param
1697 ;; Don't override face attributes explicitly
1698 ;; specified for new frames.
1699 (eq (face-attribute face attr t
) 'unspecified
))
1700 (set-face-attribute face frame attr frame-param
))))))
1703 (defun tty-handle-reverse-video (frame parameters
)
1704 "Handle the reverse-video frame parameter for terminal frames."
1705 (when (cdr (or (assq 'reverse parameters
)
1706 (assq 'reverse default-frame-alist
)))
1707 (let* ((params (frame-parameters frame
))
1708 (bg (cdr (assq 'foreground-color params
)))
1709 (fg (cdr (assq 'background-color params
))))
1710 (modify-frame-parameters frame
1711 (list (cons 'foreground-color fg
)
1712 (cons 'background-color bg
)))
1713 (if (equal bg
(cdr (assq 'mouse-color params
)))
1714 (modify-frame-parameters frame
1715 (list (cons 'mouse-color fg
))))
1716 (if (equal bg
(cdr (assq 'cursor-color params
)))
1717 (modify-frame-parameters frame
1718 (list (cons 'cursor-color fg
)))))))
1721 (defun tty-create-frame-with-faces (&optional parameters
)
1722 "Create a frame from optional frame parameters PARAMETERS.
1723 Parameters not specified by PARAMETERS are taken from
1724 `default-frame-alist'. If either PARAMETERS or `default-frame-alist'
1725 contains a `reverse' parameter, handle that. Value is the new frame
1727 (let ((frame (make-terminal-frame parameters
))
1731 (tty-handle-reverse-video frame
(frame-parameters frame
))
1732 (frame-set-background-mode frame
)
1733 (face-set-after-frame-default frame
)
1736 (delete-frame frame
)))
1740 ;; Called from C function init_display to initialize faces of the
1741 ;; dumped terminal frame on startup.
1743 (defun tty-set-up-initial-frame-faces ()
1744 (let ((frame (selected-frame)))
1745 (frame-set-background-mode frame
)
1746 (face-set-after-frame-default frame
)))
1751 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1752 ;;; Compatiblity with 20.2
1753 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1755 ;; Update a frame's faces when we change its default font.
1757 (defalias 'frame-update-faces
'ignore
)
1758 (make-obsolete 'frame-update-faces
"No longer necessary" "21.1")
1760 ;; Update the colors of FACE, after FRAME's own colors have been
1763 (defalias 'frame-update-face-colors
'frame-set-background-mode
)
1764 (make-obsolete 'frame-update-face-colors
'frame-set-background-mode
"21.1")
1767 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1769 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1771 (defgroup basic-faces nil
1772 "The standard faces of Emacs."
1778 "Basic default face."
1779 :group
'basic-faces
)
1783 '((((type x w32 mac
) (class color
))
1784 :box
(:line-width -
1 :style released-button
)
1785 :background
"grey75" :foreground
"black")
1788 "Basic mode line face for selected window."
1791 :group
'basic-faces
)
1793 (defface mode-line-inactive
1796 (((type x w32 mac
) (background light
) (class color
))
1798 :box
(:line-width -
1 :color
"grey75" :style nil
)
1799 :foreground
"grey20" :background
"grey90")
1800 (((type x w32 mac
) (background dark
) (class color
))
1802 :box
(:line-width -
1 :color
"grey40" :style nil
)
1803 :foreground
"grey80" :background
"grey30"))
1804 "Basic mode line face for non-selected windows."
1807 :group
'basic-faces
)
1809 ;; Make `modeline' an alias for `mode-line', for compatibility.
1810 (put 'modeline
'face-alias
'mode-line
)
1811 (put 'modeline-inactive
'face-alias
'mode-line-inactive
)
1813 (defface header-line
1817 ;; This used to be `:inverse-video t', but that doesn't look very
1818 ;; good when combined with inverse-video mode-lines and multiple
1819 ;; windows. Underlining looks better, and is more consistent with
1820 ;; the window-system face variants, which deemphasize the
1821 ;; header-line in relation to the mode-line face. If a terminal
1822 ;; can't underline, then the header-line will end up without any
1823 ;; highlighting; this may be too confusing in general, although it
1824 ;; happens to look good with the only current use of header-lines,
1825 ;; the info browser. XXX
1827 (((class color grayscale
) (background light
))
1828 :background
"grey90" :foreground
"grey20"
1830 (((class color grayscale
) (background dark
))
1831 :background
"grey20" :foreground
"grey90"
1833 (((class mono
) (background light
))
1834 :background
"white" :foreground
"black"
1838 (((class mono
) (background dark
))
1839 :background
"black" :foreground
"white"
1843 "Basic header-line face."
1845 :group
'basic-faces
)
1849 '((((type x w32 mac
) (class color
))
1850 :box
(:line-width
1 :style released-button
)
1851 :background
"grey75" :foreground
"black")
1852 (((type x
) (class mono
))
1853 :box
(:line-width
1 :style released-button
)
1854 :background
"grey" :foreground
"black")
1857 "Basic tool-bar face."
1859 :group
'basic-faces
)
1862 (defface minibuffer-prompt
'((((background dark
)) :foreground
"cyan")
1863 (((type pc
)) :foreground
"magenta")
1864 (t :foreground
"dark blue"))
1865 "Face for minibuffer prompts."
1867 :group
'basic-faces
)
1869 (setq minibuffer-prompt-properties
1870 (append minibuffer-prompt-properties
(list 'face
'minibuffer-prompt
)))
1873 '((((type tty
) (class color
))
1874 :background
"blue" :foreground
"white")
1875 (((type tty
) (class mono
))
1877 (((class color
) (background dark
))
1878 :background
"blue3")
1879 (((class color
) (background light
))
1880 :background
"lightgoldenrod2")
1881 (t :background
"gray"))
1882 "Basic face for highlighting the region."
1884 :group
'basic-faces
)
1888 '((((class color
) (background light
))
1889 :background
"grey95")
1890 (((class color
) (background dark
))
1891 :background
"grey10")
1893 :background
"gray"))
1894 "Basic face for the fringes to the left and right of windows under X."
1897 :group
'basic-faces
)
1900 (defface scroll-bar
'()
1901 "Basic face for the scroll bar colors under X."
1904 :group
'basic-faces
)
1914 "Basic face for the font and colors of the menu bar and popup menus."
1917 :group
'basic-faces
)
1921 "Basic face for the frame border under X."
1924 :group
'basic-faces
)
1928 "Basic face for the cursor color under X."
1931 :group
'basic-faces
)
1935 "Basic face for the mouse color under X."
1938 :group
'basic-faces
)
1941 (defface bold
'((t :weight bold
))
1943 :group
'basic-faces
)
1947 '((((supports :slant italic
))
1949 (((supports :underline t
))
1952 ;; default to italic, even it doesn't appear to be supported,
1953 ;; because in some cases the display engine will do it's own
1954 ;; workaround (to `dim' on ttys)
1956 "Basic italic font."
1957 :group
'basic-faces
)
1960 (defface bold-italic
'((t :weight bold
:slant italic
))
1961 "Basic bold-italic face."
1962 :group
'basic-faces
)
1965 (defface underline
'((t :underline t
))
1966 "Basic underlined face."
1967 :group
'basic-faces
)
1971 '((((type tty
) (class color
))
1972 :background
"green" :foreground
"black")
1973 (((class color
) (background light
))
1974 :background
"darkseagreen2")
1975 (((class color
) (background dark
))
1976 :background
"darkolivegreen")
1977 (t :inverse-video t
))
1978 "Basic face for highlighting."
1979 :group
'basic-faces
)
1982 (defface secondary-selection
1983 '((((type tty
) (class color
))
1984 :background
"cyan" :foreground
"black")
1985 (((class color
) (background light
))
1986 :background
"yellow")
1987 (((class color
) (background dark
))
1988 :background
"SkyBlue4")
1989 (t :inverse-video t
))
1990 "Basic face for displaying the secondary selection."
1991 :group
'basic-faces
)
1994 (defface fixed-pitch
'((t :family
"courier"))
1995 "The basic fixed-pitch face."
1996 :group
'basic-faces
)
1999 (defface variable-pitch
'((t :family
"helv"))
2000 "The basic variable-pitch face."
2001 :group
'basic-faces
)
2004 (defface trailing-whitespace
2005 '((((class color
) (background light
))
2007 (((class color
) (background dark
))
2009 (t :inverse-video t
))
2010 "Basic face for highlighting trailing whitespace."
2012 :group
'font-lock
; like `show-trailing-whitespace'
2013 :group
'basic-faces
)
2017 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2018 ;;; Manipulating font names.
2019 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2021 ;; This is here for compatibilty with Emacs 20.2. For example,
2022 ;; international/fontset.el uses x-resolve-font-name. The following
2023 ;; functions are not used in the face implementation itself.
2025 (defvar x-font-regexp nil
)
2026 (defvar x-font-regexp-head nil
)
2027 (defvar x-font-regexp-weight nil
)
2028 (defvar x-font-regexp-slant nil
)
2030 (defconst x-font-regexp-weight-subnum
1)
2031 (defconst x-font-regexp-slant-subnum
2)
2032 (defconst x-font-regexp-swidth-subnum
3)
2033 (defconst x-font-regexp-adstyle-subnum
4)
2035 ;;; Regexps matching font names in "Host Portable Character Representation."
2040 (weight "\\(bold\\|demibold\\|medium\\)") ; 1
2041 ; (weight\? "\\(\\*\\|bold\\|demibold\\|medium\\|\\)") ; 1
2042 (weight\? "\\([^-]*\\)") ; 1
2043 (slant "\\([ior]\\)") ; 2
2044 ; (slant\? "\\([ior?*]?\\)") ; 2
2045 (slant\? "\\([^-]?\\)") ; 2
2046 ; (swidth "\\(\\*\\|normal\\|semicondensed\\|\\)") ; 3
2047 (swidth "\\([^-]*\\)") ; 3
2048 ; (adstyle "\\(\\*\\|sans\\|\\)") ; 4
2049 (adstyle "\\([^-]*\\)") ; 4
2050 (pixelsize "[0-9]+")
2051 (pointsize "[0-9][0-9]+")
2052 (resx "[0-9][0-9]+")
2053 (resy "[0-9][0-9]+")
2060 (concat "\\`\\*?[-?*]"
2061 foundry - family - weight
\? - slant
\? - swidth - adstyle -
2062 pixelsize - pointsize - resx - resy - spacing - avgwidth -
2063 registry - encoding
"\\*?\\'"
2065 (setq x-font-regexp-head
2066 (concat "\\`[-?*]" foundry - family - weight
\? - slant
\?
2067 "\\([-*?]\\|\\'\\)"))
2068 (setq x-font-regexp-slant
(concat - slant -
))
2069 (setq x-font-regexp-weight
(concat - weight -
))
2073 (defun x-resolve-font-name (pattern &optional face frame
)
2074 "Return a font name matching PATTERN.
2075 All wildcards in PATTERN are instantiated.
2076 If PATTERN is nil, return the name of the frame's base font, which never
2078 Given optional arguments FACE and FRAME, return a font which is
2079 also the same size as FACE on FRAME, or fail."
2081 (setq face
(face-name face
)))
2085 ;; Note that x-list-fonts has code to handle a face with nil as its font.
2086 (let ((fonts (x-list-fonts pattern face frame
1)))
2089 (if (string-match "\\*" pattern
)
2090 (if (null (face-font face
))
2091 (error "No matching fonts are the same height as the frame default font")
2092 (error "No matching fonts are the same height as face `%s'" face
))
2093 (if (null (face-font face
))
2094 (error "Height of font `%s' doesn't match the frame default font"
2096 (error "Height of font `%s' doesn't match face `%s'"
2098 (error "No fonts match `%s'" pattern
)))
2100 (cdr (assq 'font
(frame-parameters (selected-frame))))))
2103 (defun x-frob-font-weight (font which
)
2104 (let ((case-fold-search t
))
2105 (cond ((string-match x-font-regexp font
)
2106 (concat (substring font
0
2107 (match-beginning x-font-regexp-weight-subnum
))
2109 (substring font
(match-end x-font-regexp-weight-subnum
)
2110 (match-beginning x-font-regexp-adstyle-subnum
))
2111 ;; Replace the ADD_STYLE_NAME field with *
2112 ;; because the info in it may not be the same
2113 ;; for related fonts.
2115 (substring font
(match-end x-font-regexp-adstyle-subnum
))))
2116 ((string-match x-font-regexp-head font
)
2117 (concat (substring font
0 (match-beginning 1)) which
2118 (substring font
(match-end 1))))
2119 ((string-match x-font-regexp-weight font
)
2120 (concat (substring font
0 (match-beginning 1)) which
2121 (substring font
(match-end 1)))))))
2122 (make-obsolete 'x-frob-font-weight
'make-face-...
"21.1")
2124 (defun x-frob-font-slant (font which
)
2125 (let ((case-fold-search t
))
2126 (cond ((string-match x-font-regexp font
)
2127 (concat (substring font
0
2128 (match-beginning x-font-regexp-slant-subnum
))
2130 (substring font
(match-end x-font-regexp-slant-subnum
)
2131 (match-beginning x-font-regexp-adstyle-subnum
))
2132 ;; Replace the ADD_STYLE_NAME field with *
2133 ;; because the info in it may not be the same
2134 ;; for related fonts.
2136 (substring font
(match-end x-font-regexp-adstyle-subnum
))))
2137 ((string-match x-font-regexp-head font
)
2138 (concat (substring font
0 (match-beginning 2)) which
2139 (substring font
(match-end 2))))
2140 ((string-match x-font-regexp-slant font
)
2141 (concat (substring font
0 (match-beginning 1)) which
2142 (substring font
(match-end 1)))))))
2143 (make-obsolete 'x-frob-font-slant
'make-face-...
"21.1")
2145 ;; These aliases are here so that we don't get warnings about obsolete
2146 ;; functions from the byte compiler.
2147 (defalias 'internal-frob-font-weight
'x-frob-font-weight
)
2148 (defalias 'internal-frob-font-slant
'x-frob-font-slant
)
2150 (defun x-make-font-bold (font)
2151 "Given an X font specification, make a bold version of it.
2152 If that can't be done, return nil."
2153 (internal-frob-font-weight font
"bold"))
2154 (make-obsolete 'x-make-font-bold
'make-face-bold
"21.1")
2156 (defun x-make-font-demibold (font)
2157 "Given an X font specification, make a demibold version of it.
2158 If that can't be done, return nil."
2159 (internal-frob-font-weight font
"demibold"))
2160 (make-obsolete 'x-make-font-demibold
'make-face-bold
"21.1")
2162 (defun x-make-font-unbold (font)
2163 "Given an X font specification, make a non-bold version of it.
2164 If that can't be done, return nil."
2165 (internal-frob-font-weight font
"medium"))
2166 (make-obsolete 'x-make-font-unbold
'make-face-unbold
"21.1")
2168 (defun x-make-font-italic (font)
2169 "Given an X font specification, make an italic version of it.
2170 If that can't be done, return nil."
2171 (internal-frob-font-slant font
"i"))
2172 (make-obsolete 'x-make-font-italic
'make-face-italic
"21.1")
2174 (defun x-make-font-oblique (font) ; you say tomayto...
2175 "Given an X font specification, make an oblique version of it.
2176 If that can't be done, return nil."
2177 (internal-frob-font-slant font
"o"))
2178 (make-obsolete 'x-make-font-oblique
'make-face-italic
"21.1")
2180 (defun x-make-font-unitalic (font)
2181 "Given an X font specification, make a non-italic version of it.
2182 If that can't be done, return nil."
2183 (internal-frob-font-slant font
"r"))
2184 (make-obsolete 'x-make-font-unitalic
'make-face-unitalic
"21.1")
2186 (defun x-make-font-bold-italic (font)
2187 "Given an X font specification, make a bold and italic version of it.
2188 If that can't be done, return nil."
2189 (and (setq font
(internal-frob-font-weight font
"bold"))
2190 (internal-frob-font-slant font
"i")))
2191 (make-obsolete 'x-make-font-bold-italic
'make-face-bold-italic
"21.1")
2195 ;;; faces.el ends here