1 ;;; faces.el --- Lisp faces
3 ;; Copyright (C) 1992, 1993, 1994, 1995, 1996, 1998, 1999, 2000, 2001,
4 ;; 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009 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 3 of the License, or
14 ;; (at your option) any later version.
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. If not, see <http://www.gnu.org/licenses/>.
31 (declare-function xw-defined-colors
"term/x-win" (&optional frame
))
33 (defvar help-xref-stack-item
)
35 (defvar face-name-history nil
36 "History list for some commands that read face names.
37 Maximum length of the history list is determined by the value
38 of `history-length', which see.")
41 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
43 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
45 (defgroup font-selection nil
46 "Influencing face font selection."
50 (defcustom face-font-selection-order
51 '(:width
:height
:weight
:slant
)
52 "A list specifying how face font selection chooses fonts.
53 Each of the four symbols `:width', `:height', `:weight', and `:slant'
54 must appear once in the list, and the list must not contain any other
55 elements. Font selection first tries to find a best matching font
56 for those face attributes that appear before in the list. For
57 example, if `:slant' appears before `:height', font selection first
58 tries to find a font with a suitable slant, even if this results in
59 a font height that isn't optimal."
60 :tag
"Font selection order"
61 :type
'(list symbol symbol symbol symbol
)
62 :group
'font-selection
63 :set
#'(lambda (symbol value
)
64 (set-default symbol value
)
65 (internal-set-font-selection-order value
)))
68 ;; In the absence of Fontconfig support, Monospace and Sans Serif are
69 ;; unavailable, and we fall back on the courier and helv families,
70 ;; which are generally available.
71 (defcustom face-font-family-alternatives
72 '(("Monospace" "courier" "fixed")
73 ("courier" "CMU Typewriter Text" "fixed")
74 ("Sans Serif" "helv" "helvetica" "arial" "fixed")
75 ("helv" "helvetica" "arial" "fixed"))
76 "Alist of alternative font family names.
77 Each element has the form (FAMILY ALTERNATIVE1 ALTERNATIVE2 ...).
78 If fonts of family FAMILY can't be loaded, try ALTERNATIVE1, then
80 :tag
"Alternative font families to try"
81 :type
'(repeat (repeat string
))
82 :group
'font-selection
83 :set
#'(lambda (symbol value
)
84 (set-default symbol value
)
85 (internal-set-alternative-font-family-alist value
)))
88 ;; This is defined originally in xfaces.c.
89 (defcustom face-font-registry-alternatives
90 (if (eq system-type
'windows-nt
)
91 '(("iso8859-1" "ms-oemlatin")
92 ("gb2312.1980" "gb2312" "gbk" "gb18030")
93 ("jisx0208.1990" "jisx0208.1983" "jisx0208.1978")
94 ("ksc5601.1989" "ksx1001.1992" "ksc5601.1987")
95 ("muletibetan-2" "muletibetan-0"))
96 '(("gb2312.1980" "gb2312.80&gb8565.88" "gbk" "gb18030")
97 ("jisx0208.1990" "jisx0208.1983" "jisx0208.1978")
98 ("ksc5601.1989" "ksx1001.1992" "ksc5601.1987")
99 ("muletibetan-2" "muletibetan-0")))
100 "Alist of alternative font registry names.
101 Each element has the form (REGISTRY ALTERNATIVE1 ALTERNATIVE2 ...).
102 If fonts of registry REGISTRY can be loaded, font selection
103 tries to find a best matching font among all fonts of registry
104 REGISTRY, ALTERNATIVE1, ALTERNATIVE2, and etc."
105 :tag
"Alternative font registries to try"
106 :type
'(repeat (repeat string
))
108 :group
'font-selection
109 :set
#'(lambda (symbol value
)
110 (set-default symbol value
)
111 (internal-set-alternative-font-registry-alist value
)))
114 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
115 ;;; Creation, copying.
116 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
120 "Return a list of all defined face names."
121 (mapcar #'car face-new-frame-defaults
))
124 ;;; ### If not frame-local initialize by what X resources?
126 (defun make-face (face &optional no-init-from-resources
)
127 "Define a new face with name FACE, a symbol.
128 NO-INIT-FROM-RESOURCES non-nil means don't initialize frame-local
129 variants of FACE from X resources. (X resources recognized are found
130 in the global variable `face-x-resources'.) If FACE is already known
131 as a face, leave it unmodified. Value is FACE."
132 (interactive (list (read-from-minibuffer
133 "Make face: " nil nil t
'face-name-history
)))
135 ;; Make frame-local faces (this also makes the global one).
136 (dolist (frame (frame-list))
137 (internal-make-lisp-face face frame
))
138 ;; Add the face to the face menu.
139 (when (fboundp 'facemenu-add-new-face
)
140 (facemenu-add-new-face face
))
141 ;; Define frame-local faces for all frames from X resources.
142 (unless no-init-from-resources
143 (make-face-x-resource-internal face
)))
147 (defun make-empty-face (face)
148 "Define a new, empty face with name FACE.
149 If the face already exists, it is left unmodified. Value is FACE."
150 (interactive (list (read-from-minibuffer
151 "Make empty face: " nil nil t
'face-name-history
)))
152 (make-face face
'no-init-from-resources
))
155 (defun copy-face (old-face new-face
&optional frame new-frame
)
156 "Define a face just like OLD-FACE, with name NEW-FACE.
158 If NEW-FACE already exists as a face, it is modified to be like
159 OLD-FACE. If it doesn't already exist, it is created.
161 If the optional argument FRAME is given as a frame, NEW-FACE is
162 changed on FRAME only.
163 If FRAME is t, the frame-independent default specification for OLD-FACE
164 is copied to NEW-FACE.
165 If FRAME is nil, copying is done for the frame-independent defaults
166 and for each existing frame.
168 If the optional fourth argument NEW-FRAME is given,
169 copy the information from face OLD-FACE on frame FRAME
170 to NEW-FACE on frame NEW-FRAME. In this case, FRAME may not be nil."
171 (let ((inhibit-quit t
))
175 (error "Copying face %s from all frames to one frame"
177 (make-empty-face new-face
)
178 (dolist (frame (frame-list))
179 (copy-face old-face new-face frame
))
180 (copy-face old-face new-face t
))
181 (make-empty-face new-face
)
182 (internal-copy-lisp-face old-face new-face frame new-frame
))
187 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
188 ;;; Obsolete functions
189 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
191 ;; The functions in this section are defined because Lisp packages use
192 ;; them, despite the prefix `internal-' suggesting that they are
193 ;; private to the face implementation.
195 (defun internal-find-face (name &optional frame
)
196 "Retrieve the face named NAME.
197 Return nil if there is no such face.
198 If NAME is already a face, it is simply returned.
199 The optional argument FRAME is ignored."
201 (make-obsolete 'internal-find-face
'facep
"21.1")
204 (defun internal-get-face (name &optional frame
)
205 "Retrieve the face named NAME; error if there is none.
206 If NAME is already a face, it is simply returned.
207 The optional argument FRAME is ignored."
210 (make-obsolete 'internal-get-face
"see `facep' and `check-face'." "21.1")
213 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
214 ;;; Predicates, type checks.
215 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
218 "Return non-nil if FACE is a face name; nil otherwise.
219 A face name can be a string or a symbol."
220 (internal-lisp-face-p face
))
223 (defun check-face (face)
224 "Signal an error if FACE doesn't name a face.
227 (error "Not a face: %s" face
))
231 ;; The ID returned is not to be confused with the internally used IDs
232 ;; of realized faces. The ID assigned to Lisp faces is used to
233 ;; support faces in display table entries.
235 (defun face-id (face &optional frame
)
236 "Return the internal ID of face with name FACE.
237 If FACE is a face-alias, return the ID of the target face.
238 The optional argument FRAME is ignored, since the internal face ID
239 of a face name is the same for all frames."
242 (face-id (get face
'face-alias
))))
244 (defun face-equal (face1 face2
&optional frame
)
245 "Non-nil if faces FACE1 and FACE2 are equal.
246 Faces are considered equal if all their attributes are equal.
247 If the optional argument FRAME is given, report on FACE1 and FACE2 in that frame.
248 If FRAME is t, report on the defaults for FACE1 and FACE2 (for new frames).
249 If FRAME is omitted or nil, use the selected frame."
250 (internal-lisp-face-equal-p face1 face2 frame
))
253 (defun face-differs-from-default-p (face &optional frame
)
254 "Return non-nil if FACE displays differently from the default face.
255 If the optional argument FRAME is given, report on face FACE in that frame.
256 If FRAME is t, report on the defaults for face FACE (for new frames).
257 If FRAME is omitted or nil, use the selected frame."
259 (delq :inherit
(mapcar 'car face-attribute-name-alist
)))
261 (while (and attrs
(not differs
))
262 (let* ((attr (pop attrs
))
263 (attr-val (face-attribute face attr frame t
)))
265 (not (eq attr-val
'unspecified
))
266 (display-supports-face-attributes-p (list attr attr-val
)
268 (setq differs attr
))))
272 (defun face-nontrivial-p (face &optional frame
)
273 "True if face FACE has some non-nil attribute.
274 If the optional argument FRAME is given, report on face FACE in that frame.
275 If FRAME is t, report on the defaults for face FACE (for new frames).
276 If FRAME is omitted or nil, use the selected frame."
277 (not (internal-lisp-face-empty-p face frame
)))
281 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
282 ;;; Setting face attributes from X resources.
283 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
285 (defcustom face-x-resources
286 '((:family
(".attributeFamily" .
"Face.AttributeFamily"))
287 (:foundry
(".attributeFoundry" .
"Face.AttributeFoundry"))
288 (:width
(".attributeWidth" .
"Face.AttributeWidth"))
289 (:height
(".attributeHeight" .
"Face.AttributeHeight"))
290 (:weight
(".attributeWeight" .
"Face.AttributeWeight"))
291 (:slant
(".attributeSlant" .
"Face.AttributeSlant"))
292 (:foreground
(".attributeForeground" .
"Face.AttributeForeground"))
293 (:background
(".attributeBackground" .
"Face.AttributeBackground"))
294 (:overline
(".attributeOverline" .
"Face.AttributeOverline"))
295 (:strike-through
(".attributeStrikeThrough" .
"Face.AttributeStrikeThrough"))
296 (:box
(".attributeBox" .
"Face.AttributeBox"))
297 (:underline
(".attributeUnderline" .
"Face.AttributeUnderline"))
298 (:inverse-video
(".attributeInverse" .
"Face.AttributeInverse"))
300 (".attributeStipple" .
"Face.AttributeStipple")
301 (".attributeBackgroundPixmap" .
"Face.AttributeBackgroundPixmap"))
302 (:bold
(".attributeBold" .
"Face.AttributeBold"))
303 (:italic
(".attributeItalic" .
"Face.AttributeItalic"))
304 (:font
(".attributeFont" .
"Face.AttributeFont"))
305 (:inherit
(".attributeInherit" .
"Face.AttributeInherit")))
306 "List of X resources and classes for face attributes.
307 Each element has the form (ATTRIBUTE ENTRY1 ENTRY2...) where ATTRIBUTE is
308 the name of a face attribute, and each ENTRY is a cons of the form
309 \(RESOURCE . CLASS) with RESOURCE being the resource and CLASS being the
310 X resource class for the attribute."
311 :type
'(repeat (cons symbol
(repeat (cons string string
))))
315 (declare-function internal-face-x-get-resource
"xfaces.c"
316 (resource class frame
))
318 (declare-function internal-set-lisp-face-attribute-from-resource
"xfaces.c"
319 (face attr value
&optional frame
))
321 (defun set-face-attribute-from-resource (face attribute resource class frame
)
322 "Set FACE's ATTRIBUTE from X resource RESOURCE, class CLASS on FRAME.
323 Value is the attribute value specified by the resource, or nil
324 if not present. This function displays a message if the resource
325 specifies an invalid attribute."
326 (let* ((face-name (face-name face
))
327 (value (internal-face-x-get-resource (concat face-name resource
)
331 (internal-set-lisp-face-attribute-from-resource
332 face attribute
(downcase value
) frame
)
334 (message "Face %s, frame %s: invalid attribute %s %s from X resource"
335 face-name frame attribute value
))))
339 (defun set-face-attributes-from-resources (face frame
)
340 "Set attributes of FACE from X resources for FRAME."
341 (when (memq (framep frame
) '(x w32
))
342 (dolist (definition face-x-resources
)
343 (let ((attribute (car definition
)))
344 (dolist (entry (cdr definition
))
345 (set-face-attribute-from-resource face attribute
(car entry
)
346 (cdr entry
) frame
))))))
349 (defun make-face-x-resource-internal (face &optional frame
)
350 "Fill frame-local FACE on FRAME from X resources.
351 FRAME nil or not specified means do it for all frames."
353 (dolist (frame (frame-list))
354 (set-face-attributes-from-resources face frame
))
355 (set-face-attributes-from-resources face frame
)))
359 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
360 ;;; Retrieving face attributes.
361 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
363 (defun face-name (face)
364 "Return the name of face FACE."
365 (symbol-name (check-face face
)))
368 (defun face-all-attributes (face &optional frame
)
369 "Return an alist stating the attributes of FACE.
370 Each element of the result has the form (ATTR-NAME . ATTR-VALUE).
371 Normally the value describes the default attributes,
372 but if you specify FRAME, the value describes the attributes
374 (mapcar (lambda (pair)
375 (let ((attr (car pair
)))
376 (cons attr
(face-attribute face attr
(or frame t
)))))
377 face-attribute-name-alist
))
379 (defun face-attribute (face attribute
&optional frame inherit
)
380 "Return the value of FACE's ATTRIBUTE on FRAME.
381 If the optional argument FRAME is given, report on face FACE in that frame.
382 If FRAME is t, report on the defaults for face FACE (for new frames).
383 If FRAME is omitted or nil, use the selected frame.
385 If INHERIT is nil, only attributes directly defined by FACE are considered,
386 so the return value may be `unspecified', or a relative value.
387 If INHERIT is non-nil, FACE's definition of ATTRIBUTE is merged with the
388 faces specified by its `:inherit' attribute; however the return value
389 may still be `unspecified' or relative.
390 If INHERIT is a face or a list of faces, then the result is further merged
391 with that face (or faces), until it becomes specified and absolute.
393 To ensure that the return value is always specified and absolute, use a
394 value of `default' for INHERIT; this will resolve any unspecified or
395 relative values by merging with the `default' face (which is always
396 completely specified)."
397 (let ((value (internal-get-lisp-face-attribute face attribute frame
)))
398 (when (and inherit
(face-attribute-relative-p attribute value
))
399 ;; VALUE is relative, so merge with inherited faces
400 (let ((inh-from (face-attribute face
:inherit frame
)))
401 (unless (or (null inh-from
) (eq inh-from
'unspecified
))
404 (face-attribute-merged-with attribute value inh-from frame
))
405 ;; The `inherit' attribute may point to non existent faces.
409 (face-attribute-relative-p attribute value
))
410 ;; We should merge with INHERIT as well
411 (setq value
(face-attribute-merged-with attribute value inherit frame
)))
414 (defun face-attribute-merged-with (attribute value faces
&optional frame
)
415 "Merges ATTRIBUTE, initially VALUE, with faces from FACES until absolute.
416 FACES may be either a single face or a list of faces.
417 \[This is an internal function.]"
418 (cond ((not (face-attribute-relative-p attribute value
))
423 (face-attribute-merged-with
425 (face-attribute-merged-with attribute value
(car faces
) frame
)
429 (merge-face-attribute attribute
431 (face-attribute faces attribute frame t
)))))
434 (defmacro face-attribute-specified-or
(value &rest body
)
435 "Return VALUE, unless it's `unspecified', in which case evaluate BODY and return the result."
436 (let ((temp (make-symbol "value")))
437 `(let ((,temp
,value
))
438 (if (not (eq ,temp
'unspecified
))
442 (defun face-foreground (face &optional frame inherit
)
443 "Return the foreground color name of FACE, or nil if unspecified.
444 If the optional argument FRAME is given, report on face FACE in that frame.
445 If FRAME is t, report on the defaults for face FACE (for new frames).
446 If FRAME is omitted or nil, use the selected frame.
448 If INHERIT is nil, only a foreground color directly defined by FACE is
449 considered, so the return value may be nil.
450 If INHERIT is t, and FACE doesn't define a foreground color, then any
451 foreground color that FACE inherits through its `:inherit' attribute
452 is considered as well; however the return value may still be nil.
453 If INHERIT is a face or a list of faces, then it is used to try to
454 resolve an unspecified foreground color.
456 To ensure that a valid color is always returned, use a value of
457 `default' for INHERIT; this will resolve any unspecified values by
458 merging with the `default' face (which is always completely specified)."
459 (face-attribute-specified-or (face-attribute face
:foreground frame inherit
)
462 (defun face-background (face &optional frame inherit
)
463 "Return the background color name of FACE, or nil if unspecified.
464 If the optional argument FRAME is given, report on face FACE in that frame.
465 If FRAME is t, report on the defaults for face FACE (for new frames).
466 If FRAME is omitted or nil, use the selected frame.
468 If INHERIT is nil, only a background color directly defined by FACE is
469 considered, so the return value may be nil.
470 If INHERIT is t, and FACE doesn't define a background color, then any
471 background color that FACE inherits through its `:inherit' attribute
472 is considered as well; however the return value may still be nil.
473 If INHERIT is a face or a list of faces, then it is used to try to
474 resolve an unspecified background color.
476 To ensure that a valid color is always returned, use a value of
477 `default' for INHERIT; this will resolve any unspecified values by
478 merging with the `default' face (which is always completely specified)."
479 (face-attribute-specified-or (face-attribute face
:background frame inherit
)
482 (defun face-stipple (face &optional frame inherit
)
483 "Return the stipple pixmap name of FACE, or nil if unspecified.
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.
488 If INHERIT is nil, only a stipple directly defined by FACE is
489 considered, so the return value may be nil.
490 If INHERIT is t, and FACE doesn't define a stipple, then any stipple
491 that FACE inherits through its `:inherit' attribute is considered as
492 well; however the return value may still be nil.
493 If INHERIT is a face or a list of faces, then it is used to try to
494 resolve an unspecified stipple.
496 To ensure that a valid stipple or nil is always returned, use a value of
497 `default' for INHERIT; this will resolve any unspecified values by merging
498 with the `default' face (which is always completely specified)."
499 (face-attribute-specified-or (face-attribute face
:stipple frame inherit
)
503 (defalias 'face-background-pixmap
'face-stipple
)
506 (defun face-underline-p (face &optional frame
)
507 "Return non-nil if FACE is underlined.
508 If the optional argument FRAME is given, report on face FACE in that frame.
509 If FRAME is t, report on the defaults for face FACE (for new frames).
510 If FRAME is omitted or nil, use the selected frame."
511 (eq (face-attribute face
:underline frame
) t
))
514 (defun face-inverse-video-p (face &optional frame
)
515 "Return non-nil if FACE is in inverse video on FRAME.
516 If the optional argument FRAME is given, report on face FACE in that frame.
517 If FRAME is t, report on the defaults for face FACE (for new frames).
518 If FRAME is omitted or nil, use the selected frame."
519 (eq (face-attribute face
:inverse-video frame
) t
))
522 (defun face-bold-p (face &optional frame
)
523 "Return non-nil if the font of FACE is bold on FRAME.
524 If the optional argument FRAME is given, report on face FACE in that frame.
525 If FRAME is t, report on the defaults for face FACE (for new frames).
526 If FRAME is omitted or nil, use the selected frame.
527 Use `face-attribute' for finer control."
528 (let ((bold (face-attribute face
:weight frame
)))
529 (memq bold
'(semi-bold bold extra-bold ultra-bold
))))
532 (defun face-italic-p (face &optional frame
)
533 "Return non-nil if the font of FACE is italic on FRAME.
534 If the optional argument FRAME is given, report on face FACE in that frame.
535 If FRAME is t, report on the defaults for face FACE (for new frames).
536 If FRAME is omitted or nil, use the selected frame.
537 Use `face-attribute' for finer control."
538 (let ((italic (face-attribute face
:slant frame
)))
539 (memq italic
'(italic oblique
))))
543 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
544 ;;; Face documentation.
545 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
547 (defun face-documentation (face)
548 "Get the documentation string for FACE.
549 If FACE is a face-alias, get the documentation for the target face."
550 (let ((alias (get face
'face-alias
))
554 (setq doc
(get alias
'face-documentation
))
555 (format "%s is an alias for the face `%s'.%s" face alias
556 (if doc
(format "\n%s" doc
)
558 (get face
'face-documentation
))))
561 (defun set-face-documentation (face string
)
562 "Set the documentation string for FACE to STRING."
563 ;; Perhaps the text should go in DOC.
564 (put face
'face-documentation
(purecopy string
)))
567 (defalias 'face-doc-string
'face-documentation
)
568 (defalias 'set-face-doc-string
'set-face-documentation
)
572 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
573 ;; Setting face attributes.
574 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
577 (defun set-face-attribute (face frame
&rest args
)
578 "Set attributes of FACE on FRAME from ARGS.
580 FRAME nil means change attributes on all frames. FRAME t means change
581 the default for new frames (this is done automatically each time an
582 attribute is changed on all frames).
584 ARGS must come in pairs ATTRIBUTE VALUE. ATTRIBUTE must be a valid
585 face attribute name. All attributes can be set to `unspecified';
586 this fact is not further mentioned below.
588 The following attributes are recognized:
592 VALUE must be a string specifying the font family, e.g. ``monospace'',
593 or a fontset alias name. If a font family is specified, wild-cards `*'
598 VALUE must be a string specifying the font foundry,
599 e.g. ``adobe''. If a font foundry is specified, wild-cards `*'
604 VALUE specifies the relative proportionate width of the font to use.
605 It must be one of the symbols `ultra-condensed', `extra-condensed',
606 `condensed', `semi-condensed', `normal', `semi-expanded', `expanded',
607 `extra-expanded', or `ultra-expanded'.
611 VALUE must be either an integer specifying the height of the font to use
612 in 1/10 pt, a floating point number specifying the amount by which to
613 scale any underlying face, or a function, which is called with the old
614 height (from the underlying face), and should return the new height.
618 VALUE specifies the weight of the font to use. It must be one of the
619 symbols `ultra-bold', `extra-bold', `bold', `semi-bold', `normal',
620 `semi-light', `light', `extra-light', `ultra-light'.
624 VALUE specifies the slant of the font to use. It must be one of the
625 symbols `italic', `oblique', `normal', `reverse-italic', or
628 `:foreground', `:background'
630 VALUE must be a color name, a string.
634 VALUE specifies whether characters in FACE should be underlined. If
635 VALUE is t, underline with foreground color of the face. If VALUE is
636 a string, underline with that color. If VALUE is nil, explicitly
641 VALUE specifies whether characters in FACE should be overlined. If
642 VALUE is t, overline with foreground color of the face. If VALUE is a
643 string, overline with that color. If VALUE is nil, explicitly don't
648 VALUE specifies whether characters in FACE should be drawn with a line
649 striking through them. If VALUE is t, use the foreground color of the
650 face. If VALUE is a string, strike-through with that color. If VALUE
651 is nil, explicitly don't strike through.
655 VALUE specifies whether characters in FACE should have a box drawn
656 around them. If VALUE is nil, explicitly don't draw boxes. If
657 VALUE is t, draw a box with lines of width 1 in the foreground color
658 of the face. If VALUE is a string, the string must be a color name,
659 and the box is drawn in that color with a line width of 1. Otherwise,
660 VALUE must be a property list of the form `(:line-width WIDTH
661 :color COLOR :style STYLE)'. If a keyword/value pair is missing from
662 the property list, a default value will be used for the value, as
663 specified below. WIDTH specifies the width of the lines to draw; it
664 defaults to 1. If WIDTH is negative, the absolute value is the width
665 of the lines, and draw top/bottom lines inside the characters area,
666 not around it. COLOR is the name of the color to draw in, default is
667 the foreground color of the face for simple boxes, and the background
668 color of the face for 3D boxes. STYLE specifies whether a 3D box
669 should be draw. If STYLE is `released-button', draw a box looking
670 like a released 3D button. If STYLE is `pressed-button' draw a box
671 that appears like a pressed button. If STYLE is nil, the default if
672 the property list doesn't contain a style specification, draw a 2D
677 VALUE specifies whether characters in FACE should be displayed in
678 inverse video. VALUE must be one of t or nil.
682 If VALUE is a string, it must be the name of a file of pixmap data.
683 The directories listed in the `x-bitmap-file-path' variable are
684 searched. Alternatively, VALUE may be a list of the form (WIDTH
685 HEIGHT DATA) where WIDTH and HEIGHT are the size in pixels, and DATA
686 is a string containing the raw bits of the bitmap. VALUE nil means
687 explicitly don't use a stipple pattern.
689 For convenience, attributes `:family', `:foundry', `:width',
690 `:height', `:weight', and `:slant' may also be set in one step
695 Set font-related face attributes from VALUE. VALUE must be a valid
696 XLFD font name. If it is a font name pattern, the first matching font
699 For compatibility with Emacs 20, keywords `:bold' and `:italic' can
700 be used to specify that a bold or italic font should be used. VALUE
701 must be t or nil in that case. A value of `unspecified' is not allowed.
705 VALUE is the name of a face from which to inherit attributes, or a list
706 of face names. Attributes from inherited faces are merged into the face
707 like an underlying face would be, with higher priority than underlying faces."
708 (setq args
(purecopy args
))
709 (let ((where (if (null frame
) 0 frame
))
712 ;; If we set the new-frame defaults, this face is modified outside Custom.
713 (if (memq where
'(0 t
))
714 (put (or (get face
'face-alias
) face
) 'face-modified t
))
715 ;; If family and/or foundry are specified, set it first. Certain
716 ;; face attributes, e.g. :weight semi-condensed, are not supported
717 ;; in every font. See bug#1127.
719 (cond ((eq (car spec
) :family
)
720 (setq family
(cadr spec
)))
721 ((eq (car spec
) :foundry
)
722 (setq foundry
(cadr spec
))))
723 (setq spec
(cddr spec
)))
724 (when (or family foundry
)
725 (when (and (stringp family
)
726 (string-match "\\([^-]*\\)-\\([^-]*\\)" family
))
728 (setq foundry
(match-string 2 family
)))
729 (setq family
(match-string 1 family
)))
730 (when (stringp family
)
731 (internal-set-lisp-face-attribute face
:family
(purecopy family
)
733 (when (stringp foundry
)
734 (internal-set-lisp-face-attribute face
:foundry
(purecopy foundry
)
737 (unless (memq (car args
) '(:family
:foundry
))
738 (internal-set-lisp-face-attribute face
(car args
)
739 (purecopy (cadr args
))
741 (setq args
(cddr args
)))))
743 (defun make-face-bold (face &optional frame noerror
)
744 "Make the font of FACE be bold, if possible.
745 FRAME nil or not specified means change face on all frames.
746 Argument NOERROR is ignored and retained for compatibility.
747 Use `set-face-attribute' for finer control of the font weight."
748 (interactive (list (read-face-name "Make which face bold")))
749 (set-face-attribute face frame
:weight
'bold
))
752 (defun make-face-unbold (face &optional frame noerror
)
753 "Make the font of FACE be non-bold, if possible.
754 FRAME nil or not specified means change face on all frames.
755 Argument NOERROR is ignored and retained for compatibility."
756 (interactive (list (read-face-name "Make which face non-bold")))
757 (set-face-attribute face frame
:weight
'normal
))
760 (defun make-face-italic (face &optional frame noerror
)
761 "Make the font of FACE be italic, if possible.
762 FRAME nil or not specified means change face on all frames.
763 Argument NOERROR is ignored and retained for compatibility.
764 Use `set-face-attribute' for finer control of the font slant."
765 (interactive (list (read-face-name "Make which face italic")))
766 (set-face-attribute face frame
:slant
'italic
))
769 (defun make-face-unitalic (face &optional frame noerror
)
770 "Make the font of FACE be non-italic, if possible.
771 FRAME nil or not specified means change face on all frames.
772 Argument NOERROR is ignored and retained for compatibility."
773 (interactive (list (read-face-name "Make which face non-italic")))
774 (set-face-attribute face frame
:slant
'normal
))
777 (defun make-face-bold-italic (face &optional frame noerror
)
778 "Make the font of FACE be bold and italic, if possible.
779 FRAME nil or not specified means change face on all frames.
780 Argument NOERROR is ignored and retained for compatibility.
781 Use `set-face-attribute' for finer control of font weight and slant."
782 (interactive (list (read-face-name "Make which face bold-italic")))
783 (set-face-attribute face frame
:weight
'bold
:slant
'italic
))
786 (defun set-face-font (face font
&optional frame
)
787 "Change font-related attributes of FACE to those of FONT (a string).
788 FRAME nil or not specified means change face on all frames.
789 This sets the attributes `:family', `:foundry', `:width',
790 `:height', `:weight', and `:slant'. When called interactively,
791 prompt for the face and font."
792 (interactive (read-face-and-attribute :font
))
793 (set-face-attribute face frame
:font font
))
796 ;; Implementation note: Emulating gray background colors with a
797 ;; stipple pattern is now part of the face realization process, and is
798 ;; done in C depending on the frame on which the face is realized.
800 (defun set-face-background (face color
&optional frame
)
801 "Change the background color of face FACE to COLOR (a string).
802 FRAME nil or not specified means change face on all frames.
803 COLOR can be a system-defined color name (see `list-colors-display')
804 or a hex spec of the form #RRGGBB.
805 When called interactively, prompts for the face and color."
806 (interactive (read-face-and-attribute :background
))
807 (set-face-attribute face frame
:background
(or color
'unspecified
)))
810 (defun set-face-foreground (face color
&optional frame
)
811 "Change the foreground color of face FACE to COLOR (a string).
812 FRAME nil or not specified means change face on all frames.
813 COLOR can be a system-defined color name (see `list-colors-display')
814 or a hex spec of the form #RRGGBB.
815 When called interactively, prompts for the face and color."
816 (interactive (read-face-and-attribute :foreground
))
817 (set-face-attribute face frame
:foreground
(or color
'unspecified
)))
820 (defun set-face-stipple (face stipple
&optional frame
)
821 "Change the stipple pixmap of face FACE to STIPPLE.
822 FRAME nil or not specified means change face on all frames.
823 STIPPLE should be a string, the name of a file of pixmap data.
824 The directories listed in the `x-bitmap-file-path' variable are searched.
826 Alternatively, STIPPLE may be a list of the form (WIDTH HEIGHT DATA)
827 where WIDTH and HEIGHT are the size in pixels,
828 and DATA is a string, containing the raw bits of the bitmap."
829 (interactive (read-face-and-attribute :stipple
))
830 (set-face-attribute face frame
:stipple
(or stipple
'unspecified
)))
833 (defun set-face-underline-p (face underline
&optional frame
)
834 "Specify whether face FACE is underlined.
835 UNDERLINE nil means FACE explicitly doesn't underline.
836 UNDERLINE non-nil means FACE explicitly does underlining
837 with the same of the foreground color.
838 If UNDERLINE is a string, underline with the color named UNDERLINE.
839 FRAME nil or not specified means change face on all frames.
840 Use `set-face-attribute' to ``unspecify'' underlining."
842 (let ((list (read-face-and-attribute :underline
)))
843 (list (car list
) (eq (car (cdr list
)) t
))))
844 (set-face-attribute face frame
:underline underline
))
846 (define-obsolete-function-alias 'set-face-underline
847 'set-face-underline-p
"22.1")
850 (defun set-face-inverse-video-p (face inverse-video-p
&optional frame
)
851 "Specify whether face FACE is in inverse video.
852 INVERSE-VIDEO-P non-nil means FACE displays explicitly in inverse video.
853 INVERSE-VIDEO-P nil means FACE explicitly is not in inverse video.
854 FRAME nil or not specified means change face on all frames.
855 Use `set-face-attribute' to ``unspecify'' the inverse video attribute."
857 (let ((list (read-face-and-attribute :inverse-video
)))
858 (list (car list
) (eq (car (cdr list
)) t
))))
859 (set-face-attribute face frame
:inverse-video inverse-video-p
))
862 (defun set-face-bold-p (face bold-p
&optional frame
)
863 "Specify whether face FACE is bold.
864 BOLD-P non-nil means FACE should explicitly display bold.
865 BOLD-P nil means FACE should explicitly display non-bold.
866 FRAME nil or not specified means change face on all frames.
867 Use `set-face-attribute' or `modify-face' for finer control."
869 (make-face-unbold face frame
)
870 (make-face-bold face frame
)))
873 (defun set-face-italic-p (face italic-p
&optional frame
)
874 "Specify whether face FACE is italic.
875 ITALIC-P non-nil means FACE should explicitly display italic.
876 ITALIC-P nil means FACE should explicitly display non-italic.
877 FRAME nil or not specified means change face on all frames.
878 Use `set-face-attribute' or `modify-face' for finer control."
880 (make-face-unitalic face frame
)
881 (make-face-italic face frame
)))
884 (defalias 'set-face-background-pixmap
'set-face-stipple
)
887 (defun invert-face (face &optional frame
)
888 "Swap the foreground and background colors of FACE.
889 If FRAME is omitted or nil, it means change face on all frames.
890 If FACE specifies neither foreground nor background color,
891 set its foreground and background to the background and foreground
892 of the default face. Value is FACE."
893 (interactive (list (read-face-name "Invert face")))
894 (let ((fg (face-attribute face
:foreground frame
))
895 (bg (face-attribute face
:background frame
)))
896 (if (not (and (eq fg
'unspecified
) (eq bg
'unspecified
)))
897 (set-face-attribute face frame
:foreground bg
:background fg
)
898 (set-face-attribute face frame
900 (face-attribute 'default
:background frame
)
902 (face-attribute 'default
:foreground frame
))))
906 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
907 ;;; Interactively modifying faces.
908 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
910 (defun read-face-name (prompt &optional string-describing-default multiple
)
911 "Read a face, defaulting to the face or faces on the char after point.
912 If it has the property `read-face-name', that overrides the `face' property.
913 PROMPT should be a string that describes what the caller will do with the face;
914 it should not end in a space.
915 STRING-DESCRIBING-DEFAULT should describe what default the caller will use if
916 the user just types RET; you can omit it.
917 If MULTIPLE is non-nil, return a list of faces (possibly only one).
918 Otherwise, return a single face."
919 (let ((faceprop (or (get-char-property (point) 'read-face-name
)
920 (get-char-property (point) 'face
)))
924 ;; Try to get a face name from the buffer.
925 (if (memq (intern-soft (thing-at-point 'symbol
)) (face-list))
926 (setq faces
(list (intern-soft (thing-at-point 'symbol
)))))
927 ;; Add the named faces that the `face' property uses.
928 (if (and (listp faceprop
)
929 ;; Don't treat an attribute spec as a list of faces.
930 (not (keywordp (car faceprop
)))
931 (not (memq (car faceprop
) '(foreground-color background-color
))))
935 (if (symbolp faceprop
)
936 (push faceprop faces
)))
939 ;; Build up the completion tables.
940 (mapatoms (lambda (s)
942 (if (get s
'face-alias
)
943 (push (symbol-name s
) aliasfaces
)
944 (push (symbol-name s
) nonaliasfaces
)))))
946 ;; If we only want one, and the default is more than one,
947 ;; discard the unwanted ones now.
950 (setq faces
(list (car faces
)))))
954 (completing-read-multiple
955 (if (or faces string-describing-default
)
956 (format "%s (default %s): " prompt
957 (if faces
(mapconcat 'symbol-name faces
",")
958 string-describing-default
))
959 (format "%s: " prompt
))
960 (completion-table-in-turn nonaliasfaces aliasfaces
)
961 nil t nil
'face-name-history
962 (if faces
(mapconcat 'symbol-name faces
","))))
963 ;; Canonicalize the output.
965 (cond ((or (equal input
"") (equal input
'("")))
968 (mapcar 'intern
(split-string input
", *" t
)))
970 (mapcar 'intern input
))
972 ;; Return either a list of faces or just one face.
977 ;; Not defined without X, but behind window-system test.
978 (defvar x-bitmap-file-path
)
980 (defun face-valid-attribute-values (attribute &optional frame
)
981 "Return valid values for face attribute ATTRIBUTE.
982 The optional argument FRAME is used to determine available fonts
983 and colors. If it is nil or not specified, the selected frame is
984 used. Value is an alist of (NAME . VALUE) if ATTRIBUTE expects a value
985 out of a set of discrete values. Value is `integerp' if ATTRIBUTE expects
990 (if (window-system frame
)
991 (mapcar (lambda (x) (cons x x
))
993 ;; Only one font on TTYs.
994 (list (cons "default" "default"))))
998 (mapcar #'(lambda (x) (cons (symbol-name (aref x
1)) (aref x
1)))
1001 (mapcar #'(lambda (x) (cons (symbol-name (aref x
1)) (aref x
1)))
1004 (mapcar #'(lambda (x) (cons (symbol-name (aref x
1)) (aref x
1)))
1007 (mapcar #'(lambda (x) (cons (symbol-name x
) x
))
1008 (internal-lisp-face-attribute-values attribute
)))
1009 ((:underline
:overline
:strike-through
:box
)
1010 (if (window-system frame
)
1011 (nconc (mapcar #'(lambda (x) (cons (symbol-name x
) x
))
1012 (internal-lisp-face-attribute-values attribute
))
1013 (mapcar #'(lambda (c) (cons c c
))
1014 (defined-colors frame
)))
1015 (mapcar #'(lambda (x) (cons (symbol-name x
) x
))
1016 (internal-lisp-face-attribute-values attribute
))))
1017 ((:foreground
:background
)
1018 (mapcar #'(lambda (c) (cons c c
))
1019 (defined-colors frame
)))
1023 (and (memq (window-system frame
) '(x ns
)) ; No stipple on w32
1026 (mapcar (lambda (dir)
1027 (and (file-readable-p dir
)
1028 (file-directory-p dir
)
1029 (directory-files dir
)))
1030 x-bitmap-file-path
)))))
1032 (cons '("none" . nil
)
1033 (mapcar #'(lambda (c) (cons (symbol-name c
) c
))
1036 (error "Internal error")))))
1037 (if (and (listp valid
) (not (memq attribute
'(:inherit
))))
1038 (nconc (list (cons "unspecified" 'unspecified
)) valid
)
1042 (defvar face-attribute-name-alist
1043 '((:family .
"font family")
1044 (:foundry .
"font foundry")
1045 (:width .
"character set width")
1046 (:height .
"height in 1/10 pt")
1047 (:weight .
"weight")
1049 (:underline .
"underline")
1050 (:overline .
"overline")
1051 (:strike-through .
"strike-through")
1053 (:inverse-video .
"inverse-video display")
1054 (:foreground .
"foreground color")
1055 (:background .
"background color")
1056 (:stipple .
"background stipple")
1057 (:inherit .
"inheritance"))
1058 "An alist of descriptive names for face attributes.
1059 Each element has the form (ATTRIBUTE-NAME . DESCRIPTION) where
1060 ATTRIBUTE-NAME is a face attribute name (a keyword symbol), and
1061 DESCRIPTION is a descriptive name for ATTRIBUTE-NAME.")
1064 (defun face-descriptive-attribute-name (attribute)
1065 "Return a descriptive name for ATTRIBUTE."
1066 (cdr (assq attribute face-attribute-name-alist
)))
1069 (defun face-read-string (face default name
&optional completion-alist
)
1070 "Interactively read a face attribute string value.
1071 FACE is the face whose attribute is read. If non-nil, DEFAULT is the
1072 default string to return if no new value is entered. NAME is a
1073 descriptive name of the attribute for prompting. COMPLETION-ALIST is an
1074 alist of valid values, if non-nil.
1076 Entering nothing accepts the default string DEFAULT.
1077 Value is the new attribute value."
1078 ;; Capitalize NAME (we don't use `capitalize' because that capitalizes
1079 ;; each word in a string separately).
1080 (setq name
(concat (upcase (substring name
0 1)) (substring name
1)))
1081 (let* ((completion-ignore-case t
)
1082 (value (completing-read
1084 (format "%s for face `%s' (default %s): "
1086 (format "%s for face `%s': " name face
))
1087 completion-alist nil nil nil nil default
)))
1088 (if (equal value
"") default value
)))
1091 (defun face-read-integer (face default name
)
1092 "Interactively read an integer face attribute value.
1093 FACE is the face whose attribute is read. DEFAULT is the default
1094 value to return if no new value is entered. NAME is a descriptive
1095 name of the attribute for prompting. Value is the new attribute value."
1097 (face-read-string face
1098 (format "%s" default
)
1100 (list (cons "unspecified" 'unspecified
)))))
1101 (cond ((equal new-value
"unspecified")
1103 ((member new-value
'("unspecified-fg" "unspecified-bg"))
1106 (string-to-number new-value
)))))
1109 (defun read-face-attribute (face attribute
&optional frame
)
1110 "Interactively read a new value for FACE's ATTRIBUTE.
1111 Optional argument FRAME nil or unspecified means read an attribute value
1112 of a global face. Value is the new attribute value."
1113 (let* ((old-value (face-attribute face attribute frame
))
1114 (attribute-name (face-descriptive-attribute-name attribute
))
1115 (valid (face-valid-attribute-values attribute frame
))
1117 ;; Represent complex attribute values as strings by printing them
1118 ;; out. Stipple can be a vector; (WIDTH HEIGHT DATA). Box can be
1119 ;; a list `(:width WIDTH :color COLOR)' or `(:width WIDTH :shadow
1121 (when (and (or (eq attribute
:stipple
)
1122 (eq attribute
:box
))
1123 (or (consp old-value
)
1124 (vectorp old-value
)))
1125 (setq old-value
(prin1-to-string old-value
)))
1126 (cond ((listp valid
)
1128 (or (car (rassoc old-value valid
))
1129 (format "%s" old-value
))))
1131 (face-read-string face default attribute-name valid
))
1132 (if (equal new-value default
)
1133 ;; Nothing changed, so don't bother with all the stuff
1134 ;; below. In particular, this avoids a non-tty color
1135 ;; from being canonicalized for a tty when the user
1136 ;; just uses the default.
1137 (setq new-value old-value
)
1138 ;; Terminal frames can support colors that don't appear
1139 ;; explicitly in VALID, using color approximation code
1140 ;; in tty-colors.el.
1141 (when (and (memq attribute
'(:foreground
:background
))
1142 (not (memq (window-system frame
) '(x w32 ns
)))
1143 (not (member new-value
1145 "unspecified-fg" "unspecified-bg"))))
1146 (setq new-value
(car (tty-color-desc new-value frame
))))
1147 (when (assoc new-value valid
)
1148 (setq new-value
(cdr (assoc new-value valid
)))))))
1149 ((eq valid
'integerp
)
1150 (setq new-value
(face-read-integer face old-value attribute-name
)))
1151 (t (error "Internal error")))
1152 ;; Convert stipple and box value text we read back to a list or
1153 ;; vector if it looks like one. This makes the assumption that a
1154 ;; pixmap file name won't start with an open-paren.
1155 (when (and (or (eq attribute
:stipple
)
1156 (eq attribute
:box
))
1158 (string-match "^[[(]" new-value
))
1159 (setq new-value
(read new-value
)))
1162 (declare-function fontset-list
"fontset.c" ())
1163 (declare-function x-list-fonts
"xfaces.c"
1164 (pattern &optional face frame maximum width
))
1166 (defun read-face-font (face &optional frame
)
1167 "Read the name of a font for FACE on FRAME.
1168 If optional argument FRAME is nil or omitted, use the selected frame."
1169 (let ((completion-ignore-case t
))
1170 (completing-read (format "Set font attributes of face `%s' from font: " face
)
1171 (append (fontset-list) (x-list-fonts "*" nil frame
)))))
1174 (defun read-all-face-attributes (face &optional frame
)
1175 "Interactively read all attributes for FACE.
1176 If optional argument FRAME is nil or omitted, use the selected frame.
1177 Value is a property list of attribute names and new values."
1179 (dolist (attribute face-attribute-name-alist result
)
1180 (setq result
(cons (car attribute
)
1181 (cons (read-face-attribute face
(car attribute
) frame
)
1184 (defun modify-face (&optional face foreground background stipple
1185 bold-p italic-p underline inverse-p frame
)
1186 "Modify attributes of faces interactively.
1187 If optional argument FRAME is nil or omitted, modify the face used
1188 for newly created frame, i.e. the global face.
1189 For non-interactive use, `set-face-attribute' is preferred.
1190 When called from Lisp, if FACE is nil, all arguments but FRAME are ignored
1191 and the face and its settings are obtained by querying the user."
1194 (set-face-attribute face frame
1195 :foreground
(or foreground
'unspecified
)
1196 :background
(or background
'unspecified
)
1200 :underline underline
1201 :inverse-video inverse-p
)
1202 (setq face
(read-face-name "Modify face"))
1203 (apply #'set-face-attribute face frame
1204 (read-all-face-attributes face frame
))))
1206 (defun read-face-and-attribute (attribute &optional frame
)
1207 "Read face name and face attribute value.
1208 ATTRIBUTE is the attribute whose new value is read.
1209 FRAME nil or unspecified means read attribute value of global face.
1210 Value is a list (FACE NEW-VALUE) where FACE is the face read
1211 \(a symbol), and NEW-VALUE is value read."
1212 (cond ((eq attribute
:font
)
1213 (let* ((prompt "Set font-related attributes of face")
1214 (face (read-face-name prompt
))
1215 (font (read-face-font face frame
)))
1218 (let* ((attribute-name (face-descriptive-attribute-name attribute
))
1219 (prompt (format "Set %s of face" attribute-name
))
1220 (face (read-face-name prompt
))
1221 (new-value (read-face-attribute face attribute frame
)))
1222 (list face new-value
)))))
1226 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1228 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1230 (defvar list-faces-sample-text
1231 "abcdefghijklmnopqrstuvwxyz ABCDEFGHIJKLMNOPQRSTUVWXYZ"
1232 "*Text string to display as the sample text for `list-faces-display'.")
1235 ;; The name list-faces would be more consistent, but let's avoid a
1236 ;; conflict with Lucid, which uses that name differently.
1238 (defvar help-xref-stack
)
1239 (defun list-faces-display (&optional regexp
)
1240 "List all faces, using the same sample text in each.
1241 The sample text is a string that comes from the variable
1242 `list-faces-sample-text'.
1244 If REGEXP is non-nil, list only those faces with names matching
1245 this regular expression. When called interactively with a prefix
1246 arg, prompt for a regular expression."
1247 (interactive (list (and current-prefix-arg
1248 (read-regexp "List faces matching regexp"))))
1249 (let ((all-faces (zerop (length regexp
)))
1250 (frame (selected-frame))
1253 disp-frame window face-name
)
1254 ;; We filter and take the max length in one pass
1258 (let ((s (symbol-name f
)))
1259 (when (or all-faces
(string-match regexp s
))
1260 (setq max-length
(max (length s
) max-length
))
1262 (sort (face-list) #'string-lessp
))))
1264 (error "No faces matching \"%s\"" regexp
))
1265 (setq max-length
(1+ max-length
)
1266 line-format
(format "%%-%ds" max-length
))
1267 (with-help-window "*Faces*"
1269 (set-buffer standard-output
)
1270 (setq truncate-lines t
)
1272 (substitute-command-keys
1275 (if (display-mouse-p) "\\[help-follow-mouse] or ")
1276 "\\[help-follow] on a face name to customize it\n"
1277 "or on its sample text for a description of the face.\n\n")))
1278 (setq help-xref-stack nil
)
1279 (dolist (face faces
)
1280 (setq face-name
(symbol-name face
))
1281 (insert (format line-format face-name
))
1282 ;; Hyperlink to a customization buffer for the face. Using
1283 ;; the help xref mechanism may not be the best way.
1286 (search-backward face-name
)
1287 (setq help-xref-stack-item
`(list-faces-display ,regexp
))
1288 (help-xref-button 0 'help-customize-face face
)))
1290 (line-beg (line-beginning-position)))
1291 (insert list-faces-sample-text
)
1292 ;; Hyperlink to a help buffer for the face.
1295 (search-backward list-faces-sample-text
)
1296 (help-xref-button 0 'help-face face
)))
1298 (put-text-property beg
(1- (point)) 'face face
)
1299 ;; Make all face commands default to the proper face
1300 ;; anywhere in the line.
1301 (put-text-property line-beg
(1- (point)) 'read-face-name face
)
1302 ;; If the sample text has multiple lines, line up all of them.
1306 (insert-char ?\s max-length
)
1308 (goto-char (point-min))))
1309 ;; If the *Faces* buffer appears in a different frame,
1310 ;; copy all the face definitions from FRAME,
1311 ;; so that the display will reflect the frame that was selected.
1312 (setq window
(get-buffer-window (get-buffer "*Faces*") t
))
1313 (setq disp-frame
(if window
(window-frame window
)
1314 (car (frame-list))))
1315 (or (eq frame disp-frame
)
1316 (let ((faces (face-list)))
1318 (copy-face (car faces
) (car faces
) frame disp-frame
)
1319 (setq faces
(cdr faces
)))))))
1322 (defun describe-face (face &optional frame
)
1323 "Display the properties of face FACE on FRAME.
1324 Interactively, FACE defaults to the faces of the character after point
1325 and FRAME defaults to the selected frame.
1327 If the optional argument FRAME is given, report on face FACE in that frame.
1328 If FRAME is t, report on the defaults for face FACE (for new frames).
1329 If FRAME is omitted or nil, use the selected frame."
1330 (interactive (list (read-face-name "Describe face" "= `default' face" t
)))
1331 (let* ((attrs '((:family .
"Family")
1332 (:foundry .
"Foundry")
1334 (:height .
"Height")
1335 (:weight .
"Weight")
1337 (:foreground .
"Foreground")
1338 (:background .
"Background")
1339 (:underline .
"Underline")
1340 (:overline .
"Overline")
1341 (:strike-through .
"Strike-through")
1343 (:inverse-video .
"Inverse")
1344 (:stipple .
"Stipple")
1346 (:fontset .
"Fontset")
1347 (:inherit .
"Inherit")))
1348 (max-width (apply #'max
(mapcar #'(lambda (x) (length (cdr x
)))
1350 (help-setup-xref (list #'describe-face face
) (interactive-p))
1352 (setq face
'default
))
1353 (if (not (listp face
))
1354 (setq face
(list face
)))
1355 (with-help-window (help-buffer)
1357 (set-buffer standard-output
)
1359 (if (stringp f
) (setq f
(intern f
)))
1360 ;; We may get called for anonymous faces (i.e., faces
1361 ;; expressed using prop-value plists). Those can't be
1362 ;; usefully customized, so ignore them.
1364 (insert "Face: " (symbol-name f
))
1366 (insert " undefined face.\n")
1367 (let ((customize-label "customize this face")
1369 (insert (concat " (" (propertize "sample" 'font-lock-face f
) ")"))
1370 (princ (concat " (" customize-label
")\n"))
1371 (insert "Documentation: "
1372 (or (face-documentation f
)
1373 "Not documented as a face.")
1375 (with-current-buffer standard-output
1378 (concat "\\(" customize-label
"\\)") nil t
)
1379 (help-xref-button 1 'help-customize-face f
)))
1380 (setq file-name
(find-lisp-object-file-name f
'defface
))
1382 (princ "Defined in `")
1383 (princ (file-name-nondirectory file-name
))
1385 ;; Make a hyperlink to the library.
1387 (re-search-backward "`\\([^`']+\\)'" nil t
)
1388 (help-xref-button 1 'help-face-def f file-name
))
1393 (let ((attr (face-attribute f
(car a
) frame
)))
1394 (insert (make-string (- max-width
(length (cdr a
))) ?\s
)
1395 (cdr a
) ": " (format "%s" attr
))
1396 (if (and (eq (car a
) :inherit
)
1397 (not (eq attr
'unspecified
)))
1398 ;; Make a hyperlink to the parent face.
1400 (re-search-backward ": \\([^:]+\\)" nil t
)
1401 (help-xref-button 1 'help-face attr
)))
1406 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1407 ;;; Face specifications (defface).
1408 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1410 ;; Parameter FRAME Is kept for call compatibility to with previous
1411 ;; face implementation.
1413 (defun face-attr-construct (face &optional frame
)
1414 "Return a `defface'-style attribute list for FACE on FRAME.
1415 Value is a property list of pairs ATTRIBUTE VALUE for all specified
1416 face attributes of FACE where ATTRIBUTE is the attribute name and
1417 VALUE is the specified value of that attribute."
1419 (dolist (entry face-attribute-name-alist result
)
1420 (let* ((attribute (car entry
))
1421 (value (face-attribute face attribute
)))
1422 (unless (eq value
'unspecified
)
1423 (setq result
(nconc (list attribute value
) result
)))))))
1426 (defun face-spec-set-match-display (display frame
)
1427 "Non-nil if DISPLAY matches FRAME.
1428 DISPLAY is part of a spec such as can be used in `defface'.
1429 If FRAME is nil, the current FRAME is used."
1430 (let* ((conjuncts display
)
1431 conjunct req options
1432 ;; t means we have succeeded against all the conjuncts in
1433 ;; DISPLAY that have been tested so far.
1435 (if (eq conjuncts t
)
1436 (setq conjuncts nil
))
1437 (while (and conjuncts match
)
1438 (setq conjunct
(car conjuncts
)
1439 conjuncts
(cdr conjuncts
)
1441 options
(cdr conjunct
)
1442 match
(cond ((eq req
'type
)
1443 (or (memq (window-system frame
) options
)
1444 ;; FIXME: This should be revisited to use
1445 ;; display-graphic-p, provided that the
1446 ;; color selection depends on the number
1447 ;; of supported colors, and all defface's
1448 ;; are changed to look at number of colors
1449 ;; instead of (type graphic) etc.
1450 (and (null (window-system frame
))
1451 (memq 'tty options
))
1452 (and (memq 'motif options
)
1454 (and (memq 'gtk options
)
1456 (and (memq 'lucid options
)
1457 (featurep 'x-toolkit
)
1458 (not (featurep 'motif
))
1459 (not (featurep 'gtk
)))
1460 (and (memq 'x-toolkit options
)
1461 (featurep 'x-toolkit
))))
1462 ((eq req
'min-colors
)
1463 (>= (display-color-cells frame
) (car options
)))
1465 (memq (frame-parameter frame
'display-type
) options
))
1466 ((eq req
'background
)
1467 (memq (frame-parameter frame
'background-mode
)
1470 (display-supports-face-attributes-p options frame
))
1471 (t (error "Unknown req `%S' with options `%S'"
1476 (defun face-spec-choose (spec &optional frame
)
1477 "Choose the proper attributes for FRAME, out of SPEC.
1478 If SPEC is nil, return nil."
1480 (setq frame
(selected-frame)))
1484 (let* ((entry (pop tail
))
1485 (display (car entry
))
1488 ;; Get the attributes as actually specified by this alternative.
1490 (if (null (cdr attrs
)) ;; was (listp (car attrs))
1491 ;; Old-style entry, the attribute list is the
1496 ;; If the condition is `default', that sets the default
1497 ;; for following conditions.
1498 (if (eq display
'default
)
1499 (setq defaults thisval
)
1500 ;; Otherwise, if it matches, use it.
1501 (when (face-spec-set-match-display display frame
)
1502 (setq result thisval
)
1504 (if defaults
(append result defaults
) result
)))
1507 (defun face-spec-reset-face (face &optional frame
)
1508 "Reset all attributes of FACE on FRAME to unspecified."
1509 (let ((attrs face-attribute-name-alist
))
1511 (let ((attr-and-name (car attrs
)))
1512 (set-face-attribute face frame
(car attr-and-name
) 'unspecified
))
1513 (setq attrs
(cdr attrs
)))))
1516 (defun face-spec-set (face spec
&optional for-defface
)
1517 "Set FACE's face spec, which controls its appearance, to SPEC.
1518 If FOR-DEFFACE is t, set the base spec, the one that `defface'
1519 and Custom set. (In that case, the caller must put it in the
1520 appropriate property, because that depends on the caller.)
1521 If FOR-DEFFACE is nil, set the overriding spec (and store it
1522 in the `face-override-spec' property of FACE).
1524 The appearance of FACE is controlled by the base spec,
1525 by any custom theme specs on top of that, and by the
1526 overriding spec on top of all the rest.
1528 FOR-DEFFACE can also be a frame, in which case we set the
1529 frame-specific attributes of FACE for that frame based on SPEC.
1530 That usage is deprecated.
1532 See `defface' for information about the format and meaning of SPEC."
1533 (if (framep for-defface
)
1534 ;; Handle the deprecated case where third arg is a frame.
1535 (face-spec-set-2 face for-defface spec
)
1537 ;; When we reset the face based on its custom spec, then it is
1538 ;; unmodified as far as Custom is concerned.
1539 (put (or (get face
'face-alias
) face
) 'face-modified nil
)
1540 ;; When we change a face based on a spec from outside custom,
1541 ;; record it for future frames.
1542 (put (or (get face
'face-alias
) face
) 'face-override-spec spec
))
1543 ;; Reset each frame according to the rules implied by all its specs.
1544 (dolist (frame (frame-list))
1545 (face-spec-recalc face frame
))))
1547 (defun face-spec-recalc (face frame
)
1548 "Reset the face attributes of FACE on FRAME according to its specs.
1549 This applies the defface/custom spec first, then the custom theme specs,
1550 then the override spec."
1551 (face-spec-reset-face face frame
)
1552 (let ((face-sym (or (get face
'face-alias
) face
)))
1553 (or (get face
'customized-face
)
1554 (get face
'saved-face
)
1555 (face-spec-set-2 face frame
(face-default-spec face
)))
1556 (let ((theme-faces (reverse (get face-sym
'theme-face
))))
1557 (dolist (spec theme-faces
)
1558 (face-spec-set-2 face frame
(cadr spec
))))
1559 (face-spec-set-2 face frame
(get face-sym
'face-override-spec
))))
1561 (defun face-spec-set-2 (face frame spec
)
1562 "Set the face attributes of FACE on FRAME according to SPEC."
1563 (let* ((spec (face-spec-choose spec frame
))
1566 (when (assq (car spec
) face-x-resources
)
1567 (push (car spec
) attrs
)
1568 (push (cadr spec
) attrs
))
1569 (setq spec
(cddr spec
)))
1570 (apply 'set-face-attribute face frame
(nreverse attrs
))))
1572 (defun face-attr-match-p (face attrs
&optional frame
)
1573 "Return t if attributes of FACE match values in plist ATTRS.
1574 Optional parameter FRAME is the frame whose definition of FACE
1575 is used. If nil or omitted, use the selected frame."
1577 (setq frame
(selected-frame)))
1578 (let ((list face-attribute-name-alist
)
1580 (while (and match
(not (null list
)))
1581 (let* ((attr (car (car list
)))
1583 (if (plist-member attrs attr
)
1584 (plist-get attrs attr
)
1586 (value-now (face-attribute face attr frame
)))
1587 (setq match
(equal specified-value value-now
))
1588 (setq list
(cdr list
))))
1591 (defun face-spec-match-p (face spec
&optional frame
)
1592 "Return t if FACE, on FRAME, matches what SPEC says it should look like."
1593 (face-attr-match-p face
(face-spec-choose spec frame
) frame
))
1595 (defsubst face-default-spec
(face)
1596 "Return the default face-spec for FACE, ignoring any user customization.
1597 If there is no default for FACE, return nil."
1598 (get face
'face-defface-spec
))
1600 (defsubst face-user-default-spec
(face)
1601 "Return the user's customized face-spec for FACE, or the default if none.
1602 If there is neither a user setting nor a default for FACE, return nil."
1603 (or (get face
'customized-face
)
1604 (get face
'saved-face
)
1605 (face-default-spec face
)))
1608 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1609 ;;; Frame-type independent color support.
1610 ;;; We keep the old x-* names as aliases for back-compatibility.
1611 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1613 (defun defined-colors (&optional frame
)
1614 "Return a list of colors supported for a particular frame.
1615 The argument FRAME specifies which frame to try.
1616 The value may be different for frames on different display types.
1617 If FRAME doesn't support colors, the value is nil.
1618 If FRAME is nil, that stands for the selected frame."
1619 (if (memq (framep (or frame
(selected-frame))) '(x w32 ns
))
1620 (xw-defined-colors frame
)
1621 (mapcar 'car
(tty-color-alist frame
))))
1622 (defalias 'x-defined-colors
'defined-colors
)
1624 (declare-function xw-color-defined-p
"xfns.c" (color &optional frame
))
1626 (defun color-defined-p (color &optional frame
)
1627 "Return non-nil if color COLOR is supported on frame FRAME.
1628 If FRAME is omitted or nil, use the selected frame.
1629 If COLOR is the symbol `unspecified' or one of the strings
1630 \"unspecified-fg\" or \"unspecified-bg\", the value is nil."
1631 (if (member color
'(unspecified "unspecified-bg" "unspecified-fg"))
1633 (if (member (framep (or frame
(selected-frame))) '(x w32 ns
))
1634 (xw-color-defined-p color frame
)
1635 (numberp (tty-color-translate color frame
)))))
1636 (defalias 'x-color-defined-p
'color-defined-p
)
1638 (declare-function xw-color-values
"xfns.c" (color &optional frame
))
1640 (defun color-values (color &optional frame
)
1641 "Return a description of the color named COLOR on frame FRAME.
1642 The value is a list of integer RGB values--(RED GREEN BLUE).
1643 These values appear to range from 0 to 65280 or 65535, depending
1644 on the system; white is \(65280 65280 65280\) or \(65535 65535 65535\).
1645 If FRAME is omitted or nil, use the selected frame.
1646 If FRAME cannot display COLOR, the value is nil.
1647 If COLOR is the symbol `unspecified' or one of the strings
1648 \"unspecified-fg\" or \"unspecified-bg\", the value is nil."
1649 (if (member color
'(unspecified "unspecified-fg" "unspecified-bg"))
1651 (if (memq (framep (or frame
(selected-frame))) '(x w32 ns
))
1652 (xw-color-values color frame
)
1653 (tty-color-values color frame
))))
1654 (defalias 'x-color-values
'color-values
)
1656 (declare-function xw-display-color-p
"xfns.c" (&optional terminal
))
1658 (defun display-color-p (&optional display
)
1659 "Return t if DISPLAY supports color.
1660 The optional argument DISPLAY specifies which display to ask about.
1661 DISPLAY should be either a frame or a display name (a string).
1662 If omitted or nil, that stands for the selected frame's display."
1663 (if (memq (framep-on-display display
) '(x w32 ns
))
1664 (xw-display-color-p display
)
1665 (tty-display-color-p display
)))
1666 (defalias 'x-display-color-p
'display-color-p
)
1668 (declare-function x-display-grayscale-p
"xfns.c" (&optional terminal
))
1670 (defun display-grayscale-p (&optional display
)
1671 "Return non-nil if frames on DISPLAY can display shades of gray."
1672 (let ((frame-type (framep-on-display display
)))
1674 ((memq frame-type
'(x w32 ns
))
1675 (x-display-grayscale-p display
))
1677 (> (tty-color-gray-shades display
) 2)))))
1679 (defun read-color (&optional prompt convert-to-RGB-p allow-empty-name-p msg-p
)
1680 "Read a color name or RGB hex value: #RRRRGGGGBBBB.
1681 Completion is available for color names, but not for RGB hex strings.
1682 If the user inputs an RGB hex string, it must have the form
1683 #XXXXXXXXXXXX or XXXXXXXXXXXX, where each X is a hex digit. The
1684 number of Xs must be a multiple of 3, with the same number of Xs for
1685 each of red, green, and blue. The order is red, green, blue.
1687 In addition to standard color names and RGB hex values, the following
1688 are available as color candidates. In each case, the corresponding
1691 * `foreground at point' - foreground under the cursor
1692 * `background at point' - background under the cursor
1694 Checks input to be sure it represents a valid color. If not, raises
1695 an error (but see exception for empty input with non-nil
1696 ALLOW-EMPTY-NAME-P).
1698 Optional arg PROMPT is the prompt; if nil, uses a default prompt.
1700 Interactively, or with optional arg CONVERT-TO-RGB-P non-nil, converts
1701 an input color name to an RGB hex string. Returns the RGB hex string.
1703 Optional arg ALLOW-EMPTY-NAME-P controls what happens if the user
1704 enters an empty color name (that is, just hits `RET'). If non-nil,
1705 then returns an empty color name, \"\". If nil, then raises an error.
1706 Programs must test for \"\" if ALLOW-EMPTY-NAME-P is non-nil. They
1707 can then perform an appropriate action in case of empty input.
1709 Interactively, or with optional arg MSG-P non-nil, echoes the color in
1711 (interactive "i\np\ni\np") ; Always convert to RGB interactively.
1712 (let* ((completion-ignore-case t
)
1713 (colors (append '("foreground at point" "background at point")
1715 (color (completing-read (or prompt
"Color (name or #R+G+B+): ")
1718 (cond ((string= "foreground at point" color
)
1719 (setq color
(foreground-color-at-point)))
1720 ((string= "background at point" color
)
1721 (setq color
(background-color-at-point))))
1725 (string-match "^#?\\([a-fA-F0-9][a-fA-F0-9][a-fA-F0-9]\\)+$" color
))
1726 (if (and allow-empty-name-p
(string= "" color
))
1728 (when (and hex-string
(not (eq (aref color
0) ?
#)))
1729 (setq color
(concat "#" color
))) ; No #; add it.
1731 (when (or (string= "" color
) (not (test-completion color colors
)))
1732 (error "No such color: %S" color
))
1733 (when convert-to-RGB-p
1734 (let ((components (x-color-values color
)))
1735 (unless components
(error "No such color: %S" color
))
1736 (unless (string-match "^#\\([a-fA-F0-9][a-fA-F0-9][a-fA-F0-9]\\)+$" color
)
1737 (setq color
(format "#%04X%04X%04X"
1738 (logand 65535 (nth 0 components
))
1739 (logand 65535 (nth 1 components
))
1740 (logand 65535 (nth 2 components
))))))))
1741 (when msg-p
(message "Color: `%s'" color
))
1744 ;; Commented out because I decided it is better to include the
1745 ;; duplicates in read-color's completion list.
1747 ;; (defun defined-colors-without-duplicates ()
1748 ;; "Return the list of defined colors, without the no-space versions.
1749 ;; For each color name, we keep the variant that DOES have spaces."
1750 ;; (let ((result (copy-sequence (defined-colors)))
1753 ;; (dolist (this result)
1754 ;; (if (string-match " " this)
1755 ;; (push (replace-regexp-in-string " " ""
1757 ;; to-be-rejected)))
1758 ;; (dolist (elt to-be-rejected)
1759 ;; (let ((as-found (car (member-ignore-case elt result))))
1760 ;; (setq result (delete as-found result)))))
1763 (defun face-at-point ()
1764 "Return the face of the character after point.
1765 If it has more than one face, return the first one.
1766 Return nil if it has no specified face."
1767 (let* ((faceprop (or (get-char-property (point) 'read-face-name
)
1768 (get-char-property (point) 'face
)
1770 (face (cond ((symbolp faceprop
) faceprop
)
1771 ;; List of faces (don't treat an attribute spec).
1772 ;; Just use the first face.
1773 ((and (consp faceprop
) (not (keywordp (car faceprop
)))
1774 (not (memq (car faceprop
)
1775 '(foreground-color background-color
))))
1777 (t nil
)))) ; Invalid face value.
1778 (if (facep face
) face nil
)))
1780 (defun foreground-color-at-point ()
1781 "Return the foreground color of the character after point."
1782 ;; `face-at-point' alone is not sufficient. It only gets named faces.
1783 ;; Need also pick up any face properties that are not associated with named faces.
1784 (let ((face (or (face-at-point)
1785 (get-char-property (point) 'read-face-name
)
1786 (get-char-property (point) 'face
))))
1787 (cond ((and face
(symbolp face
))
1788 (let ((value (face-foreground face nil
'default
)))
1789 (if (member value
'("unspecified-fg" "unspecified-bg"))
1793 (cond ((memq 'foreground-color face
) (cdr (memq 'foreground-color face
)))
1794 ((memq ':foreground face
) (cadr (memq ':foreground face
)))))
1795 (t nil
)))) ; Invalid face value.
1797 (defun background-color-at-point ()
1798 "Return the background color of the character after point."
1799 ;; `face-at-point' alone is not sufficient. It only gets named faces.
1800 ;; Need also pick up any face properties that are not associated with named faces.
1801 (let ((face (or (face-at-point)
1802 (get-char-property (point) 'read-face-name
)
1803 (get-char-property (point) 'face
))))
1804 (cond ((and face
(symbolp face
))
1805 (let ((value (face-background face nil
'default
)))
1806 (if (member value
'("unspecified-fg" "unspecified-bg"))
1810 (cond ((memq 'background-color face
) (cdr (memq 'background-color face
)))
1811 ((memq ':background face
) (cadr (memq ':background face
)))))
1812 (t nil
)))) ; Invalid face value.
1814 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1815 ;;; Background mode.
1816 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1818 (defcustom frame-background-mode nil
1819 "The brightness of the background.
1820 Set this to the symbol `dark' if your background color is dark,
1821 `light' if your background is light, or nil (automatic by default)
1822 if you want Emacs to examine the brightness for you. Don't set this
1823 variable with `setq'; this won't have the expected effect."
1825 :set
#'(lambda (var value
)
1826 (set-default var value
)
1827 (mapc 'frame-set-background-mode
(frame-list)))
1828 :initialize
'custom-initialize-changed
1829 :type
'(choice (const dark
)
1831 (const :tag
"automatic" nil
)))
1834 (declare-function x-get-resource
"frame.c"
1835 (attribute class
&optional component subclass
))
1837 (defvar inhibit-frame-set-background-mode nil
)
1839 (defun frame-set-background-mode (frame)
1840 "Set up display-dependent faces on FRAME.
1841 Display-dependent faces are those which have different definitions
1842 according to the `background-mode' and `display-type' frame parameters."
1843 (unless inhibit-frame-set-background-mode
1845 (and (window-system frame
)
1846 (x-get-resource "backgroundMode" "BackgroundMode")))
1847 (bg-color (frame-parameter frame
'background-color
))
1848 (terminal-bg-mode (terminal-parameter frame
'background-mode
))
1849 (tty-type (tty-type frame
))
1851 (cond (frame-background-mode)
1852 (bg-resource (intern (downcase bg-resource
)))
1854 ((and (null (window-system frame
))
1855 ;; Unspecified frame background color can only
1857 (member bg-color
'(nil unspecified
"unspecified-bg")))
1858 ;; There is no way to determine the background mode
1859 ;; automatically, so we make a guess based on the
1862 (string-match "^\\(xterm\\|rxvt\\|dtterm\\|eterm\\)"
1866 ((equal bg-color
"unspecified-fg") ; inverted colors
1868 (string-match "^\\(xterm\\|rxvt\\|dtterm\\|eterm\\)"
1872 ((>= (apply '+ (color-values bg-color frame
))
1873 ;; Just looking at the screen, colors whose
1874 ;; values add up to .6 of the white total
1875 ;; still look dark to me.
1876 (* (apply '+ (color-values "white" frame
)) .6))
1880 (cond ((null (window-system frame
))
1881 (if (tty-display-color-p frame
) 'color
'mono
))
1882 ((display-color-p frame
)
1884 ((x-display-grayscale-p frame
)
1888 (frame-parameter frame
'background-mode
))
1890 (frame-parameter frame
'display-type
)))
1892 (unless (and (eq bg-mode old-bg-mode
) (eq display-type old-display-type
))
1893 (let ((locally-modified-faces nil
)
1894 ;; Prevent face-spec-recalc from calling this function
1895 ;; again, resulting in a loop (bug#911).
1896 (inhibit-frame-set-background-mode t
))
1897 ;; Before modifying the frame parameters, collect a list of
1898 ;; faces that don't match what their face-spec says they
1899 ;; should look like. We then avoid changing these faces
1900 ;; below. These are the faces whose attributes were
1901 ;; modified on FRAME. We use a negative list on the
1902 ;; assumption that most faces will be unmodified, so we can
1903 ;; avoid consing in the common case.
1904 (dolist (face (face-list))
1905 (and (not (get face
'face-override-spec
))
1906 (not (face-spec-match-p face
1907 (face-user-default-spec face
)
1909 (push face locally-modified-faces
)))
1910 ;; Now change to the new frame parameters
1911 (modify-frame-parameters frame
1912 (list (cons 'background-mode bg-mode
)
1913 (cons 'display-type display-type
)))
1914 ;; For all named faces, choose face specs matching the new frame
1915 ;; parameters, unless they have been locally modified.
1916 (dolist (face (face-list))
1917 (unless (memq face locally-modified-faces
)
1918 (face-spec-recalc face frame
))))))))
1921 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1923 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1925 (declare-function x-parse-geometry
"frame.c" (string))
1927 (defun x-handle-named-frame-geometry (parameters)
1928 "Add geometry parameters for a named frame to parameter list PARAMETERS.
1929 Value is the new parameter list."
1930 (let* ((name (or (cdr (assq 'name parameters
))
1931 (cdr (assq 'name default-frame-alist
))))
1932 (x-resource-name name
)
1933 (res-geometry (if name
(x-get-resource "geometry" "Geometry"))))
1935 (let ((parsed (x-parse-geometry res-geometry
)))
1936 ;; If the resource specifies a position, call the position
1937 ;; and size "user-specified".
1938 (when (or (assq 'top parsed
)
1939 (assq 'left parsed
))
1940 (setq parsed
(append '((user-position . t
) (user-size . t
)) parsed
)))
1941 ;; Put the geometry parameters at the end. Copy
1942 ;; default-frame-alist so that they go after it.
1943 (setq parameters
(append parameters default-frame-alist parsed
))))
1947 (defun x-handle-reverse-video (frame parameters
)
1948 "Handle the reverse-video frame parameter and X resource.
1949 `x-create-frame' does not handle this one."
1950 (when (cdr (or (assq 'reverse parameters
)
1951 (assq 'reverse default-frame-alist
)
1952 (let ((resource (x-get-resource "reverseVideo"
1955 (cons nil
(member (downcase resource
)
1956 '("on" "true")))))))
1957 (let* ((params (frame-parameters frame
))
1958 (bg (cdr (assq 'foreground-color params
)))
1959 (fg (cdr (assq 'background-color params
))))
1960 (modify-frame-parameters frame
1961 (list (cons 'foreground-color fg
)
1962 (cons 'background-color bg
)))
1963 (if (equal bg
(cdr (assq 'border-color params
)))
1964 (modify-frame-parameters frame
1965 (list (cons 'border-color fg
))))
1966 (if (equal bg
(cdr (assq 'mouse-color params
)))
1967 (modify-frame-parameters frame
1968 (list (cons 'mouse-color fg
))))
1969 (if (equal bg
(cdr (assq 'cursor-color params
)))
1970 (modify-frame-parameters frame
1971 (list (cons 'cursor-color fg
)))))))
1973 (declare-function x-create-frame
"xfns.c" (parms))
1974 (declare-function x-setup-function-keys
"term/x-win" (frame))
1976 (defun x-create-frame-with-faces (&optional parameters
)
1977 "Create a frame from optional frame parameters PARAMETERS.
1978 Parameters not specified by PARAMETERS are taken from
1979 `default-frame-alist'. If PARAMETERS specify a frame name,
1980 handle X geometry resources for that name. If either PARAMETERS
1981 or `default-frame-alist' contains a `reverse' parameter, or
1982 the X resource ``reverseVideo'' is present, handle that.
1983 Value is the new frame created."
1984 (setq parameters
(x-handle-named-frame-geometry parameters
))
1985 (let* ((params (copy-tree parameters
))
1986 (visibility-spec (assq 'visibility parameters
))
1987 (delayed-params '(foreground-color background-color font
1988 border-color cursor-color mouse-color
1989 visibility scroll-bar-foreground
1990 scroll-bar-background
))
1992 (dolist (param delayed-params
)
1993 (setq params
(assq-delete-all param params
)))
1994 (setq frame
(x-create-frame `((visibility . nil
) .
,params
)))
1997 (x-setup-function-keys frame
)
1998 (x-handle-reverse-video frame parameters
)
1999 (frame-set-background-mode frame
)
2000 (face-set-after-frame-default frame parameters
)
2001 (if (null visibility-spec
)
2002 (make-frame-visible frame
)
2003 (modify-frame-parameters frame
(list visibility-spec
)))
2006 (delete-frame frame
)))
2009 (defun face-set-after-frame-default (frame &optional parameters
)
2010 "Initialize the frame-local faces of FRAME.
2011 Calculate the face definitions using the face specs, custom theme
2012 settings, X resources, and `face-new-frame-defaults'.
2013 Finally, apply any relevant face attributes found amongst the
2014 frame parameters in PARAMETERS and `default-frame-alist'."
2015 (dolist (face (nreverse (face-list)))
2018 ;; Initialize faces from face spec and custom theme.
2019 (face-spec-recalc face frame
)
2020 ;; X resouces for the default face are applied during
2022 (and (not (eq face
'default
))
2023 (memq (window-system frame
) '(x w32
))
2024 (make-face-x-resource-internal face frame
))
2025 ;; Apply attributes specified by face-new-frame-defaults
2026 (internal-merge-in-global-face face frame
))
2027 ;; Don't let invalid specs prevent frame creation.
2029 ;; Apply attributes specified by frame parameters.
2030 (let ((face-params '((foreground-color default
:foreground
)
2031 (background-color default
:background
)
2032 (font default
:font
)
2033 (border-color border
:background
)
2034 (cursor-color cursor
:background
)
2035 (scroll-bar-foreground scroll-bar
:foreground
)
2036 (scroll-bar-background scroll-bar
:background
)
2037 (mouse-color mouse
:background
))))
2038 (dolist (param face-params
)
2039 (let* ((param-name (nth 0 param
))
2040 (value (cdr (or (assq param-name parameters
)
2041 (assq param-name default-frame-alist
)))))
2043 (set-face-attribute (nth 1 param
) frame
2044 (nth 2 param
) value
))))))
2046 (defun tty-handle-reverse-video (frame parameters
)
2047 "Handle the reverse-video frame parameter for terminal frames."
2048 (when (cdr (or (assq 'reverse parameters
)
2049 (assq 'reverse default-frame-alist
)))
2050 (let* ((params (frame-parameters frame
))
2051 (bg (cdr (assq 'foreground-color params
)))
2052 (fg (cdr (assq 'background-color params
))))
2053 (modify-frame-parameters frame
2054 (list (cons 'foreground-color fg
)
2055 (cons 'background-color bg
)))
2056 (if (equal bg
(cdr (assq 'mouse-color params
)))
2057 (modify-frame-parameters frame
2058 (list (cons 'mouse-color fg
))))
2059 (if (equal bg
(cdr (assq 'cursor-color params
)))
2060 (modify-frame-parameters frame
2061 (list (cons 'cursor-color fg
)))))))
2064 (defun tty-create-frame-with-faces (&optional parameters
)
2065 "Create a frame from optional frame parameters PARAMETERS.
2066 Parameters not specified by PARAMETERS are taken from
2067 `default-frame-alist'. If either PARAMETERS or `default-frame-alist'
2068 contains a `reverse' parameter, handle that. Value is the new frame
2070 (let ((frame (make-terminal-frame parameters
))
2073 (with-selected-frame frame
2074 (tty-handle-reverse-video frame
(frame-parameters frame
))
2076 (unless (terminal-parameter frame
'terminal-initted
)
2077 (set-terminal-parameter frame
'terminal-initted t
)
2078 (set-locale-environment nil frame
)
2079 (tty-run-terminal-initialization frame
))
2080 (frame-set-background-mode frame
)
2081 (face-set-after-frame-default frame parameters
)
2084 (delete-frame frame
)))
2087 (defun tty-find-type (pred type
)
2088 "Return the longest prefix of TYPE to which PRED returns non-nil.
2089 TYPE should be a tty type name such as \"xterm-16color\".
2091 The function tries only those prefixes that are followed by a
2092 dash or underscore in the original type name, like \"xterm\" in
2096 (not (funcall pred type
)))
2097 ;; Strip off last hyphen and what follows, then try again
2099 (if (setq hyphend
(string-match "[-_][^-_]+$" type
))
2100 (substring type
0 hyphend
)
2104 (defun tty-run-terminal-initialization (frame &optional type
)
2105 "Run the special initialization code for the terminal type of FRAME.
2106 The optional TYPE parameter may be used to override the autodetected
2107 terminal type to a different value."
2108 (setq type
(or type
(tty-type frame
)))
2109 ;; Load library for our terminal type.
2110 ;; User init file can set term-file-prefix to nil to prevent this.
2111 (with-selected-frame frame
2112 (unless (null term-file-prefix
)
2113 (let* (term-init-func)
2114 ;; First, load the terminal initialization file, if it is
2115 ;; available and it hasn't been loaded already.
2116 (tty-find-type #'(lambda (type)
2117 (let ((file (locate-library (concat term-file-prefix type
))))
2119 (or (assoc file load-history
)
2122 ;; Next, try to find a matching initialization function, and call it.
2123 (tty-find-type #'(lambda (type)
2124 (fboundp (setq term-init-func
2125 (intern (concat "terminal-init-" type
)))))
2127 (when (fboundp term-init-func
)
2128 (funcall term-init-func
))
2129 (set-terminal-parameter frame
'terminal-initted term-init-func
)))))
2131 ;; Called from C function init_display to initialize faces of the
2132 ;; dumped terminal frame on startup.
2134 (defun tty-set-up-initial-frame-faces ()
2135 (let ((frame (selected-frame)))
2136 (frame-set-background-mode frame
)
2137 (face-set-after-frame-default frame
)))
2142 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2143 ;;; Compatiblity with 20.2
2144 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2146 ;; Update a frame's faces when we change its default font.
2148 (defalias 'frame-update-faces
'ignore
"")
2149 (make-obsolete 'frame-update-faces
"no longer necessary." "21.1")
2151 ;; Update the colors of FACE, after FRAME's own colors have been
2154 (define-obsolete-function-alias 'frame-update-face-colors
2155 'frame-set-background-mode
"21.1")
2158 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2160 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2162 (defgroup basic-faces nil
2163 "The standard faces of Emacs."
2167 '((t nil
)) ; If this were nil, face-defface-spec would not be set.
2168 "Basic default face."
2169 :group
'basic-faces
)
2174 :group
'basic-faces
)
2177 '((((supports :slant italic
))
2179 (((supports :underline t
))
2182 ;; default to italic, even it doesn't appear to be supported,
2183 ;; because in some cases the display engine will do it's own
2184 ;; workaround (to `dim' on ttys)
2186 "Basic italic face."
2187 :group
'basic-faces
)
2189 (defface bold-italic
2190 '((t :weight bold
:slant italic
))
2191 "Basic bold-italic face."
2192 :group
'basic-faces
)
2195 '((((supports :underline t
))
2197 (((supports :weight bold
))
2200 "Basic underlined face."
2201 :group
'basic-faces
)
2203 (defface fixed-pitch
2204 '((t :family
"Monospace"))
2205 "The basic fixed-pitch face."
2206 :group
'basic-faces
)
2208 (defface variable-pitch
2209 '((t :family
"Sans Serif"))
2210 "The basic variable-pitch face."
2211 :group
'basic-faces
)
2214 '((((class color grayscale
) (min-colors 88) (background light
))
2215 :foreground
"grey50")
2216 (((class color grayscale
) (min-colors 88) (background dark
))
2217 :foreground
"grey70")
2218 (((class color
) (min-colors 8) (background light
))
2219 :foreground
"green")
2220 (((class color
) (min-colors 8) (background dark
))
2221 :foreground
"yellow"))
2222 "Basic face for shadowed text."
2227 '((((class color
) (min-colors 88) (background light
))
2228 :foreground
"blue1" :underline t
)
2229 (((class color
) (background light
))
2230 :foreground
"blue" :underline t
)
2231 (((class color
) (min-colors 88) (background dark
))
2232 :foreground
"cyan1" :underline t
)
2233 (((class color
) (background dark
))
2234 :foreground
"cyan" :underline t
)
2235 (t :inherit underline
))
2236 "Basic face for unvisited links."
2240 (defface link-visited
2241 '((default :inherit link
)
2242 (((class color
) (background light
)) :foreground
"magenta4")
2243 (((class color
) (background dark
)) :foreground
"violet"))
2244 "Basic face for visited links."
2249 '((((class color
) (min-colors 88) (background light
))
2250 :background
"darkseagreen2")
2251 (((class color
) (min-colors 88) (background dark
))
2252 :background
"darkolivegreen")
2253 (((class color
) (min-colors 16) (background light
))
2254 :background
"darkseagreen2")
2255 (((class color
) (min-colors 16) (background dark
))
2256 :background
"darkolivegreen")
2257 (((class color
) (min-colors 8))
2258 :background
"green" :foreground
"black")
2259 (t :inverse-video t
))
2260 "Basic face for highlighting."
2261 :group
'basic-faces
)
2264 '((((class color
) (min-colors 88) (background dark
))
2265 :background
"blue3")
2266 (((class color
) (min-colors 88) (background light
))
2267 :background
"lightgoldenrod2")
2268 (((class color
) (min-colors 16) (background dark
))
2269 :background
"blue3")
2270 (((class color
) (min-colors 16) (background light
))
2271 :background
"lightgoldenrod2")
2272 (((class color
) (min-colors 8))
2273 :background
"blue" :foreground
"white")
2274 (((type tty
) (class mono
))
2276 (t :background
"gray"))
2277 "Basic face for highlighting the region."
2279 :group
'basic-faces
)
2281 (defface secondary-selection
2282 '((((class color
) (min-colors 88) (background light
))
2283 :background
"yellow1")
2284 (((class color
) (min-colors 88) (background dark
))
2285 :background
"SkyBlue4")
2286 (((class color
) (min-colors 16) (background light
))
2287 :background
"yellow")
2288 (((class color
) (min-colors 16) (background dark
))
2289 :background
"SkyBlue4")
2290 (((class color
) (min-colors 8))
2291 :background
"cyan" :foreground
"black")
2292 (t :inverse-video t
))
2293 "Basic face for displaying the secondary selection."
2294 :group
'basic-faces
)
2296 (defface trailing-whitespace
2297 '((((class color
) (background light
))
2299 (((class color
) (background dark
))
2301 (t :inverse-video t
))
2302 "Basic face for highlighting trailing whitespace."
2304 :group
'whitespace-faces
; like `show-trailing-whitespace'
2305 :group
'basic-faces
)
2307 (defface escape-glyph
2308 '((((background dark
)) :foreground
"cyan")
2309 ;; See the comment in minibuffer-prompt for
2310 ;; the reason not to use blue on MS-DOS.
2311 (((type pc
)) :foreground
"magenta")
2312 ;; red4 is too dark, but some say blue is too loud.
2313 ;; brown seems to work ok. -- rms.
2314 (t :foreground
"brown"))
2315 "Face for characters displayed as sequences using `^' or `\\'."
2319 (defface nobreak-space
2320 '((((class color
) (min-colors 88)) :inherit escape-glyph
:underline t
)
2321 (((class color
) (min-colors 8)) :background
"magenta")
2322 (t :inverse-video t
))
2323 "Face for displaying nobreak space."
2327 (defgroup mode-line-faces nil
2328 "Faces used in the mode line."
2334 '((((class color
) (min-colors 88))
2335 :box
(:line-width -
1 :style released-button
)
2336 :background
"grey75" :foreground
"black")
2339 "Basic mode line face for selected window."
2341 :group
'mode-line-faces
2342 :group
'basic-faces
)
2344 (defface mode-line-inactive
2347 (((class color
) (min-colors 88) (background light
))
2349 :box
(:line-width -
1 :color
"grey75" :style nil
)
2350 :foreground
"grey20" :background
"grey90")
2351 (((class color
) (min-colors 88) (background dark
) )
2353 :box
(:line-width -
1 :color
"grey40" :style nil
)
2354 :foreground
"grey80" :background
"grey30"))
2355 "Basic mode line face for non-selected windows."
2357 :group
'mode-line-faces
2358 :group
'basic-faces
)
2360 (defface mode-line-highlight
2361 '((((class color
) (min-colors 88))
2362 :box
(:line-width
2 :color
"grey40" :style released-button
))
2364 :inherit highlight
))
2365 "Basic mode line face for highlighting."
2367 :group
'mode-line-faces
2368 :group
'basic-faces
)
2370 (defface mode-line-emphasis
2371 '((t (:weight bold
)))
2372 "Face used to emphasize certain mode line features.
2373 Use the face `mode-line-highlight' for features that can be selected."
2375 :group
'mode-line-faces
2376 :group
'basic-faces
)
2378 (defface mode-line-buffer-id
2379 '((t (:weight bold
)))
2380 "Face used for buffer identification parts of the mode line."
2382 :group
'mode-line-faces
2383 :group
'basic-faces
)
2385 ;; Make `modeline' an alias for `mode-line', for compatibility.
2386 (put 'modeline
'face-alias
'mode-line
)
2387 (put 'modeline-inactive
'face-alias
'mode-line-inactive
)
2388 (put 'modeline-highlight
'face-alias
'mode-line-highlight
)
2389 (put 'modeline-buffer-id
'face-alias
'mode-line-buffer-id
)
2391 (defface header-line
2395 ;; This used to be `:inverse-video t', but that doesn't look very
2396 ;; good when combined with inverse-video mode-lines and multiple
2397 ;; windows. Underlining looks better, and is more consistent with
2398 ;; the window-system face variants, which deemphasize the
2399 ;; header-line in relation to the mode-line face. If a terminal
2400 ;; can't underline, then the header-line will end up without any
2401 ;; highlighting; this may be too confusing in general, although it
2402 ;; happens to look good with the only current use of header-lines,
2403 ;; the info browser. XXX
2404 :inverse-video nil
;Override the value inherited from mode-line.
2406 (((class color grayscale
) (background light
))
2407 :background
"grey90" :foreground
"grey20"
2409 (((class color grayscale
) (background dark
))
2410 :background
"grey20" :foreground
"grey90"
2412 (((class mono
) (background light
))
2413 :background
"white" :foreground
"black"
2417 (((class mono
) (background dark
))
2418 :background
"black" :foreground
"white"
2422 "Basic header-line face."
2424 :group
'basic-faces
)
2426 (defface vertical-border
2427 '((((type tty
)) :inherit mode-line-inactive
))
2428 "Face used for vertical window dividers on ttys."
2430 :group
'basic-faces
)
2432 (defface minibuffer-prompt
2433 '((((background dark
)) :foreground
"cyan")
2434 ;; Don't use blue because many users of the MS-DOS port customize
2435 ;; their foreground color to be blue.
2436 (((type pc
)) :foreground
"magenta")
2437 (t :foreground
"medium blue"))
2438 "Face for minibuffer prompts.
2439 By default, Emacs automatically adds this face to the value of
2440 `minibuffer-prompt-properties', which is a list of text properties
2441 used to display the prompt text."
2443 :group
'basic-faces
)
2445 (setq minibuffer-prompt-properties
2446 (append minibuffer-prompt-properties
(list 'face
'minibuffer-prompt
)))
2449 '((((class color
) (background light
))
2450 :background
"grey95")
2451 (((class color
) (background dark
))
2452 :background
"grey10")
2454 :background
"gray"))
2455 "Basic face for the fringes to the left and right of windows under X."
2458 :group
'basic-faces
)
2460 (defface scroll-bar
'((t nil
))
2461 "Basic face for the scroll bar colors under X."
2464 :group
'basic-faces
)
2466 (defface border
'((t nil
))
2467 "Basic face for the frame border under X."
2470 :group
'basic-faces
)
2472 (defface cursor
'((t nil
))
2473 "Basic face for the cursor color under X.
2474 Note: Other faces cannot inherit from the cursor face."
2477 :group
'basic-faces
)
2479 (put 'cursor
'face-no-inherit t
)
2481 (defface mouse
'((t nil
))
2482 "Basic face for the mouse color under X."
2485 :group
'basic-faces
)
2489 :box
(:line-width
1 :style released-button
)
2490 :foreground
"black")
2491 (((type x w32 ns
) (class color
))
2492 :background
"grey75")
2493 (((type x
) (class mono
))
2494 :background
"grey"))
2495 "Basic tool-bar face."
2497 :group
'basic-faces
)
2506 "Basic face for the font and colors of the menu bar and popup menus."
2509 :group
'basic-faces
)
2512 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2513 ;;; Manipulating font names.
2514 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2516 ;; This is here for compatibilty with Emacs 20.2. For example,
2517 ;; international/fontset.el uses x-resolve-font-name. The following
2518 ;; functions are not used in the face implementation itself.
2520 (defvar x-font-regexp nil
)
2521 (defvar x-font-regexp-head nil
)
2522 (defvar x-font-regexp-weight nil
)
2523 (defvar x-font-regexp-slant nil
)
2525 (defconst x-font-regexp-weight-subnum
1)
2526 (defconst x-font-regexp-slant-subnum
2)
2527 (defconst x-font-regexp-swidth-subnum
3)
2528 (defconst x-font-regexp-adstyle-subnum
4)
2530 ;;; Regexps matching font names in "Host Portable Character Representation."
2535 (weight "\\(bold\\|demibold\\|medium\\)") ; 1
2536 ; (weight\? "\\(\\*\\|bold\\|demibold\\|medium\\|\\)") ; 1
2537 (weight\? "\\([^-]*\\)") ; 1
2538 (slant "\\([ior]\\)") ; 2
2539 ; (slant\? "\\([ior?*]?\\)") ; 2
2540 (slant\? "\\([^-]?\\)") ; 2
2541 ; (swidth "\\(\\*\\|normal\\|semicondensed\\|\\)") ; 3
2542 (swidth "\\([^-]*\\)") ; 3
2543 ; (adstyle "\\(\\*\\|sans\\|\\)") ; 4
2544 (adstyle "\\([^-]*\\)") ; 4
2545 (pixelsize "[0-9]+")
2546 (pointsize "[0-9][0-9]+")
2547 (resx "[0-9][0-9]+")
2548 (resy "[0-9][0-9]+")
2555 (concat "\\`\\*?[-?*]"
2556 foundry - family - weight
\? - slant
\? - swidth - adstyle -
2557 pixelsize - pointsize - resx - resy - spacing - avgwidth -
2558 registry - encoding
"\\*?\\'"
2560 (setq x-font-regexp-head
2561 (concat "\\`[-?*]" foundry - family - weight
\? - slant
\?
2562 "\\([-*?]\\|\\'\\)"))
2563 (setq x-font-regexp-slant
(concat - slant -
))
2564 (setq x-font-regexp-weight
(concat - weight -
))
2568 (defun x-resolve-font-name (pattern &optional face frame
)
2569 "Return a font name matching PATTERN.
2570 All wildcards in PATTERN are instantiated.
2571 If PATTERN is nil, return the name of the frame's base font, which never
2573 Given optional arguments FACE and FRAME, return a font which is
2574 also the same size as FACE on FRAME, or fail."
2576 (setq face
(face-name face
)))
2580 ;; Note that x-list-fonts has code to handle a face with nil as its font.
2581 (let ((fonts (x-list-fonts pattern face frame
1)))
2584 (if (string-match "\\*" pattern
)
2585 (if (null (face-font face
))
2586 (error "No matching fonts are the same height as the frame default font")
2587 (error "No matching fonts are the same height as face `%s'" face
))
2588 (if (null (face-font face
))
2589 (error "Height of font `%s' doesn't match the frame default font"
2591 (error "Height of font `%s' doesn't match face `%s'"
2593 (error "No fonts match `%s'" pattern
)))
2595 (cdr (assq 'font
(frame-parameters (selected-frame))))))
2598 (defun x-frob-font-weight (font which
)
2599 (let ((case-fold-search t
))
2600 (cond ((string-match x-font-regexp font
)
2601 (concat (substring font
0
2602 (match-beginning x-font-regexp-weight-subnum
))
2604 (substring font
(match-end x-font-regexp-weight-subnum
)
2605 (match-beginning x-font-regexp-adstyle-subnum
))
2606 ;; Replace the ADD_STYLE_NAME field with *
2607 ;; because the info in it may not be the same
2608 ;; for related fonts.
2610 (substring font
(match-end x-font-regexp-adstyle-subnum
))))
2611 ((string-match x-font-regexp-head font
)
2612 (concat (substring font
0 (match-beginning 1)) which
2613 (substring font
(match-end 1))))
2614 ((string-match x-font-regexp-weight font
)
2615 (concat (substring font
0 (match-beginning 1)) which
2616 (substring font
(match-end 1)))))))
2617 (make-obsolete 'x-frob-font-weight
'make-face-...
"21.1")
2619 (defun x-frob-font-slant (font which
)
2620 (let ((case-fold-search t
))
2621 (cond ((string-match x-font-regexp font
)
2622 (concat (substring font
0
2623 (match-beginning x-font-regexp-slant-subnum
))
2625 (substring font
(match-end x-font-regexp-slant-subnum
)
2626 (match-beginning x-font-regexp-adstyle-subnum
))
2627 ;; Replace the ADD_STYLE_NAME field with *
2628 ;; because the info in it may not be the same
2629 ;; for related fonts.
2631 (substring font
(match-end x-font-regexp-adstyle-subnum
))))
2632 ((string-match x-font-regexp-head font
)
2633 (concat (substring font
0 (match-beginning 2)) which
2634 (substring font
(match-end 2))))
2635 ((string-match x-font-regexp-slant font
)
2636 (concat (substring font
0 (match-beginning 1)) which
2637 (substring font
(match-end 1)))))))
2638 (make-obsolete 'x-frob-font-slant
'make-face-...
"21.1")
2640 ;; These aliases are here so that we don't get warnings about obsolete
2641 ;; functions from the byte compiler.
2642 (defalias 'internal-frob-font-weight
'x-frob-font-weight
)
2643 (defalias 'internal-frob-font-slant
'x-frob-font-slant
)
2645 (defun x-make-font-bold (font)
2646 "Given an X font specification, make a bold version of it.
2647 If that can't be done, return nil."
2648 (internal-frob-font-weight font
"bold"))
2649 (make-obsolete 'x-make-font-bold
'make-face-bold
"21.1")
2651 (defun x-make-font-demibold (font)
2652 "Given an X font specification, make a demibold version of it.
2653 If that can't be done, return nil."
2654 (internal-frob-font-weight font
"demibold"))
2655 (make-obsolete 'x-make-font-demibold
'make-face-bold
"21.1")
2657 (defun x-make-font-unbold (font)
2658 "Given an X font specification, make a non-bold version of it.
2659 If that can't be done, return nil."
2660 (internal-frob-font-weight font
"medium"))
2661 (make-obsolete 'x-make-font-unbold
'make-face-unbold
"21.1")
2663 (defun x-make-font-italic (font)
2664 "Given an X font specification, make an italic version of it.
2665 If that can't be done, return nil."
2666 (internal-frob-font-slant font
"i"))
2667 (make-obsolete 'x-make-font-italic
'make-face-italic
"21.1")
2669 (defun x-make-font-oblique (font) ; you say tomayto...
2670 "Given an X font specification, make an oblique version of it.
2671 If that can't be done, return nil."
2672 (internal-frob-font-slant font
"o"))
2673 (make-obsolete 'x-make-font-oblique
'make-face-italic
"21.1")
2675 (defun x-make-font-unitalic (font)
2676 "Given an X font specification, make a non-italic version of it.
2677 If that can't be done, return nil."
2678 (internal-frob-font-slant font
"r"))
2679 (make-obsolete 'x-make-font-unitalic
'make-face-unitalic
"21.1")
2681 (defun x-make-font-bold-italic (font)
2682 "Given an X font specification, make a bold and italic version of it.
2683 If that can't be done, return nil."
2684 (and (setq font
(internal-frob-font-weight font
"bold"))
2685 (internal-frob-font-slant font
"i")))
2686 (make-obsolete 'x-make-font-bold-italic
'make-face-bold-italic
"21.1")
2690 ;; arch-tag: 19a4759f-2963-445f-b004-425b9aadd7d6
2691 ;;; faces.el ends here