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