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