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