(vip-add-hook,vip-remove-hook): new functions.
[emacs.git] / lisp / faces.el
blobbf9c33022840f31ac59e02ab238369630e06abbb
1 ;;; faces.el --- Lisp interface to the c "face" structure
3 ;; Copyright (C) 1992, 1993, 1994, 1995 Free Software Foundation, Inc.
5 ;; This file is part of GNU Emacs.
7 ;; GNU Emacs is free software; you can redistribute it and/or modify
8 ;; it under the terms of the GNU General Public License as published by
9 ;; the Free Software Foundation; either version 2, or (at your option)
10 ;; any later version.
12 ;; GNU Emacs is distributed in the hope that it will be useful,
13 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
14 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 ;; GNU General Public License for more details.
17 ;; You should have received a copy of the GNU General Public License
18 ;; along with GNU Emacs; see the file COPYING. If not, write to
19 ;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
21 ;;; Commentary:
23 ;; Mostly derived from Lucid.
25 ;;; Code:
27 (eval-when-compile
28 ;; These used to be defsubsts, now they're subrs. Avoid losing if we're
29 ;; being compiled with an old Emacs that still has defsubrs in it.
30 (put 'face-name 'byte-optimizer nil)
31 (put 'face-id 'byte-optimizer nil)
32 (put 'face-font 'byte-optimizer nil)
33 (put 'face-foreground 'byte-optimizer nil)
34 (put 'face-background 'byte-optimizer nil)
35 (put 'face-stipple 'byte-optimizer nil)
36 (put 'face-underline-p 'byte-optimizer nil)
37 (put 'set-face-font 'byte-optimizer nil)
38 (put 'set-face-foreground 'byte-optimizer nil)
39 (put 'set-face-background 'byte-optimizer nil)
40 (put 'set-face-stipple 'byte-optimizer nil)
41 (put 'set-face-underline-p 'byte-optimizer nil))
43 ;;;; Functions for manipulating face vectors.
45 ;;; A face vector is a vector of the form:
46 ;;; [face NAME ID FONT FOREGROUND BACKGROUND STIPPLE UNDERLINE]
48 ;;; Type checkers.
49 (defsubst internal-facep (x)
50 (and (vectorp x) (= (length x) 8) (eq (aref x 0) 'face)))
52 (defun facep (x)
53 "Return t if X is a face name or an internal face vector."
54 (and (or (internal-facep x)
55 (and (symbolp x) (assq x global-face-data)))
56 t))
58 (defmacro internal-check-face (face)
59 (` (or (internal-facep (, face))
60 (signal 'wrong-type-argument (list 'internal-facep (, face))))))
62 ;;; Accessors.
63 (defun face-name (face)
64 "Return the name of face FACE."
65 (aref (internal-get-face face) 1))
67 (defun face-id (face)
68 "Return the internal ID number of face FACE."
69 (aref (internal-get-face face) 2))
71 (defun face-font (face &optional frame)
72 "Return the font name of face FACE, or nil if it is unspecified.
73 If the optional argument FRAME is given, report on face FACE in that frame.
74 If FRAME is t, report on the defaults for face FACE (for new frames).
75 The font default for a face is either nil, or a list
76 of the form (bold), (italic) or (bold italic).
77 If FRAME is omitted or nil, use the selected frame."
78 (aref (internal-get-face face frame) 3))
80 (defun face-foreground (face &optional frame)
81 "Return the foreground color name of face FACE, or nil if unspecified.
82 If the optional argument FRAME is given, report on face FACE in that frame.
83 If FRAME is t, report on the defaults for face FACE (for new frames).
84 If FRAME is omitted or nil, use the selected frame."
85 (aref (internal-get-face face frame) 4))
87 (defun face-background (face &optional frame)
88 "Return the background color name of face FACE, or nil if unspecified.
89 If the optional argument FRAME is given, report on face FACE in that frame.
90 If FRAME is t, report on the defaults for face FACE (for new frames).
91 If FRAME is omitted or nil, use the selected frame."
92 (aref (internal-get-face face frame) 5))
94 (defun face-stipple (face &optional frame)
95 "Return the stipple pixmap name of face FACE, or nil if unspecified.
96 If the optional argument FRAME is given, report on face FACE in that frame.
97 If FRAME is t, report on the defaults for face FACE (for new frames).
98 If FRAME is omitted or nil, use the selected frame."
99 (aref (internal-get-face face frame) 6))
101 (defalias 'face-background-pixmap 'face-stipple)
103 (defun face-underline-p (face &optional frame)
104 "Return t if face FACE is underlined.
105 If the optional argument FRAME is given, report on face FACE in that frame.
106 If FRAME is t, report on the defaults for face FACE (for new frames).
107 If FRAME is omitted or nil, use the selected frame."
108 (aref (internal-get-face face frame) 7))
111 ;;; Mutators.
113 (defun set-face-font (face font &optional frame)
114 "Change the font of face FACE to FONT (a string).
115 If the optional FRAME argument is provided, change only
116 in that frame; otherwise change each frame."
117 (interactive (internal-face-interactive "font"))
118 (if (stringp font) (setq font (x-resolve-font-name font 'default frame)))
119 (internal-set-face-1 face 'font font 3 frame))
121 (defun set-face-foreground (face color &optional frame)
122 "Change the foreground color of face FACE to COLOR (a string).
123 If the optional FRAME argument is provided, change only
124 in that frame; otherwise change each frame."
125 (interactive (internal-face-interactive "foreground"))
126 (internal-set-face-1 face 'foreground color 4 frame))
128 (defvar face-default-stipple "gray3"
129 "Default stipple pattern used on monochrome displays.
130 This stipple pattern is used on monochrome displays
131 instead of shades of gray for a face background color.
132 See `set-face-stipple' for possible values for this variable.")
134 (defun face-color-gray-p (color &optional frame)
135 "Return t if COLOR is a shade of gray (or white or black).
136 FRAME specifies the frame and thus the display for interpreting COLOR."
137 (let* ((values (x-color-values color frame))
138 (r (nth 0 values))
139 (g (nth 1 values))
140 (b (nth 2 values)))
141 (and (< (abs (- r g)) (/ (max 1 (abs r) (abs g)) 20))
142 (< (abs (- g b)) (/ (max 1 (abs g) (abs b)) 20))
143 (< (abs (- b r)) (/ (max 1 (abs b) (abs r)) 20)))))
145 (defun set-face-background (face color &optional frame)
146 "Change the background color of face FACE to COLOR (a string).
147 If the optional FRAME argument is provided, change only
148 in that frame; otherwise change each frame."
149 (interactive (internal-face-interactive "background"))
150 ;; For a specific frame, use gray stipple instead of gray color
151 ;; if the display does not support a gray color.
152 (if (and frame (not (eq frame t))
153 (not (face-color-supported-p frame color t)))
154 (set-face-stipple face face-default-stipple frame)
155 (if (null frame)
156 (let ((frames (frame-list)))
157 (while frames
158 (set-face-background (face-name face) color (car frames))
159 (setq frames (cdr frames)))
160 (set-face-background face color t)
161 color)
162 (internal-set-face-1 face 'background color 5 frame))))
164 (defun set-face-stipple (face pixmap &optional frame)
165 "Change the stipple pixmap of face FACE to PIXMAP.
166 PIXMAP should be a string, the name of a file of pixmap data.
167 The directories listed in the `x-bitmap-file-path' variable are searched.
169 Alternatively, PIXMAP may be a list of the form (WIDTH HEIGHT DATA)
170 where WIDTH and HEIGHT are the size in pixels,
171 and DATA is a string, containing the raw bits of the bitmap.
173 If the optional FRAME argument is provided, change only
174 in that frame; otherwise change each frame."
175 (interactive (internal-face-interactive "stipple"))
176 (internal-set-face-1 face 'background-pixmap pixmap 6 frame))
178 (defalias 'set-face-background-pixmap 'set-face-stipple)
180 (defun set-face-underline-p (face underline-p &optional frame)
181 "Specify whether face FACE is underlined. (Yes if UNDERLINE-P is non-nil.)
182 If the optional FRAME argument is provided, change only
183 in that frame; otherwise change each frame."
184 (interactive (internal-face-interactive "underline-p" "underlined"))
185 (internal-set-face-1 face 'underline underline-p 7 frame))
187 (defun modify-face-read-string (face default name alist)
188 (let ((value
189 (completing-read
190 (if default
191 (format "Set face %s %s (default %s): "
192 face name (downcase default))
193 (format "Set face %s %s: " face name))
194 alist)))
195 (cond ((equal value "none")
196 nil)
197 ((equal value "")
198 default)
199 (t value))))
201 (defun modify-face (face foreground background stipple
202 bold-p italic-p underline-p)
203 "Change the display attributes for face FACE.
204 FOREGROUND and BACKGROUND should be color strings or nil.
205 STIPPLE should be a stipple pattern name or nil.
206 BOLD-P, ITALIC-P, and UNDERLINE-P specify whether the face should be set bold,
207 in italic, and underlined, respectively. (Yes if non-nil.)
208 If called interactively, prompts for a face and face attributes."
209 (interactive
210 (let* ((completion-ignore-case t)
211 (face (symbol-name (read-face-name "Modify face: ")))
212 (colors (mapcar 'list x-colors))
213 (stipples (mapcar 'list
214 (apply 'nconc
215 (mapcar 'directory-files
216 x-bitmap-file-path))))
217 (foreground (modify-face-read-string
218 face (face-foreground (intern face))
219 "foreground" colors))
220 (background (modify-face-read-string
221 face (face-background (intern face))
222 "background" colors))
223 (stipple (modify-face-read-string
224 face (face-stipple (intern face))
225 "stipple" stipples))
226 (bold-p (y-or-n-p (concat "Set face " face " bold ")))
227 (italic-p (y-or-n-p (concat "Set face " face " italic ")))
228 (underline-p (y-or-n-p (concat "Set face " face " underline "))))
229 (message "Face %s: %s" face
230 (mapconcat 'identity
231 (delq nil
232 (list (and foreground (concat (downcase foreground) " foreground"))
233 (and background (concat (downcase background) " background"))
234 (and stipple (concat (downcase stipple) " stipple"))
235 (and bold-p "bold") (and italic-p "italic")
236 (and underline-p "underline"))) ", "))
237 (list (intern face) foreground background stipple
238 bold-p italic-p underline-p)))
239 (condition-case nil (set-face-foreground face foreground) (error nil))
240 (condition-case nil (set-face-background face background) (error nil))
241 (condition-case nil (set-face-stipple face stipple) (error nil))
242 (funcall (if bold-p 'make-face-bold 'make-face-unbold) face nil t)
243 (funcall (if italic-p 'make-face-italic 'make-face-unitalic) face nil t)
244 (set-face-underline-p face underline-p)
245 (and (interactive-p) (redraw-display)))
247 ;;;; Associating face names (symbols) with their face vectors.
249 (defvar global-face-data nil
250 "Internal data for face support functions. Not for external use.
251 This is an alist associating face names with the default values for
252 their parameters. Newly created frames get their data from here.")
254 (defun face-list ()
255 "Returns a list of all defined face names."
256 (mapcar 'car global-face-data))
258 (defun internal-find-face (name &optional frame)
259 "Retrieve the face named NAME. Return nil if there is no such face.
260 If the optional argument FRAME is given, this gets the face NAME for
261 that frame; otherwise, it uses the selected frame.
262 If FRAME is the symbol t, then the global, non-frame face is returned.
263 If NAME is already a face, it is simply returned."
264 (if (and (eq frame t) (not (symbolp name)))
265 (setq name (face-name name)))
266 (if (symbolp name)
267 (cdr (assq name
268 (if (eq frame t)
269 global-face-data
270 (frame-face-alist (or frame (selected-frame))))))
271 (internal-check-face name)
272 name))
274 (defun internal-get-face (name &optional frame)
275 "Retrieve the face named NAME; error if there is none.
276 If the optional argument FRAME is given, this gets the face NAME for
277 that frame; otherwise, it uses the selected frame.
278 If FRAME is the symbol t, then the global, non-frame face is returned.
279 If NAME is already a face, it is simply returned."
280 (or (internal-find-face name frame)
281 (internal-check-face name)))
284 (defun internal-set-face-1 (face name value index frame)
285 (let ((inhibit-quit t))
286 (if (null frame)
287 (let ((frames (frame-list)))
288 (while frames
289 (internal-set-face-1 (face-name face) name value index (car frames))
290 (setq frames (cdr frames)))
291 (aset (internal-get-face (if (symbolp face) face (face-name face)) t)
292 index value)
293 value)
294 (or (eq frame t)
295 (set-face-attribute-internal (face-id face) name value frame))
296 (aset (internal-get-face face frame) index value))))
299 (defun read-face-name (prompt)
300 (let (face)
301 (while (= (length face) 0)
302 (setq face (completing-read prompt
303 (mapcar '(lambda (x) (list (symbol-name x)))
304 (face-list))
305 nil t)))
306 (intern face)))
308 (defun internal-face-interactive (what &optional bool)
309 (let* ((fn (intern (concat "face-" what)))
310 (prompt (concat "Set " what " of face"))
311 (face (read-face-name (concat prompt ": ")))
312 (default (if (fboundp fn)
313 (or (funcall fn face (selected-frame))
314 (funcall fn 'default (selected-frame)))))
315 (value (if bool
316 (y-or-n-p (concat "Should face " (symbol-name face)
317 " be " bool "? "))
318 (read-string (concat prompt " " (symbol-name face) " to: ")
319 default))))
320 (list face (if (equal value "") nil value))))
324 (defun make-face (name)
325 "Define a new FACE on all frames.
326 You can modify the font, color, etc of this face with the set-face- functions.
327 If the face already exists, it is unmodified."
328 (interactive "SMake face: ")
329 (or (internal-find-face name)
330 (let ((face (make-vector 8 nil)))
331 (aset face 0 'face)
332 (aset face 1 name)
333 (let* ((frames (frame-list))
334 (inhibit-quit t)
335 (id (internal-next-face-id)))
336 (make-face-internal id)
337 (aset face 2 id)
338 (while frames
339 (set-frame-face-alist (car frames)
340 (cons (cons name (copy-sequence face))
341 (frame-face-alist (car frames))))
342 (setq frames (cdr frames)))
343 (setq global-face-data (cons (cons name face) global-face-data)))
344 ;; when making a face after frames already exist
345 (if (eq window-system 'x)
346 (make-face-x-resource-internal face))
347 ;; add to menu
348 (if (fboundp 'facemenu-add-new-face)
349 (facemenu-add-new-face name))
350 face))
351 name)
353 ;; Fill in a face by default based on X resources, for all existing frames.
354 ;; This has to be done when a new face is made.
355 (defun make-face-x-resource-internal (face &optional frame set-anyway)
356 (cond ((null frame)
357 (let ((frames (frame-list)))
358 (while frames
359 (if (eq (framep (car frames)) 'x)
360 (make-face-x-resource-internal (face-name face)
361 (car frames) set-anyway))
362 (setq frames (cdr frames)))))
364 (setq face (internal-get-face (face-name face) frame))
366 ;; These are things like "attributeForeground" instead of simply
367 ;; "foreground" because people tend to do things like "*foreground",
368 ;; which would cause all faces to be fully qualified, making faces
369 ;; inherit attributes in a non-useful way. So we've made them slightly
370 ;; less obvious to specify in order to make them work correctly in
371 ;; more random environments.
373 ;; I think these should be called "face.faceForeground" instead of
374 ;; "face.attributeForeground", but they're the way they are for
375 ;; hysterical reasons.
377 (let* ((name (symbol-name (face-name face)))
378 (fn (or (x-get-resource (concat name ".attributeFont")
379 "Face.AttributeFont")
380 (and set-anyway (face-font face))))
381 (fg (or (x-get-resource (concat name ".attributeForeground")
382 "Face.AttributeForeground")
383 (and set-anyway (face-foreground face))))
384 (bg (or (x-get-resource (concat name ".attributeBackground")
385 "Face.AttributeBackground")
386 (and set-anyway (face-background face))))
387 (bgp (or (x-get-resource (concat name ".attributeStipple")
388 "Face.AttributeStipple")
389 (x-get-resource (concat name ".attributeBackgroundPixmap")
390 "Face.AttributeBackgroundPixmap")
391 (and set-anyway (face-stipple face))))
392 (ulp (let ((resource (x-get-resource
393 (concat name ".attributeUnderline")
394 "Face.AttributeUnderline")))
395 (if resource
396 (member (downcase resource) '("on" "true"))
397 (and set-anyway (face-underline-p face)))))
399 (if fn
400 (condition-case ()
401 (cond ((string= fn "italic")
402 (make-face-italic face))
403 ((string= fn "bold")
404 (make-face-bold face))
405 ((string= fn "bold-italic")
406 (make-face-bold-italic face))
408 (set-face-font face fn frame)))
409 (error
410 (if (member fn '("italic" "bold" "bold-italic"))
411 (message "no %s version found for face `%s'" fn name)
412 (message "font `%s' not found for face `%s'" fn name)))))
413 (if fg
414 (condition-case ()
415 (set-face-foreground face fg frame)
416 (error (message "color `%s' not allocated for face `%s'" fg name))))
417 (if bg
418 (condition-case ()
419 (set-face-background face bg frame)
420 (error (message "color `%s' not allocated for face `%s'" bg name))))
421 (if bgp
422 (condition-case ()
423 (set-face-stipple face bgp frame)
424 (error (message "pixmap `%s' not found for face `%s'" bgp name))))
425 (if (or ulp set-anyway)
426 (set-face-underline-p face ulp frame))
428 face)
430 (defun copy-face (old-face new-face &optional frame new-frame)
431 "Define a face just like OLD-FACE, with name NEW-FACE.
432 If NEW-FACE already exists as a face, it is modified to be like OLD-FACE.
433 If it doesn't already exist, it is created.
435 If the optional argument FRAME is given as a frame,
436 NEW-FACE is changed on FRAME only.
437 If FRAME is t, the frame-independent default specification for OLD-FACE
438 is copied to NEW-FACE.
439 If FRAME is nil, copying is done for the frame-independent defaults
440 and for each existing frame.
441 If the optional fourth argument NEW-FRAME is given,
442 copy the information from face OLD-FACE on frame FRAME
443 to NEW-FACE on frame NEW-FRAME."
444 (or new-frame (setq new-frame frame))
445 (let ((inhibit-quit t))
446 (if (null frame)
447 (let ((frames (frame-list)))
448 (while frames
449 (copy-face old-face new-face (car frames))
450 (setq frames (cdr frames)))
451 (copy-face old-face new-face t))
452 (setq old-face (internal-get-face old-face frame))
453 (setq new-face (or (internal-find-face new-face new-frame)
454 (make-face new-face)))
455 (condition-case nil
456 ;; A face that has a global symbolic font modifier such as `bold'
457 ;; might legitimately get an error here.
458 ;; Use the frame's default font in that case.
459 (set-face-font new-face (face-font old-face frame) new-frame)
460 (error
461 (set-face-font new-face nil new-frame)))
462 (set-face-foreground new-face (face-foreground old-face frame) new-frame)
463 (set-face-background new-face (face-background old-face frame) new-frame)
464 (set-face-stipple new-face
465 (face-stipple old-face frame)
466 new-frame)
467 (set-face-underline-p new-face (face-underline-p old-face frame)
468 new-frame))
469 new-face))
471 (defun face-equal (face1 face2 &optional frame)
472 "True if the faces FACE1 and FACE2 display in the same way."
473 (setq face1 (internal-get-face face1 frame)
474 face2 (internal-get-face face2 frame))
475 (and (equal (face-foreground face1 frame) (face-foreground face2 frame))
476 (equal (face-background face1 frame) (face-background face2 frame))
477 (equal (face-font face1 frame) (face-font face2 frame))
478 (eq (face-underline-p face1 frame) (face-underline-p face2 frame))
479 (equal (face-stipple face1 frame)
480 (face-stipple face2 frame))))
482 (defun face-differs-from-default-p (face &optional frame)
483 "True if face FACE displays differently from the default face, on FRAME.
484 A face is considered to be ``the same'' as the default face if it is
485 actually specified in the same way (equivalent fonts, etc) or if it is
486 fully unspecified, and thus inherits the attributes of any face it
487 is displayed on top of.
489 The optional argument FRAME specifies which frame to test;
490 if FRAME is t, test the default for new frames.
491 If FRAME is nil or omitted, test the selected frame."
492 (let ((default (internal-get-face 'default frame)))
493 (setq face (internal-get-face face frame))
494 (not (and (or (equal (face-foreground default frame)
495 (face-foreground face frame))
496 (null (face-foreground face frame)))
497 (or (equal (face-background default frame)
498 (face-background face frame))
499 (null (face-background face frame)))
500 (or (equal (face-font default frame) (face-font face frame))
501 (null (face-font face frame)))
502 (or (equal (face-stipple default frame)
503 (face-stipple face frame))
504 (null (face-stipple face frame)))
505 (equal (face-underline-p default frame)
506 (face-underline-p face frame))
507 ))))
509 (defun face-nontrivial-p (face &optional frame)
510 "True if face FACE has some non-nil attribute.
511 The optional argument FRAME specifies which frame to test;
512 if FRAME is t, test the default for new frames.
513 If FRAME is nil or omitted, test the selected frame."
514 (setq face (internal-get-face face frame))
515 (or (face-foreground face frame)
516 (face-background face frame)
517 (face-font face frame)
518 (face-stipple face frame)
519 (face-underline-p face frame)))
522 (defun invert-face (face &optional frame)
523 "Swap the foreground and background colors of face FACE.
524 If the face doesn't specify both foreground and background, then
525 set its foreground and background to the default background and foreground."
526 (interactive (list (read-face-name "Invert face: ")))
527 (setq face (internal-get-face face frame))
528 (let ((fg (face-foreground face frame))
529 (bg (face-background face frame)))
530 (if (or fg bg)
531 (progn
532 (set-face-foreground face bg frame)
533 (set-face-background face fg frame))
534 (set-face-foreground face (or (face-background 'default frame)
535 (cdr (assq 'background-color (frame-parameters frame))))
536 frame)
537 (set-face-background face (or (face-foreground 'default frame)
538 (cdr (assq 'foreground-color (frame-parameters frame))))
539 frame)))
540 face)
543 (defun internal-try-face-font (face font &optional frame)
544 "Like set-face-font, but returns nil on failure instead of an error."
545 (condition-case ()
546 (set-face-font face font frame)
547 (error nil)))
549 ;; Manipulating font names.
551 (defconst x-font-regexp nil)
552 (defconst x-font-regexp-head nil)
553 (defconst x-font-regexp-weight nil)
554 (defconst x-font-regexp-slant nil)
556 (defconst x-font-regexp-weight-subnum 1)
557 (defconst x-font-regexp-slant-subnum 2)
558 (defconst x-font-regexp-swidth-subnum 3)
559 (defconst x-font-regexp-adstyle-subnum 4)
561 ;;; Regexps matching font names in "Host Portable Character Representation."
563 (let ((- "[-?]")
564 (foundry "[^-]+")
565 (family "[^-]+")
566 (weight "\\(bold\\|demibold\\|medium\\)") ; 1
567 ; (weight\? "\\(\\*\\|bold\\|demibold\\|medium\\|\\)") ; 1
568 (weight\? "\\([^-]*\\)") ; 1
569 (slant "\\([ior]\\)") ; 2
570 ; (slant\? "\\([ior?*]?\\)") ; 2
571 (slant\? "\\([^-]?\\)") ; 2
572 ; (swidth "\\(\\*\\|normal\\|semicondensed\\|\\)") ; 3
573 (swidth "\\([^-]*\\)") ; 3
574 ; (adstyle "\\(\\*\\|sans\\|\\)") ; 4
575 (adstyle "\\([^-]*\\)") ; 4
576 (pixelsize "[0-9]+")
577 (pointsize "[0-9][0-9]+")
578 (resx "[0-9][0-9]+")
579 (resy "[0-9][0-9]+")
580 (spacing "[cmp?*]")
581 (avgwidth "[0-9]+")
582 (registry "[^-]+")
583 (encoding "[^-]+")
585 (setq x-font-regexp
586 (concat "\\`\\*?[-?*]"
587 foundry - family - weight\? - slant\? - swidth - adstyle -
588 pixelsize - pointsize - resx - resy - spacing - avgwidth -
589 registry - encoding "\\*?\\'"
591 (setq x-font-regexp-head
592 (concat "\\`[-?*]" foundry - family - weight\? - slant\?
593 "\\([-*?]\\|\\'\\)"))
594 (setq x-font-regexp-slant (concat - slant -))
595 (setq x-font-regexp-weight (concat - weight -))
596 nil)
598 (defun x-resolve-font-name (pattern &optional face frame)
599 "Return a font name matching PATTERN.
600 All wildcards in PATTERN become substantiated.
601 If PATTERN is nil, return the name of the frame's base font, which never
602 contains wildcards.
603 Given optional arguments FACE and FRAME, return a font which is
604 also the same size as FACE on FRAME, or fail."
605 (or (symbolp face)
606 (setq face (face-name face)))
607 (and (eq frame t)
608 (setq frame nil))
609 (if pattern
610 ;; Note that x-list-fonts has code to handle a face with nil as its font.
611 (let ((fonts (x-list-fonts pattern face frame)))
612 (or fonts
613 (if face
614 (if (string-match "\\*" pattern)
615 (if (null (face-font face))
616 (error "No matching fonts are the same height as the frame default font")
617 (error "No matching fonts are the same height as face `%s'" face))
618 (if (null (face-font face))
619 (error "Height of font `%s' doesn't match the frame default font"
620 pattern)
621 (error "Height of font `%s' doesn't match face `%s'"
622 pattern face)))
623 (error "No fonts match `%s'" pattern)))
624 (car fonts))
625 (cdr (assq 'font (frame-parameters (selected-frame))))))
627 (defun x-frob-font-weight (font which)
628 (cond ((string-match x-font-regexp font)
629 (concat (substring font 0 (match-beginning x-font-regexp-weight-subnum))
630 which
631 (substring font (match-end x-font-regexp-weight-subnum)
632 (match-beginning x-font-regexp-adstyle-subnum))
633 ;; Replace the ADD_STYLE_NAME field with *
634 ;; because the info in it may not be the same
635 ;; for related fonts.
637 (substring font (match-end x-font-regexp-adstyle-subnum))))
638 ((or (string-match x-font-regexp-head font)
639 (string-match x-font-regexp-weight font))
640 (concat (substring font 0 (match-beginning 1)) which
641 (substring font (match-end 1))))))
643 (defun x-frob-font-slant (font which)
644 (cond ((string-match x-font-regexp font)
645 (concat (substring font 0 (match-beginning x-font-regexp-slant-subnum))
646 which
647 (substring font (match-end x-font-regexp-slant-subnum)
648 (match-beginning x-font-regexp-adstyle-subnum))
649 ;; Replace the ADD_STYLE_NAME field with *
650 ;; because the info in it may not be the same
651 ;; for related fonts.
653 (substring font (match-end x-font-regexp-adstyle-subnum))))
654 ((or (string-match x-font-regexp-head font)
655 (string-match x-font-regexp-slant font))
656 (concat (substring font 0 (match-beginning 1)) which
657 (substring font (match-end 1))))))
659 (defun x-make-font-bold (font)
660 "Given an X font specification, make a bold version of it.
661 If that can't be done, return nil."
662 (x-frob-font-weight font "bold"))
664 (defun x-make-font-demibold (font)
665 "Given an X font specification, make a demibold version of it.
666 If that can't be done, return nil."
667 (x-frob-font-weight font "demibold"))
669 (defun x-make-font-unbold (font)
670 "Given an X font specification, make a non-bold version of it.
671 If that can't be done, return nil."
672 (x-frob-font-weight font "medium"))
674 (defun x-make-font-italic (font)
675 "Given an X font specification, make an italic version of it.
676 If that can't be done, return nil."
677 (x-frob-font-slant font "i"))
679 (defun x-make-font-oblique (font) ; you say tomayto...
680 "Given an X font specification, make an oblique version of it.
681 If that can't be done, return nil."
682 (x-frob-font-slant font "o"))
684 (defun x-make-font-unitalic (font)
685 "Given an X font specification, make a non-italic version of it.
686 If that can't be done, return nil."
687 (x-frob-font-slant font "r"))
689 ;;; non-X-specific interface
691 (defun make-face-bold (face &optional frame noerror)
692 "Make the font of the given face be bold, if possible.
693 If NOERROR is non-nil, return nil on failure."
694 (interactive (list (read-face-name "Make which face bold: ")))
695 (if (and (eq frame t) (listp (face-font face t)))
696 (set-face-font face (if (memq 'italic (face-font face t))
697 '(bold italic) '(bold))
699 (let (font)
700 (if (null frame)
701 (let ((frames (frame-list)))
702 ;; Make this face bold in global-face-data.
703 (make-face-bold face t noerror)
704 ;; Make this face bold in each frame.
705 (while frames
706 (make-face-bold face (car frames) noerror)
707 (setq frames (cdr frames))))
708 (setq face (internal-get-face face frame))
709 (setq font (or (face-font face frame)
710 (face-font face t)))
711 (if (listp font)
712 (setq font nil))
713 (setq font (or font
714 (face-font 'default frame)
715 (cdr (assq 'font (frame-parameters frame)))))
716 (or (and font (make-face-bold-internal face frame font))
717 ;; We failed to find a bold version of the font.
718 noerror
719 (error "No bold version of %S" font))))))
721 (defun make-face-bold-internal (face frame font)
722 (let (f2)
723 (or (and (setq f2 (x-make-font-bold font))
724 (internal-try-face-font face f2 frame))
725 (and (setq f2 (x-make-font-demibold font))
726 (internal-try-face-font face f2 frame)))))
728 (defun make-face-italic (face &optional frame noerror)
729 "Make the font of the given face be italic, if possible.
730 If NOERROR is non-nil, return nil on failure."
731 (interactive (list (read-face-name "Make which face italic: ")))
732 (if (and (eq frame t) (listp (face-font face t)))
733 (set-face-font face (if (memq 'bold (face-font face t))
734 '(bold italic) '(italic))
736 (let (font)
737 (if (null frame)
738 (let ((frames (frame-list)))
739 ;; Make this face italic in global-face-data.
740 (make-face-italic face t noerror)
741 ;; Make this face italic in each frame.
742 (while frames
743 (make-face-italic face (car frames) noerror)
744 (setq frames (cdr frames))))
745 (setq face (internal-get-face face frame))
746 (setq font (or (face-font face frame)
747 (face-font face t)))
748 (if (listp font)
749 (setq font nil))
750 (setq font (or font
751 (face-font 'default frame)
752 (cdr (assq 'font (frame-parameters frame)))))
753 (or (and font (make-face-italic-internal face frame font))
754 ;; We failed to find an italic version of the font.
755 noerror
756 (error "No italic version of %S" font))))))
758 (defun make-face-italic-internal (face frame font)
759 (let (f2)
760 (or (and (setq f2 (x-make-font-italic font))
761 (internal-try-face-font face f2 frame))
762 (and (setq f2 (x-make-font-oblique font))
763 (internal-try-face-font face f2 frame)))))
765 (defun make-face-bold-italic (face &optional frame noerror)
766 "Make the font of the given face be bold and italic, if possible.
767 If NOERROR is non-nil, return nil on failure."
768 (interactive (list (read-face-name "Make which face bold-italic: ")))
769 (if (and (eq frame t) (listp (face-font face t)))
770 (set-face-font face '(bold italic) t)
771 (let (font)
772 (if (null frame)
773 (let ((frames (frame-list)))
774 ;; Make this face bold-italic in global-face-data.
775 (make-face-bold-italic face t noerror)
776 ;; Make this face bold in each frame.
777 (while frames
778 (make-face-bold-italic face (car frames) noerror)
779 (setq frames (cdr frames))))
780 (setq face (internal-get-face face frame))
781 (setq font (or (face-font face frame)
782 (face-font face t)))
783 (if (listp font)
784 (setq font nil))
785 (setq font (or font
786 (face-font 'default frame)
787 (cdr (assq 'font (frame-parameters frame)))))
788 (or (and font (make-face-bold-italic-internal face frame font))
789 ;; We failed to find a bold italic version.
790 noerror
791 (error "No bold italic version of %S" font))))))
793 (defun make-face-bold-italic-internal (face frame font)
794 (let (f2 f3)
795 (or (and (setq f2 (x-make-font-italic font))
796 (not (equal font f2))
797 (setq f3 (x-make-font-bold f2))
798 (not (equal f2 f3))
799 (internal-try-face-font face f3 frame))
800 (and (setq f2 (x-make-font-oblique font))
801 (not (equal font f2))
802 (setq f3 (x-make-font-bold f2))
803 (not (equal f2 f3))
804 (internal-try-face-font face f3 frame))
805 (and (setq f2 (x-make-font-italic font))
806 (not (equal font f2))
807 (setq f3 (x-make-font-demibold f2))
808 (not (equal f2 f3))
809 (internal-try-face-font face f3 frame))
810 (and (setq f2 (x-make-font-oblique font))
811 (not (equal font f2))
812 (setq f3 (x-make-font-demibold f2))
813 (not (equal f2 f3))
814 (internal-try-face-font face f3 frame)))))
816 (defun make-face-unbold (face &optional frame noerror)
817 "Make the font of the given face be non-bold, if possible.
818 If NOERROR is non-nil, return nil on failure."
819 (interactive (list (read-face-name "Make which face non-bold: ")))
820 (if (and (eq frame t) (listp (face-font face t)))
821 (set-face-font face (if (memq 'italic (face-font face t))
822 '(italic) nil)
824 (let (font font1)
825 (if (null frame)
826 (let ((frames (frame-list)))
827 ;; Make this face unbold in global-face-data.
828 (make-face-unbold face t noerror)
829 ;; Make this face unbold in each frame.
830 (while frames
831 (make-face-unbold face (car frames) noerror)
832 (setq frames (cdr frames))))
833 (setq face (internal-get-face face frame))
834 (setq font1 (or (face-font face frame)
835 (face-font face t)))
836 (if (listp font1)
837 (setq font1 nil))
838 (setq font1 (or font1
839 (face-font 'default frame)
840 (cdr (assq 'font (frame-parameters frame)))))
841 (setq font (and font1 (x-make-font-unbold font1)))
842 (or (if font (internal-try-face-font face font frame))
843 noerror
844 (error "No unbold version of %S" font1))))))
846 (defun make-face-unitalic (face &optional frame noerror)
847 "Make the font of the given face be non-italic, if possible.
848 If NOERROR is non-nil, return nil on failure."
849 (interactive (list (read-face-name "Make which face non-italic: ")))
850 (if (and (eq frame t) (listp (face-font face t)))
851 (set-face-font face (if (memq 'bold (face-font face t))
852 '(bold) nil)
854 (let (font font1)
855 (if (null frame)
856 (let ((frames (frame-list)))
857 ;; Make this face unitalic in global-face-data.
858 (make-face-unitalic face t noerror)
859 ;; Make this face unitalic in each frame.
860 (while frames
861 (make-face-unitalic face (car frames) noerror)
862 (setq frames (cdr frames))))
863 (setq face (internal-get-face face frame))
864 (setq font1 (or (face-font face frame)
865 (face-font face t)))
866 (if (listp font1)
867 (setq font1 nil))
868 (setq font1 (or font1
869 (face-font 'default frame)
870 (cdr (assq 'font (frame-parameters frame)))))
871 (setq font (and font1 (x-make-font-unitalic font1)))
872 (or (if font (internal-try-face-font face font frame))
873 noerror
874 (error "No unitalic version of %S" font1))))))
876 (defvar list-faces-sample-text
877 "abcdefghijklmnopqrstuvwxyz ABCDEFGHIJKLMNOPQRSTUVWXYZ"
878 "*Text string to display as the sample text for `list-faces-display'.")
880 ;; The name list-faces would be more consistent, but let's avoid a conflict
881 ;; with Lucid, which uses that name differently.
882 (defun list-faces-display ()
883 "List all faces, using the same sample text in each.
884 The sample text is a string that comes from the variable
885 `list-faces-sample-text'.
887 It is possible to give a particular face name different appearances in
888 different frames. This command shows the appearance in the
889 selected frame."
890 (interactive)
891 (let ((faces (sort (face-list) (function string-lessp)))
892 (face nil)
893 (frame (selected-frame))
894 disp-frame window)
895 (with-output-to-temp-buffer "*Faces*"
896 (save-excursion
897 (set-buffer standard-output)
898 (setq truncate-lines t)
899 (while faces
900 (setq face (car faces))
901 (setq faces (cdr faces))
902 (insert (format "%25s " (symbol-name face)))
903 (let ((beg (point)))
904 (insert list-faces-sample-text)
905 (insert "\n")
906 (put-text-property beg (1- (point)) 'face face)
907 ;; If the sample text has multiple lines, line up all of them.
908 (goto-char beg)
909 (forward-line 1)
910 (while (not (eobp))
911 (insert " ")
912 (forward-line 1))))
913 (goto-char (point-min))))
914 ;; If the *Faces* buffer appears in a different frame,
915 ;; copy all the face definitions from FRAME,
916 ;; so that the display will reflect the frame that was selected.
917 (setq window (get-buffer-window (get-buffer "*Faces*") t))
918 (setq disp-frame (if window (window-frame window)
919 (car (frame-list))))
920 (or (eq frame disp-frame)
921 (let ((faces (face-list)))
922 (while faces
923 (copy-face (car faces) (car faces) frame disp-frame)
924 (setq faces (cdr faces)))))))
926 (defun describe-face (face)
927 "Display the properties of face FACE."
928 (interactive (list (read-face-name "Describe face: ")))
929 (with-output-to-temp-buffer "*Help*"
930 (princ "Properties of face `")
931 (princ (face-name face))
932 (princ "':") (terpri)
933 (princ "Foreground: ") (princ (face-foreground face)) (terpri)
934 (princ "Background: ") (princ (face-background face)) (terpri)
935 (princ " Font: ") (princ (face-font face)) (terpri)
936 (princ "Underlined: ") (princ (if (face-underline-p face) "yes" "no")) (terpri)
937 (princ " Stipple: ") (princ (or (face-stipple face) "none"))))
939 ;;; Make the standard faces.
940 ;;; The C code knows the default and modeline faces as faces 0 and 1,
941 ;;; so they must be the first two faces made.
942 (defun face-initialize ()
943 (make-face 'default)
944 (make-face 'modeline)
945 (make-face 'highlight)
947 ;; These aren't really special in any way, but they're nice to have around.
949 (make-face 'bold)
950 (make-face 'italic)
951 (make-face 'bold-italic)
952 (make-face 'region)
953 (make-face 'secondary-selection)
954 (make-face 'underline)
956 (setq region-face (face-id 'region))
958 ;; Specify the global properties of these faces
959 ;; so they will come out right on new frames.
961 (make-face-bold 'bold t)
962 (make-face-italic 'italic t)
963 (make-face-bold-italic 'bold-italic t)
965 (set-face-background 'highlight '("darkseagreen2" "green" t) t)
966 (set-face-background 'region '("gray" underline) t)
967 (set-face-background 'secondary-selection '("paleturquoise" "green" t) t)
968 (set-face-background 'modeline '(t) t)
969 (set-face-underline-p 'underline t t)
971 ;; Set up the faces of all existing X Window frames
972 ;; from those global properties, unless already set in a given frame.
974 (let ((frames (frame-list)))
975 (while frames
976 (if (not (memq (framep (car frames)) '(t nil)))
977 (let ((frame (car frames))
978 (rest global-face-data))
979 (while rest
980 (let ((face (car (car rest))))
981 (or (face-differs-from-default-p face)
982 (face-fill-in face (cdr (car rest)) frame)))
983 (setq rest (cdr rest)))))
984 (setq frames (cdr frames)))))
987 ;; Like x-create-frame but also set up the faces.
989 (defun x-create-frame-with-faces (&optional parameters)
990 ;; Read this frame's geometry resource, if it has an explicit name,
991 ;; and put the specs into PARAMETERS.
992 (let* ((name (or (cdr (assq 'name parameters))
993 (cdr (assq 'name default-frame-alist))))
994 (x-resource-name name)
995 (res-geometry (if name (x-get-resource "geometry" "Geometry")))
996 parsed)
997 (if res-geometry
998 (progn
999 (setq parsed (x-parse-geometry res-geometry))
1000 ;; If the resource specifies a position,
1001 ;; call the position and size "user-specified".
1002 (if (or (assq 'top parsed) (assq 'left parsed))
1003 (setq parsed (cons '(user-position . t)
1004 (cons '(user-size . t) parsed))))
1005 ;; Put the geometry parameters at the end.
1006 ;; Copy default-frame-alist so that they go after it.
1007 (setq parameters (append parameters
1008 default-frame-alist
1009 parsed)))))
1010 (let (frame)
1011 (if (null global-face-data)
1012 (setq frame (x-create-frame parameters))
1013 (let* ((visibility-spec (assq 'visibility parameters))
1014 (faces (copy-alist global-face-data))
1015 success
1016 (rest faces))
1017 (setq frame (x-create-frame (cons '(visibility . nil) parameters)))
1018 (unwind-protect
1019 (progn
1020 (set-frame-face-alist frame faces)
1022 (if (cdr (or (assq 'reverse parameters)
1023 (assq 'reverse default-frame-alist)
1024 (let ((resource (x-get-resource "reverseVideo"
1025 "ReverseVideo")))
1026 (if resource
1027 (cons nil (member (downcase resource)
1028 '("on" "true")))))))
1029 (let* ((params (frame-parameters frame))
1030 (bg (cdr (assq 'foreground-color params)))
1031 (fg (cdr (assq 'background-color params))))
1032 (modify-frame-parameters frame
1033 (list (cons 'foreground-color fg)
1034 (cons 'background-color bg)))
1035 (if (equal bg (cdr (assq 'border-color params)))
1036 (modify-frame-parameters frame
1037 (list (cons 'border-color fg))))
1038 (if (equal bg (cdr (assq 'mouse-color params)))
1039 (modify-frame-parameters frame
1040 (list (cons 'mouse-color fg))))
1041 (if (equal bg (cdr (assq 'cursor-color params)))
1042 (modify-frame-parameters frame
1043 (list (cons 'cursor-color fg))))))
1044 ;; Copy the vectors that represent the faces.
1045 ;; Also fill them in from X resources.
1046 (while rest
1047 (let ((global (cdr (car rest))))
1048 (setcdr (car rest) (vector 'face
1049 (face-name (cdr (car rest)))
1050 (face-id (cdr (car rest)))
1051 nil nil nil nil nil))
1052 (face-fill-in (car (car rest)) global frame))
1053 (make-face-x-resource-internal (cdr (car rest)) frame t)
1054 (setq rest (cdr rest)))
1055 (if (null visibility-spec)
1056 (make-frame-visible frame)
1057 (modify-frame-parameters frame (list visibility-spec)))
1058 (setq success t))
1059 (or success
1060 (delete-frame frame)))))
1061 ;; Set up the background-mode frame parameter
1062 ;; so that programs can decide good ways of highlighting
1063 ;; on this frame.
1064 (let ((bg-resource (x-get-resource ".backgroundMode"
1065 "BackgroundMode"))
1066 (params (frame-parameters frame))
1067 (bg-mode))
1068 (setq bg-mode
1069 (cond (bg-resource (intern (downcase bg-resource)))
1070 ((< (apply '+ (x-color-values
1071 (cdr (assq 'background-color params))
1072 frame))
1073 (/ (apply '+ (x-color-values "white" frame)) 3))
1074 'dark)
1075 (t 'light)))
1076 (modify-frame-parameters frame
1077 (list (cons 'background-mode bg-mode)
1078 (cons 'display-type
1079 (cond ((x-display-color-p frame)
1080 'color)
1081 ((x-display-grayscale-p frame)
1082 'grayscale)
1083 (t 'mono))))))
1084 frame))
1086 ;; Update a frame's faces when we change its default font.
1087 (defun frame-update-faces (frame)
1088 (let* ((faces global-face-data)
1089 (rest faces))
1090 (while rest
1091 (let* ((face (car (car rest)))
1092 (font (face-font face t)))
1093 (if (listp font)
1094 (let ((bold (memq 'bold font))
1095 (italic (memq 'italic font)))
1096 ;; Ignore any previous (string-valued) font, it might not even
1097 ;; be the right size anymore.
1098 (set-face-font face nil frame)
1099 (cond ((and bold italic)
1100 (make-face-bold-italic face frame t))
1101 (bold
1102 (make-face-bold face frame t))
1103 (italic
1104 (make-face-italic face frame t)))))
1105 (setq rest (cdr rest)))
1106 frame)))
1108 ;; Update the colors of FACE, after FRAME's own colors have been changed.
1109 ;; This applies only to faces with global color specifications
1110 ;; that are not simple constants.
1111 (defun frame-update-face-colors (frame)
1112 (let ((faces global-face-data))
1113 (while faces
1114 (condition-case nil
1115 (let* ((data (cdr (car faces)))
1116 (face (car (car faces)))
1117 (foreground (face-foreground data))
1118 (background (face-background data)))
1119 ;; If the global spec is a specific color,
1120 ;; which doesn't depend on the frame's attributes,
1121 ;; we don't need to recalculate it now.
1122 (or (listp foreground)
1123 (setq foreground nil))
1124 (or (listp background)
1125 (setq background nil))
1126 ;; If we are going to frob this face at all,
1127 ;; reinitialize it first.
1128 (if (or foreground background)
1129 (progn (set-face-foreground face nil frame)
1130 (set-face-background face nil frame)))
1131 (if foreground
1132 (face-try-color-list 'set-face-foreground
1133 face foreground frame))
1134 (if background
1135 (face-try-color-list 'set-face-background
1136 face background frame)))
1137 (error nil))
1138 (setq faces (cdr faces)))))
1140 ;; Fill in the face FACE from frame-independent face data DATA.
1141 ;; DATA should be the non-frame-specific ("global") face vector
1142 ;; for the face. FACE should be a face name or face object.
1143 ;; FRAME is the frame to act on; it must be an actual frame, not nil or t.
1144 (defun face-fill-in (face data frame)
1145 (condition-case nil
1146 (let ((foreground (face-foreground data))
1147 (background (face-background data))
1148 (font (face-font data))
1149 (stipple (face-stipple data)))
1150 (set-face-underline-p face (face-underline-p data) frame)
1151 (if foreground
1152 (face-try-color-list 'set-face-foreground
1153 face foreground frame))
1154 (if background
1155 (face-try-color-list 'set-face-background
1156 face background frame))
1157 (if (listp font)
1158 (let ((bold (memq 'bold font))
1159 (italic (memq 'italic font)))
1160 (cond ((and bold italic)
1161 (make-face-bold-italic face frame))
1162 (bold
1163 (make-face-bold face frame))
1164 (italic
1165 (make-face-italic face frame))))
1166 (if font
1167 (set-face-font face font frame)))
1168 (if stipple
1169 (set-face-stipple face stipple frame)))
1170 (error nil)))
1172 ;; Assuming COLOR is a valid color name,
1173 ;; return t if it can be displayed on FRAME.
1174 (defun face-color-supported-p (frame color background-p)
1175 (or (x-display-color-p frame)
1176 ;; A black-and-white display can implement these.
1177 (member color '("black" "white"))
1178 ;; A black-and-white display can fake gray for background.
1179 (and background-p
1180 (face-color-gray-p color frame))
1181 ;; A grayscale display can implement colors that are gray (more or less).
1182 (and (x-display-grayscale-p frame)
1183 (face-color-gray-p color frame))))
1185 ;; Use FUNCTION to store a color in FACE on FRAME.
1186 ;; COLORS is either a single color or a list of colors.
1187 ;; If it is a list, try the colors one by one until one of them
1188 ;; succeeds. We signal an error only if all the colors failed.
1189 ;; t as COLORS or as an element of COLORS means to invert the face.
1190 ;; That can't fail, so any subsequent elements after the t are ignored.
1191 (defun face-try-color-list (function face colors frame)
1192 (if (stringp colors)
1193 (if (face-color-supported-p frame colors
1194 (eq function 'set-face-background))
1195 (funcall function face colors frame))
1196 (if (eq colors t)
1197 (invert-face face frame)
1198 (let (done)
1199 (while (and colors (not done))
1200 (if (or (memq (car colors) '(t underline))
1201 (face-color-supported-p frame (car colors)
1202 (eq function 'set-face-background)))
1203 (if (cdr colors)
1204 ;; If there are more colors to try, catch errors
1205 ;; and set `done' if we succeed.
1206 (condition-case nil
1207 (progn
1208 (cond ((eq (car colors) t)
1209 (invert-face face frame))
1210 ((eq (car colors) 'underline)
1211 (set-face-underline-p face t frame))
1213 (funcall function face (car colors) frame)))
1214 (setq done t))
1215 (error nil))
1216 ;; If this is the last color, let the error get out if it fails.
1217 ;; If it succeeds, we will exit anyway after this iteration.
1218 (cond ((eq (car colors) t)
1219 (invert-face face frame))
1220 ((eq (car colors) 'underline)
1221 (set-face-underline-p face t frame))
1223 (funcall function face (car colors) frame)))))
1224 (setq colors (cdr colors)))))))
1226 ;; If we are already using x-window frames, initialize faces for them.
1227 (if (eq (framep (selected-frame)) 'x)
1228 (face-initialize))
1230 (provide 'faces)
1232 ;;; faces.el ends here