Make a few libraries loadable in isolation
[bpt/emacs.git] / lisp / faces.el
CommitLineData
5f5c8ee5 1;;; faces.el --- Lisp faces
465fceed 2
ab422c4d 3;; Copyright (C) 1992-1996, 1998-2013 Free Software Foundation, Inc.
465fceed 4
6228c05b 5;; Maintainer: FSF
30764597 6;; Keywords: internal
bd78fa1d 7;; Package: emacs
6228c05b 8
465fceed
ER
9;; This file is part of GNU Emacs.
10
eb3fa2cf 11;; GNU Emacs is free software: you can redistribute it and/or modify
465fceed 12;; it under the terms of the GNU General Public License as published by
eb3fa2cf
GM
13;; the Free Software Foundation, either version 3 of the License, or
14;; (at your option) any later version.
465fceed
ER
15
16;; GNU Emacs is distributed in the hope that it will be useful,
17;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19;; GNU General Public License for more details.
20
21;; You should have received a copy of the GNU General Public License
eb3fa2cf 22;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
465fceed
ER
23
24;;; Commentary:
25
465fceed
ER
26;;; Code:
27
f18b81e6
GM
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
c8ccffb1 38(declare-function xw-defined-colors "term/common-win" (&optional frame))
5f5c8ee5 39
b782a458 40(defvar help-xref-stack-item)
2aef0850
JL
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
5f5c8ee5
GM
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)
9201cc28 59 "A list specifying how face font selection chooses fonts.
5f5c8ee5
GM
60Each of the four symbols `:width', `:height', `:weight', and `:slant'
61must appear once in the list, and the list must not contain any other
7c626e9d 62elements. Font selection first tries to find a best matching font
b73f65b6 63for those face attributes that appear before in the list. For
5f5c8ee5
GM
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."
239ad97f 67 :tag "Font selection order"
94354bdd 68 :type '(list symbol symbol symbol symbol)
5f5c8ee5
GM
69 :group 'font-selection
70 :set #'(lambda (symbol value)
71 (set-default symbol value)
72 (internal-set-font-selection-order value)))
73
18f1dcb4 74
ed008205 75;; In the absence of Fontconfig support, Monospace and Sans Serif are
80073c33
CY
76;; unavailable, and we fall back on the courier and helv families,
77;; which are generally available.
5f5c8ee5 78(defcustom face-font-family-alternatives
1e8780b1 79 (mapcar (lambda (arg) (mapcar 'purecopy arg))
d5f57335 80 '(("Monospace" "courier" "fixed")
f37a389e 81 ("courier" "CMU Typewriter Text" "fixed")
ed008205 82 ("Sans Serif" "helv" "helvetica" "arial" "fixed")
1e8780b1 83 ("helv" "helvetica" "arial" "fixed")))
9201cc28 84 "Alist of alternative font family names.
86886bce 85Each element has the form (FAMILY ALTERNATIVE1 ALTERNATIVE2 ...).
5f5c8ee5
GM
86If fonts of family FAMILY can't be loaded, try ALTERNATIVE1, then
87ALTERNATIVE2 etc."
239ad97f 88 :tag "Alternative font families to try"
94354bdd 89 :type '(repeat (repeat string))
5f5c8ee5
GM
90 :group 'font-selection
91 :set #'(lambda (symbol value)
92 (set-default symbol value)
93 (internal-set-alternative-font-family-alist value)))
94
95
18f1dcb4
GM
96;; This is defined originally in xfaces.c.
97(defcustom face-font-registry-alternatives
1e8780b1 98 (mapcar (lambda (arg) (mapcar 'purecopy arg))
0fda9b75 99 (if (featurep 'w32)
990d68dd 100 '(("iso8859-1" "ms-oemlatin")
e38c812e 101 ("gb2312.1980" "gb2312" "gbk" "gb18030")
c97db4e4
AI
102 ("jisx0208.1990" "jisx0208.1983" "jisx0208.1978")
103 ("ksc5601.1989" "ksx1001.1992" "ksc5601.1987")
104 ("muletibetan-2" "muletibetan-0"))
e38c812e 105 '(("gb2312.1980" "gb2312.80&gb8565.88" "gbk" "gb18030")
c97db4e4
AI
106 ("jisx0208.1990" "jisx0208.1983" "jisx0208.1978")
107 ("ksc5601.1989" "ksx1001.1992" "ksc5601.1987")
1e8780b1 108 ("muletibetan-2" "muletibetan-0"))))
9201cc28 109 "Alist of alternative font registry names.
86886bce 110Each element has the form (REGISTRY ALTERNATIVE1 ALTERNATIVE2 ...).
8ac2d32f
KH
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."
239ad97f 114 :tag "Alternative font registries to try"
18f1dcb4 115 :type '(repeat (repeat string))
f676894c 116 :version "21.1"
18f1dcb4
GM
117 :group 'font-selection
118 :set #'(lambda (symbol value)
119 (set-default symbol value)
120 (internal-set-alternative-font-registry-alist value)))
121
bdda3754 122\f
5f5c8ee5
GM
123;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
124;;; Creation, copying.
125;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
126
127
128(defun face-list ()
94ab793f 129 "Return a list of all defined faces."
5f5c8ee5
GM
130 (mapcar #'car face-new-frame-defaults))
131
5f5c8ee5
GM
132(defun make-face (face &optional no-init-from-resources)
133 "Define a new face with name FACE, a symbol.
fb5b8aca
CY
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."
2aef0850
JL
139 (interactive (list (read-from-minibuffer
140 "Make face: " nil nil t 'face-name-history)))
5f5c8ee5
GM
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
5f5c8ee5
GM
153(defun make-empty-face (face)
154 "Define a new, empty face with name FACE.
fb5b8aca 155Do not call this directly from Lisp code; use `defface' instead."
2aef0850
JL
156 (interactive (list (read-from-minibuffer
157 "Make empty face: " nil nil t 'face-name-history)))
5f5c8ee5
GM
158 (make-face face 'no-init-from-resources))
159
5f5c8ee5 160(defun copy-face (old-face new-face &optional frame new-frame)
fb5b8aca
CY
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."
5f5c8ee5
GM
177 (let ((inhibit-quit t))
178 (if (null frame)
179 (progn
341a1bfb
RS
180 (when new-frame
181 (error "Copying face %s from all frames to one frame"
182 old-face))
183 (make-empty-face new-face)
5f5c8ee5
GM
184 (dolist (frame (frame-list))
185 (copy-face old-face new-face frame))
186 (copy-face old-face new-face t))
341a1bfb 187 (make-empty-face new-face)
5f5c8ee5
GM
188 (internal-copy-lisp-face old-face new-face frame new-frame))
189 new-face))
190
5f5c8ee5
GM
191\f
192;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
193;;; Predicates, type checks.
194;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
195
196(defun facep (face)
20d29b0b
RS
197 "Return non-nil if FACE is a face name; nil otherwise.
198A face name can be a string or a symbol."
5f5c8ee5
GM
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
06b60517 214(defun face-id (face &optional _frame)
2df447f2 215 "Return the internal ID of face with name FACE.
b2d5aa46 216If FACE is a face-alias, return the ID of the target face.
9ae89a1a
RS
217The optional argument FRAME is ignored, since the internal face ID
218of a face name is the same for all frames."
5f5c8ee5 219 (check-face face)
b2d5aa46
JB
220 (or (get face 'face)
221 (face-id (get face 'face-alias))))
5f5c8ee5
GM
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.
a09be93a
JB
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).
5f5c8ee5
GM
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)
7e07a66d 233 "Return non-nil if FACE displays differently from the default face.
5f5c8ee5
GM
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).
7e07a66d 236If FRAME is omitted or nil, use the selected frame."
1151d617 237 (let ((attrs
833547aa 238 (delq :inherit (mapcar 'car face-attribute-name-alist)))
1151d617
MB
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))
5f5c8ee5
GM
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
1e8780b1
DN
265 (mapcar
266 (lambda (arg)
267 ;; FIXME; can we purecopy some of the conses too?
e8e4d5c8
SS
268 (cons (car arg)
269 (cons (purecopy (car (cdr arg))) (purecopy (cdr (cdr arg))))))
5f5c8ee5 270 '((:family (".attributeFamily" . "Face.AttributeFamily"))
fcea6e23 271 (:foundry (".attributeFoundry" . "Face.AttributeFoundry"))
5f5c8ee5
GM
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"))
5f5c8ee5
GM
286 (:bold (".attributeBold" . "Face.AttributeBold"))
287 (:italic (".attributeItalic" . "Face.AttributeItalic"))
a0e5a5a4 288 (:font (".attributeFont" . "Face.AttributeFont"))
1e8780b1 289 (:inherit (".attributeInherit" . "Face.AttributeInherit"))))
9201cc28 290 "List of X resources and classes for face attributes.
5f5c8ee5
GM
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
2cb95d1b 293\(RESOURCE . CLASS) with RESOURCE being the resource and CLASS being the
5f5c8ee5 294X resource class for the attribute."
b5325e78 295 :type '(repeat (cons symbol (repeat (cons string string))))
5f5c8ee5
GM
296 :group 'faces)
297
298
aa360da1
GM
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
5f5c8ee5
GM
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."
e51fe00a 325 (when (memq (framep frame) '(x w32))
5f5c8ee5
GM
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))))))
00f51890
SS
331
332
5f5c8ee5
GM
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
feaad827 347(defun face-name (face)
465fceed 348 "Return the name of face FACE."
5f5c8ee5
GM
349 (symbol-name (check-face face)))
350
351
833547aa
RS
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).
37766706 355If FRAME is omitted or nil the value describes the default attributes,
833547aa
RS
356but if you specify FRAME, the value describes the attributes
357of FACE on FRAME."
606c9f59
RS
358 (mapcar (lambda (pair)
359 (let ((attr (car pair)))
360 (cons attr (face-attribute face attr (or frame t)))))
833547aa
RS
361 face-attribute-name-alist))
362
c7f814cb 363(defun face-attribute (face attribute &optional frame inherit)
5f5c8ee5
GM
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).
c7f814cb 367If FRAME is omitted or nil, use the selected frame.
5f5c8ee5 368
c7f814cb
MB
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))
621e71ee
SM
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)))))
c7f814cb
MB
391 (when (and inherit
392 (not (eq inherit t))
393 (face-attribute-relative-p attribute value))
b6b90dfc 394 ;; We should merge with INHERIT as well
c7f814cb
MB
395 (setq value (face-attribute-merged-with attribute value inherit frame)))
396 value))
5f5c8ee5 397
c7f814cb
MB
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.
522fb950 401\[This is an internal function.]"
c7f814cb
MB
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)
5f5c8ee5
GM
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).
c7f814cb 430If FRAME is omitted or nil, use the selected frame.
5f5c8ee5 431
c7f814cb
MB
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)
5f5c8ee5
GM
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).
c7f814cb 450If FRAME is omitted or nil, use the selected frame.
5f5c8ee5 451
c7f814cb
MB
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)
5f5c8ee5
GM
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).
c7f814cb
MB
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))
5f5c8ee5
GM
485
486
487(defalias 'face-background-pixmap 'face-stipple)
488
489
1bf335cf 490(defun face-underline-p (face &optional frame inherit)
bde3c6c0 491 "Return non-nil if FACE specifies a non-nil underlining.
5f5c8ee5
GM
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).
1bf335cf
GM
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))
5f5c8ee5
GM
498
499
1bf335cf 500(defun face-inverse-video-p (face &optional frame inherit)
bde3c6c0 501 "Return non-nil if FACE specifies a non-nil inverse-video.
5f5c8ee5
GM
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).
1bf335cf
GM
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))
5f5c8ee5
GM
507
508
1bf335cf 509(defun face-bold-p (face &optional frame inherit)
5f5c8ee5
GM
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.
1bf335cf 514Optional argument INHERIT is passed to `face-attribute'.
5f5c8ee5 515Use `face-attribute' for finer control."
1bf335cf 516 (let ((bold (face-attribute face :weight frame inherit)))
da2c7b8c 517 (memq bold '(semi-bold bold extra-bold ultra-bold))))
5f5c8ee5
GM
518
519
1bf335cf 520(defun face-italic-p (face &optional frame inherit)
5f5c8ee5
GM
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.
1bf335cf 525Optional argument INHERIT is passed to `face-attribute'.
5f5c8ee5 526Use `face-attribute' for finer control."
1bf335cf 527 (let ((italic (face-attribute face :slant frame inherit)))
a48f6020 528 (memq italic '(italic oblique))))
00f51890 529
5f5c8ee5 530
5f5c8ee5
GM
531\f
532;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
533;;; Face documentation.
534;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
535
536(defun face-documentation (face)
9a558a07
GM
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))
3446bfc8 544 (format "%s is an alias for the face `%s'.%s" face alias
9a558a07
GM
545 (if doc (format "\n%s" doc)
546 "")))
547 (get face 'face-documentation))))
5f5c8ee5
GM
548
549
550(defun set-face-documentation (face string)
551 "Set the documentation string for FACE to STRING."
291cfb96 552 ;; Perhaps the text should go in DOC.
49435801 553 (put face 'face-documentation (purecopy string)))
5f5c8ee5
GM
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.
4b56d0fe
CY
568This function overrides the face attributes specified by FACE's
569face spec. It is mostly intended for internal use only.
5f5c8ee5 570
4b56d0fe
CY
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.
5f5c8ee5 574
4b56d0fe
CY
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.
5f5c8ee5
GM
578
579The following attributes are recognized:
580
581`:family'
582
4b56d0fe
CY
583VALUE must be a string specifying the font family
584\(e.g. \"Monospace\") or a fontset.
5f5c8ee5 585
fcea6e23
KH
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
5f5c8ee5
GM
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
4b56d0fe
CY
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,
95838641 604which specifies a scaling factor for the underlying face height;
4b56d0fe
CY
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
95838641 608for it to be relative to).
5f5c8ee5
GM
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
9b0e3eba
AA
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'.
5f5c8ee5
GM
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
0f937ebd
KH
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
5f5c8ee5
GM
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
70d0c3b0 683inverse video. VALUE must be one of t or nil.
5f5c8ee5
GM
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
fcea6e23
KH
694For convenience, attributes `:family', `:foundry', `:width',
695`:height', `:weight', and `:slant' may also be set in one step
696from an X font name:
5f5c8ee5
GM
697
698`:font'
699
4b56d0fe
CY
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.
19feb949
MB
704
705`:inherit'
706
4b56d0fe
CY
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."
61ab9392
CY
720 (setq args (purecopy args))
721 (let ((where (if (null frame) 0 frame))
722 (spec args)
723 family foundry)
680da3f8
RS
724 ;; If we set the new-frame defaults, this face is modified outside Custom.
725 (if (memq where '(0 t))
9a558a07 726 (put (or (get face 'face-alias) face) 'face-modified t))
61ab9392
CY
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
3a92c095
KH
740 (setq foundry (match-string 1 family)))
741 (setq family (match-string 2 family)))
c917476d 742 (when (or (stringp family) (eq family 'unspecified))
61ab9392
CY
743 (internal-set-lisp-face-attribute face :family (purecopy family)
744 where))
c917476d 745 (when (or (stringp foundry) (eq foundry 'unspecified))
61ab9392
CY
746 (internal-set-lisp-face-attribute face :foundry (purecopy foundry)
747 where)))
70a267c9 748 (while args
61ab9392 749 (unless (memq (car args) '(:family :foundry))
96c1a800
CY
750 (internal-set-lisp-face-attribute face (car args)
751 (purecopy (cadr args))
752 where))
61ab9392 753 (setq args (cddr args)))))
5f5c8ee5 754
06b60517 755(defun make-face-bold (face &optional frame _noerror)
5f5c8ee5
GM
756 "Make the font of FACE be bold, if possible.
757FRAME nil or not specified means change face on all frames.
39cac3e7 758Argument NOERROR is ignored and retained for compatibility.
5f5c8ee5 759Use `set-face-attribute' for finer control of the font weight."
011cddd6
RW
760 (interactive (list (read-face-name "Make which face bold"
761 (face-at-point t))))
5f5c8ee5
GM
762 (set-face-attribute face frame :weight 'bold))
763
764
06b60517 765(defun make-face-unbold (face &optional frame _noerror)
5f5c8ee5 766 "Make the font of FACE be non-bold, if possible.
39cac3e7
GM
767FRAME nil or not specified means change face on all frames.
768Argument NOERROR is ignored and retained for compatibility."
011cddd6
RW
769 (interactive (list (read-face-name "Make which face non-bold"
770 (face-at-point t))))
5f5c8ee5
GM
771 (set-face-attribute face frame :weight 'normal))
772
00f51890 773
06b60517 774(defun make-face-italic (face &optional frame _noerror)
5f5c8ee5
GM
775 "Make the font of FACE be italic, if possible.
776FRAME nil or not specified means change face on all frames.
39cac3e7 777Argument NOERROR is ignored and retained for compatibility.
5f5c8ee5 778Use `set-face-attribute' for finer control of the font slant."
011cddd6
RW
779 (interactive (list (read-face-name "Make which face italic"
780 (face-at-point t))))
5f5c8ee5
GM
781 (set-face-attribute face frame :slant 'italic))
782
783
06b60517 784(defun make-face-unitalic (face &optional frame _noerror)
5f5c8ee5 785 "Make the font of FACE be non-italic, if possible.
70d0c3b0
DL
786FRAME nil or not specified means change face on all frames.
787Argument NOERROR is ignored and retained for compatibility."
011cddd6
RW
788 (interactive (list (read-face-name "Make which face non-italic"
789 (face-at-point t))))
5f5c8ee5
GM
790 (set-face-attribute face frame :slant 'normal))
791
00f51890 792
06b60517 793(defun make-face-bold-italic (face &optional frame _noerror)
5f5c8ee5
GM
794 "Make the font of FACE be bold and italic, if possible.
795FRAME nil or not specified means change face on all frames.
39cac3e7 796Argument NOERROR is ignored and retained for compatibility.
5f5c8ee5 797Use `set-face-attribute' for finer control of font weight and slant."
011cddd6
RW
798 (interactive (list (read-face-name "Make which face bold-italic"
799 (face-at-point t))))
5f5c8ee5
GM
800 (set-face-attribute face frame :weight 'bold :slant 'italic))
801
802
803(defun set-face-font (face font &optional frame)
804 "Change font-related attributes of FACE to those of FONT (a string).
805FRAME nil or not specified means change face on all frames.
fcea6e23
KH
806This sets the attributes `:family', `:foundry', `:width',
807`:height', `:weight', and `:slant'. When called interactively,
808prompt for the face and font."
5f5c8ee5
GM
809 (interactive (read-face-and-attribute :font))
810 (set-face-attribute face frame :font font))
811
812
813;; Implementation note: Emulating gray background colors with a
814;; stipple pattern is now part of the face realization process, and is
815;; done in C depending on the frame on which the face is realized.
816
817(defun set-face-background (face color &optional frame)
818 "Change the background color of face FACE to COLOR (a string).
819FRAME nil or not specified means change face on all frames.
72e6f142
RS
820COLOR can be a system-defined color name (see `list-colors-display')
821or a hex spec of the form #RRGGBB.
822When called interactively, prompts for the face and color."
5f5c8ee5 823 (interactive (read-face-and-attribute :background))
78ad1cd5 824 (set-face-attribute face frame :background (or color 'unspecified)))
5f5c8ee5
GM
825
826
827(defun set-face-foreground (face color &optional frame)
828 "Change the foreground color of face FACE to COLOR (a string).
829FRAME nil or not specified means change face on all frames.
72e6f142
RS
830COLOR can be a system-defined color name (see `list-colors-display')
831or a hex spec of the form #RRGGBB.
832When called interactively, prompts for the face and color."
5f5c8ee5 833 (interactive (read-face-and-attribute :foreground))
78ad1cd5 834 (set-face-attribute face frame :foreground (or color 'unspecified)))
5f5c8ee5
GM
835
836
837(defun set-face-stipple (face stipple &optional frame)
838 "Change the stipple pixmap of face FACE to STIPPLE.
839FRAME nil or not specified means change face on all frames.
70d0c3b0 840STIPPLE should be a string, the name of a file of pixmap data.
5f5c8ee5
GM
841The directories listed in the `x-bitmap-file-path' variable are searched.
842
843Alternatively, STIPPLE may be a list of the form (WIDTH HEIGHT DATA)
844where WIDTH and HEIGHT are the size in pixels,
845and DATA is a string, containing the raw bits of the bitmap."
846 (interactive (read-face-and-attribute :stipple))
78ad1cd5 847 (set-face-attribute face frame :stipple (or stipple 'unspecified)))
5f5c8ee5
GM
848
849
bde3c6c0 850(defun set-face-underline (face underline &optional frame)
5f5c8ee5
GM
851 "Specify whether face FACE is underlined.
852UNDERLINE nil means FACE explicitly doesn't underline.
bde3c6c0
GM
853UNDERLINE t means FACE underlines with its foreground color.
854If UNDERLINE is a string, underline with that color.
855
856UNDERLINE may also be a list of the form (:color COLOR :style STYLE),
857where COLOR is a string or `foreground-color', and STYLE is either
858`line' or `wave'. :color may be omitted, which means to use the
859foreground color. :style may be omitted, which means to use a line.
860
5f5c8ee5 861FRAME nil or not specified means change face on all frames.
5f5c8ee5 862Use `set-face-attribute' to ``unspecify'' underlining."
bde3c6c0 863 (interactive (read-face-and-attribute :underline))
a61afeac 864 (set-face-attribute face frame :underline underline))
5f5c8ee5 865
bde3c6c0
GM
866(define-obsolete-function-alias 'set-face-underline-p
867 'set-face-underline "24.3")
9b82fc01 868
5f5c8ee5 869
3ca2f1bf 870(defun set-face-inverse-video (face inverse-video-p &optional frame)
5f5c8ee5
GM
871 "Specify whether face FACE is in inverse video.
872INVERSE-VIDEO-P non-nil means FACE displays explicitly in inverse video.
873INVERSE-VIDEO-P nil means FACE explicitly is not in inverse video.
874FRAME nil or not specified means change face on all frames.
875Use `set-face-attribute' to ``unspecify'' the inverse video attribute."
876 (interactive
877 (let ((list (read-face-and-attribute :inverse-video)))
3ca2f1bf 878 (list (car list) (if (cadr list) t))))
5f5c8ee5
GM
879 (set-face-attribute face frame :inverse-video inverse-video-p))
880
3ca2f1bf
GM
881(define-obsolete-function-alias 'set-face-inverse-video-p
882 'set-face-inverse-video "24.4")
5f5c8ee5 883
3ca2f1bf 884(defun set-face-bold (face bold-p &optional frame)
5f5c8ee5
GM
885 "Specify whether face FACE is bold.
886BOLD-P non-nil means FACE should explicitly display bold.
887BOLD-P nil means FACE should explicitly display non-bold.
888FRAME nil or not specified means change face on all frames.
889Use `set-face-attribute' or `modify-face' for finer control."
890 (if (null bold-p)
891 (make-face-unbold face frame)
892 (make-face-bold face frame)))
893
3ca2f1bf 894(define-obsolete-function-alias 'set-face-bold-p 'set-face-bold "24.4")
5f5c8ee5 895
3ca2f1bf
GM
896
897(defun set-face-italic (face italic-p &optional frame)
5f5c8ee5
GM
898 "Specify whether face FACE is italic.
899ITALIC-P non-nil means FACE should explicitly display italic.
900ITALIC-P nil means FACE should explicitly display non-italic.
901FRAME nil or not specified means change face on all frames.
902Use `set-face-attribute' or `modify-face' for finer control."
903 (if (null italic-p)
904 (make-face-unitalic face frame)
905 (make-face-italic face frame)))
906
3ca2f1bf
GM
907(define-obsolete-function-alias 'set-face-italic-p 'set-face-italic "24.4")
908
5f5c8ee5
GM
909
910(defalias 'set-face-background-pixmap 'set-face-stipple)
911
912
913(defun invert-face (face &optional frame)
914 "Swap the foreground and background colors of FACE.
e458cb49 915If FRAME is omitted or nil, it means change face on all frames.
5f5c8ee5
GM
916If FACE specifies neither foreground nor background color,
917set its foreground and background to the background and foreground
918of the default face. Value is FACE."
011cddd6 919 (interactive (list (read-face-name "Invert face" (face-at-point t))))
5f5c8ee5
GM
920 (let ((fg (face-attribute face :foreground frame))
921 (bg (face-attribute face :background frame)))
e458cb49 922 (if (not (and (eq fg 'unspecified) (eq bg 'unspecified)))
5f5c8ee5
GM
923 (set-face-attribute face frame :foreground bg :background fg)
924 (set-face-attribute face frame
925 :foreground
926 (face-attribute 'default :background frame)
927 :background
928 (face-attribute 'default :foreground frame))))
929 face)
930
931\f
932;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
933;;; Interactively modifying faces.
934;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
935
5cb15713
JB
936(defvar crm-separator) ; from crm.el
937
c91e692b 938(defun read-face-name (prompt &optional default multiple)
011cddd6
RW
939 "Read one or more face names, prompting with PROMPT.
940PROMPT should not end in a space or a colon.
bccffa83 941
011cddd6 942Return DEFAULT if the user enters the empty string.
c46da669
RW
943If DEFAULT is non-nil, it should be a single face or a list of face names
944\(symbols or strings). In the latter case, return the `car' of DEFAULT
945\(if MULTIPLE is nil, see below), or DEFAULT (if MULTIPLE is non-nil).
946
947If MULTIPLE is non-nil, this function uses `completing-read-multiple'
948to read multiple faces with \"[ \\t]*,[ \\t]*\" as the separator regexp
949and it returns a list of face names. Otherwise, it reads and returns
950a single face name."
011cddd6
RW
951 (if (and default (not (stringp default)))
952 (setq default
953 (cond ((symbolp default)
954 (symbol-name default))
955 (multiple
956 (mapconcat (lambda (f) (if (symbolp f) (symbol-name f) f))
957 default ", "))
958 ;; If we only want one, and the default is more than one,
959 ;; discard the unwanted ones.
960 (t (symbol-name (car default))))))
c46da669
RW
961 (if (and default (not multiple))
962 ;; For compatibility with `completing-read-multiple' use `crm-separator'
963 ;; to define DEFAULT if MULTIPLE is nil.
964 (setq default (car (split-string default crm-separator t))))
965
966 (let ((prompt (if default
967 (format "%s (default `%s'): " prompt default)
968 (format "%s: " prompt)))
969 aliasfaces nonaliasfaces faces)
011cddd6 970 ;; Build up the completion tables.
e3b5b35b 971 (mapatoms (lambda (s)
011cddd6 972 (if (facep s)
e3b5b35b
SM
973 (if (get s 'face-alias)
974 (push (symbol-name s) aliasfaces)
975 (push (symbol-name s) nonaliasfaces)))))
c46da669
RW
976 (if multiple
977 (progn
978 (dolist (face (completing-read-multiple
979 prompt
980 (completion-table-in-turn nonaliasfaces aliasfaces)
981 nil t nil 'face-name-history default))
982 ;; Ignore elements that are not faces
983 ;; (for example, because DEFAULT was "all faces")
984 (if (facep face) (push (intern face) faces)))
985 (nreverse faces))
986 (let ((face (completing-read
987 prompt
011cddd6 988 (completion-table-in-turn nonaliasfaces aliasfaces)
c46da669
RW
989 nil t nil 'face-name-history default)))
990 (if (facep face) (intern face))))))
a482f364 991
aa360da1
GM
992;; Not defined without X, but behind window-system test.
993(defvar x-bitmap-file-path)
a482f364 994
5f5c8ee5
GM
995(defun face-valid-attribute-values (attribute &optional frame)
996 "Return valid values for face attribute ATTRIBUTE.
997The optional argument FRAME is used to determine available fonts
c6f3804c
JB
998and colors. If it is nil or not specified, the selected frame is used.
999Value is an alist of (NAME . VALUE) if ATTRIBUTE expects a value out
1000of a set of discrete values. Value is `integerp' if ATTRIBUTE expects
5f5c8ee5 1001an integer value."
00f51890 1002 (let ((valid
36cec983
SM
1003 (pcase attribute
1004 (`:family
428a555e 1005 (if (window-system frame)
95ac8fbd 1006 (mapcar (lambda (x) (cons x x))
6e783e91 1007 (font-family-list))
00f51890
SS
1008 ;; Only one font on TTYs.
1009 (list (cons "default" "default"))))
36cec983 1010 (`:foundry
fcea6e23 1011 (list nil))
36cec983 1012 (`:width
e83eedbf 1013 (mapcar #'(lambda (x) (cons (symbol-name (aref x 1)) (aref x 1)))
6e783e91 1014 font-width-table))
36cec983 1015 (`:weight
e83eedbf 1016 (mapcar #'(lambda (x) (cons (symbol-name (aref x 1)) (aref x 1)))
6e783e91 1017 font-weight-table))
36cec983 1018 (`:slant
e83eedbf 1019 (mapcar #'(lambda (x) (cons (symbol-name (aref x 1)) (aref x 1)))
6e783e91 1020 font-slant-table))
36cec983 1021 (`:inverse-video
6e783e91
KH
1022 (mapcar #'(lambda (x) (cons (symbol-name x) x))
1023 (internal-lisp-face-attribute-values attribute)))
36cec983 1024 ((or `:underline `:overline `:strike-through `:box)
428a555e 1025 (if (window-system frame)
00f51890
SS
1026 (nconc (mapcar #'(lambda (x) (cons (symbol-name x) x))
1027 (internal-lisp-face-attribute-values attribute))
1028 (mapcar #'(lambda (c) (cons c c))
b533d0ae 1029 (defined-colors frame)))
00f51890
SS
1030 (mapcar #'(lambda (x) (cons (symbol-name x) x))
1031 (internal-lisp-face-attribute-values attribute))))
36cec983 1032 ((or `:foreground `:background)
00f51890
SS
1033 (mapcar #'(lambda (c) (cons c c))
1034 (defined-colors frame)))
36cec983 1035 (`:height
00f51890 1036 'integerp)
36cec983 1037 (`:stipple
0db2e6af 1038 (and (memq (window-system frame) '(x ns)) ; No stipple on w32
00f51890
SS
1039 (mapcar #'list
1040 (apply #'nconc
1041 (mapcar (lambda (dir)
1042 (and (file-readable-p dir)
1043 (file-directory-p dir)
1044 (directory-files dir)))
1045 x-bitmap-file-path)))))
36cec983 1046 (`:inherit
00f51890
SS
1047 (cons '("none" . nil)
1048 (mapcar #'(lambda (c) (cons (symbol-name c) c))
1049 (face-list))))
36cec983 1050 (_
00f51890 1051 (error "Internal error")))))
19feb949 1052 (if (and (listp valid) (not (memq attribute '(:inherit))))
fbd5f1cc
GM
1053 (nconc (list (cons "unspecified" 'unspecified)) valid)
1054 valid)))
5f5c8ee5
GM
1055
1056
2f7f4bee 1057(defconst face-attribute-name-alist
5f5c8ee5 1058 '((:family . "font family")
fcea6e23 1059 (:foundry . "font foundry")
5f5c8ee5
GM
1060 (:width . "character set width")
1061 (:height . "height in 1/10 pt")
1062 (:weight . "weight")
1063 (:slant . "slant")
1064 (:underline . "underline")
1065 (:overline . "overline")
1066 (:strike-through . "strike-through")
1067 (:box . "box")
1068 (:inverse-video . "inverse-video display")
1069 (:foreground . "foreground color")
1070 (:background . "background color")
19feb949
MB
1071 (:stipple . "background stipple")
1072 (:inherit . "inheritance"))
5f5c8ee5
GM
1073 "An alist of descriptive names for face attributes.
1074Each element has the form (ATTRIBUTE-NAME . DESCRIPTION) where
1075ATTRIBUTE-NAME is a face attribute name (a keyword symbol), and
1076DESCRIPTION is a descriptive name for ATTRIBUTE-NAME.")
1077
1078
1079(defun face-descriptive-attribute-name (attribute)
1080 "Return a descriptive name for ATTRIBUTE."
1081 (cdr (assq attribute face-attribute-name-alist)))
1082
1083
1084(defun face-read-string (face default name &optional completion-alist)
1085 "Interactively read a face attribute string value.
19feb949
MB
1086FACE is the face whose attribute is read. If non-nil, DEFAULT is the
1087default string to return if no new value is entered. NAME is a
1088descriptive name of the attribute for prompting. COMPLETION-ALIST is an
1089alist of valid values, if non-nil.
5f5c8ee5 1090
19feb949 1091Entering nothing accepts the default string DEFAULT.
5f5c8ee5 1092Value is the new attribute value."
19feb949
MB
1093 ;; Capitalize NAME (we don't use `capitalize' because that capitalizes
1094 ;; each word in a string separately).
1095 (setq name (concat (upcase (substring name 0 1)) (substring name 1)))
5f5c8ee5
GM
1096 (let* ((completion-ignore-case t)
1097 (value (completing-read
1098 (if default
19feb949
MB
1099 (format "%s for face `%s' (default %s): "
1100 name face default)
1101 (format "%s for face `%s': " name face))
d69ab4ba 1102 completion-alist nil nil nil nil default)))
fbd5f1cc 1103 (if (equal value "") default value)))
5f5c8ee5
GM
1104
1105
1106(defun face-read-integer (face default name)
1107 "Interactively read an integer face attribute value.
1108FACE is the face whose attribute is read. DEFAULT is the default
1109value to return if no new value is entered. NAME is a descriptive
1110name of the attribute for prompting. Value is the new attribute value."
fbd5f1cc
GM
1111 (let ((new-value
1112 (face-read-string face
19feb949 1113 (format "%s" default)
fbd5f1cc
GM
1114 name
1115 (list (cons "unspecified" 'unspecified)))))
19feb949
MB
1116 (cond ((equal new-value "unspecified")
1117 'unspecified)
1118 ((member new-value '("unspecified-fg" "unspecified-bg"))
1119 new-value)
1120 (t
027a4b6b 1121 (string-to-number new-value)))))
5f5c8ee5
GM
1122
1123
bde3c6c0
GM
1124;; FIXME this does allow you to enter the list forms of :box,
1125;; :stipple, or :underline, because face-valid-attribute-values does
1126;; not return those forms.
5f5c8ee5
GM
1127(defun read-face-attribute (face attribute &optional frame)
1128 "Interactively read a new value for FACE's ATTRIBUTE.
1129Optional argument FRAME nil or unspecified means read an attribute value
1130of a global face. Value is the new attribute value."
1131 (let* ((old-value (face-attribute face attribute frame))
1132 (attribute-name (face-descriptive-attribute-name attribute))
1133 (valid (face-valid-attribute-values attribute frame))
1134 new-value)
1135 ;; Represent complex attribute values as strings by printing them
1136 ;; out. Stipple can be a vector; (WIDTH HEIGHT DATA). Box can be
1137 ;; a list `(:width WIDTH :color COLOR)' or `(:width WIDTH :shadow
bde3c6c0
GM
1138 ;; SHADOW)'. Underline can be `(:color COLOR :style STYLE)'.
1139 (and (memq attribute '(:box :stipple :underline))
1140 (or (consp old-value)
1141 (vectorp old-value))
1142 (setq old-value (prin1-to-string old-value)))
5f5c8ee5 1143 (cond ((listp valid)
19feb949
MB
1144 (let ((default
1145 (or (car (rassoc old-value valid))
1146 (format "%s" old-value))))
1147 (setq new-value
1148 (face-read-string face default attribute-name valid))
1149 (if (equal new-value default)
1150 ;; Nothing changed, so don't bother with all the stuff
1151 ;; below. In particular, this avoids a non-tty color
1152 ;; from being canonicalized for a tty when the user
1153 ;; just uses the default.
1154 (setq new-value old-value)
1155 ;; Terminal frames can support colors that don't appear
1156 ;; explicitly in VALID, using color approximation code
1157 ;; in tty-colors.el.
f9056dd9 1158 (when (and (memq attribute '(:foreground :background))
9e2a2647 1159 (not (memq (window-system frame) '(x w32 ns)))
f9056dd9
MB
1160 (not (member new-value
1161 '("unspecified"
1162 "unspecified-fg" "unspecified-bg"))))
4385f1b0 1163 (setq new-value (car (tty-color-desc new-value frame))))
f9056dd9
MB
1164 (when (assoc new-value valid)
1165 (setq new-value (cdr (assoc new-value valid)))))))
5f5c8ee5
GM
1166 ((eq valid 'integerp)
1167 (setq new-value (face-read-integer face old-value attribute-name)))
1168 (t (error "Internal error")))
1169 ;; Convert stipple and box value text we read back to a list or
1170 ;; vector if it looks like one. This makes the assumption that a
1171 ;; pixmap file name won't start with an open-paren.
bde3c6c0
GM
1172 (and (memq attribute '(:stipple :box :underline))
1173 (stringp new-value)
1174 (string-match "^[[(]" new-value)
1175 (setq new-value (read new-value)))
5f5c8ee5
GM
1176 new-value))
1177
aa360da1
GM
1178(declare-function fontset-list "fontset.c" ())
1179(declare-function x-list-fonts "xfaces.c"
1180 (pattern &optional face frame maximum width))
5f5c8ee5
GM
1181
1182(defun read-face-font (face &optional frame)
1183 "Read the name of a font for FACE on FRAME.
522fb950 1184If optional argument FRAME is nil or omitted, use the selected frame."
5f5c8ee5 1185 (let ((completion-ignore-case t))
48ec9939 1186 (completing-read (format "Set font attributes of face `%s' from font: " face)
6b61353c 1187 (append (fontset-list) (x-list-fonts "*" nil frame)))))
5f5c8ee5
GM
1188
1189
1190(defun read-all-face-attributes (face &optional frame)
1191 "Interactively read all attributes for FACE.
522fb950 1192If optional argument FRAME is nil or omitted, use the selected frame.
5f5c8ee5
GM
1193Value is a property list of attribute names and new values."
1194 (let (result)
1195 (dolist (attribute face-attribute-name-alist result)
1196 (setq result (cons (car attribute)
1197 (cons (read-face-attribute face (car attribute) frame)
1198 result))))))
1199
7cd512f2 1200(defun modify-face (&optional face foreground background stipple
a61afeac 1201 bold-p italic-p underline inverse-p frame)
5f5c8ee5
GM
1202 "Modify attributes of faces interactively.
1203If optional argument FRAME is nil or omitted, modify the face used
7cd512f2
SM
1204for newly created frame, i.e. the global face.
1205For non-interactive use, `set-face-attribute' is preferred.
522fb950 1206When called from Lisp, if FACE is nil, all arguments but FRAME are ignored
7cd512f2 1207and the face and its settings are obtained by querying the user."
5f5c8ee5 1208 (interactive)
7cd512f2
SM
1209 (if face
1210 (set-face-attribute face frame
1211 :foreground (or foreground 'unspecified)
1212 :background (or background 'unspecified)
1213 :stipple stipple
4b56d0fe
CY
1214 :weight (if bold-p 'bold 'normal)
1215 :slant (if italic-p 'italic 'normal)
a61afeac 1216 :underline underline
7cd512f2 1217 :inverse-video inverse-p)
011cddd6 1218 (setq face (read-face-name "Modify face" (face-at-point t)))
5f5c8ee5
GM
1219 (apply #'set-face-attribute face frame
1220 (read-all-face-attributes face frame))))
1221
5f5c8ee5
GM
1222(defun read-face-and-attribute (attribute &optional frame)
1223 "Read face name and face attribute value.
1224ATTRIBUTE is the attribute whose new value is read.
1225FRAME nil or unspecified means read attribute value of global face.
1226Value is a list (FACE NEW-VALUE) where FACE is the face read
7cd512f2 1227\(a symbol), and NEW-VALUE is value read."
5f5c8ee5 1228 (cond ((eq attribute :font)
48ec9939 1229 (let* ((prompt "Set font-related attributes of face")
011cddd6 1230 (face (read-face-name prompt (face-at-point t)))
5f5c8ee5
GM
1231 (font (read-face-font face frame)))
1232 (list face font)))
1233 (t
1234 (let* ((attribute-name (face-descriptive-attribute-name attribute))
19feb949 1235 (prompt (format "Set %s of face" attribute-name))
011cddd6 1236 (face (read-face-name prompt (face-at-point t)))
5f5c8ee5
GM
1237 (new-value (read-face-attribute face attribute frame)))
1238 (list face new-value)))))
1239
1240
1241\f
1242;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1243;;; Listing faces.
1244;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1245
2f7f4bee 1246(defconst list-faces-sample-text
5f5c8ee5 1247 "abcdefghijklmnopqrstuvwxyz ABCDEFGHIJKLMNOPQRSTUVWXYZ"
fb7ada5f 1248 "Text string to display as the sample text for `list-faces-display'.")
5f5c8ee5
GM
1249
1250
1251;; The name list-faces would be more consistent, but let's avoid a
1252;; conflict with Lucid, which uses that name differently.
1253
645a1038 1254(defvar help-xref-stack)
e2c11e3b 1255(defun list-faces-display (&optional regexp)
5f5c8ee5
GM
1256 "List all faces, using the same sample text in each.
1257The sample text is a string that comes from the variable
e2c11e3b
RS
1258`list-faces-sample-text'.
1259
1260If REGEXP is non-nil, list only those faces with names matching
1261this regular expression. When called interactively with a prefix
1262arg, prompt for a regular expression."
1263 (interactive (list (and current-prefix-arg
2aef0850 1264 (read-regexp "List faces matching regexp"))))
011131fd 1265 (let ((all-faces (zerop (length regexp)))
5f5c8ee5 1266 (frame (selected-frame))
011131fd
JB
1267 (max-length 0)
1268 faces line-format
84fe35f0 1269 disp-frame window face-name)
011131fd
JB
1270 ;; We filter and take the max length in one pass
1271 (setq faces
1272 (delq nil
1273 (mapcar (lambda (f)
1274 (let ((s (symbol-name f)))
1275 (when (or all-faces (string-match regexp s))
1276 (setq max-length (max (length s) max-length))
1277 f)))
1278 (sort (face-list) #'string-lessp))))
1279 (unless faces
1280 (error "No faces matching \"%s\"" regexp))
1281 (setq max-length (1+ max-length)
1282 line-format (format "%%-%ds" max-length))
b766be6a 1283 (with-help-window "*Faces*"
7fdbcd83 1284 (with-current-buffer standard-output
5f5c8ee5 1285 (setq truncate-lines t)
84fe35f0
DL
1286 (insert
1287 (substitute-command-keys
1288 (concat
75bfc667 1289 "\\<help-mode-map>Use "
53c80cf6 1290 (if (display-mouse-p) "\\[help-follow-mouse] or ")
32e33f60 1291 "\\[help-follow] on a face name to customize it\n"
46057f5f 1292 "or on its sample text for a description of the face.\n\n")))
84fe35f0 1293 (setq help-xref-stack nil)
e2c11e3b 1294 (dolist (face faces)
84fe35f0 1295 (setq face-name (symbol-name face))
011131fd 1296 (insert (format line-format face-name))
84fe35f0
DL
1297 ;; Hyperlink to a customization buffer for the face. Using
1298 ;; the help xref mechanism may not be the best way.
1299 (save-excursion
1300 (save-match-data
1301 (search-backward face-name)
35a0a8aa 1302 (setq help-xref-stack-item `(list-faces-display ,regexp))
a482f364
RS
1303 (help-xref-button 0 'help-customize-face face)))
1304 (let ((beg (point))
1305 (line-beg (line-beginning-position)))
5f5c8ee5 1306 (insert list-faces-sample-text)
84fe35f0
DL
1307 ;; Hyperlink to a help buffer for the face.
1308 (save-excursion
1309 (save-match-data
1310 (search-backward list-faces-sample-text)
8940232b 1311 (help-xref-button 0 'help-face face)))
5f5c8ee5
GM
1312 (insert "\n")
1313 (put-text-property beg (1- (point)) 'face face)
a482f364
RS
1314 ;; Make all face commands default to the proper face
1315 ;; anywhere in the line.
1316 (put-text-property line-beg (1- (point)) 'read-face-name face)
5f5c8ee5
GM
1317 ;; If the sample text has multiple lines, line up all of them.
1318 (goto-char beg)
1319 (forward-line 1)
1320 (while (not (eobp))
011131fd 1321 (insert-char ?\s max-length)
5f5c8ee5 1322 (forward-line 1))))
b766be6a 1323 (goto-char (point-min))))
5f5c8ee5
GM
1324 ;; If the *Faces* buffer appears in a different frame,
1325 ;; copy all the face definitions from FRAME,
1326 ;; so that the display will reflect the frame that was selected.
1327 (setq window (get-buffer-window (get-buffer "*Faces*") t))
1328 (setq disp-frame (if window (window-frame window)
1329 (car (frame-list))))
1330 (or (eq frame disp-frame)
1331 (let ((faces (face-list)))
1332 (while faces
1333 (copy-face (car faces) (car faces) frame disp-frame)
1334 (setq faces (cdr faces)))))))
1335
e2c11e3b 1336
5f5c8ee5
GM
1337(defun describe-face (face &optional frame)
1338 "Display the properties of face FACE on FRAME.
6afa5404 1339Interactively, FACE defaults to the faces of the character after point
a482f364
RS
1340and FRAME defaults to the selected frame.
1341
5f5c8ee5
GM
1342If the optional argument FRAME is given, report on face FACE in that frame.
1343If FRAME is t, report on the defaults for face FACE (for new frames).
1344If FRAME is omitted or nil, use the selected frame."
f3d3eaf0 1345 (interactive (list (read-face-name "Describe face"
011cddd6 1346 (or (face-at-point t) 'default)
f3d3eaf0 1347 t)))
5f5c8ee5 1348 (let* ((attrs '((:family . "Family")
fcea6e23 1349 (:foundry . "Foundry")
5f5c8ee5
GM
1350 (:width . "Width")
1351 (:height . "Height")
1352 (:weight . "Weight")
1353 (:slant . "Slant")
1354 (:foreground . "Foreground")
1355 (:background . "Background")
1356 (:underline . "Underline")
1357 (:overline . "Overline")
1358 (:strike-through . "Strike-through")
1359 (:box . "Box")
1360 (:inverse-video . "Inverse")
b32631c8 1361 (:stipple . "Stipple")
0540dc5e
KH
1362 (:font . "Font")
1363 (:fontset . "Fontset")
25ac7b52 1364 (:inherit . "Inherit")))
5f5c8ee5
GM
1365 (max-width (apply #'max (mapcar #'(lambda (x) (length (cdr x)))
1366 attrs))))
32226619
JB
1367 (help-setup-xref (list #'describe-face face)
1368 (called-interactively-p 'interactive))
a482f364
RS
1369 (unless face
1370 (setq face 'default))
1371 (if (not (listp face))
1372 (setq face (list face)))
b766be6a 1373 (with-help-window (help-buffer)
7fdbcd83 1374 (with-current-buffer standard-output
a482f364 1375 (dolist (f face)
faa3d27b 1376 (if (stringp f) (setq f (intern f)))
0d3b1f4e
CY
1377 ;; We may get called for anonymous faces (i.e., faces
1378 ;; expressed using prop-value plists). Those can't be
1379 ;; usefully customized, so ignore them.
1380 (when (symbolp f)
1381 (insert "Face: " (symbol-name f))
1382 (if (not (facep f))
1383 (insert " undefined face.\n")
1384 (let ((customize-label "customize this face")
1385 file-name)
1386 (insert (concat " (" (propertize "sample" 'font-lock-face f) ")"))
1387 (princ (concat " (" customize-label ")\n"))
3446bfc8
GM
1388 ;; FIXME not sure how much of this belongs here, and
1389 ;; how much in `face-documentation'. The latter is
1390 ;; not used much, but needs to return nil for
1391 ;; undocumented faces.
1392 (let ((alias (get f 'face-alias))
1393 (face f)
1394 obsolete)
1395 (when alias
1396 (setq face alias)
1397 (insert
1398 (format "\n %s is an alias for the face `%s'.\n%s"
1399 f alias
1400 (if (setq obsolete (get f 'obsolete-face))
1401 (format " This face is obsolete%s; use `%s' instead.\n"
1402 (if (stringp obsolete)
1403 (format " since %s" obsolete)
1404 "")
1405 alias)
1406 ""))))
1407 (insert "\nDocumentation:\n"
1408 (or (face-documentation face)
1409 "Not documented as a face.")
1410 "\n\n"))
0d3b1f4e
CY
1411 (with-current-buffer standard-output
1412 (save-excursion
1413 (re-search-backward
1414 (concat "\\(" customize-label "\\)") nil t)
1415 (help-xref-button 1 'help-customize-face f)))
1416 (setq file-name (find-lisp-object-file-name f 'defface))
1417 (when file-name
1418 (princ "Defined in `")
1419 (princ (file-name-nondirectory file-name))
1420 (princ "'")
1421 ;; Make a hyperlink to the library.
1422 (save-excursion
1423 (re-search-backward "`\\([^`']+\\)'" nil t)
1424 (help-xref-button 1 'help-face-def f file-name))
1425 (princ ".")
1426 (terpri)
1427 (terpri))
1428 (dolist (a attrs)
1429 (let ((attr (face-attribute f (car a) frame)))
1430 (insert (make-string (- max-width (length (cdr a))) ?\s)
1431 (cdr a) ": " (format "%s" attr))
1432 (if (and (eq (car a) :inherit)
1433 (not (eq attr 'unspecified)))
1434 ;; Make a hyperlink to the parent face.
1435 (save-excursion
1436 (re-search-backward ": \\([^:]+\\)" nil t)
1437 (help-xref-button 1 'help-face attr)))
1438 (insert "\n")))))
1439 (terpri)))))))
8940232b 1440
5f5c8ee5
GM
1441\f
1442;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1443;;; Face specifications (defface).
1444;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1445
1446;; Parameter FRAME Is kept for call compatibility to with previous
1447;; face implementation.
1448
06b60517
JB
1449(defun face-attr-construct (face &optional _frame)
1450 "Return a `defface'-style attribute list for FACE.
5f5c8ee5
GM
1451Value is a property list of pairs ATTRIBUTE VALUE for all specified
1452face attributes of FACE where ATTRIBUTE is the attribute name and
06b60517
JB
1453VALUE is the specified value of that attribute.
1454Argument FRAME is ignored and retained for compatibility."
5f5c8ee5
GM
1455 (let (result)
1456 (dolist (entry face-attribute-name-alist result)
1457 (let* ((attribute (car entry))
1458 (value (face-attribute face attribute)))
1459 (unless (eq value 'unspecified)
1460 (setq result (nconc (list attribute value) result)))))))
00f51890 1461
5f5c8ee5
GM
1462
1463(defun face-spec-set-match-display (display frame)
1464 "Non-nil if DISPLAY matches FRAME.
1465DISPLAY is part of a spec such as can be used in `defface'.
1466If FRAME is nil, the current FRAME is used."
1467 (let* ((conjuncts display)
1468 conjunct req options
1469 ;; t means we have succeeded against all the conjuncts in
1470 ;; DISPLAY that have been tested so far.
1471 (match t))
1472 (if (eq conjuncts t)
1473 (setq conjuncts nil))
1474 (while (and conjuncts match)
1475 (setq conjunct (car conjuncts)
1476 conjuncts (cdr conjuncts)
1477 req (car conjunct)
1478 options (cdr conjunct)
1479 match (cond ((eq req 'type)
428a555e 1480 (or (memq (window-system frame) options)
ee0e9f11
LMI
1481 (and (memq 'graphic options)
1482 (memq (window-system frame) '(x w32 ns)))
1695ca2b
EZ
1483 ;; FIXME: This should be revisited to use
1484 ;; display-graphic-p, provided that the
1485 ;; color selection depends on the number
1486 ;; of supported colors, and all defface's
1487 ;; are changed to look at number of colors
1488 ;; instead of (type graphic) etc.
dcb79f20
AS
1489 (if (null (window-system frame))
1490 (memq 'tty options)
1491 (or (and (memq 'motif options)
1492 (featurep 'motif))
1493 (and (memq 'gtk options)
1494 (featurep 'gtk))
1495 (and (memq 'lucid options)
1496 (featurep 'x-toolkit)
1497 (not (featurep 'motif))
1498 (not (featurep 'gtk)))
1499 (and (memq 'x-toolkit options)
1500 (featurep 'x-toolkit))))))
6b61353c
KH
1501 ((eq req 'min-colors)
1502 (>= (display-color-cells frame) (car options)))
5f5c8ee5
GM
1503 ((eq req 'class)
1504 (memq (frame-parameter frame 'display-type) options))
1505 ((eq req 'background)
1506 (memq (frame-parameter frame 'background-mode)
1507 options))
16320ac7
MB
1508 ((eq req 'supports)
1509 (display-supports-face-attributes-p options frame))
70d0c3b0 1510 (t (error "Unknown req `%S' with options `%S'"
5f5c8ee5
GM
1511 req options)))))
1512 match))
1513
1514
1515(defun face-spec-choose (spec &optional frame)
96c2938f
MB
1516 "Choose the proper attributes for FRAME, out of SPEC.
1517If SPEC is nil, return nil."
5f5c8ee5
GM
1518 (unless frame
1519 (setq frame (selected-frame)))
1520 (let ((tail spec)
cf459bb7 1521 result defaults)
5f5c8ee5 1522 (while tail
073f69e6
MB
1523 (let* ((entry (pop tail))
1524 (display (car entry))
cf459bb7
RS
1525 (attrs (cdr entry))
1526 thisval)
1527 ;; Get the attributes as actually specified by this alternative.
1528 (setq thisval
1529 (if (null (cdr attrs)) ;; was (listp (car attrs))
1530 ;; Old-style entry, the attribute list is the
1531 ;; first element.
1532 (car attrs)
1533 attrs))
1534
1535 ;; If the condition is `default', that sets the default
1536 ;; for following conditions.
1537 (if (eq display 'default)
1538 (setq defaults thisval)
1539 ;; Otherwise, if it matches, use it.
1540 (when (face-spec-set-match-display display frame)
1541 (setq result thisval)
b6b90dfc 1542 (setq tail nil)))))
cf459bb7 1543 (if defaults (append result defaults) result)))
5f5c8ee5
GM
1544
1545
1546(defun face-spec-reset-face (face &optional frame)
1547 "Reset all attributes of FACE on FRAME to unspecified."
c349f4e6
CY
1548 (apply 'set-face-attribute face frame
1549 (if (eq face 'default)
1550 ;; For the default face, avoid making any attribute
f003f294 1551 ;; unspecified. Instead, set attributes to default values
c349f4e6
CY
1552 ;; (see also realize_default_face in xfaces.c).
1553 (append
1554 '(:underline nil :overline nil :strike-through nil
1555 :box nil :inverse-video nil :stipple nil :inherit nil)
4c5779ab
CY
1556 ;; `display-graphic-p' is unavailable when running
1557 ;; temacs, prior to loading frame.el.
1558 (unless (and (fboundp 'display-graphic-p)
1559 (display-graphic-p frame))
67ada220 1560 `(:family "default" :foundry "default" :width normal
c349f4e6 1561 :height 1 :weight normal :slant normal
67ada220
AS
1562 :foreground ,(if (frame-parameter nil 'reverse)
1563 "unspecified-bg"
1564 "unspecified-fg")
1565 :background ,(if (frame-parameter nil 'reverse)
1566 "unspecified-fg"
1567 "unspecified-bg"))))
c349f4e6
CY
1568 ;; For all other faces, unspecify all attributes.
1569 (apply 'append
1570 (mapcar (lambda (x) (list (car x) 'unspecified))
1571 face-attribute-name-alist)))))
5f5c8ee5 1572
1c4f115d
CY
1573(defun face-spec-set (face spec &optional spec-type)
1574 "Set the face spec SPEC for FACE.
1575See `defface' for the format of SPEC.
1576
1577The appearance of each face is controlled by its spec, and by the
1578internal face attributes (which can be frame-specific and can be
1579set via `set-face-attribute').
1580
1581The argument SPEC-TYPE determines which spec to set:
1582 nil or `face-override-spec' means the override spec (which is
1583 usually what you want if calling this function outside of
1584 Custom code);
1585 `customized-face' or `saved-face' means the customized spec or
1586 the saved custom spec;
1587 `face-defface-spec' means the default spec
1588 (usually set only via `defface');
1589 `reset' means to ignore SPEC, but clear the `customized-face'
1590 and `face-override-spec' specs;
1591Any other value means not to set any spec, but to run the
1592function for its other effects.
1593
1594In addition to setting the face spec, this function defines FACE
1595as a valid face name if it is not already one, and (re)calculates
1596the face's attributes on existing frames."
1597 (if (get face 'face-alias)
1598 (setq face (get face 'face-alias)))
1599 ;; Save SPEC to the relevant symbol property.
1600 (unless spec-type
1601 (setq spec-type 'face-override-spec))
1602 (if (memq spec-type '(face-defface-spec face-override-spec
1603 customized-face saved-face))
1604 (put face spec-type spec))
1605 (if (memq spec-type '(reset saved-face))
1606 (put face 'customized-face nil))
1607 ;; Setting the face spec via Custom empties out any override spec,
f24f2e22 1608 ;; similar to how setting a variable via Custom changes its values.
1c4f115d
CY
1609 (if (memq spec-type '(customized-face saved-face reset))
1610 (put face 'face-override-spec nil))
1611 ;; If we reset the face based on its custom spec, it is unmodified
1612 ;; as far as Custom is concerned.
1613 (unless (eq face 'face-override-spec)
1614 (put face 'face-modified nil))
1615 (if (facep face)
1616 ;; If the face already exists, recalculate it.
1617 (dolist (frame (frame-list))
1618 (face-spec-recalc face frame))
1619 ;; Otherwise, initialize it on all frames.
1620 (make-empty-face face)
1621 (let ((value (face-user-default-spec face))
1622 (have-window-system (memq initial-window-system '(x w32 ns))))
1623 (dolist (frame (frame-list))
1624 (face-spec-set-2 face frame value)
1625 (when (memq (window-system frame) '(x w32 ns))
1626 (setq have-window-system t)))
1627 (if have-window-system
1628 (make-face-x-resource-internal face)))))
24837f13
RS
1629
1630(defun face-spec-recalc (face frame)
1631 "Reset the face attributes of FACE on FRAME according to its specs.
1632This applies the defface/custom spec first, then the custom theme specs,
1633then the override spec."
1c4f115d
CY
1634 (while (get face 'face-alias)
1635 (setq face (get face 'face-alias)))
24837f13 1636 (face-spec-reset-face face frame)
1c4f115d
CY
1637 ;; If FACE is customized or themed, set the custom spec from
1638 ;; `theme-face' records, which completely replace the defface spec
1639 ;; rather than inheriting from it.
1640 (let ((theme-faces (get face 'theme-face)))
1641 (if theme-faces
1642 (dolist (spec (reverse theme-faces))
1643 (face-spec-set-2 face frame (cadr spec)))
1644 (face-spec-set-2 face frame (face-default-spec face))))
1645 (face-spec-set-2 face frame (get face 'face-override-spec)))
24837f13
RS
1646
1647(defun face-spec-set-2 (face frame spec)
1648 "Set the face attributes of FACE on FRAME according to SPEC."
4f77c25d
CY
1649 (let* ((spec (face-spec-choose spec frame))
1650 attrs)
1651 (while spec
1652 (when (assq (car spec) face-x-resources)
1653 (push (car spec) attrs)
1654 (push (cadr spec) attrs))
1655 (setq spec (cddr spec)))
1656 (apply 'set-face-attribute face frame (nreverse attrs))))
5f5c8ee5
GM
1657
1658(defun face-attr-match-p (face attrs &optional frame)
a9de7d29 1659 "Return t if attributes of FACE match values in plist ATTRS.
5f5c8ee5
GM
1660Optional parameter FRAME is the frame whose definition of FACE
1661is used. If nil or omitted, use the selected frame."
1662 (unless frame
1663 (setq frame (selected-frame)))
8a6f24e5
GM
1664 (let* ((list face-attribute-name-alist)
1665 (match t)
1666 (bold (and (plist-member attrs :bold)
1667 (not (plist-member attrs :weight))))
1668 (italic (and (plist-member attrs :italic)
1669 (not (plist-member attrs :slant))))
1670 (plist (if (or bold italic)
1671 (copy-sequence attrs)
1672 attrs)))
1673 ;; Handle the Emacs 20 :bold and :italic properties.
1674 (if bold
1675 (plist-put plist :weight (if bold 'bold 'normal)))
1676 (if italic
1677 (plist-put plist :slant (if italic 'italic 'normal)))
4983ddea
CY
1678 (while (and match list)
1679 (let* ((attr (caar list))
a9de7d29 1680 (specified-value
8a6f24e5
GM
1681 (if (plist-member plist attr)
1682 (plist-get plist attr)
a9de7d29 1683 'unspecified))
5f5c8ee5 1684 (value-now (face-attribute face attr frame)))
a9de7d29 1685 (setq match (equal specified-value value-now))
5f5c8ee5
GM
1686 (setq list (cdr list))))
1687 match))
1688
4983ddea 1689(defsubst face-spec-match-p (face spec &optional frame)
5f5c8ee5
GM
1690 "Return t if FACE, on FRAME, matches what SPEC says it should look like."
1691 (face-attr-match-p face (face-spec-choose spec frame) frame))
1692
94fe8a31 1693(defsubst face-default-spec (face)
96c2938f
MB
1694 "Return the default face-spec for FACE, ignoring any user customization.
1695If there is no default for FACE, return nil."
1696 (get face 'face-defface-spec))
5f5c8ee5 1697
94fe8a31
MB
1698(defsubst face-user-default-spec (face)
1699 "Return the user's customized face-spec for FACE, or the default if none.
7cd512f2 1700If there is neither a user setting nor a default for FACE, return nil."
e44d251c
JL
1701 (or (get face 'customized-face)
1702 (get face 'saved-face)
94fe8a31
MB
1703 (face-default-spec face)))
1704
5f5c8ee5 1705\f
f795f633
EZ
1706;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1707;;; Frame-type independent color support.
1708;;; We keep the old x-* names as aliases for back-compatibility.
1709;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1710
1711(defun defined-colors (&optional frame)
1712 "Return a list of colors supported for a particular frame.
1713The argument FRAME specifies which frame to try.
1714The value may be different for frames on different display types.
43c58260
RS
1715If FRAME doesn't support colors, the value is nil.
1716If FRAME is nil, that stands for the selected frame."
9e2a2647 1717 (if (memq (framep (or frame (selected-frame))) '(x w32 ns))
f795f633 1718 (xw-defined-colors frame)
37462f4c 1719 (mapcar 'car (tty-color-alist frame))))
f795f633
EZ
1720(defalias 'x-defined-colors 'defined-colors)
1721
aa360da1
GM
1722(declare-function xw-color-defined-p "xfns.c" (color &optional frame))
1723
f795f633 1724(defun color-defined-p (color &optional frame)
bccffa83
CY
1725 "Return non-nil if COLOR is supported on frame FRAME.
1726COLOR should be a string naming a color (e.g. \"white\"), or a
1727string specifying a color's RGB components (e.g. \"#ff12ec\"), or
1728the symbol `unspecified'.
1729
1730This function returns nil if COLOR is the symbol `unspecified',
1731or one of the strings \"unspecified-fg\" or \"unspecified-bg\".
1732
1733If FRAME is omitted or nil, use the selected frame."
1734 (unless (member color '(unspecified "unspecified-bg" "unspecified-fg"))
9e2a2647 1735 (if (member (framep (or frame (selected-frame))) '(x w32 ns))
f795f633 1736 (xw-color-defined-p color frame)
37462f4c 1737 (numberp (tty-color-translate color frame)))))
f795f633
EZ
1738(defalias 'x-color-defined-p 'color-defined-p)
1739
aa360da1
GM
1740(declare-function xw-color-values "xfns.c" (color &optional frame))
1741
f795f633
EZ
1742(defun color-values (color &optional frame)
1743 "Return a description of the color named COLOR on frame FRAME.
6d713256
CY
1744COLOR should be a string naming a color (e.g. \"white\"), or a
1745string specifying a color's RGB components (e.g. \"#ff12ec\").
1746
1747Return a list of three integers, (RED GREEN BLUE), each between 0
1748and either 65280 or 65535 (the maximum depends on the system).
1749Use `color-name-to-rgb' if you want RGB floating-point values
1750normalized to 1.0.
1751
f795f633
EZ
1752If FRAME is omitted or nil, use the selected frame.
1753If FRAME cannot display COLOR, the value is nil.
6d713256
CY
1754
1755COLOR can also be the symbol `unspecified' or one of the strings
1756\"unspecified-fg\" or \"unspecified-bg\", in which case the
1757return value is nil."
1758 (cond
1759 ((member color '(unspecified "unspecified-fg" "unspecified-bg"))
1760 nil)
1761 ((memq (framep (or frame (selected-frame))) '(x w32 ns))
1762 (xw-color-values color frame))
1763 (t
1764 (tty-color-values color frame))))
1765
f795f633
EZ
1766(defalias 'x-color-values 'color-values)
1767
aa360da1
GM
1768(declare-function xw-display-color-p "xfns.c" (&optional terminal))
1769
f795f633
EZ
1770(defun display-color-p (&optional display)
1771 "Return t if DISPLAY supports color.
1772The optional argument DISPLAY specifies which display to ask about.
1773DISPLAY should be either a frame or a display name (a string).
1774If omitted or nil, that stands for the selected frame's display."
9e2a2647 1775 (if (memq (framep-on-display display) '(x w32 ns))
d5179a01
EZ
1776 (xw-display-color-p display)
1777 (tty-display-color-p display)))
f795f633
EZ
1778(defalias 'x-display-color-p 'display-color-p)
1779
aa360da1
GM
1780(declare-function x-display-grayscale-p "xfns.c" (&optional terminal))
1781
d5179a01
EZ
1782(defun display-grayscale-p (&optional display)
1783 "Return non-nil if frames on DISPLAY can display shades of gray."
1784 (let ((frame-type (framep-on-display display)))
1785 (cond
9e2a2647 1786 ((memq frame-type '(x w32 ns))
d5179a01
EZ
1787 (x-display-grayscale-p display))
1788 (t
1789 (> (tty-color-gray-shades display) 2)))))
1790
9317e499 1791(defun read-color (&optional prompt convert-to-RGB allow-empty-name msg)
315bc30d 1792 "Read a color name or RGB triplet.
9317e499
CY
1793Completion is available for color names, but not for RGB triplets.
1794
315bc30d
CY
1795RGB triplets have the form \"#RRGGBB\". Each of the R, G, and B
1796components can have one to four digits, but all three components
1797must have the same number of digits. Each digit is a hex value
1798between 0 and F; either upper case or lower case for A through F
1799are acceptable.
9317e499
CY
1800
1801In addition to standard color names and RGB hex values, the
1802following are available as color candidates. In each case, the
1803corresponding color is used.
26c07a69
RS
1804
1805 * `foreground at point' - foreground under the cursor
1806 * `background at point' - background under the cursor
1807
9317e499 1808Optional arg PROMPT is the prompt; if nil, use a default prompt.
26c07a69 1809
9317e499
CY
1810Interactively, or with optional arg CONVERT-TO-RGB-P non-nil,
1811convert an input color name to an RGB hex string. Return the RGB
1812hex string.
26c07a69 1813
9317e499
CY
1814If optional arg ALLOW-EMPTY-NAME is non-nil, the user is allowed
1815to enter an empty color name (the empty string).
26c07a69 1816
9317e499
CY
1817Interactively, or with optional arg MSG non-nil, print the
1818resulting color name in the echo area."
26c07a69
RS
1819 (interactive "i\np\ni\np") ; Always convert to RGB interactively.
1820 (let* ((completion-ignore-case t)
9317e499
CY
1821 (colors (or facemenu-color-alist
1822 (append '("foreground at point" "background at point")
1823 (if allow-empty-name '(""))
1824 (defined-colors))))
1825 (color (completing-read
1826 (or prompt "Color (name or #RGB triplet): ")
1827 ;; Completing function for reading colors, accepting
1828 ;; both color names and RGB triplets.
1829 (lambda (string pred flag)
1830 (cond
1831 ((null flag) ; Try completion.
1832 (or (try-completion string colors pred)
1833 (if (color-defined-p string)
1834 string)))
1835 ((eq flag t) ; List all completions.
1836 (or (all-completions string colors pred)
1837 (if (color-defined-p string)
1838 (list string))))
1839 ((eq flag 'lambda) ; Test completion.
1840 (or (memq string colors)
1841 (color-defined-p string)))))
06b60517 1842 nil t)))
9317e499
CY
1843
1844 ;; Process named colors.
1845 (when (member color colors)
1846 (cond ((string-equal color "foreground at point")
1847 (setq color (foreground-color-at-point)))
1848 ((string-equal color "background at point")
1849 (setq color (background-color-at-point))))
1850 (when (and convert-to-RGB
1851 (not (string-equal color "")))
1852 (let ((components (x-color-values color)))
1853 (unless (string-match "^#\\([a-fA-F0-9][a-fA-F0-9][a-fA-F0-9]\\)+$" color)
1854 (setq color (format "#%04X%04X%04X"
1855 (logand 65535 (nth 0 components))
1856 (logand 65535 (nth 1 components))
1857 (logand 65535 (nth 2 components))))))))
1858 (when msg (message "Color: `%s'" color))
1859 color))
1860
011cddd6 1861(defun face-at-point (&optional thing multiple)
26c07a69
RS
1862 "Return the face of the character after point.
1863If it has more than one face, return the first one.
011cddd6
RW
1864If THING is non-nil try first to get a face name from the buffer.
1865IF MULTIPLE is non-nil, return a list of all faces.
1866Return nil if there is no face."
1867 (let (faces)
1868 (if thing
1869 ;; Try to get a face name from the buffer.
1870 (let ((face (intern-soft (thing-at-point 'symbol))))
1871 (if (facep face)
1872 (push face faces))))
1873 ;; Add the named faces that the `read-face-name' or `face' property uses.
1874 (let ((faceprop (or (get-char-property (point) 'read-face-name)
1875 (get-char-property (point) 'face))))
1876 (cond ((facep faceprop)
1877 (push faceprop faces))
1878 ((and (listp faceprop)
1879 ;; Don't treat an attribute spec as a list of faces.
1880 (not (keywordp (car faceprop)))
1881 (not (memq (car faceprop)
1882 '(foreground-color background-color))))
1883 (dolist (face faceprop)
1884 (if (facep face)
1885 (push face faces))))))
1886 (setq faces (delete-dups (nreverse faces)))
1887 (if multiple faces (car faces))))
26c07a69
RS
1888
1889(defun foreground-color-at-point ()
1890 "Return the foreground color of the character after point."
1891 ;; `face-at-point' alone is not sufficient. It only gets named faces.
1892 ;; Need also pick up any face properties that are not associated with named faces.
1893 (let ((face (or (face-at-point)
1894 (get-char-property (point) 'read-face-name)
1895 (get-char-property (point) 'face))))
1896 (cond ((and face (symbolp face))
1897 (let ((value (face-foreground face nil 'default)))
1898 (if (member value '("unspecified-fg" "unspecified-bg"))
1899 nil
1900 value)))
1901 ((consp face)
1902 (cond ((memq 'foreground-color face) (cdr (memq 'foreground-color face)))
1903 ((memq ':foreground face) (cadr (memq ':foreground face)))))
1904 (t nil)))) ; Invalid face value.
1905
1906(defun background-color-at-point ()
1907 "Return the background color of the character after point."
1908 ;; `face-at-point' alone is not sufficient. It only gets named faces.
1909 ;; Need also pick up any face properties that are not associated with named faces.
1910 (let ((face (or (face-at-point)
1911 (get-char-property (point) 'read-face-name)
1912 (get-char-property (point) 'face))))
1913 (cond ((and face (symbolp face))
1914 (let ((value (face-background face nil 'default)))
1915 (if (member value '("unspecified-fg" "unspecified-bg"))
1916 nil
1917 value)))
1918 ((consp face)
1919 (cond ((memq 'background-color face) (cdr (memq 'background-color face)))
1920 ((memq ':background face) (cadr (memq ':background face)))))
1921 (t nil)))) ; Invalid face value.
5f5c8ee5 1922
5f5c8ee5
GM
1923\f
1924;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1925;;; Frame creation.
1926;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1927
aa360da1 1928(declare-function x-parse-geometry "frame.c" (string))
a88324d4 1929(defvar x-display-name)
aa360da1 1930
5f5c8ee5
GM
1931(defun x-handle-named-frame-geometry (parameters)
1932 "Add geometry parameters for a named frame to parameter list PARAMETERS.
1933Value is the new parameter list."
e8a2b2da 1934 ;; Note that `x-resource-name' has a global meaning.
c1ef4455 1935 (let ((x-resource-name (cdr (assq 'name parameters))))
e8a2b2da
CY
1936 (when x-resource-name
1937 ;; Before checking X resources, we must have an X connection.
1938 (or (window-system)
1939 (x-display-list)
1940 (x-open-connection (or (cdr (assq 'display parameters))
1941 x-display-name)))
1942 (let (res-geometry parsed)
1943 (and (setq res-geometry (x-get-resource "geometry" "Geometry"))
1944 (setq parsed (x-parse-geometry res-geometry))
1945 (setq parameters
c1ef4455 1946 (append parameters parsed
e8a2b2da
CY
1947 ;; If the resource specifies a position,
1948 ;; take note of that.
1949 (if (or (assq 'top parsed) (assq 'left parsed))
1950 '((user-position . t) (user-size . t)))))))))
1951 parameters)
5f5c8ee5
GM
1952
1953
1954(defun x-handle-reverse-video (frame parameters)
1955 "Handle the reverse-video frame parameter and X resource.
1956`x-create-frame' does not handle this one."
1957 (when (cdr (or (assq 'reverse parameters)
5f5c8ee5
GM
1958 (let ((resource (x-get-resource "reverseVideo"
1959 "ReverseVideo")))
1960 (if resource
1961 (cons nil (member (downcase resource)
1962 '("on" "true")))))))
1963 (let* ((params (frame-parameters frame))
1964 (bg (cdr (assq 'foreground-color params)))
1965 (fg (cdr (assq 'background-color params))))
1966 (modify-frame-parameters frame
1967 (list (cons 'foreground-color fg)
1968 (cons 'background-color bg)))
1969 (if (equal bg (cdr (assq 'border-color params)))
1970 (modify-frame-parameters frame
1971 (list (cons 'border-color fg))))
1972 (if (equal bg (cdr (assq 'mouse-color params)))
1973 (modify-frame-parameters frame
1974 (list (cons 'mouse-color fg))))
1975 (if (equal bg (cdr (assq 'cursor-color params)))
1976 (modify-frame-parameters frame
1977 (list (cons 'cursor-color fg)))))))
1978
aa360da1 1979(declare-function x-create-frame "xfns.c" (parms))
c8ccffb1 1980(declare-function x-setup-function-keys "term/common-win" (frame))
5f5c8ee5
GM
1981
1982(defun x-create-frame-with-faces (&optional parameters)
c1ef4455
CY
1983 "Create and return a frame with frame parameters PARAMETERS.
1984If PARAMETERS specify a frame name, handle X geometry resources
1985for that name. If PARAMETERS includes a `reverse' parameter, or
1986the X resource ``reverseVideo'' is present, handle that."
5f5c8ee5 1987 (setq parameters (x-handle-named-frame-geometry parameters))
41e6403e
CY
1988 (let* ((params (copy-tree parameters))
1989 (visibility-spec (assq 'visibility parameters))
1990 (delayed-params '(foreground-color background-color font
1991 border-color cursor-color mouse-color
1992 visibility scroll-bar-foreground
1993 scroll-bar-background))
1994 frame success)
1995 (dolist (param delayed-params)
1996 (setq params (assq-delete-all param params)))
1997 (setq frame (x-create-frame `((visibility . nil) . ,params)))
5f5c8ee5
GM
1998 (unwind-protect
1999 (progn
2bb819d5 2000 (x-setup-function-keys frame)
5f5c8ee5 2001 (x-handle-reverse-video frame parameters)
4983ddea 2002 (frame-set-background-mode frame t)
fa7015f4 2003 (face-set-after-frame-default frame parameters)
095fe281 2004 (if (null visibility-spec)
5f5c8ee5
GM
2005 (make-frame-visible frame)
2006 (modify-frame-parameters frame (list visibility-spec)))
2007 (setq success t))
2008 (unless success
2009 (delete-frame frame)))
2010 frame))
2011
fa7015f4
CY
2012(defun face-set-after-frame-default (frame &optional parameters)
2013 "Initialize the frame-local faces of FRAME.
2014Calculate the face definitions using the face specs, custom theme
41e6403e 2015settings, X resources, and `face-new-frame-defaults'.
fa7015f4 2016Finally, apply any relevant face attributes found amongst the
c1ef4455 2017frame parameters in PARAMETERS."
4983ddea 2018 (let ((window-system-p (memq (window-system frame) '(x w32))))
1485f4c0
CY
2019 ;; The `reverse' is so that `default' goes first.
2020 (dolist (face (nreverse (face-list)))
4983ddea
CY
2021 (condition-case ()
2022 (progn
2023 ;; Initialize faces from face spec and custom theme.
2024 (face-spec-recalc face frame)
40ba43b4 2025 ;; X resources for the default face are applied during
4983ddea
CY
2026 ;; `x-create-frame'.
2027 (and (not (eq face 'default)) window-system-p
2028 (make-face-x-resource-internal face frame))
2029 ;; Apply attributes specified by face-new-frame-defaults
2030 (internal-merge-in-global-face face frame))
2031 ;; Don't let invalid specs prevent frame creation.
2032 (error nil))))
2033
fa7015f4 2034 ;; Apply attributes specified by frame parameters.
8db9c5ee 2035 (let ((face-params '((foreground-color default :foreground)
fa7015f4
CY
2036 (background-color default :background)
2037 (font default :font)
2038 (border-color border :background)
2039 (cursor-color cursor :background)
2040 (scroll-bar-foreground scroll-bar :foreground)
2041 (scroll-bar-background scroll-bar :background)
2042 (mouse-color mouse :background))))
8db9c5ee 2043 (dolist (param face-params)
fa7015f4 2044 (let* ((param-name (nth 0 param))
c1ef4455 2045 (value (cdr (assq param-name parameters))))
fa7015f4
CY
2046 (if value
2047 (set-face-attribute (nth 1 param) frame
2048 (nth 2 param) value))))))
5f5c8ee5 2049
53990c84
EZ
2050(defun tty-handle-reverse-video (frame parameters)
2051 "Handle the reverse-video frame parameter for terminal frames."
c1ef4455 2052 (when (cdr (assq 'reverse parameters))
53990c84
EZ
2053 (let* ((params (frame-parameters frame))
2054 (bg (cdr (assq 'foreground-color params)))
2055 (fg (cdr (assq 'background-color params))))
2056 (modify-frame-parameters frame
2057 (list (cons 'foreground-color fg)
2058 (cons 'background-color bg)))
2059 (if (equal bg (cdr (assq 'mouse-color params)))
2060 (modify-frame-parameters frame
2061 (list (cons 'mouse-color fg))))
2062 (if (equal bg (cdr (assq 'cursor-color params)))
2063 (modify-frame-parameters frame
2064 (list (cons 'cursor-color fg)))))))
2065
5f5c8ee5
GM
2066
2067(defun tty-create-frame-with-faces (&optional parameters)
c1ef4455
CY
2068 "Create and return a frame from optional frame parameters PARAMETERS.
2069If PARAMETERS contains a `reverse' parameter, handle that."
5f5c8ee5
GM
2070 (let ((frame (make-terminal-frame parameters))
2071 success)
2072 (unwind-protect
061e4e7f 2073 (with-selected-frame frame
53990c84 2074 (tty-handle-reverse-video frame (frame-parameters frame))
cd85984a 2075
8782c744
SM
2076 (unless (terminal-parameter frame 'terminal-initted)
2077 (set-terminal-parameter frame 'terminal-initted t)
2078 (set-locale-environment nil frame)
2079 (tty-run-terminal-initialization frame))
4983ddea 2080 (frame-set-background-mode frame t)
fa7015f4 2081 (face-set-after-frame-default frame parameters)
5f5c8ee5
GM
2082 (setq success t))
2083 (unless success
2084 (delete-frame frame)))
2085 frame))
465fceed 2086
b34c34da
KL
2087(defun tty-find-type (pred type)
2088 "Return the longest prefix of TYPE to which PRED returns non-nil.
2089TYPE should be a tty type name such as \"xterm-16color\".
2090
2091The function tries only those prefixes that are followed by a
2092dash or underscore in the original type name, like \"xterm\" in
2093the above example."
2094 (let (hyphend)
2095 (while (and type
2096 (not (funcall pred type)))
2097 ;; Strip off last hyphen and what follows, then try again
2098 (setq type
2099 (if (setq hyphend (string-match "[-_][^-_]+$" type))
2100 (substring type 0 hyphend)
2101 nil))))
2102 type)
2103
8cbd7bed
KL
2104(defun tty-run-terminal-initialization (frame &optional type)
2105 "Run the special initialization code for the terminal type of FRAME.
2106The optional TYPE parameter may be used to override the autodetected
2107terminal type to a different value."
2108 (setq type (or type (tty-type frame)))
cd85984a
KL
2109 ;; Load library for our terminal type.
2110 ;; User init file can set term-file-prefix to nil to prevent this.
2111 (with-selected-frame frame
8782c744 2112 (unless (null term-file-prefix)
b34c34da
KL
2113 (let* (term-init-func)
2114 ;; First, load the terminal initialization file, if it is
2115 ;; available and it hasn't been loaded already.
2116 (tty-find-type #'(lambda (type)
2117 (let ((file (locate-library (concat term-file-prefix type))))
2118 (and file
2119 (or (assoc file load-history)
2120 (load file t t)))))
8cbd7bed 2121 type)
b34c34da
KL
2122 ;; Next, try to find a matching initialization function, and call it.
2123 (tty-find-type #'(lambda (type)
2124 (fboundp (setq term-init-func
2125 (intern (concat "terminal-init-" type)))))
8cbd7bed 2126 type)
567c8878 2127 (when (fboundp term-init-func)
b34c34da
KL
2128 (funcall term-init-func))
2129 (set-terminal-parameter frame 'terminal-initted term-init-func)))))
465fceed 2130
5f5c8ee5
GM
2131;; Called from C function init_display to initialize faces of the
2132;; dumped terminal frame on startup.
465fceed 2133
5f5c8ee5
GM
2134(defun tty-set-up-initial-frame-faces ()
2135 (let ((frame (selected-frame)))
4983ddea 2136 (frame-set-background-mode frame t)
5f5c8ee5 2137 (face-set-after-frame-default frame)))
00f51890 2138
465fceed 2139
bdda3754 2140\f
5f5c8ee5
GM
2141;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2142;;; Standard faces.
2143;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
465fceed 2144
5f5c8ee5
GM
2145(defgroup basic-faces nil
2146 "The standard faces of Emacs."
2147 :group 'faces)
ef436392 2148
bacbbe8f
CY
2149(defface default
2150 '((t nil)) ; If this were nil, face-defface-spec would not be set.
5f5c8ee5
GM
2151 "Basic default face."
2152 :group 'basic-faces)
465fceed 2153
51d44a36
JL
2154(defface bold
2155 '((t :weight bold))
2156 "Basic bold face."
2157 :group 'basic-faces)
2158
2159(defface italic
2160 '((((supports :slant italic))
2161 :slant italic)
2162 (((supports :underline t))
2163 :underline t)
2164 (t
9aaf2b9c
GM
2165 ;; Default to italic, even if it doesn't appear to be supported,
2166 ;; because in some cases the display engine will do its own
2167 ;; workaround (to `dim' on ttys).
51d44a36
JL
2168 :slant italic))
2169 "Basic italic face."
2170 :group 'basic-faces)
2171
2172(defface bold-italic
2173 '((t :weight bold :slant italic))
2174 "Basic bold-italic face."
2175 :group 'basic-faces)
2176
2177(defface underline
2178 '((((supports :underline t))
2179 :underline t)
2180 (((supports :weight bold))
2181 :weight bold)
2182 (t :underline t))
2183 "Basic underlined face."
2184 :group 'basic-faces)
2185
2186(defface fixed-pitch
d5f57335 2187 '((t :family "Monospace"))
51d44a36
JL
2188 "The basic fixed-pitch face."
2189 :group 'basic-faces)
2190
2191(defface variable-pitch
ed008205 2192 '((t :family "Sans Serif"))
51d44a36
JL
2193 "The basic variable-pitch face."
2194 :group 'basic-faces)
2195
2196(defface shadow
2197 '((((class color grayscale) (min-colors 88) (background light))
2198 :foreground "grey50")
2199 (((class color grayscale) (min-colors 88) (background dark))
2200 :foreground "grey70")
2201 (((class color) (min-colors 8) (background light))
2202 :foreground "green")
2203 (((class color) (min-colors 8) (background dark))
2204 :foreground "yellow"))
2205 "Basic face for shadowed text."
2206 :group 'basic-faces
2207 :version "22.1")
2208
59746720
JL
2209(defface link
2210 '((((class color) (min-colors 88) (background light))
fa7c3228 2211 :foreground "RoyalBlue3" :underline t)
59746720
JL
2212 (((class color) (background light))
2213 :foreground "blue" :underline t)
2214 (((class color) (min-colors 88) (background dark))
2215 :foreground "cyan1" :underline t)
2216 (((class color) (background dark))
2217 :foreground "cyan" :underline t)
2218 (t :inherit underline))
2219 "Basic face for unvisited links."
2220 :group 'basic-faces
2221 :version "22.1")
2222
2223(defface link-visited
2224 '((default :inherit link)
2225 (((class color) (background light)) :foreground "magenta4")
2226 (((class color) (background dark)) :foreground "violet"))
2227 "Basic face for visited links."
2228 :group 'basic-faces
2229 :version "22.1")
2230
51d44a36
JL
2231(defface highlight
2232 '((((class color) (min-colors 88) (background light))
2233 :background "darkseagreen2")
2234 (((class color) (min-colors 88) (background dark))
2235 :background "darkolivegreen")
2236 (((class color) (min-colors 16) (background light))
2237 :background "darkseagreen2")
2238 (((class color) (min-colors 16) (background dark))
2239 :background "darkolivegreen")
2240 (((class color) (min-colors 8))
2241 :background "green" :foreground "black")
2242 (t :inverse-video t))
2243 "Basic face for highlighting."
2244 :group 'basic-faces)
2245
f3e848f4
AR
2246;; Region face: under NS, default to the system-defined selection
2247;; color (optimized for the fixed white background of other apps),
2248;; if background is light.
51d44a36
JL
2249(defface region
2250 '((((class color) (min-colors 88) (background dark))
2251 :background "blue3")
3a46642b
J
2252 (((class color) (min-colors 88) (background light) (type gtk))
2253 :foreground "gtk_selection_fg_color"
2254 :background "gtk_selection_bg_color")
f3e848f4
AR
2255 (((class color) (min-colors 88) (background light) (type ns))
2256 :background "ns_selection_color")
51d44a36
JL
2257 (((class color) (min-colors 88) (background light))
2258 :background "lightgoldenrod2")
2259 (((class color) (min-colors 16) (background dark))
2260 :background "blue3")
2261 (((class color) (min-colors 16) (background light))
2262 :background "lightgoldenrod2")
2263 (((class color) (min-colors 8))
2264 :background "blue" :foreground "white")
2265 (((type tty) (class mono))
2266 :inverse-video t)
2267 (t :background "gray"))
2268 "Basic face for highlighting the region."
2269 :version "21.1"
2270 :group 'basic-faces)
2271
2272(defface secondary-selection
2273 '((((class color) (min-colors 88) (background light))
2274 :background "yellow1")
2275 (((class color) (min-colors 88) (background dark))
2276 :background "SkyBlue4")
2277 (((class color) (min-colors 16) (background light))
2278 :background "yellow")
2279 (((class color) (min-colors 16) (background dark))
2280 :background "SkyBlue4")
2281 (((class color) (min-colors 8))
2282 :background "cyan" :foreground "black")
2283 (t :inverse-video t))
2284 "Basic face for displaying the secondary selection."
2285 :group 'basic-faces)
2286
2287(defface trailing-whitespace
2288 '((((class color) (background light))
2289 :background "red1")
2290 (((class color) (background dark))
2291 :background "red1")
2292 (t :inverse-video t))
2293 "Basic face for highlighting trailing whitespace."
2294 :version "21.1"
d4c6530f 2295 :group 'whitespace-faces ; like `show-trailing-whitespace'
51d44a36
JL
2296 :group 'basic-faces)
2297
2298(defface escape-glyph
2299 '((((background dark)) :foreground "cyan")
2300 ;; See the comment in minibuffer-prompt for
2301 ;; the reason not to use blue on MS-DOS.
2302 (((type pc)) :foreground "magenta")
2303 ;; red4 is too dark, but some say blue is too loud.
2304 ;; brown seems to work ok. -- rms.
2305 (t :foreground "brown"))
1a77c985 2306 "Face for characters displayed as sequences using `^' or `\\'."
51d44a36
JL
2307 :group 'basic-faces
2308 :version "22.1")
2309
2310(defface nobreak-space
2311 '((((class color) (min-colors 88)) :inherit escape-glyph :underline t)
2312 (((class color) (min-colors 8)) :background "magenta")
2313 (t :inverse-video t))
2314 "Face for displaying nobreak space."
2315 :group 'basic-faces
2316 :version "22.1")
72418504 2317
97bca259
JL
2318(defgroup mode-line-faces nil
2319 "Faces used in the mode line."
6d968826 2320 :group 'mode-line
97bca259
JL
2321 :group 'faces
2322 :version "22.1")
2323
3759f14b 2324(defface mode-line
11c2175c 2325 '((((class color) (min-colors 88))
b6b90dfc
SM
2326 :box (:line-width -1 :style released-button)
2327 :background "grey75" :foreground "black")
5f5c8ee5 2328 (t
b6b90dfc 2329 :inverse-video t))
c5752dcb 2330 "Basic mode line face for selected window."
a4391cf1 2331 :version "21.1"
97bca259 2332 :group 'mode-line-faces
5f5c8ee5 2333 :group 'basic-faces)
465fceed 2334
c5752dcb 2335(defface mode-line-inactive
cf459bb7 2336 '((default
b6b90dfc 2337 :inherit mode-line)
11c2175c 2338 (((class color) (min-colors 88) (background light))
c5752dcb
KS
2339 :weight light
2340 :box (:line-width -1 :color "grey75" :style nil)
2341 :foreground "grey20" :background "grey90")
11c2175c 2342 (((class color) (min-colors 88) (background dark) )
53a2f6e1
MB
2343 :weight light
2344 :box (:line-width -1 :color "grey40" :style nil)
b6b90dfc 2345 :foreground "grey80" :background "grey30"))
c5752dcb 2346 "Basic mode line face for non-selected windows."
bf247b6e 2347 :version "22.1"
97bca259
JL
2348 :group 'mode-line-faces
2349 :group 'basic-faces)
9f255bc3 2350(define-obsolete-face-alias 'modeline-inactive 'mode-line-inactive "22.1")
97bca259
JL
2351
2352(defface mode-line-highlight
2353 '((((class color) (min-colors 88))
2354 :box (:line-width 2 :color "grey40" :style released-button))
2355 (t
2356 :inherit highlight))
2357 "Basic mode line face for highlighting."
2358 :version "22.1"
2359 :group 'mode-line-faces
2360 :group 'basic-faces)
9f255bc3 2361(define-obsolete-face-alias 'modeline-highlight 'mode-line-highlight "22.1")
97bca259 2362
313e2fc4
GM
2363(defface mode-line-emphasis
2364 '((t (:weight bold)))
2365 "Face used to emphasize certain mode line features.
2366Use the face `mode-line-highlight' for features that can be selected."
2367 :version "23.1"
2368 :group 'mode-line-faces
2369 :group 'basic-faces)
2370
97bca259
JL
2371(defface mode-line-buffer-id
2372 '((t (:weight bold)))
2373 "Face used for buffer identification parts of the mode line."
2374 :version "22.1"
2375 :group 'mode-line-faces
c5752dcb 2376 :group 'basic-faces)
9f255bc3 2377(define-obsolete-face-alias 'modeline-buffer-id 'mode-line-buffer-id "22.1")
d11fba25 2378
e5e7779f 2379(defface header-line
cf459bb7 2380 '((default
6b61353c
KH
2381 :inherit mode-line)
2382 (((type tty))
1cb4393e
MB
2383 ;; This used to be `:inverse-video t', but that doesn't look very
2384 ;; good when combined with inverse-video mode-lines and multiple
2385 ;; windows. Underlining looks better, and is more consistent with
2386 ;; the window-system face variants, which deemphasize the
2387 ;; header-line in relation to the mode-line face. If a terminal
2388 ;; can't underline, then the header-line will end up without any
2389 ;; highlighting; this may be too confusing in general, although it
2390 ;; happens to look good with the only current use of header-lines,
2391 ;; the info browser. XXX
6b61353c 2392 :inverse-video nil ;Override the value inherited from mode-line.
a7ac92b6 2393 :underline t)
98490598 2394 (((class color grayscale) (background light))
bdab1d43 2395 :background "grey90" :foreground "grey20"
6b61353c 2396 :box nil)
98490598 2397 (((class color grayscale) (background dark))
bdab1d43 2398 :background "grey20" :foreground "grey90"
6b61353c 2399 :box nil)
98490598 2400 (((class mono) (background light))
bdab1d43
MB
2401 :background "white" :foreground "black"
2402 :inverse-video nil
2403 :box nil
6b61353c 2404 :underline t)
98490598 2405 (((class mono) (background dark))
bdab1d43
MB
2406 :background "black" :foreground "white"
2407 :inverse-video nil
2408 :box nil
6b61353c 2409 :underline t))
e5e7779f 2410 "Basic header-line face."
a4391cf1 2411 :version "21.1"
5f5c8ee5 2412 :group 'basic-faces)
e8e4cda0 2413
51d44a36
JL
2414(defface vertical-border
2415 '((((type tty)) :inherit mode-line-inactive))
2416 "Face used for vertical window dividers on ttys."
2417 :version "22.1"
5f5c8ee5 2418 :group 'basic-faces)
d11fba25 2419
9ed779e8
JL
2420(defface minibuffer-prompt
2421 '((((background dark)) :foreground "cyan")
2422 ;; Don't use blue because many users of the MS-DOS port customize
2423 ;; their foreground color to be blue.
2424 (((type pc)) :foreground "magenta")
c57a1dc6 2425 (t :foreground "medium blue"))
9ed779e8
JL
2426 "Face for minibuffer prompts.
2427By default, Emacs automatically adds this face to the value of
2428`minibuffer-prompt-properties', which is a list of text properties
2429used to display the prompt text."
bf247b6e 2430 :version "22.1"
31cf46d3
RS
2431 :group 'basic-faces)
2432
2433(setq minibuffer-prompt-properties
2434 (append minibuffer-prompt-properties (list 'face 'minibuffer-prompt)))
2435
f1cae29e 2436(defface fringe
d6d59057 2437 '((((class color) (background light))
b6b90dfc
SM
2438 :background "grey95")
2439 (((class color) (background dark))
2440 :background "grey10")
2441 (t
2442 :background "gray"))
f1cae29e
GM
2443 "Basic face for the fringes to the left and right of windows under X."
2444 :version "21.1"
84fe35f0 2445 :group 'frames
f1cae29e
GM
2446 :group 'basic-faces)
2447
d390b4d2 2448(defface scroll-bar '((t nil))
f1cae29e
GM
2449 "Basic face for the scroll bar colors under X."
2450 :version "21.1"
84fe35f0 2451 :group 'frames
f1cae29e
GM
2452 :group 'basic-faces)
2453
d390b4d2 2454(defface border '((t nil))
f1cae29e
GM
2455 "Basic face for the frame border under X."
2456 :version "21.1"
84fe35f0 2457 :group 'frames
f1cae29e
GM
2458 :group 'basic-faces)
2459
4983ddea
CY
2460(defface cursor
2461 '((((background light)) :background "black")
2462 (((background dark)) :background "white"))
8d413c2b 2463 "Basic face for the cursor color under X.
08b0fee8
CY
2464Currently, only the `:background' attribute is meaningful; all
2465other attributes are ignored. The cursor foreground color is
2466taken from the background color of the underlying text.
2467
8d413c2b 2468Note: Other faces cannot inherit from the cursor face."
f1cae29e 2469 :version "21.1"
84fe35f0 2470 :group 'cursor
f1cae29e
GM
2471 :group 'basic-faces)
2472
8d413c2b 2473(put 'cursor 'face-no-inherit t)
f1cae29e 2474
d390b4d2 2475(defface mouse '((t nil))
f1cae29e 2476 "Basic face for the mouse color under X."
e59176e2 2477 :version "21.1"
84fe35f0 2478 :group 'mouse
5f5c8ee5 2479 :group 'basic-faces)
bdda3754 2480
51d44a36
JL
2481(defface tool-bar
2482 '((default
2483 :box (:line-width 1 :style released-button)
2484 :foreground "black")
9e2a2647 2485 (((type x w32 ns) (class color))
51d44a36
JL
2486 :background "grey75")
2487 (((type x) (class mono))
2488 :background "grey"))
2489 "Basic tool-bar face."
2490 :version "21.1"
5f5c8ee5 2491 :group 'basic-faces)
bdda3754 2492
51d44a36
JL
2493(defface menu
2494 '((((type tty))
2495 :inverse-video t)
2496 (((type x-toolkit))
2497 )
16320ac7 2498 (t
51d44a36
JL
2499 :inverse-video t))
2500 "Basic face for the font and colors of the menu bar and popup menus."
a4391cf1 2501 :version "21.1"
51d44a36 2502 :group 'menu
a4391cf1 2503 :group 'basic-faces)
465fceed 2504
4c47bd1e 2505(defface help-argument-name '((t :inherit italic))
6c58c39c
CY
2506 "Face to highlight argument names in *Help* buffers."
2507 :group 'help)
b2cca856 2508
b18fad6d
KH
2509(defface glyphless-char
2510 '((((type tty)) :inherit underline)
1cd64aae 2511 (((type pc)) :inherit escape-glyph)
b18fad6d 2512 (t :height 0.6))
b2cca856
KH
2513 "Face for displaying non-graphic characters (e.g. U+202A (LRE)).
2514It is used for characters of no fonts too."
2515 :version "24.1"
2516 :group 'basic-faces)
bc987f8b
JL
2517
2518(defface error
4b56d0fe
CY
2519 '((default :weight bold)
2520 (((class color) (min-colors 88) (background light)) :foreground "Red1")
2521 (((class color) (min-colors 88) (background dark)) :foreground "Pink")
2522 (((class color) (min-colors 16) (background light)) :foreground "Red1")
2523 (((class color) (min-colors 16) (background dark)) :foreground "Pink")
2524 (((class color) (min-colors 8)) :foreground "red")
2525 (t :inverse-video t))
bc987f8b
JL
2526 "Basic face used to highlight errors and to denote failure."
2527 :version "24.1"
2528 :group 'basic-faces)
2529
2530(defface warning
4b56d0fe
CY
2531 '((default :weight bold)
2532 (((class color) (min-colors 16)) :foreground "DarkOrange")
2533 (((class color)) :foreground "yellow"))
bc987f8b
JL
2534 "Basic face used to highlight warnings."
2535 :version "24.1"
2536 :group 'basic-faces)
2537
2538(defface success
4b56d0fe
CY
2539 '((default :weight bold)
2540 (((class color) (min-colors 16) (background light)) :foreground "ForestGreen")
2541 (((class color) (min-colors 88) (background dark)) :foreground "Green1")
2542 (((class color) (min-colors 16) (background dark)) :foreground "Green")
2543 (((class color)) :foreground "green"))
bc987f8b
JL
2544 "Basic face used to indicate successful operation."
2545 :version "24.1"
2546 :group 'basic-faces)
2547
465fceed 2548\f
5f5c8ee5
GM
2549;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2550;;; Manipulating font names.
2551;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2552
da6062e6 2553;; This is here for compatibility with Emacs 20.2. For example,
07f27947
DL
2554;; international/fontset.el uses x-resolve-font-name. The following
2555;; functions are not used in the face implementation itself.
465fceed 2556
d7fa5aa2
RS
2557(defvar x-font-regexp nil)
2558(defvar x-font-regexp-head nil)
2559(defvar x-font-regexp-weight nil)
2560(defvar x-font-regexp-slant nil)
465fceed 2561
021ca129
KH
2562(defconst x-font-regexp-weight-subnum 1)
2563(defconst x-font-regexp-slant-subnum 2)
2564(defconst x-font-regexp-swidth-subnum 3)
2565(defconst x-font-regexp-adstyle-subnum 4)
2566
465fceed
ER
2567;;; Regexps matching font names in "Host Portable Character Representation."
2568;;;
2569(let ((- "[-?]")
2570 (foundry "[^-]+")
2571 (family "[^-]+")
2572 (weight "\\(bold\\|demibold\\|medium\\)") ; 1
2573; (weight\? "\\(\\*\\|bold\\|demibold\\|medium\\|\\)") ; 1
2574 (weight\? "\\([^-]*\\)") ; 1
2575 (slant "\\([ior]\\)") ; 2
2576; (slant\? "\\([ior?*]?\\)") ; 2
2577 (slant\? "\\([^-]?\\)") ; 2
2578; (swidth "\\(\\*\\|normal\\|semicondensed\\|\\)") ; 3
2579 (swidth "\\([^-]*\\)") ; 3
2580; (adstyle "\\(\\*\\|sans\\|\\)") ; 4
c8787b81 2581 (adstyle "\\([^-]*\\)") ; 4
465fceed
ER
2582 (pixelsize "[0-9]+")
2583 (pointsize "[0-9][0-9]+")
2584 (resx "[0-9][0-9]+")
2585 (resy "[0-9][0-9]+")
2586 (spacing "[cmp?*]")
2587 (avgwidth "[0-9]+")
2588 (registry "[^-]+")
2589 (encoding "[^-]+")
2590 )
2591 (setq x-font-regexp
1e8780b1 2592 (purecopy (concat "\\`\\*?[-?*]"
465fceed 2593 foundry - family - weight\? - slant\? - swidth - adstyle -
e20d641f
RS
2594 pixelsize - pointsize - resx - resy - spacing - avgwidth -
2595 registry - encoding "\\*?\\'"
1e8780b1 2596 )))
465fceed 2597 (setq x-font-regexp-head
1e8780b1
DN
2598 (purecopy (concat "\\`[-?*]" foundry - family - weight\? - slant\?
2599 "\\([-*?]\\|\\'\\)")))
2600 (setq x-font-regexp-slant (purecopy (concat - slant -)))
2601 (setq x-font-regexp-weight (purecopy (concat - weight -)))
70d0c3b0 2602 nil)
465fceed 2603
5f5c8ee5 2604
281dc1c2
JB
2605(defun x-resolve-font-name (pattern &optional face frame)
2606 "Return a font name matching PATTERN.
ac4c2e6b 2607All wildcards in PATTERN are instantiated.
10d89673
JB
2608If PATTERN is nil, return the name of the frame's base font, which never
2609contains wildcards.
e17dbede
RS
2610Given optional arguments FACE and FRAME, return a font which is
2611also the same size as FACE on FRAME, or fail."
14e6867c
RS
2612 (or (symbolp face)
2613 (setq face (face-name face)))
2614 (and (eq frame t)
2615 (setq frame nil))
10d89673 2616 (if pattern
8db93e45 2617 ;; Note that x-list-fonts has code to handle a face with nil as its font.
abd89b80 2618 (let ((fonts (x-list-fonts pattern face frame 1)))
10d89673
JB
2619 (or fonts
2620 (if face
962a60aa
RS
2621 (if (string-match "\\*" pattern)
2622 (if (null (face-font face))
2623 (error "No matching fonts are the same height as the frame default font")
2624 (error "No matching fonts are the same height as face `%s'" face))
2625 (if (null (face-font face))
2626 (error "Height of font `%s' doesn't match the frame default font"
2627 pattern)
2628 (error "Height of font `%s' doesn't match face `%s'"
2629 pattern face)))
7cf6fac1 2630 (error "No fonts match `%s'" pattern)))
10d89673
JB
2631 (car fonts))
2632 (cdr (assq 'font (frame-parameters (selected-frame))))))
281dc1c2 2633
49238e7f
CY
2634(defcustom font-list-limit 100
2635 "This variable is obsolete and has no effect."
2636 :type 'integer
2637 :group 'display)
2638(make-obsolete-variable 'font-list-limit nil "24.3")
2639
f0138172
JB
2640(provide 'faces)
2641
70d0c3b0 2642;;; faces.el ends here