1 ;;; faces.el --- Lisp faces
3 ;; Copyright (C) 1992, 1993, 1994, 1995, 1996, 1998, 1999, 2000
4 ;; Free Software Foundation, Inc.
6 ;; This file is part of GNU Emacs.
8 ;; GNU Emacs is free software; you can redistribute it and/or modify
9 ;; it under the terms of the GNU General Public License as published by
10 ;; the Free Software Foundation; either version 2, or (at your option)
13 ;; GNU Emacs is distributed in the hope that it will be useful,
14 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
15 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 ;; GNU General Public License for more details.
18 ;; You should have received a copy of the GNU General Public License
19 ;; along with GNU Emacs; see the file COPYING. If not, write to the
20 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
21 ;; Boston, MA 02111-1307, USA.
33 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
35 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
37 (defgroup font-selection nil
38 "Influencing face font selection."
42 (defcustom face-font-selection-order
43 '(:width :height :weight :slant)
44 "*A list specifying how face font selection chooses fonts.
45 Each of the four symbols `:width', `:height', `:weight', and `:slant'
46 must appear once in the list, and the list must not contain any other
47 elements. Font selection tries to find a best matching font for
48 those face attributes first that appear first in the list. For
49 example, if `:slant' appears before `:height', font selection first
50 tries to find a font with a suitable slant, even if this results in
51 a font height that isn't optimal."
52 :tag "Font selection order."
53 :type '(list symbol symbol symbol symbol)
54 :group 'font-selection
55 :set #'(lambda (symbol value)
56 (set-default symbol value)
57 (internal-set-font-selection-order value)))
59 ;; This is defined originally in {w32,x}faces.c.
60 (defcustom face-font-family-alternatives
62 ("helv" "helvetica" "arial" "fixed"))
63 "*Alist of alternative font family names.
64 Each element has the the form (FAMILY ALTERNATIVE1 ALTERNATIVE2 ...).
65 If fonts of family FAMILY can't be loaded, try ALTERNATIVE1, then
67 :tag "Alternative font families to try."
68 :type '(repeat (repeat string))
69 :group 'font-selection
70 :set #'(lambda (symbol value)
71 (set-default symbol value)
72 (internal-set-alternative-font-family-alist value)))
76 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
77 ;;; Creation, copying.
78 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
82 "Return a list of all defined face names."
83 (mapcar #'car face-new-frame-defaults))
86 ;;; ### If not frame-local initialize by what X resources?
88 (defun make-face (face &optional no-init-from-resources)
89 "Define a new face with name FACE, a symbol.
90 NO-INIT-FROM-RESOURCES non-nil means don't initialize frame-local
91 variants of FACE from X resources. (X resources recognized are found
92 in the global variable `face-x-resources'.) If FACE is already known
93 as a face, leave it unmodified. Value is FACE."
94 (interactive "SMake face: ")
96 ;; Make frame-local faces (this also makes the global one).
97 (dolist (frame (frame-list))
98 (internal-make-lisp-face face frame))
99 ;; Add the face to the face menu.
100 (when (fboundp 'facemenu-add-new-face)
101 (facemenu-add-new-face face))
102 ;; Define frame-local faces for all frames from X resources.
103 (unless no-init-from-resources
104 (make-face-x-resource-internal face)))
108 (defun make-empty-face (face)
109 "Define a new, empty face with name FACE.
110 If the face already exists, it is left unmodified. Value is FACE."
111 (interactive "SMake empty face: ")
112 (make-face face 'no-init-from-resources))
115 (defun copy-face (old-face new-face &optional frame new-frame)
116 "Define a face just like OLD-FACE, with name NEW-FACE.
118 If NEW-FACE already exists as a face, it is modified to be like
119 OLD-FACE. If it doesn't already exist, it is created.
121 If the optional argument FRAME is given as a frame, NEW-FACE is
122 changed on FRAME only.
123 If FRAME is t, the frame-independent default specification for OLD-FACE
124 is copied to NEW-FACE.
125 If FRAME is nil, copying is done for the frame-independent defaults
126 and for each existing frame.
128 If the optional fourth argument NEW-FRAME is given,
129 copy the information from face OLD-FACE on frame FRAME
130 to NEW-FACE on frame NEW-FRAME."
131 (let ((inhibit-quit t))
134 (dolist (frame (frame-list))
135 (copy-face old-face new-face frame))
136 (copy-face old-face new-face t))
137 (internal-copy-lisp-face old-face new-face frame new-frame))
142 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
143 ;;; Obsolete functions
144 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
146 ;; The functions in this section are defined because Lisp packages use
147 ;; them, despite the prefix `internal-' suggesting that they are
148 ;; private to the face implementation.
150 (defun internal-find-face (name &optional frame)
151 "Retrieve the face named NAME.
152 Return nil if there is no such face.
153 If the optional argument FRAME is given, this gets the face NAME for
154 that frame; otherwise, it uses the selected frame.
155 If FRAME is the symbol t, then the global, non-frame face is returned.
156 If NAME is already a face, it is simply returned.
158 This function is defined for compatibility with Emacs 20.2. It
159 should not be used anymore."
161 (make-obsolete 'internal-find-face 'facep "21.1")
164 (defun internal-get-face (name &optional frame)
165 "Retrieve the face named NAME; error if there is none.
166 If the optional argument FRAME is given, this gets the face NAME for
167 that frame; otherwise, it uses the selected frame.
168 If FRAME is the symbol t, then the global, non-frame face is returned.
169 If NAME is already a face, it is simply returned.
171 This function is defined for compatibility with Emacs 20.2. It
172 should not be used anymore."
173 (or (internal-find-face name frame)
175 (make-obsolete 'internal-get-face "See `facep' and `check-face'." "21.1")
178 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
179 ;;; Predicates, type checks.
180 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
183 "Return non-nil if FACE is a face name."
184 (internal-lisp-face-p face))
187 (defun check-face (face)
188 "Signal an error if FACE doesn't name a face.
191 (error "Not a face: %s" face))
195 ;; The ID returned is not to be confused with the internally used IDs
196 ;; of realized faces. The ID assigned to Lisp faces is used to
197 ;; support faces in display table entries.
199 (defun face-id (face &optional frame)
200 "Return the interNal ID of face with name FACE.
201 If optional argument FRAME is nil or omitted, use the selected frame."
206 (defun face-equal (face1 face2 &optional frame)
207 "Non-nil if faces FACE1 and FACE2 are equal.
208 Faces are considered equal if all their attributes are equal.
209 If the optional argument FRAME is given, report on face FACE in that frame.
210 If FRAME is t, report on the defaults for face FACE (for new frames).
211 If FRAME is omitted or nil, use the selected frame."
212 (internal-lisp-face-equal-p face1 face2 frame))
215 (defun face-differs-from-default-p (face &optional frame)
216 "Non-nil if FACE displays differently from the default face.
217 If the optional argument FRAME is given, report on face FACE in that frame.
218 If FRAME is t, report on the defaults for face FACE (for new frames).
219 If FRAME is omitted or nil, use the selected frame.
220 A face is considered to be ``the same'' as the default face if it is
221 actually specified in the same way (equal attributes) or if it is
222 fully-unspecified, and thus inherits the attributes of any face it
223 is displayed on top of."
224 (cond ((eq frame t) (setq frame nil))
225 ((null frame) (setq frame (selected-frame))))
226 (let* ((v1 (internal-lisp-face-p face frame))
227 (n (if v1 (length v1) 0))
228 (v2 (internal-lisp-face-p 'default frame))
231 (error "Not a face: %S" face))
233 (or (eq 'unspecified (aref v1 i))
234 (equal (aref v1 i) (aref v2 i))))
239 (defun face-nontrivial-p (face &optional frame)
240 "True if face FACE has some non-nil attribute.
241 If the optional argument FRAME is given, report on face FACE in that frame.
242 If FRAME is t, report on the defaults for face FACE (for new frames).
243 If FRAME is omitted or nil, use the selected frame."
244 (not (internal-lisp-face-empty-p face frame)))
248 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
249 ;;; Setting face attributes from X resources.
250 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
252 (defcustom face-x-resources
253 '((:family (".attributeFamily" . "Face.AttributeFamily"))
254 (:width (".attributeWidth" . "Face.AttributeWidth"))
255 (:height (".attributeHeight" . "Face.AttributeHeight"))
256 (:weight (".attributeWeight" . "Face.AttributeWeight"))
257 (:slant (".attributeSlant" . "Face.AttributeSlant"))
258 (:foreground (".attributeForeground" . "Face.AttributeForeground"))
259 (:background (".attributeBackground" . "Face.AttributeBackground"))
260 (:overline (".attributeOverline" . "Face.AttributeOverline"))
261 (:strike-through (".attributeStrikeThrough" . "Face.AttributeStrikeThrough"))
262 (:box (".attributeBox" . "Face.AttributeBox"))
263 (:underline (".attributeUnderline" . "Face.AttributeUnderline"))
264 (:inverse-video (".attributeInverse" . "Face.AttributeInverse"))
266 (".attributeStipple" . "Face.AttributeStipple")
267 (".attributeBackgroundPixmap" . "Face.AttributeBackgroundPixmap"))
268 (:bold (".attributeBold" . "Face.AttributeBold"))
269 (:italic (".attributeItalic" . "Face.AttributeItalic"))
270 (:font (".attributeFont" . "Face.AttributeFont"))
271 (:inherit (".attributeInherit" . "Face.AttributeInherit")))
272 "*List of X resources and classes for face attributes.
273 Each element has the form (ATTRIBUTE ENTRY1 ENTRY2...) where ATTRIBUTE is
274 the name of a face attribute, and each ENTRY is a cons of the form
275 (RESOURCE . CLASS) with RESOURCE being the resource and CLASS being the
276 X resource class for the attribute."
281 (defun set-face-attribute-from-resource (face attribute resource class frame)
282 "Set FACE's ATTRIBUTE from X resource RESOURCE, class CLASS on FRAME.
283 Value is the attribute value specified by the resource, or nil
284 if not present. This function displays a message if the resource
285 specifies an invalid attribute."
286 (let* ((face-name (face-name face))
287 (value (internal-face-x-get-resource (concat face-name resource)
291 (internal-set-lisp-face-attribute-from-resource
292 face attribute (downcase value) frame)
294 (message "Face %s, frame %s: invalid attribute %s %s from X resource"
295 face-name frame attribute value))))
299 (defun set-face-attributes-from-resources (face frame)
300 "Set attributes of FACE from X resources for FRAME."
301 (when (memq (framep frame) '(x w32))
302 (dolist (definition face-x-resources)
303 (let ((attribute (car definition)))
304 (dolist (entry (cdr definition))
305 (set-face-attribute-from-resource face attribute (car entry)
306 (cdr entry) frame))))))
309 (defun make-face-x-resource-internal (face &optional frame)
310 "Fill frame-local FACE on FRAME from X resources.
311 FRAME nil or not specified means do it for all frames."
313 (dolist (frame (frame-list))
314 (set-face-attributes-from-resources face frame))
315 (set-face-attributes-from-resources face frame)))
319 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
320 ;;; Retrieving face attributes.
321 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
323 (defun face-name (face)
324 "Return the name of face FACE."
325 (symbol-name (check-face face)))
328 (defun face-attribute (face attribute &optional frame)
329 "Return the value of FACE's ATTRIBUTE on FRAME.
330 If the optional argument FRAME is given, report on face FACE in that frame.
331 If FRAME is t, report on the defaults for face FACE (for new frames).
332 If FRAME is omitted or nil, use the selected frame."
333 (internal-get-lisp-face-attribute face attribute frame))
336 (defun face-foreground (face &optional frame)
337 "Return the foreground color name of FACE, or nil if unspecified.
338 If the optional argument FRAME is given, report on face FACE in that frame.
339 If FRAME is t, report on the defaults for face FACE (for new frames).
340 If FRAME is omitted or nil, use the selected frame."
341 (internal-get-lisp-face-attribute face :foreground frame))
344 (defun face-background (face &optional frame)
345 "Return the background color name of FACE, or nil if unspecified.
346 If the optional argument FRAME is given, report on face FACE in that frame.
347 If FRAME is t, report on the defaults for face FACE (for new frames).
348 If FRAME is omitted or nil, use the selected frame."
349 (internal-get-lisp-face-attribute face :background frame))
352 (defun face-stipple (face &optional frame)
353 "Return the stipple pixmap name of FACE, or nil if unspecified.
354 If the optional argument FRAME is given, report on face FACE in that frame.
355 If FRAME is t, report on the defaults for face FACE (for new frames).
356 If FRAME is omitted or nil, use the selected frame."
357 (internal-get-lisp-face-attribute face :stipple frame))
360 (defalias 'face-background-pixmap 'face-stipple)
363 (defun face-underline-p (face &optional frame)
364 "Return non-nil if FACE is underlined.
365 If the optional argument FRAME is given, report on face FACE in that frame.
366 If FRAME is t, report on the defaults for face FACE (for new frames).
367 If FRAME is omitted or nil, use the selected frame."
368 (eq (face-attribute face :underline frame) t))
371 (defun face-inverse-video-p (face &optional frame)
372 "Return non-nil if FACE is in inverse video on FRAME.
373 If the optional argument FRAME is given, report on face FACE in that frame.
374 If FRAME is t, report on the defaults for face FACE (for new frames).
375 If FRAME is omitted or nil, use the selected frame."
376 (eq (face-attribute face :inverse-video frame) t))
379 (defun face-bold-p (face &optional frame)
380 "Return non-nil if the font of FACE is bold 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.
384 Use `face-attribute' for finer control."
385 (let ((bold (face-attribute face :weight frame)))
386 (memq bold '(semi-bold bold extra-bold ultra-bold))))
389 (defun face-italic-p (face &optional frame)
390 "Return non-nil if the font of FACE is italic on FRAME.
391 If the optional argument FRAME is given, report on face FACE in that frame.
392 If FRAME is t, report on the defaults for face FACE (for new frames).
393 If FRAME is omitted or nil, use the selected frame.
394 Use `face-attribute' for finer control."
395 (let ((italic (face-attribute face :slant frame)))
396 (memq italic '(italic oblique))))
402 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
403 ;;; Face documentation.
404 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
406 (defun face-documentation (face)
407 "Get the documentation string for FACE."
408 (get face 'face-documentation))
411 (defun set-face-documentation (face string)
412 "Set the documentation string for FACE to STRING."
413 ;; Perhaps the text should go in DOC.
414 (put face 'face-documentation (purecopy string)))
417 (defalias 'face-doc-string 'face-documentation)
418 (defalias 'set-face-doc-string 'set-face-documentation)
422 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
423 ;; Setting face attributes.
424 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
427 (defun set-face-attribute (face frame &rest args)
428 "Set attributes of FACE on FRAME from ARGS.
430 FRAME nil means change attributes on all frames. FRAME t means change
431 the default for new frames (this is done automatically each time an
432 attribute is changed on all frames).
434 ARGS must come in pairs ATTRIBUTE VALUE. ATTRIBUTE must be a valid
435 face attribute name. All attributes can be set to `unspecified';
436 this fact is not further mentioned below.
438 The following attributes are recognized:
442 VALUE must be a string specifying the font family, e.g. ``courier'',
443 or a fontset alias name. If a font family is specified, wild-cards `*'
448 VALUE specifies the relative proportionate width of the font to use.
449 It must be one of the symbols `ultra-condensed', `extra-condensed',
450 `condensed', `semi-condensed', `normal', `semi-expanded', `expanded',
451 `extra-expanded', or `ultra-expanded'.
455 VALUE must be either an integer specifying the height of the font to use
456 in 1/10 pt, a floating point number specifying the amount by which to
457 scale any underlying face, or a function, which is called with the old
458 height (from the underlying face), and should return the new height.
462 VALUE specifies the weight of the font to use. It must be one of the
463 symbols `ultra-bold', `extra-bold', `bold', `semi-bold', `normal',
464 `semi-light', `light', `extra-light', `ultra-light'.
468 VALUE specifies the slant of the font to use. It must be one of the
469 symbols `italic', `oblique', `normal', `reverse-italic', or
472 `:foreground', `:background'
474 VALUE must be a color name, a string.
478 VALUE specifies whether characters in FACE should be underlined. If
479 VALUE is t, underline with foreground color of the face. If VALUE is
480 a string, underline with that color. If VALUE is nil, explicitly
485 VALUE specifies whether characters in FACE should be overlined. If
486 VALUE is t, overline with foreground color of the face. If VALUE is a
487 string, overline with that color. If VALUE is nil, explicitly don't
492 VALUE specifies whether characters in FACE should be drawn with a line
493 striking through them. If VALUE is t, use the foreground color of the
494 face. If VALUE is a string, strike-through with that color. If VALUE
495 is nil, explicitly don't strike through.
499 VALUE specifies whether characters in FACE should have a box drawn
500 around them. If VALUE is nil, explicitly don't draw boxes. If
501 VALUE is t, draw a box with lines of width 1 in the foreground color
502 of the face. If VALUE is a string, the string must be a color name,
503 and the box is drawn in that color with a line width of 1. Otherwise,
504 VALUE must be a property list of the form `(:line-width WIDTH
505 :color COLOR :style STYLE)'. If a keyword/value pair is missing from
506 the property list, a default value will be used for the value, as
507 specified below. WIDTH specifies the width of the lines to draw; it
508 defaults to 1. COLOR is the name of the color to draw in, default is
509 the foreground color of the face for simple boxes, and the background
510 color of the face for 3D boxes. STYLE specifies whether a 3D box
511 should be draw. If STYLE is `released-button', draw a box looking
512 like a released 3D button. If STYLE is `pressed-button' draw a box
513 that appears like a pressed button. If STYLE is nil, the default if
514 the property list doesn't contain a style specification, draw a 2D
519 VALUE specifies whether characters in FACE should be displayed in
520 inverse video. VALUE must be one of t or nil.
524 If VALUE is a string, it must be the name of a file of pixmap data.
525 The directories listed in the `x-bitmap-file-path' variable are
526 searched. Alternatively, VALUE may be a list of the form (WIDTH
527 HEIGHT DATA) where WIDTH and HEIGHT are the size in pixels, and DATA
528 is a string containing the raw bits of the bitmap. VALUE nil means
529 explicitly don't use a stipple pattern.
531 For convenience, attributes `:family', `:width', `:height', `:weight',
532 and `:slant' may also be set in one step from an X font name:
536 Set font-related face attributes from VALUE. VALUE must be a valid
537 XLFD font name. If it is a font name pattern, the first matching font
540 For compatibility with Emacs 20, keywords `:bold' and `:italic' can
541 be used to specify that a bold or italic font should be used. VALUE
542 must be t or nil in that case. A value of `unspecified' is not allowed.
546 VALUE is the name of a face from which to inherit attributes, or a list
547 of face names. Attributes from inherited faces are merged into the face
548 like an underlying face would be, with higher priority than underlying faces."
549 (let ((where (if (null frame) 0 frame)))
550 (setq args (purecopy args))
552 (internal-set-lisp-face-attribute face (car args)
553 (purecopy (cadr args))
555 (setq args (cdr (cdr args))))))
558 (defun make-face-bold (face &optional frame noerror)
559 "Make the font of FACE be bold, if possible.
560 FRAME nil or not specified means change face on all frames.
561 Argument NOERROR is ignored and retained for compatibility.
562 Use `set-face-attribute' for finer control of the font weight."
563 (interactive (list (read-face-name "Make which face bold ")))
564 (set-face-attribute face frame :weight 'bold))
567 (defun make-face-unbold (face &optional frame noerror)
568 "Make the font of FACE be non-bold, if possible.
569 FRAME nil or not specified means change face on all frames.
570 Argument NOERROR is ignored and retained for compatibility."
571 (interactive (list (read-face-name "Make which face non-bold ")))
572 (set-face-attribute face frame :weight 'normal))
575 (defun make-face-italic (face &optional frame noerror)
576 "Make the font of FACE be italic, if possible.
577 FRAME nil or not specified means change face on all frames.
578 Argument NOERROR is ignored and retained for compatibility.
579 Use `set-face-attribute' for finer control of the font slant."
580 (interactive (list (read-face-name "Make which face italic ")))
581 (set-face-attribute face frame :slant 'italic))
584 (defun make-face-unitalic (face &optional frame noerror)
585 "Make the font of FACE be non-italic, if possible.
586 FRAME nil or not specified means change face on all frames.
587 Argument NOERROR is ignored and retained for compatibility."
588 (interactive (list (read-face-name "Make which face non-italic ")))
589 (set-face-attribute face frame :slant 'normal))
592 (defun make-face-bold-italic (face &optional frame noerror)
593 "Make the font of FACE be bold and italic, if possible.
594 FRAME nil or not specified means change face on all frames.
595 Argument NOERROR is ignored and retained for compatibility.
596 Use `set-face-attribute' for finer control of font weight and slant."
597 (interactive (list (read-face-name "Make which face bold-italic: ")))
598 (set-face-attribute face frame :weight 'bold :slant 'italic))
601 (defun set-face-font (face font &optional frame)
602 "Change font-related attributes of FACE to those of FONT (a string).
603 FRAME nil or not specified means change face on all frames.
604 This sets the attributes `:family', `:width', `:height', `:weight',
605 and `:slant'. When called interactively, prompt for the face and font."
606 (interactive (read-face-and-attribute :font))
607 (set-face-attribute face frame :font font))
610 ;; Implementation note: Emulating gray background colors with a
611 ;; stipple pattern is now part of the face realization process, and is
612 ;; done in C depending on the frame on which the face is realized.
614 (defun set-face-background (face color &optional frame)
615 "Change the background color of face FACE to COLOR (a string).
616 FRAME nil or not specified means change face on all frames.
617 When called interactively, prompt for the face and color."
618 (interactive (read-face-and-attribute :background))
619 (set-face-attribute face frame :background color))
622 (defun set-face-foreground (face color &optional frame)
623 "Change the foreground color of face FACE to COLOR (a string).
624 FRAME nil or not specified means change face on all frames.
625 When called interactively, prompt for the face and color."
626 (interactive (read-face-and-attribute :foreground))
627 (set-face-attribute face frame :foreground color))
630 (defun set-face-stipple (face stipple &optional frame)
631 "Change the stipple pixmap of face FACE to STIPPLE.
632 FRAME nil or not specified means change face on all frames.
633 STIPPLE should be a string, the name of a file of pixmap data.
634 The directories listed in the `x-bitmap-file-path' variable are searched.
636 Alternatively, STIPPLE may be a list of the form (WIDTH HEIGHT DATA)
637 where WIDTH and HEIGHT are the size in pixels,
638 and DATA is a string, containing the raw bits of the bitmap."
639 (interactive (read-face-and-attribute :stipple))
640 (set-face-attribute face frame :stipple stipple))
643 (defun set-face-underline (face underline &optional frame)
644 "Specify whether face FACE is underlined.
645 UNDERLINE nil means FACE explicitly doesn't underline.
646 UNDERLINE non-nil means FACE explicitly does underlining
647 with the same of the foreground color.
648 If UNDERLINE is a string, underline with the color named UNDERLINE.
649 FRAME nil or not specified means change face on all frames.
650 Use `set-face-attribute' to ``unspecify'' underlining."
652 (let ((list (read-face-and-attribute :underline)))
653 (list (car list) (eq (car (cdr list)) t))))
654 (set-face-attribute face frame :underline underline))
657 (defun set-face-underline-p (face underline-p &optional frame)
658 "Specify whether face FACE is underlined.
659 UNDERLINE-P nil means FACE explicitly doesn't underline.
660 UNDERLINE-P non-nil means FACE explicitly does underlining.
661 FRAME nil or not specified means change face on all frames.
662 Use `set-face-attribute' to ``unspecify'' underlining."
664 (let ((list (read-face-and-attribute :underline)))
665 (list (car list) (eq (car (cdr list)) t))))
666 (set-face-attribute face frame :underline underline-p))
669 (defun set-face-inverse-video-p (face inverse-video-p &optional frame)
670 "Specify whether face FACE is in inverse video.
671 INVERSE-VIDEO-P non-nil means FACE displays explicitly in inverse video.
672 INVERSE-VIDEO-P nil means FACE explicitly is not in inverse video.
673 FRAME nil or not specified means change face on all frames.
674 Use `set-face-attribute' to ``unspecify'' the inverse video attribute."
676 (let ((list (read-face-and-attribute :inverse-video)))
677 (list (car list) (eq (car (cdr list)) t))))
678 (set-face-attribute face frame :inverse-video inverse-video-p))
681 (defun set-face-bold-p (face bold-p &optional frame)
682 "Specify whether face FACE is bold.
683 BOLD-P non-nil means FACE should explicitly display bold.
684 BOLD-P nil means FACE should explicitly display non-bold.
685 FRAME nil or not specified means change face on all frames.
686 Use `set-face-attribute' or `modify-face' for finer control."
688 (make-face-unbold face frame)
689 (make-face-bold face frame)))
692 (defun set-face-italic-p (face italic-p &optional frame)
693 "Specify whether face FACE is italic.
694 ITALIC-P non-nil means FACE should explicitly display italic.
695 ITALIC-P nil means FACE should explicitly display non-italic.
696 FRAME nil or not specified means change face on all frames.
697 Use `set-face-attribute' or `modify-face' for finer control."
699 (make-face-unitalic face frame)
700 (make-face-italic face frame)))
703 (defalias 'set-face-background-pixmap 'set-face-stipple)
706 (defun invert-face (face &optional frame)
707 "Swap the foreground and background colors of FACE.
708 FRAME nil or not specified means change face on all frames.
709 If FACE specifies neither foreground nor background color,
710 set its foreground and background to the background and foreground
711 of the default face. Value is FACE."
712 (interactive (list (read-face-name "Invert face ")))
713 (let ((fg (face-attribute face :foreground frame))
714 (bg (face-attribute face :background frame)))
716 (set-face-attribute face frame :foreground bg :background fg)
717 (set-face-attribute face frame
719 (face-attribute 'default :background frame)
721 (face-attribute 'default :foreground frame))))
725 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
726 ;;; Interactively modifying faces.
727 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
729 (defun read-face-name (prompt)
730 "Read and return a face symbol, prompting with PROMPT.
731 Value is a symbol naming a known face."
732 (let ((face-list (mapcar #'(lambda (x) (cons (symbol-name x) x))
734 (def (thing-at-point 'symbol))
736 (cond ((assoc def face-list)
737 (setq prompt (concat prompt " (default " def "): ")))
739 (setq prompt (concat prompt ": "))))
740 (while (equal "" (setq face (completing-read
741 prompt face-list nil t nil nil def))))
745 (defun face-valid-attribute-values (attribute &optional frame)
746 "Return valid values for face attribute ATTRIBUTE.
747 The optional argument FRAME is used to determine available fonts
748 and colors. If it is nil or not specified, the selected frame is
749 used. Value is an alist of (NAME . VALUE) if ATTRIBUTE expects a value
750 out of a set of discrete values. Value is `integerp' if ATTRIBUTE expects
757 (mapcar #'(lambda (x) (cons (car x) (car x)))
758 (x-font-family-list))
759 ;; Only one font on TTYs.
760 (list (cons "default" "default"))))
761 ((:width :weight :slant :inverse-video)
762 (mapcar #'(lambda (x) (cons (symbol-name x) x))
763 (internal-lisp-face-attribute-values attribute)))
764 ((:underline :overline :strike-through :box)
766 (nconc (mapcar #'(lambda (x) (cons (symbol-name x) x))
767 (internal-lisp-face-attribute-values attribute))
768 (mapcar #'(lambda (c) (cons c c))
769 (x-defined-colors frame)))
770 (mapcar #'(lambda (x) (cons (symbol-name x) x))
771 (internal-lisp-face-attribute-values attribute))))
772 ((:foreground :background)
773 (mapcar #'(lambda (c) (cons c c))
774 (defined-colors frame)))
778 (and (memq window-system '(x w32))
780 (apply #'nconc (mapcar #'directory-files
781 x-bitmap-file-path)))))
783 (cons '("none" . nil)
784 (mapcar #'(lambda (c) (cons (symbol-name c) c))
787 (error "Internal error"))))
788 (if (and (listp valid) (not (memq attribute '(:inherit))))
789 (nconc (list (cons "unspecified" 'unspecified)) valid)
794 (defvar face-attribute-name-alist
795 '((:family . "font family")
796 (:width . "character set width")
797 (:height . "height in 1/10 pt")
800 (:underline . "underline")
801 (:overline . "overline")
802 (:strike-through . "strike-through")
804 (:inverse-video . "inverse-video display")
805 (:foreground . "foreground color")
806 (:background . "background color")
807 (:stipple . "background stipple")
808 (:inherit . "inheritance"))
809 "An alist of descriptive names for face attributes.
810 Each element has the form (ATTRIBUTE-NAME . DESCRIPTION) where
811 ATTRIBUTE-NAME is a face attribute name (a keyword symbol), and
812 DESCRIPTION is a descriptive name for ATTRIBUTE-NAME.")
815 (defun face-descriptive-attribute-name (attribute)
816 "Return a descriptive name for ATTRIBUTE."
817 (cdr (assq attribute face-attribute-name-alist)))
820 (defun face-read-string (face default name &optional completion-alist)
821 "Interactively read a face attribute string value.
822 FACE is the face whose attribute is read. If non-nil, DEFAULT is the
823 default string to return if no new value is entered. NAME is a
824 descriptive name of the attribute for prompting. COMPLETION-ALIST is an
825 alist of valid values, if non-nil.
827 Entering nothing accepts the default string DEFAULT.
828 Value is the new attribute value."
829 ;; Capitalize NAME (we don't use `capitalize' because that capitalizes
830 ;; each word in a string separately).
831 (setq name (concat (upcase (substring name 0 1)) (substring name 1)))
832 (let* ((completion-ignore-case t)
833 (value (completing-read
835 (format "%s for face `%s' (default %s): "
837 (format "%s for face `%s': " name face))
839 (if (equal value "") default value)))
842 (defun face-read-integer (face default name)
843 "Interactively read an integer face attribute value.
844 FACE is the face whose attribute is read. DEFAULT is the default
845 value to return if no new value is entered. NAME is a descriptive
846 name of the attribute for prompting. Value is the new attribute value."
848 (face-read-string face
849 (format "%s" default)
851 (list (cons "unspecified" 'unspecified)))))
852 (cond ((equal new-value "unspecified")
854 ((member new-value '("unspecified-fg" "unspecified-bg"))
857 (string-to-int new-value)))))
860 (defun read-face-attribute (face attribute &optional frame)
861 "Interactively read a new value for FACE's ATTRIBUTE.
862 Optional argument FRAME nil or unspecified means read an attribute value
863 of a global face. Value is the new attribute value."
864 (let* ((old-value (face-attribute face attribute frame))
865 (attribute-name (face-descriptive-attribute-name attribute))
866 (valid (face-valid-attribute-values attribute frame))
868 ;; Represent complex attribute values as strings by printing them
869 ;; out. Stipple can be a vector; (WIDTH HEIGHT DATA). Box can be
870 ;; a list `(:width WIDTH :color COLOR)' or `(:width WIDTH :shadow
872 (when (and (or (eq attribute :stipple)
874 (or (consp old-value)
875 (vectorp old-value)))
876 (setq old-value (prin1-to-string old-value)))
879 (or (car (rassoc old-value valid))
880 (format "%s" old-value))))
882 (face-read-string face default attribute-name valid))
883 (if (equal new-value default)
884 ;; Nothing changed, so don't bother with all the stuff
885 ;; below. In particular, this avoids a non-tty color
886 ;; from being canonicalized for a tty when the user
887 ;; just uses the default.
888 (setq new-value old-value)
889 ;; Terminal frames can support colors that don't appear
890 ;; explicitly in VALID, using color approximation code
892 (if (and (memq attribute '(:foreground :background))
893 (not (memq window-system '(x w32 mac)))
894 (not (member new-value
896 "unspecified-fg" "unspecified-bg"))))
897 (setq new-value (car (tty-color-desc new-value frame))))
898 (setq new-value (cdr (assoc new-value valid))))))
899 ((eq valid 'integerp)
900 (setq new-value (face-read-integer face old-value attribute-name)))
901 (t (error "Internal error")))
902 ;; Convert stipple and box value text we read back to a list or
903 ;; vector if it looks like one. This makes the assumption that a
904 ;; pixmap file name won't start with an open-paren.
905 (when (and (or (eq attribute :stipple)
908 (string-match "^[[(]" new-value))
909 (setq new-value (read new-value)))
913 (defun read-face-font (face &optional frame)
914 "Read the name of a font for FACE on FRAME.
915 If optional argument FRAME Is nil or omitted, use the selected frame."
916 (let ((completion-ignore-case t))
917 (completing-read (format "Set font attributes of face `%s' from font: " face)
918 (mapcar 'list (x-list-fonts "*" nil frame)))))
921 (defun read-all-face-attributes (face &optional frame)
922 "Interactively read all attributes for FACE.
923 If optional argument FRAME Is nil or omitted, use the selected frame.
924 Value is a property list of attribute names and new values."
926 (dolist (attribute face-attribute-name-alist result)
927 (setq result (cons (car attribute)
928 (cons (read-face-attribute face (car attribute) frame)
932 (defun modify-face (&optional frame)
933 "Modify attributes of faces interactively.
934 If optional argument FRAME is nil or omitted, modify the face used
935 for newly created frame, i.e. the global face."
937 (let ((face (read-face-name "Modify face")))
938 (apply #'set-face-attribute face frame
939 (read-all-face-attributes face frame))))
942 (defun read-face-and-attribute (attribute &optional frame)
943 "Read face name and face attribute value.
944 ATTRIBUTE is the attribute whose new value is read.
945 FRAME nil or unspecified means read attribute value of global face.
946 Value is a list (FACE NEW-VALUE) where FACE is the face read
947 (a symbol), and NEW-VALUE is value read."
948 (cond ((eq attribute :font)
949 (let* ((prompt "Set font-related attributes of face")
950 (face (read-face-name prompt))
951 (font (read-face-font face frame)))
954 (let* ((attribute-name (face-descriptive-attribute-name attribute))
955 (prompt (format "Set %s of face" attribute-name))
956 (face (read-face-name prompt))
957 (new-value (read-face-attribute face attribute frame)))
958 (list face new-value)))))
962 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
964 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
966 (defvar list-faces-sample-text
967 "abcdefghijklmnopqrstuvwxyz ABCDEFGHIJKLMNOPQRSTUVWXYZ"
968 "*Text string to display as the sample text for `list-faces-display'.")
971 ;; The name list-faces would be more consistent, but let's avoid a
972 ;; conflict with Lucid, which uses that name differently.
974 (defun list-faces-display ()
975 "List all faces, using the same sample text in each.
976 The sample text is a string that comes from the variable
977 `list-faces-sample-text'."
979 (let ((faces (sort (face-list) #'string-lessp))
981 (frame (selected-frame))
982 disp-frame window face-name)
983 (with-output-to-temp-buffer "*Faces*"
985 (set-buffer standard-output)
986 (setq truncate-lines t)
988 (substitute-command-keys
991 (if (display-mouse-p) "\\[help-follow-mouse] or ")
992 "\\[help-follow] on a face name to customize it\n"
993 "or on its sample text for a decription of the face.\n\n")))
994 (setq help-xref-stack nil)
996 (setq face (car faces))
997 (setq faces (cdr faces))
998 (setq face-name (symbol-name face))
999 (insert (format "%25s " face-name))
1000 ;; Hyperlink to a customization buffer for the face. Using
1001 ;; the help xref mechanism may not be the best way.
1004 (search-backward face-name)
1005 (help-xref-button 0 (lambda (f)
1007 (pop help-xref-stack))
1010 "mouse-2: customize this face")))
1011 (let ((beg (point)))
1012 (insert list-faces-sample-text)
1013 ;; Hyperlink to a help buffer for the face.
1016 (search-backward list-faces-sample-text)
1017 (help-xref-button 0 #'describe-face face
1018 "mouse-2: describe this face")))
1020 (put-text-property beg (1- (point)) 'face face)
1021 ;; If the sample text has multiple lines, line up all of them.
1027 (goto-char (point-min)))
1028 (print-help-return-message))
1029 ;; If the *Faces* buffer appears in a different frame,
1030 ;; copy all the face definitions from FRAME,
1031 ;; so that the display will reflect the frame that was selected.
1032 (setq window (get-buffer-window (get-buffer "*Faces*") t))
1033 (setq disp-frame (if window (window-frame window)
1034 (car (frame-list))))
1035 (or (eq frame disp-frame)
1036 (let ((faces (face-list)))
1038 (copy-face (car faces) (car faces) frame disp-frame)
1039 (setq faces (cdr faces)))))))
1042 (defun describe-face (face &optional frame)
1043 "Display the properties of face FACE on FRAME.
1044 If the optional argument FRAME is given, report on face FACE in that frame.
1045 If FRAME is t, report on the defaults for face FACE (for new frames).
1046 If FRAME is omitted or nil, use the selected frame."
1047 (interactive (list (read-face-name "Describe face")))
1048 (let* ((attrs '((:family . "Family")
1050 (:height . "Height")
1051 (:weight . "Weight")
1053 (:foreground . "Foreground")
1054 (:background . "Background")
1055 (:underline . "Underline")
1056 (:overline . "Overline")
1057 (:strike-through . "Strike-through")
1059 (:inverse-video . "Inverse")
1060 (:stipple . "Stipple")
1061 (:font . "Font or fontset")
1062 (:inherit . "Inherit")))
1063 (max-width (apply #'max (mapcar #'(lambda (x) (length (cdr x)))
1065 (with-output-to-temp-buffer "*Help*"
1067 (set-buffer standard-output)
1069 (let ((attr (face-attribute face (car a) frame)))
1070 (insert (make-string (- max-width (length (cdr a))) ?\ )
1071 (cdr a) ": " (format "%s" attr) "\n")))
1072 (insert "\nDocumentation:\n\n"
1073 (or (face-documentation face)
1074 "not documented as a face."))
1075 (let ((customize-label "customize"))
1078 (princ (concat "You can " customize-label " this face."))
1079 (with-current-buffer "*Help*"
1082 (concat "\\(" customize-label "\\)") nil t)
1083 (help-xref-button 1 #'customize-face face
1084 "mouse-2, RET: customize face")))))
1085 (print-help-return-message)
1086 (with-current-buffer "*Help*"
1087 (help-setup-xref (list #'describe-face face) (interactive-p))
1090 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1091 ;;; Face specifications (defface).
1092 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1094 ;; Parameter FRAME Is kept for call compatibility to with previous
1095 ;; face implementation.
1097 (defun face-attr-construct (face &optional frame)
1098 "Return a defface-style attribute list for FACE on FRAME.
1099 Value is a property list of pairs ATTRIBUTE VALUE for all specified
1100 face attributes of FACE where ATTRIBUTE is the attribute name and
1101 VALUE is the specified value of that attribute."
1103 (dolist (entry face-attribute-name-alist result)
1104 (let* ((attribute (car entry))
1105 (value (face-attribute face attribute)))
1106 (unless (eq value 'unspecified)
1107 (setq result (nconc (list attribute value) result)))))))
1110 (defun face-spec-set-match-display (display frame)
1111 "Non-nil if DISPLAY matches FRAME.
1112 DISPLAY is part of a spec such as can be used in `defface'.
1113 If FRAME is nil, the current FRAME is used."
1114 (let* ((conjuncts display)
1115 conjunct req options
1116 ;; t means we have succeeded against all the conjuncts in
1117 ;; DISPLAY that have been tested so far.
1119 (if (eq conjuncts t)
1120 (setq conjuncts nil))
1121 (while (and conjuncts match)
1122 (setq conjunct (car conjuncts)
1123 conjuncts (cdr conjuncts)
1125 options (cdr conjunct)
1126 match (cond ((eq req 'type)
1127 (or (memq window-system options)
1128 (and (null window-system)
1129 (memq 'tty options))
1130 (and (memq 'motif options)
1132 (and (memq 'lucid options)
1133 (featurep 'x-toolkit)
1134 (not (featurep 'motif)))
1135 (and (memq 'x-toolkit options)
1136 (featurep 'x-toolkit))))
1138 (memq (frame-parameter frame 'display-type) options))
1139 ((eq req 'background)
1140 (memq (frame-parameter frame 'background-mode)
1142 (t (error "Unknown req `%S' with options `%S'"
1147 (defun face-spec-choose (spec &optional frame)
1148 "Choose the proper attributes for FRAME, out of SPEC."
1150 (setq frame (selected-frame)))
1154 (let* ((entry (car tail))
1155 (display (nth 0 entry))
1156 (attrs (nth 1 entry)))
1157 (setq tail (cdr tail))
1158 (when (face-spec-set-match-display display frame)
1159 (setq result attrs tail nil))))
1163 (defun face-spec-reset-face (face &optional frame)
1164 "Reset all attributes of FACE on FRAME to unspecified."
1165 (let ((attrs face-attribute-name-alist))
1167 (let ((attr-and-name (car attrs)))
1168 (set-face-attribute face frame (car attr-and-name) 'unspecified))
1169 (setq attrs (cdr attrs)))))
1172 (defun face-spec-set (face spec &optional frame)
1173 "Set FACE's attributes according to the first matching entry in SPEC.
1174 FRAME is the frame whose frame-local face is set. FRAME nil means
1175 do it on all frames. See `defface' for information about SPEC."
1176 (let ((attrs (face-spec-choose spec frame)))
1177 (face-spec-reset-face face frame)
1179 (let ((attribute (car attrs))
1180 (value (car (cdr attrs))))
1181 ;; Support some old-style attribute names and values.
1183 (:bold (setq attribute :weight value (if value 'bold 'normal)))
1184 (:italic (setq attribute :slant value (if value 'italic 'normal)))
1185 (t (unless (assq attribute face-x-resources)
1186 (setq attribute nil))))
1188 (set-face-attribute face frame attribute value)))
1189 (setq attrs (cdr (cdr attrs))))))
1192 (defun face-attr-match-p (face attrs &optional frame)
1193 "Return t if attributes of FACE match values in plist ATTRS.
1194 Optional parameter FRAME is the frame whose definition of FACE
1195 is used. If nil or omitted, use the selected frame."
1197 (setq frame (selected-frame)))
1198 (let ((list face-attribute-name-alist)
1200 (while (and match (not (null list)))
1201 (let* ((attr (car (car list)))
1203 (if (plist-member attrs attr)
1204 (plist-get attrs attr)
1206 (value-now (face-attribute face attr frame)))
1207 (setq match (equal specified-value value-now))
1208 (setq list (cdr list))))
1211 (defun face-spec-match-p (face spec &optional frame)
1212 "Return t if FACE, on FRAME, matches what SPEC says it should look like."
1213 (face-attr-match-p face (face-spec-choose spec frame) frame))
1217 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1218 ;;; Frame-type independent color support.
1219 ;;; We keep the old x-* names as aliases for back-compatibility.
1220 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1222 (defun defined-colors (&optional frame)
1223 "Return a list of colors supported for a particular frame.
1224 The argument FRAME specifies which frame to try.
1225 The value may be different for frames on different display types.
1226 If FRAME doesn't support colors, the value is nil."
1227 (if (memq (framep (or frame (selected-frame))) '(x w32))
1228 (xw-defined-colors frame)
1229 (mapcar 'car (tty-color-alist frame))))
1230 (defalias 'x-defined-colors 'defined-colors)
1232 (defun color-defined-p (color &optional frame)
1233 "Return non-nil if color COLOR is supported on frame FRAME.
1234 If FRAME is omitted or nil, use the selected frame.
1235 If COLOR is the symbol `unspecified' or one of the strings
1236 \"unspecified-fg\" or \"unspecified-bg\", the value is nil."
1237 (if (memq color '(unspecified "unspecified-bg" "unspecified-fg"))
1239 (if (memq (framep (or frame (selected-frame))) '(x w32))
1240 (xw-color-defined-p color frame)
1241 (numberp (tty-color-translate color frame)))))
1242 (defalias 'x-color-defined-p 'color-defined-p)
1244 (defun color-values (color &optional frame)
1245 "Return a description of the color named COLOR on frame FRAME.
1246 The value is a list of integer RGB values--\(RED GREEN BLUE\).
1247 These values appear to range from 0 65535; white is \(65535 65535 65535\).
1248 If FRAME is omitted or nil, use the selected frame.
1249 If FRAME cannot display COLOR, the value is nil.
1250 If COLOR is the symbol `unspecified' or one of the strings
1251 \"unspecified-fg\" or \"unspecified-bg\", the value is nil."
1252 (if (memq color '(unspecified "unspecified-fg" "unspecified-bg"))
1254 (if (memq (framep (or frame (selected-frame))) '(x w32))
1255 (xw-color-values color frame)
1256 (tty-color-values color frame))))
1257 (defalias 'x-color-values 'color-values)
1259 (defun display-color-p (&optional display)
1260 "Return t if DISPLAY supports color.
1261 The optional argument DISPLAY specifies which display to ask about.
1262 DISPLAY should be either a frame or a display name (a string).
1263 If omitted or nil, that stands for the selected frame's display."
1264 (if (memq (framep-on-display display) '(x w32))
1265 (xw-display-color-p display)
1266 (tty-display-color-p display)))
1267 (defalias 'x-display-color-p 'display-color-p)
1269 (defun display-grayscale-p (&optional display)
1270 "Return non-nil if frames on DISPLAY can display shades of gray."
1271 (let ((frame-type (framep-on-display display)))
1273 ((memq frame-type '(x w32 mac))
1274 (x-display-grayscale-p display))
1276 (> (tty-color-gray-shades display) 2)))))
1279 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1280 ;;; Background mode.
1281 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1283 (defcustom frame-background-mode nil
1284 "*The brightness of the background.
1285 Set this to the symbol `dark' if your background color is dark, `light' if
1286 your background is light, or nil (default) if you want Emacs to
1287 examine the brightness for you. Don't set this variable with `setq';
1288 this won't have the expected effect."
1290 :set #'(lambda (var value)
1291 (set-default var value)
1292 (mapcar 'frame-set-background-mode (frame-list)))
1293 :initialize 'custom-initialize-changed
1294 :type '(choice (choice-item dark)
1296 (choice-item :tag "default" nil)))
1299 (defun frame-set-background-mode (frame)
1300 "Set up the `background-mode' and `display-type' frame parameters for FRAME."
1303 (x-get-resource ".backgroundMode" "BackgroundMode")))
1304 (bg-mode (cond (frame-background-mode)
1305 ((null window-system)
1306 ;; No way to determine this automatically (?).
1309 (intern (downcase bg-resource)))
1310 ((< (apply '+ (x-color-values
1311 (frame-parameter frame 'background-color)
1313 ;; Just looking at the screen, colors whose
1314 ;; values add up to .6 of the white total
1315 ;; still look dark to me.
1316 (* (apply '+ (x-color-values "white" frame)) .6))
1319 (display-type (cond ((null window-system)
1320 (if (tty-display-color-p frame) 'color 'mono))
1321 ((x-display-color-p frame)
1323 ((x-display-grayscale-p frame)
1326 (modify-frame-parameters frame
1327 (list (cons 'background-mode bg-mode)
1328 (cons 'display-type display-type))))
1330 ;; For all named faces, choose face specs matching the new frame
1332 (let ((face-list (face-list)))
1334 (let* ((face (car face-list))
1335 (spec (get face 'face-defface-spec)))
1337 (face-spec-set face spec frame))
1338 (setq face-list (cdr face-list))))))
1343 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1345 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1347 (defun x-handle-named-frame-geometry (parameters)
1348 "Add geometry parameters for a named frame to parameter list PARAMETERS.
1349 Value is the new parameter list."
1350 (let* ((name (or (cdr (assq 'name parameters))
1351 (cdr (assq 'name default-frame-alist))))
1352 (x-resource-name name)
1353 (res-geometry (if name (x-get-resource "geometry" "Geometry"))))
1355 (let ((parsed (x-parse-geometry res-geometry)))
1356 ;; If the resource specifies a position, call the position
1357 ;; and size "user-specified".
1358 (when (or (assq 'top parsed)
1359 (assq 'left parsed))
1360 (setq parsed (append '((user-position . t) (user-size . t)) parsed)))
1361 ;; Put the geometry parameters at the end. Copy
1362 ;; default-frame-alist so that they go after it.
1363 (setq parameters (append parameters default-frame-alist parsed))))
1367 (defun x-handle-reverse-video (frame parameters)
1368 "Handle the reverse-video frame parameter and X resource.
1369 `x-create-frame' does not handle this one."
1370 (when (cdr (or (assq 'reverse parameters)
1371 (assq 'reverse default-frame-alist)
1372 (let ((resource (x-get-resource "reverseVideo"
1375 (cons nil (member (downcase resource)
1376 '("on" "true")))))))
1377 (let* ((params (frame-parameters frame))
1378 (bg (cdr (assq 'foreground-color params)))
1379 (fg (cdr (assq 'background-color params))))
1380 (modify-frame-parameters frame
1381 (list (cons 'foreground-color fg)
1382 (cons 'background-color bg)))
1383 (if (equal bg (cdr (assq 'border-color params)))
1384 (modify-frame-parameters frame
1385 (list (cons 'border-color fg))))
1386 (if (equal bg (cdr (assq 'mouse-color params)))
1387 (modify-frame-parameters frame
1388 (list (cons 'mouse-color fg))))
1389 (if (equal bg (cdr (assq 'cursor-color params)))
1390 (modify-frame-parameters frame
1391 (list (cons 'cursor-color fg)))))))
1394 (defun x-create-frame-with-faces (&optional parameters)
1395 "Create a frame from optional frame parameters PARAMETERS.
1396 Parameters not specified by PARAMETERS are taken from
1397 `default-frame-alist'. If PARAMETERS specify a frame name,
1398 handle X geometry resources for that name. If either PARAMETERS
1399 or `default-frame-alist' contains a `reverse' parameter, or
1400 the X resource ``reverseVideo'' is present, handle that.
1401 Value is the new frame created."
1402 (setq parameters (x-handle-named-frame-geometry parameters))
1403 (let ((visibility-spec (assq 'visibility parameters))
1404 (frame-list (frame-list))
1405 (frame (x-create-frame (cons '(visibility . nil) parameters)))
1409 (x-handle-reverse-video frame parameters)
1410 (frame-set-background-mode frame)
1411 (face-set-after-frame-default frame)
1412 (if (or (null frame-list) (null visibility-spec))
1413 (make-frame-visible frame)
1414 (modify-frame-parameters frame (list visibility-spec)))
1417 (delete-frame frame)))
1421 (defun face-set-after-frame-default (frame)
1422 "Set frame-local faces of FRAME from face specs and resources.
1423 Initialize colors of certain faces from frame parameters."
1424 (dolist (face (face-list))
1425 (let ((spec (or (get face 'saved-face)
1426 (get face 'face-defface-spec))))
1428 (face-spec-set face spec frame))
1429 (internal-merge-in-global-face face frame)
1430 (when (memq window-system '(x w32))
1431 (make-face-x-resource-internal face frame))))
1433 ;; Initialize attributes from frame parameters.
1434 (let ((params '((foreground-color default :foreground)
1435 (background-color default :background)
1436 (border-color border :background)
1437 (cursor-color cursor :background)
1438 (scroll-bar-foreground scroll-bar :foreground)
1439 (scroll-bar-background scroll-bar :background)
1440 (mouse-color mouse :background))))
1442 (let ((param-name (nth 0 (car params)))
1443 (face (nth 1 (car params)))
1444 (attr (nth 2 (car params)))
1446 (when (setq value (frame-parameter frame param-name))
1447 (set-face-attribute face frame attr value)))
1448 (setq params (cdr params)))))
1451 (defun tty-create-frame-with-faces (&optional parameters)
1452 "Create a frame from optional frame parameters PARAMETERS.
1453 Parameters not specified by PARAMETERS are taken from
1454 `default-frame-alist'. If either PARAMETERS or `default-frame-alist'
1455 contains a `reverse' parameter, handle that. Value is the new frame
1457 (let ((frame (make-terminal-frame parameters))
1461 (frame-set-background-mode frame)
1462 (face-set-after-frame-default frame)
1465 (delete-frame frame)))
1469 ;; Called from C function init_display to initialize faces of the
1470 ;; dumped terminal frame on startup.
1472 (defun tty-set-up-initial-frame-faces ()
1473 (let ((frame (selected-frame)))
1474 (frame-set-background-mode frame)
1475 (face-set-after-frame-default frame)))
1480 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1481 ;;; Compatiblity with 20.2
1482 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1484 ;; Update a frame's faces when we change its default font.
1486 (defalias 'frame-update-faces 'ignore)
1487 (make-obsolete 'frame-update-faces "No longer necessary" "21.1")
1489 ;; Update the colors of FACE, after FRAME's own colors have been
1492 (defalias 'frame-update-face-colors 'frame-set-background-mode)
1493 (make-obsolete 'frame-update-face-colors 'frame-set-background-mode "21.1")
1496 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1498 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1500 (defgroup basic-faces nil
1501 "The standard faces of Emacs."
1507 "Basic default face."
1508 :group 'basic-faces)
1512 '((((type x) (class color))
1513 (:box (:line-width 2 :style released-button)
1514 :background "grey75" :foreground "black"))
1515 (((type w32) (class color))
1516 (:box (:line-width 2 :style released-button)
1517 :background "grey75" :foreground "black"))
1519 (:inverse-video t)))
1520 "Basic mode line face."
1523 :group 'basic-faces)
1525 ;; Make `modeline' an alias for `mode-line', for compatibility.
1526 (put 'modeline 'face-alias 'mode-line)
1528 (defface header-line
1529 '((((type x) (class color))
1530 (:box (:line-width 2 :style released-button)
1531 :background "grey75" :foreground "black"))
1532 (((type w32) (class color))
1533 (:box (:line-width 2 :style released-button)
1534 :background "grey75" :foreground "black"))
1536 (:inverse-video t)))
1537 "Basic header-line face."
1539 :group 'basic-faces)
1543 '((((type x) (class color))
1544 (:box (:line-width 1 :style released-button)
1545 :background "grey75" :foreground "black"))
1546 (((type x) (class mono))
1547 (:box (:line-width 1 :style released-button)
1548 :background "grey" :foreground "black"))
1549 (((type w32) (class color))
1550 (:box (:line-width 1 :style released-button)
1551 :background "grey75" :foreground "black"))
1554 "Basic tool-bar face."
1556 :group 'basic-faces)
1560 '((((type tty) (class color))
1561 (:background "blue" :foreground "white"))
1562 (((type tty) (class mono))
1564 (((class color) (background dark))
1565 (:background "blue"))
1566 (((class color) (background light))
1567 (:background "light goldenrod yellow"))
1568 (t (:background "gray")))
1569 "Basic face for highlighting the region."
1570 :group 'basic-faces)
1574 '((((class color) (background light))
1575 (:background "grey95"))
1576 (((class color) (background dark))
1577 (:background "grey10"))
1579 (:background "gray")))
1580 "Basic face for the fringes to the left and right of windows under X."
1583 :group 'basic-faces)
1586 (defface scroll-bar '()
1587 "Basic face for the scroll bar colors under X."
1590 :group 'basic-faces)
1594 '((((type x-toolkit)) ())
1595 (t (:inverse-video t)))
1599 :group 'basic-faces)
1603 "Basic face for the frame border under X."
1606 :group 'basic-faces)
1610 "Basic face for the cursor color under X."
1613 :group 'basic-faces)
1617 "Basic face for the mouse color under X."
1620 :group 'basic-faces)
1623 (defface bold '((t (:weight bold)))
1625 :group 'basic-faces)
1628 (defface italic '((t (:slant italic)))
1629 "Basic italic font."
1630 :group 'basic-faces)
1633 (defface bold-italic '((t (:weight bold :slant italic)))
1634 "Basic bold-italic face."
1635 :group 'basic-faces)
1638 (defface underline '((t (:underline t)))
1639 "Basic underlined face."
1640 :group 'basic-faces)
1644 '((((type tty) (class color))
1645 (:background "green"))
1646 (((class color) (background light))
1647 (:background "darkseagreen2"))
1648 (((class color) (background dark))
1649 (:background "darkolivegreen"))
1650 (t (:inverse-video t)))
1651 "Basic face for highlighting."
1652 :group 'basic-faces)
1655 (defface secondary-selection
1656 '((((type tty) (class color))
1657 (:background "cyan"))
1658 (((class color) (background light))
1659 (:background "yellow"))
1660 (((class color) (background dark))
1661 (:background "yellow"))
1662 (t (:inverse-video t)))
1663 "Basic face for displaying the secondary selection."
1664 :group 'basic-faces)
1667 (defface fixed-pitch '((t (:family "courier")))
1668 "The basic fixed-pitch face."
1669 :group 'basic-faces)
1672 (defface variable-pitch '((t (:family "helv")))
1673 "The basic variable-pitch face."
1674 :group 'basic-faces)
1677 (defface trailing-whitespace
1678 '((((class color) (background light))
1679 (:background "red"))
1680 (((class color) (background dark))
1681 (:background "red"))
1682 (t (:inverse-video t)))
1683 "Basic face for highlighting trailing whitespace."
1685 :group 'font-lock ; like `show-trailing-whitespace'
1686 :group 'basic-faces)
1690 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1691 ;;; Manipulating font names.
1692 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1694 ;; This is here for compatibilty with Emacs 20.2. For example,
1695 ;; international/fontset.el uses x-resolve-font-name. The following
1696 ;; functions are not used in the face implementation itself.
1698 (defvar x-font-regexp nil)
1699 (defvar x-font-regexp-head nil)
1700 (defvar x-font-regexp-weight nil)
1701 (defvar x-font-regexp-slant nil)
1703 (defconst x-font-regexp-weight-subnum 1)
1704 (defconst x-font-regexp-slant-subnum 2)
1705 (defconst x-font-regexp-swidth-subnum 3)
1706 (defconst x-font-regexp-adstyle-subnum 4)
1708 ;;; Regexps matching font names in "Host Portable Character Representation."
1713 (weight "\\(bold\\|demibold\\|medium\\)") ; 1
1714 ; (weight\? "\\(\\*\\|bold\\|demibold\\|medium\\|\\)") ; 1
1715 (weight\? "\\([^-]*\\)") ; 1
1716 (slant "\\([ior]\\)") ; 2
1717 ; (slant\? "\\([ior?*]?\\)") ; 2
1718 (slant\? "\\([^-]?\\)") ; 2
1719 ; (swidth "\\(\\*\\|normal\\|semicondensed\\|\\)") ; 3
1720 (swidth "\\([^-]*\\)") ; 3
1721 ; (adstyle "\\(\\*\\|sans\\|\\)") ; 4
1722 (adstyle "\\([^-]*\\)") ; 4
1723 (pixelsize "[0-9]+")
1724 (pointsize "[0-9][0-9]+")
1725 (resx "[0-9][0-9]+")
1726 (resy "[0-9][0-9]+")
1733 (concat "\\`\\*?[-?*]"
1734 foundry - family - weight\? - slant\? - swidth - adstyle -
1735 pixelsize - pointsize - resx - resy - spacing - avgwidth -
1736 registry - encoding "\\*?\\'"
1738 (setq x-font-regexp-head
1739 (concat "\\`[-?*]" foundry - family - weight\? - slant\?
1740 "\\([-*?]\\|\\'\\)"))
1741 (setq x-font-regexp-slant (concat - slant -))
1742 (setq x-font-regexp-weight (concat - weight -))
1746 (defun x-resolve-font-name (pattern &optional face frame)
1747 "Return a font name matching PATTERN.
1748 All wildcards in PATTERN are instantiated.
1749 If PATTERN is nil, return the name of the frame's base font, which never
1751 Given optional arguments FACE and FRAME, return a font which is
1752 also the same size as FACE on FRAME, or fail."
1754 (setq face (face-name face)))
1758 ;; Note that x-list-fonts has code to handle a face with nil as its font.
1759 (let ((fonts (x-list-fonts pattern face frame 1)))
1762 (if (string-match "\\*" pattern)
1763 (if (null (face-font face))
1764 (error "No matching fonts are the same height as the frame default font")
1765 (error "No matching fonts are the same height as face `%s'" face))
1766 (if (null (face-font face))
1767 (error "Height of font `%s' doesn't match the frame default font"
1769 (error "Height of font `%s' doesn't match face `%s'"
1771 (error "No fonts match `%s'" pattern)))
1773 (cdr (assq 'font (frame-parameters (selected-frame))))))
1776 (defun x-frob-font-weight (font which)
1777 (let ((case-fold-search t))
1778 (cond ((string-match x-font-regexp font)
1779 (concat (substring font 0
1780 (match-beginning x-font-regexp-weight-subnum))
1782 (substring font (match-end x-font-regexp-weight-subnum)
1783 (match-beginning x-font-regexp-adstyle-subnum))
1784 ;; Replace the ADD_STYLE_NAME field with *
1785 ;; because the info in it may not be the same
1786 ;; for related fonts.
1788 (substring font (match-end x-font-regexp-adstyle-subnum))))
1789 ((string-match x-font-regexp-head font)
1790 (concat (substring font 0 (match-beginning 1)) which
1791 (substring font (match-end 1))))
1792 ((string-match x-font-regexp-weight font)
1793 (concat (substring font 0 (match-beginning 1)) which
1794 (substring font (match-end 1)))))))
1795 (make-obsolete 'x-frob-font-weight 'make-face-... "21.1")
1797 (defun x-frob-font-slant (font which)
1798 (let ((case-fold-search t))
1799 (cond ((string-match x-font-regexp font)
1800 (concat (substring font 0
1801 (match-beginning x-font-regexp-slant-subnum))
1803 (substring font (match-end x-font-regexp-slant-subnum)
1804 (match-beginning x-font-regexp-adstyle-subnum))
1805 ;; Replace the ADD_STYLE_NAME field with *
1806 ;; because the info in it may not be the same
1807 ;; for related fonts.
1809 (substring font (match-end x-font-regexp-adstyle-subnum))))
1810 ((string-match x-font-regexp-head font)
1811 (concat (substring font 0 (match-beginning 2)) which
1812 (substring font (match-end 2))))
1813 ((string-match x-font-regexp-slant font)
1814 (concat (substring font 0 (match-beginning 1)) which
1815 (substring font (match-end 1)))))))
1816 (make-obsolete 'x-frob-font-slant 'make-face-... "21.1")
1818 (defun x-make-font-bold (font)
1819 "Given an X font specification, make a bold version of it.
1820 If that can't be done, return nil."
1821 (x-frob-font-weight font "bold"))
1822 (make-obsolete 'x-make-font-bold 'make-face-bold "21.1")
1824 (defun x-make-font-demibold (font)
1825 "Given an X font specification, make a demibold version of it.
1826 If that can't be done, return nil."
1827 (x-frob-font-weight font "demibold"))
1828 (make-obsolete 'x-make-font-demibold 'make-face-bold "21.1")
1830 (defun x-make-font-unbold (font)
1831 "Given an X font specification, make a non-bold version of it.
1832 If that can't be done, return nil."
1833 (x-frob-font-weight font "medium"))
1834 (make-obsolete 'x-make-font-unbold 'make-face-unbold "21.1")
1836 (defun x-make-font-italic (font)
1837 "Given an X font specification, make an italic version of it.
1838 If that can't be done, return nil."
1839 (x-frob-font-slant font "i"))
1840 (make-obsolete 'x-make-font-italic 'make-face-italic "21.1")
1842 (defun x-make-font-oblique (font) ; you say tomayto...
1843 "Given an X font specification, make an oblique version of it.
1844 If that can't be done, return nil."
1845 (x-frob-font-slant font "o"))
1846 (make-obsolete 'x-make-font-oblique 'make-face-italic "21.1")
1848 (defun x-make-font-unitalic (font)
1849 "Given an X font specification, make a non-italic version of it.
1850 If that can't be done, return nil."
1851 (x-frob-font-slant font "r"))
1852 (make-obsolete 'x-make-font-unitalic 'make-face-unitalic "21.1")
1854 (defun x-make-font-bold-italic (font)
1855 "Given an X font specification, make a bold and italic version of it.
1856 If that can't be done, return nil."
1857 (and (setq font (x-make-font-bold font))
1858 (x-make-font-italic font)))
1859 (make-obsolete 'x-make-font-bold-italic 'make-face-bold-italic "21.1")
1863 ;;; faces.el ends here