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