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