(show_help_echo): Call message3_nolog with number of
[bpt/emacs.git] / lisp / faces.el
CommitLineData
5f5c8ee5 1;;; faces.el --- Lisp faces
465fceed 2
84fe35f0 3;; Copyright (C) 1992, 1993, 1994, 1995, 1996, 1998, 1999, 2000
5f5c8ee5 4;; Free Software Foundation, Inc.
465fceed
ER
5
6;; This file is part of GNU Emacs.
7
8;; GNU Emacs is free software; you can redistribute it and/or modify
9;; it under the terms of the GNU General Public License as published by
10;; the Free Software Foundation; either version 2, or (at your option)
11;; any later version.
12
13;; GNU Emacs is distributed in the hope that it will be useful,
14;; but WITHOUT ANY WARRANTY; without even the implied warranty of
15;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16;; GNU General Public License for more details.
17
18;; You should have received a copy of the GNU General Public License
b578f267
EN
19;; along with GNU Emacs; see the file COPYING. If not, write to the
20;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
21;; Boston, MA 02111-1307, USA.
465fceed
ER
22
23;;; Commentary:
24
465fceed
ER
25;;; Code:
26
39b3b754 27(eval-when-compile
b5325e78
DL
28 (require 'cl)
29 ;; Warning suppression -- can't require x-win in batch:
30 (autoload 'xw-defined-colors "x-win"))
5f5c8ee5
GM
31
32(require 'cus-face)
33
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
49elements. Font selection tries to find a best matching font for
50those face attributes first that appear first in the list. For
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."
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
GM
66 "*Alist of alternative font family names.
67Each element has the the form (FAMILY ALTERNATIVE1 ALTERNATIVE2 ...).
68If fonts of family FAMILY can't be loaded, try ALTERNATIVE1, then
69ALTERNATIVE2 etc."
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
80 '(("muletibetan-2" "muletibetan-0"))
81 "*Alist of alternative font registry names.
82Each element has the the form (REGISTRY ALTERNATIVE1 ALTERNATIVE2 ...).
83If fonts of registry REGISTRY can't be loaded, try ALTERNATIVE1, then
84ALTERNATIVE2 etc."
85 :tag "Alternative font registries to try."
86 :type '(repeat (repeat string))
f676894c 87 :version "21.1"
18f1dcb4
GM
88 :group 'font-selection
89 :set #'(lambda (symbol value)
90 (set-default symbol value)
91 (internal-set-alternative-font-registry-alist value)))
92
93
bdda3754 94\f
5f5c8ee5
GM
95;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
96;;; Creation, copying.
97;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
98
99
100(defun face-list ()
101 "Return a list of all defined face names."
102 (mapcar #'car face-new-frame-defaults))
103
104
105;;; ### If not frame-local initialize by what X resources?
106
107(defun make-face (face &optional no-init-from-resources)
108 "Define a new face with name FACE, a symbol.
109NO-INIT-FROM-RESOURCES non-nil means don't initialize frame-local
110variants of FACE from X resources. (X resources recognized are found
111in the global variable `face-x-resources'.) If FACE is already known
112as a face, leave it unmodified. Value is FACE."
113 (interactive "SMake face: ")
114 (unless (facep face)
115 ;; Make frame-local faces (this also makes the global one).
116 (dolist (frame (frame-list))
117 (internal-make-lisp-face face frame))
118 ;; Add the face to the face menu.
119 (when (fboundp 'facemenu-add-new-face)
120 (facemenu-add-new-face face))
121 ;; Define frame-local faces for all frames from X resources.
122 (unless no-init-from-resources
123 (make-face-x-resource-internal face)))
124 face)
125
126
127(defun make-empty-face (face)
128 "Define a new, empty face with name FACE.
129If the face already exists, it is left unmodified. Value is FACE."
130 (interactive "SMake empty face: ")
131 (make-face face 'no-init-from-resources))
132
133
134(defun copy-face (old-face new-face &optional frame new-frame)
135 "Define a face just like OLD-FACE, with name NEW-FACE.
136
137If NEW-FACE already exists as a face, it is modified to be like
138OLD-FACE. If it doesn't already exist, it is created.
139
140If the optional argument FRAME is given as a frame, NEW-FACE is
141changed on FRAME only.
142If FRAME is t, the frame-independent default specification for OLD-FACE
143is copied to NEW-FACE.
144If FRAME is nil, copying is done for the frame-independent defaults
145and for each existing frame.
146
147If the optional fourth argument NEW-FRAME is given,
148copy the information from face OLD-FACE on frame FRAME
149to NEW-FACE on frame NEW-FRAME."
150 (let ((inhibit-quit t))
151 (if (null frame)
152 (progn
153 (dolist (frame (frame-list))
154 (copy-face old-face new-face frame))
155 (copy-face old-face new-face t))
156 (internal-copy-lisp-face old-face new-face frame new-frame))
157 new-face))
158
159
160\f
161;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
162;;; Obsolete functions
163;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
164
165;; The functions in this section are defined because Lisp packages use
166;; them, despite the prefix `internal-' suggesting that they are
70d0c3b0 167;; private to the face implementation.
5f5c8ee5
GM
168
169(defun internal-find-face (name &optional frame)
170 "Retrieve the face named NAME.
171Return nil if there is no such face.
172If the optional argument FRAME is given, this gets the face NAME for
173that frame; otherwise, it uses the selected frame.
174If FRAME is the symbol t, then the global, non-frame face is returned.
175If NAME is already a face, it is simply returned.
176
177This function is defined for compatibility with Emacs 20.2. It
178should not be used anymore."
179 (facep name))
2598a293 180(make-obsolete 'internal-find-face 'facep "21.1")
5f5c8ee5
GM
181
182
183(defun internal-get-face (name &optional frame)
184 "Retrieve the face named NAME; error if there is none.
185If the optional argument FRAME is given, this gets the face NAME for
186that frame; otherwise, it uses the selected frame.
187If FRAME is the symbol t, then the global, non-frame face is returned.
188If NAME is already a face, it is simply returned.
189
190This function is defined for compatibility with Emacs 20.2. It
191should not be used anymore."
192 (or (internal-find-face name frame)
193 (check-face name)))
2598a293 194(make-obsolete 'internal-get-face "See `facep' and `check-face'." "21.1")
5f5c8ee5
GM
195
196\f
197;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
198;;; Predicates, type checks.
199;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
200
201(defun facep (face)
202 "Return non-nil if FACE is a face name."
203 (internal-lisp-face-p face))
204
205
206(defun check-face (face)
207 "Signal an error if FACE doesn't name a face.
208Value is FACE."
209 (unless (facep face)
210 (error "Not a face: %s" face))
211 face)
212
213
214;; The ID returned is not to be confused with the internally used IDs
215;; of realized faces. The ID assigned to Lisp faces is used to
216;; support faces in display table entries.
217
218(defun face-id (face &optional frame)
219 "Return the interNal ID of face with name FACE.
220If optional argument FRAME is nil or omitted, use the selected frame."
221 (check-face face)
222 (get face 'face))
223
224
225(defun face-equal (face1 face2 &optional frame)
226 "Non-nil if faces FACE1 and FACE2 are equal.
227Faces are considered equal if all their attributes are equal.
228If the optional argument FRAME is given, report on face FACE in that frame.
229If FRAME is t, report on the defaults for face FACE (for new frames).
230If FRAME is omitted or nil, use the selected frame."
231 (internal-lisp-face-equal-p face1 face2 frame))
232
233
234(defun face-differs-from-default-p (face &optional frame)
235 "Non-nil if FACE displays differently from the default face.
236If the optional argument FRAME is given, report on face FACE in that frame.
237If FRAME is t, report on the defaults for face FACE (for new frames).
238If FRAME is omitted or nil, use the selected frame.
239A face is considered to be ``the same'' as the default face if it is
240actually specified in the same way (equal attributes) or if it is
241fully-unspecified, and thus inherits the attributes of any face it
242is displayed on top of."
6904df7a
GM
243 (cond ((eq frame t) (setq frame nil))
244 ((null frame) (setq frame (selected-frame))))
245 (let* ((v1 (internal-lisp-face-p face frame))
246 (n (if v1 (length v1) 0))
247 (v2 (internal-lisp-face-p 'default frame))
248 (i 1))
249 (unless v1
250 (error "Not a face: %S" face))
251 (while (and (< i n)
252 (or (eq 'unspecified (aref v1 i))
253 (equal (aref v1 i) (aref v2 i))))
254 (setq i (1+ i)))
255 (< i n)))
5f5c8ee5
GM
256
257
258(defun face-nontrivial-p (face &optional frame)
259 "True if face FACE has some non-nil attribute.
260If the optional argument FRAME is given, report on face FACE in that frame.
261If FRAME is t, report on the defaults for face FACE (for new frames).
262If FRAME is omitted or nil, use the selected frame."
263 (not (internal-lisp-face-empty-p face frame)))
264
265
266\f
267;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
268;;; Setting face attributes from X resources.
269;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
270
271(defcustom face-x-resources
272 '((:family (".attributeFamily" . "Face.AttributeFamily"))
273 (:width (".attributeWidth" . "Face.AttributeWidth"))
274 (:height (".attributeHeight" . "Face.AttributeHeight"))
275 (:weight (".attributeWeight" . "Face.AttributeWeight"))
276 (:slant (".attributeSlant" . "Face.AttributeSlant"))
277 (:foreground (".attributeForeground" . "Face.AttributeForeground"))
278 (:background (".attributeBackground" . "Face.AttributeBackground"))
279 (:overline (".attributeOverline" . "Face.AttributeOverline"))
280 (:strike-through (".attributeStrikeThrough" . "Face.AttributeStrikeThrough"))
281 (:box (".attributeBox" . "Face.AttributeBox"))
282 (:underline (".attributeUnderline" . "Face.AttributeUnderline"))
283 (:inverse-video (".attributeInverse" . "Face.AttributeInverse"))
284 (:stipple
285 (".attributeStipple" . "Face.AttributeStipple")
286 (".attributeBackgroundPixmap" . "Face.AttributeBackgroundPixmap"))
5f5c8ee5
GM
287 (:bold (".attributeBold" . "Face.AttributeBold"))
288 (:italic (".attributeItalic" . "Face.AttributeItalic"))
a0e5a5a4
MB
289 (:font (".attributeFont" . "Face.AttributeFont"))
290 (:inherit (".attributeInherit" . "Face.AttributeInherit")))
5f5c8ee5
GM
291 "*List of X resources and classes for face attributes.
292Each element has the form (ATTRIBUTE ENTRY1 ENTRY2...) where ATTRIBUTE is
293the name of a face attribute, and each ENTRY is a cons of the form
294(RESOURCE . CLASS) with RESOURCE being the resource and CLASS being the
295X resource class for the attribute."
b5325e78 296 :type '(repeat (cons symbol (repeat (cons string string))))
5f5c8ee5
GM
297 :group 'faces)
298
299
300(defun set-face-attribute-from-resource (face attribute resource class frame)
301 "Set FACE's ATTRIBUTE from X resource RESOURCE, class CLASS on FRAME.
302Value is the attribute value specified by the resource, or nil
303if not present. This function displays a message if the resource
304specifies an invalid attribute."
305 (let* ((face-name (face-name face))
306 (value (internal-face-x-get-resource (concat face-name resource)
307 class frame)))
308 (when value
309 (condition-case ()
310 (internal-set-lisp-face-attribute-from-resource
311 face attribute (downcase value) frame)
312 (error
313 (message "Face %s, frame %s: invalid attribute %s %s from X resource"
314 face-name frame attribute value))))
315 value))
316
317
318(defun set-face-attributes-from-resources (face frame)
319 "Set attributes of FACE from X resources for FRAME."
1a578e9b 320 (when (memq (framep frame) '(x w32 mac))
5f5c8ee5
GM
321 (dolist (definition face-x-resources)
322 (let ((attribute (car definition)))
323 (dolist (entry (cdr definition))
324 (set-face-attribute-from-resource face attribute (car entry)
325 (cdr entry) frame))))))
326
327
328(defun make-face-x-resource-internal (face &optional frame)
329 "Fill frame-local FACE on FRAME from X resources.
330FRAME nil or not specified means do it for all frames."
331 (if (null frame)
332 (dolist (frame (frame-list))
333 (set-face-attributes-from-resources face frame))
334 (set-face-attributes-from-resources face frame)))
335
336
337\f
338;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
339;;; Retrieving face attributes.
340;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
341
feaad827 342(defun face-name (face)
465fceed 343 "Return the name of face FACE."
5f5c8ee5
GM
344 (symbol-name (check-face face)))
345
346
347(defun face-attribute (face attribute &optional frame)
348 "Return the value of FACE's ATTRIBUTE on FRAME.
349If the optional argument FRAME is given, report on face FACE in that frame.
350If FRAME is t, report on the defaults for face FACE (for new frames).
351If FRAME is omitted or nil, use the selected frame."
352 (internal-get-lisp-face-attribute face attribute frame))
353
354
355(defun face-foreground (face &optional frame)
356 "Return the foreground color name of FACE, or nil if unspecified.
357If the optional argument FRAME is given, report on face FACE in that frame.
358If FRAME is t, report on the defaults for face FACE (for new frames).
359If FRAME is omitted or nil, use the selected frame."
360 (internal-get-lisp-face-attribute face :foreground frame))
361
362
363(defun face-background (face &optional frame)
364 "Return the background color name of FACE, or nil if unspecified.
365If the optional argument FRAME is given, report on face FACE in that frame.
366If FRAME is t, report on the defaults for face FACE (for new frames).
367If FRAME is omitted or nil, use the selected frame."
368 (internal-get-lisp-face-attribute face :background frame))
369
370
371(defun face-stipple (face &optional frame)
372 "Return the stipple pixmap name of FACE, or nil if unspecified.
373If the optional argument FRAME is given, report on face FACE in that frame.
374If FRAME is t, report on the defaults for face FACE (for new frames).
375If FRAME is omitted or nil, use the selected frame."
376 (internal-get-lisp-face-attribute face :stipple frame))
377
378
379(defalias 'face-background-pixmap 'face-stipple)
380
381
382(defun face-underline-p (face &optional frame)
383 "Return non-nil if FACE is underlined.
384If the optional argument FRAME is given, report on face FACE in that frame.
385If FRAME is t, report on the defaults for face FACE (for new frames).
386If FRAME is omitted or nil, use the selected frame."
387 (eq (face-attribute face :underline frame) t))
388
389
390(defun face-inverse-video-p (face &optional frame)
391 "Return non-nil if FACE is in inverse video on FRAME.
392If the optional argument FRAME is given, report on face FACE in that frame.
393If FRAME is t, report on the defaults for face FACE (for new frames).
394If FRAME is omitted or nil, use the selected frame."
395 (eq (face-attribute face :inverse-video frame) t))
396
397
398(defun face-bold-p (face &optional frame)
399 "Return non-nil if the font of FACE is bold on FRAME.
400If the optional argument FRAME is given, report on face FACE in that frame.
401If FRAME is t, report on the defaults for face FACE (for new frames).
402If FRAME is omitted or nil, use the selected frame.
403Use `face-attribute' for finer control."
404 (let ((bold (face-attribute face :weight frame)))
da2c7b8c 405 (memq bold '(semi-bold bold extra-bold ultra-bold))))
5f5c8ee5
GM
406
407
408(defun face-italic-p (face &optional frame)
409 "Return non-nil if the font of FACE is italic on FRAME.
410If the optional argument FRAME is given, report on face FACE in that frame.
411If FRAME is t, report on the defaults for face FACE (for new frames).
412If FRAME is omitted or nil, use the selected frame.
413Use `face-attribute' for finer control."
414 (let ((italic (face-attribute face :slant frame)))
a48f6020 415 (memq italic '(italic oblique))))
5f5c8ee5
GM
416
417
5f5c8ee5
GM
418\f
419;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
420;;; Face documentation.
421;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
422
423(defun face-documentation (face)
424 "Get the documentation string for FACE."
425 (get face 'face-documentation))
426
427
428(defun set-face-documentation (face string)
429 "Set the documentation string for FACE to STRING."
291cfb96 430 ;; Perhaps the text should go in DOC.
49435801 431 (put face 'face-documentation (purecopy string)))
5f5c8ee5
GM
432
433
434(defalias 'face-doc-string 'face-documentation)
435(defalias 'set-face-doc-string 'set-face-documentation)
436
437
438\f
439;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
440;; Setting face attributes.
441;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
442
443
444(defun set-face-attribute (face frame &rest args)
445 "Set attributes of FACE on FRAME from ARGS.
446
447FRAME nil means change attributes on all frames. FRAME t means change
448the default for new frames (this is done automatically each time an
449attribute is changed on all frames).
450
451ARGS must come in pairs ATTRIBUTE VALUE. ATTRIBUTE must be a valid
452face attribute name. All attributes can be set to `unspecified';
453this fact is not further mentioned below.
454
455The following attributes are recognized:
456
457`:family'
458
459VALUE must be a string specifying the font family, e.g. ``courier'',
460or a fontset alias name. If a font family is specified, wild-cards `*'
461and `?' are allowed.
462
463`:width'
464
465VALUE specifies the relative proportionate width of the font to use.
466It must be one of the symbols `ultra-condensed', `extra-condensed',
467`condensed', `semi-condensed', `normal', `semi-expanded', `expanded',
468`extra-expanded', or `ultra-expanded'.
469
470`:height'
471
19feb949
MB
472VALUE must be either an integer specifying the height of the font to use
473in 1/10 pt, a floating point number specifying the amount by which to
474scale any underlying face, or a function, which is called with the old
475height (from the underlying face), and should return the new height.
5f5c8ee5
GM
476
477`:weight'
478
479VALUE specifies the weight of the font to use. It must be one of the
480symbols `ultra-bold', `extra-bold', `bold', `semi-bold', `normal',
481`semi-light', `light', `extra-light', `ultra-light'.
482
483`:slant'
484
485VALUE specifies the slant of the font to use. It must be one of the
486symbols `italic', `oblique', `normal', `reverse-italic', or
487`reverse-oblique'.
488
489`:foreground', `:background'
490
491VALUE must be a color name, a string.
492
493`:underline'
494
495VALUE specifies whether characters in FACE should be underlined. If
496VALUE is t, underline with foreground color of the face. If VALUE is
497a string, underline with that color. If VALUE is nil, explicitly
498don't underline.
499
500`:overline'
501
502VALUE specifies whether characters in FACE should be overlined. If
503VALUE is t, overline with foreground color of the face. If VALUE is a
504string, overline with that color. If VALUE is nil, explicitly don't
505overline.
506
507`:strike-through'
508
509VALUE specifies whether characters in FACE should be drawn with a line
510striking through them. If VALUE is t, use the foreground color of the
511face. If VALUE is a string, strike-through with that color. If VALUE
512is nil, explicitly don't strike through.
513
514`:box'
515
516VALUE specifies whether characters in FACE should have a box drawn
517around them. If VALUE is nil, explicitly don't draw boxes. If
518VALUE is t, draw a box with lines of width 1 in the foreground color
519of the face. If VALUE is a string, the string must be a color name,
520and the box is drawn in that color with a line width of 1. Otherwise,
521VALUE must be a property list of the form `(:line-width WIDTH
522:color COLOR :style STYLE)'. If a keyword/value pair is missing from
523the property list, a default value will be used for the value, as
524specified below. WIDTH specifies the width of the lines to draw; it
525defaults to 1. COLOR is the name of the color to draw in, default is
526the foreground color of the face for simple boxes, and the background
527color of the face for 3D boxes. STYLE specifies whether a 3D box
528should be draw. If STYLE is `released-button', draw a box looking
529like a released 3D button. If STYLE is `pressed-button' draw a box
530that appears like a pressed button. If STYLE is nil, the default if
531the property list doesn't contain a style specification, draw a 2D
532box.
533
534`:inverse-video'
535
536VALUE specifies whether characters in FACE should be displayed in
70d0c3b0 537inverse video. VALUE must be one of t or nil.
5f5c8ee5
GM
538
539`:stipple'
540
541If VALUE is a string, it must be the name of a file of pixmap data.
542The directories listed in the `x-bitmap-file-path' variable are
543searched. Alternatively, VALUE may be a list of the form (WIDTH
544HEIGHT DATA) where WIDTH and HEIGHT are the size in pixels, and DATA
545is a string containing the raw bits of the bitmap. VALUE nil means
546explicitly don't use a stipple pattern.
547
548For convenience, attributes `:family', `:width', `:height', `:weight',
549and `:slant' may also be set in one step from an X font name:
550
551`:font'
552
553Set font-related face attributes from VALUE. VALUE must be a valid
554XLFD font name. If it is a font name pattern, the first matching font
555will be used.
556
557For compatibility with Emacs 20, keywords `:bold' and `:italic' can
558be used to specify that a bold or italic font should be used. VALUE
19feb949
MB
559must be t or nil in that case. A value of `unspecified' is not allowed.
560
561`:inherit'
562
563VALUE is the name of a face from which to inherit attributes, or a list
564of face names. Attributes from inherited faces are merged into the face
565like an underlying face would be, with higher priority than underlying faces."
70a267c9
GM
566 (let ((where (if (null frame) 0 frame)))
567 (setq args (purecopy args))
568 (while args
569 (internal-set-lisp-face-attribute face (car args)
570 (purecopy (cadr args))
571 where)
572 (setq args (cdr (cdr args))))))
5f5c8ee5
GM
573
574
39cac3e7 575(defun make-face-bold (face &optional frame noerror)
5f5c8ee5
GM
576 "Make the font of FACE be bold, if possible.
577FRAME nil or not specified means change face on all frames.
39cac3e7 578Argument NOERROR is ignored and retained for compatibility.
5f5c8ee5 579Use `set-face-attribute' for finer control of the font weight."
84fe35f0 580 (interactive (list (read-face-name "Make which face bold ")))
5f5c8ee5
GM
581 (set-face-attribute face frame :weight 'bold))
582
583
39cac3e7 584(defun make-face-unbold (face &optional frame noerror)
5f5c8ee5 585 "Make the font of FACE be non-bold, if possible.
39cac3e7
GM
586FRAME nil or not specified means change face on all frames.
587Argument NOERROR is ignored and retained for compatibility."
84fe35f0 588 (interactive (list (read-face-name "Make which face non-bold ")))
5f5c8ee5
GM
589 (set-face-attribute face frame :weight 'normal))
590
591
39cac3e7 592(defun make-face-italic (face &optional frame noerror)
5f5c8ee5
GM
593 "Make the font of FACE be italic, if possible.
594FRAME nil or not specified means change face on all frames.
39cac3e7 595Argument NOERROR is ignored and retained for compatibility.
5f5c8ee5 596Use `set-face-attribute' for finer control of the font slant."
84fe35f0 597 (interactive (list (read-face-name "Make which face italic ")))
5f5c8ee5
GM
598 (set-face-attribute face frame :slant 'italic))
599
600
39cac3e7 601(defun make-face-unitalic (face &optional frame noerror)
5f5c8ee5 602 "Make the font of FACE be non-italic, if possible.
70d0c3b0
DL
603FRAME nil or not specified means change face on all frames.
604Argument NOERROR is ignored and retained for compatibility."
84fe35f0 605 (interactive (list (read-face-name "Make which face non-italic ")))
5f5c8ee5
GM
606 (set-face-attribute face frame :slant 'normal))
607
608
39cac3e7 609(defun make-face-bold-italic (face &optional frame noerror)
5f5c8ee5
GM
610 "Make the font of FACE be bold and italic, if possible.
611FRAME nil or not specified means change face on all frames.
39cac3e7 612Argument NOERROR is ignored and retained for compatibility.
5f5c8ee5
GM
613Use `set-face-attribute' for finer control of font weight and slant."
614 (interactive (list (read-face-name "Make which face bold-italic: ")))
615 (set-face-attribute face frame :weight 'bold :slant 'italic))
616
617
618(defun set-face-font (face font &optional frame)
619 "Change font-related attributes of FACE to those of FONT (a string).
620FRAME nil or not specified means change face on all frames.
621This sets the attributes `:family', `:width', `:height', `:weight',
622and `:slant'. When called interactively, prompt for the face and font."
623 (interactive (read-face-and-attribute :font))
624 (set-face-attribute face frame :font font))
625
626
627;; Implementation note: Emulating gray background colors with a
628;; stipple pattern is now part of the face realization process, and is
629;; done in C depending on the frame on which the face is realized.
630
631(defun set-face-background (face color &optional frame)
632 "Change the background color of face FACE to COLOR (a string).
633FRAME nil or not specified means change face on all frames.
634When called interactively, prompt for the face and color."
635 (interactive (read-face-and-attribute :background))
636 (set-face-attribute face frame :background color))
637
638
639(defun set-face-foreground (face color &optional frame)
640 "Change the foreground color of face FACE to COLOR (a string).
641FRAME nil or not specified means change face on all frames.
642When called interactively, prompt for the face and color."
643 (interactive (read-face-and-attribute :foreground))
644 (set-face-attribute face frame :foreground color))
645
646
647(defun set-face-stipple (face stipple &optional frame)
648 "Change the stipple pixmap of face FACE to STIPPLE.
649FRAME nil or not specified means change face on all frames.
70d0c3b0 650STIPPLE should be a string, the name of a file of pixmap data.
5f5c8ee5
GM
651The directories listed in the `x-bitmap-file-path' variable are searched.
652
653Alternatively, STIPPLE may be a list of the form (WIDTH HEIGHT DATA)
654where WIDTH and HEIGHT are the size in pixels,
655and DATA is a string, containing the raw bits of the bitmap."
656 (interactive (read-face-and-attribute :stipple))
657 (set-face-attribute face frame :stipple stipple))
658
659
660(defun set-face-underline (face underline &optional frame)
661 "Specify whether face FACE is underlined.
662UNDERLINE nil means FACE explicitly doesn't underline.
663UNDERLINE non-nil means FACE explicitly does underlining
664with the same of the foreground color.
665If UNDERLINE is a string, underline with the color named UNDERLINE.
666FRAME nil or not specified means change face on all frames.
667Use `set-face-attribute' to ``unspecify'' underlining."
668 (interactive
669 (let ((list (read-face-and-attribute :underline)))
670 (list (car list) (eq (car (cdr list)) t))))
671 (set-face-attribute face frame :underline underline))
672
673
674(defun set-face-underline-p (face underline-p &optional frame)
675 "Specify whether face FACE is underlined.
676UNDERLINE-P nil means FACE explicitly doesn't underline.
677UNDERLINE-P non-nil means FACE explicitly does underlining.
678FRAME nil or not specified means change face on all frames.
679Use `set-face-attribute' to ``unspecify'' underlining."
680 (interactive
681 (let ((list (read-face-and-attribute :underline)))
682 (list (car list) (eq (car (cdr list)) t))))
683 (set-face-attribute face frame :underline underline-p))
684
685
686(defun set-face-inverse-video-p (face inverse-video-p &optional frame)
687 "Specify whether face FACE is in inverse video.
688INVERSE-VIDEO-P non-nil means FACE displays explicitly in inverse video.
689INVERSE-VIDEO-P nil means FACE explicitly is not in inverse video.
690FRAME nil or not specified means change face on all frames.
691Use `set-face-attribute' to ``unspecify'' the inverse video attribute."
692 (interactive
693 (let ((list (read-face-and-attribute :inverse-video)))
694 (list (car list) (eq (car (cdr list)) t))))
695 (set-face-attribute face frame :inverse-video inverse-video-p))
696
697
698(defun set-face-bold-p (face bold-p &optional frame)
699 "Specify whether face FACE is bold.
700BOLD-P non-nil means FACE should explicitly display bold.
701BOLD-P nil means FACE should explicitly display non-bold.
702FRAME nil or not specified means change face on all frames.
703Use `set-face-attribute' or `modify-face' for finer control."
704 (if (null bold-p)
705 (make-face-unbold face frame)
706 (make-face-bold face frame)))
707
708
709(defun set-face-italic-p (face italic-p &optional frame)
710 "Specify whether face FACE is italic.
711ITALIC-P non-nil means FACE should explicitly display italic.
712ITALIC-P nil means FACE should explicitly display non-italic.
713FRAME nil or not specified means change face on all frames.
714Use `set-face-attribute' or `modify-face' for finer control."
715 (if (null italic-p)
716 (make-face-unitalic face frame)
717 (make-face-italic face frame)))
718
719
720(defalias 'set-face-background-pixmap 'set-face-stipple)
721
722
723(defun invert-face (face &optional frame)
724 "Swap the foreground and background colors of FACE.
725FRAME nil or not specified means change face on all frames.
726If FACE specifies neither foreground nor background color,
727set its foreground and background to the background and foreground
728of the default face. Value is FACE."
84fe35f0 729 (interactive (list (read-face-name "Invert face ")))
5f5c8ee5
GM
730 (let ((fg (face-attribute face :foreground frame))
731 (bg (face-attribute face :background frame)))
732 (if (or fg bg)
733 (set-face-attribute face frame :foreground bg :background fg)
734 (set-face-attribute face frame
735 :foreground
736 (face-attribute 'default :background frame)
737 :background
738 (face-attribute 'default :foreground frame))))
739 face)
740
741\f
742;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
743;;; Interactively modifying faces.
744;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
745
746(defun read-face-name (prompt)
747 "Read and return a face symbol, prompting with PROMPT.
748Value is a symbol naming a known face."
749 (let ((face-list (mapcar #'(lambda (x) (cons (symbol-name x) x))
750 (face-list)))
84fe35f0 751 (def (thing-at-point 'symbol))
5f5c8ee5 752 face)
84fe35f0 753 (cond ((assoc def face-list)
19feb949 754 (setq prompt (concat prompt " (default " def "): ")))
84fe35f0
DL
755 (t (setq def nil)
756 (setq prompt (concat prompt ": "))))
757 (while (equal "" (setq face (completing-read
758 prompt face-list nil t nil nil def))))
5f5c8ee5
GM
759 (intern face)))
760
761
762(defun face-valid-attribute-values (attribute &optional frame)
763 "Return valid values for face attribute ATTRIBUTE.
764The optional argument FRAME is used to determine available fonts
765and colors. If it is nil or not specified, the selected frame is
766used. Value is an alist of (NAME . VALUE) if ATTRIBUTE expects a value
767out of a set of discrete values. Value is `integerp' if ATTRIBUTE expects
768an integer value."
fbd5f1cc
GM
769 (let (valid)
770 (setq valid
771 (case attribute
772 (:family
773 (if window-system
774 (mapcar #'(lambda (x) (cons (car x) (car x)))
775 (x-font-family-list))
776 ;; Only one font on TTYs.
777 (list (cons "default" "default"))))
778 ((:width :weight :slant :inverse-video)
779 (mapcar #'(lambda (x) (cons (symbol-name x) x))
780 (internal-lisp-face-attribute-values attribute)))
781 ((:underline :overline :strike-through :box)
782 (if window-system
783 (nconc (mapcar #'(lambda (x) (cons (symbol-name x) x))
784 (internal-lisp-face-attribute-values attribute))
785 (mapcar #'(lambda (c) (cons c c))
786 (x-defined-colors frame)))
787 (mapcar #'(lambda (x) (cons (symbol-name x) x))
788 (internal-lisp-face-attribute-values attribute))))
789 ((:foreground :background)
790 (mapcar #'(lambda (c) (cons c c))
f795f633 791 (defined-colors frame)))
fbd5f1cc
GM
792 ((:height)
793 'integerp)
794 (:stipple
1a578e9b 795 (and (memq window-system '(x w32 mac))
fbd5f1cc 796 (mapcar #'list
37a99821
MB
797 (apply #'nconc
798 (mapcar (lambda (dir)
799 (and (file-readable-p dir)
800 (file-directory-p dir)
801 (directory-files dir)))
802 x-bitmap-file-path)))))
19feb949
MB
803 (:inherit
804 (cons '("none" . nil)
805 (mapcar #'(lambda (c) (cons (symbol-name c) c))
806 (face-list))))
fbd5f1cc
GM
807 (t
808 (error "Internal error"))))
19feb949 809 (if (and (listp valid) (not (memq attribute '(:inherit))))
fbd5f1cc
GM
810 (nconc (list (cons "unspecified" 'unspecified)) valid)
811 valid)))
812
5f5c8ee5
GM
813
814
815(defvar face-attribute-name-alist
816 '((:family . "font family")
817 (:width . "character set width")
818 (:height . "height in 1/10 pt")
819 (:weight . "weight")
820 (:slant . "slant")
821 (:underline . "underline")
822 (:overline . "overline")
823 (:strike-through . "strike-through")
824 (:box . "box")
825 (:inverse-video . "inverse-video display")
826 (:foreground . "foreground color")
827 (:background . "background color")
19feb949
MB
828 (:stipple . "background stipple")
829 (:inherit . "inheritance"))
5f5c8ee5
GM
830 "An alist of descriptive names for face attributes.
831Each element has the form (ATTRIBUTE-NAME . DESCRIPTION) where
832ATTRIBUTE-NAME is a face attribute name (a keyword symbol), and
833DESCRIPTION is a descriptive name for ATTRIBUTE-NAME.")
834
835
836(defun face-descriptive-attribute-name (attribute)
837 "Return a descriptive name for ATTRIBUTE."
838 (cdr (assq attribute face-attribute-name-alist)))
839
840
841(defun face-read-string (face default name &optional completion-alist)
842 "Interactively read a face attribute string value.
19feb949
MB
843FACE is the face whose attribute is read. If non-nil, DEFAULT is the
844default string to return if no new value is entered. NAME is a
845descriptive name of the attribute for prompting. COMPLETION-ALIST is an
846alist of valid values, if non-nil.
5f5c8ee5 847
19feb949 848Entering nothing accepts the default string DEFAULT.
5f5c8ee5 849Value is the new attribute value."
19feb949
MB
850 ;; Capitalize NAME (we don't use `capitalize' because that capitalizes
851 ;; each word in a string separately).
852 (setq name (concat (upcase (substring name 0 1)) (substring name 1)))
5f5c8ee5
GM
853 (let* ((completion-ignore-case t)
854 (value (completing-read
855 (if default
19feb949
MB
856 (format "%s for face `%s' (default %s): "
857 name face default)
858 (format "%s for face `%s': " name face))
5f5c8ee5 859 completion-alist)))
fbd5f1cc 860 (if (equal value "") default value)))
5f5c8ee5
GM
861
862
863(defun face-read-integer (face default name)
864 "Interactively read an integer face attribute value.
865FACE is the face whose attribute is read. DEFAULT is the default
866value to return if no new value is entered. NAME is a descriptive
867name of the attribute for prompting. Value is the new attribute value."
fbd5f1cc
GM
868 (let ((new-value
869 (face-read-string face
19feb949 870 (format "%s" default)
fbd5f1cc
GM
871 name
872 (list (cons "unspecified" 'unspecified)))))
19feb949
MB
873 (cond ((equal new-value "unspecified")
874 'unspecified)
875 ((member new-value '("unspecified-fg" "unspecified-bg"))
876 new-value)
877 (t
878 (string-to-int new-value)))))
5f5c8ee5
GM
879
880
881(defun read-face-attribute (face attribute &optional frame)
882 "Interactively read a new value for FACE's ATTRIBUTE.
883Optional argument FRAME nil or unspecified means read an attribute value
884of a global face. Value is the new attribute value."
885 (let* ((old-value (face-attribute face attribute frame))
886 (attribute-name (face-descriptive-attribute-name attribute))
887 (valid (face-valid-attribute-values attribute frame))
888 new-value)
889 ;; Represent complex attribute values as strings by printing them
890 ;; out. Stipple can be a vector; (WIDTH HEIGHT DATA). Box can be
891 ;; a list `(:width WIDTH :color COLOR)' or `(:width WIDTH :shadow
892 ;; SHADOW)'.
893 (when (and (or (eq attribute :stipple)
894 (eq attribute :box))
895 (or (consp old-value)
896 (vectorp old-value)))
897 (setq old-value (prin1-to-string old-value)))
898 (cond ((listp valid)
19feb949
MB
899 (let ((default
900 (or (car (rassoc old-value valid))
901 (format "%s" old-value))))
902 (setq new-value
903 (face-read-string face default attribute-name valid))
904 (if (equal new-value default)
905 ;; Nothing changed, so don't bother with all the stuff
906 ;; below. In particular, this avoids a non-tty color
907 ;; from being canonicalized for a tty when the user
908 ;; just uses the default.
909 (setq new-value old-value)
910 ;; Terminal frames can support colors that don't appear
911 ;; explicitly in VALID, using color approximation code
912 ;; in tty-colors.el.
913 (if (and (memq attribute '(:foreground :background))
914 (not (memq window-system '(x w32 mac)))
915 (not (member new-value
916 '("unspecified"
917 "unspecified-fg" "unspecified-bg"))))
918 (setq new-value (car (tty-color-desc new-value frame))))
919 (setq new-value (cdr (assoc new-value valid))))))
5f5c8ee5
GM
920 ((eq valid 'integerp)
921 (setq new-value (face-read-integer face old-value attribute-name)))
922 (t (error "Internal error")))
923 ;; Convert stipple and box value text we read back to a list or
924 ;; vector if it looks like one. This makes the assumption that a
925 ;; pixmap file name won't start with an open-paren.
926 (when (and (or (eq attribute :stipple)
927 (eq attribute :box))
928 (stringp new-value)
929 (string-match "^[[(]" new-value))
930 (setq new-value (read new-value)))
931 new-value))
932
933
934(defun read-face-font (face &optional frame)
935 "Read the name of a font for FACE on FRAME.
936If optional argument FRAME Is nil or omitted, use the selected frame."
937 (let ((completion-ignore-case t))
48ec9939 938 (completing-read (format "Set font attributes of face `%s' from font: " face)
b32631c8 939 (mapcar 'list (x-list-fonts "*" nil frame)))))
5f5c8ee5
GM
940
941
942(defun read-all-face-attributes (face &optional frame)
943 "Interactively read all attributes for FACE.
944If optional argument FRAME Is nil or omitted, use the selected frame.
945Value is a property list of attribute names and new values."
946 (let (result)
947 (dolist (attribute face-attribute-name-alist result)
948 (setq result (cons (car attribute)
949 (cons (read-face-attribute face (car attribute) frame)
950 result))))))
951
952
953(defun modify-face (&optional frame)
954 "Modify attributes of faces interactively.
955If optional argument FRAME is nil or omitted, modify the face used
956for newly created frame, i.e. the global face."
957 (interactive)
19feb949 958 (let ((face (read-face-name "Modify face")))
5f5c8ee5
GM
959 (apply #'set-face-attribute face frame
960 (read-all-face-attributes face frame))))
961
962
963(defun read-face-and-attribute (attribute &optional frame)
964 "Read face name and face attribute value.
965ATTRIBUTE is the attribute whose new value is read.
966FRAME nil or unspecified means read attribute value of global face.
967Value is a list (FACE NEW-VALUE) where FACE is the face read
968(a symbol), and NEW-VALUE is value read."
969 (cond ((eq attribute :font)
48ec9939 970 (let* ((prompt "Set font-related attributes of face")
5f5c8ee5
GM
971 (face (read-face-name prompt))
972 (font (read-face-font face frame)))
973 (list face font)))
974 (t
975 (let* ((attribute-name (face-descriptive-attribute-name attribute))
19feb949 976 (prompt (format "Set %s of face" attribute-name))
5f5c8ee5
GM
977 (face (read-face-name prompt))
978 (new-value (read-face-attribute face attribute frame)))
979 (list face new-value)))))
980
981
982\f
983;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
984;;; Listing faces.
985;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
986
987(defvar list-faces-sample-text
988 "abcdefghijklmnopqrstuvwxyz ABCDEFGHIJKLMNOPQRSTUVWXYZ"
989 "*Text string to display as the sample text for `list-faces-display'.")
990
991
992;; The name list-faces would be more consistent, but let's avoid a
993;; conflict with Lucid, which uses that name differently.
994
995(defun list-faces-display ()
996 "List all faces, using the same sample text in each.
997The sample text is a string that comes from the variable
998`list-faces-sample-text'."
999 (interactive)
1000 (let ((faces (sort (face-list) #'string-lessp))
1001 (face nil)
1002 (frame (selected-frame))
84fe35f0 1003 disp-frame window face-name)
5f5c8ee5
GM
1004 (with-output-to-temp-buffer "*Faces*"
1005 (save-excursion
1006 (set-buffer standard-output)
1007 (setq truncate-lines t)
84fe35f0
DL
1008 (insert
1009 (substitute-command-keys
1010 (concat
1011 "Use "
53c80cf6 1012 (if (display-mouse-p) "\\[help-follow-mouse] or ")
32e33f60 1013 "\\[help-follow] on a face name to customize it\n"
84fe35f0
DL
1014 "or on its sample text for a decription of the face.\n\n")))
1015 (setq help-xref-stack nil)
5f5c8ee5
GM
1016 (while faces
1017 (setq face (car faces))
1018 (setq faces (cdr faces))
84fe35f0
DL
1019 (setq face-name (symbol-name face))
1020 (insert (format "%25s " face-name))
1021 ;; Hyperlink to a customization buffer for the face. Using
1022 ;; the help xref mechanism may not be the best way.
1023 (save-excursion
1024 (save-match-data
1025 (search-backward face-name)
70d0c3b0
DL
1026 (help-xref-button 0 (lambda (f)
1027 (if help-xref-stack
1028 (pop help-xref-stack))
1029 (customize-face f))
1030 face-name
eab5a18b 1031 "mouse-2: customize this face")))
5f5c8ee5
GM
1032 (let ((beg (point)))
1033 (insert list-faces-sample-text)
84fe35f0
DL
1034 ;; Hyperlink to a help buffer for the face.
1035 (save-excursion
1036 (save-match-data
1037 (search-backward list-faces-sample-text)
eab5a18b
DL
1038 (help-xref-button 0 #'describe-face face
1039 "mouse-2: describe this face")))
5f5c8ee5
GM
1040 (insert "\n")
1041 (put-text-property beg (1- (point)) 'face face)
1042 ;; If the sample text has multiple lines, line up all of them.
1043 (goto-char beg)
1044 (forward-line 1)
1045 (while (not (eobp))
1046 (insert " ")
1047 (forward-line 1))))
1048 (goto-char (point-min)))
1049 (print-help-return-message))
1050 ;; If the *Faces* buffer appears in a different frame,
1051 ;; copy all the face definitions from FRAME,
1052 ;; so that the display will reflect the frame that was selected.
1053 (setq window (get-buffer-window (get-buffer "*Faces*") t))
1054 (setq disp-frame (if window (window-frame window)
1055 (car (frame-list))))
1056 (or (eq frame disp-frame)
1057 (let ((faces (face-list)))
1058 (while faces
1059 (copy-face (car faces) (car faces) frame disp-frame)
1060 (setq faces (cdr faces)))))))
1061
1062
1063(defun describe-face (face &optional frame)
1064 "Display the properties of face FACE on FRAME.
1065If the optional argument FRAME is given, report on face FACE in that frame.
1066If FRAME is t, report on the defaults for face FACE (for new frames).
1067If FRAME is omitted or nil, use the selected frame."
70d0c3b0 1068 (interactive (list (read-face-name "Describe face")))
5f5c8ee5
GM
1069 (let* ((attrs '((:family . "Family")
1070 (:width . "Width")
1071 (:height . "Height")
1072 (:weight . "Weight")
1073 (:slant . "Slant")
1074 (:foreground . "Foreground")
1075 (:background . "Background")
1076 (:underline . "Underline")
1077 (:overline . "Overline")
1078 (:strike-through . "Strike-through")
1079 (:box . "Box")
1080 (:inverse-video . "Inverse")
b32631c8 1081 (:stipple . "Stipple")
25ac7b52
MB
1082 (:font . "Font or fontset")
1083 (:inherit . "Inherit")))
5f5c8ee5
GM
1084 (max-width (apply #'max (mapcar #'(lambda (x) (length (cdr x)))
1085 attrs))))
1086 (with-output-to-temp-buffer "*Help*"
1087 (save-excursion
1088 (set-buffer standard-output)
1089 (dolist (a attrs)
1090 (let ((attr (face-attribute face (car a) frame)))
1091 (insert (make-string (- max-width (length (cdr a))) ?\ )
1092 (cdr a) ": " (format "%s" attr) "\n")))
1093 (insert "\nDocumentation:\n\n"
1094 (or (face-documentation face)
70d0c3b0
DL
1095 "not documented as a face."))
1096 (let ((customize-label "customize"))
1097 (terpri)
1098 (terpri)
1099 (princ (concat "You can " customize-label " this face."))
1100 (with-current-buffer "*Help*"
1101 (save-excursion
1102 (re-search-backward
1103 (concat "\\(" customize-label "\\)") nil t)
1104 (help-xref-button 1 #'customize-face face
1105 "mouse-2, RET: customize face")))))
1106 (print-help-return-message)
1107 (with-current-buffer "*Help*"
1108 (help-setup-xref (list #'describe-face face) (interactive-p))
1109 (buffer-string)))))
5f5c8ee5
GM
1110\f
1111;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1112;;; Face specifications (defface).
1113;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1114
1115;; Parameter FRAME Is kept for call compatibility to with previous
1116;; face implementation.
1117
1118(defun face-attr-construct (face &optional frame)
1119 "Return a defface-style attribute list for FACE on FRAME.
1120Value is a property list of pairs ATTRIBUTE VALUE for all specified
1121face attributes of FACE where ATTRIBUTE is the attribute name and
1122VALUE is the specified value of that attribute."
1123 (let (result)
1124 (dolist (entry face-attribute-name-alist result)
1125 (let* ((attribute (car entry))
1126 (value (face-attribute face attribute)))
1127 (unless (eq value 'unspecified)
1128 (setq result (nconc (list attribute value) result)))))))
1129
1130
1131(defun face-spec-set-match-display (display frame)
1132 "Non-nil if DISPLAY matches FRAME.
1133DISPLAY is part of a spec such as can be used in `defface'.
1134If FRAME is nil, the current FRAME is used."
1135 (let* ((conjuncts display)
1136 conjunct req options
1137 ;; t means we have succeeded against all the conjuncts in
1138 ;; DISPLAY that have been tested so far.
1139 (match t))
1140 (if (eq conjuncts t)
1141 (setq conjuncts nil))
1142 (while (and conjuncts match)
1143 (setq conjunct (car conjuncts)
1144 conjuncts (cdr conjuncts)
1145 req (car conjunct)
1146 options (cdr conjunct)
1147 match (cond ((eq req 'type)
1148 (or (memq window-system options)
c698842f
MB
1149 (if (display-graphic-p frame)
1150 (memq 'graphic options)
1151 (memq 'tty options))
ee716db5
GM
1152 (and (memq 'motif options)
1153 (featurep 'motif))
1154 (and (memq 'lucid options)
1155 (featurep 'x-toolkit)
1156 (not (featurep 'motif)))
1157 (and (memq 'x-toolkit options)
1158 (featurep 'x-toolkit))))
5f5c8ee5
GM
1159 ((eq req 'class)
1160 (memq (frame-parameter frame 'display-type) options))
1161 ((eq req 'background)
1162 (memq (frame-parameter frame 'background-mode)
1163 options))
70d0c3b0 1164 (t (error "Unknown req `%S' with options `%S'"
5f5c8ee5
GM
1165 req options)))))
1166 match))
1167
1168
1169(defun face-spec-choose (spec &optional frame)
96c2938f
MB
1170 "Choose the proper attributes for FRAME, out of SPEC.
1171If SPEC is nil, return nil."
5f5c8ee5
GM
1172 (unless frame
1173 (setq frame (selected-frame)))
1174 (let ((tail spec)
1175 result)
1176 (while tail
073f69e6
MB
1177 (let* ((entry (pop tail))
1178 (display (car entry))
1179 (attrs (cdr entry)))
5f5c8ee5 1180 (when (face-spec-set-match-display display frame)
073f69e6
MB
1181 (setq result (if (listp (car attrs))
1182 ;; Old-style entry, the attribute list is the
1183 ;; first element.
1184 (car attrs)
1185 attrs)
1186 tail nil))))
5f5c8ee5
GM
1187 result))
1188
1189
1190(defun face-spec-reset-face (face &optional frame)
1191 "Reset all attributes of FACE on FRAME to unspecified."
bfe27647 1192 (let ((attrs face-attribute-name-alist))
5f5c8ee5
GM
1193 (while attrs
1194 (let ((attr-and-name (car attrs)))
bfe27647
GM
1195 (set-face-attribute face frame (car attr-and-name) 'unspecified))
1196 (setq attrs (cdr attrs)))))
5f5c8ee5
GM
1197
1198
1199(defun face-spec-set (face spec &optional frame)
1200 "Set FACE's attributes according to the first matching entry in SPEC.
1201FRAME is the frame whose frame-local face is set. FRAME nil means
96c2938f
MB
1202do it on all frames. See `defface' for information about SPEC.
1203If SPEC is nil, do nothing."
bfe27647 1204 (let ((attrs (face-spec-choose spec frame)))
10ab7a51
GM
1205 (when attrs
1206 (face-spec-reset-face face frame))
5f5c8ee5
GM
1207 (while attrs
1208 (let ((attribute (car attrs))
1209 (value (car (cdr attrs))))
1210 ;; Support some old-style attribute names and values.
1211 (case attribute
1212 (:bold (setq attribute :weight value (if value 'bold 'normal)))
c9630862
GM
1213 (:italic (setq attribute :slant value (if value 'italic 'normal)))
1214 (t (unless (assq attribute face-x-resources)
1215 (setq attribute nil))))
1216 (when attribute
bfe27647
GM
1217 (set-face-attribute face frame attribute value)))
1218 (setq attrs (cdr (cdr attrs))))))
5f5c8ee5
GM
1219
1220
1221(defun face-attr-match-p (face attrs &optional frame)
a9de7d29 1222 "Return t if attributes of FACE match values in plist ATTRS.
5f5c8ee5
GM
1223Optional parameter FRAME is the frame whose definition of FACE
1224is used. If nil or omitted, use the selected frame."
1225 (unless frame
1226 (setq frame (selected-frame)))
1227 (let ((list face-attribute-name-alist)
1228 (match t))
1229 (while (and match (not (null list)))
1230 (let* ((attr (car (car list)))
a9de7d29
MB
1231 (specified-value
1232 (if (plist-member attrs attr)
1233 (plist-get attrs attr)
1234 'unspecified))
5f5c8ee5 1235 (value-now (face-attribute face attr frame)))
a9de7d29 1236 (setq match (equal specified-value value-now))
5f5c8ee5
GM
1237 (setq list (cdr list))))
1238 match))
1239
5f5c8ee5
GM
1240(defun face-spec-match-p (face spec &optional frame)
1241 "Return t if FACE, on FRAME, matches what SPEC says it should look like."
1242 (face-attr-match-p face (face-spec-choose spec frame) frame))
1243
94fe8a31 1244(defsubst face-default-spec (face)
96c2938f
MB
1245 "Return the default face-spec for FACE, ignoring any user customization.
1246If there is no default for FACE, return nil."
1247 (get face 'face-defface-spec))
5f5c8ee5 1248
94fe8a31
MB
1249(defsubst face-user-default-spec (face)
1250 "Return the user's customized face-spec for FACE, or the default if none.
1251If there is neither a user setting or a default for FACE, return nil."
1252 (or (get face 'saved-face)
1253 (face-default-spec face)))
1254
5f5c8ee5 1255\f
f795f633
EZ
1256;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1257;;; Frame-type independent color support.
1258;;; We keep the old x-* names as aliases for back-compatibility.
1259;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1260
1261(defun defined-colors (&optional frame)
1262 "Return a list of colors supported for a particular frame.
1263The argument FRAME specifies which frame to try.
1264The value may be different for frames on different display types.
1265If FRAME doesn't support colors, the value is nil."
1a578e9b 1266 (if (memq (framep (or frame (selected-frame))) '(x w32 mac))
f795f633 1267 (xw-defined-colors frame)
37462f4c 1268 (mapcar 'car (tty-color-alist frame))))
f795f633
EZ
1269(defalias 'x-defined-colors 'defined-colors)
1270
1271(defun color-defined-p (color &optional frame)
1272 "Return non-nil if color COLOR is supported on frame FRAME.
1273If FRAME is omitted or nil, use the selected frame.
293b4814
EZ
1274If COLOR is the symbol `unspecified' or one of the strings
1275\"unspecified-fg\" or \"unspecified-bg\", the value is nil."
1e221c16 1276 (if (member color '(unspecified "unspecified-bg" "unspecified-fg"))
f795f633 1277 nil
1a578e9b 1278 (if (member (framep (or frame (selected-frame))) '(x w32 mac))
f795f633 1279 (xw-color-defined-p color frame)
37462f4c 1280 (numberp (tty-color-translate color frame)))))
f795f633
EZ
1281(defalias 'x-color-defined-p 'color-defined-p)
1282
1283(defun color-values (color &optional frame)
1284 "Return a description of the color named COLOR on frame FRAME.
1285The value is a list of integer RGB values--\(RED GREEN BLUE\).
b0285112 1286These values appear to range from 0 65535; white is \(65535 65535 65535\).
f795f633
EZ
1287If FRAME is omitted or nil, use the selected frame.
1288If FRAME cannot display COLOR, the value is nil.
293b4814
EZ
1289If COLOR is the symbol `unspecified' or one of the strings
1290\"unspecified-fg\" or \"unspecified-bg\", the value is nil."
1e221c16 1291 (if (member color '(unspecified "unspecified-fg" "unspecified-bg"))
f795f633 1292 nil
1a578e9b 1293 (if (memq (framep (or frame (selected-frame))) '(x w32 mac))
f795f633
EZ
1294 (xw-color-values color frame)
1295 (tty-color-values color frame))))
1296(defalias 'x-color-values 'color-values)
1297
1298(defun display-color-p (&optional display)
1299 "Return t if DISPLAY supports color.
1300The optional argument DISPLAY specifies which display to ask about.
1301DISPLAY should be either a frame or a display name (a string).
1302If omitted or nil, that stands for the selected frame's display."
1a578e9b 1303 (if (memq (framep-on-display display) '(x w32 mac))
d5179a01
EZ
1304 (xw-display-color-p display)
1305 (tty-display-color-p display)))
f795f633
EZ
1306(defalias 'x-display-color-p 'display-color-p)
1307
d5179a01
EZ
1308(defun display-grayscale-p (&optional display)
1309 "Return non-nil if frames on DISPLAY can display shades of gray."
1310 (let ((frame-type (framep-on-display display)))
1311 (cond
1312 ((memq frame-type '(x w32 mac))
1313 (x-display-grayscale-p display))
1314 (t
1315 (> (tty-color-gray-shades display) 2)))))
1316
f795f633 1317\f
5f5c8ee5
GM
1318;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1319;;; Background mode.
1320;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1321
1322(defcustom frame-background-mode nil
1323 "*The brightness of the background.
1324Set this to the symbol `dark' if your background color is dark, `light' if
1325your background is light, or nil (default) if you want Emacs to
01eac4fd
GM
1326examine the brightness for you. Don't set this variable with `setq';
1327this won't have the expected effect."
5f5c8ee5
GM
1328 :group 'faces
1329 :set #'(lambda (var value)
c20d5073 1330 (set-default var value)
b5325e78 1331 (mapc 'frame-set-background-mode (frame-list)))
5f5c8ee5 1332 :initialize 'custom-initialize-changed
70d0c3b0 1333 :type '(choice (choice-item dark)
5f5c8ee5
GM
1334 (choice-item light)
1335 (choice-item :tag "default" nil)))
1336
1337
1338(defun frame-set-background-mode (frame)
d8abcd91
MB
1339 "Set up display-dependent faces on FRAME.
1340Display-dependent faces are those which have different definitions
1341according to the `background-mode' and `display-type' frame parameters."
5f5c8ee5
GM
1342 (let* ((bg-resource
1343 (and window-system
1344 (x-get-resource ".backgroundMode" "BackgroundMode")))
772139c0 1345 (bg-color (frame-parameter frame 'background-color))
f161d539
MB
1346 (bg-mode
1347 (cond (frame-background-mode)
f161d539
MB
1348 (bg-resource
1349 (intern (downcase bg-resource)))
772139c0
EZ
1350 ((and (null window-system) (null bg-color))
1351 ;; No way to determine this automatically (?).
1352 'dark)
1353 ;; Unspecified frame background color can only happen
1354 ;; on tty's.
1e221c16 1355 ((member bg-color '(unspecified "unspecified-bg"))
772139c0 1356 'dark)
1e221c16 1357 ((equal bg-color "unspecified-fg") ; inverted colors
772139c0
EZ
1358 'light)
1359 ((>= (apply '+ (x-color-values bg-color frame))
f161d539
MB
1360 ;; Just looking at the screen, colors whose
1361 ;; values add up to .6 of the white total
1362 ;; still look dark to me.
1363 (* (apply '+ (x-color-values "white" frame)) .6))
772139c0
EZ
1364 'light)
1365 (t 'dark)))
f161d539
MB
1366 (display-type
1367 (cond ((null window-system)
1368 (if (tty-display-color-p frame) 'color 'mono))
1369 ((x-display-color-p frame)
1370 'color)
1371 ((x-display-grayscale-p frame)
1372 'grayscale)
1373 (t 'mono)))
1374 (old-bg-mode
1375 (frame-parameter frame 'background-mode))
1376 (old-display-type
1377 (frame-parameter frame 'display-type)))
1378
1379 (unless (and (eq bg-mode old-bg-mode) (eq display-type old-display-type))
1380 (modify-frame-parameters frame
1381 (list (cons 'background-mode bg-mode)
1382 (cons 'display-type display-type)))
1383 ;; For all named faces, choose face specs matching the new frame
1384 ;; parameters.
1385 (dolist (face (face-list))
96c2938f 1386 (face-spec-set face (face-user-default-spec face) frame)))))
5f5c8ee5 1387
5f5c8ee5
GM
1388\f
1389;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1390;;; Frame creation.
1391;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1392
1393(defun x-handle-named-frame-geometry (parameters)
1394 "Add geometry parameters for a named frame to parameter list PARAMETERS.
1395Value is the new parameter list."
1396 (let* ((name (or (cdr (assq 'name parameters))
1397 (cdr (assq 'name default-frame-alist))))
1398 (x-resource-name name)
1399 (res-geometry (if name (x-get-resource "geometry" "Geometry"))))
1400 (when res-geometry
1401 (let ((parsed (x-parse-geometry res-geometry)))
1402 ;; If the resource specifies a position, call the position
1403 ;; and size "user-specified".
1404 (when (or (assq 'top parsed)
1405 (assq 'left parsed))
1406 (setq parsed (append '((user-position . t) (user-size . t)) parsed)))
1407 ;; Put the geometry parameters at the end. Copy
1408 ;; default-frame-alist so that they go after it.
1409 (setq parameters (append parameters default-frame-alist parsed))))
1410 parameters))
1411
1412
1413(defun x-handle-reverse-video (frame parameters)
1414 "Handle the reverse-video frame parameter and X resource.
1415`x-create-frame' does not handle this one."
1416 (when (cdr (or (assq 'reverse parameters)
1417 (assq 'reverse default-frame-alist)
1418 (let ((resource (x-get-resource "reverseVideo"
1419 "ReverseVideo")))
1420 (if resource
1421 (cons nil (member (downcase resource)
1422 '("on" "true")))))))
1423 (let* ((params (frame-parameters frame))
1424 (bg (cdr (assq 'foreground-color params)))
1425 (fg (cdr (assq 'background-color params))))
1426 (modify-frame-parameters frame
1427 (list (cons 'foreground-color fg)
1428 (cons 'background-color bg)))
1429 (if (equal bg (cdr (assq 'border-color params)))
1430 (modify-frame-parameters frame
1431 (list (cons 'border-color fg))))
1432 (if (equal bg (cdr (assq 'mouse-color params)))
1433 (modify-frame-parameters frame
1434 (list (cons 'mouse-color fg))))
1435 (if (equal bg (cdr (assq 'cursor-color params)))
1436 (modify-frame-parameters frame
1437 (list (cons 'cursor-color fg)))))))
1438
1439
1440(defun x-create-frame-with-faces (&optional parameters)
1441 "Create a frame from optional frame parameters PARAMETERS.
1442Parameters not specified by PARAMETERS are taken from
1443`default-frame-alist'. If PARAMETERS specify a frame name,
1444handle X geometry resources for that name. If either PARAMETERS
1445or `default-frame-alist' contains a `reverse' parameter, or
1446the X resource ``reverseVideo'' is present, handle that.
1447Value is the new frame created."
1448 (setq parameters (x-handle-named-frame-geometry parameters))
1449 (let ((visibility-spec (assq 'visibility parameters))
1450 (frame-list (frame-list))
1451 (frame (x-create-frame (cons '(visibility . nil) parameters)))
1452 success)
1453 (unwind-protect
1454 (progn
1455 (x-handle-reverse-video frame parameters)
1456 (frame-set-background-mode frame)
1457 (face-set-after-frame-default frame)
1458 (if (or (null frame-list) (null visibility-spec))
1459 (make-frame-visible frame)
1460 (modify-frame-parameters frame (list visibility-spec)))
1461 (setq success t))
1462 (unless success
1463 (delete-frame frame)))
1464 frame))
1465
1466
1467(defun face-set-after-frame-default (frame)
f1cae29e
GM
1468 "Set frame-local faces of FRAME from face specs and resources.
1469Initialize colors of certain faces from frame parameters."
5f5c8ee5 1470 (dolist (face (face-list))
96c2938f
MB
1471 (face-spec-set face (face-user-default-spec face) frame)
1472 (internal-merge-in-global-face face frame)
1473 (when (memq window-system '(x w32 mac))
1474 (make-face-x-resource-internal face frame)))
f1cae29e
GM
1475
1476 ;; Initialize attributes from frame parameters.
1477 (let ((params '((foreground-color default :foreground)
1478 (background-color default :background)
1479 (border-color border :background)
1480 (cursor-color cursor :background)
1481 (scroll-bar-foreground scroll-bar :foreground)
1482 (scroll-bar-background scroll-bar :background)
1483 (mouse-color mouse :background))))
1484 (while params
1485 (let ((param-name (nth 0 (car params)))
1486 (face (nth 1 (car params)))
1487 (attr (nth 2 (car params)))
1488 value)
1489 (when (setq value (frame-parameter frame param-name))
1490 (set-face-attribute face frame attr value)))
1491 (setq params (cdr params)))))
5f5c8ee5 1492
53990c84
EZ
1493(defun tty-handle-reverse-video (frame parameters)
1494 "Handle the reverse-video frame parameter for terminal frames."
1495 (when (cdr (or (assq 'reverse parameters)
1496 (assq 'reverse default-frame-alist)))
1497 (if (null window-system)
1498 (setq inverse-video t))
1499 (let* ((params (frame-parameters frame))
1500 (bg (cdr (assq 'foreground-color params)))
1501 (fg (cdr (assq 'background-color params))))
1502 (modify-frame-parameters frame
1503 (list (cons 'foreground-color fg)
1504 (cons 'background-color bg)))
1505 (if (equal bg (cdr (assq 'mouse-color params)))
1506 (modify-frame-parameters frame
1507 (list (cons 'mouse-color fg))))
1508 (if (equal bg (cdr (assq 'cursor-color params)))
1509 (modify-frame-parameters frame
1510 (list (cons 'cursor-color fg)))))))
1511
5f5c8ee5
GM
1512
1513(defun tty-create-frame-with-faces (&optional parameters)
1514 "Create a frame from optional frame parameters PARAMETERS.
1515Parameters not specified by PARAMETERS are taken from
1516`default-frame-alist'. If either PARAMETERS or `default-frame-alist'
1517contains a `reverse' parameter, handle that. Value is the new frame
1518created."
1519 (let ((frame (make-terminal-frame parameters))
1520 success)
1521 (unwind-protect
1522 (progn
53990c84 1523 (tty-handle-reverse-video frame (frame-parameters frame))
5f5c8ee5
GM
1524 (frame-set-background-mode frame)
1525 (face-set-after-frame-default frame)
1526 (setq success t))
1527 (unless success
1528 (delete-frame frame)))
1529 frame))
465fceed 1530
465fceed 1531
5f5c8ee5
GM
1532;; Called from C function init_display to initialize faces of the
1533;; dumped terminal frame on startup.
465fceed 1534
5f5c8ee5
GM
1535(defun tty-set-up-initial-frame-faces ()
1536 (let ((frame (selected-frame)))
1537 (frame-set-background-mode frame)
1538 (face-set-after-frame-default frame)))
1539
465fceed 1540
465fceed 1541
5f5c8ee5
GM
1542\f
1543;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1544;;; Compatiblity with 20.2
1545;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
72418504 1546
5f5c8ee5 1547;; Update a frame's faces when we change its default font.
465fceed 1548
c20d5073 1549(defalias 'frame-update-faces 'ignore)
2598a293 1550(make-obsolete 'frame-update-faces "No longer necessary" "21.1")
e8e4cda0 1551
5f5c8ee5
GM
1552;; Update the colors of FACE, after FRAME's own colors have been
1553;; changed.
1bcb155c 1554
c20d5073 1555(defalias 'frame-update-face-colors 'frame-set-background-mode)
2598a293 1556(make-obsolete 'frame-update-face-colors 'frame-set-background-mode "21.1")
d11fba25 1557
bdda3754 1558\f
5f5c8ee5
GM
1559;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1560;;; Standard faces.
1561;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
465fceed 1562
5f5c8ee5
GM
1563(defgroup basic-faces nil
1564 "The standard faces of Emacs."
1565 :group 'faces)
ef436392 1566
465fceed 1567
5f5c8ee5
GM
1568(defface default
1569 '((t nil))
1570 "Basic default face."
1571 :group 'basic-faces)
465fceed 1572
72418504 1573
3759f14b 1574(defface mode-line
1a578e9b 1575 '((((type x w32 mac) (class color))
f6478c66
GM
1576 (:box (:line-width 2 :style released-button)
1577 :background "grey75" :foreground "black"))
5f5c8ee5
GM
1578 (t
1579 (:inverse-video t)))
1580 "Basic mode line face."
a4391cf1 1581 :version "21.1"
84fe35f0 1582 :group 'modeline
5f5c8ee5 1583 :group 'basic-faces)
465fceed 1584
3759f14b
GM
1585;; Make `modeline' an alias for `mode-line', for compatibility.
1586(put 'modeline 'face-alias 'mode-line)
d11fba25 1587
e5e7779f 1588(defface header-line
a114b1ca 1589 '((((type tty))
1cb4393e
MB
1590 ;; This used to be `:inverse-video t', but that doesn't look very
1591 ;; good when combined with inverse-video mode-lines and multiple
1592 ;; windows. Underlining looks better, and is more consistent with
1593 ;; the window-system face variants, which deemphasize the
1594 ;; header-line in relation to the mode-line face. If a terminal
1595 ;; can't underline, then the header-line will end up without any
1596 ;; highlighting; this may be too confusing in general, although it
1597 ;; happens to look good with the only current use of header-lines,
1598 ;; the info browser. XXX
1599 (:underline t))
98490598
MB
1600 (((class color grayscale) (background light))
1601 (:inherit mode-line
1602 :background "grey90" :foreground "grey20"
1603 :box (:line-width 1 :style released-button)))
1604 (((class color grayscale) (background dark))
1605 (:inherit mode-line
1606 :background "grey20" :foreground "grey90"
1607 :box (:line-width 1 :style released-button)))
1608 (((class mono) (background light))
1609 (:inherit mode-line
1610 :background "white" :foreground "black"
1611 :inverse-video nil
1612 :box nil
1613 :underline t))
1614 (((class mono) (background dark))
1615 (:inherit mode-line
1616 :background "black" :foreground "white"
1617 :inverse-video nil
1618 :box nil
1619 :underline t))
5f5c8ee5
GM
1620 (t
1621 (:inverse-video t)))
e5e7779f 1622 "Basic header-line face."
a4391cf1 1623 :version "21.1"
5f5c8ee5 1624 :group 'basic-faces)
e8e4cda0 1625
d11fba25 1626
533322cd 1627(defface tool-bar
1a578e9b 1628 '((((type x w32 mac) (class color))
f6478c66
GM
1629 (:box (:line-width 1 :style released-button)
1630 :background "grey75" :foreground "black"))
9668a746 1631 (((type x) (class mono))
f6478c66
GM
1632 (:box (:line-width 1 :style released-button)
1633 :background "grey" :foreground "black"))
5f5c8ee5
GM
1634 (t
1635 ()))
533322cd 1636 "Basic tool-bar face."
a4391cf1 1637 :version "21.1"
5f5c8ee5 1638 :group 'basic-faces)
d11fba25 1639
bdda3754 1640
5f5c8ee5
GM
1641(defface region
1642 '((((type tty) (class color))
1643 (:background "blue" :foreground "white"))
1644 (((type tty) (class mono))
1645 (:inverse-video t))
1646 (((class color) (background dark))
2af966f9 1647 (:background "blue3"))
5f5c8ee5 1648 (((class color) (background light))
0a9c90a0 1649 (:background "light goldenrod yellow"))
5f5c8ee5 1650 (t (:background "gray")))
62f1e1cd 1651 "Basic face for highlighting the region."
b5325e78 1652 :version "21.1"
5f5c8ee5 1653 :group 'basic-faces)
66a5c2c6 1654
bdda3754 1655
f1cae29e 1656(defface fringe
d6d59057
GM
1657 '((((class color) (background light))
1658 (:background "grey95"))
1659 (((class color) (background dark))
1660 (:background "grey10"))
1661 (t
1662 (:background "gray")))
f1cae29e
GM
1663 "Basic face for the fringes to the left and right of windows under X."
1664 :version "21.1"
84fe35f0 1665 :group 'frames
f1cae29e
GM
1666 :group 'basic-faces)
1667
1668
1669(defface scroll-bar '()
1670 "Basic face for the scroll bar colors under X."
1671 :version "21.1"
84fe35f0 1672 :group 'frames
f1cae29e
GM
1673 :group 'basic-faces)
1674
1675
ee716db5
GM
1676(defface menu
1677 '((((type x-toolkit)) ())
1678 (t (:inverse-video t)))
1679 "Basic menu face."
1680 :version "21.1"
84fe35f0 1681 :group 'menu
ee716db5
GM
1682 :group 'basic-faces)
1683
1684
f1cae29e
GM
1685(defface border '()
1686 "Basic face for the frame border under X."
1687 :version "21.1"
84fe35f0 1688 :group 'frames
f1cae29e
GM
1689 :group 'basic-faces)
1690
1691
1692(defface cursor '()
1693 "Basic face for the cursor color under X."
1694 :version "21.1"
84fe35f0 1695 :group 'cursor
f1cae29e
GM
1696 :group 'basic-faces)
1697
1698
1699(defface mouse '()
1700 "Basic face for the mouse color under X."
e59176e2 1701 :version "21.1"
84fe35f0 1702 :group 'mouse
5f5c8ee5 1703 :group 'basic-faces)
bdda3754 1704
bdda3754 1705
5f5c8ee5
GM
1706(defface bold '((t (:weight bold)))
1707 "Basic bold face."
1708 :group 'basic-faces)
bdda3754 1709
bdda3754 1710
5f5c8ee5
GM
1711(defface italic '((t (:slant italic)))
1712 "Basic italic font."
1713 :group 'basic-faces)
bdda3754 1714
bdda3754 1715
5f5c8ee5
GM
1716(defface bold-italic '((t (:weight bold :slant italic)))
1717 "Basic bold-italic face."
1718 :group 'basic-faces)
465fceed 1719
17b3a11b 1720
5f5c8ee5
GM
1721(defface underline '((t (:underline t)))
1722 "Basic underlined face."
1723 :group 'basic-faces)
465fceed 1724
2f2ddd1e 1725
5f5c8ee5
GM
1726(defface highlight
1727 '((((type tty) (class color))
1728 (:background "green"))
1729 (((class color) (background light))
1730 (:background "darkseagreen2"))
1731 (((class color) (background dark))
1732 (:background "darkolivegreen"))
1733 (t (:inverse-video t)))
a4391cf1
DL
1734 "Basic face for highlighting."
1735 :group 'basic-faces)
465fceed 1736
465fceed 1737
5f5c8ee5
GM
1738(defface secondary-selection
1739 '((((type tty) (class color))
445a653e 1740 (:background "cyan" :foreground "black"))
5f5c8ee5 1741 (((class color) (background light))
230e947b 1742 (:background "yellow"))
5f5c8ee5 1743 (((class color) (background dark))
690d30e6 1744 (:background "SkyBlue4"))
5f5c8ee5 1745 (t (:inverse-video t)))
a4391cf1
DL
1746 "Basic face for displaying the secondary selection."
1747 :group 'basic-faces)
465fceed 1748
93d6fcef 1749
3855860a 1750(defface fixed-pitch '((t (:family "courier")))
5f5c8ee5
GM
1751 "The basic fixed-pitch face."
1752 :group 'basic-faces)
465fceed 1753
5f5c8ee5 1754
3855860a 1755(defface variable-pitch '((t (:family "helv")))
5f5c8ee5
GM
1756 "The basic variable-pitch face."
1757 :group 'basic-faces)
1758
1759
1760(defface trailing-whitespace
1761 '((((class color) (background light))
1762 (:background "red"))
1763 (((class color) (background dark))
1764 (:background "red"))
1765 (t (:inverse-video t)))
a4391cf1
DL
1766 "Basic face for highlighting trailing whitespace."
1767 :version "21.1"
84fe35f0 1768 :group 'font-lock ; like `show-trailing-whitespace'
a4391cf1 1769 :group 'basic-faces)
465fceed
ER
1770
1771
465fceed 1772\f
5f5c8ee5
GM
1773;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1774;;; Manipulating font names.
1775;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1776
1777;; This is here for compatibilty with Emacs 20.2. For example,
07f27947
DL
1778;; international/fontset.el uses x-resolve-font-name. The following
1779;; functions are not used in the face implementation itself.
465fceed 1780
d7fa5aa2
RS
1781(defvar x-font-regexp nil)
1782(defvar x-font-regexp-head nil)
1783(defvar x-font-regexp-weight nil)
1784(defvar x-font-regexp-slant nil)
465fceed 1785
021ca129
KH
1786(defconst x-font-regexp-weight-subnum 1)
1787(defconst x-font-regexp-slant-subnum 2)
1788(defconst x-font-regexp-swidth-subnum 3)
1789(defconst x-font-regexp-adstyle-subnum 4)
1790
465fceed
ER
1791;;; Regexps matching font names in "Host Portable Character Representation."
1792;;;
1793(let ((- "[-?]")
1794 (foundry "[^-]+")
1795 (family "[^-]+")
1796 (weight "\\(bold\\|demibold\\|medium\\)") ; 1
1797; (weight\? "\\(\\*\\|bold\\|demibold\\|medium\\|\\)") ; 1
1798 (weight\? "\\([^-]*\\)") ; 1
1799 (slant "\\([ior]\\)") ; 2
1800; (slant\? "\\([ior?*]?\\)") ; 2
1801 (slant\? "\\([^-]?\\)") ; 2
1802; (swidth "\\(\\*\\|normal\\|semicondensed\\|\\)") ; 3
1803 (swidth "\\([^-]*\\)") ; 3
1804; (adstyle "\\(\\*\\|sans\\|\\)") ; 4
c8787b81 1805 (adstyle "\\([^-]*\\)") ; 4
465fceed
ER
1806 (pixelsize "[0-9]+")
1807 (pointsize "[0-9][0-9]+")
1808 (resx "[0-9][0-9]+")
1809 (resy "[0-9][0-9]+")
1810 (spacing "[cmp?*]")
1811 (avgwidth "[0-9]+")
1812 (registry "[^-]+")
1813 (encoding "[^-]+")
1814 )
1815 (setq x-font-regexp
1816 (concat "\\`\\*?[-?*]"
1817 foundry - family - weight\? - slant\? - swidth - adstyle -
e20d641f
RS
1818 pixelsize - pointsize - resx - resy - spacing - avgwidth -
1819 registry - encoding "\\*?\\'"
465fceed
ER
1820 ))
1821 (setq x-font-regexp-head
1822 (concat "\\`[-?*]" foundry - family - weight\? - slant\?
1823 "\\([-*?]\\|\\'\\)"))
1824 (setq x-font-regexp-slant (concat - slant -))
1825 (setq x-font-regexp-weight (concat - weight -))
70d0c3b0 1826 nil)
465fceed 1827
5f5c8ee5 1828
281dc1c2
JB
1829(defun x-resolve-font-name (pattern &optional face frame)
1830 "Return a font name matching PATTERN.
ac4c2e6b 1831All wildcards in PATTERN are instantiated.
10d89673
JB
1832If PATTERN is nil, return the name of the frame's base font, which never
1833contains wildcards.
e17dbede
RS
1834Given optional arguments FACE and FRAME, return a font which is
1835also the same size as FACE on FRAME, or fail."
14e6867c
RS
1836 (or (symbolp face)
1837 (setq face (face-name face)))
1838 (and (eq frame t)
1839 (setq frame nil))
10d89673 1840 (if pattern
8db93e45 1841 ;; Note that x-list-fonts has code to handle a face with nil as its font.
abd89b80 1842 (let ((fonts (x-list-fonts pattern face frame 1)))
10d89673
JB
1843 (or fonts
1844 (if face
962a60aa
RS
1845 (if (string-match "\\*" pattern)
1846 (if (null (face-font face))
1847 (error "No matching fonts are the same height as the frame default font")
1848 (error "No matching fonts are the same height as face `%s'" face))
1849 (if (null (face-font face))
1850 (error "Height of font `%s' doesn't match the frame default font"
1851 pattern)
1852 (error "Height of font `%s' doesn't match face `%s'"
1853 pattern face)))
7cf6fac1 1854 (error "No fonts match `%s'" pattern)))
10d89673
JB
1855 (car fonts))
1856 (cdr (assq 'font (frame-parameters (selected-frame))))))
281dc1c2 1857
5f5c8ee5 1858
465fceed 1859(defun x-frob-font-weight (font which)
b7ffee5f
SM
1860 (let ((case-fold-search t))
1861 (cond ((string-match x-font-regexp font)
1862 (concat (substring font 0
1863 (match-beginning x-font-regexp-weight-subnum))
1864 which
1865 (substring font (match-end x-font-regexp-weight-subnum)
1866 (match-beginning x-font-regexp-adstyle-subnum))
1867 ;; Replace the ADD_STYLE_NAME field with *
1868 ;; because the info in it may not be the same
1869 ;; for related fonts.
1870 "*"
1871 (substring font (match-end x-font-regexp-adstyle-subnum))))
528fbf51
RS
1872 ((string-match x-font-regexp-head font)
1873 (concat (substring font 0 (match-beginning 1)) which
1874 (substring font (match-end 1))))
1875 ((string-match x-font-regexp-weight font)
b7ffee5f
SM
1876 (concat (substring font 0 (match-beginning 1)) which
1877 (substring font (match-end 1)))))))
2598a293 1878(make-obsolete 'x-frob-font-weight 'make-face-... "21.1")
5f5c8ee5 1879
465fceed 1880(defun x-frob-font-slant (font which)
b7ffee5f
SM
1881 (let ((case-fold-search t))
1882 (cond ((string-match x-font-regexp font)
1883 (concat (substring font 0
1884 (match-beginning x-font-regexp-slant-subnum))
1885 which
1886 (substring font (match-end x-font-regexp-slant-subnum)
1887 (match-beginning x-font-regexp-adstyle-subnum))
1888 ;; Replace the ADD_STYLE_NAME field with *
1889 ;; because the info in it may not be the same
1890 ;; for related fonts.
1891 "*"
1892 (substring font (match-end x-font-regexp-adstyle-subnum))))
528fbf51
RS
1893 ((string-match x-font-regexp-head font)
1894 (concat (substring font 0 (match-beginning 2)) which
1895 (substring font (match-end 2))))
1896 ((string-match x-font-regexp-slant font)
b7ffee5f
SM
1897 (concat (substring font 0 (match-beginning 1)) which
1898 (substring font (match-end 1)))))))
2598a293 1899(make-obsolete 'x-frob-font-slant 'make-face-... "21.1")
5f5c8ee5 1900
465fceed 1901(defun x-make-font-bold (font)
f3f31ccf
RS
1902 "Given an X font specification, make a bold version of it.
1903If that can't be done, return nil."
465fceed 1904 (x-frob-font-weight font "bold"))
2598a293 1905(make-obsolete 'x-make-font-bold 'make-face-bold "21.1")
5f5c8ee5 1906
465fceed 1907(defun x-make-font-demibold (font)
f3f31ccf
RS
1908 "Given an X font specification, make a demibold version of it.
1909If that can't be done, return nil."
465fceed 1910 (x-frob-font-weight font "demibold"))
2598a293 1911(make-obsolete 'x-make-font-demibold 'make-face-bold "21.1")
5f5c8ee5 1912
465fceed 1913(defun x-make-font-unbold (font)
f3f31ccf
RS
1914 "Given an X font specification, make a non-bold version of it.
1915If that can't be done, return nil."
465fceed 1916 (x-frob-font-weight font "medium"))
2598a293 1917(make-obsolete 'x-make-font-unbold 'make-face-unbold "21.1")
5f5c8ee5 1918
465fceed 1919(defun x-make-font-italic (font)
f3f31ccf
RS
1920 "Given an X font specification, make an italic version of it.
1921If that can't be done, return nil."
465fceed 1922 (x-frob-font-slant font "i"))
2598a293 1923(make-obsolete 'x-make-font-italic 'make-face-italic "21.1")
5f5c8ee5 1924
465fceed 1925(defun x-make-font-oblique (font) ; you say tomayto...
f3f31ccf
RS
1926 "Given an X font specification, make an oblique version of it.
1927If that can't be done, return nil."
465fceed 1928 (x-frob-font-slant font "o"))
2598a293 1929(make-obsolete 'x-make-font-oblique 'make-face-italic "21.1")
5f5c8ee5 1930
465fceed 1931(defun x-make-font-unitalic (font)
f3f31ccf
RS
1932 "Given an X font specification, make a non-italic version of it.
1933If that can't be done, return nil."
465fceed 1934 (x-frob-font-slant font "r"))
2598a293 1935(make-obsolete 'x-make-font-unitalic 'make-face-unitalic "21.1")
5f5c8ee5 1936
b7d7285c
KH
1937(defun x-make-font-bold-italic (font)
1938 "Given an X font specification, make a bold and italic version of it.
1939If that can't be done, return nil."
1940 (and (setq font (x-make-font-bold font))
1941 (x-make-font-italic font)))
2598a293 1942(make-obsolete 'x-make-font-bold-italic 'make-face-bold-italic "21.1")
113ab303 1943
f0138172
JB
1944(provide 'faces)
1945
70d0c3b0 1946;;; faces.el ends here