1 ;;; faces.el --- Lisp faces
3 ;; Copyright (C) 1992-1996, 1998-2015 Free Software Foundation, Inc.
5 ;; Maintainer: emacs-devel@gnu.org
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/>.
28 (defcustom term-file-prefix
(purecopy "term/")
29 "If non-nil, Emacs startup performs terminal-specific initialization.
30 It does this by: (load (concat term-file-prefix (getenv \"TERM\")))
32 You may set this variable to nil in your init file if you do not wish
33 the terminal-initialization file to be loaded."
34 :type
'(choice (const :tag
"No terminal-specific initialization" nil
)
35 (string :tag
"Name of directory with term files"))
38 (defcustom term-file-aliases
39 '(("apollo" .
"vt100")
50 "Alist of terminal type aliases.
51 Entries are of the form (TYPE . ALIAS), where both elements are strings.
52 This means to treat a terminal of type TYPE as if it were of type ALIAS."
53 :type
'(alist :key-type
(string :tag
"Terminal")
54 :value-type
(string :tag
"Alias"))
58 (declare-function xw-defined-colors
"term/common-win" (&optional frame
))
60 (defvar help-xref-stack-item
)
62 (defvar face-name-history nil
63 "History list for some commands that read face names.
64 Maximum length of the history list is determined by the value
65 of `history-length', which see.")
68 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
70 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
72 (defgroup font-selection nil
73 "Influencing face font selection."
77 (defcustom face-font-selection-order
78 '(:width
:height
:weight
:slant
)
79 "A list specifying how face font selection chooses fonts.
80 Each of the four symbols `:width', `:height', `:weight', and `:slant'
81 must appear once in the list, and the list must not contain any other
82 elements. Font selection first tries to find a best matching font
83 for those face attributes that appear before in the list. For
84 example, if `:slant' appears before `:height', font selection first
85 tries to find a font with a suitable slant, even if this results in
86 a font height that isn't optimal."
87 :tag
"Font selection order"
88 :type
'(list symbol symbol symbol symbol
)
89 :group
'font-selection
90 :set
#'(lambda (symbol value
)
91 (set-default symbol value
)
92 (internal-set-font-selection-order value
)))
95 ;; In the absence of Fontconfig support, Monospace and Sans Serif are
96 ;; unavailable, and we fall back on the courier and helv families,
97 ;; which are generally available.
98 (defcustom face-font-family-alternatives
99 (mapcar (lambda (arg) (mapcar 'purecopy arg
))
100 '(("Monospace" "courier" "fixed")
101 ("courier" "CMU Typewriter Text" "fixed")
102 ("Sans Serif" "helv" "helvetica" "arial" "fixed")
103 ("helv" "helvetica" "arial" "fixed")))
104 "Alist of alternative font family names.
105 Each element has the form (FAMILY ALTERNATIVE1 ALTERNATIVE2 ...).
106 If fonts of family FAMILY can't be loaded, try ALTERNATIVE1, then
108 :tag
"Alternative font families to try"
109 :type
'(repeat (repeat string
))
110 :group
'font-selection
111 :set
#'(lambda (symbol value
)
112 (set-default symbol value
)
113 (internal-set-alternative-font-family-alist value
)))
116 ;; This is defined originally in xfaces.c.
117 (defcustom face-font-registry-alternatives
118 (mapcar (lambda (arg) (mapcar 'purecopy arg
))
120 '(("iso8859-1" "ms-oemlatin")
121 ("gb2312.1980" "gb2312" "gbk" "gb18030")
122 ("jisx0208.1990" "jisx0208.1983" "jisx0208.1978")
123 ("ksc5601.1989" "ksx1001.1992" "ksc5601.1987")
124 ("muletibetan-2" "muletibetan-0"))
125 '(("gb2312.1980" "gb2312.80&gb8565.88" "gbk" "gb18030")
126 ("jisx0208.1990" "jisx0208.1983" "jisx0208.1978")
127 ("ksc5601.1989" "ksx1001.1992" "ksc5601.1987")
128 ("muletibetan-2" "muletibetan-0"))))
129 "Alist of alternative font registry names.
130 Each element has the form (REGISTRY ALTERNATIVE1 ALTERNATIVE2 ...).
131 If fonts of registry REGISTRY can be loaded, font selection
132 tries to find a best matching font among all fonts of registry
133 REGISTRY, ALTERNATIVE1, ALTERNATIVE2, and etc."
134 :tag
"Alternative font registries to try"
135 :type
'(repeat (repeat string
))
137 :group
'font-selection
138 :set
#'(lambda (symbol value
)
139 (set-default symbol value
)
140 (internal-set-alternative-font-registry-alist value
)))
143 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
144 ;;; Creation, copying.
145 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
149 "Return a list of all defined faces."
150 (mapcar #'car face-new-frame-defaults
))
152 (defun make-face (face)
153 "Define a new face with name FACE, a symbol.
154 Do not call this directly from Lisp code; use `defface' instead.
156 If FACE is already known as a face, leave it unmodified. Return FACE."
157 (interactive (list (read-from-minibuffer
158 "Make face: " nil nil t
'face-name-history
)))
160 ;; Make frame-local faces (this also makes the global one).
161 (dolist (frame (frame-list))
162 (internal-make-lisp-face face frame
))
163 ;; Add the face to the face menu.
164 (when (fboundp 'facemenu-add-new-face
)
165 (facemenu-add-new-face face
))
166 ;; Define frame-local faces for all frames from X resources.
167 (make-face-x-resource-internal face
))
170 (defun make-empty-face (face)
171 "Define a new, empty face with name FACE.
172 Do not call this directly from Lisp code; use `defface' instead."
173 (interactive (list (read-from-minibuffer
174 "Make empty face: " nil nil t
'face-name-history
)))
177 (defun copy-face (old-face new-face
&optional frame new-frame
)
178 "Define a face named NEW-FACE, which is a copy of OLD-FACE.
179 This function does not copy face customization data, so NEW-FACE
180 will not be made customizable. Most Lisp code should not call
181 this function; use `defface' with :inherit instead.
183 If NEW-FACE already exists as a face, modify it to be like
184 OLD-FACE. If NEW-FACE doesn't already exist, create it.
186 If the optional argument FRAME is a frame, change NEW-FACE on
187 FRAME only. If FRAME is t, copy the frame-independent default
188 specification for OLD-FACE to NEW-FACE. If FRAME is nil, copy
189 the defaults as well as the faces on each existing frame.
191 If the optional fourth argument NEW-FRAME is given, copy the
192 information from face OLD-FACE on frame FRAME to NEW-FACE on
193 frame NEW-FRAME. In this case, FRAME must not be nil."
194 (let ((inhibit-quit t
))
198 (error "Copying face %s from all frames to one frame"
200 (make-empty-face new-face
)
201 (dolist (frame (frame-list))
202 (copy-face old-face new-face frame
))
203 (copy-face old-face new-face t
))
204 (make-empty-face new-face
)
205 (internal-copy-lisp-face old-face new-face frame new-frame
))
209 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
210 ;;; Predicates, type checks.
211 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
214 "Return non-nil if FACE is a face name; nil otherwise.
215 A face name can be a string or a symbol."
216 (internal-lisp-face-p face
))
219 (defun check-face (face)
220 "Signal an error if FACE doesn't name a face.
223 (error "Not a face: %s" face
))
227 ;; The ID returned is not to be confused with the internally used IDs
228 ;; of realized faces. The ID assigned to Lisp faces is used to
229 ;; support faces in display table entries.
231 (defun face-id (face &optional _frame
)
232 "Return the internal ID of face with name FACE.
233 If FACE is a face-alias, return the ID of the target face.
234 The optional argument FRAME is ignored, since the internal face ID
235 of a face name is the same for all frames."
238 (face-id (get face
'face-alias
))))
240 (defun face-equal (face1 face2
&optional frame
)
241 "Non-nil if faces FACE1 and FACE2 are equal.
242 Faces are considered equal if all their attributes are equal.
243 If the optional argument FRAME is given, report on FACE1 and FACE2 in that frame.
244 If FRAME is t, report on the defaults for FACE1 and FACE2 (for new frames).
245 If FRAME is omitted or nil, use the selected frame."
246 (internal-lisp-face-equal-p face1 face2 frame
))
249 (defun face-differs-from-default-p (face &optional frame
)
250 "Return non-nil if FACE displays differently from the default face.
251 If the optional argument FRAME is given, report on face FACE in that frame.
252 If FRAME is t, report on the defaults for face FACE (for new frames).
253 If FRAME is omitted or nil, use the selected frame."
255 (delq :inherit
(mapcar 'car face-attribute-name-alist
)))
257 (while (and attrs
(not differs
))
258 (let* ((attr (pop attrs
))
259 (attr-val (face-attribute face attr frame t
)))
261 (not (eq attr-val
'unspecified
))
262 (display-supports-face-attributes-p (list attr attr-val
)
264 (setq differs attr
))))
268 (defun face-nontrivial-p (face &optional frame
)
269 "True if face FACE has some non-nil attribute.
270 If the optional argument FRAME is given, report on face FACE in that frame.
271 If FRAME is t, report on the defaults for face FACE (for new frames).
272 If FRAME is omitted or nil, use the selected frame."
273 (not (internal-lisp-face-empty-p face frame
)))
276 (defun face-list-p (face-or-list)
277 "True if FACE-OR-LIST is a list of faces.
278 Return nil if FACE-OR-LIST is a non-nil atom, or a cons cell whose car
279 is either 'foreground-color, 'background-color, or a keyword."
280 ;; The logic of merge_face_ref (xfaces.c) is recreated here.
281 (and (listp face-or-list
)
282 (not (memq (car face-or-list
)
283 '(foreground-color background-color
)))
284 (not (keywordp (car face-or-list
)))))
288 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
289 ;;; Setting face attributes from X resources.
290 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
292 (defcustom face-x-resources
295 ;; FIXME; can we purecopy some of the conses too?
297 (cons (purecopy (car (cdr arg
))) (purecopy (cdr (cdr arg
))))))
298 '((:family
(".attributeFamily" .
"Face.AttributeFamily"))
299 (:foundry
(".attributeFoundry" .
"Face.AttributeFoundry"))
300 (:width
(".attributeWidth" .
"Face.AttributeWidth"))
301 (:height
(".attributeHeight" .
"Face.AttributeHeight"))
302 (:weight
(".attributeWeight" .
"Face.AttributeWeight"))
303 (:slant
(".attributeSlant" .
"Face.AttributeSlant"))
304 (:foreground
(".attributeForeground" .
"Face.AttributeForeground"))
306 (".attributeDistantForeground" .
"Face.AttributeDistantForeground"))
307 (:background
(".attributeBackground" .
"Face.AttributeBackground"))
308 (:overline
(".attributeOverline" .
"Face.AttributeOverline"))
309 (:strike-through
(".attributeStrikeThrough" .
"Face.AttributeStrikeThrough"))
310 (:box
(".attributeBox" .
"Face.AttributeBox"))
311 (:underline
(".attributeUnderline" .
"Face.AttributeUnderline"))
312 (:inverse-video
(".attributeInverse" .
"Face.AttributeInverse"))
314 (".attributeStipple" .
"Face.AttributeStipple")
315 (".attributeBackgroundPixmap" .
"Face.AttributeBackgroundPixmap"))
316 (:bold
(".attributeBold" .
"Face.AttributeBold"))
317 (:italic
(".attributeItalic" .
"Face.AttributeItalic"))
318 (:font
(".attributeFont" .
"Face.AttributeFont"))
319 (:inherit
(".attributeInherit" .
"Face.AttributeInherit"))))
320 "List of X resources and classes for face attributes.
321 Each element has the form (ATTRIBUTE ENTRY1 ENTRY2...) where ATTRIBUTE is
322 the name of a face attribute, and each ENTRY is a cons of the form
323 \(RESOURCE . CLASS) with RESOURCE being the resource and CLASS being the
324 X resource class for the attribute."
325 :type
'(repeat (cons symbol
(repeat (cons string string
))))
329 (declare-function internal-face-x-get-resource
"xfaces.c"
330 (resource class
&optional frame
))
332 (declare-function internal-set-lisp-face-attribute-from-resource
"xfaces.c"
333 (face attr value
&optional frame
))
335 (defun set-face-attribute-from-resource (face attribute resource class frame
)
336 "Set FACE's ATTRIBUTE from X resource RESOURCE, class CLASS on FRAME.
337 Value is the attribute value specified by the resource, or nil
338 if not present. This function displays a message if the resource
339 specifies an invalid attribute."
340 (let* ((face-name (face-name face
))
341 (value (internal-face-x-get-resource (concat face-name resource
)
345 (internal-set-lisp-face-attribute-from-resource
346 face attribute
(downcase value
) frame
)
348 (message "Face %s, frame %s: invalid attribute %s %s from X resource"
349 face-name frame attribute value
))))
353 (defun set-face-attributes-from-resources (face frame
)
354 "Set attributes of FACE from X resources for FRAME."
355 (when (memq (framep frame
) '(x w32
))
356 (dolist (definition face-x-resources
)
357 (let ((attribute (car definition
)))
358 (dolist (entry (cdr definition
))
359 (set-face-attribute-from-resource face attribute
(car entry
)
360 (cdr entry
) frame
))))))
363 (defun make-face-x-resource-internal (face &optional frame
)
364 "Fill frame-local FACE on FRAME from X resources.
365 FRAME nil or not specified means do it for all frames.
367 If `inhibit-x-resources' is non-nil, this function does nothing."
368 (unless inhibit-x-resources
369 (dolist (frame (if (null frame
) (frame-list) (list frame
)))
370 ;; `x-create-frame' already took care of correctly handling
371 ;; the reverse video case-- do _not_ touch the default face
372 (unless (and (eq face
'default
)
373 (frame-parameter frame
'reverse
))
374 (set-face-attributes-from-resources face frame
)))))
378 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
379 ;;; Retrieving face attributes.
380 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
382 (defun face-name (face)
383 "Return the name of face FACE."
384 (symbol-name (check-face face
)))
387 (defun face-all-attributes (face &optional frame
)
388 "Return an alist stating the attributes of FACE.
389 Each element of the result has the form (ATTR-NAME . ATTR-VALUE).
390 If FRAME is omitted or nil the value describes the default attributes,
391 but if you specify FRAME, the value describes the attributes
393 (mapcar (lambda (pair)
394 (let ((attr (car pair
)))
395 (cons attr
(face-attribute face attr
(or frame t
)))))
396 face-attribute-name-alist
))
398 (defun face-attribute (face attribute
&optional frame inherit
)
399 "Return the value of FACE's ATTRIBUTE on FRAME.
400 If the optional argument FRAME is given, report on face FACE in that frame.
401 If FRAME is t, report on the defaults for face FACE (for new frames).
402 If FRAME is omitted or nil, use the selected frame.
404 If INHERIT is nil, only attributes directly defined by FACE are considered,
405 so the return value may be `unspecified', or a relative value.
406 If INHERIT is non-nil, FACE's definition of ATTRIBUTE is merged with the
407 faces specified by its `:inherit' attribute; however the return value
408 may still be `unspecified' or relative.
409 If INHERIT is a face or a list of faces, then the result is further merged
410 with that face (or faces), until it becomes specified and absolute.
412 To ensure that the return value is always specified and absolute, use a
413 value of `default' for INHERIT; this will resolve any unspecified or
414 relative values by merging with the `default' face (which is always
415 completely specified)."
416 (let ((value (internal-get-lisp-face-attribute face attribute frame
)))
417 (when (and inherit
(face-attribute-relative-p attribute value
))
418 ;; VALUE is relative, so merge with inherited faces
419 (let ((inh-from (face-attribute face
:inherit frame
)))
420 (unless (or (null inh-from
) (eq inh-from
'unspecified
))
423 (face-attribute-merged-with attribute value inh-from frame
))
424 ;; The `inherit' attribute may point to non existent faces.
428 (face-attribute-relative-p attribute value
))
429 ;; We should merge with INHERIT as well
430 (setq value
(face-attribute-merged-with attribute value inherit frame
)))
433 (defun face-attribute-merged-with (attribute value faces
&optional frame
)
434 "Merges ATTRIBUTE, initially VALUE, with faces from FACES until absolute.
435 FACES may be either a single face or a list of faces.
436 \[This is an internal function.]"
437 (cond ((not (face-attribute-relative-p attribute value
))
442 (face-attribute-merged-with
444 (face-attribute-merged-with attribute value
(car faces
) frame
)
448 (merge-face-attribute attribute
450 (face-attribute faces attribute frame t
)))))
453 (defmacro face-attribute-specified-or
(value &rest body
)
454 "Return VALUE, unless it's `unspecified', in which case evaluate BODY and return the result."
455 (let ((temp (make-symbol "value")))
456 `(let ((,temp
,value
))
457 (if (not (eq ,temp
'unspecified
))
461 (defun face-foreground (face &optional frame inherit
)
462 "Return the foreground color name of FACE, or nil if unspecified.
463 If the optional argument FRAME is given, report on face FACE in that frame.
464 If FRAME is t, report on the defaults for face FACE (for new frames).
465 If FRAME is omitted or nil, use the selected frame.
467 If INHERIT is nil, only a foreground color directly defined by FACE is
468 considered, so the return value may be nil.
469 If INHERIT is t, and FACE doesn't define a foreground color, then any
470 foreground color that FACE inherits through its `:inherit' attribute
471 is considered as well; however the return value may still be nil.
472 If INHERIT is a face or a list of faces, then it is used to try to
473 resolve an unspecified foreground color.
475 To ensure that a valid color is always returned, use a value of
476 `default' for INHERIT; this will resolve any unspecified values by
477 merging with the `default' face (which is always completely specified)."
478 (face-attribute-specified-or (face-attribute face
:foreground frame inherit
)
481 (defun face-background (face &optional frame inherit
)
482 "Return the background color name of FACE, or nil if unspecified.
483 If the optional argument FRAME is given, report on face FACE in that frame.
484 If FRAME is t, report on the defaults for face FACE (for new frames).
485 If FRAME is omitted or nil, use the selected frame.
487 If INHERIT is nil, only a background color directly defined by FACE is
488 considered, so the return value may be nil.
489 If INHERIT is t, and FACE doesn't define a background color, then any
490 background color that FACE inherits through its `:inherit' attribute
491 is considered as well; however the return value may still be nil.
492 If INHERIT is a face or a list of faces, then it is used to try to
493 resolve an unspecified background color.
495 To ensure that a valid color is always returned, use a value of
496 `default' for INHERIT; this will resolve any unspecified values by
497 merging with the `default' face (which is always completely specified)."
498 (face-attribute-specified-or (face-attribute face
:background frame inherit
)
501 (defun face-stipple (face &optional frame inherit
)
502 "Return the stipple pixmap name of FACE, or nil if unspecified.
503 If the optional argument FRAME is given, report on face FACE in that frame.
504 If FRAME is t, report on the defaults for face FACE (for new frames).
505 If FRAME is omitted or nil, use the selected frame.
507 If INHERIT is nil, only a stipple directly defined by FACE is
508 considered, so the return value may be nil.
509 If INHERIT is t, and FACE doesn't define a stipple, then any stipple
510 that FACE inherits through its `:inherit' attribute is considered as
511 well; however the return value may still be nil.
512 If INHERIT is a face or a list of faces, then it is used to try to
513 resolve an unspecified stipple.
515 To ensure that a valid stipple or nil is always returned, use a value of
516 `default' for INHERIT; this will resolve any unspecified values by merging
517 with the `default' face (which is always completely specified)."
518 (face-attribute-specified-or (face-attribute face
:stipple frame inherit
)
522 (defalias 'face-background-pixmap
'face-stipple
)
525 (defun face-underline-p (face &optional frame inherit
)
526 "Return non-nil if FACE specifies a non-nil underlining.
527 If the optional argument FRAME is given, report on face FACE in that frame.
528 If FRAME is t, report on the defaults for face FACE (for new frames).
529 If FRAME is omitted or nil, use the selected frame.
530 Optional argument INHERIT is passed to `face-attribute'."
531 (face-attribute-specified-or
532 (face-attribute face
:underline frame inherit
) nil
))
535 (defun face-inverse-video-p (face &optional frame inherit
)
536 "Return non-nil if FACE specifies a non-nil inverse-video.
537 If the optional argument FRAME is given, report on face FACE in that frame.
538 If FRAME is t, report on the defaults for face FACE (for new frames).
539 If FRAME is omitted or nil, use the selected frame.
540 Optional argument INHERIT is passed to `face-attribute'."
541 (eq (face-attribute face
:inverse-video frame inherit
) t
))
544 (defun face-bold-p (face &optional frame inherit
)
545 "Return non-nil if the font of FACE is bold on FRAME.
546 If the optional argument FRAME is given, report on face FACE in that frame.
547 If FRAME is t, report on the defaults for face FACE (for new frames).
548 If FRAME is omitted or nil, use the selected frame.
549 Optional argument INHERIT is passed to `face-attribute'.
550 Use `face-attribute' for finer control."
551 (let ((bold (face-attribute face
:weight frame inherit
)))
552 (memq bold
'(semi-bold bold extra-bold ultra-bold
))))
555 (defun face-italic-p (face &optional frame inherit
)
556 "Return non-nil if the font of FACE is italic on FRAME.
557 If the optional argument FRAME is given, report on face FACE in that frame.
558 If FRAME is t, report on the defaults for face FACE (for new frames).
559 If FRAME is omitted or nil, use the selected frame.
560 Optional argument INHERIT is passed to `face-attribute'.
561 Use `face-attribute' for finer control."
562 (let ((italic (face-attribute face
:slant frame inherit
)))
563 (memq italic
'(italic oblique
))))
567 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
568 ;;; Face documentation.
569 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
571 (defun face-documentation (face)
572 "Get the documentation string for FACE.
573 If FACE is a face-alias, get the documentation for the target face."
574 (let ((alias (get face
'face-alias
)))
576 (let ((doc (get alias
'face-documentation
)))
577 (format "%s is an alias for the face `%s'.%s" face alias
578 (if doc
(format "\n%s" doc
)
580 (get face
'face-documentation
))))
583 (defun set-face-documentation (face string
)
584 "Set the documentation string for FACE to STRING."
585 ;; Perhaps the text should go in DOC.
586 (put face
'face-documentation
(purecopy string
)))
589 (defalias 'face-doc-string
'face-documentation
)
590 (defalias 'set-face-doc-string
'set-face-documentation
)
594 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
595 ;; Setting face attributes.
596 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
599 (defun set-face-attribute (face frame
&rest args
)
600 "Set attributes of FACE on FRAME from ARGS.
601 This function overrides the face attributes specified by FACE's
602 face spec. It is mostly intended for internal use only.
604 If FRAME is nil, set the attributes for all existing frames, as
605 well as the default for new frames. If FRAME is t, change the
606 default for new frames only.
608 ARGS must come in pairs ATTRIBUTE VALUE. ATTRIBUTE must be a
609 valid face attribute name. All attributes can be set to
610 `unspecified'; this fact is not further mentioned below.
612 The following attributes are recognized:
616 VALUE must be a string specifying the font family
617 \(e.g. \"Monospace\") or a fontset.
621 VALUE must be a string specifying the font foundry,
622 e.g., \"adobe\". If a font foundry is specified, wild-cards `*'
627 VALUE specifies the relative proportionate width of the font to use.
628 It must be one of the symbols `ultra-condensed', `extra-condensed',
629 `condensed', `semi-condensed', `normal', `semi-expanded', `expanded',
630 `extra-expanded', or `ultra-expanded'.
634 VALUE specifies the relative or absolute height of the font. An
635 absolute height is an integer, and specifies font height in units
636 of 1/10 pt. A relative height is either a floating point number,
637 which specifies a scaling factor for the underlying face height;
638 or a function that takes a single argument (the underlying face
639 height) and returns the new height. Note that for the `default'
640 face, you must specify an absolute height (since there is nothing
641 for it to be relative to).
645 VALUE specifies the weight of the font to use. It must be one of the
646 symbols `ultra-bold', `extra-bold', `bold', `semi-bold', `normal',
647 `semi-light', `light', `extra-light', `ultra-light'.
651 VALUE specifies the slant of the font to use. It must be one of the
652 symbols `italic', `oblique', `normal', `reverse-italic', or
655 `:foreground', `:background'
657 VALUE must be a color name, a string.
661 VALUE specifies whether characters in FACE should be underlined.
662 If VALUE is t, underline with foreground color of the face.
663 If VALUE is a string, underline with that color.
664 If VALUE is nil, explicitly don't underline.
666 Otherwise, VALUE must be a property list of the form:
668 `(:color COLOR :style STYLE)'.
670 COLOR can be a either a color name string or `foreground-color'.
671 STYLE can be either `line' or `wave'.
672 If a keyword/value pair is missing from the property list, a
673 default value will be used for the value.
674 The default value of COLOR is the foreground color of the face.
675 The default value of STYLE is `line'.
679 VALUE specifies whether characters in FACE should be overlined. If
680 VALUE is t, overline with foreground color of the face. If VALUE is a
681 string, overline with that color. If VALUE is nil, explicitly don't
686 VALUE specifies whether characters in FACE should be drawn with a line
687 striking through them. If VALUE is t, use the foreground color of the
688 face. If VALUE is a string, strike-through with that color. If VALUE
689 is nil, explicitly don't strike through.
693 VALUE specifies whether characters in FACE should have a box drawn
694 around them. If VALUE is nil, explicitly don't draw boxes. If
695 VALUE is t, draw a box with lines of width 1 in the foreground color
696 of the face. If VALUE is a string, the string must be a color name,
697 and the box is drawn in that color with a line width of 1. Otherwise,
698 VALUE must be a property list of the form `(:line-width WIDTH
699 :color COLOR :style STYLE)'. If a keyword/value pair is missing from
700 the property list, a default value will be used for the value, as
701 specified below. WIDTH specifies the width of the lines to draw; it
702 defaults to 1. If WIDTH is negative, the absolute value is the width
703 of the lines, and draw top/bottom lines inside the characters area,
704 not around it. COLOR is the name of the color to draw in, default is
705 the foreground color of the face for simple boxes, and the background
706 color of the face for 3D boxes. STYLE specifies whether a 3D box
707 should be draw. If STYLE is `released-button', draw a box looking
708 like a released 3D button. If STYLE is `pressed-button' draw a box
709 that appears like a pressed button. If STYLE is nil, the default if
710 the property list doesn't contain a style specification, draw a 2D
715 VALUE specifies whether characters in FACE should be displayed in
716 inverse video. VALUE must be one of t or nil.
720 If VALUE is a string, it must be the name of a file of pixmap data.
721 The directories listed in the `x-bitmap-file-path' variable are
722 searched. Alternatively, VALUE may be a list of the form (WIDTH
723 HEIGHT DATA) where WIDTH and HEIGHT are the size in pixels, and DATA
724 is a string containing the raw bits of the bitmap. VALUE nil means
725 explicitly don't use a stipple pattern.
727 For convenience, attributes `:family', `:foundry', `:width',
728 `:height', `:weight', and `:slant' may also be set in one step
733 Set font-related face attributes from VALUE. VALUE must be a
734 valid font name or font object. Setting this attribute will also
735 set the `:family', `:foundry', `:width', `:height', `:weight',
736 and `:slant' attributes.
740 VALUE is the name of a face from which to inherit attributes, or
741 a list of face names. Attributes from inherited faces are merged
742 into the face like an underlying face would be, with higher
743 priority than underlying faces.
745 For backward compatibility, the keywords `:bold' and `:italic'
746 can be used to specify weight and slant respectively. This usage
747 is considered obsolete. For these two keywords, the VALUE must
748 be either t or nil. A value of t for `:bold' is equivalent to
749 setting `:weight' to `bold', and a value of t for `:italic' is
750 equivalent to setting `:slant' to `italic'. But if `:weight' is
751 specified in the face spec, `:bold' is ignored, and if `:slant'
752 is specified, `:italic' is ignored."
753 (setq args
(purecopy args
))
754 (let ((where (if (null frame
) 0 frame
))
757 ;; If we set the new-frame defaults, this face is modified outside Custom.
758 (if (memq where
'(0 t
))
759 (put (or (get face
'face-alias
) face
) 'face-modified t
))
760 ;; If family and/or foundry are specified, set it first. Certain
761 ;; face attributes, e.g. :weight semi-condensed, are not supported
762 ;; in every font. See bug#1127.
764 (cond ((eq (car spec
) :family
)
765 (setq family
(cadr spec
)))
766 ((eq (car spec
) :foundry
)
767 (setq foundry
(cadr spec
))))
768 (setq spec
(cddr spec
)))
769 (when (or family foundry
)
770 (when (and (stringp family
)
771 (string-match "\\([^-]*\\)-\\([^-]*\\)" family
))
773 (setq foundry
(match-string 1 family
)))
774 (setq family
(match-string 2 family
)))
775 (when (or (stringp family
) (eq family
'unspecified
))
776 (internal-set-lisp-face-attribute face
:family
(purecopy family
)
778 (when (or (stringp foundry
) (eq foundry
'unspecified
))
779 (internal-set-lisp-face-attribute face
:foundry
(purecopy foundry
)
782 (unless (memq (car args
) '(:family
:foundry
))
783 (internal-set-lisp-face-attribute face
(car args
)
784 (purecopy (cadr args
))
786 (setq args
(cddr args
)))))
788 (defun make-face-bold (face &optional frame _noerror
)
789 "Make the font of FACE be bold, if possible.
790 FRAME nil or not specified means change face on all frames.
791 Argument NOERROR is ignored and retained for compatibility.
792 Use `set-face-attribute' for finer control of the font weight."
793 (interactive (list (read-face-name "Make which face bold"
795 (set-face-attribute face frame
:weight
'bold
))
798 (defun make-face-unbold (face &optional frame _noerror
)
799 "Make the font of FACE be non-bold, if possible.
800 FRAME nil or not specified means change face on all frames.
801 Argument NOERROR is ignored and retained for compatibility."
802 (interactive (list (read-face-name "Make which face non-bold"
804 (set-face-attribute face frame
:weight
'normal
))
807 (defun make-face-italic (face &optional frame _noerror
)
808 "Make the font of FACE be italic, if possible.
809 FRAME nil or not specified means change face on all frames.
810 Argument NOERROR is ignored and retained for compatibility.
811 Use `set-face-attribute' for finer control of the font slant."
812 (interactive (list (read-face-name "Make which face italic"
814 (set-face-attribute face frame
:slant
'italic
))
817 (defun make-face-unitalic (face &optional frame _noerror
)
818 "Make the font of FACE be non-italic, if possible.
819 FRAME nil or not specified means change face on all frames.
820 Argument NOERROR is ignored and retained for compatibility."
821 (interactive (list (read-face-name "Make which face non-italic"
823 (set-face-attribute face frame
:slant
'normal
))
826 (defun make-face-bold-italic (face &optional frame _noerror
)
827 "Make the font of FACE be bold and italic, if possible.
828 FRAME nil or not specified means change face on all frames.
829 Argument NOERROR is ignored and retained for compatibility.
830 Use `set-face-attribute' for finer control of font weight and slant."
831 (interactive (list (read-face-name "Make which face bold-italic"
833 (set-face-attribute face frame
:weight
'bold
:slant
'italic
))
836 (defun set-face-font (face font
&optional frame
)
837 "Change font-related attributes of FACE to those of FONT (a string).
838 FRAME nil or not specified means change face on all frames.
839 This sets the attributes `:family', `:foundry', `:width',
840 `:height', `:weight', and `:slant'. When called interactively,
841 prompt for the face and font."
842 (interactive (read-face-and-attribute :font
))
843 (set-face-attribute face frame
:font font
))
846 ;; Implementation note: Emulating gray background colors with a
847 ;; stipple pattern is now part of the face realization process, and is
848 ;; done in C depending on the frame on which the face is realized.
850 (defun set-face-background (face color
&optional frame
)
851 "Change the background color of face FACE to COLOR (a string).
852 FRAME nil or not specified means change face on all frames.
853 COLOR can be a system-defined color name (see `list-colors-display')
854 or a hex spec of the form #RRGGBB.
855 When called interactively, prompts for the face and color."
856 (interactive (read-face-and-attribute :background
))
857 (set-face-attribute face frame
:background
(or color
'unspecified
)))
860 (defun set-face-foreground (face color
&optional frame
)
861 "Change the foreground color of face FACE to COLOR (a string).
862 FRAME nil or not specified means change face on all frames.
863 COLOR can be a system-defined color name (see `list-colors-display')
864 or a hex spec of the form #RRGGBB.
865 When called interactively, prompts for the face and color."
866 (interactive (read-face-and-attribute :foreground
))
867 (set-face-attribute face frame
:foreground
(or color
'unspecified
)))
870 (defun set-face-stipple (face stipple
&optional frame
)
871 "Change the stipple pixmap of face FACE to STIPPLE.
872 FRAME nil or not specified means change face on all frames.
873 STIPPLE should be a string, the name of a file of pixmap data.
874 The directories listed in the `x-bitmap-file-path' variable are searched.
876 Alternatively, STIPPLE may be a list of the form (WIDTH HEIGHT DATA)
877 where WIDTH and HEIGHT are the size in pixels,
878 and DATA is a string, containing the raw bits of the bitmap."
879 (interactive (read-face-and-attribute :stipple
))
880 (set-face-attribute face frame
:stipple
(or stipple
'unspecified
)))
883 (defun set-face-underline (face underline
&optional frame
)
884 "Specify whether face FACE is underlined.
885 UNDERLINE nil means FACE explicitly doesn't underline.
886 UNDERLINE t means FACE underlines with its foreground color.
887 If UNDERLINE is a string, underline with that color.
889 UNDERLINE may also be a list of the form (:color COLOR :style STYLE),
890 where COLOR is a string or `foreground-color', and STYLE is either
891 `line' or `wave'. :color may be omitted, which means to use the
892 foreground color. :style may be omitted, which means to use a line.
894 FRAME nil or not specified means change face on all frames.
895 Use `set-face-attribute' to “unspecify” underlining."
896 (interactive (read-face-and-attribute :underline
))
897 (set-face-attribute face frame
:underline underline
))
899 (define-obsolete-function-alias 'set-face-underline-p
900 'set-face-underline
"24.3")
903 (defun set-face-inverse-video (face inverse-video-p
&optional frame
)
904 "Specify whether face FACE is in inverse video.
905 INVERSE-VIDEO-P non-nil means FACE displays explicitly in inverse video.
906 INVERSE-VIDEO-P nil means FACE explicitly is not in inverse video.
907 FRAME nil or not specified means change face on all frames.
908 Use `set-face-attribute' to “unspecify” the inverse video attribute."
910 (let ((list (read-face-and-attribute :inverse-video
)))
911 (list (car list
) (if (cadr list
) t
))))
912 (set-face-attribute face frame
:inverse-video inverse-video-p
))
914 (define-obsolete-function-alias 'set-face-inverse-video-p
915 'set-face-inverse-video
"24.4")
917 (defun set-face-bold (face bold-p
&optional frame
)
918 "Specify whether face FACE is bold.
919 BOLD-P non-nil means FACE should explicitly display bold.
920 BOLD-P nil means FACE should explicitly display non-bold.
921 FRAME nil or not specified means change face on all frames.
922 Use `set-face-attribute' or `modify-face' for finer control."
924 (make-face-unbold face frame
)
925 (make-face-bold face frame
)))
927 (define-obsolete-function-alias 'set-face-bold-p
'set-face-bold
"24.4")
930 (defun set-face-italic (face italic-p
&optional frame
)
931 "Specify whether face FACE is italic.
932 ITALIC-P non-nil means FACE should explicitly display italic.
933 ITALIC-P nil means FACE should explicitly display non-italic.
934 FRAME nil or not specified means change face on all frames.
935 Use `set-face-attribute' or `modify-face' for finer control."
937 (make-face-unitalic face frame
)
938 (make-face-italic face frame
)))
940 (define-obsolete-function-alias 'set-face-italic-p
'set-face-italic
"24.4")
943 (defalias 'set-face-background-pixmap
'set-face-stipple
)
946 (defun invert-face (face &optional frame
)
947 "Swap the foreground and background colors of FACE.
948 If FRAME is omitted or nil, it means change face on all frames.
949 If FACE specifies neither foreground nor background color,
950 set its foreground and background to the background and foreground
951 of the default face. Value is FACE."
952 (interactive (list (read-face-name "Invert face" (face-at-point t
))))
953 (let ((fg (face-attribute face
:foreground frame
))
954 (bg (face-attribute face
:background frame
)))
955 (if (not (and (eq fg
'unspecified
) (eq bg
'unspecified
)))
956 (set-face-attribute face frame
:foreground bg
:background fg
)
957 (set-face-attribute face frame
959 (face-attribute 'default
:background frame
)
961 (face-attribute 'default
:foreground frame
))))
965 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
966 ;;; Interactively modifying faces.
967 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
969 (defvar crm-separator
) ; from crm.el
971 (defun read-face-name (prompt &optional default multiple
)
972 "Read one or more face names, prompting with PROMPT.
973 PROMPT should not end in a space or a colon.
975 Return DEFAULT if the user enters the empty string.
976 If DEFAULT is non-nil, it should be a single face or a list of face names
977 \(symbols or strings). In the latter case, return the `car' of DEFAULT
978 \(if MULTIPLE is nil, see below), or DEFAULT (if MULTIPLE is non-nil).
980 If MULTIPLE is non-nil, this function uses `completing-read-multiple'
981 to read multiple faces with \"[ \\t]*,[ \\t]*\" as the separator regexp
982 and it returns a list of face names. Otherwise, it reads and returns
984 (if (and default
(not (stringp default
)))
986 (cond ((symbolp default
)
987 (symbol-name default
))
989 (mapconcat (lambda (f) (if (symbolp f
) (symbol-name f
) f
))
991 ;; If we only want one, and the default is more than one,
992 ;; discard the unwanted ones.
993 (t (symbol-name (car default
))))))
994 (when (and default
(not multiple
))
996 ;; For compatibility with `completing-read-multiple' use `crm-separator'
997 ;; to define DEFAULT if MULTIPLE is nil.
998 (setq default
(car (split-string default crm-separator t
))))
1000 (let ((prompt (if default
1001 (format "%s (default `%s'): " prompt default
)
1002 (format "%s: " prompt
)))
1003 aliasfaces nonaliasfaces faces
)
1004 ;; Build up the completion tables.
1005 (mapatoms (lambda (s)
1007 (if (get s
'face-alias
)
1008 (push (symbol-name s
) aliasfaces
)
1009 (push (symbol-name s
) nonaliasfaces
)))))
1012 (dolist (face (completing-read-multiple
1014 (completion-table-in-turn nonaliasfaces aliasfaces
)
1015 nil t nil
'face-name-history default
))
1016 ;; Ignore elements that are not faces
1017 ;; (for example, because DEFAULT was "all faces")
1018 (if (facep face
) (push (intern face
) faces
)))
1020 (let ((face (completing-read
1022 (completion-table-in-turn nonaliasfaces aliasfaces
)
1023 nil t nil
'face-name-history default
)))
1024 (if (facep face
) (intern face
))))))
1026 ;; Not defined without X, but behind window-system test.
1027 (defvar x-bitmap-file-path
)
1029 (defun face-valid-attribute-values (attribute &optional frame
)
1030 "Return valid values for face attribute ATTRIBUTE.
1031 The optional argument FRAME is used to determine available fonts
1032 and colors. If it is nil or not specified, the selected frame is used.
1033 Value is an alist of (NAME . VALUE) if ATTRIBUTE expects a value out
1034 of a set of discrete values. Value is `integerp' if ATTRIBUTE expects
1039 (if (window-system frame
)
1040 (mapcar (lambda (x) (cons x x
))
1042 ;; Only one font on TTYs.
1043 (list (cons "default" "default"))))
1047 (mapcar #'(lambda (x) (cons (symbol-name (aref x
1)) (aref x
1)))
1050 (mapcar #'(lambda (x) (cons (symbol-name (aref x
1)) (aref x
1)))
1053 (mapcar #'(lambda (x) (cons (symbol-name (aref x
1)) (aref x
1)))
1056 (mapcar #'(lambda (x) (cons (symbol-name x
) x
))
1057 (internal-lisp-face-attribute-values attribute
)))
1058 ((or `:underline
`:overline
`:strike-through
`:box
)
1059 (if (window-system frame
)
1060 (nconc (mapcar #'(lambda (x) (cons (symbol-name x
) x
))
1061 (internal-lisp-face-attribute-values attribute
))
1062 (mapcar #'(lambda (c) (cons c c
))
1063 (defined-colors frame
)))
1064 (mapcar #'(lambda (x) (cons (symbol-name x
) x
))
1065 (internal-lisp-face-attribute-values attribute
))))
1066 ((or `:foreground
`:background
)
1067 (mapcar #'(lambda (c) (cons c c
))
1068 (defined-colors frame
)))
1072 (and (memq (window-system frame
) '(x ns
)) ; No stipple on w32
1075 (mapcar (lambda (dir)
1076 (and (file-readable-p dir
)
1077 (file-directory-p dir
)
1078 (directory-files dir
)))
1079 x-bitmap-file-path
)))))
1081 (cons '("none" . nil
)
1082 (mapcar #'(lambda (c) (cons (symbol-name c
) c
))
1085 (error "Internal error")))))
1086 (if (and (listp valid
) (not (memq attribute
'(:inherit
))))
1087 (nconc (list (cons "unspecified" 'unspecified
)) valid
)
1091 (defconst face-attribute-name-alist
1092 '((:family .
"font family")
1093 (:foundry .
"font foundry")
1094 (:width .
"character set width")
1095 (:height .
"height in 1/10 pt")
1096 (:weight .
"weight")
1098 (:underline .
"underline")
1099 (:overline .
"overline")
1100 (:strike-through .
"strike-through")
1102 (:inverse-video .
"inverse-video display")
1103 (:foreground .
"foreground color")
1104 (:background .
"background color")
1105 (:stipple .
"background stipple")
1106 (:inherit .
"inheritance"))
1107 "An alist of descriptive names for face attributes.
1108 Each element has the form (ATTRIBUTE-NAME . DESCRIPTION) where
1109 ATTRIBUTE-NAME is a face attribute name (a keyword symbol), and
1110 DESCRIPTION is a descriptive name for ATTRIBUTE-NAME.")
1113 (defun face-descriptive-attribute-name (attribute)
1114 "Return a descriptive name for ATTRIBUTE."
1115 (cdr (assq attribute face-attribute-name-alist
)))
1118 (defun face-read-string (face default name
&optional completion-alist
)
1119 "Interactively read a face attribute string value.
1120 FACE is the face whose attribute is read. If non-nil, DEFAULT is the
1121 default string to return if no new value is entered. NAME is a
1122 descriptive name of the attribute for prompting. COMPLETION-ALIST is an
1123 alist of valid values, if non-nil.
1125 Entering nothing accepts the default string DEFAULT.
1126 Value is the new attribute value."
1127 ;; Capitalize NAME (we don't use `capitalize' because that capitalizes
1128 ;; each word in a string separately).
1129 (setq name
(concat (upcase (substring name
0 1)) (substring name
1)))
1130 (let* ((completion-ignore-case t
)
1131 (value (completing-read
1133 (format "%s for face `%s' (default %s): "
1135 (format "%s for face `%s': " name face
))
1136 completion-alist nil nil nil nil default
)))
1137 (if (equal value
"") default value
)))
1140 (defun face-read-integer (face default name
)
1141 "Interactively read an integer face attribute value.
1142 FACE is the face whose attribute is read. DEFAULT is the default
1143 value to return if no new value is entered. NAME is a descriptive
1144 name of the attribute for prompting. Value is the new attribute value."
1146 (face-read-string face
1147 (format "%s" default
)
1149 (list (cons "unspecified" 'unspecified
)))))
1150 (cond ((equal new-value
"unspecified")
1152 ((member new-value
'("unspecified-fg" "unspecified-bg"))
1155 (string-to-number new-value
)))))
1158 ;; FIXME this does allow you to enter the list forms of :box,
1159 ;; :stipple, or :underline, because face-valid-attribute-values does
1160 ;; not return those forms.
1161 (defun read-face-attribute (face attribute
&optional frame
)
1162 "Interactively read a new value for FACE's ATTRIBUTE.
1163 Optional argument FRAME nil or unspecified means read an attribute value
1164 of a global face. Value is the new attribute value."
1165 (let* ((old-value (face-attribute face attribute frame
))
1166 (attribute-name (face-descriptive-attribute-name attribute
))
1167 (valid (face-valid-attribute-values attribute frame
))
1169 ;; Represent complex attribute values as strings by printing them
1170 ;; out. Stipple can be a vector; (WIDTH HEIGHT DATA). Box can be
1171 ;; a list `(:width WIDTH :color COLOR)' or `(:width WIDTH :shadow
1172 ;; SHADOW)'. Underline can be `(:color COLOR :style STYLE)'.
1173 (and (memq attribute
'(:box
:stipple
:underline
))
1174 (or (consp old-value
)
1175 (vectorp old-value
))
1176 (setq old-value
(prin1-to-string old-value
)))
1177 (cond ((listp valid
)
1179 (or (car (rassoc old-value valid
))
1180 (format "%s" old-value
))))
1182 (face-read-string face default attribute-name valid
))
1183 (if (equal new-value default
)
1184 ;; Nothing changed, so don't bother with all the stuff
1185 ;; below. In particular, this avoids a non-tty color
1186 ;; from being canonicalized for a tty when the user
1187 ;; just uses the default.
1188 (setq new-value old-value
)
1189 ;; Terminal frames can support colors that don't appear
1190 ;; explicitly in VALID, using color approximation code
1191 ;; in tty-colors.el.
1192 (when (and (memq attribute
'(:foreground
:background
))
1193 (not (memq (window-system frame
) '(x w32 ns
)))
1194 (not (member new-value
1196 "unspecified-fg" "unspecified-bg"))))
1197 (setq new-value
(car (tty-color-desc new-value frame
))))
1198 (when (assoc new-value valid
)
1199 (setq new-value
(cdr (assoc new-value valid
)))))))
1200 ((eq valid
'integerp
)
1201 (setq new-value
(face-read-integer face old-value attribute-name
)))
1202 (t (error "Internal error")))
1203 ;; Convert stipple and box value text we read back to a list or
1204 ;; vector if it looks like one. This makes the assumption that a
1205 ;; pixmap file name won't start with an open-paren.
1206 (and (memq attribute
'(:stipple
:box
:underline
))
1208 (string-match-p "^[[(]" new-value
)
1209 (setq new-value
(read new-value
)))
1212 (declare-function fontset-list
"fontset.c" ())
1213 (declare-function x-list-fonts
"xfaces.c"
1214 (pattern &optional face frame maximum width
))
1216 (defun read-face-font (face &optional frame
)
1217 "Read the name of a font for FACE on FRAME.
1218 If optional argument FRAME is nil or omitted, use the selected frame."
1219 (let ((completion-ignore-case t
))
1220 (completing-read (format "Set font attributes of face `%s' from font: " face
)
1221 (append (fontset-list) (x-list-fonts "*" nil frame
)))))
1224 (defun read-all-face-attributes (face &optional frame
)
1225 "Interactively read all attributes for FACE.
1226 If optional argument FRAME is nil or omitted, use the selected frame.
1227 Value is a property list of attribute names and new values."
1229 (dolist (attribute face-attribute-name-alist result
)
1230 (setq result
(cons (car attribute
)
1231 (cons (read-face-attribute face
(car attribute
) frame
)
1234 (defun modify-face (&optional face foreground background stipple
1235 bold-p italic-p underline inverse-p frame
)
1236 "Modify attributes of faces interactively.
1237 If optional argument FRAME is nil or omitted, modify the face used
1238 for newly created frame, i.e. the global face.
1239 For non-interactive use, `set-face-attribute' is preferred.
1240 When called from Lisp, if FACE is nil, all arguments but FRAME are ignored
1241 and the face and its settings are obtained by querying the user."
1244 (set-face-attribute face frame
1245 :foreground
(or foreground
'unspecified
)
1246 :background
(or background
'unspecified
)
1248 :weight
(if bold-p
'bold
'normal
)
1249 :slant
(if italic-p
'italic
'normal
)
1250 :underline underline
1251 :inverse-video inverse-p
)
1252 (setq face
(read-face-name "Modify face" (face-at-point t
)))
1253 (apply #'set-face-attribute face frame
1254 (read-all-face-attributes face frame
))))
1256 (defun read-face-and-attribute (attribute &optional frame
)
1257 "Read face name and face attribute value.
1258 ATTRIBUTE is the attribute whose new value is read.
1259 FRAME nil or unspecified means read attribute value of global face.
1260 Value is a list (FACE NEW-VALUE) where FACE is the face read
1261 \(a symbol), and NEW-VALUE is value read."
1262 (cond ((eq attribute
:font
)
1263 (let* ((prompt "Set font-related attributes of face")
1264 (face (read-face-name prompt
(face-at-point t
)))
1265 (font (read-face-font face frame
)))
1268 (let* ((attribute-name (face-descriptive-attribute-name attribute
))
1269 (prompt (format "Set %s of face" attribute-name
))
1270 (face (read-face-name prompt
(face-at-point t
)))
1271 (new-value (read-face-attribute face attribute frame
)))
1272 (list face new-value
)))))
1276 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1278 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1280 (defconst list-faces-sample-text
1281 "abcdefghijklmnopqrstuvwxyz ABCDEFGHIJKLMNOPQRSTUVWXYZ"
1282 "Text string to display as the sample text for `list-faces-display'.")
1285 ;; The name list-faces would be more consistent, but let's avoid a
1286 ;; conflict with Lucid, which uses that name differently.
1288 (defvar help-xref-stack
)
1289 (defun list-faces-display (&optional regexp
)
1290 "List all faces, using the same sample text in each.
1291 The sample text is a string that comes from the variable
1292 `list-faces-sample-text'.
1294 If REGEXP is non-nil, list only those faces with names matching
1295 this regular expression. When called interactively with a prefix
1296 argument, prompt for a regular expression using `read-regexp'."
1297 (interactive (list (and current-prefix-arg
1298 (read-regexp "List faces matching regexp"))))
1299 (let ((all-faces (zerop (length regexp
)))
1300 (frame (selected-frame))
1303 disp-frame window face-name
)
1304 ;; We filter and take the max length in one pass
1308 (let ((s (symbol-name f
)))
1309 (when (or all-faces
(string-match-p regexp s
))
1310 (setq max-length
(max (length s
) max-length
))
1312 (sort (face-list) #'string-lessp
))))
1314 (error "No faces matching \"%s\"" regexp
))
1315 (setq max-length
(1+ max-length
)
1316 line-format
(format "%%-%ds" max-length
))
1317 (with-help-window "*Faces*"
1318 (with-current-buffer standard-output
1319 (setq truncate-lines t
)
1321 (substitute-command-keys
1323 "\\<help-mode-map>Use "
1324 (if (display-mouse-p) "\\[help-follow-mouse] or ")
1325 "\\[help-follow] on a face name to customize it\n"
1326 "or on its sample text for a description of the face.\n\n")))
1327 (setq help-xref-stack nil
)
1328 (dolist (face faces
)
1329 (setq face-name
(symbol-name face
))
1330 (insert (format line-format face-name
))
1331 ;; Hyperlink to a customization buffer for the face. Using
1332 ;; the help xref mechanism may not be the best way.
1335 (search-backward face-name
)
1336 (setq help-xref-stack-item
`(list-faces-display ,regexp
))
1337 (help-xref-button 0 'help-customize-face face
)))
1339 (line-beg (line-beginning-position)))
1340 (insert list-faces-sample-text
)
1341 ;; Hyperlink to a help buffer for the face.
1344 (search-backward list-faces-sample-text
)
1345 (help-xref-button 0 'help-face face
)))
1347 (put-text-property beg
(1- (point)) 'face face
)
1348 ;; Make all face commands default to the proper face
1349 ;; anywhere in the line.
1350 (put-text-property line-beg
(1- (point)) 'read-face-name face
)
1351 ;; If the sample text has multiple lines, line up all of them.
1355 (insert-char ?\s max-length
)
1357 (goto-char (point-min))))
1358 ;; If the *Faces* buffer appears in a different frame,
1359 ;; copy all the face definitions from FRAME,
1360 ;; so that the display will reflect the frame that was selected.
1361 (setq window
(get-buffer-window (get-buffer "*Faces*") t
))
1362 (setq disp-frame
(if window
(window-frame window
)
1363 (car (frame-list))))
1364 (or (eq frame disp-frame
)
1365 (dolist (face (face-list))
1366 (copy-face face face frame disp-frame
)))))
1369 (defun describe-face (face &optional frame
)
1370 "Display the properties of face FACE on FRAME.
1371 Interactively, FACE defaults to the faces of the character after point
1372 and FRAME defaults to the selected frame.
1374 If the optional argument FRAME is given, report on face FACE in that frame.
1375 If FRAME is t, report on the defaults for face FACE (for new frames).
1376 If FRAME is omitted or nil, use the selected frame."
1377 (interactive (list (read-face-name "Describe face"
1378 (or (face-at-point t
) 'default
)
1380 (let* ((attrs '((:family .
"Family")
1381 (:foundry .
"Foundry")
1383 (:height .
"Height")
1384 (:weight .
"Weight")
1386 (:foreground .
"Foreground")
1387 (:distant-foreground .
"DistantForeground")
1388 (:background .
"Background")
1389 (:underline .
"Underline")
1390 (:overline .
"Overline")
1391 (:strike-through .
"Strike-through")
1393 (:inverse-video .
"Inverse")
1394 (:stipple .
"Stipple")
1396 (:fontset .
"Fontset")
1397 (:inherit .
"Inherit")))
1398 (max-width (apply #'max
(mapcar #'(lambda (x) (length (cdr x
)))
1400 (help-setup-xref (list #'describe-face face
)
1401 (called-interactively-p 'interactive
))
1403 (setq face
'default
))
1404 (if (not (listp face
))
1405 (setq face
(list face
)))
1406 (with-help-window (help-buffer)
1407 (with-current-buffer standard-output
1409 (if (stringp f
) (setq f
(intern f
)))
1410 ;; We may get called for anonymous faces (i.e., faces
1411 ;; expressed using prop-value plists). Those can't be
1412 ;; usefully customized, so ignore them.
1414 (insert "Face: " (symbol-name f
))
1416 (insert " undefined face.\n")
1417 (let ((customize-label "customize this face")
1419 (insert (concat " (" (propertize "sample" 'font-lock-face f
) ")"))
1420 (princ (concat " (" customize-label
")\n"))
1421 ;; FIXME not sure how much of this belongs here, and
1422 ;; how much in `face-documentation'. The latter is
1423 ;; not used much, but needs to return nil for
1424 ;; undocumented faces.
1425 (let ((alias (get f
'face-alias
))
1431 (format "\n %s is an alias for the face `%s'.\n%s"
1433 (if (setq obsolete
(get f
'obsolete-face
))
1434 (format " This face is obsolete%s; use `%s' instead.\n"
1435 (if (stringp obsolete
)
1436 (format " since %s" obsolete
)
1440 (insert "\nDocumentation:\n"
1441 (or (face-documentation face
)
1442 "Not documented as a face.")
1444 (with-current-buffer standard-output
1447 (concat "\\(" customize-label
"\\)") nil t
)
1448 (help-xref-button 1 'help-customize-face f
)))
1449 (setq file-name
(find-lisp-object-file-name f
'defface
))
1451 (princ "Defined in `")
1452 (princ (file-name-nondirectory file-name
))
1454 ;; Make a hyperlink to the library.
1456 (re-search-backward "`\\([^`']+\\)'" nil t
)
1457 (help-xref-button 1 'help-face-def f file-name
))
1462 (let ((attr (face-attribute f
(car a
) frame
)))
1463 (insert (make-string (- max-width
(length (cdr a
))) ?\s
)
1464 (cdr a
) ": " (format "%s" attr
))
1465 (if (and (eq (car a
) :inherit
)
1466 (not (eq attr
'unspecified
)))
1467 ;; Make a hyperlink to the parent face.
1469 (re-search-backward ": \\([^:]+\\)" nil t
)
1470 (help-xref-button 1 'help-face attr
)))
1475 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1476 ;;; Face specifications (defface).
1477 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1479 ;; Parameter FRAME Is kept for call compatibility to with previous
1480 ;; face implementation.
1482 (defun face-attr-construct (face &optional _frame
)
1483 "Return a `defface'-style attribute list for FACE.
1484 Value is a property list of pairs ATTRIBUTE VALUE for all specified
1485 face attributes of FACE where ATTRIBUTE is the attribute name and
1486 VALUE is the specified value of that attribute.
1487 Argument FRAME is ignored and retained for compatibility."
1489 (dolist (entry face-attribute-name-alist result
)
1490 (let* ((attribute (car entry
))
1491 (value (face-attribute face attribute
)))
1492 (unless (eq value
'unspecified
)
1493 (setq result
(nconc (list attribute value
) result
)))))))
1496 (defun face-spec-set-match-display (display frame
)
1497 "Non-nil if DISPLAY matches FRAME.
1498 DISPLAY is part of a spec such as can be used in `defface'.
1499 If FRAME is nil, the current FRAME is used."
1500 (let* ((conjuncts display
)
1501 conjunct req options
1502 ;; t means we have succeeded against all the conjuncts in
1503 ;; DISPLAY that have been tested so far.
1505 (if (eq conjuncts t
)
1506 (setq conjuncts nil
))
1507 (while (and conjuncts match
)
1508 (setq conjunct
(car conjuncts
)
1509 conjuncts
(cdr conjuncts
)
1511 options
(cdr conjunct
)
1512 match
(cond ((eq req
'type
)
1513 (or (memq (window-system frame
) options
)
1514 (and (memq 'graphic options
)
1515 (memq (window-system frame
) '(x w32 ns
)))
1516 ;; FIXME: This should be revisited to use
1517 ;; display-graphic-p, provided that the
1518 ;; color selection depends on the number
1519 ;; of supported colors, and all defface's
1520 ;; are changed to look at number of colors
1521 ;; instead of (type graphic) etc.
1522 (if (null (window-system frame
))
1524 (or (and (memq 'motif options
)
1526 (and (memq 'gtk options
)
1528 (and (memq 'lucid options
)
1529 (featurep 'x-toolkit
)
1530 (not (featurep 'motif
))
1531 (not (featurep 'gtk
)))
1532 (and (memq 'x-toolkit options
)
1533 (featurep 'x-toolkit
))))))
1534 ((eq req
'min-colors
)
1535 (>= (display-color-cells frame
) (car options
)))
1537 (memq (frame-parameter frame
'display-type
) options
))
1538 ((eq req
'background
)
1539 (memq (frame-parameter frame
'background-mode
)
1542 (display-supports-face-attributes-p options frame
))
1543 (t (error "Unknown req `%S' with options `%S'"
1548 (defun face-spec-choose (spec &optional frame no-match-retval
)
1549 "Return the proper attributes for FRAME, out of SPEC.
1551 If no match is found or SPEC is nil, return nil, unless NO-MATCH-RETVAL
1552 is given, in which case return its value instead."
1554 (setq frame
(selected-frame)))
1556 result defaults match-found
)
1558 (let* ((entry (pop tail
))
1559 (display (car entry
))
1562 ;; Get the attributes as actually specified by this alternative.
1564 (if (null (cdr attrs
)) ;; was (listp (car attrs))
1565 ;; Old-style entry, the attribute list is the
1570 ;; If the condition is `default', that sets the default
1571 ;; for following conditions.
1572 (if (eq display
'default
)
1573 (setq defaults thisval
)
1574 ;; Otherwise, if it matches, use it.
1575 (when (face-spec-set-match-display display frame
)
1576 (setq result thisval
1579 ;; If defaults have been found, it's safe to just append those to the result
1580 ;; list (which at this point will be either nil or contain actual specs) and
1581 ;; return it to the caller. Since there will most definitely be something to
1582 ;; return in this case, there's no need to know/check if a match was found.
1584 (append result defaults
)
1590 (defun face-spec-reset-face (face &optional frame
)
1591 "Reset all attributes of FACE on FRAME to unspecified."
1592 (apply 'set-face-attribute face frame
1593 (if (eq face
'default
)
1594 ;; For the default face, avoid making any attribute
1595 ;; unspecified. Instead, set attributes to default values
1596 ;; (see also realize_default_face in xfaces.c).
1598 '(:underline nil
:overline nil
:strike-through nil
1599 :box nil
:inverse-video nil
:stipple nil
:inherit nil
)
1600 ;; `display-graphic-p' is unavailable when running
1601 ;; temacs, prior to loading frame.el.
1602 (when (fboundp 'display-graphic-p
)
1603 (unless (display-graphic-p frame
)
1604 `(:family
"default" :foundry
"default" :width normal
1605 :height
1 :weight normal
:slant normal
1606 :foreground
,(if (frame-parameter nil
'reverse
)
1609 :background
,(if (frame-parameter nil
'reverse
)
1611 "unspecified-bg")))))
1612 ;; For all other faces, unspecify all attributes.
1614 (mapcar (lambda (x) (list (car x
) 'unspecified
))
1615 face-attribute-name-alist
)))))
1617 (defun face-spec-set (face spec
&optional spec-type
)
1618 "Set the face spec SPEC for FACE.
1619 See `defface' for the format of SPEC.
1621 The appearance of each face is controlled by its specs (set via
1622 this function), and by the internal frame-specific face
1623 attributes (set via `set-face-attribute').
1625 This function also defines FACE as a valid face name if it is not
1626 already one, and (re)calculates its attributes on existing
1629 The argument SPEC-TYPE determines which spec to set:
1630 nil or `face-override-spec' means the override spec (which is
1631 usually what you want if calling this function outside of
1633 `customized-face' or `saved-face' means the customized spec or
1634 the saved custom spec;
1635 `face-defface-spec' means the default spec
1636 (usually set only via `defface');
1637 `reset' means to ignore SPEC, but clear the `customized-face'
1638 and `face-override-spec' specs;
1639 Any other value means not to set any spec, but to run the
1640 function for its other effects."
1641 (if (get face
'face-alias
)
1642 (setq face
(get face
'face-alias
)))
1643 ;; Save SPEC to the relevant symbol property.
1645 (setq spec-type
'face-override-spec
))
1646 (if (memq spec-type
'(face-defface-spec face-override-spec
1647 customized-face saved-face
))
1648 (put face spec-type spec
))
1649 (if (memq spec-type
'(reset saved-face
))
1650 (put face
'customized-face nil
))
1651 ;; Setting the face spec via Custom empties out any override spec,
1652 ;; similar to how setting a variable via Custom changes its values.
1653 (if (memq spec-type
'(customized-face saved-face reset
))
1654 (put face
'face-override-spec nil
))
1655 ;; If we reset the face based on its custom spec, it is unmodified
1656 ;; as far as Custom is concerned.
1657 (unless (eq face
'face-override-spec
)
1658 (put face
'face-modified nil
))
1659 ;; Initialize the face if it does not exist, then recalculate.
1660 (make-empty-face face
)
1661 (dolist (frame (frame-list))
1662 (face-spec-recalc face frame
)))
1664 (defun face-spec-recalc (face frame
)
1665 "Reset the face attributes of FACE on FRAME according to its specs.
1666 The following sources are applied in this order:
1668 face reset to default values if it's the default face, otherwise set
1669 to unspecified (through `face-spec-reset-face')
1671 (theme and user customization)
1672 or: if none of the above exist, and none match the current frame or
1673 inherited from the defface spec instead of overwriting it
1674 entirely, the following is applied instead:
1675 (defface default spec)
1676 (X resources (if applicable))
1678 defface override spec"
1679 (while (get face
'face-alias
)
1680 (setq face
(get face
'face-alias
)))
1681 (face-spec-reset-face face frame
)
1682 ;; If FACE is customized or themed, set the custom spec from
1683 ;; `theme-face' records.
1684 (let ((theme-faces (get face
'theme-face
))
1686 spec theme-face-applied
)
1688 (dolist (elt (reverse theme-faces
))
1689 (setq spec
(face-spec-choose (cadr elt
) frame no-match-found
))
1690 (unless (eq spec no-match-found
)
1691 (face-spec-set-2 face frame spec
)
1692 (setq theme-face-applied t
))))
1693 ;; If there was a spec applicable to FRAME, that overrides the
1694 ;; defface spec entirely (rather than inheriting from it). If
1695 ;; there was no spec applicable to FRAME, apply the defface spec
1696 ;; as well as any applicable X resources.
1697 (unless theme-face-applied
1698 (setq spec
(face-spec-choose (face-default-spec face
) frame
))
1699 (face-spec-set-2 face frame spec
)
1700 (make-face-x-resource-internal face frame
))
1701 (setq spec
(face-spec-choose (get face
'face-override-spec
) frame
))
1702 (face-spec-set-2 face frame spec
)))
1704 (defun face-spec-set-2 (face frame spec
)
1705 "Set the face attributes of FACE on FRAME according to SPEC."
1708 (when (assq (car spec
) face-x-resources
)
1709 (push (car spec
) attrs
)
1710 (push (cadr spec
) attrs
))
1711 (setq spec
(cddr spec
)))
1712 (apply 'set-face-attribute face frame
(nreverse attrs
))))
1714 (defun face-attr-match-p (face attrs
&optional frame
)
1715 "Return t if attributes of FACE match values in plist ATTRS.
1716 Optional parameter FRAME is the frame whose definition of FACE
1717 is used. If nil or omitted, use the selected frame."
1719 (setq frame
(selected-frame)))
1720 (let* ((list face-attribute-name-alist
)
1722 (bold (and (plist-member attrs
:bold
)
1723 (not (plist-member attrs
:weight
))))
1724 (italic (and (plist-member attrs
:italic
)
1725 (not (plist-member attrs
:slant
))))
1726 (plist (if (or bold italic
)
1727 (copy-sequence attrs
)
1729 ;; Handle the Emacs 20 :bold and :italic properties.
1731 (plist-put plist
:weight
(if bold
'bold
'normal
)))
1733 (plist-put plist
:slant
(if italic
'italic
'normal
)))
1734 (while (and match list
)
1735 (let* ((attr (caar list
))
1737 (if (plist-member plist attr
)
1738 (plist-get plist attr
)
1740 (value-now (face-attribute face attr frame
)))
1741 (setq match
(equal specified-value value-now
))
1742 (setq list
(cdr list
))))
1745 (defsubst face-spec-match-p
(face spec
&optional frame
)
1746 "Return t if FACE, on FRAME, matches what SPEC says it should look like."
1747 (face-attr-match-p face
(face-spec-choose spec frame
) frame
))
1749 (defsubst face-default-spec
(face)
1750 "Return the default face-spec for FACE, ignoring any user customization.
1751 If there is no default for FACE, return nil."
1752 (get face
'face-defface-spec
))
1754 (defsubst face-user-default-spec
(face)
1755 "Return the user's customized face-spec for FACE, or the default if none.
1756 If there is neither a user setting nor a default for FACE, return nil."
1757 (or (get face
'customized-face
)
1758 (get face
'saved-face
)
1759 (face-default-spec face
)))
1762 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1763 ;;; Frame-type independent color support.
1764 ;;; We keep the old x-* names as aliases for back-compatibility.
1765 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1767 (defun defined-colors (&optional frame
)
1768 "Return a list of colors supported for a particular frame.
1769 The argument FRAME specifies which frame to try.
1770 The value may be different for frames on different display types.
1771 If FRAME doesn't support colors, the value is nil.
1772 If FRAME is nil, that stands for the selected frame."
1773 (if (memq (framep (or frame
(selected-frame))) '(x w32 ns
))
1774 (xw-defined-colors frame
)
1775 (mapcar 'car
(tty-color-alist frame
))))
1776 (defalias 'x-defined-colors
'defined-colors
)
1778 (declare-function xw-color-defined-p
"xfns.c" (color &optional frame
))
1780 (defun color-defined-p (color &optional frame
)
1781 "Return non-nil if COLOR is supported on frame FRAME.
1782 COLOR should be a string naming a color (e.g. \"white\"), or a
1783 string specifying a color's RGB components (e.g. \"#ff12ec\"), or
1784 the symbol `unspecified'.
1786 This function returns nil if COLOR is the symbol `unspecified',
1787 or one of the strings \"unspecified-fg\" or \"unspecified-bg\".
1789 If FRAME is omitted or nil, use the selected frame."
1790 (unless (member color
'(unspecified "unspecified-bg" "unspecified-fg"))
1791 (if (member (framep (or frame
(selected-frame))) '(x w32 ns
))
1792 (xw-color-defined-p color frame
)
1793 (numberp (tty-color-translate color frame
)))))
1794 (defalias 'x-color-defined-p
'color-defined-p
)
1796 (declare-function xw-color-values
"xfns.c" (color &optional frame
))
1798 (defun color-values (color &optional frame
)
1799 "Return a description of the color named COLOR on frame FRAME.
1800 COLOR should be a string naming a color (e.g. \"white\"), or a
1801 string specifying a color's RGB components (e.g. \"#ff12ec\").
1803 Return a list of three integers, (RED GREEN BLUE), each between 0
1804 and either 65280 or 65535 (the maximum depends on the system).
1805 Use `color-name-to-rgb' if you want RGB floating-point values
1808 If FRAME is omitted or nil, use the selected frame.
1809 If FRAME cannot display COLOR, the value is nil.
1811 COLOR can also be the symbol `unspecified' or one of the strings
1812 \"unspecified-fg\" or \"unspecified-bg\", in which case the
1813 return value is nil."
1815 ((member color
'(unspecified "unspecified-fg" "unspecified-bg"))
1817 ((memq (framep (or frame
(selected-frame))) '(x w32 ns
))
1818 (xw-color-values color frame
))
1820 (tty-color-values color frame
))))
1822 (defalias 'x-color-values
'color-values
)
1824 (declare-function xw-display-color-p
"xfns.c" (&optional terminal
))
1826 (defun display-color-p (&optional display
)
1827 "Return t if DISPLAY supports color.
1828 The optional argument DISPLAY specifies which display to ask about.
1829 DISPLAY should be either a frame or a display name (a string).
1830 If omitted or nil, that stands for the selected frame's display."
1831 (if (memq (framep-on-display display
) '(x w32 ns
))
1832 (xw-display-color-p display
)
1833 (tty-display-color-p display
)))
1834 (defalias 'x-display-color-p
'display-color-p
)
1836 (declare-function x-display-grayscale-p
"xfns.c" (&optional terminal
))
1838 (defun display-grayscale-p (&optional display
)
1839 "Return non-nil if frames on DISPLAY can display shades of gray.
1840 DISPLAY should be either a frame or a display name (a string).
1841 If omitted or nil, that stands for the selected frame's display."
1842 (let ((frame-type (framep-on-display display
)))
1844 ((memq frame-type
'(x w32 ns
))
1845 (x-display-grayscale-p display
))
1847 (> (tty-color-gray-shades display
) 2)))))
1849 (defun read-color (&optional prompt convert-to-RGB allow-empty-name msg
)
1850 "Read a color name or RGB triplet.
1851 Completion is available for color names, but not for RGB triplets.
1853 RGB triplets have the form \"#RRGGBB\". Each of the R, G, and B
1854 components can have one to four digits, but all three components
1855 must have the same number of digits. Each digit is a hex value
1856 between 0 and F; either upper case or lower case for A through F
1859 In addition to standard color names and RGB hex values, the
1860 following are available as color candidates. In each case, the
1861 corresponding color is used.
1863 * `foreground at point' - foreground under the cursor
1864 * `background at point' - background under the cursor
1866 Optional arg PROMPT is the prompt; if nil, use a default prompt.
1868 Interactively, or with optional arg CONVERT-TO-RGB-P non-nil,
1869 convert an input color name to an RGB hex string. Return the RGB
1872 If optional arg ALLOW-EMPTY-NAME is non-nil, the user is allowed
1873 to enter an empty color name (the empty string).
1875 Interactively, or with optional arg MSG non-nil, print the
1876 resulting color name in the echo area."
1877 (interactive "i\np\ni\np") ; Always convert to RGB interactively.
1878 (let* ((completion-ignore-case t
)
1879 (colors (or facemenu-color-alist
1880 (append '("foreground at point" "background at point")
1881 (if allow-empty-name
'(""))
1883 (color (completing-read
1884 (or prompt
"Color (name or #RGB triplet): ")
1885 ;; Completing function for reading colors, accepting
1886 ;; both color names and RGB triplets.
1887 (lambda (string pred flag
)
1889 ((null flag
) ; Try completion.
1890 (or (try-completion string colors pred
)
1891 (if (color-defined-p string
)
1893 ((eq flag t
) ; List all completions.
1894 (or (all-completions string colors pred
)
1895 (if (color-defined-p string
)
1897 ((eq flag
'lambda
) ; Test completion.
1898 (or (member string colors
)
1899 (color-defined-p string
)))))
1902 ;; Process named colors.
1903 (when (member color colors
)
1904 (cond ((string-equal color
"foreground at point")
1905 (setq color
(foreground-color-at-point)))
1906 ((string-equal color
"background at point")
1907 (setq color
(background-color-at-point))))
1908 (when (and convert-to-RGB
1909 (not (string-equal color
"")))
1910 (let ((components (x-color-values color
)))
1911 (unless (string-match-p "^#\\(?:[a-fA-F0-9][a-fA-F0-9][a-fA-F0-9]\\)+$" color
)
1912 (setq color
(format "#%04X%04X%04X"
1913 (logand 65535 (nth 0 components
))
1914 (logand 65535 (nth 1 components
))
1915 (logand 65535 (nth 2 components
))))))))
1916 (when msg
(message "Color: `%s'" color
))
1919 (defun face-at-point (&optional thing multiple
)
1920 "Return the face of the character after point.
1921 If it has more than one face, return the first one.
1922 If THING is non-nil try first to get a face name from the buffer.
1923 IF MULTIPLE is non-nil, return a list of all faces.
1924 Return nil if there is no face."
1927 ;; Try to get a face name from the buffer.
1928 (let ((face (intern-soft (thing-at-point 'symbol
))))
1930 (push face faces
))))
1931 ;; Add the named faces that the `read-face-name' or `face' property uses.
1932 (let ((faceprop (or (get-char-property (point) 'read-face-name
)
1933 (get-char-property (point) 'face
))))
1934 (cond ((facep faceprop
)
1935 (push faceprop faces
))
1936 ((face-list-p faceprop
)
1937 (dolist (face faceprop
)
1939 (push face faces
))))))
1940 (setq faces
(delete-dups (nreverse faces
)))
1941 (if multiple faces
(car faces
))))
1943 (defun foreground-color-at-point ()
1944 "Return the foreground color of the character after point."
1945 ;; `face-at-point' alone is not sufficient. It only gets named faces.
1946 ;; Need also pick up any face properties that are not associated with named faces.
1947 (let ((face (or (face-at-point)
1948 (get-char-property (point) 'read-face-name
)
1949 (get-char-property (point) 'face
))))
1950 (cond ((and face
(symbolp face
))
1951 (let ((value (face-foreground face nil
'default
)))
1952 (if (member value
'("unspecified-fg" "unspecified-bg"))
1956 (cond ((memq 'foreground-color face
) (cdr (memq 'foreground-color face
)))
1957 ((memq ':foreground face
) (cadr (memq ':foreground face
)))))
1958 (t nil
)))) ; Invalid face value.
1960 (defun background-color-at-point ()
1961 "Return the background color of the character after point."
1962 ;; `face-at-point' alone is not sufficient. It only gets named faces.
1963 ;; Need also pick up any face properties that are not associated with named faces.
1964 (let ((face (or (face-at-point)
1965 (get-char-property (point) 'read-face-name
)
1966 (get-char-property (point) 'face
))))
1967 (cond ((and face
(symbolp face
))
1968 (let ((value (face-background face nil
'default
)))
1969 (if (member value
'("unspecified-fg" "unspecified-bg"))
1973 (cond ((memq 'background-color face
) (cdr (memq 'background-color face
)))
1974 ((memq ':background face
) (cadr (memq ':background face
)))))
1975 (t nil
)))) ; Invalid face value.
1978 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1980 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1982 (declare-function x-display-list
"xfns.c" ())
1983 (declare-function x-open-connection
"xfns.c"
1984 (display &optional xrm-string must-succeed
))
1985 (declare-function x-get-resource
"frame.c"
1986 (attribute class
&optional component subclass
))
1987 (declare-function x-parse-geometry
"frame.c" (string))
1988 (defvar x-display-name
)
1990 (defun x-handle-named-frame-geometry (parameters)
1991 "Add geometry parameters for a named frame to parameter list PARAMETERS.
1992 Value is the new parameter list."
1993 ;; Note that `x-resource-name' has a global meaning.
1994 (let ((x-resource-name (cdr (assq 'name parameters
))))
1995 (when x-resource-name
1996 ;; Before checking X resources, we must have an X connection.
1999 (x-open-connection (or (cdr (assq 'display parameters
))
2001 (let (res-geometry parsed
)
2002 (and (setq res-geometry
(x-get-resource "geometry" "Geometry"))
2003 (setq parsed
(x-parse-geometry res-geometry
))
2005 (append parameters parsed
2006 ;; If the resource specifies a position,
2007 ;; take note of that.
2008 (if (or (assq 'top parsed
) (assq 'left parsed
))
2009 '((user-position . t
) (user-size . t
)))))))))
2013 (defun x-handle-reverse-video (frame parameters
)
2014 "Handle the reverse-video frame parameter and X resource.
2015 `x-create-frame' does not handle this one."
2016 (when (cdr (or (assq 'reverse parameters
)
2017 (let ((resource (x-get-resource "reverseVideo"
2020 (cons nil
(member (downcase resource
)
2021 '("on" "true")))))))
2022 (let* ((params (frame-parameters frame
))
2023 (bg (cdr (assq 'foreground-color params
)))
2024 (fg (cdr (assq 'background-color params
))))
2025 (modify-frame-parameters frame
2026 (list (cons 'foreground-color fg
)
2027 (cons 'background-color bg
)))
2028 (if (equal bg
(cdr (assq 'border-color params
)))
2029 (modify-frame-parameters frame
2030 (list (cons 'border-color fg
))))
2031 (if (equal bg
(cdr (assq 'mouse-color params
)))
2032 (modify-frame-parameters frame
2033 (list (cons 'mouse-color fg
))))
2034 (if (equal bg
(cdr (assq 'cursor-color params
)))
2035 (modify-frame-parameters frame
2036 (list (cons 'cursor-color fg
)))))))
2038 (declare-function x-create-frame
"xfns.c" (parms))
2039 (declare-function x-setup-function-keys
"term/common-win" (frame))
2041 (defun x-create-frame-with-faces (&optional parameters
)
2042 "Create and return a frame with frame parameters PARAMETERS.
2043 If PARAMETERS specify a frame name, handle X geometry resources
2044 for that name. If PARAMETERS includes a `reverse' parameter, or
2045 the X resource \"reverseVideo\" is present, handle that."
2046 (setq parameters
(x-handle-named-frame-geometry parameters
))
2047 (let* ((params (copy-tree parameters
))
2048 (visibility-spec (assq 'visibility parameters
))
2049 (delayed-params '(foreground-color background-color font
2050 border-color cursor-color mouse-color
2051 visibility scroll-bar-foreground
2052 scroll-bar-background
))
2054 (dolist (param delayed-params
)
2055 (setq params
(assq-delete-all param params
)))
2056 (setq frame
(x-create-frame `((visibility . nil
) .
,params
)))
2059 (x-setup-function-keys frame
)
2060 (x-handle-reverse-video frame parameters
)
2061 (frame-set-background-mode frame t
)
2062 (face-set-after-frame-default frame parameters
)
2063 (if (null visibility-spec
)
2064 (make-frame-visible frame
)
2065 (modify-frame-parameters frame
(list visibility-spec
)))
2068 (delete-frame frame
)))
2071 (defun face-set-after-frame-default (frame &optional parameters
)
2072 "Initialize the frame-local faces of FRAME.
2073 Calculate the face definitions using the face specs, custom theme
2074 settings, X resources, and `face-new-frame-defaults'.
2075 Finally, apply any relevant face attributes found amongst the
2076 frame parameters in PARAMETERS."
2077 ;; The `reverse' is so that `default' goes first.
2078 (dolist (face (nreverse (face-list)))
2081 ;; Initialize faces from face spec and custom theme.
2082 (face-spec-recalc face frame
)
2083 ;; Apply attributes specified by face-new-frame-defaults
2084 (internal-merge-in-global-face face frame
))
2085 ;; Don't let invalid specs prevent frame creation.
2088 ;; Apply attributes specified by frame parameters.
2089 (let ((face-params '((foreground-color default
:foreground
)
2090 (background-color default
:background
)
2091 (font default
:font
)
2092 (border-color border
:background
)
2093 (cursor-color cursor
:background
)
2094 (scroll-bar-foreground scroll-bar
:foreground
)
2095 (scroll-bar-background scroll-bar
:background
)
2096 (mouse-color mouse
:background
))))
2097 (dolist (param face-params
)
2098 (let* ((param-name (nth 0 param
))
2099 (value (cdr (assq param-name parameters
))))
2101 (set-face-attribute (nth 1 param
) frame
2102 (nth 2 param
) value
))))))
2104 (defun tty-handle-reverse-video (frame parameters
)
2105 "Handle the reverse-video frame parameter for terminal frames."
2106 (when (cdr (assq 'reverse parameters
))
2107 (let* ((params (frame-parameters frame
))
2108 (bg (cdr (assq 'foreground-color params
)))
2109 (fg (cdr (assq 'background-color params
))))
2110 (modify-frame-parameters frame
2111 (list (cons 'foreground-color fg
)
2112 (cons 'background-color bg
)))
2113 (if (equal bg
(cdr (assq 'mouse-color params
)))
2114 (modify-frame-parameters frame
2115 (list (cons 'mouse-color fg
))))
2116 (if (equal bg
(cdr (assq 'cursor-color params
)))
2117 (modify-frame-parameters frame
2118 (list (cons 'cursor-color fg
)))))))
2121 (defun tty-create-frame-with-faces (&optional parameters
)
2122 "Create and return a frame from optional frame parameters PARAMETERS.
2123 If PARAMETERS contains a `reverse' parameter, handle that."
2124 (let ((frame (make-terminal-frame parameters
))
2127 (with-selected-frame frame
2128 (tty-handle-reverse-video frame
(frame-parameters frame
))
2130 (unless (terminal-parameter frame
'terminal-initted
)
2131 (set-terminal-parameter frame
'terminal-initted t
)
2132 (set-locale-environment nil frame
)
2133 (tty-run-terminal-initialization frame nil t
))
2134 (frame-set-background-mode frame t
)
2135 (face-set-after-frame-default frame parameters
)
2138 (delete-frame frame
)))
2141 (defun tty-find-type (pred type
)
2142 "Return the longest prefix of TYPE to which PRED returns non-nil.
2143 TYPE should be a tty type name such as \"xterm-16color\".
2145 The function tries only those prefixes that are followed by a
2146 dash or underscore in the original type name, like \"xterm\" in
2150 (not (funcall pred type
)))
2151 ;; Strip off last hyphen and what follows, then try again
2153 (if (setq hyphend
(string-match-p "[-_][^-_]+$" type
))
2154 (substring type
0 hyphend
)
2158 (defvar tty-setup-hook nil
2159 "Hook run after running the initialization function of a new text terminal.
2160 Specifically, `tty-run-terminal-initialization' runs this.
2161 This can be used to fine tune the `input-decode-map', for example.")
2163 (defun tty-run-terminal-initialization (frame &optional type run-hook
)
2164 "Run the special initialization code for the terminal type of FRAME.
2165 The optional TYPE parameter may be used to override the autodetected
2166 terminal type to a different value.
2168 This consults `term-file-aliases' to map terminal types to their aliases.
2170 If optional argument RUN-HOOK is non-nil, then as a final step,
2171 this runs the hook `tty-setup-hook'.
2173 If you set `term-file-prefix' to nil, this function does nothing."
2174 (setq type
(or type
(tty-type frame
)))
2175 (let ((alias (tty-find-type
2176 (lambda (typ) (assoc typ term-file-aliases
)) type
)))
2177 (if alias
(setq type
(cdr (assoc alias term-file-aliases
)))))
2178 ;; Load library for our terminal type.
2179 ;; User init file can set term-file-prefix to nil to prevent this.
2180 (with-selected-frame frame
2181 (unless (null term-file-prefix
)
2182 (let* (term-init-func)
2183 ;; First, load the terminal initialization file, if it is
2184 ;; available and it hasn't been loaded already.
2185 (tty-find-type #'(lambda (type)
2186 (let ((file (locate-library (concat term-file-prefix type
))))
2188 (or (assoc file load-history
)
2191 ;; Next, try to find a matching initialization function, and call it.
2192 (tty-find-type #'(lambda (type)
2193 (fboundp (setq term-init-func
2194 (intern (concat "terminal-init-" type
)))))
2196 (when (fboundp term-init-func
)
2197 (funcall term-init-func
))
2198 (set-terminal-parameter frame
'terminal-initted term-init-func
)
2199 (if run-hook
(run-hooks 'tty-setup-hook
))))))
2201 ;; Called from C function init_display to initialize faces of the
2202 ;; dumped terminal frame on startup.
2204 (defun tty-set-up-initial-frame-faces ()
2205 (let ((frame (selected-frame)))
2206 (frame-set-background-mode frame t
)
2207 (face-set-after-frame-default frame
)))
2210 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2212 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2214 (defgroup basic-faces nil
2215 "The standard faces of Emacs."
2219 '((t nil
)) ; If this were nil, face-defface-spec would not be set.
2220 "Basic default face."
2221 :group
'basic-faces
)
2226 :group
'basic-faces
)
2229 '((((supports :slant italic
))
2231 (((supports :underline t
))
2234 ;; Default to italic, even if it doesn't appear to be supported,
2235 ;; because in some cases the display engine will do its own
2236 ;; workaround (to `dim' on ttys).
2238 "Basic italic face."
2239 :group
'basic-faces
)
2241 (defface bold-italic
2242 '((t :weight bold
:slant italic
))
2243 "Basic bold-italic face."
2244 :group
'basic-faces
)
2247 '((((supports :underline t
))
2249 (((supports :weight bold
))
2252 "Basic underlined face."
2253 :group
'basic-faces
)
2255 (defface fixed-pitch
2256 '((t :family
"Monospace"))
2257 "The basic fixed-pitch face."
2258 :group
'basic-faces
)
2260 (defface variable-pitch
2261 '((t :family
"Sans Serif"))
2262 "The basic variable-pitch face."
2263 :group
'basic-faces
)
2266 '((((class color grayscale
) (min-colors 88) (background light
))
2267 :foreground
"grey50")
2268 (((class color grayscale
) (min-colors 88) (background dark
))
2269 :foreground
"grey70")
2270 (((class color
) (min-colors 8) (background light
))
2271 :foreground
"green")
2272 (((class color
) (min-colors 8) (background dark
))
2273 :foreground
"yellow"))
2274 "Basic face for shadowed text."
2279 '((((class color
) (min-colors 88) (background light
))
2280 :foreground
"RoyalBlue3" :underline t
)
2281 (((class color
) (background light
))
2282 :foreground
"blue" :underline t
)
2283 (((class color
) (min-colors 88) (background dark
))
2284 :foreground
"cyan1" :underline t
)
2285 (((class color
) (background dark
))
2286 :foreground
"cyan" :underline t
)
2287 (t :inherit underline
))
2288 "Basic face for unvisited links."
2292 (defface link-visited
2293 '((default :inherit link
)
2294 (((class color
) (background light
)) :foreground
"magenta4")
2295 (((class color
) (background dark
)) :foreground
"violet"))
2296 "Basic face for visited links."
2301 '((((class color
) (min-colors 88) (background light
))
2302 :background
"darkseagreen2")
2303 (((class color
) (min-colors 88) (background dark
))
2304 :background
"darkolivegreen")
2305 (((class color
) (min-colors 16) (background light
))
2306 :background
"darkseagreen2")
2307 (((class color
) (min-colors 16) (background dark
))
2308 :background
"darkolivegreen")
2309 (((class color
) (min-colors 8))
2310 :background
"green" :foreground
"black")
2311 (t :inverse-video t
))
2312 "Basic face for highlighting."
2313 :group
'basic-faces
)
2315 ;; Region face: under NS, default to the system-defined selection
2316 ;; color (optimized for the fixed white background of other apps),
2317 ;; if background is light.
2319 '((((class color
) (min-colors 88) (background dark
))
2320 :background
"blue3")
2321 (((class color
) (min-colors 88) (background light
) (type gtk
))
2322 :distant-foreground
"gtk_selection_fg_color"
2323 :background
"gtk_selection_bg_color")
2324 (((class color
) (min-colors 88) (background light
) (type ns
))
2325 :distant-foreground
"ns_selection_fg_color"
2326 :background
"ns_selection_bg_color")
2327 (((class color
) (min-colors 88) (background light
))
2328 :background
"lightgoldenrod2")
2329 (((class color
) (min-colors 16) (background dark
))
2330 :background
"blue3")
2331 (((class color
) (min-colors 16) (background light
))
2332 :background
"lightgoldenrod2")
2333 (((class color
) (min-colors 8))
2334 :background
"blue" :foreground
"white")
2335 (((type tty
) (class mono
))
2337 (t :background
"gray"))
2338 "Basic face for highlighting the region."
2340 :group
'basic-faces
)
2342 (defface secondary-selection
2343 '((((class color
) (min-colors 88) (background light
))
2344 :background
"yellow1")
2345 (((class color
) (min-colors 88) (background dark
))
2346 :background
"SkyBlue4")
2347 (((class color
) (min-colors 16) (background light
))
2348 :background
"yellow")
2349 (((class color
) (min-colors 16) (background dark
))
2350 :background
"SkyBlue4")
2351 (((class color
) (min-colors 8))
2352 :background
"cyan" :foreground
"black")
2353 (t :inverse-video t
))
2354 "Basic face for displaying the secondary selection."
2355 :group
'basic-faces
)
2357 (defface trailing-whitespace
2358 '((((class color
) (background light
))
2360 (((class color
) (background dark
))
2362 (t :inverse-video t
))
2363 "Basic face for highlighting trailing whitespace."
2365 :group
'basic-faces
)
2367 (defface escape-glyph
2368 '((((background dark
)) :foreground
"cyan")
2369 ;; See the comment in minibuffer-prompt for
2370 ;; the reason not to use blue on MS-DOS.
2371 (((type pc
)) :foreground
"magenta")
2372 ;; red4 is too dark, but some say blue is too loud.
2373 ;; brown seems to work ok. -- rms.
2374 (t :foreground
"brown"))
2375 "Face for characters displayed as sequences using `^' or `\\'."
2379 (defface nobreak-space
2380 '((((class color
) (min-colors 88)) :inherit escape-glyph
:underline t
)
2381 (((class color
) (min-colors 8)) :background
"magenta")
2382 (t :inverse-video t
))
2383 "Face for displaying nobreak space."
2387 (defgroup mode-line-faces nil
2388 "Faces used in the mode line."
2394 '((((class color
) (min-colors 88))
2395 :box
(:line-width -
1 :style released-button
)
2396 :background
"grey75" :foreground
"black")
2399 "Basic mode line face for selected window."
2401 :group
'mode-line-faces
2402 :group
'basic-faces
)
2404 (defface mode-line-inactive
2407 (((class color
) (min-colors 88) (background light
))
2409 :box
(:line-width -
1 :color
"grey75" :style nil
)
2410 :foreground
"grey20" :background
"grey90")
2411 (((class color
) (min-colors 88) (background dark
) )
2413 :box
(:line-width -
1 :color
"grey40" :style nil
)
2414 :foreground
"grey80" :background
"grey30"))
2415 "Basic mode line face for non-selected windows."
2417 :group
'mode-line-faces
2418 :group
'basic-faces
)
2419 (define-obsolete-face-alias 'modeline-inactive
'mode-line-inactive
"22.1")
2421 (defface mode-line-highlight
2422 '((((class color
) (min-colors 88))
2423 :box
(:line-width
2 :color
"grey40" :style released-button
))
2425 :inherit highlight
))
2426 "Basic mode line face for highlighting."
2428 :group
'mode-line-faces
2429 :group
'basic-faces
)
2430 (define-obsolete-face-alias 'modeline-highlight
'mode-line-highlight
"22.1")
2432 (defface mode-line-emphasis
2433 '((t (:weight bold
)))
2434 "Face used to emphasize certain mode line features.
2435 Use the face `mode-line-highlight' for features that can be selected."
2437 :group
'mode-line-faces
2438 :group
'basic-faces
)
2440 (defface mode-line-buffer-id
2441 '((t (:weight bold
)))
2442 "Face used for buffer identification parts of the mode line."
2444 :group
'mode-line-faces
2445 :group
'basic-faces
)
2446 (define-obsolete-face-alias 'modeline-buffer-id
'mode-line-buffer-id
"22.1")
2448 (defface header-line
2452 ;; This used to be `:inverse-video t', but that doesn't look very
2453 ;; good when combined with inverse-video mode-lines and multiple
2454 ;; windows. Underlining looks better, and is more consistent with
2455 ;; the window-system face variants, which deemphasize the
2456 ;; header-line in relation to the mode-line face. If a terminal
2457 ;; can't underline, then the header-line will end up without any
2458 ;; highlighting; this may be too confusing in general, although it
2459 ;; happens to look good with the only current use of header-lines,
2460 ;; the info browser. XXX
2461 :inverse-video nil
;Override the value inherited from mode-line.
2463 (((class color grayscale
) (background light
))
2464 :background
"grey90" :foreground
"grey20"
2466 (((class color grayscale
) (background dark
))
2467 :background
"grey20" :foreground
"grey90"
2469 (((class mono
) (background light
))
2470 :background
"white" :foreground
"black"
2474 (((class mono
) (background dark
))
2475 :background
"black" :foreground
"white"
2479 "Basic header-line face."
2481 :group
'basic-faces
)
2483 (defface vertical-border
2484 '((((type tty
)) :inherit mode-line-inactive
))
2485 "Face used for vertical window dividers on ttys."
2487 :group
'basic-faces
)
2489 (defface window-divider
'((t :foreground
"gray60"))
2490 "Basic face for window dividers.
2491 When a divider is less than 3 pixels wide, it is drawn solidly
2492 with the foreground of this face. For larger dividers this face
2493 is used for the inner part while the first pixel line/column is
2494 drawn with the `window-divider-first-pixel' face and the last
2495 pixel line/column with the `window-divider-last-pixel' face."
2498 :group
'basic-faces
)
2500 (defface window-divider-first-pixel
2501 '((t :foreground
"gray80"))
2502 "Basic face for first pixel line/column of window dividers.
2503 When a divider is at least 3 pixels wide, its first pixel
2504 line/column is drawn with the foreground of this face. If you do
2505 not want to accentuate the first pixel line/column, set this to
2506 the same as `window-divider' face."
2509 :group
'basic-faces
)
2511 (defface window-divider-last-pixel
2512 '((t :foreground
"gray40"))
2513 "Basic face for last pixel line/column of window dividers.
2514 When a divider is at least 3 pixels wide, its last pixel
2515 line/column is drawn with the foreground of this face. If you do
2516 not want to accentuate the last pixel line/column, set this to
2517 the same as `window-divider' face."
2520 :group
'basic-faces
)
2522 (defface minibuffer-prompt
2523 '((((background dark
)) :foreground
"cyan")
2524 ;; Don't use blue because many users of the MS-DOS port customize
2525 ;; their foreground color to be blue.
2526 (((type pc
)) :foreground
"magenta")
2527 (t :foreground
"medium blue"))
2528 "Face for minibuffer prompts.
2529 By default, Emacs automatically adds this face to the value of
2530 `minibuffer-prompt-properties', which is a list of text properties
2531 used to display the prompt text."
2533 :group
'basic-faces
)
2535 (setq minibuffer-prompt-properties
2536 (append minibuffer-prompt-properties
(list 'face
'minibuffer-prompt
)))
2539 '((((class color
) (background light
))
2540 :background
"grey95")
2541 (((class color
) (background dark
))
2542 :background
"grey10")
2544 :background
"gray"))
2545 "Basic face for the fringes to the left and right of windows under X."
2548 :group
'basic-faces
)
2550 (defface scroll-bar
'((t nil
))
2551 "Basic face for the scroll bar colors under X."
2554 :group
'basic-faces
)
2556 (defface border
'((t nil
))
2557 "Basic face for the frame border under X."
2560 :group
'basic-faces
)
2563 '((((background light
)) :background
"black")
2564 (((background dark
)) :background
"white"))
2565 "Basic face for the cursor color under X.
2566 Currently, only the `:background' attribute is meaningful; all
2567 other attributes are ignored. The cursor foreground color is
2568 taken from the background color of the underlying text.
2570 Note: Other faces cannot inherit from the cursor face."
2573 :group
'basic-faces
)
2575 (put 'cursor
'face-no-inherit t
)
2577 (defface mouse
'((t nil
))
2578 "Basic face for the mouse color under X."
2581 :group
'basic-faces
)
2585 :box
(:line-width
1 :style released-button
)
2586 :foreground
"black")
2587 (((type x w32 ns
) (class color
))
2588 :background
"grey75")
2589 (((type x
) (class mono
))
2590 :background
"grey"))
2591 "Basic tool-bar face."
2593 :group
'basic-faces
)
2602 "Basic face for the font and colors of the menu bar and popup menus."
2605 :group
'basic-faces
)
2607 (defface help-argument-name
'((t :inherit italic
))
2608 "Face to highlight argument names in *Help* buffers."
2611 (defface glyphless-char
2612 '((((type tty
)) :inherit underline
)
2613 (((type pc
)) :inherit escape-glyph
)
2615 "Face for displaying non-graphic characters (e.g. U+202A (LRE)).
2616 It is used for characters of no fonts too."
2618 :group
'basic-faces
)
2621 '((default :weight bold
)
2622 (((class color
) (min-colors 88) (background light
)) :foreground
"Red1")
2623 (((class color
) (min-colors 88) (background dark
)) :foreground
"Pink")
2624 (((class color
) (min-colors 16) (background light
)) :foreground
"Red1")
2625 (((class color
) (min-colors 16) (background dark
)) :foreground
"Pink")
2626 (((class color
) (min-colors 8)) :foreground
"red")
2627 (t :inverse-video t
))
2628 "Basic face used to highlight errors and to denote failure."
2630 :group
'basic-faces
)
2633 '((default :weight bold
)
2634 (((class color
) (min-colors 16)) :foreground
"DarkOrange")
2635 (((class color
)) :foreground
"yellow"))
2636 "Basic face used to highlight warnings."
2638 :group
'basic-faces
)
2641 '((default :weight bold
)
2642 (((class color
) (min-colors 16) (background light
)) :foreground
"ForestGreen")
2643 (((class color
) (min-colors 88) (background dark
)) :foreground
"Green1")
2644 (((class color
) (min-colors 16) (background dark
)) :foreground
"Green")
2645 (((class color
)) :foreground
"green"))
2646 "Basic face used to indicate successful operation."
2648 :group
'basic-faces
)
2650 ;; Faces for TTY menus.
2651 (defface tty-menu-enabled-face
2653 :foreground
"yellow" :background
"blue" :weight bold
))
2654 "Face for displaying enabled items in TTY menus."
2655 :group
'basic-faces
)
2657 (defface tty-menu-disabled-face
2658 '((((class color
) (min-colors 16))
2659 :foreground
"lightgray" :background
"blue")
2661 :foreground
"white" :background
"blue"))
2662 "Face for displaying disabled items in TTY menus."
2663 :group
'basic-faces
)
2665 (defface tty-menu-selected-face
2666 '((t :background
"red"))
2667 "Face for displaying the currently selected item in TTY menus."
2668 :group
'basic-faces
)
2670 (defgroup paren-showing-faces nil
2671 "Faces used to highlight paren matches."
2672 :group
'paren-showing
2676 (defface show-paren-match
2677 '((((class color
) (background light
))
2678 :background
"turquoise") ; looks OK on tty (becomes cyan)
2679 (((class color
) (background dark
))
2680 :background
"steelblue3") ; looks OK on tty (becomes blue)
2681 (((background dark
))
2682 :background
"grey50")
2684 :background
"gray"))
2685 "Face used for a matching paren."
2686 :group
'paren-showing-faces
)
2688 (defface show-paren-mismatch
2689 '((((class color
)) (:foreground
"white" :background
"purple"))
2690 (t (:inverse-video t
)))
2691 "Face used for a mismatching paren."
2692 :group
'paren-showing-faces
)
2695 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2696 ;;; Manipulating font names.
2697 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2699 ;; This is here for compatibility with Emacs 20.2. For example,
2700 ;; international/fontset.el uses x-resolve-font-name. The following
2701 ;; functions are not used in the face implementation itself.
2703 (defvar x-font-regexp nil
)
2704 (defvar x-font-regexp-head nil
)
2705 (defvar x-font-regexp-weight nil
)
2706 (defvar x-font-regexp-slant nil
)
2708 (defconst x-font-regexp-weight-subnum
1)
2709 (defconst x-font-regexp-slant-subnum
2)
2710 (defconst x-font-regexp-swidth-subnum
3)
2711 (defconst x-font-regexp-adstyle-subnum
4)
2713 ;;; Regexps matching font names in "Host Portable Character Representation."
2718 (weight "\\(bold\\|demibold\\|medium\\)") ; 1
2719 ; (weight\? "\\(\\*\\|bold\\|demibold\\|medium\\|\\)") ; 1
2720 (weight\? "\\([^-]*\\)") ; 1
2721 (slant "\\([ior]\\)") ; 2
2722 ; (slant\? "\\([ior?*]?\\)") ; 2
2723 (slant\? "\\([^-]?\\)") ; 2
2724 ; (swidth "\\(\\*\\|normal\\|semicondensed\\|\\)") ; 3
2725 (swidth "\\([^-]*\\)") ; 3
2726 ; (adstyle "\\(\\*\\|sans\\|\\)") ; 4
2727 (adstyle "\\([^-]*\\)") ; 4
2728 (pixelsize "[0-9]+")
2729 (pointsize "[0-9][0-9]+")
2730 (resx "[0-9][0-9]+")
2731 (resy "[0-9][0-9]+")
2738 (purecopy (concat "\\`\\*?[-?*]"
2739 foundry - family - weight
\? - slant
\? - swidth - adstyle -
2740 pixelsize - pointsize - resx - resy - spacing - avgwidth -
2741 registry - encoding
"\\*?\\'"
2743 (setq x-font-regexp-head
2744 (purecopy (concat "\\`[-?*]" foundry - family - weight
\? - slant
\?
2745 "\\([-*?]\\|\\'\\)")))
2746 (setq x-font-regexp-slant
(purecopy (concat - slant -
)))
2747 (setq x-font-regexp-weight
(purecopy (concat - weight -
)))
2751 (defun x-resolve-font-name (pattern &optional face frame
)
2752 "Return a font name matching PATTERN.
2753 All wildcards in PATTERN are instantiated.
2754 If PATTERN is nil, return the name of the frame's base font, which never
2756 Given optional arguments FACE and FRAME, return a font which is
2757 also the same size as FACE on FRAME, or fail."
2761 ;; Note that x-list-fonts has code to handle a face with nil as its font.
2762 (let ((fonts (x-list-fonts pattern face frame
1)))
2765 (if (string-match-p "\\*" pattern
)
2766 (if (null (face-font face
))
2767 (error "No matching fonts are the same height as the frame default font")
2768 (error "No matching fonts are the same height as face `%s'" face
))
2769 (if (null (face-font face
))
2770 (error "Height of font `%s' doesn't match the frame default font"
2772 (error "Height of font `%s' doesn't match face `%s'"
2774 (error "No fonts match `%s'" pattern
)))
2776 (cdr (assq 'font
(frame-parameters (selected-frame))))))
2778 (defcustom font-list-limit
100
2779 "This variable is obsolete and has no effect."
2782 (make-obsolete-variable 'font-list-limit nil
"24.3")
2786 ;;; faces.el ends here