faces.el 37.5 KB
Newer Older
Eric S. Raymond's avatar
Eric S. Raymond committed
1 2
;;; faces.el --- Lisp interface to the c "face" structure

3
;; Copyright (C) 1992, 1993, 1994 Free Software Foundation, Inc.
Eric S. Raymond's avatar
Eric S. Raymond committed
4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26

;; This file is part of GNU Emacs.

;; GNU Emacs is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation; either version 2, or (at your option)
;; any later version.

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs; see the file COPYING.  If not, write to
;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.

;;; Commentary:

;; Mostly derived from Lucid.

;;; Code:

27 28 29 30

;;;; Functions for manipulating face vectors.

;;; A face vector is a vector of the form:
31
;;;    [face NAME ID FONT FOREGROUND BACKGROUND STIPPLE UNDERLINE]
32 33

;;; Type checkers.
Eric S. Raymond's avatar
Eric S. Raymond committed
34 35 36 37 38 39 40
(defsubst internal-facep (x)
  (and (vectorp x) (= (length x) 8) (eq (aref x 0) 'face)))

(defmacro internal-check-face (face)
  (` (while (not (internal-facep (, face)))
       (setq (, face) (signal 'wrong-type-argument (list 'internal-facep (, face)))))))

41
;;; Accessors.
Eric S. Raymond's avatar
Eric S. Raymond committed
42 43 44 45 46 47 48 49 50 51 52
(defsubst face-name (face)
  "Return the name of face FACE."
  (aref (internal-get-face face) 1))

(defsubst face-id (face)
  "Return the internal ID number of face FACE."
  (aref (internal-get-face face) 2))

(defsubst face-font (face &optional frame)
  "Return the font name of face FACE, or nil if it is unspecified.
If the optional argument FRAME is given, report on face FACE in that frame.
53 54 55 56
If FRAME is t, report on the defaults for face FACE (for new frames).
  The font default for a face is either nil, or a list
  of the form (bold), (italic) or (bold italic).
If FRAME is omitted or nil, use the selected frame."
Eric S. Raymond's avatar
Eric S. Raymond committed
57 58 59 60 61
  (aref (internal-get-face face frame) 3))

(defsubst face-foreground (face &optional frame)
  "Return the foreground color name of face FACE, or nil if unspecified.
If the optional argument FRAME is given, report on face FACE in that frame.
62 63
If FRAME is t, report on the defaults for face FACE (for new frames).
If FRAME is omitted or nil, use the selected frame."
Eric S. Raymond's avatar
Eric S. Raymond committed
64 65 66 67 68
  (aref (internal-get-face face frame) 4))

(defsubst face-background (face &optional frame)
  "Return the background color name of face FACE, or nil if unspecified.
If the optional argument FRAME is given, report on face FACE in that frame.
69 70
If FRAME is t, report on the defaults for face FACE (for new frames).
If FRAME is omitted or nil, use the selected frame."
Eric S. Raymond's avatar
Eric S. Raymond committed
71 72
  (aref (internal-get-face face frame) 5))

73 74 75 76 77 78 79 80
(defsubst face-stipple (face &optional frame)
 "Return the stipple pixmap name of face FACE, or nil if unspecified.
If the optional argument FRAME is given, report on face FACE in that frame.
If FRAME is t, report on the defaults for face FACE (for new frames).
If FRAME is omitted or nil, use the selected frame."
 (aref (internal-get-face face frame) 6))

(defalias 'face-background-pixmap 'face-stipple)
Eric S. Raymond's avatar
Eric S. Raymond committed
81 82 83 84

(defsubst face-underline-p (face &optional frame)
 "Return t if face FACE is underlined.
If the optional argument FRAME is given, report on face FACE in that frame.
85 86
If FRAME is t, report on the defaults for face FACE (for new frames).
If FRAME is omitted or nil, use the selected frame."
Eric S. Raymond's avatar
Eric S. Raymond committed
87 88
 (aref (internal-get-face face frame) 7))

89 90

;;; Mutators.
Eric S. Raymond's avatar
Eric S. Raymond committed
91 92 93 94 95 96

(defsubst set-face-font (face font &optional frame)
  "Change the font of face FACE to FONT (a string).
If the optional FRAME argument is provided, change only
in that frame; otherwise change each frame."
  (interactive (internal-face-interactive "font"))
97 98
  (if (stringp font) (setq font (x-resolve-font-name font face frame)))
  (internal-set-face-1 face 'font font 3 frame))
Eric S. Raymond's avatar
Eric S. Raymond committed
99 100 101 102 103 104

(defsubst set-face-foreground (face color &optional frame)
  "Change the foreground color of face FACE to COLOR (a string).
If the optional FRAME argument is provided, change only
in that frame; otherwise change each frame."
  (interactive (internal-face-interactive "foreground"))
105
  (internal-set-face-1 face 'foreground color 4 frame))
Eric S. Raymond's avatar
Eric S. Raymond committed
106 107 108 109 110 111

(defsubst set-face-background (face color &optional frame)
  "Change the background color of face FACE to COLOR (a string).
If the optional FRAME argument is provided, change only
in that frame; otherwise change each frame."
  (interactive (internal-face-interactive "background"))
112 113 114 115
  (if (and frame (member color '("gray" "gray1" "gray3"))
	   (not (x-display-color-p frame))
	   (not (x-display-grayscale-p frame)))
      (set-face-stipple face color frame))
116
  (internal-set-face-1 face 'background color 5 frame))
Eric S. Raymond's avatar
Eric S. Raymond committed
117

118 119 120 121
(defsubst set-face-stipple (face name &optional frame)
  "Change the stipple pixmap of face FACE to PIXMAP.
PIXMAP should be a string, the name of a file of pixmap data.
The directories listed in the `x-bitmap-file-path' variable are searched.
Eric S. Raymond's avatar
Eric S. Raymond committed
122

123 124 125
Alternatively, PIXMAP may be a list of the form (WIDTH HEIGHT DATA)
where WIDTH and HEIGHT are the size in pixels,
and DATA is a string, containing the raw bits of the bitmap.  
Eric S. Raymond's avatar
Eric S. Raymond committed
126

127 128 129 130 131 132
If the optional FRAME argument is provided, change only
in that frame; otherwise change each frame."
  (interactive (internal-face-interactive "stipple"))
  (internal-set-face-1 face 'background-pixmap name 6 frame))

(defalias 'set-face-background-pixmap 'set-face-stipple)
Eric S. Raymond's avatar
Eric S. Raymond committed
133 134 135 136 137 138

(defsubst set-face-underline-p (face underline-p &optional frame)
  "Specify whether face FACE is underlined.  (Yes if UNDERLINE-P is non-nil.)
If the optional FRAME argument is provided, change only
in that frame; otherwise change each frame."
  (interactive (internal-face-interactive "underline-p" "underlined"))
139
  (internal-set-face-1 face 'underline underline-p 7 frame))
140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178

(defun modify-face (face foreground background bold-p italic-p underline-p)
  "Change the display attributes for face FACE.
FOREGROUND and BACKGROUND should be color strings.  (Default color if nil.)
BOLD-P, ITALIC-P, and UNDERLINE-P specify whether the face should be set bold,
in italic, and underlined, respectively.  (Yes if non-nil.)
If called interactively, prompts for a face and face attributes."
  (interactive
   (let* ((completion-ignore-case t)
	  (face		(symbol-name (read-face-name "Face: ")))
	  (foreground	(completing-read
			 (format "Face %s set foreground (default %s): " face
				 (downcase (or (face-foreground (intern face))
					       "foreground")))
			 (mapcar 'list (x-defined-colors))))
	  (background	(completing-read
			 (format "Face %s set background (default %s): " face
				 (downcase (or (face-background (intern face))
					       "background")))
			 (mapcar 'list (x-defined-colors))))
	  (bold-p	(y-or-n-p (concat "Face " face ": set bold ")))
	  (italic-p	(y-or-n-p (concat "Face " face ": set italic ")))
	  (underline-p	(y-or-n-p (concat "Face " face ": set underline "))))
     (if (string-equal background "") (setq background nil))
     (if (string-equal foreground "") (setq foreground nil))
     (message "Face %s: %s" face
      (mapconcat 'identity
       (delq nil
	(list (and foreground (concat (downcase foreground) " foreground"))
	      (and background (concat (downcase background) " background"))
	      (and bold-p "bold") (and italic-p "italic")
	      (and underline-p "underline"))) ", "))
     (list (intern face) foreground background bold-p italic-p underline-p)))
  (condition-case nil (set-face-foreground face foreground) (error nil))
  (condition-case nil (set-face-background face background) (error nil))
  (funcall (if bold-p 'make-face-bold 'make-face-unbold) face nil t)
  (funcall (if italic-p 'make-face-italic 'make-face-unitalic) face nil t)
  (set-face-underline-p face underline-p)
  (and (interactive-p) (redraw-display)))
179 180 181

;;;; Associating face names (symbols) with their face vectors.

182 183 184 185 186
(defvar global-face-data nil
  "Internal data for face support functions.  Not for external use.
This is an alist associating face names with the default values for
their parameters.  Newly created frames get their data from here.")

187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255
(defun face-list ()
  "Returns a list of all defined face names."
  (mapcar 'car global-face-data))

(defun internal-find-face (name &optional frame)
  "Retrieve the face named NAME.  Return nil if there is no such face.
If the optional argument FRAME is given, this gets the face NAME for
that frame; otherwise, it uses the selected frame.
If FRAME is the symbol t, then the global, non-frame face is returned.
If NAME is already a face, it is simply returned."
  (if (and (eq frame t) (not (symbolp name)))
      (setq name (face-name name)))
  (if (symbolp name)
      (cdr (assq name
		 (if (eq frame t)
		     global-face-data
		   (frame-face-alist (or frame (selected-frame))))))
    (internal-check-face name)
    name))

(defun internal-get-face (name &optional frame)
  "Retrieve the face named NAME; error if there is none.
If the optional argument FRAME is given, this gets the face NAME for
that frame; otherwise, it uses the selected frame.
If FRAME is the symbol t, then the global, non-frame face is returned.
If NAME is already a face, it is simply returned."
  (or (internal-find-face name frame)
      (internal-check-face name)))


(defun internal-set-face-1 (face name value index frame)
  (let ((inhibit-quit t))
    (if (null frame)
	(let ((frames (frame-list)))
	  (while frames
	    (internal-set-face-1 (face-name face) name value index (car frames))
	    (setq frames (cdr frames)))
	  (aset (internal-get-face (if (symbolp face) face (face-name face)) t)
		index value)
	  value)
      (or (eq frame t)
	  (set-face-attribute-internal (face-id face) name value frame))
      (aset (internal-get-face face frame) index value))))


(defun read-face-name (prompt)
  (let (face)
    (while (= (length face) 0)
      (setq face (completing-read prompt
				  (mapcar '(lambda (x) (list (symbol-name x)))
					  (face-list))
				  nil t)))
    (intern face)))

(defun internal-face-interactive (what &optional bool)
  (let* ((fn (intern (concat "face-" what)))
	 (prompt (concat "Set " what " of face"))
	 (face (read-face-name (concat prompt ": ")))
	 (default (if (fboundp fn)
		      (or (funcall fn face (selected-frame))
			  (funcall fn 'default (selected-frame)))))
	 (value (if bool
		    (y-or-n-p (concat "Should face " (symbol-name face)
				      " be " bool "? "))
		  (read-string (concat prompt " " (symbol-name face) " to: ")
			       default))))
    (list face (if (equal value "") nil value))))


Eric S. Raymond's avatar
Eric S. Raymond committed
256 257 258 259 260

(defun make-face (name)
  "Define a new FACE on all frames.  
You can modify the font, color, etc of this face with the set-face- functions.
If the face already exists, it is unmodified."
261
  (interactive "SMake face: ")
Eric S. Raymond's avatar
Eric S. Raymond committed
262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279
  (or (internal-find-face name)
      (let ((face (make-vector 8 nil)))
	(aset face 0 'face)
	(aset face 1 name)
	(let* ((frames (frame-list))
	       (inhibit-quit t)
	       (id (internal-next-face-id)))
	  (make-face-internal id)
	  (aset face 2 id)
	  (while frames
	    (set-frame-face-alist (car frames)
				  (cons (cons name (copy-sequence face))
					(frame-face-alist (car frames))))
	    (setq frames (cdr frames)))
	  (setq global-face-data (cons (cons name face) global-face-data)))
	;; when making a face after frames already exist
	(if (eq window-system 'x)
	    (make-face-x-resource-internal face))
280 281 282
	;; add to menu
	(if (fboundp 'facemenu-add-new-face)
	    (facemenu-add-new-face name))
283 284
	face))
  name)
Eric S. Raymond's avatar
Eric S. Raymond committed
285 286 287 288 289 290 291

;; Fill in a face by default based on X resources, for all existing frames.
;; This has to be done when a new face is made.
(defun make-face-x-resource-internal (face &optional frame set-anyway)
  (cond ((null frame)
	 (let ((frames (frame-list)))
	   (while frames
292 293 294
	     (if (eq (framep (car frames)) 'x)
		 (make-face-x-resource-internal (face-name face)
						(car frames) set-anyway))
Eric S. Raymond's avatar
Eric S. Raymond committed
295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319
	     (setq frames (cdr frames)))))
	(t
	 (setq face (internal-get-face (face-name face) frame))
	 ;;
	 ;; These are things like "attributeForeground" instead of simply
	 ;; "foreground" because people tend to do things like "*foreground",
	 ;; which would cause all faces to be fully qualified, making faces
	 ;; inherit attributes in a non-useful way.  So we've made them slightly
	 ;; less obvious to specify in order to make them work correctly in
	 ;; more random environments.
	 ;;
	 ;; I think these should be called "face.faceForeground" instead of
	 ;; "face.attributeForeground", but they're the way they are for
	 ;; hysterical reasons.
	 ;; 
	 (let* ((name (symbol-name (face-name face)))
		(fn  (or (x-get-resource (concat name ".attributeFont")
					 "Face.AttributeFont")
			 (and set-anyway (face-font face))))
		(fg  (or (x-get-resource (concat name ".attributeForeground")
					 "Face.AttributeForeground")
			 (and set-anyway (face-foreground face))))
		(bg  (or (x-get-resource (concat name ".attributeBackground")
					 "Face.AttributeBackground")
			 (and set-anyway (face-background face))))
320 321 322 323 324
		(bgp (or (x-get-resource (concat name ".attributeStipple")
					 "Face.AttributeStipple")
			 (x-get-resource (concat name ".attributeBackgroundPixmap")
					 "Face.AttributeBackgroundPixmap")
			 (and set-anyway (face-stipple face))))
325 326 327 328 329 330
		(ulp (let ((resource (x-get-resource
				      (concat name ".attributeUnderline")
				      "Face.AttributeUnderline")))
		       (if resource
			   (member (downcase resource) '("on" "true"))
			 (and set-anyway (face-underline-p face)))))
Eric S. Raymond's avatar
Eric S. Raymond committed
331 332 333 334 335 336 337 338 339 340 341 342 343
		)
	   (if fn
	       (condition-case ()
		   (set-face-font face fn frame)
		 (error (message "font `%s' not found for face `%s'" fn name))))
	   (if fg
	       (condition-case ()
		   (set-face-foreground face fg frame)
		 (error (message "color `%s' not allocated for face `%s'" fg name))))
	   (if bg
	       (condition-case ()
		   (set-face-background face bg frame)
		 (error (message "color `%s' not allocated for face `%s'" bg name))))
344 345 346 347
	   (if bgp
	       (condition-case ()
		   (set-face-stipple face bgp frame)
		 (error (message "pixmap `%s' not found for face `%s'" bgp name))))
Eric S. Raymond's avatar
Eric S. Raymond committed
348 349 350 351 352
	   (if (or ulp set-anyway)
	       (set-face-underline-p face ulp frame))
	   )))
  face)

Richard M. Stallman's avatar
Richard M. Stallman committed
353 354 355 356 357 358 359 360 361 362 363
(defun copy-face (old-face new-face &optional frame new-frame)
  "Define a face just like OLD-FACE, with name NEW-FACE.
If NEW-FACE already exists as a face, it is modified to be like OLD-FACE.
If it doesn't already exist, it is created.

If the optional argument FRAME is given as a frame,
NEW-FACE is changed on FRAME only.
If FRAME is t, the frame-independent default specification for OLD-FACE
is copied to NEW-FACE.
If FRAME is nil, copying is done for the frame-independent defaults
and for each existing frame.
364 365
If the optional fourth argument NEW-FRAME is given, 
copy the information from face OLD-FACE on frame FRAME
Richard M. Stallman's avatar
Richard M. Stallman committed
366
to NEW-FACE on frame NEW-FRAME."
367
  (or new-frame (setq new-frame frame))
368
  (let ((inhibit-quit t))
Eric S. Raymond's avatar
Eric S. Raymond committed
369 370 371
    (if (null frame)
	(let ((frames (frame-list)))
	  (while frames
Richard M. Stallman's avatar
Richard M. Stallman committed
372
	    (copy-face old-face new-face (car frames))
Eric S. Raymond's avatar
Eric S. Raymond committed
373
	    (setq frames (cdr frames)))
Richard M. Stallman's avatar
Richard M. Stallman committed
374
	  (copy-face old-face new-face t))
375 376 377
      (setq old-face (internal-get-face old-face frame))
      (setq new-face (or (internal-find-face new-face new-frame)
			 (make-face new-face)))
378 379 380 381 382 383 384
      (condition-case nil
	  ;; A face that has a global symbolic font modifier such as `bold'
	  ;; might legitimately get an error here.
	  ;; Use the frame's default font in that case.
	  (set-face-font new-face (face-font old-face frame) new-frame)
	(error
	 (set-face-font new-face nil new-frame)))
385 386
      (set-face-foreground new-face (face-foreground old-face frame) new-frame)
      (set-face-background new-face (face-background old-face frame) new-frame)
387 388 389
      (set-face-stipple new-face
			(face-stipple old-face frame)
			new-frame)
Eric S. Raymond's avatar
Eric S. Raymond committed
390
      (set-face-underline-p new-face (face-underline-p old-face frame)
391
			    new-frame))
Eric S. Raymond's avatar
Eric S. Raymond committed
392 393 394
    new-face))

(defun face-equal (face1 face2 &optional frame)
395
  "True if the faces FACE1 and FACE2 display in the same way."
Eric S. Raymond's avatar
Eric S. Raymond committed
396 397 398 399 400
  (setq face1 (internal-get-face face1 frame)
	face2 (internal-get-face face2 frame))
  (and (equal (face-foreground face1 frame) (face-foreground face2 frame))
       (equal (face-background face1 frame) (face-background face2 frame))
       (equal (face-font face1 frame) (face-font face2 frame))
401
       (eq (face-underline-p face1 frame) (face-underline-p face2 frame))
402 403
       (equal (face-stipple face1 frame)
	      (face-stipple face2 frame))))
Eric S. Raymond's avatar
Eric S. Raymond committed
404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420

(defun face-differs-from-default-p (face &optional frame)
  "True if face FACE displays differently from the default face, on FRAME.
A face is considered to be ``the same'' as the default face if it is 
actually specified in the same way (equivalent fonts, etc) or if it is 
fully unspecified, and thus inherits the attributes of any face it 
is displayed on top of."
  (let ((default (internal-get-face 'default frame)))
    (setq face (internal-get-face face frame))
    (not (and (or (equal (face-foreground default frame)
			 (face-foreground face frame))
		  (null (face-foreground face frame)))
	      (or (equal (face-background default frame)
			 (face-background face frame))
		  (null (face-background face frame)))
	      (or (equal (face-font default frame) (face-font face frame))
		  (null (face-font face frame)))
421 422 423
	      (or (equal (face-stipple default frame)
			 (face-stipple face frame))
		  (null (face-stipple face frame)))
Eric S. Raymond's avatar
Eric S. Raymond committed
424 425 426 427 428 429 430 431
	      (equal (face-underline-p default frame)
		     (face-underline-p face frame))
	      ))))


(defun invert-face (face &optional frame)
  "Swap the foreground and background colors of face FACE.
If the face doesn't specify both foreground and background, then
432
set its foreground and background to the default background and foreground."
Eric S. Raymond's avatar
Eric S. Raymond committed
433 434 435 436 437 438 439 440
  (interactive (list (read-face-name "Invert face: ")))
  (setq face (internal-get-face face frame))
  (let ((fg (face-foreground face frame))
	(bg (face-background face frame)))
    (if (or fg bg)
	(progn
	  (set-face-foreground face bg frame)
	  (set-face-background face fg frame))
441 442 443 444 445 446
      (set-face-foreground face (or (face-background 'default frame)
				    (cdr (assq 'background-color (frame-parameters frame))))
			   frame)
      (set-face-background face (or (face-foreground 'default frame)
				    (cdr (assq 'foreground-color (frame-parameters frame))))
			   frame)))
Eric S. Raymond's avatar
Eric S. Raymond committed
447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499
  face)


(defun internal-try-face-font (face font &optional frame)
  "Like set-face-font, but returns nil on failure instead of an error."
  (condition-case ()
      (set-face-font face font frame)
    (error nil)))

;; Manipulating font names.

(defconst x-font-regexp nil)
(defconst x-font-regexp-head nil)
(defconst x-font-regexp-weight nil)
(defconst x-font-regexp-slant nil)

;;; Regexps matching font names in "Host Portable Character Representation."
;;;
(let ((- 		"[-?]")
      (foundry		"[^-]+")
      (family 		"[^-]+")
      (weight		"\\(bold\\|demibold\\|medium\\)")		; 1
;     (weight\?		"\\(\\*\\|bold\\|demibold\\|medium\\|\\)")	; 1
      (weight\?		"\\([^-]*\\)")					; 1
      (slant		"\\([ior]\\)")					; 2
;     (slant\?		"\\([ior?*]?\\)")				; 2
      (slant\?		"\\([^-]?\\)")					; 2
;     (swidth		"\\(\\*\\|normal\\|semicondensed\\|\\)")	; 3
      (swidth		"\\([^-]*\\)")					; 3
;     (adstyle		"\\(\\*\\|sans\\|\\)")				; 4
      (adstyle		"[^-]*")					; 4
      (pixelsize	"[0-9]+")
      (pointsize	"[0-9][0-9]+")
      (resx		"[0-9][0-9]+")
      (resy		"[0-9][0-9]+")
      (spacing		"[cmp?*]")
      (avgwidth		"[0-9]+")
      (registry		"[^-]+")
      (encoding		"[^-]+")
      )
  (setq x-font-regexp
	(concat "\\`\\*?[-?*]"
		foundry - family - weight\? - slant\? - swidth - adstyle -
		pixelsize - pointsize - resx - resy - spacing - registry -
		encoding "[-?*]\\*?\\'"
		))
  (setq x-font-regexp-head
	(concat "\\`[-?*]" foundry - family - weight\? - slant\?
		"\\([-*?]\\|\\'\\)"))
  (setq x-font-regexp-slant (concat - slant -))
  (setq x-font-regexp-weight (concat - weight -))
  nil)	    

500 501 502
(defun x-resolve-font-name (pattern &optional face frame)
  "Return a font name matching PATTERN.
All wildcards in PATTERN become substantiated.
503 504
If PATTERN is nil, return the name of the frame's base font, which never
contains wildcards.
505
Given optional arguments FACE and FRAME, try to return a font which is
506
also the same size as FACE on FRAME."
507 508 509 510
  (or (symbolp face)
      (setq face (face-name face)))
  (and (eq frame t)
       (setq frame nil))
511
  (if pattern
512 513
      ;; Note that x-list-fonts has code to handle a face with nil as its font.
      (let ((fonts (x-list-fonts pattern face frame)))
514 515
	(or fonts
	    (if face
516
		(error "No fonts matching pattern are the same size as `%s'"
517
		       face)
518
	      (error "No fonts match `%s'" pattern)))
519 520
	(car fonts))
    (cdr (assq 'font (frame-parameters (selected-frame))))))
521

Eric S. Raymond's avatar
Eric S. Raymond committed
522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541
(defun x-frob-font-weight (font which)
  (if (or (string-match x-font-regexp font)
	  (string-match x-font-regexp-head font)
	  (string-match x-font-regexp-weight font))
      (concat (substring font 0 (match-beginning 1)) which
	      (substring font (match-end 1)))
    nil))

(defun x-frob-font-slant (font which)
  (cond ((or (string-match x-font-regexp font)
	     (string-match x-font-regexp-head font))
	 (concat (substring font 0 (match-beginning 2)) which
		 (substring font (match-end 2))))
	((string-match x-font-regexp-slant font)
	 (concat (substring font 0 (match-beginning 1)) which
		 (substring font (match-end 1))))
	(t nil)))


(defun x-make-font-bold (font)
542 543
  "Given an X font specification, make a bold version of it.
If that can't be done, return nil."
Eric S. Raymond's avatar
Eric S. Raymond committed
544 545 546
  (x-frob-font-weight font "bold"))

(defun x-make-font-demibold (font)
547 548
  "Given an X font specification, make a demibold version of it.
If that can't be done, return nil."
Eric S. Raymond's avatar
Eric S. Raymond committed
549 550 551
  (x-frob-font-weight font "demibold"))

(defun x-make-font-unbold (font)
552 553
  "Given an X font specification, make a non-bold version of it.
If that can't be done, return nil."
Eric S. Raymond's avatar
Eric S. Raymond committed
554 555 556
  (x-frob-font-weight font "medium"))

(defun x-make-font-italic (font)
557 558
  "Given an X font specification, make an italic version of it.
If that can't be done, return nil."
Eric S. Raymond's avatar
Eric S. Raymond committed
559 560 561
  (x-frob-font-slant font "i"))

(defun x-make-font-oblique (font) ; you say tomayto...
562 563
  "Given an X font specification, make an oblique version of it.
If that can't be done, return nil."
Eric S. Raymond's avatar
Eric S. Raymond committed
564 565 566
  (x-frob-font-slant font "o"))

(defun x-make-font-unitalic (font)
567 568
  "Given an X font specification, make a non-italic version of it.
If that can't be done, return nil."
Eric S. Raymond's avatar
Eric S. Raymond committed
569 570 571 572
  (x-frob-font-slant font "r"))

;;; non-X-specific interface

573
(defun make-face-bold (face &optional frame noerror)
Eric S. Raymond's avatar
Eric S. Raymond committed
574
  "Make the font of the given face be bold, if possible.  
575
If NOERROR is non-nil, return nil on failure."
Eric S. Raymond's avatar
Eric S. Raymond committed
576
  (interactive (list (read-face-name "Make which face bold: ")))
577
  (if (and (eq frame t) (listp (face-font face t)))
578 579 580 581
      (set-face-font face (if (memq 'italic (face-font face t))
			      '(bold italic) '(bold))
		     t)
    (let ((ofont (face-font face frame))
582
	  font)
583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598
      (if (null frame)
	  (let ((frames (frame-list)))
	    ;; Make this face bold in global-face-data.
	    (make-face-bold face t noerror)
	    ;; Make this face bold in each frame.
	    (while frames
	      (make-face-bold face (car frames) noerror)
	      (setq frames (cdr frames))))
	(setq face (internal-get-face face frame))
	(setq font (or (face-font face frame)
		       (face-font face t)))
	(if (listp font)
	    (setq font nil))
	(setq font (or font
		       (face-font 'default frame)
		       (cdr (assq 'font (frame-parameters frame)))))
599
	(and font (make-face-bold-internal face frame font)))
600 601 602 603
      (or (not (equal ofont (face-font face)))
	  (and (not noerror)
	       (error "No bold version of %S" font))))))

604 605 606 607 608 609
(defun make-face-bold-internal (face frame font)
  (let (f2)
    (or (and (setq f2 (x-make-font-bold font))
	     (internal-try-face-font face f2 frame))
	(and (setq f2 (x-make-font-demibold font))
	     (internal-try-face-font face f2 frame)))))
610 611

(defun make-face-italic (face &optional frame noerror)
Eric S. Raymond's avatar
Eric S. Raymond committed
612
  "Make the font of the given face be italic, if possible.  
613
If NOERROR is non-nil, return nil on failure."
Eric S. Raymond's avatar
Eric S. Raymond committed
614
  (interactive (list (read-face-name "Make which face italic: ")))
615
  (if (and (eq frame t) (listp (face-font face t)))
616 617 618 619
      (set-face-font face (if (memq 'bold (face-font face t))
			      '(bold italic) '(italic))
		     t)
    (let ((ofont (face-font face frame))
620
	  font)
621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636
      (if (null frame)
	  (let ((frames (frame-list)))
	    ;; Make this face italic in global-face-data.
	    (make-face-italic face t noerror)
	    ;; Make this face italic in each frame.
	    (while frames
	      (make-face-italic face (car frames) noerror)
	      (setq frames (cdr frames))))
	(setq face (internal-get-face face frame))
	(setq font (or (face-font face frame)
		       (face-font face t)))
	(if (listp font)
	    (setq font nil))
	(setq font (or font
		       (face-font 'default frame)
		       (cdr (assq 'font (frame-parameters frame)))))
637
	(and font (make-face-italic-internal face frame font)))
638 639 640 641
      (or (not (equal ofont (face-font face)))
	  (and (not noerror)
	       (error "No italic version of %S" font))))))

642 643 644 645 646 647
(defun make-face-italic-internal (face frame font)
  (let (f2)
    (or (and (setq f2 (x-make-font-italic font))
	     (internal-try-face-font face f2 frame))
	(and (setq f2 (x-make-font-oblique font))
	     (internal-try-face-font face f2 frame)))))
648 649

(defun make-face-bold-italic (face &optional frame noerror)
Eric S. Raymond's avatar
Eric S. Raymond committed
650
  "Make the font of the given face be bold and italic, if possible.  
651
If NOERROR is non-nil, return nil on failure."
Eric S. Raymond's avatar
Eric S. Raymond committed
652
  (interactive (list (read-face-name "Make which face bold-italic: ")))
653
  (if (and (eq frame t) (listp (face-font face t)))
654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672
      (set-face-font face '(bold italic) t)
    (let ((ofont (face-font face frame))
	  font)
      (if (null frame)
	  (let ((frames (frame-list)))
	    ;; Make this face bold-italic in global-face-data.
	    (make-face-bold-italic face t noerror)
	    ;; Make this face bold in each frame.
	    (while frames
	      (make-face-bold-italic face (car frames) noerror)
	      (setq frames (cdr frames))))
	(setq face (internal-get-face face frame))
	(setq font (or (face-font face frame)
		       (face-font face t)))
	(if (listp font)
	    (setq font nil))
	(setq font (or font
		       (face-font 'default frame)
		       (cdr (assq 'font (frame-parameters frame)))))
673
	(and font (make-face-bold-italic-internal face frame font)))
674 675 676 677
      (or (not (equal ofont (face-font face)))
	  (and (not noerror)
	       (error "No bold italic version of %S" font))))))

678
(defun make-face-bold-italic-internal (face frame font)
679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699
  (let (f2 f3)
    (or (and (setq f2 (x-make-font-italic font))
	     (not (equal font f2))
	     (setq f3 (x-make-font-bold f2))
	     (not (equal f2 f3))
	     (internal-try-face-font face f3 frame))
	(and (setq f2 (x-make-font-oblique font))
	     (not (equal font f2))
	     (setq f3 (x-make-font-bold f2))
	     (not (equal f2 f3))
	     (internal-try-face-font face f3 frame))
	(and (setq f2 (x-make-font-italic font))
	     (not (equal font f2))
	     (setq f3 (x-make-font-demibold f2))
	     (not (equal f2 f3))
	     (internal-try-face-font face f3 frame))
	(and (setq f2 (x-make-font-oblique font))
	     (not (equal font f2))
	     (setq f3 (x-make-font-demibold f2))
	     (not (equal f2 f3))
	     (internal-try-face-font face f3 frame)))))
700 701

(defun make-face-unbold (face &optional frame noerror)
Eric S. Raymond's avatar
Eric S. Raymond committed
702
  "Make the font of the given face be non-bold, if possible.  
703
If NOERROR is non-nil, return nil on failure."
Eric S. Raymond's avatar
Eric S. Raymond committed
704
  (interactive (list (read-face-name "Make which face non-bold: ")))
705
  (if (and (eq frame t) (listp (face-font face t)))
706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726
      (set-face-font face (if (memq 'italic (face-font face t))
			      '(italic) nil)
		     t)
    (let ((ofont (face-font face frame))
	  font font1)
      (if (null frame)
	  (let ((frames (frame-list)))
	    ;; Make this face unbold in global-face-data.
	    (make-face-unbold face t noerror)
	    ;; Make this face unbold in each frame.
	    (while frames
	      (make-face-unbold face (car frames) noerror)
	      (setq frames (cdr frames))))
	(setq face (internal-get-face face frame))
	(setq font1 (or (face-font face frame)
			(face-font face t)))
	(if (listp font1)
	    (setq font1 nil))
	(setq font1 (or font1
			(face-font 'default frame)
			(cdr (assq 'font (frame-parameters frame)))))
727
	(setq font (and font1 (x-make-font-unbold font1)))
728 729 730 731
	(if font (internal-try-face-font face font frame)))
      (or (not (equal ofont (face-font face)))
	  (and (not noerror)
	       (error "No unbold version of %S" font1))))))
732 733

(defun make-face-unitalic (face &optional frame noerror)
Eric S. Raymond's avatar
Eric S. Raymond committed
734
  "Make the font of the given face be non-italic, if possible.  
735
If NOERROR is non-nil, return nil on failure."
Eric S. Raymond's avatar
Eric S. Raymond committed
736
  (interactive (list (read-face-name "Make which face non-italic: ")))
737
  (if (and (eq frame t) (listp (face-font face t)))
738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758
      (set-face-font face (if (memq 'bold (face-font face t))
			      '(bold) nil)
		     t)
    (let ((ofont (face-font face frame))
	  font font1)
      (if (null frame)
	  (let ((frames (frame-list)))
	    ;; Make this face unitalic in global-face-data.
	    (make-face-unitalic face t noerror)
	    ;; Make this face unitalic in each frame.
	    (while frames
	      (make-face-unitalic face (car frames) noerror)
	      (setq frames (cdr frames))))
	(setq face (internal-get-face face frame))
	(setq font1 (or (face-font face frame)
			(face-font face t)))
	(if (listp font1)
	    (setq font1 nil))
	(setq font1 (or font1
			(face-font 'default frame)
			(cdr (assq 'font (frame-parameters frame)))))
759
	(setq font (and font1 (x-make-font-unitalic font1)))
760 761 762 763
	(if font (internal-try-face-font face font frame)))
      (or (not (equal ofont (face-font face)))
	  (and (not noerror)
	       (error "No unitalic version of %S" font1))))))
Eric S. Raymond's avatar
Eric S. Raymond committed
764

765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794
(defvar list-faces-sample-text
  "abcdefghijklmnopqrstuvwxyz ABCDEFGHIJKLMNOPQRSTUVWXYZ"
  "*Text string to display as the sample text for `list-faces-display'.")

;; The name list-faces would be more consistent, but let's avoid a conflict
;; with Lucid, which uses that name differently.
(defun list-faces-display ()
  "List all faces, using the same sample text in each.
The sample text is a string that comes from the variable
`list-faces-sample-text'.

It is possible to give a particular face name different appearances in
different frames.  This command shows the appearance in the
selected frame."
  (interactive)
  (let ((faces (sort (face-list) (function string-lessp)))
	(face nil)
	(frame (selected-frame))
	disp-frame window)
    (with-output-to-temp-buffer "*Faces*"
      (save-excursion
	(set-buffer standard-output)
	(setq truncate-lines t)
	(while faces
	  (setq face (car faces))
	  (setq faces (cdr faces))
	  (insert (format "%25s " (symbol-name face)))
	  (let ((beg (point)))
	    (insert list-faces-sample-text)
	    (insert "\n")
795 796 797 798 799 800 801
	    (put-text-property beg (1- (point)) 'face face)
	    ;; If the sample text has multiple lines, line up all of them.
	    (goto-char beg)
	    (forward-line 1)
	    (while (not (eobp))
	      (insert "                          ")
	      (forward-line 1))))
802 803 804 805 806 807 808 809 810 811 812 813 814
	(goto-char (point-min))))
    ;; If the *Faces* buffer appears in a different frame,
    ;; copy all the face definitions from FRAME,
    ;; so that the display will reflect the frame that was selected.
    (setq window (get-buffer-window (get-buffer "*Faces*") t))
    (setq disp-frame (if window (window-frame window)
		       (car (frame-list))))
    (or (eq frame disp-frame)
	(let ((faces (face-list)))
	  (while faces
	    (copy-face (car faces) (car faces) frame disp-frame)
	    (setq faces (cdr faces)))))))

815 816 817
;;; Make the standard faces.
;;; The C code knows the default and modeline faces as faces 0 and 1,
;;; so they must be the first two faces made.
818
(defun face-initialize ()
Eric S. Raymond's avatar
Eric S. Raymond committed
819
  (make-face 'default)
820
  (make-face 'modeline)
Eric S. Raymond's avatar
Eric S. Raymond committed
821
  (make-face 'highlight)
822

Eric S. Raymond's avatar
Eric S. Raymond committed
823
  ;; These aren't really special in any way, but they're nice to have around.
824

Eric S. Raymond's avatar
Eric S. Raymond committed
825 826 827
  (make-face 'bold)
  (make-face 'italic)
  (make-face 'bold-italic)
828
  (make-face 'region)
829
  (make-face 'secondary-selection)
830
  (make-face 'underline)
831

832
  (setq region-face (face-id 'region))
833

834 835 836 837 838 839 840 841
  ;; Specify the global properties of these faces
  ;; so they will come out right on new frames.

  (make-face-bold 'bold t)
  (make-face-italic 'italic t)
  (make-face-bold-italic 'bold-italic t)

  (set-face-background 'highlight '("darkseagreen2" "green" t) t)
842
  (set-face-background 'region '("gray" underline) t)
843 844 845 846 847 848 849
  (set-face-background 'secondary-selection '("paleturquoise" "green" t) t)
  (set-face-background 'modeline '(t) t)
  (set-face-underline-p 'underline t t)

  ;; Set up the faces of all existing X Window frames
  ;; from those global properties, unless already set in a given frame.

850 851
  (let ((frames (frame-list)))
    (while frames
Morten Welinder's avatar
Morten Welinder committed
852
      (if (framep (car frames))
853 854 855 856 857 858 859
	  (let ((frame (car frames))
		(rest global-face-data))
	    (while rest
	      (let ((face (car (car rest))))
		(or (face-differs-from-default-p face)
		    (face-fill-in face (cdr (car rest)) frame)))
	      (setq rest (cdr rest)))))
860 861
      (setq frames (cdr frames)))))

Eric S. Raymond's avatar
Eric S. Raymond committed
862 863 864 865

;; Like x-create-frame but also set up the faces.

(defun x-create-frame-with-faces (&optional parameters)
866 867
  (if (null global-face-data)
      (x-create-frame parameters)
868 869
    (let* ((visibility-spec (assq 'visibility parameters))
	   (frame (x-create-frame (cons '(visibility . nil) parameters)))
870
	   (faces (copy-alist global-face-data))
871
	   success
872
	   (rest faces))
873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912
      (unwind-protect
	  (progn
	    (set-frame-face-alist frame faces)

	    (if (cdr (or (assq 'reverse parameters)
			 (assq 'reverse default-frame-alist)
			 (let ((resource (x-get-resource "reverseVideo"
							 "ReverseVideo")))
			   (if resource
			       (cons nil (member (downcase resource)
						 '("on" "true")))))))
		(let ((params (frame-parameters frame)))
		  (modify-frame-parameters
		   frame
		   (list (cons 'foreground-color (cdr (assq 'background-color params)))
			 (cons 'background-color (cdr (assq 'foreground-color params)))
			 (cons 'mouse-color (cdr (assq 'background-color params)))
			 (cons 'border-color (cdr (assq 'background-color params)))))
		  (modify-frame-parameters
		   frame
		   (list (cons 'cursor-color (cdr (assq 'background-color params)))))))

	    ;; Copy the vectors that represent the faces.
	    ;; Also fill them in from X resources.
	    (while rest
	      (let ((global (cdr (car rest))))
		(setcdr (car rest) (vector 'face
					   (face-name (cdr (car rest)))
					   (face-id (cdr (car rest)))
					   nil nil nil nil nil))
		(face-fill-in (car (car rest)) global frame))
	      (make-face-x-resource-internal (cdr (car rest)) frame t)
	      (setq rest (cdr rest)))
	    (if (null visibility-spec)
		(make-frame-visible frame)
	      (modify-frame-parameters frame (list visibility-spec)))
	    (setq success t)
	    frame)
	(or success
	    (delete-frame frame))))))
913

914 915 916 917 918 919 920 921 922 923
;; Update a frame's faces when we change its default font.
(defun frame-update-faces (frame)
  (let* ((faces global-face-data)
	 (rest faces))
    (while rest
      (let* ((face (car (car rest)))
	     (font (face-font face t)))
	(if (listp font)
	    (let ((bold (memq 'bold font))
		  (italic (memq 'italic font)))
924 925 926
	      ;; Ignore any previous (string-valued) font, it might not even
	      ;; be the right size anymore.
	      (set-face-font face nil frame)
927 928 929 930 931 932 933 934 935
	      (cond ((and bold italic)
		     (make-face-bold-italic face frame t))
		    (bold
		     (make-face-bold face frame t))
		    (italic
		     (make-face-italic face frame t)))))
      (setq rest (cdr rest)))
    frame)))

936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963
;; Fill in the face FACE from frame-independent face data DATA.
;; DATA should be the non-frame-specific ("global") face vector
;; for the face.  FACE should be a face name or face object.
;; FRAME is the frame to act on; it must be an actual frame, not nil or t.
(defun face-fill-in (face data frame)
  (condition-case nil
      (let ((foreground (face-foreground data))
	    (background (face-background data))
	    (font (face-font data)))
	(set-face-underline-p face (face-underline-p data) frame)
	(if foreground
	    (face-try-color-list 'set-face-foreground
				 face foreground frame))
	(if background
	    (face-try-color-list 'set-face-background
				 face background frame))
	(if (listp font)
	    (let ((bold (memq 'bold font))
		  (italic (memq 'italic font)))
	      (cond ((and bold italic)
		     (make-face-bold-italic face frame))
		    (bold
		     (make-face-bold face frame))
		    (italic
		     (make-face-italic face frame))))
	  (if font
	      (set-face-font face font frame))))
    (error nil)))
964

965 966 967 968 969 970 971 972
;; Use FUNCTION to store a color in FACE on FRAME.
;; COLORS is either a single color or a list of colors.
;; If it is a list, try the colors one by one until one of them
;; succeeds.  We signal an error only if all the colors failed.
;; t as COLORS or as an element of COLORS means to invert the face.
;; That can't fail, so any subsequent elements after the t are ignored.
(defun face-try-color-list (function face colors frame)
  (if (stringp colors)
973 974 975
      (if (and (not (member colors '("gray" "gray1" "gray3")))
	       (or (not (x-display-color-p))
		   (= (x-display-planes) 1)))
976 977
	  nil
	(funcall function face colors frame))
978 979 980 981
    (if (eq colors t)
	(invert-face face frame)
      (let (done)
	(while (and colors (not done))
982
	  (if (and (stringp (car colors))
983 984 985
		   (and (not (member (car colors) '("gray" "gray1" "gray3")))
			(or (not (x-display-color-p))
			    (= (x-display-planes) 1))))
986 987 988 989 990 991
	      nil
	    (if (cdr colors)
		;; If there are more colors to try, catch errors
		;; and set `done' if we succeed.
		(condition-case nil
		    (progn
992 993 994 995 996 997
		      (cond ((eq (car colors) t)
			     (invert-face face frame))
			    ((eq (car colors) 'underline)
			     (set-face-underline-p face t frame))
			    (t
			     (funcall function face (car colors) frame)))
998 999 1000 1001
		      (setq done t))
		  (error nil))
	      ;; If this is the last color, let the error get out if it fails.
	      ;; If it succeeds, we will exit anyway after this iteration.
1002 1003 1004 1005 1006 1007
	      (cond ((eq (car colors) t)
		     (invert-face face frame))
		    ((eq (car colors) 'underline)
		     (set-face-underline-p face t frame))
		    (t
		     (funcall function face (car colors) frame)))))
1008
	  (setq colors (cdr colors)))))))
1009 1010 1011 1012

;; If we are already using x-window frames, initialize faces for them.
(if (eq (framep (selected-frame)) 'x)
    (face-initialize))
Eric S. Raymond's avatar
Eric S. Raymond committed
1013

1014 1015
(provide 'faces)

Eric S. Raymond's avatar
Eric S. Raymond committed
1016
;;; faces.el ends here