* doc/lispref/keymaps.texi (Key Sequences): Avoid referring to Edit Macro mode.
[bpt/emacs.git] / lisp / faces.el
CommitLineData
5f5c8ee5 1;;; faces.el --- Lisp faces
465fceed 2
acaf905b 3;; Copyright (C) 1992-1996, 1998-2012 Free Software Foundation, Inc.
465fceed 4
6228c05b 5;; Maintainer: FSF
30764597 6;; Keywords: internal
bd78fa1d 7;; Package: emacs
6228c05b 8
465fceed
ER
9;; This file is part of GNU Emacs.
10
eb3fa2cf 11;; GNU Emacs is free software: you can redistribute it and/or modify
465fceed 12;; it under the terms of the GNU General Public License as published by
eb3fa2cf
GM
13;; the Free Software Foundation, either version 3 of the License, or
14;; (at your option) any later version.
465fceed
ER
15
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.
20
21;; You should have received a copy of the GNU General Public License
eb3fa2cf 22;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
465fceed
ER
23
24;;; Commentary:
25
465fceed
ER
26;;; Code:
27
f18b81e6
GM
28(defcustom term-file-prefix (purecopy "term/")
29 "If non-nil, Emacs startup performs terminal-specific initialization.
30It does this by: (load (concat term-file-prefix (getenv \"TERM\")))
31
32You may set this variable to nil in your init file if you do not wish
33the 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)
37
c8ccffb1 38(declare-function xw-defined-colors "term/common-win" (&optional frame))
5f5c8ee5 39
b782a458 40(defvar help-xref-stack-item)
2aef0850
JL
41
42(defvar face-name-history nil
43 "History list for some commands that read face names.
44Maximum length of the history list is determined by the value
45of `history-length', which see.")
46
5f5c8ee5
GM
47\f
48;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
49;;; Font selection.
50;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
51
52(defgroup font-selection nil
53 "Influencing face font selection."
54 :group 'faces)
55
56
57(defcustom face-font-selection-order
58 '(:width :height :weight :slant)
9201cc28 59 "A list specifying how face font selection chooses fonts.
5f5c8ee5
GM
60Each of the four symbols `:width', `:height', `:weight', and `:slant'
61must appear once in the list, and the list must not contain any other
7c626e9d 62elements. Font selection first tries to find a best matching font
b73f65b6 63for those face attributes that appear before in the list. For
5f5c8ee5
GM
64example, if `:slant' appears before `:height', font selection first
65tries to find a font with a suitable slant, even if this results in
66a font height that isn't optimal."
239ad97f 67 :tag "Font selection order"
94354bdd 68 :type '(list symbol symbol symbol symbol)
5f5c8ee5
GM
69 :group 'font-selection
70 :set #'(lambda (symbol value)
71 (set-default symbol value)
72 (internal-set-font-selection-order value)))
73
18f1dcb4 74
ed008205 75;; In the absence of Fontconfig support, Monospace and Sans Serif are
80073c33
CY
76;; unavailable, and we fall back on the courier and helv families,
77;; which are generally available.
5f5c8ee5 78(defcustom face-font-family-alternatives
1e8780b1 79 (mapcar (lambda (arg) (mapcar 'purecopy arg))
d5f57335 80 '(("Monospace" "courier" "fixed")
f37a389e 81 ("courier" "CMU Typewriter Text" "fixed")
ed008205 82 ("Sans Serif" "helv" "helvetica" "arial" "fixed")
1e8780b1 83 ("helv" "helvetica" "arial" "fixed")))
9201cc28 84 "Alist of alternative font family names.
86886bce 85Each element has the form (FAMILY ALTERNATIVE1 ALTERNATIVE2 ...).
5f5c8ee5
GM
86If fonts of family FAMILY can't be loaded, try ALTERNATIVE1, then
87ALTERNATIVE2 etc."
239ad97f 88 :tag "Alternative font families to try"
94354bdd 89 :type '(repeat (repeat string))
5f5c8ee5
GM
90 :group 'font-selection
91 :set #'(lambda (symbol value)
92 (set-default symbol value)
93 (internal-set-alternative-font-family-alist value)))
94
95
18f1dcb4
GM
96;; This is defined originally in xfaces.c.
97(defcustom face-font-registry-alternatives
1e8780b1 98 (mapcar (lambda (arg) (mapcar 'purecopy arg))
0fda9b75 99 (if (featurep 'w32)
990d68dd 100 '(("iso8859-1" "ms-oemlatin")
e38c812e 101 ("gb2312.1980" "gb2312" "gbk" "gb18030")
c97db4e4
AI
102 ("jisx0208.1990" "jisx0208.1983" "jisx0208.1978")
103 ("ksc5601.1989" "ksx1001.1992" "ksc5601.1987")
104 ("muletibetan-2" "muletibetan-0"))
e38c812e 105 '(("gb2312.1980" "gb2312.80&gb8565.88" "gbk" "gb18030")
c97db4e4
AI
106 ("jisx0208.1990" "jisx0208.1983" "jisx0208.1978")
107 ("ksc5601.1989" "ksx1001.1992" "ksc5601.1987")
1e8780b1 108 ("muletibetan-2" "muletibetan-0"))))
9201cc28 109 "Alist of alternative font registry names.
86886bce 110Each element has the form (REGISTRY ALTERNATIVE1 ALTERNATIVE2 ...).
8ac2d32f
KH
111If fonts of registry REGISTRY can be loaded, font selection
112tries to find a best matching font among all fonts of registry
113REGISTRY, ALTERNATIVE1, ALTERNATIVE2, and etc."
239ad97f 114 :tag "Alternative font registries to try"
18f1dcb4 115 :type '(repeat (repeat string))
f676894c 116 :version "21.1"
18f1dcb4
GM
117 :group 'font-selection
118 :set #'(lambda (symbol value)
119 (set-default symbol value)
120 (internal-set-alternative-font-registry-alist value)))
121
bdda3754 122\f
5f5c8ee5
GM
123;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
124;;; Creation, copying.
125;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
126
127
128(defun face-list ()
94ab793f 129 "Return a list of all defined faces."
5f5c8ee5
GM
130 (mapcar #'car face-new-frame-defaults))
131
5f5c8ee5
GM
132(defun make-face (face &optional no-init-from-resources)
133 "Define a new face with name FACE, a symbol.
fb5b8aca
CY
134Do not call this directly from Lisp code; use `defface' instead.
135
136If NO-INIT-FROM-RESOURCES is non-nil, don't initialize face
137attributes from X resources. If FACE is already known as a face,
138leave it unmodified. Return FACE."
2aef0850
JL
139 (interactive (list (read-from-minibuffer
140 "Make face: " nil nil t 'face-name-history)))
5f5c8ee5
GM
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)
152
5f5c8ee5
GM
153(defun make-empty-face (face)
154 "Define a new, empty face with name FACE.
fb5b8aca 155Do not call this directly from Lisp code; use `defface' instead."
2aef0850
JL
156 (interactive (list (read-from-minibuffer
157 "Make empty face: " nil nil t 'face-name-history)))
5f5c8ee5
GM
158 (make-face face 'no-init-from-resources))
159
5f5c8ee5 160(defun copy-face (old-face new-face &optional frame new-frame)
fb5b8aca
CY
161 "Define a face named NEW-FACE, which is a copy of OLD-FACE.
162This function does not copy face customization data, so NEW-FACE
163will not be made customizable. Most Lisp code should not call
164this function; use `defface' with :inherit instead.
165
166If NEW-FACE already exists as a face, modify it to be like
167OLD-FACE. If NEW-FACE doesn't already exist, create it.
168
169If the optional argument FRAME is a frame, change NEW-FACE on
170FRAME only. If FRAME is t, copy the frame-independent default
171specification for OLD-FACE to NEW-FACE. If FRAME is nil, copy
172the defaults as well as the faces on each existing frame.
173
174If the optional fourth argument NEW-FRAME is given, copy the
175information from face OLD-FACE on frame FRAME to NEW-FACE on
176frame NEW-FRAME. In this case, FRAME must not be nil."
5f5c8ee5
GM
177 (let ((inhibit-quit t))
178 (if (null frame)
179 (progn
341a1bfb
RS
180 (when new-frame
181 (error "Copying face %s from all frames to one frame"
182 old-face))
183 (make-empty-face new-face)
5f5c8ee5
GM
184 (dolist (frame (frame-list))
185 (copy-face old-face new-face frame))
186 (copy-face old-face new-face t))
341a1bfb 187 (make-empty-face new-face)
5f5c8ee5
GM
188 (internal-copy-lisp-face old-face new-face frame new-frame))
189 new-face))
190
5f5c8ee5
GM
191\f
192;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
193;;; Predicates, type checks.
194;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
195
196(defun facep (face)
20d29b0b
RS
197 "Return non-nil if FACE is a face name; nil otherwise.
198A face name can be a string or a symbol."
5f5c8ee5
GM
199 (internal-lisp-face-p face))
200
201
202(defun check-face (face)
203 "Signal an error if FACE doesn't name a face.
204Value is FACE."
205 (unless (facep face)
206 (error "Not a face: %s" face))
207 face)
208
209
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.
213
06b60517 214(defun face-id (face &optional _frame)
2df447f2 215 "Return the internal ID of face with name FACE.
b2d5aa46 216If FACE is a face-alias, return the ID of the target face.
9ae89a1a
RS
217The optional argument FRAME is ignored, since the internal face ID
218of a face name is the same for all frames."
5f5c8ee5 219 (check-face face)
b2d5aa46
JB
220 (or (get face 'face)
221 (face-id (get face 'face-alias))))
5f5c8ee5
GM
222
223(defun face-equal (face1 face2 &optional frame)
224 "Non-nil if faces FACE1 and FACE2 are equal.
225Faces are considered equal if all their attributes are equal.
a09be93a
JB
226If the optional argument FRAME is given, report on FACE1 and FACE2 in that frame.
227If FRAME is t, report on the defaults for FACE1 and FACE2 (for new frames).
5f5c8ee5
GM
228If FRAME is omitted or nil, use the selected frame."
229 (internal-lisp-face-equal-p face1 face2 frame))
230
231
232(defun face-differs-from-default-p (face &optional frame)
7e07a66d 233 "Return non-nil if FACE displays differently from the default face.
5f5c8ee5
GM
234If the optional argument FRAME is given, report on face FACE in that frame.
235If FRAME is t, report on the defaults for face FACE (for new frames).
7e07a66d 236If FRAME is omitted or nil, use the selected frame."
1151d617 237 (let ((attrs
833547aa 238 (delq :inherit (mapcar 'car face-attribute-name-alist)))
1151d617
MB
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))
5f5c8ee5
GM
249
250
251(defun face-nontrivial-p (face &optional frame)
252 "True if face FACE has some non-nil attribute.
253If the optional argument FRAME is given, report on face FACE in that frame.
254If FRAME is t, report on the defaults for face FACE (for new frames).
255If FRAME is omitted or nil, use the selected frame."
256 (not (internal-lisp-face-empty-p face frame)))
257
258
259\f
260;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
261;;; Setting face attributes from X resources.
262;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
263
264(defcustom face-x-resources
1e8780b1
DN
265 (mapcar
266 (lambda (arg)
267 ;; FIXME; can we purecopy some of the conses too?
e8e4d5c8
SS
268 (cons (car arg)
269 (cons (purecopy (car (cdr arg))) (purecopy (cdr (cdr arg))))))
5f5c8ee5 270 '((:family (".attributeFamily" . "Face.AttributeFamily"))
fcea6e23 271 (:foundry (".attributeFoundry" . "Face.AttributeFoundry"))
5f5c8ee5
GM
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"))
5f5c8ee5
GM
286 (:bold (".attributeBold" . "Face.AttributeBold"))
287 (:italic (".attributeItalic" . "Face.AttributeItalic"))
a0e5a5a4 288 (:font (".attributeFont" . "Face.AttributeFont"))
1e8780b1 289 (:inherit (".attributeInherit" . "Face.AttributeInherit"))))
9201cc28 290 "List of X resources and classes for face attributes.
5f5c8ee5
GM
291Each element has the form (ATTRIBUTE ENTRY1 ENTRY2...) where ATTRIBUTE is
292the name of a face attribute, and each ENTRY is a cons of the form
2cb95d1b 293\(RESOURCE . CLASS) with RESOURCE being the resource and CLASS being the
5f5c8ee5 294X resource class for the attribute."
b5325e78 295 :type '(repeat (cons symbol (repeat (cons string string))))
5f5c8ee5
GM
296 :group 'faces)
297
298
aa360da1
GM
299(declare-function internal-face-x-get-resource "xfaces.c"
300 (resource class frame))
301
302(declare-function internal-set-lisp-face-attribute-from-resource "xfaces.c"
303 (face attr value &optional frame))
304
5f5c8ee5
GM
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.
307Value is the attribute value specified by the resource, or nil
308if not present. This function displays a message if the resource
309specifies 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))
321
322
323(defun set-face-attributes-from-resources (face frame)
324 "Set attributes of FACE from X resources for FRAME."
e51fe00a 325 (when (memq (framep frame) '(x w32))
5f5c8ee5
GM
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))))))
00f51890
SS
331
332
5f5c8ee5
GM
333(defun make-face-x-resource-internal (face &optional frame)
334 "Fill frame-local FACE on FRAME from X resources.
335FRAME 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)))
340
341
342\f
343;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
344;;; Retrieving face attributes.
345;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
346
feaad827 347(defun face-name (face)
465fceed 348 "Return the name of face FACE."
5f5c8ee5
GM
349 (symbol-name (check-face face)))
350
351
833547aa
RS
352(defun face-all-attributes (face &optional frame)
353 "Return an alist stating the attributes of FACE.
354Each element of the result has the form (ATTR-NAME . ATTR-VALUE).
37766706 355If FRAME is omitted or nil the value describes the default attributes,
833547aa
RS
356but if you specify FRAME, the value describes the attributes
357of FACE on FRAME."
606c9f59
RS
358 (mapcar (lambda (pair)
359 (let ((attr (car pair)))
360 (cons attr (face-attribute face attr (or frame t)))))
833547aa
RS
361 face-attribute-name-alist))
362
c7f814cb 363(defun face-attribute (face attribute &optional frame inherit)
5f5c8ee5
GM
364 "Return the value of FACE's ATTRIBUTE on FRAME.
365If the optional argument FRAME is given, report on face FACE in that frame.
366If FRAME is t, report on the defaults for face FACE (for new frames).
c7f814cb 367If FRAME is omitted or nil, use the selected frame.
5f5c8ee5 368
c7f814cb
MB
369If INHERIT is nil, only attributes directly defined by FACE are considered,
370 so the return value may be `unspecified', or a relative value.
371If 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.
374If 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.
376
377To ensure that the return value is always specified and absolute, use a
378value of `default' for INHERIT; this will resolve any unspecified or
379relative values by merging with the `default' face (which is always
380completely 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))
621e71ee
SM
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)))))
c7f814cb
MB
391 (when (and inherit
392 (not (eq inherit t))
393 (face-attribute-relative-p attribute value))
b6b90dfc 394 ;; We should merge with INHERIT as well
c7f814cb
MB
395 (setq value (face-attribute-merged-with attribute value inherit frame)))
396 value))
5f5c8ee5 397
c7f814cb
MB
398(defun face-attribute-merged-with (attribute value faces &optional frame)
399 "Merges ATTRIBUTE, initially VALUE, with faces from FACES until absolute.
400FACES may be either a single face or a list of faces.
522fb950 401\[This is an internal function.]"
c7f814cb
MB
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))
412 (t
413 (merge-face-attribute attribute
414 value
415 (face-attribute faces attribute frame t)))))
416
417
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))))
425
426(defun face-foreground (face &optional frame inherit)
5f5c8ee5
GM
427 "Return the foreground color name of FACE, or nil if unspecified.
428If the optional argument FRAME is given, report on face FACE in that frame.
429If FRAME is t, report on the defaults for face FACE (for new frames).
c7f814cb 430If FRAME is omitted or nil, use the selected frame.
5f5c8ee5 431
c7f814cb
MB
432If INHERIT is nil, only a foreground color directly defined by FACE is
433 considered, so the return value may be nil.
434If 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.
437If INHERIT is a face or a list of faces, then it is used to try to
438 resolve an unspecified foreground color.
439
440To ensure that a valid color is always returned, use a value of
441`default' for INHERIT; this will resolve any unspecified values by
442merging with the `default' face (which is always completely specified)."
443 (face-attribute-specified-or (face-attribute face :foreground frame inherit)
444 nil))
445
446(defun face-background (face &optional frame inherit)
5f5c8ee5
GM
447 "Return the background color name of FACE, or nil if unspecified.
448If the optional argument FRAME is given, report on face FACE in that frame.
449If FRAME is t, report on the defaults for face FACE (for new frames).
c7f814cb 450If FRAME is omitted or nil, use the selected frame.
5f5c8ee5 451
c7f814cb
MB
452If INHERIT is nil, only a background color directly defined by FACE is
453 considered, so the return value may be nil.
454If 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.
457If INHERIT is a face or a list of faces, then it is used to try to
458 resolve an unspecified background color.
459
460To ensure that a valid color is always returned, use a value of
461`default' for INHERIT; this will resolve any unspecified values by
462merging with the `default' face (which is always completely specified)."
463 (face-attribute-specified-or (face-attribute face :background frame inherit)
464 nil))
465
466(defun face-stipple (face &optional frame inherit)
5f5c8ee5
GM
467 "Return the stipple pixmap name of FACE, or nil if unspecified.
468If the optional argument FRAME is given, report on face FACE in that frame.
469If FRAME is t, report on the defaults for face FACE (for new frames).
c7f814cb
MB
470If FRAME is omitted or nil, use the selected frame.
471
472If INHERIT is nil, only a stipple directly defined by FACE is
473 considered, so the return value may be nil.
474If 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.
477If INHERIT is a face or a list of faces, then it is used to try to
478 resolve an unspecified stipple.
479
480To 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
482with the `default' face (which is always completely specified)."
483 (face-attribute-specified-or (face-attribute face :stipple frame inherit)
484 nil))
5f5c8ee5
GM
485
486
487(defalias 'face-background-pixmap 'face-stipple)
488
489
490(defun face-underline-p (face &optional frame)
491 "Return non-nil if FACE is underlined.
492If the optional argument FRAME is given, report on face FACE in that frame.
493If FRAME is t, report on the defaults for face FACE (for new frames).
494If FRAME is omitted or nil, use the selected frame."
495 (eq (face-attribute face :underline frame) t))
496
497
498(defun face-inverse-video-p (face &optional frame)
499 "Return non-nil if FACE is in inverse video on FRAME.
500If the optional argument FRAME is given, report on face FACE in that frame.
501If FRAME is t, report on the defaults for face FACE (for new frames).
502If FRAME is omitted or nil, use the selected frame."
503 (eq (face-attribute face :inverse-video frame) t))
504
505
506(defun face-bold-p (face &optional frame)
507 "Return non-nil if the font of FACE is bold on FRAME.
508If the optional argument FRAME is given, report on face FACE in that frame.
509If FRAME is t, report on the defaults for face FACE (for new frames).
510If FRAME is omitted or nil, use the selected frame.
511Use `face-attribute' for finer control."
512 (let ((bold (face-attribute face :weight frame)))
da2c7b8c 513 (memq bold '(semi-bold bold extra-bold ultra-bold))))
5f5c8ee5
GM
514
515
516(defun face-italic-p (face &optional frame)
517 "Return non-nil if the font of FACE is italic on FRAME.
518If the optional argument FRAME is given, report on face FACE in that frame.
519If FRAME is t, report on the defaults for face FACE (for new frames).
520If FRAME is omitted or nil, use the selected frame.
521Use `face-attribute' for finer control."
522 (let ((italic (face-attribute face :slant frame)))
a48f6020 523 (memq italic '(italic oblique))))
00f51890 524
5f5c8ee5 525
5f5c8ee5
GM
526\f
527;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
528;;; Face documentation.
529;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
530
531(defun face-documentation (face)
9a558a07
GM
532 "Get the documentation string for FACE.
533If FACE is a face-alias, get the documentation for the target face."
534 (let ((alias (get face 'face-alias))
535 doc)
536 (if alias
537 (progn
538 (setq doc (get alias 'face-documentation))
3446bfc8 539 (format "%s is an alias for the face `%s'.%s" face alias
9a558a07
GM
540 (if doc (format "\n%s" doc)
541 "")))
542 (get face 'face-documentation))))
5f5c8ee5
GM
543
544
545(defun set-face-documentation (face string)
546 "Set the documentation string for FACE to STRING."
291cfb96 547 ;; Perhaps the text should go in DOC.
49435801 548 (put face 'face-documentation (purecopy string)))
5f5c8ee5
GM
549
550
551(defalias 'face-doc-string 'face-documentation)
552(defalias 'set-face-doc-string 'set-face-documentation)
553
554
555\f
556;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
557;; Setting face attributes.
558;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
559
560
561(defun set-face-attribute (face frame &rest args)
562 "Set attributes of FACE on FRAME from ARGS.
4b56d0fe
CY
563This function overrides the face attributes specified by FACE's
564face spec. It is mostly intended for internal use only.
5f5c8ee5 565
4b56d0fe
CY
566If FRAME is nil, set the attributes for all existing frames, as
567well as the default for new frames. If FRAME is t, change the
568default for new frames only.
5f5c8ee5 569
4b56d0fe
CY
570ARGS must come in pairs ATTRIBUTE VALUE. ATTRIBUTE must be a
571valid face attribute name. All attributes can be set to
572`unspecified'; this fact is not further mentioned below.
5f5c8ee5
GM
573
574The following attributes are recognized:
575
576`:family'
577
4b56d0fe
CY
578VALUE must be a string specifying the font family
579\(e.g. \"Monospace\") or a fontset.
5f5c8ee5 580
fcea6e23
KH
581`:foundry'
582
583VALUE must be a string specifying the font foundry,
584e.g. ``adobe''. If a font foundry is specified, wild-cards `*'
585and `?' are allowed.
586
5f5c8ee5
GM
587`:width'
588
589VALUE specifies the relative proportionate width of the font to use.
590It must be one of the symbols `ultra-condensed', `extra-condensed',
591`condensed', `semi-condensed', `normal', `semi-expanded', `expanded',
592`extra-expanded', or `ultra-expanded'.
593
594`:height'
595
4b56d0fe
CY
596VALUE specifies the relative or absolute height of the font. An
597absolute height is an integer, and specifies font height in units
598of 1/10 pt. A relative height is either a floating point number,
95838641 599which specifies a scaling factor for the underlying face height;
4b56d0fe
CY
600or a function that takes a single argument (the underlying face
601height) and returns the new height. Note that for the `default'
602face, you must specify an absolute height (since there is nothing
95838641 603for it to be relative to).
5f5c8ee5
GM
604
605`:weight'
606
607VALUE specifies the weight of the font to use. It must be one of the
608symbols `ultra-bold', `extra-bold', `bold', `semi-bold', `normal',
609`semi-light', `light', `extra-light', `ultra-light'.
610
611`:slant'
612
613VALUE specifies the slant of the font to use. It must be one of the
614symbols `italic', `oblique', `normal', `reverse-italic', or
615`reverse-oblique'.
616
617`:foreground', `:background'
618
619VALUE must be a color name, a string.
620
621`:underline'
622
9b0e3eba
AA
623VALUE specifies whether characters in FACE should be underlined.
624If VALUE is t, underline with foreground color of the face.
625If VALUE is a string, underline with that color.
626If VALUE is nil, explicitly don't underline.
627
628Otherwise, VALUE must be a property list of the form:
629
630`(:color COLOR :style STYLE)'.
631
632COLOR can be a either a color name string or `foreground-color'.
633STYLE can be either `line' or `wave'.
634If a keyword/value pair is missing from the property list, a
635default value will be used for the value.
636The default value of COLOR is the foreground color of the face.
637The default value of STYLE is `line'.
5f5c8ee5
GM
638
639`:overline'
640
641VALUE specifies whether characters in FACE should be overlined. If
642VALUE is t, overline with foreground color of the face. If VALUE is a
643string, overline with that color. If VALUE is nil, explicitly don't
644overline.
645
646`:strike-through'
647
648VALUE specifies whether characters in FACE should be drawn with a line
649striking through them. If VALUE is t, use the foreground color of the
650face. If VALUE is a string, strike-through with that color. If VALUE
651is nil, explicitly don't strike through.
652
653`:box'
654
655VALUE specifies whether characters in FACE should have a box drawn
656around them. If VALUE is nil, explicitly don't draw boxes. If
657VALUE is t, draw a box with lines of width 1 in the foreground color
658of the face. If VALUE is a string, the string must be a color name,
659and the box is drawn in that color with a line width of 1. Otherwise,
660VALUE must be a property list of the form `(:line-width WIDTH
661:color COLOR :style STYLE)'. If a keyword/value pair is missing from
662the property list, a default value will be used for the value, as
663specified below. WIDTH specifies the width of the lines to draw; it
0f937ebd
KH
664defaults to 1. If WIDTH is negative, the absolute value is the width
665of the lines, and draw top/bottom lines inside the characters area,
666not around it. COLOR is the name of the color to draw in, default is
5f5c8ee5
GM
667the foreground color of the face for simple boxes, and the background
668color of the face for 3D boxes. STYLE specifies whether a 3D box
669should be draw. If STYLE is `released-button', draw a box looking
670like a released 3D button. If STYLE is `pressed-button' draw a box
671that appears like a pressed button. If STYLE is nil, the default if
672the property list doesn't contain a style specification, draw a 2D
673box.
674
675`:inverse-video'
676
677VALUE specifies whether characters in FACE should be displayed in
70d0c3b0 678inverse video. VALUE must be one of t or nil.
5f5c8ee5
GM
679
680`:stipple'
681
682If VALUE is a string, it must be the name of a file of pixmap data.
683The directories listed in the `x-bitmap-file-path' variable are
684searched. Alternatively, VALUE may be a list of the form (WIDTH
685HEIGHT DATA) where WIDTH and HEIGHT are the size in pixels, and DATA
686is a string containing the raw bits of the bitmap. VALUE nil means
687explicitly don't use a stipple pattern.
688
fcea6e23
KH
689For convenience, attributes `:family', `:foundry', `:width',
690`:height', `:weight', and `:slant' may also be set in one step
691from an X font name:
5f5c8ee5
GM
692
693`:font'
694
4b56d0fe
CY
695Set font-related face attributes from VALUE. VALUE must be a
696valid font name or font object. Setting this attribute will also
697set the `:family', `:foundry', `:width', `:height', `:weight',
698and `:slant' attributes.
19feb949
MB
699
700`:inherit'
701
4b56d0fe
CY
702VALUE is the name of a face from which to inherit attributes, or
703a list of face names. Attributes from inherited faces are merged
704into the face like an underlying face would be, with higher
705priority than underlying faces.
706
707For backward compatibility, the keywords `:bold' and `:italic'
708can be used to specify weight and slant respectively. This usage
709is considered obsolete. For these two keywords, the VALUE must
710be either t or nil. A value of t for `:bold' is equivalent to
711setting `:weight' to `bold', and a value of t for `:italic' is
712equivalent to setting `:slant' to `italic'. But if `:weight' is
713specified in the face spec, `:bold' is ignored, and if `:slant'
714is specified, `:italic' is ignored."
61ab9392
CY
715 (setq args (purecopy args))
716 (let ((where (if (null frame) 0 frame))
717 (spec args)
718 family foundry)
680da3f8
RS
719 ;; If we set the new-frame defaults, this face is modified outside Custom.
720 (if (memq where '(0 t))
9a558a07 721 (put (or (get face 'face-alias) face) 'face-modified t))
61ab9392
CY
722 ;; If family and/or foundry are specified, set it first. Certain
723 ;; face attributes, e.g. :weight semi-condensed, are not supported
724 ;; in every font. See bug#1127.
725 (while spec
726 (cond ((eq (car spec) :family)
727 (setq family (cadr spec)))
728 ((eq (car spec) :foundry)
729 (setq foundry (cadr spec))))
730 (setq spec (cddr spec)))
731 (when (or family foundry)
732 (when (and (stringp family)
733 (string-match "\\([^-]*\\)-\\([^-]*\\)" family))
734 (unless foundry
3a92c095
KH
735 (setq foundry (match-string 1 family)))
736 (setq family (match-string 2 family)))
c917476d 737 (when (or (stringp family) (eq family 'unspecified))
61ab9392
CY
738 (internal-set-lisp-face-attribute face :family (purecopy family)
739 where))
c917476d 740 (when (or (stringp foundry) (eq foundry 'unspecified))
61ab9392
CY
741 (internal-set-lisp-face-attribute face :foundry (purecopy foundry)
742 where)))
70a267c9 743 (while args
61ab9392 744 (unless (memq (car args) '(:family :foundry))
96c1a800
CY
745 (internal-set-lisp-face-attribute face (car args)
746 (purecopy (cadr args))
747 where))
61ab9392 748 (setq args (cddr args)))))
5f5c8ee5 749
06b60517 750(defun make-face-bold (face &optional frame _noerror)
5f5c8ee5
GM
751 "Make the font of FACE be bold, if possible.
752FRAME nil or not specified means change face on all frames.
39cac3e7 753Argument NOERROR is ignored and retained for compatibility.
5f5c8ee5 754Use `set-face-attribute' for finer control of the font weight."
95125512 755 (interactive (list (read-face-name "Make which face bold")))
5f5c8ee5
GM
756 (set-face-attribute face frame :weight 'bold))
757
758
06b60517 759(defun make-face-unbold (face &optional frame _noerror)
5f5c8ee5 760 "Make the font of FACE be non-bold, if possible.
39cac3e7
GM
761FRAME nil or not specified means change face on all frames.
762Argument NOERROR is ignored and retained for compatibility."
95125512 763 (interactive (list (read-face-name "Make which face non-bold")))
5f5c8ee5
GM
764 (set-face-attribute face frame :weight 'normal))
765
00f51890 766
06b60517 767(defun make-face-italic (face &optional frame _noerror)
5f5c8ee5
GM
768 "Make the font of FACE be italic, if possible.
769FRAME nil or not specified means change face on all frames.
39cac3e7 770Argument NOERROR is ignored and retained for compatibility.
5f5c8ee5 771Use `set-face-attribute' for finer control of the font slant."
95125512 772 (interactive (list (read-face-name "Make which face italic")))
5f5c8ee5
GM
773 (set-face-attribute face frame :slant 'italic))
774
775
06b60517 776(defun make-face-unitalic (face &optional frame _noerror)
5f5c8ee5 777 "Make the font of FACE be non-italic, if possible.
70d0c3b0
DL
778FRAME nil or not specified means change face on all frames.
779Argument NOERROR is ignored and retained for compatibility."
95125512 780 (interactive (list (read-face-name "Make which face non-italic")))
5f5c8ee5
GM
781 (set-face-attribute face frame :slant 'normal))
782
00f51890 783
06b60517 784(defun make-face-bold-italic (face &optional frame _noerror)
5f5c8ee5
GM
785 "Make the font of FACE be bold and italic, if possible.
786FRAME nil or not specified means change face on all frames.
39cac3e7 787Argument NOERROR is ignored and retained for compatibility.
5f5c8ee5 788Use `set-face-attribute' for finer control of font weight and slant."
95125512 789 (interactive (list (read-face-name "Make which face bold-italic")))
5f5c8ee5
GM
790 (set-face-attribute face frame :weight 'bold :slant 'italic))
791
792
793(defun set-face-font (face font &optional frame)
794 "Change font-related attributes of FACE to those of FONT (a string).
795FRAME nil or not specified means change face on all frames.
fcea6e23
KH
796This sets the attributes `:family', `:foundry', `:width',
797`:height', `:weight', and `:slant'. When called interactively,
798prompt for the face and font."
5f5c8ee5
GM
799 (interactive (read-face-and-attribute :font))
800 (set-face-attribute face frame :font font))
801
802
803;; Implementation note: Emulating gray background colors with a
804;; stipple pattern is now part of the face realization process, and is
805;; done in C depending on the frame on which the face is realized.
806
807(defun set-face-background (face color &optional frame)
808 "Change the background color of face FACE to COLOR (a string).
809FRAME nil or not specified means change face on all frames.
72e6f142
RS
810COLOR can be a system-defined color name (see `list-colors-display')
811or a hex spec of the form #RRGGBB.
812When called interactively, prompts for the face and color."
5f5c8ee5 813 (interactive (read-face-and-attribute :background))
78ad1cd5 814 (set-face-attribute face frame :background (or color 'unspecified)))
5f5c8ee5
GM
815
816
817(defun set-face-foreground (face color &optional frame)
818 "Change the foreground color of face FACE to COLOR (a string).
819FRAME nil or not specified means change face on all frames.
72e6f142
RS
820COLOR can be a system-defined color name (see `list-colors-display')
821or a hex spec of the form #RRGGBB.
822When called interactively, prompts for the face and color."
5f5c8ee5 823 (interactive (read-face-and-attribute :foreground))
78ad1cd5 824 (set-face-attribute face frame :foreground (or color 'unspecified)))
5f5c8ee5
GM
825
826
827(defun set-face-stipple (face stipple &optional frame)
828 "Change the stipple pixmap of face FACE to STIPPLE.
829FRAME nil or not specified means change face on all frames.
70d0c3b0 830STIPPLE should be a string, the name of a file of pixmap data.
5f5c8ee5
GM
831The directories listed in the `x-bitmap-file-path' variable are searched.
832
833Alternatively, STIPPLE may be a list of the form (WIDTH HEIGHT DATA)
834where WIDTH and HEIGHT are the size in pixels,
835and DATA is a string, containing the raw bits of the bitmap."
836 (interactive (read-face-and-attribute :stipple))
78ad1cd5 837 (set-face-attribute face frame :stipple (or stipple 'unspecified)))
5f5c8ee5
GM
838
839
a61afeac 840(defun set-face-underline-p (face underline &optional frame)
5f5c8ee5
GM
841 "Specify whether face FACE is underlined.
842UNDERLINE nil means FACE explicitly doesn't underline.
843UNDERLINE non-nil means FACE explicitly does underlining
844with the same of the foreground color.
845If UNDERLINE is a string, underline with the color named UNDERLINE.
846FRAME nil or not specified means change face on all frames.
5f5c8ee5
GM
847Use `set-face-attribute' to ``unspecify'' underlining."
848 (interactive
849 (let ((list (read-face-and-attribute :underline)))
850 (list (car list) (eq (car (cdr list)) t))))
a61afeac 851 (set-face-attribute face frame :underline underline))
5f5c8ee5 852
9b82fc01
JL
853(define-obsolete-function-alias 'set-face-underline
854 'set-face-underline-p "22.1")
855
5f5c8ee5
GM
856
857(defun set-face-inverse-video-p (face inverse-video-p &optional frame)
858 "Specify whether face FACE is in inverse video.
859INVERSE-VIDEO-P non-nil means FACE displays explicitly in inverse video.
860INVERSE-VIDEO-P nil means FACE explicitly is not in inverse video.
861FRAME nil or not specified means change face on all frames.
862Use `set-face-attribute' to ``unspecify'' the inverse video attribute."
863 (interactive
864 (let ((list (read-face-and-attribute :inverse-video)))
865 (list (car list) (eq (car (cdr list)) t))))
866 (set-face-attribute face frame :inverse-video inverse-video-p))
867
868
869(defun set-face-bold-p (face bold-p &optional frame)
870 "Specify whether face FACE is bold.
871BOLD-P non-nil means FACE should explicitly display bold.
872BOLD-P nil means FACE should explicitly display non-bold.
873FRAME nil or not specified means change face on all frames.
874Use `set-face-attribute' or `modify-face' for finer control."
875 (if (null bold-p)
876 (make-face-unbold face frame)
877 (make-face-bold face frame)))
878
879
880(defun set-face-italic-p (face italic-p &optional frame)
881 "Specify whether face FACE is italic.
882ITALIC-P non-nil means FACE should explicitly display italic.
883ITALIC-P nil means FACE should explicitly display non-italic.
884FRAME nil or not specified means change face on all frames.
885Use `set-face-attribute' or `modify-face' for finer control."
886 (if (null italic-p)
887 (make-face-unitalic face frame)
888 (make-face-italic face frame)))
889
890
891(defalias 'set-face-background-pixmap 'set-face-stipple)
892
893
894(defun invert-face (face &optional frame)
895 "Swap the foreground and background colors of FACE.
e458cb49 896If FRAME is omitted or nil, it means change face on all frames.
5f5c8ee5
GM
897If FACE specifies neither foreground nor background color,
898set its foreground and background to the background and foreground
899of the default face. Value is FACE."
95125512 900 (interactive (list (read-face-name "Invert face")))
5f5c8ee5
GM
901 (let ((fg (face-attribute face :foreground frame))
902 (bg (face-attribute face :background frame)))
e458cb49 903 (if (not (and (eq fg 'unspecified) (eq bg 'unspecified)))
5f5c8ee5
GM
904 (set-face-attribute face frame :foreground bg :background fg)
905 (set-face-attribute face frame
906 :foreground
907 (face-attribute 'default :background frame)
908 :background
909 (face-attribute 'default :foreground frame))))
910 face)
911
912\f
913;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
914;;; Interactively modifying faces.
915;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
916
c91e692b 917(defun read-face-name (prompt &optional default multiple)
a482f364 918 "Read a face, defaulting to the face or faces on the char after point.
c7b93b44 919If it has the property `read-face-name', that overrides the `face' property.
3748d13d
RS
920PROMPT should be a string that describes what the caller will do with the face;
921it should not end in a space.
c91e692b
JL
922The optional argument DEFAULT provides the value to display in the
923minibuffer prompt that is returned if the user just types RET
924unless DEFAULT is a string (in which case nil is returned).
a482f364
RS
925If MULTIPLE is non-nil, return a list of faces (possibly only one).
926Otherwise, return a single face."
927 (let ((faceprop (or (get-char-property (point) 'read-face-name)
928 (get-char-property (point) 'face)))
e3b5b35b
SM
929 (aliasfaces nil)
930 (nonaliasfaces nil)
a482f364 931 faces)
224d108e
JL
932 ;; Try to get a face name from the buffer.
933 (if (memq (intern-soft (thing-at-point 'symbol)) (face-list))
934 (setq faces (list (intern-soft (thing-at-point 'symbol)))))
935 ;; Add the named faces that the `face' property uses.
1bd59f82
RS
936 (if (and (listp faceprop)
937 ;; Don't treat an attribute spec as a list of faces.
938 (not (keywordp (car faceprop)))
939 (not (memq (car faceprop) '(foreground-color background-color))))
a482f364
RS
940 (dolist (f faceprop)
941 (if (symbolp f)
942 (push f faces)))
943 (if (symbolp faceprop)
1bd59f82 944 (push faceprop faces)))
81435dc4 945 (delete-dups faces)
a482f364 946
e3b5b35b
SM
947 ;; Build up the completion tables.
948 (mapatoms (lambda (s)
949 (if (custom-facep s)
950 (if (get s 'face-alias)
951 (push (symbol-name s) aliasfaces)
952 (push (symbol-name s) nonaliasfaces)))))
953
a482f364
RS
954 ;; If we only want one, and the default is more than one,
955 ;; discard the unwanted ones now.
956 (unless multiple
957 (if faces
958 (setq faces (list (car faces)))))
224d108e 959 (require 'crm)
a482f364
RS
960 (let* ((input
961 ;; Read the input.
224d108e 962 (completing-read-multiple
c91e692b
JL
963 (if (or faces default)
964 (format "%s (default `%s'): " prompt
224d108e 965 (if faces (mapconcat 'symbol-name faces ",")
c91e692b 966 default))
3b4ef34b 967 (format "%s: " prompt))
45555ebe 968 (completion-table-in-turn nonaliasfaces aliasfaces)
2aef0850 969 nil t nil 'face-name-history
224d108e 970 (if faces (mapconcat 'symbol-name faces ","))))
a482f364
RS
971 ;; Canonicalize the output.
972 (output
224d108e 973 (cond ((or (equal input "") (equal input '("")))
c91e692b 974 (or faces (unless (stringp default) default)))
224d108e
JL
975 ((stringp input)
976 (mapcar 'intern (split-string input ", *" t)))
977 ((listp input)
978 (mapcar 'intern input))
979 (input))))
a482f364
RS
980 ;; Return either a list of faces or just one face.
981 (if multiple
982 output
983 (car output)))))
984
aa360da1
GM
985;; Not defined without X, but behind window-system test.
986(defvar x-bitmap-file-path)
a482f364 987
5f5c8ee5
GM
988(defun face-valid-attribute-values (attribute &optional frame)
989 "Return valid values for face attribute ATTRIBUTE.
990The optional argument FRAME is used to determine available fonts
c6f3804c
JB
991and colors. If it is nil or not specified, the selected frame is used.
992Value is an alist of (NAME . VALUE) if ATTRIBUTE expects a value out
993of a set of discrete values. Value is `integerp' if ATTRIBUTE expects
5f5c8ee5 994an integer value."
00f51890 995 (let ((valid
36cec983
SM
996 (pcase attribute
997 (`:family
428a555e 998 (if (window-system frame)
95ac8fbd 999 (mapcar (lambda (x) (cons x x))
6e783e91 1000 (font-family-list))
00f51890
SS
1001 ;; Only one font on TTYs.
1002 (list (cons "default" "default"))))
36cec983 1003 (`:foundry
fcea6e23 1004 (list nil))
36cec983 1005 (`:width
e83eedbf 1006 (mapcar #'(lambda (x) (cons (symbol-name (aref x 1)) (aref x 1)))
6e783e91 1007 font-width-table))
36cec983 1008 (`:weight
e83eedbf 1009 (mapcar #'(lambda (x) (cons (symbol-name (aref x 1)) (aref x 1)))
6e783e91 1010 font-weight-table))
36cec983 1011 (`:slant
e83eedbf 1012 (mapcar #'(lambda (x) (cons (symbol-name (aref x 1)) (aref x 1)))
6e783e91 1013 font-slant-table))
36cec983 1014 (`:inverse-video
6e783e91
KH
1015 (mapcar #'(lambda (x) (cons (symbol-name x) x))
1016 (internal-lisp-face-attribute-values attribute)))
36cec983 1017 ((or `:underline `:overline `:strike-through `:box)
428a555e 1018 (if (window-system frame)
00f51890
SS
1019 (nconc (mapcar #'(lambda (x) (cons (symbol-name x) x))
1020 (internal-lisp-face-attribute-values attribute))
1021 (mapcar #'(lambda (c) (cons c c))
b533d0ae 1022 (defined-colors frame)))
00f51890
SS
1023 (mapcar #'(lambda (x) (cons (symbol-name x) x))
1024 (internal-lisp-face-attribute-values attribute))))
36cec983 1025 ((or `:foreground `:background)
00f51890
SS
1026 (mapcar #'(lambda (c) (cons c c))
1027 (defined-colors frame)))
36cec983 1028 (`:height
00f51890 1029 'integerp)
36cec983 1030 (`:stipple
0db2e6af 1031 (and (memq (window-system frame) '(x ns)) ; No stipple on w32
00f51890
SS
1032 (mapcar #'list
1033 (apply #'nconc
1034 (mapcar (lambda (dir)
1035 (and (file-readable-p dir)
1036 (file-directory-p dir)
1037 (directory-files dir)))
1038 x-bitmap-file-path)))))
36cec983 1039 (`:inherit
00f51890
SS
1040 (cons '("none" . nil)
1041 (mapcar #'(lambda (c) (cons (symbol-name c) c))
1042 (face-list))))
36cec983 1043 (_
00f51890 1044 (error "Internal error")))))
19feb949 1045 (if (and (listp valid) (not (memq attribute '(:inherit))))
fbd5f1cc
GM
1046 (nconc (list (cons "unspecified" 'unspecified)) valid)
1047 valid)))
5f5c8ee5
GM
1048
1049
2f7f4bee 1050(defconst face-attribute-name-alist
5f5c8ee5 1051 '((:family . "font family")
fcea6e23 1052 (:foundry . "font foundry")
5f5c8ee5
GM
1053 (:width . "character set width")
1054 (:height . "height in 1/10 pt")
1055 (:weight . "weight")
1056 (:slant . "slant")
1057 (:underline . "underline")
1058 (:overline . "overline")
1059 (:strike-through . "strike-through")
1060 (:box . "box")
1061 (:inverse-video . "inverse-video display")
1062 (:foreground . "foreground color")
1063 (:background . "background color")
19feb949
MB
1064 (:stipple . "background stipple")
1065 (:inherit . "inheritance"))
5f5c8ee5
GM
1066 "An alist of descriptive names for face attributes.
1067Each element has the form (ATTRIBUTE-NAME . DESCRIPTION) where
1068ATTRIBUTE-NAME is a face attribute name (a keyword symbol), and
1069DESCRIPTION is a descriptive name for ATTRIBUTE-NAME.")
1070
1071
1072(defun face-descriptive-attribute-name (attribute)
1073 "Return a descriptive name for ATTRIBUTE."
1074 (cdr (assq attribute face-attribute-name-alist)))
1075
1076
1077(defun face-read-string (face default name &optional completion-alist)
1078 "Interactively read a face attribute string value.
19feb949
MB
1079FACE is the face whose attribute is read. If non-nil, DEFAULT is the
1080default string to return if no new value is entered. NAME is a
1081descriptive name of the attribute for prompting. COMPLETION-ALIST is an
1082alist of valid values, if non-nil.
5f5c8ee5 1083
19feb949 1084Entering nothing accepts the default string DEFAULT.
5f5c8ee5 1085Value is the new attribute value."
19feb949
MB
1086 ;; Capitalize NAME (we don't use `capitalize' because that capitalizes
1087 ;; each word in a string separately).
1088 (setq name (concat (upcase (substring name 0 1)) (substring name 1)))
5f5c8ee5
GM
1089 (let* ((completion-ignore-case t)
1090 (value (completing-read
1091 (if default
19feb949
MB
1092 (format "%s for face `%s' (default %s): "
1093 name face default)
1094 (format "%s for face `%s': " name face))
d69ab4ba 1095 completion-alist nil nil nil nil default)))
fbd5f1cc 1096 (if (equal value "") default value)))
5f5c8ee5
GM
1097
1098
1099(defun face-read-integer (face default name)
1100 "Interactively read an integer face attribute value.
1101FACE is the face whose attribute is read. DEFAULT is the default
1102value to return if no new value is entered. NAME is a descriptive
1103name of the attribute for prompting. Value is the new attribute value."
fbd5f1cc
GM
1104 (let ((new-value
1105 (face-read-string face
19feb949 1106 (format "%s" default)
fbd5f1cc
GM
1107 name
1108 (list (cons "unspecified" 'unspecified)))))
19feb949
MB
1109 (cond ((equal new-value "unspecified")
1110 'unspecified)
1111 ((member new-value '("unspecified-fg" "unspecified-bg"))
1112 new-value)
1113 (t
027a4b6b 1114 (string-to-number new-value)))))
5f5c8ee5
GM
1115
1116
1117(defun read-face-attribute (face attribute &optional frame)
1118 "Interactively read a new value for FACE's ATTRIBUTE.
1119Optional argument FRAME nil or unspecified means read an attribute value
1120of a global face. Value is the new attribute value."
1121 (let* ((old-value (face-attribute face attribute frame))
1122 (attribute-name (face-descriptive-attribute-name attribute))
1123 (valid (face-valid-attribute-values attribute frame))
1124 new-value)
1125 ;; Represent complex attribute values as strings by printing them
1126 ;; out. Stipple can be a vector; (WIDTH HEIGHT DATA). Box can be
1127 ;; a list `(:width WIDTH :color COLOR)' or `(:width WIDTH :shadow
1128 ;; SHADOW)'.
1129 (when (and (or (eq attribute :stipple)
1130 (eq attribute :box))
1131 (or (consp old-value)
1132 (vectorp old-value)))
1133 (setq old-value (prin1-to-string old-value)))
1134 (cond ((listp valid)
19feb949
MB
1135 (let ((default
1136 (or (car (rassoc old-value valid))
1137 (format "%s" old-value))))
1138 (setq new-value
1139 (face-read-string face default attribute-name valid))
1140 (if (equal new-value default)
1141 ;; Nothing changed, so don't bother with all the stuff
1142 ;; below. In particular, this avoids a non-tty color
1143 ;; from being canonicalized for a tty when the user
1144 ;; just uses the default.
1145 (setq new-value old-value)
1146 ;; Terminal frames can support colors that don't appear
1147 ;; explicitly in VALID, using color approximation code
1148 ;; in tty-colors.el.
f9056dd9 1149 (when (and (memq attribute '(:foreground :background))
9e2a2647 1150 (not (memq (window-system frame) '(x w32 ns)))
f9056dd9
MB
1151 (not (member new-value
1152 '("unspecified"
1153 "unspecified-fg" "unspecified-bg"))))
4385f1b0 1154 (setq new-value (car (tty-color-desc new-value frame))))
f9056dd9
MB
1155 (when (assoc new-value valid)
1156 (setq new-value (cdr (assoc new-value valid)))))))
5f5c8ee5
GM
1157 ((eq valid 'integerp)
1158 (setq new-value (face-read-integer face old-value attribute-name)))
1159 (t (error "Internal error")))
1160 ;; Convert stipple and box value text we read back to a list or
1161 ;; vector if it looks like one. This makes the assumption that a
1162 ;; pixmap file name won't start with an open-paren.
1163 (when (and (or (eq attribute :stipple)
1164 (eq attribute :box))
1165 (stringp new-value)
1166 (string-match "^[[(]" new-value))
1167 (setq new-value (read new-value)))
1168 new-value))
1169
aa360da1
GM
1170(declare-function fontset-list "fontset.c" ())
1171(declare-function x-list-fonts "xfaces.c"
1172 (pattern &optional face frame maximum width))
5f5c8ee5
GM
1173
1174(defun read-face-font (face &optional frame)
1175 "Read the name of a font for FACE on FRAME.
522fb950 1176If optional argument FRAME is nil or omitted, use the selected frame."
5f5c8ee5 1177 (let ((completion-ignore-case t))
48ec9939 1178 (completing-read (format "Set font attributes of face `%s' from font: " face)
6b61353c 1179 (append (fontset-list) (x-list-fonts "*" nil frame)))))
5f5c8ee5
GM
1180
1181
1182(defun read-all-face-attributes (face &optional frame)
1183 "Interactively read all attributes for FACE.
522fb950 1184If optional argument FRAME is nil or omitted, use the selected frame.
5f5c8ee5
GM
1185Value is a property list of attribute names and new values."
1186 (let (result)
1187 (dolist (attribute face-attribute-name-alist result)
1188 (setq result (cons (car attribute)
1189 (cons (read-face-attribute face (car attribute) frame)
1190 result))))))
1191
7cd512f2 1192(defun modify-face (&optional face foreground background stipple
a61afeac 1193 bold-p italic-p underline inverse-p frame)
5f5c8ee5
GM
1194 "Modify attributes of faces interactively.
1195If optional argument FRAME is nil or omitted, modify the face used
7cd512f2
SM
1196for newly created frame, i.e. the global face.
1197For non-interactive use, `set-face-attribute' is preferred.
522fb950 1198When called from Lisp, if FACE is nil, all arguments but FRAME are ignored
7cd512f2 1199and the face and its settings are obtained by querying the user."
5f5c8ee5 1200 (interactive)
7cd512f2
SM
1201 (if face
1202 (set-face-attribute face frame
1203 :foreground (or foreground 'unspecified)
1204 :background (or background 'unspecified)
1205 :stipple stipple
4b56d0fe
CY
1206 :weight (if bold-p 'bold 'normal)
1207 :slant (if italic-p 'italic 'normal)
a61afeac 1208 :underline underline
7cd512f2
SM
1209 :inverse-video inverse-p)
1210 (setq face (read-face-name "Modify face"))
5f5c8ee5
GM
1211 (apply #'set-face-attribute face frame
1212 (read-all-face-attributes face frame))))
1213
5f5c8ee5
GM
1214(defun read-face-and-attribute (attribute &optional frame)
1215 "Read face name and face attribute value.
1216ATTRIBUTE is the attribute whose new value is read.
1217FRAME nil or unspecified means read attribute value of global face.
1218Value is a list (FACE NEW-VALUE) where FACE is the face read
7cd512f2 1219\(a symbol), and NEW-VALUE is value read."
5f5c8ee5 1220 (cond ((eq attribute :font)
48ec9939 1221 (let* ((prompt "Set font-related attributes of face")
5f5c8ee5
GM
1222 (face (read-face-name prompt))
1223 (font (read-face-font face frame)))
1224 (list face font)))
1225 (t
1226 (let* ((attribute-name (face-descriptive-attribute-name attribute))
19feb949 1227 (prompt (format "Set %s of face" attribute-name))
5f5c8ee5
GM
1228 (face (read-face-name prompt))
1229 (new-value (read-face-attribute face attribute frame)))
1230 (list face new-value)))))
1231
1232
1233\f
1234;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1235;;; Listing faces.
1236;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1237
2f7f4bee 1238(defconst list-faces-sample-text
5f5c8ee5 1239 "abcdefghijklmnopqrstuvwxyz ABCDEFGHIJKLMNOPQRSTUVWXYZ"
fb7ada5f 1240 "Text string to display as the sample text for `list-faces-display'.")
5f5c8ee5
GM
1241
1242
1243;; The name list-faces would be more consistent, but let's avoid a
1244;; conflict with Lucid, which uses that name differently.
1245
645a1038 1246(defvar help-xref-stack)
e2c11e3b 1247(defun list-faces-display (&optional regexp)
5f5c8ee5
GM
1248 "List all faces, using the same sample text in each.
1249The sample text is a string that comes from the variable
e2c11e3b
RS
1250`list-faces-sample-text'.
1251
1252If REGEXP is non-nil, list only those faces with names matching
1253this regular expression. When called interactively with a prefix
1254arg, prompt for a regular expression."
1255 (interactive (list (and current-prefix-arg
2aef0850 1256 (read-regexp "List faces matching regexp"))))
011131fd 1257 (let ((all-faces (zerop (length regexp)))
5f5c8ee5 1258 (frame (selected-frame))
011131fd
JB
1259 (max-length 0)
1260 faces line-format
84fe35f0 1261 disp-frame window face-name)
011131fd
JB
1262 ;; We filter and take the max length in one pass
1263 (setq faces
1264 (delq nil
1265 (mapcar (lambda (f)
1266 (let ((s (symbol-name f)))
1267 (when (or all-faces (string-match regexp s))
1268 (setq max-length (max (length s) max-length))
1269 f)))
1270 (sort (face-list) #'string-lessp))))
1271 (unless faces
1272 (error "No faces matching \"%s\"" regexp))
1273 (setq max-length (1+ max-length)
1274 line-format (format "%%-%ds" max-length))
b766be6a 1275 (with-help-window "*Faces*"
7fdbcd83 1276 (with-current-buffer standard-output
5f5c8ee5 1277 (setq truncate-lines t)
84fe35f0
DL
1278 (insert
1279 (substitute-command-keys
1280 (concat
75bfc667 1281 "\\<help-mode-map>Use "
53c80cf6 1282 (if (display-mouse-p) "\\[help-follow-mouse] or ")
32e33f60 1283 "\\[help-follow] on a face name to customize it\n"
46057f5f 1284 "or on its sample text for a description of the face.\n\n")))
84fe35f0 1285 (setq help-xref-stack nil)
e2c11e3b 1286 (dolist (face faces)
84fe35f0 1287 (setq face-name (symbol-name face))
011131fd 1288 (insert (format line-format face-name))
84fe35f0
DL
1289 ;; Hyperlink to a customization buffer for the face. Using
1290 ;; the help xref mechanism may not be the best way.
1291 (save-excursion
1292 (save-match-data
1293 (search-backward face-name)
35a0a8aa 1294 (setq help-xref-stack-item `(list-faces-display ,regexp))
a482f364
RS
1295 (help-xref-button 0 'help-customize-face face)))
1296 (let ((beg (point))
1297 (line-beg (line-beginning-position)))
5f5c8ee5 1298 (insert list-faces-sample-text)
84fe35f0
DL
1299 ;; Hyperlink to a help buffer for the face.
1300 (save-excursion
1301 (save-match-data
1302 (search-backward list-faces-sample-text)
8940232b 1303 (help-xref-button 0 'help-face face)))
5f5c8ee5
GM
1304 (insert "\n")
1305 (put-text-property beg (1- (point)) 'face face)
a482f364
RS
1306 ;; Make all face commands default to the proper face
1307 ;; anywhere in the line.
1308 (put-text-property line-beg (1- (point)) 'read-face-name face)
5f5c8ee5
GM
1309 ;; If the sample text has multiple lines, line up all of them.
1310 (goto-char beg)
1311 (forward-line 1)
1312 (while (not (eobp))
011131fd 1313 (insert-char ?\s max-length)
5f5c8ee5 1314 (forward-line 1))))
b766be6a 1315 (goto-char (point-min))))
5f5c8ee5
GM
1316 ;; If the *Faces* buffer appears in a different frame,
1317 ;; copy all the face definitions from FRAME,
1318 ;; so that the display will reflect the frame that was selected.
1319 (setq window (get-buffer-window (get-buffer "*Faces*") t))
1320 (setq disp-frame (if window (window-frame window)
1321 (car (frame-list))))
1322 (or (eq frame disp-frame)
1323 (let ((faces (face-list)))
1324 (while faces
1325 (copy-face (car faces) (car faces) frame disp-frame)
1326 (setq faces (cdr faces)))))))
1327
e2c11e3b 1328
5f5c8ee5
GM
1329(defun describe-face (face &optional frame)
1330 "Display the properties of face FACE on FRAME.
6afa5404 1331Interactively, FACE defaults to the faces of the character after point
a482f364
RS
1332and FRAME defaults to the selected frame.
1333
5f5c8ee5
GM
1334If the optional argument FRAME is given, report on face FACE in that frame.
1335If FRAME is t, report on the defaults for face FACE (for new frames).
1336If FRAME is omitted or nil, use the selected frame."
c91e692b 1337 (interactive (list (read-face-name "Describe face" 'default t)))
5f5c8ee5 1338 (let* ((attrs '((:family . "Family")
fcea6e23 1339 (:foundry . "Foundry")
5f5c8ee5
GM
1340 (:width . "Width")
1341 (:height . "Height")
1342 (:weight . "Weight")
1343 (:slant . "Slant")
1344 (:foreground . "Foreground")
1345 (:background . "Background")
1346 (:underline . "Underline")
1347 (:overline . "Overline")
1348 (:strike-through . "Strike-through")
1349 (:box . "Box")
1350 (:inverse-video . "Inverse")
b32631c8 1351 (:stipple . "Stipple")
0540dc5e
KH
1352 (:font . "Font")
1353 (:fontset . "Fontset")
25ac7b52 1354 (:inherit . "Inherit")))
5f5c8ee5
GM
1355 (max-width (apply #'max (mapcar #'(lambda (x) (length (cdr x)))
1356 attrs))))
32226619
JB
1357 (help-setup-xref (list #'describe-face face)
1358 (called-interactively-p 'interactive))
a482f364
RS
1359 (unless face
1360 (setq face 'default))
1361 (if (not (listp face))
1362 (setq face (list face)))
b766be6a 1363 (with-help-window (help-buffer)
7fdbcd83 1364 (with-current-buffer standard-output
a482f364 1365 (dolist (f face)
faa3d27b 1366 (if (stringp f) (setq f (intern f)))
0d3b1f4e
CY
1367 ;; We may get called for anonymous faces (i.e., faces
1368 ;; expressed using prop-value plists). Those can't be
1369 ;; usefully customized, so ignore them.
1370 (when (symbolp f)
1371 (insert "Face: " (symbol-name f))
1372 (if (not (facep f))
1373 (insert " undefined face.\n")
1374 (let ((customize-label "customize this face")
1375 file-name)
1376 (insert (concat " (" (propertize "sample" 'font-lock-face f) ")"))
1377 (princ (concat " (" customize-label ")\n"))
3446bfc8
GM
1378 ;; FIXME not sure how much of this belongs here, and
1379 ;; how much in `face-documentation'. The latter is
1380 ;; not used much, but needs to return nil for
1381 ;; undocumented faces.
1382 (let ((alias (get f 'face-alias))
1383 (face f)
1384 obsolete)
1385 (when alias
1386 (setq face alias)
1387 (insert
1388 (format "\n %s is an alias for the face `%s'.\n%s"
1389 f alias
1390 (if (setq obsolete (get f 'obsolete-face))
1391 (format " This face is obsolete%s; use `%s' instead.\n"
1392 (if (stringp obsolete)
1393 (format " since %s" obsolete)
1394 "")
1395 alias)
1396 ""))))
1397 (insert "\nDocumentation:\n"
1398 (or (face-documentation face)
1399 "Not documented as a face.")
1400 "\n\n"))
0d3b1f4e
CY
1401 (with-current-buffer standard-output
1402 (save-excursion
1403 (re-search-backward
1404 (concat "\\(" customize-label "\\)") nil t)
1405 (help-xref-button 1 'help-customize-face f)))
1406 (setq file-name (find-lisp-object-file-name f 'defface))
1407 (when file-name
1408 (princ "Defined in `")
1409 (princ (file-name-nondirectory file-name))
1410 (princ "'")
1411 ;; Make a hyperlink to the library.
1412 (save-excursion
1413 (re-search-backward "`\\([^`']+\\)'" nil t)
1414 (help-xref-button 1 'help-face-def f file-name))
1415 (princ ".")
1416 (terpri)
1417 (terpri))
1418 (dolist (a attrs)
1419 (let ((attr (face-attribute f (car a) frame)))
1420 (insert (make-string (- max-width (length (cdr a))) ?\s)
1421 (cdr a) ": " (format "%s" attr))
1422 (if (and (eq (car a) :inherit)
1423 (not (eq attr 'unspecified)))
1424 ;; Make a hyperlink to the parent face.
1425 (save-excursion
1426 (re-search-backward ": \\([^:]+\\)" nil t)
1427 (help-xref-button 1 'help-face attr)))
1428 (insert "\n")))))
1429 (terpri)))))))
8940232b 1430
5f5c8ee5
GM
1431\f
1432;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1433;;; Face specifications (defface).
1434;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1435
1436;; Parameter FRAME Is kept for call compatibility to with previous
1437;; face implementation.
1438
06b60517
JB
1439(defun face-attr-construct (face &optional _frame)
1440 "Return a `defface'-style attribute list for FACE.
5f5c8ee5
GM
1441Value is a property list of pairs ATTRIBUTE VALUE for all specified
1442face attributes of FACE where ATTRIBUTE is the attribute name and
06b60517
JB
1443VALUE is the specified value of that attribute.
1444Argument FRAME is ignored and retained for compatibility."
5f5c8ee5
GM
1445 (let (result)
1446 (dolist (entry face-attribute-name-alist result)
1447 (let* ((attribute (car entry))
1448 (value (face-attribute face attribute)))
1449 (unless (eq value 'unspecified)
1450 (setq result (nconc (list attribute value) result)))))))
00f51890 1451
5f5c8ee5
GM
1452
1453(defun face-spec-set-match-display (display frame)
1454 "Non-nil if DISPLAY matches FRAME.
1455DISPLAY is part of a spec such as can be used in `defface'.
1456If FRAME is nil, the current FRAME is used."
1457 (let* ((conjuncts display)
1458 conjunct req options
1459 ;; t means we have succeeded against all the conjuncts in
1460 ;; DISPLAY that have been tested so far.
1461 (match t))
1462 (if (eq conjuncts t)
1463 (setq conjuncts nil))
1464 (while (and conjuncts match)
1465 (setq conjunct (car conjuncts)
1466 conjuncts (cdr conjuncts)
1467 req (car conjunct)
1468 options (cdr conjunct)
1469 match (cond ((eq req 'type)
428a555e 1470 (or (memq (window-system frame) options)
ee0e9f11
LMI
1471 (and (memq 'graphic options)
1472 (memq (window-system frame) '(x w32 ns)))
1695ca2b
EZ
1473 ;; FIXME: This should be revisited to use
1474 ;; display-graphic-p, provided that the
1475 ;; color selection depends on the number
1476 ;; of supported colors, and all defface's
1477 ;; are changed to look at number of colors
1478 ;; instead of (type graphic) etc.
dcb79f20
AS
1479 (if (null (window-system frame))
1480 (memq 'tty options)
1481 (or (and (memq 'motif options)
1482 (featurep 'motif))
1483 (and (memq 'gtk options)
1484 (featurep 'gtk))
1485 (and (memq 'lucid options)
1486 (featurep 'x-toolkit)
1487 (not (featurep 'motif))
1488 (not (featurep 'gtk)))
1489 (and (memq 'x-toolkit options)
1490 (featurep 'x-toolkit))))))
6b61353c
KH
1491 ((eq req 'min-colors)
1492 (>= (display-color-cells frame) (car options)))
5f5c8ee5
GM
1493 ((eq req 'class)
1494 (memq (frame-parameter frame 'display-type) options))
1495 ((eq req 'background)
1496 (memq (frame-parameter frame 'background-mode)
1497 options))
16320ac7
MB
1498 ((eq req 'supports)
1499 (display-supports-face-attributes-p options frame))
70d0c3b0 1500 (t (error "Unknown req `%S' with options `%S'"
5f5c8ee5
GM
1501 req options)))))
1502 match))
1503
1504
1505(defun face-spec-choose (spec &optional frame)
96c2938f
MB
1506 "Choose the proper attributes for FRAME, out of SPEC.
1507If SPEC is nil, return nil."
5f5c8ee5
GM
1508 (unless frame
1509 (setq frame (selected-frame)))
1510 (let ((tail spec)
cf459bb7 1511 result defaults)
5f5c8ee5 1512 (while tail
073f69e6
MB
1513 (let* ((entry (pop tail))
1514 (display (car entry))
cf459bb7
RS
1515 (attrs (cdr entry))
1516 thisval)
1517 ;; Get the attributes as actually specified by this alternative.
1518 (setq thisval
1519 (if (null (cdr attrs)) ;; was (listp (car attrs))
1520 ;; Old-style entry, the attribute list is the
1521 ;; first element.
1522 (car attrs)
1523 attrs))
1524
1525 ;; If the condition is `default', that sets the default
1526 ;; for following conditions.
1527 (if (eq display 'default)
1528 (setq defaults thisval)
1529 ;; Otherwise, if it matches, use it.
1530 (when (face-spec-set-match-display display frame)
1531 (setq result thisval)
b6b90dfc 1532 (setq tail nil)))))
cf459bb7 1533 (if defaults (append result defaults) result)))
5f5c8ee5
GM
1534
1535
1536(defun face-spec-reset-face (face &optional frame)
1537 "Reset all attributes of FACE on FRAME to unspecified."
c349f4e6
CY
1538 (apply 'set-face-attribute face frame
1539 (if (eq face 'default)
1540 ;; For the default face, avoid making any attribute
f003f294 1541 ;; unspecified. Instead, set attributes to default values
c349f4e6
CY
1542 ;; (see also realize_default_face in xfaces.c).
1543 (append
1544 '(:underline nil :overline nil :strike-through nil
1545 :box nil :inverse-video nil :stipple nil :inherit nil)
4c5779ab
CY
1546 ;; `display-graphic-p' is unavailable when running
1547 ;; temacs, prior to loading frame.el.
1548 (unless (and (fboundp 'display-graphic-p)
1549 (display-graphic-p frame))
67ada220 1550 `(:family "default" :foundry "default" :width normal
c349f4e6 1551 :height 1 :weight normal :slant normal
67ada220
AS
1552 :foreground ,(if (frame-parameter nil 'reverse)
1553 "unspecified-bg"
1554 "unspecified-fg")
1555 :background ,(if (frame-parameter nil 'reverse)
1556 "unspecified-fg"
1557 "unspecified-bg"))))
c349f4e6
CY
1558 ;; For all other faces, unspecify all attributes.
1559 (apply 'append
1560 (mapcar (lambda (x) (list (car x) 'unspecified))
1561 face-attribute-name-alist)))))
5f5c8ee5 1562
24837f13 1563(defun face-spec-set (face spec &optional for-defface)
eeddc531
CY
1564 "Set and apply the face spec for FACE.
1565If the optional argument FOR-DEFFACE is omitted or nil, set the
1566overriding spec to SPEC, recording it in the `face-override-spec'
1567property of FACE. See `defface' for the format of SPEC.
1568
1569If FOR-DEFFACE is non-nil, set the base spec (the one set by
1570`defface' and Custom). In this case, SPEC is ignored; the caller
1571is responsible for putting the face spec in the `saved-face',
1572`customized-face', or `face-defface-spec', as appropriate.
1573
1574The appearance of FACE is controlled by the base spec, by any
1575custom theme specs on top of that, and by the overriding spec on
1576top of all the rest."
1577 (if for-defface
1578 ;; When we reset the face based on its custom spec, then it is
1579 ;; unmodified as far as Custom is concerned.
1580 (put (or (get face 'face-alias) face) 'face-modified nil)
1581 ;; When we change a face based on a spec from outside custom,
1582 ;; record it for future frames.
1583 (put (or (get face 'face-alias) face) 'face-override-spec spec))
1584 ;; Reset each frame according to the rules implied by all its specs.
1585 (dolist (frame (frame-list))
1586 (face-spec-recalc face frame)))
24837f13
RS
1587
1588(defun face-spec-recalc (face frame)
1589 "Reset the face attributes of FACE on FRAME according to its specs.
1590This applies the defface/custom spec first, then the custom theme specs,
1591then the override spec."
1592 (face-spec-reset-face face frame)
1593 (let ((face-sym (or (get face 'face-alias) face)))
7ecc4011
CY
1594 (or (get face 'customized-face)
1595 (get face 'saved-face)
1596 (face-spec-set-2 face frame (face-default-spec face)))
24837f13
RS
1597 (let ((theme-faces (reverse (get face-sym 'theme-face))))
1598 (dolist (spec theme-faces)
1599 (face-spec-set-2 face frame (cadr spec))))
1600 (face-spec-set-2 face frame (get face-sym 'face-override-spec))))
1601
1602(defun face-spec-set-2 (face frame spec)
1603 "Set the face attributes of FACE on FRAME according to SPEC."
4f77c25d
CY
1604 (let* ((spec (face-spec-choose spec frame))
1605 attrs)
1606 (while spec
1607 (when (assq (car spec) face-x-resources)
1608 (push (car spec) attrs)
1609 (push (cadr spec) attrs))
1610 (setq spec (cddr spec)))
1611 (apply 'set-face-attribute face frame (nreverse attrs))))
5f5c8ee5
GM
1612
1613(defun face-attr-match-p (face attrs &optional frame)
a9de7d29 1614 "Return t if attributes of FACE match values in plist ATTRS.
5f5c8ee5
GM
1615Optional parameter FRAME is the frame whose definition of FACE
1616is used. If nil or omitted, use the selected frame."
1617 (unless frame
1618 (setq frame (selected-frame)))
8a6f24e5
GM
1619 (let* ((list face-attribute-name-alist)
1620 (match t)
1621 (bold (and (plist-member attrs :bold)
1622 (not (plist-member attrs :weight))))
1623 (italic (and (plist-member attrs :italic)
1624 (not (plist-member attrs :slant))))
1625 (plist (if (or bold italic)
1626 (copy-sequence attrs)
1627 attrs)))
1628 ;; Handle the Emacs 20 :bold and :italic properties.
1629 (if bold
1630 (plist-put plist :weight (if bold 'bold 'normal)))
1631 (if italic
1632 (plist-put plist :slant (if italic 'italic 'normal)))
4983ddea
CY
1633 (while (and match list)
1634 (let* ((attr (caar list))
a9de7d29 1635 (specified-value
8a6f24e5
GM
1636 (if (plist-member plist attr)
1637 (plist-get plist attr)
a9de7d29 1638 'unspecified))
5f5c8ee5 1639 (value-now (face-attribute face attr frame)))
a9de7d29 1640 (setq match (equal specified-value value-now))
5f5c8ee5
GM
1641 (setq list (cdr list))))
1642 match))
1643
4983ddea 1644(defsubst face-spec-match-p (face spec &optional frame)
5f5c8ee5
GM
1645 "Return t if FACE, on FRAME, matches what SPEC says it should look like."
1646 (face-attr-match-p face (face-spec-choose spec frame) frame))
1647
94fe8a31 1648(defsubst face-default-spec (face)
96c2938f
MB
1649 "Return the default face-spec for FACE, ignoring any user customization.
1650If there is no default for FACE, return nil."
1651 (get face 'face-defface-spec))
5f5c8ee5 1652
94fe8a31
MB
1653(defsubst face-user-default-spec (face)
1654 "Return the user's customized face-spec for FACE, or the default if none.
7cd512f2 1655If there is neither a user setting nor a default for FACE, return nil."
e44d251c
JL
1656 (or (get face 'customized-face)
1657 (get face 'saved-face)
94fe8a31
MB
1658 (face-default-spec face)))
1659
5f5c8ee5 1660\f
f795f633
EZ
1661;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1662;;; Frame-type independent color support.
1663;;; We keep the old x-* names as aliases for back-compatibility.
1664;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1665
1666(defun defined-colors (&optional frame)
1667 "Return a list of colors supported for a particular frame.
1668The argument FRAME specifies which frame to try.
1669The value may be different for frames on different display types.
43c58260
RS
1670If FRAME doesn't support colors, the value is nil.
1671If FRAME is nil, that stands for the selected frame."
9e2a2647 1672 (if (memq (framep (or frame (selected-frame))) '(x w32 ns))
f795f633 1673 (xw-defined-colors frame)
37462f4c 1674 (mapcar 'car (tty-color-alist frame))))
f795f633
EZ
1675(defalias 'x-defined-colors 'defined-colors)
1676
aa360da1
GM
1677(declare-function xw-color-defined-p "xfns.c" (color &optional frame))
1678
f795f633
EZ
1679(defun color-defined-p (color &optional frame)
1680 "Return non-nil if color COLOR is supported on frame FRAME.
1681If FRAME is omitted or nil, use the selected frame.
293b4814
EZ
1682If COLOR is the symbol `unspecified' or one of the strings
1683\"unspecified-fg\" or \"unspecified-bg\", the value is nil."
1e221c16 1684 (if (member color '(unspecified "unspecified-bg" "unspecified-fg"))
f795f633 1685 nil
9e2a2647 1686 (if (member (framep (or frame (selected-frame))) '(x w32 ns))
f795f633 1687 (xw-color-defined-p color frame)
37462f4c 1688 (numberp (tty-color-translate color frame)))))
f795f633
EZ
1689(defalias 'x-color-defined-p 'color-defined-p)
1690
aa360da1
GM
1691(declare-function xw-color-values "xfns.c" (color &optional frame))
1692
f795f633
EZ
1693(defun color-values (color &optional frame)
1694 "Return a description of the color named COLOR on frame FRAME.
6d713256
CY
1695COLOR should be a string naming a color (e.g. \"white\"), or a
1696string specifying a color's RGB components (e.g. \"#ff12ec\").
1697
1698Return a list of three integers, (RED GREEN BLUE), each between 0
1699and either 65280 or 65535 (the maximum depends on the system).
1700Use `color-name-to-rgb' if you want RGB floating-point values
1701normalized to 1.0.
1702
f795f633
EZ
1703If FRAME is omitted or nil, use the selected frame.
1704If FRAME cannot display COLOR, the value is nil.
6d713256
CY
1705
1706COLOR can also be the symbol `unspecified' or one of the strings
1707\"unspecified-fg\" or \"unspecified-bg\", in which case the
1708return value is nil."
1709 (cond
1710 ((member color '(unspecified "unspecified-fg" "unspecified-bg"))
1711 nil)
1712 ((memq (framep (or frame (selected-frame))) '(x w32 ns))
1713 (xw-color-values color frame))
1714 (t
1715 (tty-color-values color frame))))
1716
f795f633
EZ
1717(defalias 'x-color-values 'color-values)
1718
aa360da1
GM
1719(declare-function xw-display-color-p "xfns.c" (&optional terminal))
1720
f795f633
EZ
1721(defun display-color-p (&optional display)
1722 "Return t if DISPLAY supports color.
1723The optional argument DISPLAY specifies which display to ask about.
1724DISPLAY should be either a frame or a display name (a string).
1725If omitted or nil, that stands for the selected frame's display."
9e2a2647 1726 (if (memq (framep-on-display display) '(x w32 ns))
d5179a01
EZ
1727 (xw-display-color-p display)
1728 (tty-display-color-p display)))
f795f633
EZ
1729(defalias 'x-display-color-p 'display-color-p)
1730
aa360da1
GM
1731(declare-function x-display-grayscale-p "xfns.c" (&optional terminal))
1732
d5179a01
EZ
1733(defun display-grayscale-p (&optional display)
1734 "Return non-nil if frames on DISPLAY can display shades of gray."
1735 (let ((frame-type (framep-on-display display)))
1736 (cond
9e2a2647 1737 ((memq frame-type '(x w32 ns))
d5179a01
EZ
1738 (x-display-grayscale-p display))
1739 (t
1740 (> (tty-color-gray-shades display) 2)))))
1741
9317e499 1742(defun read-color (&optional prompt convert-to-RGB allow-empty-name msg)
315bc30d 1743 "Read a color name or RGB triplet.
9317e499
CY
1744Completion is available for color names, but not for RGB triplets.
1745
315bc30d
CY
1746RGB triplets have the form \"#RRGGBB\". Each of the R, G, and B
1747components can have one to four digits, but all three components
1748must have the same number of digits. Each digit is a hex value
1749between 0 and F; either upper case or lower case for A through F
1750are acceptable.
9317e499
CY
1751
1752In addition to standard color names and RGB hex values, the
1753following are available as color candidates. In each case, the
1754corresponding color is used.
26c07a69
RS
1755
1756 * `foreground at point' - foreground under the cursor
1757 * `background at point' - background under the cursor
1758
9317e499 1759Optional arg PROMPT is the prompt; if nil, use a default prompt.
26c07a69 1760
9317e499
CY
1761Interactively, or with optional arg CONVERT-TO-RGB-P non-nil,
1762convert an input color name to an RGB hex string. Return the RGB
1763hex string.
26c07a69 1764
9317e499
CY
1765If optional arg ALLOW-EMPTY-NAME is non-nil, the user is allowed
1766to enter an empty color name (the empty string).
26c07a69 1767
9317e499
CY
1768Interactively, or with optional arg MSG non-nil, print the
1769resulting color name in the echo area."
26c07a69
RS
1770 (interactive "i\np\ni\np") ; Always convert to RGB interactively.
1771 (let* ((completion-ignore-case t)
9317e499
CY
1772 (colors (or facemenu-color-alist
1773 (append '("foreground at point" "background at point")
1774 (if allow-empty-name '(""))
1775 (defined-colors))))
1776 (color (completing-read
1777 (or prompt "Color (name or #RGB triplet): ")
1778 ;; Completing function for reading colors, accepting
1779 ;; both color names and RGB triplets.
1780 (lambda (string pred flag)
1781 (cond
1782 ((null flag) ; Try completion.
1783 (or (try-completion string colors pred)
1784 (if (color-defined-p string)
1785 string)))
1786 ((eq flag t) ; List all completions.
1787 (or (all-completions string colors pred)
1788 (if (color-defined-p string)
1789 (list string))))
1790 ((eq flag 'lambda) ; Test completion.
1791 (or (memq string colors)
1792 (color-defined-p string)))))
06b60517 1793 nil t)))
9317e499
CY
1794
1795 ;; Process named colors.
1796 (when (member color colors)
1797 (cond ((string-equal color "foreground at point")
1798 (setq color (foreground-color-at-point)))
1799 ((string-equal color "background at point")
1800 (setq color (background-color-at-point))))
1801 (when (and convert-to-RGB
1802 (not (string-equal color "")))
1803 (let ((components (x-color-values color)))
1804 (unless (string-match "^#\\([a-fA-F0-9][a-fA-F0-9][a-fA-F0-9]\\)+$" color)
1805 (setq color (format "#%04X%04X%04X"
1806 (logand 65535 (nth 0 components))
1807 (logand 65535 (nth 1 components))
1808 (logand 65535 (nth 2 components))))))))
1809 (when msg (message "Color: `%s'" color))
1810 color))
1811
26c07a69
RS
1812
1813(defun face-at-point ()
1814 "Return the face of the character after point.
1815If it has more than one face, return the first one.
1816Return nil if it has no specified face."
1817 (let* ((faceprop (or (get-char-property (point) 'read-face-name)
1818 (get-char-property (point) 'face)
1819 'default))
1820 (face (cond ((symbolp faceprop) faceprop)
1821 ;; List of faces (don't treat an attribute spec).
1822 ;; Just use the first face.
1823 ((and (consp faceprop) (not (keywordp (car faceprop)))
1824 (not (memq (car faceprop)
1825 '(foreground-color background-color))))
1826 (car faceprop))
1827 (t nil)))) ; Invalid face value.
1828 (if (facep face) face nil)))
1829
1830(defun foreground-color-at-point ()
1831 "Return the foreground color of the character after point."
1832 ;; `face-at-point' alone is not sufficient. It only gets named faces.
1833 ;; Need also pick up any face properties that are not associated with named faces.
1834 (let ((face (or (face-at-point)
1835 (get-char-property (point) 'read-face-name)
1836 (get-char-property (point) 'face))))
1837 (cond ((and face (symbolp face))
1838 (let ((value (face-foreground face nil 'default)))
1839 (if (member value '("unspecified-fg" "unspecified-bg"))
1840 nil
1841 value)))
1842 ((consp face)
1843 (cond ((memq 'foreground-color face) (cdr (memq 'foreground-color face)))
1844 ((memq ':foreground face) (cadr (memq ':foreground face)))))
1845 (t nil)))) ; Invalid face value.
1846
1847(defun background-color-at-point ()
1848 "Return the background color of the character after point."
1849 ;; `face-at-point' alone is not sufficient. It only gets named faces.
1850 ;; Need also pick up any face properties that are not associated with named faces.
1851 (let ((face (or (face-at-point)
1852 (get-char-property (point) 'read-face-name)
1853 (get-char-property (point) 'face))))
1854 (cond ((and face (symbolp face))
1855 (let ((value (face-background face nil 'default)))
1856 (if (member value '("unspecified-fg" "unspecified-bg"))
1857 nil
1858 value)))
1859 ((consp face)
1860 (cond ((memq 'background-color face) (cdr (memq 'background-color face)))
1861 ((memq ':background face) (cadr (memq ':background face)))))
1862 (t nil)))) ; Invalid face value.
5f5c8ee5 1863
5f5c8ee5
GM
1864\f
1865;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1866;;; Frame creation.
1867;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1868
aa360da1 1869(declare-function x-parse-geometry "frame.c" (string))
a88324d4 1870(defvar x-display-name)
aa360da1 1871
5f5c8ee5
GM
1872(defun x-handle-named-frame-geometry (parameters)
1873 "Add geometry parameters for a named frame to parameter list PARAMETERS.
1874Value is the new parameter list."
e8a2b2da 1875 ;; Note that `x-resource-name' has a global meaning.
c1ef4455 1876 (let ((x-resource-name (cdr (assq 'name parameters))))
e8a2b2da
CY
1877 (when x-resource-name
1878 ;; Before checking X resources, we must have an X connection.
1879 (or (window-system)
1880 (x-display-list)
1881 (x-open-connection (or (cdr (assq 'display parameters))
1882 x-display-name)))
1883 (let (res-geometry parsed)
1884 (and (setq res-geometry (x-get-resource "geometry" "Geometry"))
1885 (setq parsed (x-parse-geometry res-geometry))
1886 (setq parameters
c1ef4455 1887 (append parameters parsed
e8a2b2da
CY
1888 ;; If the resource specifies a position,
1889 ;; take note of that.
1890 (if (or (assq 'top parsed) (assq 'left parsed))
1891 '((user-position . t) (user-size . t)))))))))
1892 parameters)
5f5c8ee5
GM
1893
1894
1895(defun x-handle-reverse-video (frame parameters)
1896 "Handle the reverse-video frame parameter and X resource.
1897`x-create-frame' does not handle this one."
1898 (when (cdr (or (assq 'reverse parameters)
5f5c8ee5
GM
1899 (let ((resource (x-get-resource "reverseVideo"
1900 "ReverseVideo")))
1901 (if resource
1902 (cons nil (member (downcase resource)
1903 '("on" "true")))))))
1904 (let* ((params (frame-parameters frame))
1905 (bg (cdr (assq 'foreground-color params)))
1906 (fg (cdr (assq 'background-color params))))
1907 (modify-frame-parameters frame
1908 (list (cons 'foreground-color fg)
1909 (cons 'background-color bg)))
1910 (if (equal bg (cdr (assq 'border-color params)))
1911 (modify-frame-parameters frame
1912 (list (cons 'border-color fg))))
1913 (if (equal bg (cdr (assq 'mouse-color params)))
1914 (modify-frame-parameters frame
1915 (list (cons 'mouse-color fg))))
1916 (if (equal bg (cdr (assq 'cursor-color params)))
1917 (modify-frame-parameters frame
1918 (list (cons 'cursor-color fg)))))))
1919
aa360da1 1920(declare-function x-create-frame "xfns.c" (parms))
c8ccffb1 1921(declare-function x-setup-function-keys "term/common-win" (frame))
5f5c8ee5
GM
1922
1923(defun x-create-frame-with-faces (&optional parameters)
c1ef4455
CY
1924 "Create and return a frame with frame parameters PARAMETERS.
1925If PARAMETERS specify a frame name, handle X geometry resources
1926for that name. If PARAMETERS includes a `reverse' parameter, or
1927the X resource ``reverseVideo'' is present, handle that."
5f5c8ee5 1928 (setq parameters (x-handle-named-frame-geometry parameters))
41e6403e
CY
1929 (let* ((params (copy-tree parameters))
1930 (visibility-spec (assq 'visibility parameters))
1931 (delayed-params '(foreground-color background-color font
1932 border-color cursor-color mouse-color
1933 visibility scroll-bar-foreground
1934 scroll-bar-background))
1935 frame success)
1936 (dolist (param delayed-params)
1937 (setq params (assq-delete-all param params)))
1938 (setq frame (x-create-frame `((visibility . nil) . ,params)))
5f5c8ee5
GM
1939 (unwind-protect
1940 (progn
2bb819d5 1941 (x-setup-function-keys frame)
5f5c8ee5 1942 (x-handle-reverse-video frame parameters)
4983ddea 1943 (frame-set-background-mode frame t)
fa7015f4 1944 (face-set-after-frame-default frame parameters)
095fe281 1945 (if (null visibility-spec)
5f5c8ee5
GM
1946 (make-frame-visible frame)
1947 (modify-frame-parameters frame (list visibility-spec)))
1948 (setq success t))
1949 (unless success
1950 (delete-frame frame)))
1951 frame))
1952
fa7015f4
CY
1953(defun face-set-after-frame-default (frame &optional parameters)
1954 "Initialize the frame-local faces of FRAME.
1955Calculate the face definitions using the face specs, custom theme
41e6403e 1956settings, X resources, and `face-new-frame-defaults'.
fa7015f4 1957Finally, apply any relevant face attributes found amongst the
c1ef4455 1958frame parameters in PARAMETERS."
4983ddea 1959 (let ((window-system-p (memq (window-system frame) '(x w32))))
1485f4c0
CY
1960 ;; The `reverse' is so that `default' goes first.
1961 (dolist (face (nreverse (face-list)))
4983ddea
CY
1962 (condition-case ()
1963 (progn
1964 ;; Initialize faces from face spec and custom theme.
1965 (face-spec-recalc face frame)
40ba43b4 1966 ;; X resources for the default face are applied during
4983ddea
CY
1967 ;; `x-create-frame'.
1968 (and (not (eq face 'default)) window-system-p
1969 (make-face-x-resource-internal face frame))
1970 ;; Apply attributes specified by face-new-frame-defaults
1971 (internal-merge-in-global-face face frame))
1972 ;; Don't let invalid specs prevent frame creation.
1973 (error nil))))
1974
fa7015f4 1975 ;; Apply attributes specified by frame parameters.
8db9c5ee 1976 (let ((face-params '((foreground-color default :foreground)
fa7015f4
CY
1977 (background-color default :background)
1978 (font default :font)
1979 (border-color border :background)
1980 (cursor-color cursor :background)
1981 (scroll-bar-foreground scroll-bar :foreground)
1982 (scroll-bar-background scroll-bar :background)
1983 (mouse-color mouse :background))))
8db9c5ee 1984 (dolist (param face-params)
fa7015f4 1985 (let* ((param-name (nth 0 param))
c1ef4455 1986 (value (cdr (assq param-name parameters))))
fa7015f4
CY
1987 (if value
1988 (set-face-attribute (nth 1 param) frame
1989 (nth 2 param) value))))))
5f5c8ee5 1990
53990c84
EZ
1991(defun tty-handle-reverse-video (frame parameters)
1992 "Handle the reverse-video frame parameter for terminal frames."
c1ef4455 1993 (when (cdr (assq 'reverse parameters))
53990c84
EZ
1994 (let* ((params (frame-parameters frame))
1995 (bg (cdr (assq 'foreground-color params)))
1996 (fg (cdr (assq 'background-color params))))
1997 (modify-frame-parameters frame
1998 (list (cons 'foreground-color fg)
1999 (cons 'background-color bg)))
2000 (if (equal bg (cdr (assq 'mouse-color params)))
2001 (modify-frame-parameters frame
2002 (list (cons 'mouse-color fg))))
2003 (if (equal bg (cdr (assq 'cursor-color params)))
2004 (modify-frame-parameters frame
2005 (list (cons 'cursor-color fg)))))))
2006
5f5c8ee5
GM
2007
2008(defun tty-create-frame-with-faces (&optional parameters)
c1ef4455
CY
2009 "Create and return a frame from optional frame parameters PARAMETERS.
2010If PARAMETERS contains a `reverse' parameter, handle that."
5f5c8ee5
GM
2011 (let ((frame (make-terminal-frame parameters))
2012 success)
2013 (unwind-protect
061e4e7f 2014 (with-selected-frame frame
53990c84 2015 (tty-handle-reverse-video frame (frame-parameters frame))
cd85984a 2016
8782c744
SM
2017 (unless (terminal-parameter frame 'terminal-initted)
2018 (set-terminal-parameter frame 'terminal-initted t)
2019 (set-locale-environment nil frame)
2020 (tty-run-terminal-initialization frame))
4983ddea 2021 (frame-set-background-mode frame t)
fa7015f4 2022 (face-set-after-frame-default frame parameters)
5f5c8ee5
GM
2023 (setq success t))
2024 (unless success
2025 (delete-frame frame)))
2026 frame))
465fceed 2027
b34c34da
KL
2028(defun tty-find-type (pred type)
2029 "Return the longest prefix of TYPE to which PRED returns non-nil.
2030TYPE should be a tty type name such as \"xterm-16color\".
2031
2032The function tries only those prefixes that are followed by a
2033dash or underscore in the original type name, like \"xterm\" in
2034the above example."
2035 (let (hyphend)
2036 (while (and type
2037 (not (funcall pred type)))
2038 ;; Strip off last hyphen and what follows, then try again
2039 (setq type
2040 (if (setq hyphend (string-match "[-_][^-_]+$" type))
2041 (substring type 0 hyphend)
2042 nil))))
2043 type)
2044
8cbd7bed
KL
2045(defun tty-run-terminal-initialization (frame &optional type)
2046 "Run the special initialization code for the terminal type of FRAME.
2047The optional TYPE parameter may be used to override the autodetected
2048terminal type to a different value."
2049 (setq type (or type (tty-type frame)))
cd85984a
KL
2050 ;; Load library for our terminal type.
2051 ;; User init file can set term-file-prefix to nil to prevent this.
2052 (with-selected-frame frame
8782c744 2053 (unless (null term-file-prefix)
b34c34da
KL
2054 (let* (term-init-func)
2055 ;; First, load the terminal initialization file, if it is
2056 ;; available and it hasn't been loaded already.
2057 (tty-find-type #'(lambda (type)
2058 (let ((file (locate-library (concat term-file-prefix type))))
2059 (and file
2060 (or (assoc file load-history)
2061 (load file t t)))))
8cbd7bed 2062 type)
b34c34da
KL
2063 ;; Next, try to find a matching initialization function, and call it.
2064 (tty-find-type #'(lambda (type)
2065 (fboundp (setq term-init-func
2066 (intern (concat "terminal-init-" type)))))
8cbd7bed 2067 type)
567c8878 2068 (when (fboundp term-init-func)
b34c34da
KL
2069 (funcall term-init-func))
2070 (set-terminal-parameter frame 'terminal-initted term-init-func)))))
465fceed 2071
5f5c8ee5
GM
2072;; Called from C function init_display to initialize faces of the
2073;; dumped terminal frame on startup.
465fceed 2074
5f5c8ee5
GM
2075(defun tty-set-up-initial-frame-faces ()
2076 (let ((frame (selected-frame)))
4983ddea 2077 (frame-set-background-mode frame t)
5f5c8ee5 2078 (face-set-after-frame-default frame)))
00f51890 2079
465fceed 2080
bdda3754 2081\f
5f5c8ee5
GM
2082;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2083;;; Standard faces.
2084;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
465fceed 2085
5f5c8ee5
GM
2086(defgroup basic-faces nil
2087 "The standard faces of Emacs."
2088 :group 'faces)
ef436392 2089
bacbbe8f
CY
2090(defface default
2091 '((t nil)) ; If this were nil, face-defface-spec would not be set.
5f5c8ee5
GM
2092 "Basic default face."
2093 :group 'basic-faces)
465fceed 2094
51d44a36
JL
2095(defface bold
2096 '((t :weight bold))
2097 "Basic bold face."
2098 :group 'basic-faces)
2099
2100(defface italic
2101 '((((supports :slant italic))
2102 :slant italic)
2103 (((supports :underline t))
2104 :underline t)
2105 (t
9aaf2b9c
GM
2106 ;; Default to italic, even if it doesn't appear to be supported,
2107 ;; because in some cases the display engine will do its own
2108 ;; workaround (to `dim' on ttys).
51d44a36
JL
2109 :slant italic))
2110 "Basic italic face."
2111 :group 'basic-faces)
2112
2113(defface bold-italic
2114 '((t :weight bold :slant italic))
2115 "Basic bold-italic face."
2116 :group 'basic-faces)
2117
2118(defface underline
2119 '((((supports :underline t))
2120 :underline t)
2121 (((supports :weight bold))
2122 :weight bold)
2123 (t :underline t))
2124 "Basic underlined face."
2125 :group 'basic-faces)
2126
2127(defface fixed-pitch
d5f57335 2128 '((t :family "Monospace"))
51d44a36
JL
2129 "The basic fixed-pitch face."
2130 :group 'basic-faces)
2131
2132(defface variable-pitch
ed008205 2133 '((t :family "Sans Serif"))
51d44a36
JL
2134 "The basic variable-pitch face."
2135 :group 'basic-faces)
2136
2137(defface shadow
2138 '((((class color grayscale) (min-colors 88) (background light))
2139 :foreground "grey50")
2140 (((class color grayscale) (min-colors 88) (background dark))
2141 :foreground "grey70")
2142 (((class color) (min-colors 8) (background light))
2143 :foreground "green")
2144 (((class color) (min-colors 8) (background dark))
2145 :foreground "yellow"))
2146 "Basic face for shadowed text."
2147 :group 'basic-faces
2148 :version "22.1")
2149
59746720
JL
2150(defface link
2151 '((((class color) (min-colors 88) (background light))
fa7c3228 2152 :foreground "RoyalBlue3" :underline t)
59746720
JL
2153 (((class color) (background light))
2154 :foreground "blue" :underline t)
2155 (((class color) (min-colors 88) (background dark))
2156 :foreground "cyan1" :underline t)
2157 (((class color) (background dark))
2158 :foreground "cyan" :underline t)
2159 (t :inherit underline))
2160 "Basic face for unvisited links."
2161 :group 'basic-faces
2162 :version "22.1")
2163
2164(defface link-visited
2165 '((default :inherit link)
2166 (((class color) (background light)) :foreground "magenta4")
2167 (((class color) (background dark)) :foreground "violet"))
2168 "Basic face for visited links."
2169 :group 'basic-faces
2170 :version "22.1")
2171
51d44a36
JL
2172(defface highlight
2173 '((((class color) (min-colors 88) (background light))
2174 :background "darkseagreen2")
2175 (((class color) (min-colors 88) (background dark))
2176 :background "darkolivegreen")
2177 (((class color) (min-colors 16) (background light))
2178 :background "darkseagreen2")
2179 (((class color) (min-colors 16) (background dark))
2180 :background "darkolivegreen")
2181 (((class color) (min-colors 8))
2182 :background "green" :foreground "black")
2183 (t :inverse-video t))
2184 "Basic face for highlighting."
2185 :group 'basic-faces)
2186
f3e848f4
AR
2187;; Region face: under NS, default to the system-defined selection
2188;; color (optimized for the fixed white background of other apps),
2189;; if background is light.
51d44a36
JL
2190(defface region
2191 '((((class color) (min-colors 88) (background dark))
2192 :background "blue3")
3a46642b
J
2193 (((class color) (min-colors 88) (background light) (type gtk))
2194 :foreground "gtk_selection_fg_color"
2195 :background "gtk_selection_bg_color")
f3e848f4
AR
2196 (((class color) (min-colors 88) (background light) (type ns))
2197 :background "ns_selection_color")
51d44a36
JL
2198 (((class color) (min-colors 88) (background light))
2199 :background "lightgoldenrod2")
2200 (((class color) (min-colors 16) (background dark))
2201 :background "blue3")
2202 (((class color) (min-colors 16) (background light))
2203 :background "lightgoldenrod2")
2204 (((class color) (min-colors 8))
2205 :background "blue" :foreground "white")
2206 (((type tty) (class mono))
2207 :inverse-video t)
2208 (t :background "gray"))
2209 "Basic face for highlighting the region."
2210 :version "21.1"
2211 :group 'basic-faces)
2212
2213(defface secondary-selection
2214 '((((class color) (min-colors 88) (background light))
2215 :background "yellow1")
2216 (((class color) (min-colors 88) (background dark))
2217 :background "SkyBlue4")
2218 (((class color) (min-colors 16) (background light))
2219 :background "yellow")
2220 (((class color) (min-colors 16) (background dark))
2221 :background "SkyBlue4")
2222 (((class color) (min-colors 8))
2223 :background "cyan" :foreground "black")
2224 (t :inverse-video t))
2225 "Basic face for displaying the secondary selection."
2226 :group 'basic-faces)
2227
2228(defface trailing-whitespace
2229 '((((class color) (background light))
2230 :background "red1")
2231 (((class color) (background dark))
2232 :background "red1")
2233 (t :inverse-video t))
2234 "Basic face for highlighting trailing whitespace."
2235 :version "21.1"
d4c6530f 2236 :group 'whitespace-faces ; like `show-trailing-whitespace'
51d44a36
JL
2237 :group 'basic-faces)
2238
2239(defface escape-glyph
2240 '((((background dark)) :foreground "cyan")
2241 ;; See the comment in minibuffer-prompt for
2242 ;; the reason not to use blue on MS-DOS.
2243 (((type pc)) :foreground "magenta")
2244 ;; red4 is too dark, but some say blue is too loud.
2245 ;; brown seems to work ok. -- rms.
2246 (t :foreground "brown"))
1a77c985 2247 "Face for characters displayed as sequences using `^' or `\\'."
51d44a36
JL
2248 :group 'basic-faces
2249 :version "22.1")
2250
2251(defface nobreak-space
2252 '((((class color) (min-colors 88)) :inherit escape-glyph :underline t)
2253 (((class color) (min-colors 8)) :background "magenta")
2254 (t :inverse-video t))
2255 "Face for displaying nobreak space."
2256 :group 'basic-faces
2257 :version "22.1")
72418504 2258
97bca259
JL
2259(defgroup mode-line-faces nil
2260 "Faces used in the mode line."
6d968826 2261 :group 'mode-line
97bca259
JL
2262 :group 'faces
2263 :version "22.1")
2264
3759f14b 2265(defface mode-line
11c2175c 2266 '((((class color) (min-colors 88))
b6b90dfc
SM
2267 :box (:line-width -1 :style released-button)
2268 :background "grey75" :foreground "black")
5f5c8ee5 2269 (t
b6b90dfc 2270 :inverse-video t))
c5752dcb 2271 "Basic mode line face for selected window."
a4391cf1 2272 :version "21.1"
97bca259 2273 :group 'mode-line-faces
5f5c8ee5 2274 :group 'basic-faces)
465fceed 2275
c5752dcb 2276(defface mode-line-inactive
cf459bb7 2277 '((default
b6b90dfc 2278 :inherit mode-line)
11c2175c 2279 (((class color) (min-colors 88) (background light))
c5752dcb
KS
2280 :weight light
2281 :box (:line-width -1 :color "grey75" :style nil)
2282 :foreground "grey20" :background "grey90")
11c2175c 2283 (((class color) (min-colors 88) (background dark) )
53a2f6e1
MB
2284 :weight light
2285 :box (:line-width -1 :color "grey40" :style nil)
b6b90dfc 2286 :foreground "grey80" :background "grey30"))
c5752dcb 2287 "Basic mode line face for non-selected windows."
bf247b6e 2288 :version "22.1"
97bca259
JL
2289 :group 'mode-line-faces
2290 :group 'basic-faces)
9f255bc3 2291(define-obsolete-face-alias 'modeline-inactive 'mode-line-inactive "22.1")
97bca259
JL
2292
2293(defface mode-line-highlight
2294 '((((class color) (min-colors 88))
2295 :box (:line-width 2 :color "grey40" :style released-button))
2296 (t
2297 :inherit highlight))
2298 "Basic mode line face for highlighting."
2299 :version "22.1"
2300 :group 'mode-line-faces
2301 :group 'basic-faces)
9f255bc3 2302(define-obsolete-face-alias 'modeline-highlight 'mode-line-highlight "22.1")
97bca259 2303
313e2fc4
GM
2304(defface mode-line-emphasis
2305 '((t (:weight bold)))
2306 "Face used to emphasize certain mode line features.
2307Use the face `mode-line-highlight' for features that can be selected."
2308 :version "23.1"
2309 :group 'mode-line-faces
2310 :group 'basic-faces)
2311
97bca259
JL
2312(defface mode-line-buffer-id
2313 '((t (:weight bold)))
2314 "Face used for buffer identification parts of the mode line."
2315 :version "22.1"
2316 :group 'mode-line-faces
c5752dcb 2317 :group 'basic-faces)
9f255bc3 2318(define-obsolete-face-alias 'modeline-buffer-id 'mode-line-buffer-id "22.1")
d11fba25 2319
e5e7779f 2320(defface header-line
cf459bb7 2321 '((default
6b61353c
KH
2322 :inherit mode-line)
2323 (((type tty))
1cb4393e
MB
2324 ;; This used to be `:inverse-video t', but that doesn't look very
2325 ;; good when combined with inverse-video mode-lines and multiple
2326 ;; windows. Underlining looks better, and is more consistent with
2327 ;; the window-system face variants, which deemphasize the
2328 ;; header-line in relation to the mode-line face. If a terminal
2329 ;; can't underline, then the header-line will end up without any
2330 ;; highlighting; this may be too confusing in general, although it
2331 ;; happens to look good with the only current use of header-lines,
2332 ;; the info browser. XXX
6b61353c 2333 :inverse-video nil ;Override the value inherited from mode-line.
a7ac92b6 2334 :underline t)
98490598 2335 (((class color grayscale) (background light))
bdab1d43 2336 :background "grey90" :foreground "grey20"
6b61353c 2337 :box nil)
98490598 2338 (((class color grayscale) (background dark))
bdab1d43 2339 :background "grey20" :foreground "grey90"
6b61353c 2340 :box nil)
98490598 2341 (((class mono) (background light))
bdab1d43
MB
2342 :background "white" :foreground "black"
2343 :inverse-video nil
2344 :box nil
6b61353c 2345 :underline t)
98490598 2346 (((class mono) (background dark))
bdab1d43
MB
2347 :background "black" :foreground "white"
2348 :inverse-video nil
2349 :box nil
6b61353c 2350 :underline t))
e5e7779f 2351 "Basic header-line face."
a4391cf1 2352 :version "21.1"
5f5c8ee5 2353 :group 'basic-faces)
e8e4cda0 2354
51d44a36
JL
2355(defface vertical-border
2356 '((((type tty)) :inherit mode-line-inactive))
2357 "Face used for vertical window dividers on ttys."
2358 :version "22.1"
5f5c8ee5 2359 :group 'basic-faces)
d11fba25 2360
9ed779e8
JL
2361(defface minibuffer-prompt
2362 '((((background dark)) :foreground "cyan")
2363 ;; Don't use blue because many users of the MS-DOS port customize
2364 ;; their foreground color to be blue.
2365 (((type pc)) :foreground "magenta")
c57a1dc6 2366 (t :foreground "medium blue"))
9ed779e8
JL
2367 "Face for minibuffer prompts.
2368By default, Emacs automatically adds this face to the value of
2369`minibuffer-prompt-properties', which is a list of text properties
2370used to display the prompt text."
bf247b6e 2371 :version "22.1"
31cf46d3
RS
2372 :group 'basic-faces)
2373
2374(setq minibuffer-prompt-properties
2375 (append minibuffer-prompt-properties (list 'face 'minibuffer-prompt)))
2376
f1cae29e 2377(defface fringe
d6d59057 2378 '((((class color) (background light))
b6b90dfc
SM
2379 :background "grey95")
2380 (((class color) (background dark))
2381 :background "grey10")
2382 (t
2383 :background "gray"))
f1cae29e
GM
2384 "Basic face for the fringes to the left and right of windows under X."
2385 :version "21.1"
84fe35f0 2386 :group 'frames
f1cae29e
GM
2387 :group 'basic-faces)
2388
d390b4d2 2389(defface scroll-bar '((t nil))
f1cae29e
GM
2390 "Basic face for the scroll bar colors under X."
2391 :version "21.1"
84fe35f0 2392 :group 'frames
f1cae29e
GM
2393 :group 'basic-faces)
2394
d390b4d2 2395(defface border '((t nil))
f1cae29e
GM
2396 "Basic face for the frame border under X."
2397 :version "21.1"
84fe35f0 2398 :group 'frames
f1cae29e
GM
2399 :group 'basic-faces)
2400
4983ddea
CY
2401(defface cursor
2402 '((((background light)) :background "black")
2403 (((background dark)) :background "white"))
8d413c2b 2404 "Basic face for the cursor color under X.
08b0fee8
CY
2405Currently, only the `:background' attribute is meaningful; all
2406other attributes are ignored. The cursor foreground color is
2407taken from the background color of the underlying text.
2408
8d413c2b 2409Note: Other faces cannot inherit from the cursor face."
f1cae29e 2410 :version "21.1"
84fe35f0 2411 :group 'cursor
f1cae29e
GM
2412 :group 'basic-faces)
2413
8d413c2b 2414(put 'cursor 'face-no-inherit t)
f1cae29e 2415
d390b4d2 2416(defface mouse '((t nil))
f1cae29e 2417 "Basic face for the mouse color under X."
e59176e2 2418 :version "21.1"
84fe35f0 2419 :group 'mouse
5f5c8ee5 2420 :group 'basic-faces)
bdda3754 2421
51d44a36
JL
2422(defface tool-bar
2423 '((default
2424 :box (:line-width 1 :style released-button)
2425 :foreground "black")
9e2a2647 2426 (((type x w32 ns) (class color))
51d44a36
JL
2427 :background "grey75")
2428 (((type x) (class mono))
2429 :background "grey"))
2430 "Basic tool-bar face."
2431 :version "21.1"
5f5c8ee5 2432 :group 'basic-faces)
bdda3754 2433
51d44a36
JL
2434(defface menu
2435 '((((type tty))
2436 :inverse-video t)
2437 (((type x-toolkit))
2438 )
16320ac7 2439 (t
51d44a36
JL
2440 :inverse-video t))
2441 "Basic face for the font and colors of the menu bar and popup menus."
a4391cf1 2442 :version "21.1"
51d44a36 2443 :group 'menu
a4391cf1 2444 :group 'basic-faces)
465fceed 2445
4c47bd1e 2446(defface help-argument-name '((t :inherit italic))
6c58c39c
CY
2447 "Face to highlight argument names in *Help* buffers."
2448 :group 'help)
b2cca856 2449
b18fad6d
KH
2450(defface glyphless-char
2451 '((((type tty)) :inherit underline)
1cd64aae 2452 (((type pc)) :inherit escape-glyph)
b18fad6d 2453 (t :height 0.6))
b2cca856
KH
2454 "Face for displaying non-graphic characters (e.g. U+202A (LRE)).
2455It is used for characters of no fonts too."
2456 :version "24.1"
2457 :group 'basic-faces)
bc987f8b
JL
2458
2459(defface error
4b56d0fe
CY
2460 '((default :weight bold)
2461 (((class color) (min-colors 88) (background light)) :foreground "Red1")
2462 (((class color) (min-colors 88) (background dark)) :foreground "Pink")
2463 (((class color) (min-colors 16) (background light)) :foreground "Red1")
2464 (((class color) (min-colors 16) (background dark)) :foreground "Pink")
2465 (((class color) (min-colors 8)) :foreground "red")
2466 (t :inverse-video t))
bc987f8b
JL
2467 "Basic face used to highlight errors and to denote failure."
2468 :version "24.1"
2469 :group 'basic-faces)
2470
2471(defface warning
4b56d0fe
CY
2472 '((default :weight bold)
2473 (((class color) (min-colors 16)) :foreground "DarkOrange")
2474 (((class color)) :foreground "yellow"))
bc987f8b
JL
2475 "Basic face used to highlight warnings."
2476 :version "24.1"
2477 :group 'basic-faces)
2478
2479(defface success
4b56d0fe
CY
2480 '((default :weight bold)
2481 (((class color) (min-colors 16) (background light)) :foreground "ForestGreen")
2482 (((class color) (min-colors 88) (background dark)) :foreground "Green1")
2483 (((class color) (min-colors 16) (background dark)) :foreground "Green")
2484 (((class color)) :foreground "green"))
bc987f8b
JL
2485 "Basic face used to indicate successful operation."
2486 :version "24.1"
2487 :group 'basic-faces)
2488
465fceed 2489\f
5f5c8ee5
GM
2490;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2491;;; Manipulating font names.
2492;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2493
da6062e6 2494;; This is here for compatibility with Emacs 20.2. For example,
07f27947
DL
2495;; international/fontset.el uses x-resolve-font-name. The following
2496;; functions are not used in the face implementation itself.
465fceed 2497
d7fa5aa2
RS
2498(defvar x-font-regexp nil)
2499(defvar x-font-regexp-head nil)
2500(defvar x-font-regexp-weight nil)
2501(defvar x-font-regexp-slant nil)
465fceed 2502
021ca129
KH
2503(defconst x-font-regexp-weight-subnum 1)
2504(defconst x-font-regexp-slant-subnum 2)
2505(defconst x-font-regexp-swidth-subnum 3)
2506(defconst x-font-regexp-adstyle-subnum 4)
2507
465fceed
ER
2508;;; Regexps matching font names in "Host Portable Character Representation."
2509;;;
2510(let ((- "[-?]")
2511 (foundry "[^-]+")
2512 (family "[^-]+")
2513 (weight "\\(bold\\|demibold\\|medium\\)") ; 1
2514; (weight\? "\\(\\*\\|bold\\|demibold\\|medium\\|\\)") ; 1
2515 (weight\? "\\([^-]*\\)") ; 1
2516 (slant "\\([ior]\\)") ; 2
2517; (slant\? "\\([ior?*]?\\)") ; 2
2518 (slant\? "\\([^-]?\\)") ; 2
2519; (swidth "\\(\\*\\|normal\\|semicondensed\\|\\)") ; 3
2520 (swidth "\\([^-]*\\)") ; 3
2521; (adstyle "\\(\\*\\|sans\\|\\)") ; 4
c8787b81 2522 (adstyle "\\([^-]*\\)") ; 4
465fceed
ER
2523 (pixelsize "[0-9]+")
2524 (pointsize "[0-9][0-9]+")
2525 (resx "[0-9][0-9]+")
2526 (resy "[0-9][0-9]+")
2527 (spacing "[cmp?*]")
2528 (avgwidth "[0-9]+")
2529 (registry "[^-]+")
2530 (encoding "[^-]+")
2531 )
2532 (setq x-font-regexp
1e8780b1 2533 (purecopy (concat "\\`\\*?[-?*]"
465fceed 2534 foundry - family - weight\? - slant\? - swidth - adstyle -
e20d641f
RS
2535 pixelsize - pointsize - resx - resy - spacing - avgwidth -
2536 registry - encoding "\\*?\\'"
1e8780b1 2537 )))
465fceed 2538 (setq x-font-regexp-head
1e8780b1
DN
2539 (purecopy (concat "\\`[-?*]" foundry - family - weight\? - slant\?
2540 "\\([-*?]\\|\\'\\)")))
2541 (setq x-font-regexp-slant (purecopy (concat - slant -)))
2542 (setq x-font-regexp-weight (purecopy (concat - weight -)))
70d0c3b0 2543 nil)
465fceed 2544
5f5c8ee5 2545
281dc1c2
JB
2546(defun x-resolve-font-name (pattern &optional face frame)
2547 "Return a font name matching PATTERN.
ac4c2e6b 2548All wildcards in PATTERN are instantiated.
10d89673
JB
2549If PATTERN is nil, return the name of the frame's base font, which never
2550contains wildcards.
e17dbede
RS
2551Given optional arguments FACE and FRAME, return a font which is
2552also the same size as FACE on FRAME, or fail."
14e6867c
RS
2553 (or (symbolp face)
2554 (setq face (face-name face)))
2555 (and (eq frame t)
2556 (setq frame nil))
10d89673 2557 (if pattern
8db93e45 2558 ;; Note that x-list-fonts has code to handle a face with nil as its font.
abd89b80 2559 (let ((fonts (x-list-fonts pattern face frame 1)))
10d89673
JB
2560 (or fonts
2561 (if face
962a60aa
RS
2562 (if (string-match "\\*" pattern)
2563 (if (null (face-font face))
2564 (error "No matching fonts are the same height as the frame default font")
2565 (error "No matching fonts are the same height as face `%s'" face))
2566 (if (null (face-font face))
2567 (error "Height of font `%s' doesn't match the frame default font"
2568 pattern)
2569 (error "Height of font `%s' doesn't match face `%s'"
2570 pattern face)))
7cf6fac1 2571 (error "No fonts match `%s'" pattern)))
10d89673
JB
2572 (car fonts))
2573 (cdr (assq 'font (frame-parameters (selected-frame))))))
281dc1c2 2574
f0138172
JB
2575(provide 'faces)
2576
70d0c3b0 2577;;; faces.el ends here