* faces.el (color-defined-p): Doc fix.
[emacs.git] / lisp / faces.el
blob71e8a17f6efd88b3d724cc63a017b0c6eebaaf5e
1 ;;; faces.el --- Lisp faces
3 ;; Copyright (C) 1992-1996, 1998-2012 Free Software Foundation, Inc.
5 ;; Maintainer: FSF
6 ;; Keywords: internal
7 ;; Package: emacs
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/>.
24 ;;; Commentary:
26 ;;; Code:
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"))
36 :group 'terminals)
38 (declare-function xw-defined-colors "term/common-win" (&optional frame))
40 (defvar help-xref-stack-item)
42 (defvar face-name-history nil
43 "History list for some commands that read face names.
44 Maximum length of the history list is determined by the value
45 of `history-length', which see.")
48 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
49 ;;; Font selection.
50 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
52 (defgroup font-selection nil
53 "Influencing face font selection."
54 :group 'faces)
57 (defcustom face-font-selection-order
58 '(:width :height :weight :slant)
59 "A list specifying how face font selection chooses fonts.
60 Each of the four symbols `:width', `:height', `:weight', and `:slant'
61 must appear once in the list, and the list must not contain any other
62 elements. Font selection first tries to find a best matching font
63 for those face attributes that appear before in the list. For
64 example, if `:slant' appears before `:height', font selection first
65 tries to find a font with a suitable slant, even if this results in
66 a font height that isn't optimal."
67 :tag "Font selection order"
68 :type '(list symbol symbol symbol symbol)
69 :group 'font-selection
70 :set #'(lambda (symbol value)
71 (set-default symbol value)
72 (internal-set-font-selection-order value)))
75 ;; In the absence of Fontconfig support, Monospace and Sans Serif are
76 ;; unavailable, and we fall back on the courier and helv families,
77 ;; which are generally available.
78 (defcustom face-font-family-alternatives
79 (mapcar (lambda (arg) (mapcar 'purecopy arg))
80 '(("Monospace" "courier" "fixed")
81 ("courier" "CMU Typewriter Text" "fixed")
82 ("Sans Serif" "helv" "helvetica" "arial" "fixed")
83 ("helv" "helvetica" "arial" "fixed")))
84 "Alist of alternative font family names.
85 Each element has the form (FAMILY ALTERNATIVE1 ALTERNATIVE2 ...).
86 If fonts of family FAMILY can't be loaded, try ALTERNATIVE1, then
87 ALTERNATIVE2 etc."
88 :tag "Alternative font families to try"
89 :type '(repeat (repeat string))
90 :group 'font-selection
91 :set #'(lambda (symbol value)
92 (set-default symbol value)
93 (internal-set-alternative-font-family-alist value)))
96 ;; This is defined originally in xfaces.c.
97 (defcustom face-font-registry-alternatives
98 (mapcar (lambda (arg) (mapcar 'purecopy arg))
99 (if (featurep 'w32)
100 '(("iso8859-1" "ms-oemlatin")
101 ("gb2312.1980" "gb2312" "gbk" "gb18030")
102 ("jisx0208.1990" "jisx0208.1983" "jisx0208.1978")
103 ("ksc5601.1989" "ksx1001.1992" "ksc5601.1987")
104 ("muletibetan-2" "muletibetan-0"))
105 '(("gb2312.1980" "gb2312.80&gb8565.88" "gbk" "gb18030")
106 ("jisx0208.1990" "jisx0208.1983" "jisx0208.1978")
107 ("ksc5601.1989" "ksx1001.1992" "ksc5601.1987")
108 ("muletibetan-2" "muletibetan-0"))))
109 "Alist of alternative font registry names.
110 Each element has the form (REGISTRY ALTERNATIVE1 ALTERNATIVE2 ...).
111 If fonts of registry REGISTRY can be loaded, font selection
112 tries to find a best matching font among all fonts of registry
113 REGISTRY, ALTERNATIVE1, ALTERNATIVE2, and etc."
114 :tag "Alternative font registries to try"
115 :type '(repeat (repeat string))
116 :version "21.1"
117 :group 'font-selection
118 :set #'(lambda (symbol value)
119 (set-default symbol value)
120 (internal-set-alternative-font-registry-alist value)))
123 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
124 ;;; Creation, copying.
125 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
128 (defun face-list ()
129 "Return a list of all defined faces."
130 (mapcar #'car face-new-frame-defaults))
132 (defun make-face (face &optional no-init-from-resources)
133 "Define a new face with name FACE, a symbol.
134 Do not call this directly from Lisp code; use `defface' instead.
136 If NO-INIT-FROM-RESOURCES is non-nil, don't initialize face
137 attributes from X resources. If FACE is already known as a face,
138 leave it unmodified. Return FACE."
139 (interactive (list (read-from-minibuffer
140 "Make face: " nil nil t 'face-name-history)))
141 (unless (facep face)
142 ;; Make frame-local faces (this also makes the global one).
143 (dolist (frame (frame-list))
144 (internal-make-lisp-face face frame))
145 ;; Add the face to the face menu.
146 (when (fboundp 'facemenu-add-new-face)
147 (facemenu-add-new-face face))
148 ;; Define frame-local faces for all frames from X resources.
149 (unless no-init-from-resources
150 (make-face-x-resource-internal face)))
151 face)
153 (defun make-empty-face (face)
154 "Define a new, empty face with name FACE.
155 Do not call this directly from Lisp code; use `defface' instead."
156 (interactive (list (read-from-minibuffer
157 "Make empty face: " nil nil t 'face-name-history)))
158 (make-face face 'no-init-from-resources))
160 (defun copy-face (old-face new-face &optional frame new-frame)
161 "Define a face named NEW-FACE, which is a copy of OLD-FACE.
162 This function does not copy face customization data, so NEW-FACE
163 will not be made customizable. Most Lisp code should not call
164 this function; use `defface' with :inherit instead.
166 If NEW-FACE already exists as a face, modify it to be like
167 OLD-FACE. If NEW-FACE doesn't already exist, create it.
169 If the optional argument FRAME is a frame, change NEW-FACE on
170 FRAME only. If FRAME is t, copy the frame-independent default
171 specification for OLD-FACE to NEW-FACE. If FRAME is nil, copy
172 the defaults as well as the faces on each existing frame.
174 If the optional fourth argument NEW-FRAME is given, copy the
175 information from face OLD-FACE on frame FRAME to NEW-FACE on
176 frame NEW-FRAME. In this case, FRAME must not be nil."
177 (let ((inhibit-quit t))
178 (if (null frame)
179 (progn
180 (when new-frame
181 (error "Copying face %s from all frames to one frame"
182 old-face))
183 (make-empty-face new-face)
184 (dolist (frame (frame-list))
185 (copy-face old-face new-face frame))
186 (copy-face old-face new-face t))
187 (make-empty-face new-face)
188 (internal-copy-lisp-face old-face new-face frame new-frame))
189 new-face))
192 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
193 ;;; Predicates, type checks.
194 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
196 (defun facep (face)
197 "Return non-nil if FACE is a face name; nil otherwise.
198 A face name can be a string or a symbol."
199 (internal-lisp-face-p face))
202 (defun check-face (face)
203 "Signal an error if FACE doesn't name a face.
204 Value is FACE."
205 (unless (facep face)
206 (error "Not a face: %s" face))
207 face)
210 ;; The ID returned is not to be confused with the internally used IDs
211 ;; of realized faces. The ID assigned to Lisp faces is used to
212 ;; support faces in display table entries.
214 (defun face-id (face &optional _frame)
215 "Return the internal ID of face with name FACE.
216 If FACE is a face-alias, return the ID of the target face.
217 The optional argument FRAME is ignored, since the internal face ID
218 of a face name is the same for all frames."
219 (check-face face)
220 (or (get face 'face)
221 (face-id (get face 'face-alias))))
223 (defun face-equal (face1 face2 &optional frame)
224 "Non-nil if faces FACE1 and FACE2 are equal.
225 Faces are considered equal if all their attributes are equal.
226 If the optional argument FRAME is given, report on FACE1 and FACE2 in that frame.
227 If FRAME is t, report on the defaults for FACE1 and FACE2 (for new frames).
228 If FRAME is omitted or nil, use the selected frame."
229 (internal-lisp-face-equal-p face1 face2 frame))
232 (defun face-differs-from-default-p (face &optional frame)
233 "Return non-nil if FACE displays differently from the default face.
234 If the optional argument FRAME is given, report on face FACE in that frame.
235 If FRAME is t, report on the defaults for face FACE (for new frames).
236 If FRAME is omitted or nil, use the selected frame."
237 (let ((attrs
238 (delq :inherit (mapcar 'car face-attribute-name-alist)))
239 (differs nil))
240 (while (and attrs (not differs))
241 (let* ((attr (pop attrs))
242 (attr-val (face-attribute face attr frame t)))
243 (when (and
244 (not (eq attr-val 'unspecified))
245 (display-supports-face-attributes-p (list attr attr-val)
246 frame))
247 (setq differs attr))))
248 differs))
251 (defun face-nontrivial-p (face &optional frame)
252 "True if face FACE has some non-nil attribute.
253 If the optional argument FRAME is given, report on face FACE in that frame.
254 If FRAME is t, report on the defaults for face FACE (for new frames).
255 If FRAME is omitted or nil, use the selected frame."
256 (not (internal-lisp-face-empty-p face frame)))
260 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
261 ;;; Setting face attributes from X resources.
262 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
264 (defcustom face-x-resources
265 (mapcar
266 (lambda (arg)
267 ;; FIXME; can we purecopy some of the conses too?
268 (cons (car arg)
269 (cons (purecopy (car (cdr arg))) (purecopy (cdr (cdr arg))))))
270 '((:family (".attributeFamily" . "Face.AttributeFamily"))
271 (:foundry (".attributeFoundry" . "Face.AttributeFoundry"))
272 (:width (".attributeWidth" . "Face.AttributeWidth"))
273 (:height (".attributeHeight" . "Face.AttributeHeight"))
274 (:weight (".attributeWeight" . "Face.AttributeWeight"))
275 (:slant (".attributeSlant" . "Face.AttributeSlant"))
276 (:foreground (".attributeForeground" . "Face.AttributeForeground"))
277 (:background (".attributeBackground" . "Face.AttributeBackground"))
278 (:overline (".attributeOverline" . "Face.AttributeOverline"))
279 (:strike-through (".attributeStrikeThrough" . "Face.AttributeStrikeThrough"))
280 (:box (".attributeBox" . "Face.AttributeBox"))
281 (:underline (".attributeUnderline" . "Face.AttributeUnderline"))
282 (:inverse-video (".attributeInverse" . "Face.AttributeInverse"))
283 (:stipple
284 (".attributeStipple" . "Face.AttributeStipple")
285 (".attributeBackgroundPixmap" . "Face.AttributeBackgroundPixmap"))
286 (:bold (".attributeBold" . "Face.AttributeBold"))
287 (:italic (".attributeItalic" . "Face.AttributeItalic"))
288 (:font (".attributeFont" . "Face.AttributeFont"))
289 (:inherit (".attributeInherit" . "Face.AttributeInherit"))))
290 "List of X resources and classes for face attributes.
291 Each element has the form (ATTRIBUTE ENTRY1 ENTRY2...) where ATTRIBUTE is
292 the name of a face attribute, and each ENTRY is a cons of the form
293 \(RESOURCE . CLASS) with RESOURCE being the resource and CLASS being the
294 X resource class for the attribute."
295 :type '(repeat (cons symbol (repeat (cons string string))))
296 :group 'faces)
299 (declare-function internal-face-x-get-resource "xfaces.c"
300 (resource class frame))
302 (declare-function internal-set-lisp-face-attribute-from-resource "xfaces.c"
303 (face attr value &optional frame))
305 (defun set-face-attribute-from-resource (face attribute resource class frame)
306 "Set FACE's ATTRIBUTE from X resource RESOURCE, class CLASS on FRAME.
307 Value is the attribute value specified by the resource, or nil
308 if not present. This function displays a message if the resource
309 specifies an invalid attribute."
310 (let* ((face-name (face-name face))
311 (value (internal-face-x-get-resource (concat face-name resource)
312 class frame)))
313 (when value
314 (condition-case ()
315 (internal-set-lisp-face-attribute-from-resource
316 face attribute (downcase value) frame)
317 (error
318 (message "Face %s, frame %s: invalid attribute %s %s from X resource"
319 face-name frame attribute value))))
320 value))
323 (defun set-face-attributes-from-resources (face frame)
324 "Set attributes of FACE from X resources for FRAME."
325 (when (memq (framep frame) '(x w32))
326 (dolist (definition face-x-resources)
327 (let ((attribute (car definition)))
328 (dolist (entry (cdr definition))
329 (set-face-attribute-from-resource face attribute (car entry)
330 (cdr entry) frame))))))
333 (defun make-face-x-resource-internal (face &optional frame)
334 "Fill frame-local FACE on FRAME from X resources.
335 FRAME nil or not specified means do it for all frames."
336 (if (null frame)
337 (dolist (frame (frame-list))
338 (set-face-attributes-from-resources face frame))
339 (set-face-attributes-from-resources face frame)))
343 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
344 ;;; Retrieving face attributes.
345 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
347 (defun face-name (face)
348 "Return the name of face FACE."
349 (symbol-name (check-face face)))
352 (defun face-all-attributes (face &optional frame)
353 "Return an alist stating the attributes of FACE.
354 Each element of the result has the form (ATTR-NAME . ATTR-VALUE).
355 If FRAME is omitted or nil the value describes the default attributes,
356 but if you specify FRAME, the value describes the attributes
357 of FACE on FRAME."
358 (mapcar (lambda (pair)
359 (let ((attr (car pair)))
360 (cons attr (face-attribute face attr (or frame t)))))
361 face-attribute-name-alist))
363 (defun face-attribute (face attribute &optional frame inherit)
364 "Return the value of FACE's ATTRIBUTE on FRAME.
365 If the optional argument FRAME is given, report on face FACE in that frame.
366 If FRAME is t, report on the defaults for face FACE (for new frames).
367 If FRAME is omitted or nil, use the selected frame.
369 If INHERIT is nil, only attributes directly defined by FACE are considered,
370 so the return value may be `unspecified', or a relative value.
371 If INHERIT is non-nil, FACE's definition of ATTRIBUTE is merged with the
372 faces specified by its `:inherit' attribute; however the return value
373 may still be `unspecified' or relative.
374 If INHERIT is a face or a list of faces, then the result is further merged
375 with that face (or faces), until it becomes specified and absolute.
377 To ensure that the return value is always specified and absolute, use a
378 value of `default' for INHERIT; this will resolve any unspecified or
379 relative values by merging with the `default' face (which is always
380 completely specified)."
381 (let ((value (internal-get-lisp-face-attribute face attribute frame)))
382 (when (and inherit (face-attribute-relative-p attribute value))
383 ;; VALUE is relative, so merge with inherited faces
384 (let ((inh-from (face-attribute face :inherit frame)))
385 (unless (or (null inh-from) (eq inh-from 'unspecified))
386 (condition-case nil
387 (setq value
388 (face-attribute-merged-with attribute value inh-from frame))
389 ;; The `inherit' attribute may point to non existent faces.
390 (error nil)))))
391 (when (and inherit
392 (not (eq inherit t))
393 (face-attribute-relative-p attribute value))
394 ;; We should merge with INHERIT as well
395 (setq value (face-attribute-merged-with attribute value inherit frame)))
396 value))
398 (defun face-attribute-merged-with (attribute value faces &optional frame)
399 "Merges ATTRIBUTE, initially VALUE, with faces from FACES until absolute.
400 FACES may be either a single face or a list of faces.
401 \[This is an internal function.]"
402 (cond ((not (face-attribute-relative-p attribute value))
403 value)
404 ((null faces)
405 value)
406 ((consp faces)
407 (face-attribute-merged-with
408 attribute
409 (face-attribute-merged-with attribute value (car faces) frame)
410 (cdr faces)
411 frame))
413 (merge-face-attribute attribute
414 value
415 (face-attribute faces attribute frame t)))))
418 (defmacro face-attribute-specified-or (value &rest body)
419 "Return VALUE, unless it's `unspecified', in which case evaluate BODY and return the result."
420 (let ((temp (make-symbol "value")))
421 `(let ((,temp ,value))
422 (if (not (eq ,temp 'unspecified))
423 ,temp
424 ,@body))))
426 (defun face-foreground (face &optional frame inherit)
427 "Return the foreground color name of FACE, or nil if unspecified.
428 If the optional argument FRAME is given, report on face FACE in that frame.
429 If FRAME is t, report on the defaults for face FACE (for new frames).
430 If FRAME is omitted or nil, use the selected frame.
432 If INHERIT is nil, only a foreground color directly defined by FACE is
433 considered, so the return value may be nil.
434 If INHERIT is t, and FACE doesn't define a foreground color, then any
435 foreground color that FACE inherits through its `:inherit' attribute
436 is considered as well; however the return value may still be nil.
437 If INHERIT is a face or a list of faces, then it is used to try to
438 resolve an unspecified foreground color.
440 To ensure that a valid color is always returned, use a value of
441 `default' for INHERIT; this will resolve any unspecified values by
442 merging with the `default' face (which is always completely specified)."
443 (face-attribute-specified-or (face-attribute face :foreground frame inherit)
444 nil))
446 (defun face-background (face &optional frame inherit)
447 "Return the background color name of FACE, or nil if unspecified.
448 If the optional argument FRAME is given, report on face FACE in that frame.
449 If FRAME is t, report on the defaults for face FACE (for new frames).
450 If FRAME is omitted or nil, use the selected frame.
452 If INHERIT is nil, only a background color directly defined by FACE is
453 considered, so the return value may be nil.
454 If INHERIT is t, and FACE doesn't define a background color, then any
455 background color that FACE inherits through its `:inherit' attribute
456 is considered as well; however the return value may still be nil.
457 If INHERIT is a face or a list of faces, then it is used to try to
458 resolve an unspecified background color.
460 To ensure that a valid color is always returned, use a value of
461 `default' for INHERIT; this will resolve any unspecified values by
462 merging with the `default' face (which is always completely specified)."
463 (face-attribute-specified-or (face-attribute face :background frame inherit)
464 nil))
466 (defun face-stipple (face &optional frame inherit)
467 "Return the stipple pixmap name of FACE, or nil if unspecified.
468 If the optional argument FRAME is given, report on face FACE in that frame.
469 If FRAME is t, report on the defaults for face FACE (for new frames).
470 If FRAME is omitted or nil, use the selected frame.
472 If INHERIT is nil, only a stipple directly defined by FACE is
473 considered, so the return value may be nil.
474 If INHERIT is t, and FACE doesn't define a stipple, then any stipple
475 that FACE inherits through its `:inherit' attribute is considered as
476 well; however the return value may still be nil.
477 If INHERIT is a face or a list of faces, then it is used to try to
478 resolve an unspecified stipple.
480 To ensure that a valid stipple or nil is always returned, use a value of
481 `default' for INHERIT; this will resolve any unspecified values by merging
482 with the `default' face (which is always completely specified)."
483 (face-attribute-specified-or (face-attribute face :stipple frame inherit)
484 nil))
487 (defalias 'face-background-pixmap 'face-stipple)
490 ;; FIXME all of these -p functions ignore inheritance (cf face-stipple).
491 ;; Ie, a face that inherits from an underlined face but does not
492 ;; specify :underline will return nil.
493 ;; So these functions don't actually tell you anything about how the
494 ;; face will _appear_. So not very useful IMO.
495 (defun face-underline-p (face &optional frame)
496 "Return non-nil if FACE specifies a non-nil underlining.
497 If the optional argument FRAME is given, report on face FACE in that frame.
498 If FRAME is t, report on the defaults for face FACE (for new frames).
499 If FRAME is omitted or nil, use the selected frame."
500 (face-attribute-specified-or (face-attribute face :underline frame) nil))
503 (defun face-inverse-video-p (face &optional frame)
504 "Return non-nil if FACE specifies a non-nil inverse-video.
505 If the optional argument FRAME is given, report on face FACE in that frame.
506 If FRAME is t, report on the defaults for face FACE (for new frames).
507 If FRAME is omitted or nil, use the selected frame."
508 (eq (face-attribute face :inverse-video frame) t))
511 (defun face-bold-p (face &optional frame)
512 "Return non-nil if the font of FACE is bold on FRAME.
513 If the optional argument FRAME is given, report on face FACE in that frame.
514 If FRAME is t, report on the defaults for face FACE (for new frames).
515 If FRAME is omitted or nil, use the selected frame.
516 Use `face-attribute' for finer control."
517 (let ((bold (face-attribute face :weight frame)))
518 (memq bold '(semi-bold bold extra-bold ultra-bold))))
521 (defun face-italic-p (face &optional frame)
522 "Return non-nil if the font of FACE is italic on FRAME.
523 If the optional argument FRAME is given, report on face FACE in that frame.
524 If FRAME is t, report on the defaults for face FACE (for new frames).
525 If FRAME is omitted or nil, use the selected frame.
526 Use `face-attribute' for finer control."
527 (let ((italic (face-attribute face :slant frame)))
528 (memq italic '(italic oblique))))
532 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
533 ;;; Face documentation.
534 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
536 (defun face-documentation (face)
537 "Get the documentation string for FACE.
538 If FACE is a face-alias, get the documentation for the target face."
539 (let ((alias (get face 'face-alias))
540 doc)
541 (if alias
542 (progn
543 (setq doc (get alias 'face-documentation))
544 (format "%s is an alias for the face `%s'.%s" face alias
545 (if doc (format "\n%s" doc)
546 "")))
547 (get face 'face-documentation))))
550 (defun set-face-documentation (face string)
551 "Set the documentation string for FACE to STRING."
552 ;; Perhaps the text should go in DOC.
553 (put face 'face-documentation (purecopy string)))
556 (defalias 'face-doc-string 'face-documentation)
557 (defalias 'set-face-doc-string 'set-face-documentation)
561 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
562 ;; Setting face attributes.
563 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
566 (defun set-face-attribute (face frame &rest args)
567 "Set attributes of FACE on FRAME from ARGS.
568 This function overrides the face attributes specified by FACE's
569 face spec. It is mostly intended for internal use only.
571 If FRAME is nil, set the attributes for all existing frames, as
572 well as the default for new frames. If FRAME is t, change the
573 default for new frames only.
575 ARGS must come in pairs ATTRIBUTE VALUE. ATTRIBUTE must be a
576 valid face attribute name. All attributes can be set to
577 `unspecified'; this fact is not further mentioned below.
579 The following attributes are recognized:
581 `:family'
583 VALUE must be a string specifying the font family
584 \(e.g. \"Monospace\") or a fontset.
586 `:foundry'
588 VALUE must be a string specifying the font foundry,
589 e.g. ``adobe''. If a font foundry is specified, wild-cards `*'
590 and `?' are allowed.
592 `:width'
594 VALUE specifies the relative proportionate width of the font to use.
595 It must be one of the symbols `ultra-condensed', `extra-condensed',
596 `condensed', `semi-condensed', `normal', `semi-expanded', `expanded',
597 `extra-expanded', or `ultra-expanded'.
599 `:height'
601 VALUE specifies the relative or absolute height of the font. An
602 absolute height is an integer, and specifies font height in units
603 of 1/10 pt. A relative height is either a floating point number,
604 which specifies a scaling factor for the underlying face height;
605 or a function that takes a single argument (the underlying face
606 height) and returns the new height. Note that for the `default'
607 face, you must specify an absolute height (since there is nothing
608 for it to be relative to).
610 `:weight'
612 VALUE specifies the weight of the font to use. It must be one of the
613 symbols `ultra-bold', `extra-bold', `bold', `semi-bold', `normal',
614 `semi-light', `light', `extra-light', `ultra-light'.
616 `:slant'
618 VALUE specifies the slant of the font to use. It must be one of the
619 symbols `italic', `oblique', `normal', `reverse-italic', or
620 `reverse-oblique'.
622 `:foreground', `:background'
624 VALUE must be a color name, a string.
626 `:underline'
628 VALUE specifies whether characters in FACE should be underlined.
629 If VALUE is t, underline with foreground color of the face.
630 If VALUE is a string, underline with that color.
631 If VALUE is nil, explicitly don't underline.
633 Otherwise, VALUE must be a property list of the form:
635 `(:color COLOR :style STYLE)'.
637 COLOR can be a either a color name string or `foreground-color'.
638 STYLE can be either `line' or `wave'.
639 If a keyword/value pair is missing from the property list, a
640 default value will be used for the value.
641 The default value of COLOR is the foreground color of the face.
642 The default value of STYLE is `line'.
644 `:overline'
646 VALUE specifies whether characters in FACE should be overlined. If
647 VALUE is t, overline with foreground color of the face. If VALUE is a
648 string, overline with that color. If VALUE is nil, explicitly don't
649 overline.
651 `:strike-through'
653 VALUE specifies whether characters in FACE should be drawn with a line
654 striking through them. If VALUE is t, use the foreground color of the
655 face. If VALUE is a string, strike-through with that color. If VALUE
656 is nil, explicitly don't strike through.
658 `:box'
660 VALUE specifies whether characters in FACE should have a box drawn
661 around them. If VALUE is nil, explicitly don't draw boxes. If
662 VALUE is t, draw a box with lines of width 1 in the foreground color
663 of the face. If VALUE is a string, the string must be a color name,
664 and the box is drawn in that color with a line width of 1. Otherwise,
665 VALUE must be a property list of the form `(:line-width WIDTH
666 :color COLOR :style STYLE)'. If a keyword/value pair is missing from
667 the property list, a default value will be used for the value, as
668 specified below. WIDTH specifies the width of the lines to draw; it
669 defaults to 1. If WIDTH is negative, the absolute value is the width
670 of the lines, and draw top/bottom lines inside the characters area,
671 not around it. COLOR is the name of the color to draw in, default is
672 the foreground color of the face for simple boxes, and the background
673 color of the face for 3D boxes. STYLE specifies whether a 3D box
674 should be draw. If STYLE is `released-button', draw a box looking
675 like a released 3D button. If STYLE is `pressed-button' draw a box
676 that appears like a pressed button. If STYLE is nil, the default if
677 the property list doesn't contain a style specification, draw a 2D
678 box.
680 `:inverse-video'
682 VALUE specifies whether characters in FACE should be displayed in
683 inverse video. VALUE must be one of t or nil.
685 `:stipple'
687 If VALUE is a string, it must be the name of a file of pixmap data.
688 The directories listed in the `x-bitmap-file-path' variable are
689 searched. Alternatively, VALUE may be a list of the form (WIDTH
690 HEIGHT DATA) where WIDTH and HEIGHT are the size in pixels, and DATA
691 is a string containing the raw bits of the bitmap. VALUE nil means
692 explicitly don't use a stipple pattern.
694 For convenience, attributes `:family', `:foundry', `:width',
695 `:height', `:weight', and `:slant' may also be set in one step
696 from an X font name:
698 `:font'
700 Set font-related face attributes from VALUE. VALUE must be a
701 valid font name or font object. Setting this attribute will also
702 set the `:family', `:foundry', `:width', `:height', `:weight',
703 and `:slant' attributes.
705 `:inherit'
707 VALUE is the name of a face from which to inherit attributes, or
708 a list of face names. Attributes from inherited faces are merged
709 into the face like an underlying face would be, with higher
710 priority than underlying faces.
712 For backward compatibility, the keywords `:bold' and `:italic'
713 can be used to specify weight and slant respectively. This usage
714 is considered obsolete. For these two keywords, the VALUE must
715 be either t or nil. A value of t for `:bold' is equivalent to
716 setting `:weight' to `bold', and a value of t for `:italic' is
717 equivalent to setting `:slant' to `italic'. But if `:weight' is
718 specified in the face spec, `:bold' is ignored, and if `:slant'
719 is specified, `:italic' is ignored."
720 (setq args (purecopy args))
721 (let ((where (if (null frame) 0 frame))
722 (spec args)
723 family foundry)
724 ;; If we set the new-frame defaults, this face is modified outside Custom.
725 (if (memq where '(0 t))
726 (put (or (get face 'face-alias) face) 'face-modified t))
727 ;; If family and/or foundry are specified, set it first. Certain
728 ;; face attributes, e.g. :weight semi-condensed, are not supported
729 ;; in every font. See bug#1127.
730 (while spec
731 (cond ((eq (car spec) :family)
732 (setq family (cadr spec)))
733 ((eq (car spec) :foundry)
734 (setq foundry (cadr spec))))
735 (setq spec (cddr spec)))
736 (when (or family foundry)
737 (when (and (stringp family)
738 (string-match "\\([^-]*\\)-\\([^-]*\\)" family))
739 (unless foundry
740 (setq foundry (match-string 1 family)))
741 (setq family (match-string 2 family)))
742 (when (or (stringp family) (eq family 'unspecified))
743 (internal-set-lisp-face-attribute face :family (purecopy family)
744 where))
745 (when (or (stringp foundry) (eq foundry 'unspecified))
746 (internal-set-lisp-face-attribute face :foundry (purecopy foundry)
747 where)))
748 (while args
749 (unless (memq (car args) '(:family :foundry))
750 (internal-set-lisp-face-attribute face (car args)
751 (purecopy (cadr args))
752 where))
753 (setq args (cddr args)))))
755 (defun make-face-bold (face &optional frame _noerror)
756 "Make the font of FACE be bold, if possible.
757 FRAME nil or not specified means change face on all frames.
758 Argument NOERROR is ignored and retained for compatibility.
759 Use `set-face-attribute' for finer control of the font weight."
760 (interactive (list (read-face-name "Make which face bold")))
761 (set-face-attribute face frame :weight 'bold))
764 (defun make-face-unbold (face &optional frame _noerror)
765 "Make the font of FACE be non-bold, if possible.
766 FRAME nil or not specified means change face on all frames.
767 Argument NOERROR is ignored and retained for compatibility."
768 (interactive (list (read-face-name "Make which face non-bold")))
769 (set-face-attribute face frame :weight 'normal))
772 (defun make-face-italic (face &optional frame _noerror)
773 "Make the font of FACE be italic, if possible.
774 FRAME nil or not specified means change face on all frames.
775 Argument NOERROR is ignored and retained for compatibility.
776 Use `set-face-attribute' for finer control of the font slant."
777 (interactive (list (read-face-name "Make which face italic")))
778 (set-face-attribute face frame :slant 'italic))
781 (defun make-face-unitalic (face &optional frame _noerror)
782 "Make the font of FACE be non-italic, if possible.
783 FRAME nil or not specified means change face on all frames.
784 Argument NOERROR is ignored and retained for compatibility."
785 (interactive (list (read-face-name "Make which face non-italic")))
786 (set-face-attribute face frame :slant 'normal))
789 (defun make-face-bold-italic (face &optional frame _noerror)
790 "Make the font of FACE be bold and italic, if possible.
791 FRAME nil or not specified means change face on all frames.
792 Argument NOERROR is ignored and retained for compatibility.
793 Use `set-face-attribute' for finer control of font weight and slant."
794 (interactive (list (read-face-name "Make which face bold-italic")))
795 (set-face-attribute face frame :weight 'bold :slant 'italic))
798 (defun set-face-font (face font &optional frame)
799 "Change font-related attributes of FACE to those of FONT (a string).
800 FRAME nil or not specified means change face on all frames.
801 This sets the attributes `:family', `:foundry', `:width',
802 `:height', `:weight', and `:slant'. When called interactively,
803 prompt for the face and font."
804 (interactive (read-face-and-attribute :font))
805 (set-face-attribute face frame :font font))
808 ;; Implementation note: Emulating gray background colors with a
809 ;; stipple pattern is now part of the face realization process, and is
810 ;; done in C depending on the frame on which the face is realized.
812 (defun set-face-background (face color &optional frame)
813 "Change the background color of face FACE to COLOR (a string).
814 FRAME nil or not specified means change face on all frames.
815 COLOR can be a system-defined color name (see `list-colors-display')
816 or a hex spec of the form #RRGGBB.
817 When called interactively, prompts for the face and color."
818 (interactive (read-face-and-attribute :background))
819 (set-face-attribute face frame :background (or color 'unspecified)))
822 (defun set-face-foreground (face color &optional frame)
823 "Change the foreground color of face FACE to COLOR (a string).
824 FRAME nil or not specified means change face on all frames.
825 COLOR can be a system-defined color name (see `list-colors-display')
826 or a hex spec of the form #RRGGBB.
827 When called interactively, prompts for the face and color."
828 (interactive (read-face-and-attribute :foreground))
829 (set-face-attribute face frame :foreground (or color 'unspecified)))
832 (defun set-face-stipple (face stipple &optional frame)
833 "Change the stipple pixmap of face FACE to STIPPLE.
834 FRAME nil or not specified means change face on all frames.
835 STIPPLE should be a string, the name of a file of pixmap data.
836 The directories listed in the `x-bitmap-file-path' variable are searched.
838 Alternatively, STIPPLE may be a list of the form (WIDTH HEIGHT DATA)
839 where WIDTH and HEIGHT are the size in pixels,
840 and DATA is a string, containing the raw bits of the bitmap."
841 (interactive (read-face-and-attribute :stipple))
842 (set-face-attribute face frame :stipple (or stipple 'unspecified)))
845 (defun set-face-underline (face underline &optional frame)
846 "Specify whether face FACE is underlined.
847 UNDERLINE nil means FACE explicitly doesn't underline.
848 UNDERLINE t means FACE underlines with its foreground color.
849 If UNDERLINE is a string, underline with that color.
851 UNDERLINE may also be a list of the form (:color COLOR :style STYLE),
852 where COLOR is a string or `foreground-color', and STYLE is either
853 `line' or `wave'. :color may be omitted, which means to use the
854 foreground color. :style may be omitted, which means to use a line.
856 FRAME nil or not specified means change face on all frames.
857 Use `set-face-attribute' to ``unspecify'' underlining."
858 (interactive (read-face-and-attribute :underline))
859 (set-face-attribute face frame :underline underline))
861 (define-obsolete-function-alias 'set-face-underline-p
862 'set-face-underline "24.3")
865 (defun set-face-inverse-video-p (face inverse-video-p &optional frame)
866 "Specify whether face FACE is in inverse video.
867 INVERSE-VIDEO-P non-nil means FACE displays explicitly in inverse video.
868 INVERSE-VIDEO-P nil means FACE explicitly is not in inverse video.
869 FRAME nil or not specified means change face on all frames.
870 Use `set-face-attribute' to ``unspecify'' the inverse video attribute."
871 (interactive
872 (let ((list (read-face-and-attribute :inverse-video)))
873 (list (car list) (eq (car (cdr list)) t))))
874 (set-face-attribute face frame :inverse-video inverse-video-p))
877 ;; The -p suffix is a hostage to fortune. What if we want to extend
878 ;; this to allow more than boolean options? Exactly this happened
879 ;; to set-face-underline-p.
880 (defun set-face-bold-p (face bold-p &optional frame)
881 "Specify whether face FACE is bold.
882 BOLD-P non-nil means FACE should explicitly display bold.
883 BOLD-P nil means FACE should explicitly display non-bold.
884 FRAME nil or not specified means change face on all frames.
885 Use `set-face-attribute' or `modify-face' for finer control."
886 (if (null bold-p)
887 (make-face-unbold face frame)
888 (make-face-bold face frame)))
891 (defun set-face-italic-p (face italic-p &optional frame)
892 "Specify whether face FACE is italic.
893 ITALIC-P non-nil means FACE should explicitly display italic.
894 ITALIC-P nil means FACE should explicitly display non-italic.
895 FRAME nil or not specified means change face on all frames.
896 Use `set-face-attribute' or `modify-face' for finer control."
897 (if (null italic-p)
898 (make-face-unitalic face frame)
899 (make-face-italic face frame)))
902 (defalias 'set-face-background-pixmap 'set-face-stipple)
905 (defun invert-face (face &optional frame)
906 "Swap the foreground and background colors of FACE.
907 If FRAME is omitted or nil, it means change face on all frames.
908 If FACE specifies neither foreground nor background color,
909 set its foreground and background to the background and foreground
910 of the default face. Value is FACE."
911 (interactive (list (read-face-name "Invert face")))
912 (let ((fg (face-attribute face :foreground frame))
913 (bg (face-attribute face :background frame)))
914 (if (not (and (eq fg 'unspecified) (eq bg 'unspecified)))
915 (set-face-attribute face frame :foreground bg :background fg)
916 (set-face-attribute face frame
917 :foreground
918 (face-attribute 'default :background frame)
919 :background
920 (face-attribute 'default :foreground frame))))
921 face)
924 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
925 ;;; Interactively modifying faces.
926 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
928 (defun read-face-name (prompt &optional default multiple)
929 "Read a face, defaulting to the face or faces at point.
930 If the text at point has the property `read-face-name', that
931 overrides the `face' property for determining the default.
933 PROMPT should be a string that describes what the caller will do
934 with the face; it should not end in a space.
937 This function uses `completing-read-multiple' with \",\" as the
938 separator character, i.e.
944 The optional argument DEFAULT provides the value to display in the
945 minibuffer prompt that is returned if the user just types RET
946 unless DEFAULT is a string (in which case nil is returned).
948 If MULTIPLE is non-nil, return a list of faces (possibly only one).
949 Otherwise, return a single face."
950 (let ((faceprop (or (get-char-property (point) 'read-face-name)
951 (get-char-property (point) 'face)))
952 (aliasfaces nil)
953 (nonaliasfaces nil)
954 faces)
955 ;; Try to get a face name from the buffer.
956 (if (memq (intern-soft (thing-at-point 'symbol)) (face-list))
957 (setq faces (list (intern-soft (thing-at-point 'symbol)))))
958 ;; Add the named faces that the `face' property uses.
959 (if (and (listp faceprop)
960 ;; Don't treat an attribute spec as a list of faces.
961 (not (keywordp (car faceprop)))
962 (not (memq (car faceprop) '(foreground-color background-color))))
963 (dolist (f faceprop)
964 (if (symbolp f)
965 (push f faces)))
966 (if (symbolp faceprop)
967 (push faceprop faces)))
968 (delete-dups faces)
970 ;; Build up the completion tables.
971 (mapatoms (lambda (s)
972 (if (custom-facep s)
973 (if (get s 'face-alias)
974 (push (symbol-name s) aliasfaces)
975 (push (symbol-name s) nonaliasfaces)))))
977 ;; If we only want one, and the default is more than one,
978 ;; discard the unwanted ones now.
979 (unless multiple
980 (if faces
981 (setq faces (list (car faces)))))
982 (require 'crm)
983 (let* ((input
984 ;; Read the input.
985 (completing-read-multiple
986 (if (or faces default)
987 (format "%s (default `%s'): " prompt
988 (if faces (mapconcat 'symbol-name faces ",")
989 default))
990 (format "%s: " prompt))
991 (completion-table-in-turn nonaliasfaces aliasfaces)
992 nil t nil 'face-name-history
993 (if faces (mapconcat 'symbol-name faces ","))))
994 ;; Canonicalize the output.
995 (output
996 (cond ((or (equal input "") (equal input '("")))
997 (or faces (unless (stringp default) default)))
998 ((stringp input)
999 (mapcar 'intern (split-string input ", *" t)))
1000 ((listp input)
1001 (mapcar 'intern input))
1002 (input))))
1003 ;; Return either a list of faces or just one face.
1004 (if multiple
1005 output
1006 (car output)))))
1008 ;; Not defined without X, but behind window-system test.
1009 (defvar x-bitmap-file-path)
1011 (defun face-valid-attribute-values (attribute &optional frame)
1012 "Return valid values for face attribute ATTRIBUTE.
1013 The optional argument FRAME is used to determine available fonts
1014 and colors. If it is nil or not specified, the selected frame is used.
1015 Value is an alist of (NAME . VALUE) if ATTRIBUTE expects a value out
1016 of a set of discrete values. Value is `integerp' if ATTRIBUTE expects
1017 an integer value."
1018 (let ((valid
1019 (pcase attribute
1020 (`:family
1021 (if (window-system frame)
1022 (mapcar (lambda (x) (cons x x))
1023 (font-family-list))
1024 ;; Only one font on TTYs.
1025 (list (cons "default" "default"))))
1026 (`:foundry
1027 (list nil))
1028 (`:width
1029 (mapcar #'(lambda (x) (cons (symbol-name (aref x 1)) (aref x 1)))
1030 font-width-table))
1031 (`:weight
1032 (mapcar #'(lambda (x) (cons (symbol-name (aref x 1)) (aref x 1)))
1033 font-weight-table))
1034 (`:slant
1035 (mapcar #'(lambda (x) (cons (symbol-name (aref x 1)) (aref x 1)))
1036 font-slant-table))
1037 (`:inverse-video
1038 (mapcar #'(lambda (x) (cons (symbol-name x) x))
1039 (internal-lisp-face-attribute-values attribute)))
1040 ((or `:underline `:overline `:strike-through `:box)
1041 (if (window-system frame)
1042 (nconc (mapcar #'(lambda (x) (cons (symbol-name x) x))
1043 (internal-lisp-face-attribute-values attribute))
1044 (mapcar #'(lambda (c) (cons c c))
1045 (defined-colors frame)))
1046 (mapcar #'(lambda (x) (cons (symbol-name x) x))
1047 (internal-lisp-face-attribute-values attribute))))
1048 ((or `:foreground `:background)
1049 (mapcar #'(lambda (c) (cons c c))
1050 (defined-colors frame)))
1051 (`:height
1052 'integerp)
1053 (`:stipple
1054 (and (memq (window-system frame) '(x ns)) ; No stipple on w32
1055 (mapcar #'list
1056 (apply #'nconc
1057 (mapcar (lambda (dir)
1058 (and (file-readable-p dir)
1059 (file-directory-p dir)
1060 (directory-files dir)))
1061 x-bitmap-file-path)))))
1062 (`:inherit
1063 (cons '("none" . nil)
1064 (mapcar #'(lambda (c) (cons (symbol-name c) c))
1065 (face-list))))
1067 (error "Internal error")))))
1068 (if (and (listp valid) (not (memq attribute '(:inherit))))
1069 (nconc (list (cons "unspecified" 'unspecified)) valid)
1070 valid)))
1073 (defconst face-attribute-name-alist
1074 '((:family . "font family")
1075 (:foundry . "font foundry")
1076 (:width . "character set width")
1077 (:height . "height in 1/10 pt")
1078 (:weight . "weight")
1079 (:slant . "slant")
1080 (:underline . "underline")
1081 (:overline . "overline")
1082 (:strike-through . "strike-through")
1083 (:box . "box")
1084 (:inverse-video . "inverse-video display")
1085 (:foreground . "foreground color")
1086 (:background . "background color")
1087 (:stipple . "background stipple")
1088 (:inherit . "inheritance"))
1089 "An alist of descriptive names for face attributes.
1090 Each element has the form (ATTRIBUTE-NAME . DESCRIPTION) where
1091 ATTRIBUTE-NAME is a face attribute name (a keyword symbol), and
1092 DESCRIPTION is a descriptive name for ATTRIBUTE-NAME.")
1095 (defun face-descriptive-attribute-name (attribute)
1096 "Return a descriptive name for ATTRIBUTE."
1097 (cdr (assq attribute face-attribute-name-alist)))
1100 (defun face-read-string (face default name &optional completion-alist)
1101 "Interactively read a face attribute string value.
1102 FACE is the face whose attribute is read. If non-nil, DEFAULT is the
1103 default string to return if no new value is entered. NAME is a
1104 descriptive name of the attribute for prompting. COMPLETION-ALIST is an
1105 alist of valid values, if non-nil.
1107 Entering nothing accepts the default string DEFAULT.
1108 Value is the new attribute value."
1109 ;; Capitalize NAME (we don't use `capitalize' because that capitalizes
1110 ;; each word in a string separately).
1111 (setq name (concat (upcase (substring name 0 1)) (substring name 1)))
1112 (let* ((completion-ignore-case t)
1113 (value (completing-read
1114 (if default
1115 (format "%s for face `%s' (default %s): "
1116 name face default)
1117 (format "%s for face `%s': " name face))
1118 completion-alist nil nil nil nil default)))
1119 (if (equal value "") default value)))
1122 (defun face-read-integer (face default name)
1123 "Interactively read an integer face attribute value.
1124 FACE is the face whose attribute is read. DEFAULT is the default
1125 value to return if no new value is entered. NAME is a descriptive
1126 name of the attribute for prompting. Value is the new attribute value."
1127 (let ((new-value
1128 (face-read-string face
1129 (format "%s" default)
1130 name
1131 (list (cons "unspecified" 'unspecified)))))
1132 (cond ((equal new-value "unspecified")
1133 'unspecified)
1134 ((member new-value '("unspecified-fg" "unspecified-bg"))
1135 new-value)
1137 (string-to-number new-value)))))
1140 ;; FIXME this does allow you to enter the list forms of :box,
1141 ;; :stipple, or :underline, because face-valid-attribute-values does
1142 ;; not return those forms.
1143 (defun read-face-attribute (face attribute &optional frame)
1144 "Interactively read a new value for FACE's ATTRIBUTE.
1145 Optional argument FRAME nil or unspecified means read an attribute value
1146 of a global face. Value is the new attribute value."
1147 (let* ((old-value (face-attribute face attribute frame))
1148 (attribute-name (face-descriptive-attribute-name attribute))
1149 (valid (face-valid-attribute-values attribute frame))
1150 new-value)
1151 ;; Represent complex attribute values as strings by printing them
1152 ;; out. Stipple can be a vector; (WIDTH HEIGHT DATA). Box can be
1153 ;; a list `(:width WIDTH :color COLOR)' or `(:width WIDTH :shadow
1154 ;; SHADOW)'. Underline can be `(:color COLOR :style STYLE)'.
1155 (and (memq attribute '(:box :stipple :underline))
1156 (or (consp old-value)
1157 (vectorp old-value))
1158 (setq old-value (prin1-to-string old-value)))
1159 (cond ((listp valid)
1160 (let ((default
1161 (or (car (rassoc old-value valid))
1162 (format "%s" old-value))))
1163 (setq new-value
1164 (face-read-string face default attribute-name valid))
1165 (if (equal new-value default)
1166 ;; Nothing changed, so don't bother with all the stuff
1167 ;; below. In particular, this avoids a non-tty color
1168 ;; from being canonicalized for a tty when the user
1169 ;; just uses the default.
1170 (setq new-value old-value)
1171 ;; Terminal frames can support colors that don't appear
1172 ;; explicitly in VALID, using color approximation code
1173 ;; in tty-colors.el.
1174 (when (and (memq attribute '(:foreground :background))
1175 (not (memq (window-system frame) '(x w32 ns)))
1176 (not (member new-value
1177 '("unspecified"
1178 "unspecified-fg" "unspecified-bg"))))
1179 (setq new-value (car (tty-color-desc new-value frame))))
1180 (when (assoc new-value valid)
1181 (setq new-value (cdr (assoc new-value valid)))))))
1182 ((eq valid 'integerp)
1183 (setq new-value (face-read-integer face old-value attribute-name)))
1184 (t (error "Internal error")))
1185 ;; Convert stipple and box value text we read back to a list or
1186 ;; vector if it looks like one. This makes the assumption that a
1187 ;; pixmap file name won't start with an open-paren.
1188 (and (memq attribute '(:stipple :box :underline))
1189 (stringp new-value)
1190 (string-match "^[[(]" new-value)
1191 (setq new-value (read new-value)))
1192 new-value))
1194 (declare-function fontset-list "fontset.c" ())
1195 (declare-function x-list-fonts "xfaces.c"
1196 (pattern &optional face frame maximum width))
1198 (defun read-face-font (face &optional frame)
1199 "Read the name of a font for FACE on FRAME.
1200 If optional argument FRAME is nil or omitted, use the selected frame."
1201 (let ((completion-ignore-case t))
1202 (completing-read (format "Set font attributes of face `%s' from font: " face)
1203 (append (fontset-list) (x-list-fonts "*" nil frame)))))
1206 (defun read-all-face-attributes (face &optional frame)
1207 "Interactively read all attributes for FACE.
1208 If optional argument FRAME is nil or omitted, use the selected frame.
1209 Value is a property list of attribute names and new values."
1210 (let (result)
1211 (dolist (attribute face-attribute-name-alist result)
1212 (setq result (cons (car attribute)
1213 (cons (read-face-attribute face (car attribute) frame)
1214 result))))))
1216 (defun modify-face (&optional face foreground background stipple
1217 bold-p italic-p underline inverse-p frame)
1218 "Modify attributes of faces interactively.
1219 If optional argument FRAME is nil or omitted, modify the face used
1220 for newly created frame, i.e. the global face.
1221 For non-interactive use, `set-face-attribute' is preferred.
1222 When called from Lisp, if FACE is nil, all arguments but FRAME are ignored
1223 and the face and its settings are obtained by querying the user."
1224 (interactive)
1225 (if face
1226 (set-face-attribute face frame
1227 :foreground (or foreground 'unspecified)
1228 :background (or background 'unspecified)
1229 :stipple stipple
1230 :weight (if bold-p 'bold 'normal)
1231 :slant (if italic-p 'italic 'normal)
1232 :underline underline
1233 :inverse-video inverse-p)
1234 (setq face (read-face-name "Modify face"))
1235 (apply #'set-face-attribute face frame
1236 (read-all-face-attributes face frame))))
1238 (defun read-face-and-attribute (attribute &optional frame)
1239 "Read face name and face attribute value.
1240 ATTRIBUTE is the attribute whose new value is read.
1241 FRAME nil or unspecified means read attribute value of global face.
1242 Value is a list (FACE NEW-VALUE) where FACE is the face read
1243 \(a symbol), and NEW-VALUE is value read."
1244 (cond ((eq attribute :font)
1245 (let* ((prompt "Set font-related attributes of face")
1246 (face (read-face-name prompt))
1247 (font (read-face-font face frame)))
1248 (list face font)))
1250 (let* ((attribute-name (face-descriptive-attribute-name attribute))
1251 (prompt (format "Set %s of face" attribute-name))
1252 (face (read-face-name prompt))
1253 (new-value (read-face-attribute face attribute frame)))
1254 (list face new-value)))))
1258 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1259 ;;; Listing faces.
1260 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1262 (defconst list-faces-sample-text
1263 "abcdefghijklmnopqrstuvwxyz ABCDEFGHIJKLMNOPQRSTUVWXYZ"
1264 "Text string to display as the sample text for `list-faces-display'.")
1267 ;; The name list-faces would be more consistent, but let's avoid a
1268 ;; conflict with Lucid, which uses that name differently.
1270 (defvar help-xref-stack)
1271 (defun list-faces-display (&optional regexp)
1272 "List all faces, using the same sample text in each.
1273 The sample text is a string that comes from the variable
1274 `list-faces-sample-text'.
1276 If REGEXP is non-nil, list only those faces with names matching
1277 this regular expression. When called interactively with a prefix
1278 arg, prompt for a regular expression."
1279 (interactive (list (and current-prefix-arg
1280 (read-regexp "List faces matching regexp"))))
1281 (let ((all-faces (zerop (length regexp)))
1282 (frame (selected-frame))
1283 (max-length 0)
1284 faces line-format
1285 disp-frame window face-name)
1286 ;; We filter and take the max length in one pass
1287 (setq faces
1288 (delq nil
1289 (mapcar (lambda (f)
1290 (let ((s (symbol-name f)))
1291 (when (or all-faces (string-match regexp s))
1292 (setq max-length (max (length s) max-length))
1293 f)))
1294 (sort (face-list) #'string-lessp))))
1295 (unless faces
1296 (error "No faces matching \"%s\"" regexp))
1297 (setq max-length (1+ max-length)
1298 line-format (format "%%-%ds" max-length))
1299 (with-help-window "*Faces*"
1300 (with-current-buffer standard-output
1301 (setq truncate-lines t)
1302 (insert
1303 (substitute-command-keys
1304 (concat
1305 "\\<help-mode-map>Use "
1306 (if (display-mouse-p) "\\[help-follow-mouse] or ")
1307 "\\[help-follow] on a face name to customize it\n"
1308 "or on its sample text for a description of the face.\n\n")))
1309 (setq help-xref-stack nil)
1310 (dolist (face faces)
1311 (setq face-name (symbol-name face))
1312 (insert (format line-format face-name))
1313 ;; Hyperlink to a customization buffer for the face. Using
1314 ;; the help xref mechanism may not be the best way.
1315 (save-excursion
1316 (save-match-data
1317 (search-backward face-name)
1318 (setq help-xref-stack-item `(list-faces-display ,regexp))
1319 (help-xref-button 0 'help-customize-face face)))
1320 (let ((beg (point))
1321 (line-beg (line-beginning-position)))
1322 (insert list-faces-sample-text)
1323 ;; Hyperlink to a help buffer for the face.
1324 (save-excursion
1325 (save-match-data
1326 (search-backward list-faces-sample-text)
1327 (help-xref-button 0 'help-face face)))
1328 (insert "\n")
1329 (put-text-property beg (1- (point)) 'face face)
1330 ;; Make all face commands default to the proper face
1331 ;; anywhere in the line.
1332 (put-text-property line-beg (1- (point)) 'read-face-name face)
1333 ;; If the sample text has multiple lines, line up all of them.
1334 (goto-char beg)
1335 (forward-line 1)
1336 (while (not (eobp))
1337 (insert-char ?\s max-length)
1338 (forward-line 1))))
1339 (goto-char (point-min))))
1340 ;; If the *Faces* buffer appears in a different frame,
1341 ;; copy all the face definitions from FRAME,
1342 ;; so that the display will reflect the frame that was selected.
1343 (setq window (get-buffer-window (get-buffer "*Faces*") t))
1344 (setq disp-frame (if window (window-frame window)
1345 (car (frame-list))))
1346 (or (eq frame disp-frame)
1347 (let ((faces (face-list)))
1348 (while faces
1349 (copy-face (car faces) (car faces) frame disp-frame)
1350 (setq faces (cdr faces)))))))
1353 (defun describe-face (face &optional frame)
1354 "Display the properties of face FACE on FRAME.
1355 Interactively, FACE defaults to the faces of the character after point
1356 and FRAME defaults to the selected frame.
1358 If the optional argument FRAME is given, report on face FACE in that frame.
1359 If FRAME is t, report on the defaults for face FACE (for new frames).
1360 If FRAME is omitted or nil, use the selected frame."
1361 (interactive (list (read-face-name "Describe face" 'default t)))
1362 (let* ((attrs '((:family . "Family")
1363 (:foundry . "Foundry")
1364 (:width . "Width")
1365 (:height . "Height")
1366 (:weight . "Weight")
1367 (:slant . "Slant")
1368 (:foreground . "Foreground")
1369 (:background . "Background")
1370 (:underline . "Underline")
1371 (:overline . "Overline")
1372 (:strike-through . "Strike-through")
1373 (:box . "Box")
1374 (:inverse-video . "Inverse")
1375 (:stipple . "Stipple")
1376 (:font . "Font")
1377 (:fontset . "Fontset")
1378 (:inherit . "Inherit")))
1379 (max-width (apply #'max (mapcar #'(lambda (x) (length (cdr x)))
1380 attrs))))
1381 (help-setup-xref (list #'describe-face face)
1382 (called-interactively-p 'interactive))
1383 (unless face
1384 (setq face 'default))
1385 (if (not (listp face))
1386 (setq face (list face)))
1387 (with-help-window (help-buffer)
1388 (with-current-buffer standard-output
1389 (dolist (f face)
1390 (if (stringp f) (setq f (intern f)))
1391 ;; We may get called for anonymous faces (i.e., faces
1392 ;; expressed using prop-value plists). Those can't be
1393 ;; usefully customized, so ignore them.
1394 (when (symbolp f)
1395 (insert "Face: " (symbol-name f))
1396 (if (not (facep f))
1397 (insert " undefined face.\n")
1398 (let ((customize-label "customize this face")
1399 file-name)
1400 (insert (concat " (" (propertize "sample" 'font-lock-face f) ")"))
1401 (princ (concat " (" customize-label ")\n"))
1402 ;; FIXME not sure how much of this belongs here, and
1403 ;; how much in `face-documentation'. The latter is
1404 ;; not used much, but needs to return nil for
1405 ;; undocumented faces.
1406 (let ((alias (get f 'face-alias))
1407 (face f)
1408 obsolete)
1409 (when alias
1410 (setq face alias)
1411 (insert
1412 (format "\n %s is an alias for the face `%s'.\n%s"
1413 f alias
1414 (if (setq obsolete (get f 'obsolete-face))
1415 (format " This face is obsolete%s; use `%s' instead.\n"
1416 (if (stringp obsolete)
1417 (format " since %s" obsolete)
1419 alias)
1420 ""))))
1421 (insert "\nDocumentation:\n"
1422 (or (face-documentation face)
1423 "Not documented as a face.")
1424 "\n\n"))
1425 (with-current-buffer standard-output
1426 (save-excursion
1427 (re-search-backward
1428 (concat "\\(" customize-label "\\)") nil t)
1429 (help-xref-button 1 'help-customize-face f)))
1430 (setq file-name (find-lisp-object-file-name f 'defface))
1431 (when file-name
1432 (princ "Defined in `")
1433 (princ (file-name-nondirectory file-name))
1434 (princ "'")
1435 ;; Make a hyperlink to the library.
1436 (save-excursion
1437 (re-search-backward "`\\([^`']+\\)'" nil t)
1438 (help-xref-button 1 'help-face-def f file-name))
1439 (princ ".")
1440 (terpri)
1441 (terpri))
1442 (dolist (a attrs)
1443 (let ((attr (face-attribute f (car a) frame)))
1444 (insert (make-string (- max-width (length (cdr a))) ?\s)
1445 (cdr a) ": " (format "%s" attr))
1446 (if (and (eq (car a) :inherit)
1447 (not (eq attr 'unspecified)))
1448 ;; Make a hyperlink to the parent face.
1449 (save-excursion
1450 (re-search-backward ": \\([^:]+\\)" nil t)
1451 (help-xref-button 1 'help-face attr)))
1452 (insert "\n")))))
1453 (terpri)))))))
1456 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1457 ;;; Face specifications (defface).
1458 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1460 ;; Parameter FRAME Is kept for call compatibility to with previous
1461 ;; face implementation.
1463 (defun face-attr-construct (face &optional _frame)
1464 "Return a `defface'-style attribute list for FACE.
1465 Value is a property list of pairs ATTRIBUTE VALUE for all specified
1466 face attributes of FACE where ATTRIBUTE is the attribute name and
1467 VALUE is the specified value of that attribute.
1468 Argument FRAME is ignored and retained for compatibility."
1469 (let (result)
1470 (dolist (entry face-attribute-name-alist result)
1471 (let* ((attribute (car entry))
1472 (value (face-attribute face attribute)))
1473 (unless (eq value 'unspecified)
1474 (setq result (nconc (list attribute value) result)))))))
1477 (defun face-spec-set-match-display (display frame)
1478 "Non-nil if DISPLAY matches FRAME.
1479 DISPLAY is part of a spec such as can be used in `defface'.
1480 If FRAME is nil, the current FRAME is used."
1481 (let* ((conjuncts display)
1482 conjunct req options
1483 ;; t means we have succeeded against all the conjuncts in
1484 ;; DISPLAY that have been tested so far.
1485 (match t))
1486 (if (eq conjuncts t)
1487 (setq conjuncts nil))
1488 (while (and conjuncts match)
1489 (setq conjunct (car conjuncts)
1490 conjuncts (cdr conjuncts)
1491 req (car conjunct)
1492 options (cdr conjunct)
1493 match (cond ((eq req 'type)
1494 (or (memq (window-system frame) options)
1495 (and (memq 'graphic options)
1496 (memq (window-system frame) '(x w32 ns)))
1497 ;; FIXME: This should be revisited to use
1498 ;; display-graphic-p, provided that the
1499 ;; color selection depends on the number
1500 ;; of supported colors, and all defface's
1501 ;; are changed to look at number of colors
1502 ;; instead of (type graphic) etc.
1503 (if (null (window-system frame))
1504 (memq 'tty options)
1505 (or (and (memq 'motif options)
1506 (featurep 'motif))
1507 (and (memq 'gtk options)
1508 (featurep 'gtk))
1509 (and (memq 'lucid options)
1510 (featurep 'x-toolkit)
1511 (not (featurep 'motif))
1512 (not (featurep 'gtk)))
1513 (and (memq 'x-toolkit options)
1514 (featurep 'x-toolkit))))))
1515 ((eq req 'min-colors)
1516 (>= (display-color-cells frame) (car options)))
1517 ((eq req 'class)
1518 (memq (frame-parameter frame 'display-type) options))
1519 ((eq req 'background)
1520 (memq (frame-parameter frame 'background-mode)
1521 options))
1522 ((eq req 'supports)
1523 (display-supports-face-attributes-p options frame))
1524 (t (error "Unknown req `%S' with options `%S'"
1525 req options)))))
1526 match))
1529 (defun face-spec-choose (spec &optional frame)
1530 "Choose the proper attributes for FRAME, out of SPEC.
1531 If SPEC is nil, return nil."
1532 (unless frame
1533 (setq frame (selected-frame)))
1534 (let ((tail spec)
1535 result defaults)
1536 (while tail
1537 (let* ((entry (pop tail))
1538 (display (car entry))
1539 (attrs (cdr entry))
1540 thisval)
1541 ;; Get the attributes as actually specified by this alternative.
1542 (setq thisval
1543 (if (null (cdr attrs)) ;; was (listp (car attrs))
1544 ;; Old-style entry, the attribute list is the
1545 ;; first element.
1546 (car attrs)
1547 attrs))
1549 ;; If the condition is `default', that sets the default
1550 ;; for following conditions.
1551 (if (eq display 'default)
1552 (setq defaults thisval)
1553 ;; Otherwise, if it matches, use it.
1554 (when (face-spec-set-match-display display frame)
1555 (setq result thisval)
1556 (setq tail nil)))))
1557 (if defaults (append result defaults) result)))
1560 (defun face-spec-reset-face (face &optional frame)
1561 "Reset all attributes of FACE on FRAME to unspecified."
1562 (apply 'set-face-attribute face frame
1563 (if (eq face 'default)
1564 ;; For the default face, avoid making any attribute
1565 ;; unspecified. Instead, set attributes to default values
1566 ;; (see also realize_default_face in xfaces.c).
1567 (append
1568 '(:underline nil :overline nil :strike-through nil
1569 :box nil :inverse-video nil :stipple nil :inherit nil)
1570 ;; `display-graphic-p' is unavailable when running
1571 ;; temacs, prior to loading frame.el.
1572 (unless (and (fboundp 'display-graphic-p)
1573 (display-graphic-p frame))
1574 `(:family "default" :foundry "default" :width normal
1575 :height 1 :weight normal :slant normal
1576 :foreground ,(if (frame-parameter nil 'reverse)
1577 "unspecified-bg"
1578 "unspecified-fg")
1579 :background ,(if (frame-parameter nil 'reverse)
1580 "unspecified-fg"
1581 "unspecified-bg"))))
1582 ;; For all other faces, unspecify all attributes.
1583 (apply 'append
1584 (mapcar (lambda (x) (list (car x) 'unspecified))
1585 face-attribute-name-alist)))))
1587 (defun face-spec-set (face spec &optional for-defface)
1588 "Set and apply the face spec for FACE.
1589 If the optional argument FOR-DEFFACE is omitted or nil, set the
1590 overriding spec to SPEC, recording it in the `face-override-spec'
1591 property of FACE. See `defface' for the format of SPEC.
1593 If FOR-DEFFACE is non-nil, set the base spec (the one set by
1594 `defface' and Custom). In this case, SPEC is ignored; the caller
1595 is responsible for putting the face spec in the `saved-face',
1596 `customized-face', or `face-defface-spec', as appropriate.
1598 The appearance of FACE is controlled by the base spec, by any
1599 custom theme specs on top of that, and by the overriding spec on
1600 top of all the rest."
1601 (if for-defface
1602 ;; When we reset the face based on its custom spec, then it is
1603 ;; unmodified as far as Custom is concerned.
1604 (put (or (get face 'face-alias) face) 'face-modified nil)
1605 ;; When we change a face based on a spec from outside custom,
1606 ;; record it for future frames.
1607 (put (or (get face 'face-alias) face) 'face-override-spec spec))
1608 ;; Reset each frame according to the rules implied by all its specs.
1609 (dolist (frame (frame-list))
1610 (face-spec-recalc face frame)))
1612 (defun face-spec-recalc (face frame)
1613 "Reset the face attributes of FACE on FRAME according to its specs.
1614 This applies the defface/custom spec first, then the custom theme specs,
1615 then the override spec."
1616 (face-spec-reset-face face frame)
1617 (let ((face-sym (or (get face 'face-alias) face)))
1618 (or (get face 'customized-face)
1619 (get face 'saved-face)
1620 (face-spec-set-2 face frame (face-default-spec face)))
1621 (let ((theme-faces (reverse (get face-sym 'theme-face))))
1622 (dolist (spec theme-faces)
1623 (face-spec-set-2 face frame (cadr spec))))
1624 (face-spec-set-2 face frame (get face-sym 'face-override-spec))))
1626 (defun face-spec-set-2 (face frame spec)
1627 "Set the face attributes of FACE on FRAME according to SPEC."
1628 (let* ((spec (face-spec-choose spec frame))
1629 attrs)
1630 (while spec
1631 (when (assq (car spec) face-x-resources)
1632 (push (car spec) attrs)
1633 (push (cadr spec) attrs))
1634 (setq spec (cddr spec)))
1635 (apply 'set-face-attribute face frame (nreverse attrs))))
1637 (defun face-attr-match-p (face attrs &optional frame)
1638 "Return t if attributes of FACE match values in plist ATTRS.
1639 Optional parameter FRAME is the frame whose definition of FACE
1640 is used. If nil or omitted, use the selected frame."
1641 (unless frame
1642 (setq frame (selected-frame)))
1643 (let* ((list face-attribute-name-alist)
1644 (match t)
1645 (bold (and (plist-member attrs :bold)
1646 (not (plist-member attrs :weight))))
1647 (italic (and (plist-member attrs :italic)
1648 (not (plist-member attrs :slant))))
1649 (plist (if (or bold italic)
1650 (copy-sequence attrs)
1651 attrs)))
1652 ;; Handle the Emacs 20 :bold and :italic properties.
1653 (if bold
1654 (plist-put plist :weight (if bold 'bold 'normal)))
1655 (if italic
1656 (plist-put plist :slant (if italic 'italic 'normal)))
1657 (while (and match list)
1658 (let* ((attr (caar list))
1659 (specified-value
1660 (if (plist-member plist attr)
1661 (plist-get plist attr)
1662 'unspecified))
1663 (value-now (face-attribute face attr frame)))
1664 (setq match (equal specified-value value-now))
1665 (setq list (cdr list))))
1666 match))
1668 (defsubst face-spec-match-p (face spec &optional frame)
1669 "Return t if FACE, on FRAME, matches what SPEC says it should look like."
1670 (face-attr-match-p face (face-spec-choose spec frame) frame))
1672 (defsubst face-default-spec (face)
1673 "Return the default face-spec for FACE, ignoring any user customization.
1674 If there is no default for FACE, return nil."
1675 (get face 'face-defface-spec))
1677 (defsubst face-user-default-spec (face)
1678 "Return the user's customized face-spec for FACE, or the default if none.
1679 If there is neither a user setting nor a default for FACE, return nil."
1680 (or (get face 'customized-face)
1681 (get face 'saved-face)
1682 (face-default-spec face)))
1685 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1686 ;;; Frame-type independent color support.
1687 ;;; We keep the old x-* names as aliases for back-compatibility.
1688 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1690 (defun defined-colors (&optional frame)
1691 "Return a list of colors supported for a particular frame.
1692 The argument FRAME specifies which frame to try.
1693 The value may be different for frames on different display types.
1694 If FRAME doesn't support colors, the value is nil.
1695 If FRAME is nil, that stands for the selected frame."
1696 (if (memq (framep (or frame (selected-frame))) '(x w32 ns))
1697 (xw-defined-colors frame)
1698 (mapcar 'car (tty-color-alist frame))))
1699 (defalias 'x-defined-colors 'defined-colors)
1701 (declare-function xw-color-defined-p "xfns.c" (color &optional frame))
1703 (defun color-defined-p (color &optional frame)
1704 "Return non-nil if COLOR is supported on frame FRAME.
1705 COLOR should be a string naming a color (e.g. \"white\"), or a
1706 string specifying a color's RGB components (e.g. \"#ff12ec\"), or
1707 the symbol `unspecified'.
1709 This function returns nil if COLOR is the symbol `unspecified',
1710 or one of the strings \"unspecified-fg\" or \"unspecified-bg\".
1712 If FRAME is omitted or nil, use the selected frame."
1713 (unless (member color '(unspecified "unspecified-bg" "unspecified-fg"))
1714 (if (member (framep (or frame (selected-frame))) '(x w32 ns))
1715 (xw-color-defined-p color frame)
1716 (numberp (tty-color-translate color frame)))))
1717 (defalias 'x-color-defined-p 'color-defined-p)
1719 (declare-function xw-color-values "xfns.c" (color &optional frame))
1721 (defun color-values (color &optional frame)
1722 "Return a description of the color named COLOR on frame FRAME.
1723 COLOR should be a string naming a color (e.g. \"white\"), or a
1724 string specifying a color's RGB components (e.g. \"#ff12ec\").
1726 Return a list of three integers, (RED GREEN BLUE), each between 0
1727 and either 65280 or 65535 (the maximum depends on the system).
1728 Use `color-name-to-rgb' if you want RGB floating-point values
1729 normalized to 1.0.
1731 If FRAME is omitted or nil, use the selected frame.
1732 If FRAME cannot display COLOR, the value is nil.
1734 COLOR can also be the symbol `unspecified' or one of the strings
1735 \"unspecified-fg\" or \"unspecified-bg\", in which case the
1736 return value is nil."
1737 (cond
1738 ((member color '(unspecified "unspecified-fg" "unspecified-bg"))
1739 nil)
1740 ((memq (framep (or frame (selected-frame))) '(x w32 ns))
1741 (xw-color-values color frame))
1743 (tty-color-values color frame))))
1745 (defalias 'x-color-values 'color-values)
1747 (declare-function xw-display-color-p "xfns.c" (&optional terminal))
1749 (defun display-color-p (&optional display)
1750 "Return t if DISPLAY supports color.
1751 The optional argument DISPLAY specifies which display to ask about.
1752 DISPLAY should be either a frame or a display name (a string).
1753 If omitted or nil, that stands for the selected frame's display."
1754 (if (memq (framep-on-display display) '(x w32 ns))
1755 (xw-display-color-p display)
1756 (tty-display-color-p display)))
1757 (defalias 'x-display-color-p 'display-color-p)
1759 (declare-function x-display-grayscale-p "xfns.c" (&optional terminal))
1761 (defun display-grayscale-p (&optional display)
1762 "Return non-nil if frames on DISPLAY can display shades of gray."
1763 (let ((frame-type (framep-on-display display)))
1764 (cond
1765 ((memq frame-type '(x w32 ns))
1766 (x-display-grayscale-p display))
1768 (> (tty-color-gray-shades display) 2)))))
1770 (defun read-color (&optional prompt convert-to-RGB allow-empty-name msg)
1771 "Read a color name or RGB triplet.
1772 Completion is available for color names, but not for RGB triplets.
1774 RGB triplets have the form \"#RRGGBB\". Each of the R, G, and B
1775 components can have one to four digits, but all three components
1776 must have the same number of digits. Each digit is a hex value
1777 between 0 and F; either upper case or lower case for A through F
1778 are acceptable.
1780 In addition to standard color names and RGB hex values, the
1781 following are available as color candidates. In each case, the
1782 corresponding color is used.
1784 * `foreground at point' - foreground under the cursor
1785 * `background at point' - background under the cursor
1787 Optional arg PROMPT is the prompt; if nil, use a default prompt.
1789 Interactively, or with optional arg CONVERT-TO-RGB-P non-nil,
1790 convert an input color name to an RGB hex string. Return the RGB
1791 hex string.
1793 If optional arg ALLOW-EMPTY-NAME is non-nil, the user is allowed
1794 to enter an empty color name (the empty string).
1796 Interactively, or with optional arg MSG non-nil, print the
1797 resulting color name in the echo area."
1798 (interactive "i\np\ni\np") ; Always convert to RGB interactively.
1799 (let* ((completion-ignore-case t)
1800 (colors (or facemenu-color-alist
1801 (append '("foreground at point" "background at point")
1802 (if allow-empty-name '(""))
1803 (defined-colors))))
1804 (color (completing-read
1805 (or prompt "Color (name or #RGB triplet): ")
1806 ;; Completing function for reading colors, accepting
1807 ;; both color names and RGB triplets.
1808 (lambda (string pred flag)
1809 (cond
1810 ((null flag) ; Try completion.
1811 (or (try-completion string colors pred)
1812 (if (color-defined-p string)
1813 string)))
1814 ((eq flag t) ; List all completions.
1815 (or (all-completions string colors pred)
1816 (if (color-defined-p string)
1817 (list string))))
1818 ((eq flag 'lambda) ; Test completion.
1819 (or (memq string colors)
1820 (color-defined-p string)))))
1821 nil t)))
1823 ;; Process named colors.
1824 (when (member color colors)
1825 (cond ((string-equal color "foreground at point")
1826 (setq color (foreground-color-at-point)))
1827 ((string-equal color "background at point")
1828 (setq color (background-color-at-point))))
1829 (when (and convert-to-RGB
1830 (not (string-equal color "")))
1831 (let ((components (x-color-values color)))
1832 (unless (string-match "^#\\([a-fA-F0-9][a-fA-F0-9][a-fA-F0-9]\\)+$" color)
1833 (setq color (format "#%04X%04X%04X"
1834 (logand 65535 (nth 0 components))
1835 (logand 65535 (nth 1 components))
1836 (logand 65535 (nth 2 components))))))))
1837 (when msg (message "Color: `%s'" color))
1838 color))
1841 (defun face-at-point ()
1842 "Return the face of the character after point.
1843 If it has more than one face, return the first one.
1844 Return nil if it has no specified face."
1845 (let* ((faceprop (or (get-char-property (point) 'read-face-name)
1846 (get-char-property (point) 'face)
1847 'default))
1848 (face (cond ((symbolp faceprop) faceprop)
1849 ;; List of faces (don't treat an attribute spec).
1850 ;; Just use the first face.
1851 ((and (consp faceprop) (not (keywordp (car faceprop)))
1852 (not (memq (car faceprop)
1853 '(foreground-color background-color))))
1854 (car faceprop))
1855 (t nil)))) ; Invalid face value.
1856 (if (facep face) face nil)))
1858 (defun foreground-color-at-point ()
1859 "Return the foreground color of the character after point."
1860 ;; `face-at-point' alone is not sufficient. It only gets named faces.
1861 ;; Need also pick up any face properties that are not associated with named faces.
1862 (let ((face (or (face-at-point)
1863 (get-char-property (point) 'read-face-name)
1864 (get-char-property (point) 'face))))
1865 (cond ((and face (symbolp face))
1866 (let ((value (face-foreground face nil 'default)))
1867 (if (member value '("unspecified-fg" "unspecified-bg"))
1869 value)))
1870 ((consp face)
1871 (cond ((memq 'foreground-color face) (cdr (memq 'foreground-color face)))
1872 ((memq ':foreground face) (cadr (memq ':foreground face)))))
1873 (t nil)))) ; Invalid face value.
1875 (defun background-color-at-point ()
1876 "Return the background color of the character after point."
1877 ;; `face-at-point' alone is not sufficient. It only gets named faces.
1878 ;; Need also pick up any face properties that are not associated with named faces.
1879 (let ((face (or (face-at-point)
1880 (get-char-property (point) 'read-face-name)
1881 (get-char-property (point) 'face))))
1882 (cond ((and face (symbolp face))
1883 (let ((value (face-background face nil 'default)))
1884 (if (member value '("unspecified-fg" "unspecified-bg"))
1886 value)))
1887 ((consp face)
1888 (cond ((memq 'background-color face) (cdr (memq 'background-color face)))
1889 ((memq ':background face) (cadr (memq ':background face)))))
1890 (t nil)))) ; Invalid face value.
1893 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1894 ;;; Frame creation.
1895 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1897 (declare-function x-parse-geometry "frame.c" (string))
1898 (defvar x-display-name)
1900 (defun x-handle-named-frame-geometry (parameters)
1901 "Add geometry parameters for a named frame to parameter list PARAMETERS.
1902 Value is the new parameter list."
1903 ;; Note that `x-resource-name' has a global meaning.
1904 (let ((x-resource-name (cdr (assq 'name parameters))))
1905 (when x-resource-name
1906 ;; Before checking X resources, we must have an X connection.
1907 (or (window-system)
1908 (x-display-list)
1909 (x-open-connection (or (cdr (assq 'display parameters))
1910 x-display-name)))
1911 (let (res-geometry parsed)
1912 (and (setq res-geometry (x-get-resource "geometry" "Geometry"))
1913 (setq parsed (x-parse-geometry res-geometry))
1914 (setq parameters
1915 (append parameters parsed
1916 ;; If the resource specifies a position,
1917 ;; take note of that.
1918 (if (or (assq 'top parsed) (assq 'left parsed))
1919 '((user-position . t) (user-size . t)))))))))
1920 parameters)
1923 (defun x-handle-reverse-video (frame parameters)
1924 "Handle the reverse-video frame parameter and X resource.
1925 `x-create-frame' does not handle this one."
1926 (when (cdr (or (assq 'reverse parameters)
1927 (let ((resource (x-get-resource "reverseVideo"
1928 "ReverseVideo")))
1929 (if resource
1930 (cons nil (member (downcase resource)
1931 '("on" "true")))))))
1932 (let* ((params (frame-parameters frame))
1933 (bg (cdr (assq 'foreground-color params)))
1934 (fg (cdr (assq 'background-color params))))
1935 (modify-frame-parameters frame
1936 (list (cons 'foreground-color fg)
1937 (cons 'background-color bg)))
1938 (if (equal bg (cdr (assq 'border-color params)))
1939 (modify-frame-parameters frame
1940 (list (cons 'border-color fg))))
1941 (if (equal bg (cdr (assq 'mouse-color params)))
1942 (modify-frame-parameters frame
1943 (list (cons 'mouse-color fg))))
1944 (if (equal bg (cdr (assq 'cursor-color params)))
1945 (modify-frame-parameters frame
1946 (list (cons 'cursor-color fg)))))))
1948 (declare-function x-create-frame "xfns.c" (parms))
1949 (declare-function x-setup-function-keys "term/common-win" (frame))
1951 (defun x-create-frame-with-faces (&optional parameters)
1952 "Create and return a frame with frame parameters PARAMETERS.
1953 If PARAMETERS specify a frame name, handle X geometry resources
1954 for that name. If PARAMETERS includes a `reverse' parameter, or
1955 the X resource ``reverseVideo'' is present, handle that."
1956 (setq parameters (x-handle-named-frame-geometry parameters))
1957 (let* ((params (copy-tree parameters))
1958 (visibility-spec (assq 'visibility parameters))
1959 (delayed-params '(foreground-color background-color font
1960 border-color cursor-color mouse-color
1961 visibility scroll-bar-foreground
1962 scroll-bar-background))
1963 frame success)
1964 (dolist (param delayed-params)
1965 (setq params (assq-delete-all param params)))
1966 (setq frame (x-create-frame `((visibility . nil) . ,params)))
1967 (unwind-protect
1968 (progn
1969 (x-setup-function-keys frame)
1970 (x-handle-reverse-video frame parameters)
1971 (frame-set-background-mode frame t)
1972 (face-set-after-frame-default frame parameters)
1973 (if (null visibility-spec)
1974 (make-frame-visible frame)
1975 (modify-frame-parameters frame (list visibility-spec)))
1976 (setq success t))
1977 (unless success
1978 (delete-frame frame)))
1979 frame))
1981 (defun face-set-after-frame-default (frame &optional parameters)
1982 "Initialize the frame-local faces of FRAME.
1983 Calculate the face definitions using the face specs, custom theme
1984 settings, X resources, and `face-new-frame-defaults'.
1985 Finally, apply any relevant face attributes found amongst the
1986 frame parameters in PARAMETERS."
1987 (let ((window-system-p (memq (window-system frame) '(x w32))))
1988 ;; The `reverse' is so that `default' goes first.
1989 (dolist (face (nreverse (face-list)))
1990 (condition-case ()
1991 (progn
1992 ;; Initialize faces from face spec and custom theme.
1993 (face-spec-recalc face frame)
1994 ;; X resources for the default face are applied during
1995 ;; `x-create-frame'.
1996 (and (not (eq face 'default)) window-system-p
1997 (make-face-x-resource-internal face frame))
1998 ;; Apply attributes specified by face-new-frame-defaults
1999 (internal-merge-in-global-face face frame))
2000 ;; Don't let invalid specs prevent frame creation.
2001 (error nil))))
2003 ;; Apply attributes specified by frame parameters.
2004 (let ((face-params '((foreground-color default :foreground)
2005 (background-color default :background)
2006 (font default :font)
2007 (border-color border :background)
2008 (cursor-color cursor :background)
2009 (scroll-bar-foreground scroll-bar :foreground)
2010 (scroll-bar-background scroll-bar :background)
2011 (mouse-color mouse :background))))
2012 (dolist (param face-params)
2013 (let* ((param-name (nth 0 param))
2014 (value (cdr (assq param-name parameters))))
2015 (if value
2016 (set-face-attribute (nth 1 param) frame
2017 (nth 2 param) value))))))
2019 (defun tty-handle-reverse-video (frame parameters)
2020 "Handle the reverse-video frame parameter for terminal frames."
2021 (when (cdr (assq 'reverse parameters))
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 'mouse-color params)))
2029 (modify-frame-parameters frame
2030 (list (cons 'mouse-color fg))))
2031 (if (equal bg (cdr (assq 'cursor-color params)))
2032 (modify-frame-parameters frame
2033 (list (cons 'cursor-color fg)))))))
2036 (defun tty-create-frame-with-faces (&optional parameters)
2037 "Create and return a frame from optional frame parameters PARAMETERS.
2038 If PARAMETERS contains a `reverse' parameter, handle that."
2039 (let ((frame (make-terminal-frame parameters))
2040 success)
2041 (unwind-protect
2042 (with-selected-frame frame
2043 (tty-handle-reverse-video frame (frame-parameters frame))
2045 (unless (terminal-parameter frame 'terminal-initted)
2046 (set-terminal-parameter frame 'terminal-initted t)
2047 (set-locale-environment nil frame)
2048 (tty-run-terminal-initialization frame))
2049 (frame-set-background-mode frame t)
2050 (face-set-after-frame-default frame parameters)
2051 (setq success t))
2052 (unless success
2053 (delete-frame frame)))
2054 frame))
2056 (defun tty-find-type (pred type)
2057 "Return the longest prefix of TYPE to which PRED returns non-nil.
2058 TYPE should be a tty type name such as \"xterm-16color\".
2060 The function tries only those prefixes that are followed by a
2061 dash or underscore in the original type name, like \"xterm\" in
2062 the above example."
2063 (let (hyphend)
2064 (while (and type
2065 (not (funcall pred type)))
2066 ;; Strip off last hyphen and what follows, then try again
2067 (setq type
2068 (if (setq hyphend (string-match "[-_][^-_]+$" type))
2069 (substring type 0 hyphend)
2070 nil))))
2071 type)
2073 (defun tty-run-terminal-initialization (frame &optional type)
2074 "Run the special initialization code for the terminal type of FRAME.
2075 The optional TYPE parameter may be used to override the autodetected
2076 terminal type to a different value."
2077 (setq type (or type (tty-type frame)))
2078 ;; Load library for our terminal type.
2079 ;; User init file can set term-file-prefix to nil to prevent this.
2080 (with-selected-frame frame
2081 (unless (null term-file-prefix)
2082 (let* (term-init-func)
2083 ;; First, load the terminal initialization file, if it is
2084 ;; available and it hasn't been loaded already.
2085 (tty-find-type #'(lambda (type)
2086 (let ((file (locate-library (concat term-file-prefix type))))
2087 (and file
2088 (or (assoc file load-history)
2089 (load file t t)))))
2090 type)
2091 ;; Next, try to find a matching initialization function, and call it.
2092 (tty-find-type #'(lambda (type)
2093 (fboundp (setq term-init-func
2094 (intern (concat "terminal-init-" type)))))
2095 type)
2096 (when (fboundp term-init-func)
2097 (funcall term-init-func))
2098 (set-terminal-parameter frame 'terminal-initted term-init-func)))))
2100 ;; Called from C function init_display to initialize faces of the
2101 ;; dumped terminal frame on startup.
2103 (defun tty-set-up-initial-frame-faces ()
2104 (let ((frame (selected-frame)))
2105 (frame-set-background-mode frame t)
2106 (face-set-after-frame-default frame)))
2110 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2111 ;;; Standard faces.
2112 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2114 (defgroup basic-faces nil
2115 "The standard faces of Emacs."
2116 :group 'faces)
2118 (defface default
2119 '((t nil)) ; If this were nil, face-defface-spec would not be set.
2120 "Basic default face."
2121 :group 'basic-faces)
2123 (defface bold
2124 '((t :weight bold))
2125 "Basic bold face."
2126 :group 'basic-faces)
2128 (defface italic
2129 '((((supports :slant italic))
2130 :slant italic)
2131 (((supports :underline t))
2132 :underline t)
2134 ;; Default to italic, even if it doesn't appear to be supported,
2135 ;; because in some cases the display engine will do its own
2136 ;; workaround (to `dim' on ttys).
2137 :slant italic))
2138 "Basic italic face."
2139 :group 'basic-faces)
2141 (defface bold-italic
2142 '((t :weight bold :slant italic))
2143 "Basic bold-italic face."
2144 :group 'basic-faces)
2146 (defface underline
2147 '((((supports :underline t))
2148 :underline t)
2149 (((supports :weight bold))
2150 :weight bold)
2151 (t :underline t))
2152 "Basic underlined face."
2153 :group 'basic-faces)
2155 (defface fixed-pitch
2156 '((t :family "Monospace"))
2157 "The basic fixed-pitch face."
2158 :group 'basic-faces)
2160 (defface variable-pitch
2161 '((t :family "Sans Serif"))
2162 "The basic variable-pitch face."
2163 :group 'basic-faces)
2165 (defface shadow
2166 '((((class color grayscale) (min-colors 88) (background light))
2167 :foreground "grey50")
2168 (((class color grayscale) (min-colors 88) (background dark))
2169 :foreground "grey70")
2170 (((class color) (min-colors 8) (background light))
2171 :foreground "green")
2172 (((class color) (min-colors 8) (background dark))
2173 :foreground "yellow"))
2174 "Basic face for shadowed text."
2175 :group 'basic-faces
2176 :version "22.1")
2178 (defface link
2179 '((((class color) (min-colors 88) (background light))
2180 :foreground "RoyalBlue3" :underline t)
2181 (((class color) (background light))
2182 :foreground "blue" :underline t)
2183 (((class color) (min-colors 88) (background dark))
2184 :foreground "cyan1" :underline t)
2185 (((class color) (background dark))
2186 :foreground "cyan" :underline t)
2187 (t :inherit underline))
2188 "Basic face for unvisited links."
2189 :group 'basic-faces
2190 :version "22.1")
2192 (defface link-visited
2193 '((default :inherit link)
2194 (((class color) (background light)) :foreground "magenta4")
2195 (((class color) (background dark)) :foreground "violet"))
2196 "Basic face for visited links."
2197 :group 'basic-faces
2198 :version "22.1")
2200 (defface highlight
2201 '((((class color) (min-colors 88) (background light))
2202 :background "darkseagreen2")
2203 (((class color) (min-colors 88) (background dark))
2204 :background "darkolivegreen")
2205 (((class color) (min-colors 16) (background light))
2206 :background "darkseagreen2")
2207 (((class color) (min-colors 16) (background dark))
2208 :background "darkolivegreen")
2209 (((class color) (min-colors 8))
2210 :background "green" :foreground "black")
2211 (t :inverse-video t))
2212 "Basic face for highlighting."
2213 :group 'basic-faces)
2215 ;; Region face: under NS, default to the system-defined selection
2216 ;; color (optimized for the fixed white background of other apps),
2217 ;; if background is light.
2218 (defface region
2219 '((((class color) (min-colors 88) (background dark))
2220 :background "blue3")
2221 (((class color) (min-colors 88) (background light) (type gtk))
2222 :foreground "gtk_selection_fg_color"
2223 :background "gtk_selection_bg_color")
2224 (((class color) (min-colors 88) (background light) (type ns))
2225 :background "ns_selection_color")
2226 (((class color) (min-colors 88) (background light))
2227 :background "lightgoldenrod2")
2228 (((class color) (min-colors 16) (background dark))
2229 :background "blue3")
2230 (((class color) (min-colors 16) (background light))
2231 :background "lightgoldenrod2")
2232 (((class color) (min-colors 8))
2233 :background "blue" :foreground "white")
2234 (((type tty) (class mono))
2235 :inverse-video t)
2236 (t :background "gray"))
2237 "Basic face for highlighting the region."
2238 :version "21.1"
2239 :group 'basic-faces)
2241 (defface secondary-selection
2242 '((((class color) (min-colors 88) (background light))
2243 :background "yellow1")
2244 (((class color) (min-colors 88) (background dark))
2245 :background "SkyBlue4")
2246 (((class color) (min-colors 16) (background light))
2247 :background "yellow")
2248 (((class color) (min-colors 16) (background dark))
2249 :background "SkyBlue4")
2250 (((class color) (min-colors 8))
2251 :background "cyan" :foreground "black")
2252 (t :inverse-video t))
2253 "Basic face for displaying the secondary selection."
2254 :group 'basic-faces)
2256 (defface trailing-whitespace
2257 '((((class color) (background light))
2258 :background "red1")
2259 (((class color) (background dark))
2260 :background "red1")
2261 (t :inverse-video t))
2262 "Basic face for highlighting trailing whitespace."
2263 :version "21.1"
2264 :group 'whitespace-faces ; like `show-trailing-whitespace'
2265 :group 'basic-faces)
2267 (defface escape-glyph
2268 '((((background dark)) :foreground "cyan")
2269 ;; See the comment in minibuffer-prompt for
2270 ;; the reason not to use blue on MS-DOS.
2271 (((type pc)) :foreground "magenta")
2272 ;; red4 is too dark, but some say blue is too loud.
2273 ;; brown seems to work ok. -- rms.
2274 (t :foreground "brown"))
2275 "Face for characters displayed as sequences using `^' or `\\'."
2276 :group 'basic-faces
2277 :version "22.1")
2279 (defface nobreak-space
2280 '((((class color) (min-colors 88)) :inherit escape-glyph :underline t)
2281 (((class color) (min-colors 8)) :background "magenta")
2282 (t :inverse-video t))
2283 "Face for displaying nobreak space."
2284 :group 'basic-faces
2285 :version "22.1")
2287 (defgroup mode-line-faces nil
2288 "Faces used in the mode line."
2289 :group 'mode-line
2290 :group 'faces
2291 :version "22.1")
2293 (defface mode-line
2294 '((((class color) (min-colors 88))
2295 :box (:line-width -1 :style released-button)
2296 :background "grey75" :foreground "black")
2298 :inverse-video t))
2299 "Basic mode line face for selected window."
2300 :version "21.1"
2301 :group 'mode-line-faces
2302 :group 'basic-faces)
2304 (defface mode-line-inactive
2305 '((default
2306 :inherit mode-line)
2307 (((class color) (min-colors 88) (background light))
2308 :weight light
2309 :box (:line-width -1 :color "grey75" :style nil)
2310 :foreground "grey20" :background "grey90")
2311 (((class color) (min-colors 88) (background dark) )
2312 :weight light
2313 :box (:line-width -1 :color "grey40" :style nil)
2314 :foreground "grey80" :background "grey30"))
2315 "Basic mode line face for non-selected windows."
2316 :version "22.1"
2317 :group 'mode-line-faces
2318 :group 'basic-faces)
2319 (define-obsolete-face-alias 'modeline-inactive 'mode-line-inactive "22.1")
2321 (defface mode-line-highlight
2322 '((((class color) (min-colors 88))
2323 :box (:line-width 2 :color "grey40" :style released-button))
2325 :inherit highlight))
2326 "Basic mode line face for highlighting."
2327 :version "22.1"
2328 :group 'mode-line-faces
2329 :group 'basic-faces)
2330 (define-obsolete-face-alias 'modeline-highlight 'mode-line-highlight "22.1")
2332 (defface mode-line-emphasis
2333 '((t (:weight bold)))
2334 "Face used to emphasize certain mode line features.
2335 Use the face `mode-line-highlight' for features that can be selected."
2336 :version "23.1"
2337 :group 'mode-line-faces
2338 :group 'basic-faces)
2340 (defface mode-line-buffer-id
2341 '((t (:weight bold)))
2342 "Face used for buffer identification parts of the mode line."
2343 :version "22.1"
2344 :group 'mode-line-faces
2345 :group 'basic-faces)
2346 (define-obsolete-face-alias 'modeline-buffer-id 'mode-line-buffer-id "22.1")
2348 (defface header-line
2349 '((default
2350 :inherit mode-line)
2351 (((type tty))
2352 ;; This used to be `:inverse-video t', but that doesn't look very
2353 ;; good when combined with inverse-video mode-lines and multiple
2354 ;; windows. Underlining looks better, and is more consistent with
2355 ;; the window-system face variants, which deemphasize the
2356 ;; header-line in relation to the mode-line face. If a terminal
2357 ;; can't underline, then the header-line will end up without any
2358 ;; highlighting; this may be too confusing in general, although it
2359 ;; happens to look good with the only current use of header-lines,
2360 ;; the info browser. XXX
2361 :inverse-video nil ;Override the value inherited from mode-line.
2362 :underline t)
2363 (((class color grayscale) (background light))
2364 :background "grey90" :foreground "grey20"
2365 :box nil)
2366 (((class color grayscale) (background dark))
2367 :background "grey20" :foreground "grey90"
2368 :box nil)
2369 (((class mono) (background light))
2370 :background "white" :foreground "black"
2371 :inverse-video nil
2372 :box nil
2373 :underline t)
2374 (((class mono) (background dark))
2375 :background "black" :foreground "white"
2376 :inverse-video nil
2377 :box nil
2378 :underline t))
2379 "Basic header-line face."
2380 :version "21.1"
2381 :group 'basic-faces)
2383 (defface vertical-border
2384 '((((type tty)) :inherit mode-line-inactive))
2385 "Face used for vertical window dividers on ttys."
2386 :version "22.1"
2387 :group 'basic-faces)
2389 (defface minibuffer-prompt
2390 '((((background dark)) :foreground "cyan")
2391 ;; Don't use blue because many users of the MS-DOS port customize
2392 ;; their foreground color to be blue.
2393 (((type pc)) :foreground "magenta")
2394 (t :foreground "medium blue"))
2395 "Face for minibuffer prompts.
2396 By default, Emacs automatically adds this face to the value of
2397 `minibuffer-prompt-properties', which is a list of text properties
2398 used to display the prompt text."
2399 :version "22.1"
2400 :group 'basic-faces)
2402 (setq minibuffer-prompt-properties
2403 (append minibuffer-prompt-properties (list 'face 'minibuffer-prompt)))
2405 (defface fringe
2406 '((((class color) (background light))
2407 :background "grey95")
2408 (((class color) (background dark))
2409 :background "grey10")
2411 :background "gray"))
2412 "Basic face for the fringes to the left and right of windows under X."
2413 :version "21.1"
2414 :group 'frames
2415 :group 'basic-faces)
2417 (defface scroll-bar '((t nil))
2418 "Basic face for the scroll bar colors under X."
2419 :version "21.1"
2420 :group 'frames
2421 :group 'basic-faces)
2423 (defface border '((t nil))
2424 "Basic face for the frame border under X."
2425 :version "21.1"
2426 :group 'frames
2427 :group 'basic-faces)
2429 (defface cursor
2430 '((((background light)) :background "black")
2431 (((background dark)) :background "white"))
2432 "Basic face for the cursor color under X.
2433 Currently, only the `:background' attribute is meaningful; all
2434 other attributes are ignored. The cursor foreground color is
2435 taken from the background color of the underlying text.
2437 Note: Other faces cannot inherit from the cursor face."
2438 :version "21.1"
2439 :group 'cursor
2440 :group 'basic-faces)
2442 (put 'cursor 'face-no-inherit t)
2444 (defface mouse '((t nil))
2445 "Basic face for the mouse color under X."
2446 :version "21.1"
2447 :group 'mouse
2448 :group 'basic-faces)
2450 (defface tool-bar
2451 '((default
2452 :box (:line-width 1 :style released-button)
2453 :foreground "black")
2454 (((type x w32 ns) (class color))
2455 :background "grey75")
2456 (((type x) (class mono))
2457 :background "grey"))
2458 "Basic tool-bar face."
2459 :version "21.1"
2460 :group 'basic-faces)
2462 (defface menu
2463 '((((type tty))
2464 :inverse-video t)
2465 (((type x-toolkit))
2468 :inverse-video t))
2469 "Basic face for the font and colors of the menu bar and popup menus."
2470 :version "21.1"
2471 :group 'menu
2472 :group 'basic-faces)
2474 (defface help-argument-name '((t :inherit italic))
2475 "Face to highlight argument names in *Help* buffers."
2476 :group 'help)
2478 (defface glyphless-char
2479 '((((type tty)) :inherit underline)
2480 (((type pc)) :inherit escape-glyph)
2481 (t :height 0.6))
2482 "Face for displaying non-graphic characters (e.g. U+202A (LRE)).
2483 It is used for characters of no fonts too."
2484 :version "24.1"
2485 :group 'basic-faces)
2487 (defface error
2488 '((default :weight bold)
2489 (((class color) (min-colors 88) (background light)) :foreground "Red1")
2490 (((class color) (min-colors 88) (background dark)) :foreground "Pink")
2491 (((class color) (min-colors 16) (background light)) :foreground "Red1")
2492 (((class color) (min-colors 16) (background dark)) :foreground "Pink")
2493 (((class color) (min-colors 8)) :foreground "red")
2494 (t :inverse-video t))
2495 "Basic face used to highlight errors and to denote failure."
2496 :version "24.1"
2497 :group 'basic-faces)
2499 (defface warning
2500 '((default :weight bold)
2501 (((class color) (min-colors 16)) :foreground "DarkOrange")
2502 (((class color)) :foreground "yellow"))
2503 "Basic face used to highlight warnings."
2504 :version "24.1"
2505 :group 'basic-faces)
2507 (defface success
2508 '((default :weight bold)
2509 (((class color) (min-colors 16) (background light)) :foreground "ForestGreen")
2510 (((class color) (min-colors 88) (background dark)) :foreground "Green1")
2511 (((class color) (min-colors 16) (background dark)) :foreground "Green")
2512 (((class color)) :foreground "green"))
2513 "Basic face used to indicate successful operation."
2514 :version "24.1"
2515 :group 'basic-faces)
2518 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2519 ;;; Manipulating font names.
2520 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2522 ;; This is here for compatibility with Emacs 20.2. For example,
2523 ;; international/fontset.el uses x-resolve-font-name. The following
2524 ;; functions are not used in the face implementation itself.
2526 (defvar x-font-regexp nil)
2527 (defvar x-font-regexp-head nil)
2528 (defvar x-font-regexp-weight nil)
2529 (defvar x-font-regexp-slant nil)
2531 (defconst x-font-regexp-weight-subnum 1)
2532 (defconst x-font-regexp-slant-subnum 2)
2533 (defconst x-font-regexp-swidth-subnum 3)
2534 (defconst x-font-regexp-adstyle-subnum 4)
2536 ;;; Regexps matching font names in "Host Portable Character Representation."
2538 (let ((- "[-?]")
2539 (foundry "[^-]+")
2540 (family "[^-]+")
2541 (weight "\\(bold\\|demibold\\|medium\\)") ; 1
2542 ; (weight\? "\\(\\*\\|bold\\|demibold\\|medium\\|\\)") ; 1
2543 (weight\? "\\([^-]*\\)") ; 1
2544 (slant "\\([ior]\\)") ; 2
2545 ; (slant\? "\\([ior?*]?\\)") ; 2
2546 (slant\? "\\([^-]?\\)") ; 2
2547 ; (swidth "\\(\\*\\|normal\\|semicondensed\\|\\)") ; 3
2548 (swidth "\\([^-]*\\)") ; 3
2549 ; (adstyle "\\(\\*\\|sans\\|\\)") ; 4
2550 (adstyle "\\([^-]*\\)") ; 4
2551 (pixelsize "[0-9]+")
2552 (pointsize "[0-9][0-9]+")
2553 (resx "[0-9][0-9]+")
2554 (resy "[0-9][0-9]+")
2555 (spacing "[cmp?*]")
2556 (avgwidth "[0-9]+")
2557 (registry "[^-]+")
2558 (encoding "[^-]+")
2560 (setq x-font-regexp
2561 (purecopy (concat "\\`\\*?[-?*]"
2562 foundry - family - weight\? - slant\? - swidth - adstyle -
2563 pixelsize - pointsize - resx - resy - spacing - avgwidth -
2564 registry - encoding "\\*?\\'"
2566 (setq x-font-regexp-head
2567 (purecopy (concat "\\`[-?*]" foundry - family - weight\? - slant\?
2568 "\\([-*?]\\|\\'\\)")))
2569 (setq x-font-regexp-slant (purecopy (concat - slant -)))
2570 (setq x-font-regexp-weight (purecopy (concat - weight -)))
2571 nil)
2574 (defun x-resolve-font-name (pattern &optional face frame)
2575 "Return a font name matching PATTERN.
2576 All wildcards in PATTERN are instantiated.
2577 If PATTERN is nil, return the name of the frame's base font, which never
2578 contains wildcards.
2579 Given optional arguments FACE and FRAME, return a font which is
2580 also the same size as FACE on FRAME, or fail."
2581 (or (symbolp face)
2582 (setq face (face-name face)))
2583 (and (eq frame t)
2584 (setq frame nil))
2585 (if pattern
2586 ;; Note that x-list-fonts has code to handle a face with nil as its font.
2587 (let ((fonts (x-list-fonts pattern face frame 1)))
2588 (or fonts
2589 (if face
2590 (if (string-match "\\*" pattern)
2591 (if (null (face-font face))
2592 (error "No matching fonts are the same height as the frame default font")
2593 (error "No matching fonts are the same height as face `%s'" face))
2594 (if (null (face-font face))
2595 (error "Height of font `%s' doesn't match the frame default font"
2596 pattern)
2597 (error "Height of font `%s' doesn't match face `%s'"
2598 pattern face)))
2599 (error "No fonts match `%s'" pattern)))
2600 (car fonts))
2601 (cdr (assq 'font (frame-parameters (selected-frame))))))
2603 (defcustom font-list-limit 100
2604 "This variable is obsolete and has no effect."
2605 :type 'integer
2606 :group 'display)
2607 (make-obsolete-variable 'font-list-limit nil "24.3")
2609 (provide 'faces)
2611 ;;; faces.el ends here