faces.el 102 KB
Newer Older
Gerd Moellmann's avatar
Gerd Moellmann committed
1
;;; faces.el --- Lisp faces
Eric S. Raymond's avatar
Eric S. Raymond committed
2

3
;; Copyright (C) 1992, 1993, 1994, 1995, 1996, 1998, 1999, 2000, 2001,
Glenn Morris's avatar
Glenn Morris committed
4
;;   2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010
5
;;   Free Software Foundation, Inc.
Eric S. Raymond's avatar
Eric S. Raymond committed
6

7
;; Maintainer: FSF
Pavel Janík's avatar
Pavel Janík committed
8
;; Keywords: internal
9

Eric S. Raymond's avatar
Eric S. Raymond committed
10 11
;; This file is part of GNU Emacs.

12
;; GNU Emacs is free software: you can redistribute it and/or modify
Eric S. Raymond's avatar
Eric S. Raymond committed
13
;; it under the terms of the GNU General Public License as published by
14 15
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
Eric S. Raymond's avatar
Eric S. Raymond committed
16 17 18 19 20 21 22

;; 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
23
;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
Eric S. Raymond's avatar
Eric S. Raymond committed
24 25 26 27 28

;;; Commentary:

;;; Code:

29
(eval-when-compile
30 31 32
  (require 'cl))

(declare-function xw-defined-colors "term/x-win" (&optional frame))
Gerd Moellmann's avatar
Gerd Moellmann committed
33

34
(defvar help-xref-stack-item)
35 36 37 38 39 40

(defvar face-name-history nil
  "History list for some commands that read face names.
Maximum length of the history list is determined by the value
of `history-length', which see.")

Gerd Moellmann's avatar
Gerd Moellmann committed
41 42 43 44 45 46 47 48 49 50 51 52

;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;;; Font selection.
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;

(defgroup font-selection nil
  "Influencing face font selection."
  :group 'faces)


(defcustom face-font-selection-order
  '(:width :height :weight :slant)
Lute Kamstra's avatar
Lute Kamstra committed
53
  "A list specifying how face font selection chooses fonts.
Gerd Moellmann's avatar
Gerd Moellmann committed
54 55
Each of the four symbols `:width', `:height', `:weight', and `:slant'
must appear once in the list, and the list must not contain any other
56
elements.  Font selection first tries to find a best matching font
57
for those face attributes that appear before in the list.  For
Gerd Moellmann's avatar
Gerd Moellmann committed
58 59 60
example, if `:slant' appears before `:height', font selection first
tries to find a font with a suitable slant, even if this results in
a font height that isn't optimal."
Andreas Schwab's avatar
Andreas Schwab committed
61
  :tag "Font selection order"
Gerd Moellmann's avatar
Gerd Moellmann committed
62
  :type '(list symbol symbol symbol symbol)
Gerd Moellmann's avatar
Gerd Moellmann committed
63 64 65 66 67
  :group 'font-selection
  :set #'(lambda (symbol value)
	   (set-default symbol value)
	   (internal-set-font-selection-order value)))

68

69
;; In the absence of Fontconfig support, Monospace and Sans Serif are
70 71
;; unavailable, and we fall back on the courier and helv families,
;; which are generally available.
Gerd Moellmann's avatar
Gerd Moellmann committed
72
(defcustom face-font-family-alternatives
73
  (mapcar (lambda (arg) (mapcar 'purecopy arg))
74
  '(("Monospace" "courier" "fixed")
75
    ("courier" "CMU Typewriter Text" "fixed")
76
    ("Sans Serif" "helv" "helvetica" "arial" "fixed")
77
    ("helv" "helvetica" "arial" "fixed")))
Lute Kamstra's avatar
Lute Kamstra committed
78
  "Alist of alternative font family names.
Pavel Janík's avatar
Pavel Janík committed
79
Each element has the form (FAMILY ALTERNATIVE1 ALTERNATIVE2 ...).
Gerd Moellmann's avatar
Gerd Moellmann committed
80 81
If fonts of family FAMILY can't be loaded, try ALTERNATIVE1, then
ALTERNATIVE2 etc."
Andreas Schwab's avatar
Andreas Schwab committed
82
  :tag "Alternative font families to try"
Gerd Moellmann's avatar
Gerd Moellmann committed
83
  :type '(repeat (repeat string))
Gerd Moellmann's avatar
Gerd Moellmann committed
84 85 86 87 88 89
  :group 'font-selection
  :set #'(lambda (symbol value)
	   (set-default symbol value)
	   (internal-set-alternative-font-family-alist value)))


90 91
;; This is defined originally in xfaces.c.
(defcustom face-font-registry-alternatives
92
  (mapcar (lambda (arg) (mapcar 'purecopy arg))
93
  (if (eq system-type 'windows-nt)
94
      '(("iso8859-1" "ms-oemlatin")
95
	("gb2312.1980" "gb2312" "gbk" "gb18030")
96 97 98
	("jisx0208.1990" "jisx0208.1983" "jisx0208.1978")
	("ksc5601.1989" "ksx1001.1992" "ksc5601.1987")
	("muletibetan-2" "muletibetan-0"))
99
    '(("gb2312.1980" "gb2312.80&gb8565.88" "gbk" "gb18030")
100 101
      ("jisx0208.1990" "jisx0208.1983" "jisx0208.1978")
      ("ksc5601.1989" "ksx1001.1992" "ksc5601.1987")
102
      ("muletibetan-2" "muletibetan-0"))))
Lute Kamstra's avatar
Lute Kamstra committed
103
  "Alist of alternative font registry names.
Pavel Janík's avatar
Pavel Janík committed
104
Each element has the form (REGISTRY ALTERNATIVE1 ALTERNATIVE2 ...).
105 106 107
If fonts of registry REGISTRY can be loaded, font selection
tries to find a best matching font among all fonts of registry
REGISTRY, ALTERNATIVE1, ALTERNATIVE2, and etc."
Andreas Schwab's avatar
Andreas Schwab committed
108
  :tag "Alternative font registries to try"
109
  :type '(repeat (repeat string))
110
  :version "21.1"
111 112 113 114 115
  :group 'font-selection
  :set #'(lambda (symbol value)
	   (set-default symbol value)
	   (internal-set-alternative-font-registry-alist value)))

116

Gerd Moellmann's avatar
Gerd Moellmann committed
117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;;; Creation, copying.
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;


(defun face-list ()
  "Return a list of all defined face names."
  (mapcar #'car face-new-frame-defaults))


;;; ### If not frame-local initialize by what X resources?

(defun make-face (face &optional no-init-from-resources)
  "Define a new face with name FACE, a symbol.
NO-INIT-FROM-RESOURCES non-nil means don't initialize frame-local
variants of FACE from X resources.  (X resources recognized are found
in the global variable `face-x-resources'.)  If FACE is already known
as a face, leave it unmodified.  Value is FACE."
135 136
  (interactive (list (read-from-minibuffer
		      "Make face: " nil nil t 'face-name-history)))
Gerd Moellmann's avatar
Gerd Moellmann committed
137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152
  (unless (facep face)
    ;; Make frame-local faces (this also makes the global one).
    (dolist (frame (frame-list))
      (internal-make-lisp-face face frame))
    ;; Add the face to the face menu.
    (when (fboundp 'facemenu-add-new-face)
      (facemenu-add-new-face face))
    ;; Define frame-local faces for all frames from X resources.
    (unless no-init-from-resources
      (make-face-x-resource-internal face)))
  face)


(defun make-empty-face (face)
  "Define a new, empty face with name FACE.
If the face already exists, it is left unmodified.  Value is FACE."
153 154
  (interactive (list (read-from-minibuffer
		      "Make empty face: " nil nil t 'face-name-history)))
Gerd Moellmann's avatar
Gerd Moellmann committed
155 156 157 158 159 160 161 162 163
  (make-face face 'no-init-from-resources))


(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.

Juanma Barranquero's avatar
Juanma Barranquero committed
164
If the optional argument FRAME is given as a frame, NEW-FACE is
Gerd Moellmann's avatar
Gerd Moellmann committed
165 166 167 168 169 170 171 172
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.

If the optional fourth argument NEW-FRAME is given,
copy the information from face OLD-FACE on frame FRAME
173
to NEW-FACE on frame NEW-FRAME.  In this case, FRAME may not be nil."
Gerd Moellmann's avatar
Gerd Moellmann committed
174 175 176
  (let ((inhibit-quit t))
    (if (null frame)
	(progn
177 178 179 180
	  (when new-frame
	    (error "Copying face %s from all frames to one frame"
		   old-face))
	  (make-empty-face new-face)
Gerd Moellmann's avatar
Gerd Moellmann committed
181 182 183
	  (dolist (frame (frame-list))
	    (copy-face old-face new-face frame))
	  (copy-face old-face new-face t))
184
      (make-empty-face new-face)
Gerd Moellmann's avatar
Gerd Moellmann committed
185 186 187 188 189 190 191 192 193 194 195
      (internal-copy-lisp-face old-face new-face frame new-frame))
    new-face))



;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;;; Obsolete functions
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;

;; The functions in this section are defined because Lisp packages use
;; them, despite the prefix `internal-' suggesting that they are
Dave Love's avatar
Dave Love committed
196
;; private to the face implementation.
Gerd Moellmann's avatar
Gerd Moellmann committed
197 198 199 200

(defun internal-find-face (name &optional frame)
  "Retrieve the face named NAME.
Return nil if there is no such face.
201 202
If NAME is already a face, it is simply returned.
The optional argument FRAME is ignored."
Gerd Moellmann's avatar
Gerd Moellmann committed
203
  (facep name))
204
(make-obsolete 'internal-find-face 'facep "21.1")
Gerd Moellmann's avatar
Gerd Moellmann committed
205 206 207 208


(defun internal-get-face (name &optional frame)
  "Retrieve the face named NAME; error if there is none.
209 210
If NAME is already a face, it is simply returned.
The optional argument FRAME is ignored."
211
  (or (facep name)
Gerd Moellmann's avatar
Gerd Moellmann committed
212
      (check-face name)))
213
(make-obsolete 'internal-get-face "see `facep' and `check-face'." "21.1")
Gerd Moellmann's avatar
Gerd Moellmann committed
214 215 216 217 218 219 220


;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;;; Predicates, type checks.
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;

(defun facep (face)
Richard M. Stallman's avatar
Richard M. Stallman committed
221 222
  "Return non-nil if FACE is a face name; nil otherwise.
A face name can be a string or a symbol."
Gerd Moellmann's avatar
Gerd Moellmann committed
223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238
  (internal-lisp-face-p face))


(defun check-face (face)
  "Signal an error if FACE doesn't name a face.
Value is FACE."
  (unless (facep face)
    (error "Not a face: %s" face))
  face)


;; The ID returned is not to be confused with the internally used IDs
;; of realized faces.  The ID assigned to Lisp faces is used to
;; support faces in display table entries.

(defun face-id (face &optional frame)
Juanma Barranquero's avatar
Juanma Barranquero committed
239
  "Return the internal ID of face with name FACE.
240
If FACE is a face-alias, return the ID of the target face.
Richard M. Stallman's avatar
Richard M. Stallman committed
241 242
The optional argument FRAME is ignored, since the internal face ID
of a face name is the same for all frames."
Gerd Moellmann's avatar
Gerd Moellmann committed
243
  (check-face face)
244 245
  (or (get face 'face)
      (face-id (get face 'face-alias))))
Gerd Moellmann's avatar
Gerd Moellmann committed
246 247 248 249

(defun face-equal (face1 face2 &optional frame)
  "Non-nil if faces FACE1 and FACE2 are equal.
Faces are considered equal if all their attributes are equal.
250 251
If the optional argument FRAME is given, report on FACE1 and FACE2 in that frame.
If FRAME is t, report on the defaults for FACE1 and FACE2 (for new frames).
Gerd Moellmann's avatar
Gerd Moellmann committed
252 253 254 255 256
If FRAME is omitted or nil, use the selected frame."
  (internal-lisp-face-equal-p face1 face2 frame))


(defun face-differs-from-default-p (face &optional frame)
257
  "Return non-nil if FACE displays differently from the default face.
Gerd Moellmann's avatar
Gerd Moellmann committed
258 259
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).
260
If FRAME is omitted or nil, use the selected frame."
261
  (let ((attrs
262
	 (delq :inherit (mapcar 'car face-attribute-name-alist)))
263 264 265 266 267 268 269 270 271 272
	(differs nil))
    (while (and attrs (not differs))
      (let* ((attr (pop attrs))
	     (attr-val (face-attribute face attr frame t)))
	(when (and
	       (not (eq attr-val 'unspecified))
	       (display-supports-face-attributes-p (list attr attr-val)
						   frame))
	  (setq differs attr))))
    differs))
Gerd Moellmann's avatar
Gerd Moellmann committed
273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288


(defun face-nontrivial-p (face &optional frame)
  "True if face FACE has some non-nil attribute.
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."
  (not (internal-lisp-face-empty-p face frame)))



;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;;; Setting face attributes from X resources.
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;

(defcustom face-x-resources
289 290 291 292 293
  (mapcar
   (lambda (arg)
     ;; FIXME; can we purecopy some of the conses too?
     (cons (car arg)
	   (cons (purecopy (car (cdr arg))) (purecopy (cdr (cdr arg))))))
Gerd Moellmann's avatar
Gerd Moellmann committed
294
  '((:family (".attributeFamily" . "Face.AttributeFamily"))
295
    (:foundry (".attributeFoundry" . "Face.AttributeFoundry"))
Gerd Moellmann's avatar
Gerd Moellmann committed
296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311
    (:width (".attributeWidth" . "Face.AttributeWidth"))
    (:height (".attributeHeight" . "Face.AttributeHeight"))
    (:weight (".attributeWeight" . "Face.AttributeWeight"))
    (:slant (".attributeSlant" . "Face.AttributeSlant"))
    (:foreground (".attributeForeground" . "Face.AttributeForeground"))
    (:background (".attributeBackground" . "Face.AttributeBackground"))
    (:overline (".attributeOverline" . "Face.AttributeOverline"))
    (:strike-through (".attributeStrikeThrough" . "Face.AttributeStrikeThrough"))
    (:box (".attributeBox" . "Face.AttributeBox"))
    (:underline (".attributeUnderline" . "Face.AttributeUnderline"))
    (:inverse-video (".attributeInverse" . "Face.AttributeInverse"))
    (:stipple
     (".attributeStipple" . "Face.AttributeStipple")
     (".attributeBackgroundPixmap" . "Face.AttributeBackgroundPixmap"))
    (:bold (".attributeBold" . "Face.AttributeBold"))
    (:italic (".attributeItalic" . "Face.AttributeItalic"))
312
    (:font (".attributeFont" . "Face.AttributeFont"))
313
    (:inherit (".attributeInherit" . "Face.AttributeInherit"))))
Lute Kamstra's avatar
Lute Kamstra committed
314
  "List of X resources and classes for face attributes.
Gerd Moellmann's avatar
Gerd Moellmann committed
315 316
Each element has the form (ATTRIBUTE ENTRY1 ENTRY2...) where ATTRIBUTE is
the name of a face attribute, and each ENTRY is a cons of the form
317
\(RESOURCE . CLASS) with RESOURCE being the resource and CLASS being the
Gerd Moellmann's avatar
Gerd Moellmann committed
318
X resource class for the attribute."
319
  :type '(repeat (cons symbol (repeat (cons string string))))
Gerd Moellmann's avatar
Gerd Moellmann committed
320 321 322
  :group 'faces)


323 324 325 326 327 328
(declare-function internal-face-x-get-resource "xfaces.c"
		  (resource class frame))

(declare-function internal-set-lisp-face-attribute-from-resource "xfaces.c"
		  (face attr value &optional frame))

Gerd Moellmann's avatar
Gerd Moellmann committed
329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348
(defun set-face-attribute-from-resource (face attribute resource class frame)
  "Set FACE's ATTRIBUTE from X resource RESOURCE, class CLASS on FRAME.
Value is the attribute value specified by the resource, or nil
if not present.  This function displays a message if the resource
specifies an invalid attribute."
  (let* ((face-name (face-name face))
	 (value (internal-face-x-get-resource (concat face-name resource)
					      class frame)))
    (when value
      (condition-case ()
	  (internal-set-lisp-face-attribute-from-resource
	   face attribute (downcase value) frame)
	(error
	 (message "Face %s, frame %s: invalid attribute %s %s from X resource"
		  face-name frame attribute value))))
    value))


(defun set-face-attributes-from-resources (face frame)
  "Set attributes of FACE from X resources for FRAME."
349
  (when (memq (framep frame) '(x w32))
Gerd Moellmann's avatar
Gerd Moellmann committed
350 351 352 353 354
    (dolist (definition face-x-resources)
      (let ((attribute (car definition)))
	(dolist (entry (cdr definition))
	  (set-face-attribute-from-resource face attribute (car entry)
					    (cdr entry) frame))))))
Sam Steingold's avatar
Sam Steingold committed
355 356


Gerd Moellmann's avatar
Gerd Moellmann committed
357 358 359 360 361 362 363 364 365 366 367 368 369 370
(defun make-face-x-resource-internal (face &optional frame)
  "Fill frame-local FACE on FRAME from X resources.
FRAME nil or not specified means do it for all frames."
  (if (null frame)
      (dolist (frame (frame-list))
	(set-face-attributes-from-resources face frame))
    (set-face-attributes-from-resources face frame)))



;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;;; Retrieving face attributes.
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;

371
(defun face-name (face)
Eric S. Raymond's avatar
Eric S. Raymond committed
372
  "Return the name of face FACE."
Gerd Moellmann's avatar
Gerd Moellmann committed
373 374 375
  (symbol-name (check-face face)))


376 377 378 379 380 381
(defun face-all-attributes (face &optional frame)
  "Return an alist stating the attributes of FACE.
Each element of the result has the form (ATTR-NAME . ATTR-VALUE).
Normally the value describes the default attributes,
but if you specify FRAME, the value describes the attributes
of FACE on FRAME."
382 383 384
  (mapcar (lambda (pair)
	    (let ((attr (car pair)))
	      (cons attr (face-attribute face attr (or frame t)))))
385 386
  	  face-attribute-name-alist))

387
(defun face-attribute (face attribute &optional frame inherit)
Gerd Moellmann's avatar
Gerd Moellmann committed
388 389 390
  "Return the value of FACE's ATTRIBUTE on FRAME.
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).
391
If FRAME is omitted or nil, use the selected frame.
Gerd Moellmann's avatar
Gerd Moellmann committed
392

393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409
If INHERIT is nil, only attributes directly defined by FACE are considered,
  so the return value may be `unspecified', or a relative value.
If INHERIT is non-nil, FACE's definition of ATTRIBUTE is merged with the
  faces specified by its `:inherit' attribute; however the return value
  may still be `unspecified' or relative.
If INHERIT is a face or a list of faces, then the result is further merged
  with that face (or faces), until it becomes specified and absolute.

To ensure that the return value is always specified and absolute, use a
value of `default' for INHERIT; this will resolve any unspecified or
relative values by merging with the `default' face (which is always
completely specified)."
  (let ((value (internal-get-lisp-face-attribute face attribute frame)))
    (when (and inherit (face-attribute-relative-p attribute value))
      ;; VALUE is relative, so merge with inherited faces
      (let ((inh-from (face-attribute face :inherit frame)))
	(unless (or (null inh-from) (eq inh-from 'unspecified))
410 411 412 413 414
          (condition-case nil
              (setq value
                    (face-attribute-merged-with attribute value inh-from frame))
            ;; The `inherit' attribute may point to non existent faces.
            (error nil)))))
415 416 417
    (when (and inherit
	       (not (eq inherit t))
	       (face-attribute-relative-p attribute value))
418
      ;; We should merge with INHERIT as well
419 420
      (setq value (face-attribute-merged-with attribute value inherit frame)))
    value))
Gerd Moellmann's avatar
Gerd Moellmann committed
421

422 423 424
(defun face-attribute-merged-with (attribute value faces &optional frame)
  "Merges ATTRIBUTE, initially VALUE, with faces from FACES until absolute.
FACES may be either a single face or a list of faces.
425
\[This is an internal function.]"
426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450
  (cond ((not (face-attribute-relative-p attribute value))
	 value)
	((null faces)
	 value)
	((consp faces)
	 (face-attribute-merged-with
	  attribute
	  (face-attribute-merged-with attribute value (car faces) frame)
	  (cdr faces)
	  frame))
	(t
	 (merge-face-attribute attribute
			       value
			       (face-attribute faces attribute frame t)))))


(defmacro face-attribute-specified-or (value &rest body)
  "Return VALUE, unless it's `unspecified', in which case evaluate BODY and return the result."
  (let ((temp (make-symbol "value")))
    `(let ((,temp ,value))
       (if (not (eq ,temp 'unspecified))
	   ,temp
	 ,@body))))

(defun face-foreground (face &optional frame inherit)
Gerd Moellmann's avatar
Gerd Moellmann committed
451 452 453
  "Return the foreground color name of 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).
454
If FRAME is omitted or nil, use the selected frame.
Gerd Moellmann's avatar
Gerd Moellmann committed
455

456 457 458 459 460 461 462 463 464 465 466 467 468 469 470
If INHERIT is nil, only a foreground color directly defined by FACE is
  considered, so the return value may be nil.
If INHERIT is t, and FACE doesn't define a foreground color, then any
  foreground color that FACE inherits through its `:inherit' attribute
  is considered as well; however the return value may still be nil.
If INHERIT is a face or a list of faces, then it is used to try to
  resolve an unspecified foreground color.

To ensure that a valid color is always returned, use a value of
`default' for INHERIT; this will resolve any unspecified values by
merging with the `default' face (which is always completely specified)."
  (face-attribute-specified-or (face-attribute face :foreground frame inherit)
			       nil))

(defun face-background (face &optional frame inherit)
Gerd Moellmann's avatar
Gerd Moellmann committed
471 472 473
  "Return the background color name of 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).
474
If FRAME is omitted or nil, use the selected frame.
Gerd Moellmann's avatar
Gerd Moellmann committed
475

476 477 478 479 480 481 482 483 484 485 486 487 488 489 490
If INHERIT is nil, only a background color directly defined by FACE is
  considered, so the return value may be nil.
If INHERIT is t, and FACE doesn't define a background color, then any
  background color that FACE inherits through its `:inherit' attribute
  is considered as well; however the return value may still be nil.
If INHERIT is a face or a list of faces, then it is used to try to
  resolve an unspecified background color.

To ensure that a valid color is always returned, use a value of
`default' for INHERIT; this will resolve any unspecified values by
merging with the `default' face (which is always completely specified)."
  (face-attribute-specified-or (face-attribute face :background frame inherit)
			       nil))

(defun face-stipple (face &optional frame inherit)
Gerd Moellmann's avatar
Gerd Moellmann committed
491 492 493
 "Return the stipple pixmap name of 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).
494 495 496 497 498 499 500 501 502 503 504 505 506 507 508
If FRAME is omitted or nil, use the selected frame.

If INHERIT is nil, only a stipple directly defined by FACE is
  considered, so the return value may be nil.
If INHERIT is t, and FACE doesn't define a stipple, then any stipple
  that FACE inherits through its `:inherit' attribute is considered as
  well; however the return value may still be nil.
If INHERIT is a face or a list of faces, then it is used to try to
  resolve an unspecified stipple.

To ensure that a valid stipple or nil is always returned, use a value of
`default' for INHERIT; this will resolve any unspecified values by merging
with the `default' face (which is always completely specified)."
  (face-attribute-specified-or (face-attribute face :stipple frame inherit)
			       nil))
Gerd Moellmann's avatar
Gerd Moellmann committed
509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536


(defalias 'face-background-pixmap 'face-stipple)


(defun face-underline-p (face &optional frame)
 "Return non-nil if FACE is underlined.
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."
 (eq (face-attribute face :underline frame) t))


(defun face-inverse-video-p (face &optional frame)
 "Return non-nil if FACE is in inverse video on FRAME.
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."
 (eq (face-attribute face :inverse-video frame) t))


(defun face-bold-p (face &optional frame)
  "Return non-nil if the font of FACE is bold on FRAME.
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.
Use `face-attribute' for finer control."
  (let ((bold (face-attribute face :weight frame)))
537
    (memq bold '(semi-bold bold extra-bold ultra-bold))))
Gerd Moellmann's avatar
Gerd Moellmann committed
538 539 540 541 542 543 544 545 546


(defun face-italic-p (face &optional frame)
  "Return non-nil if the font of FACE is italic on FRAME.
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.
Use `face-attribute' for finer control."
  (let ((italic (face-attribute face :slant frame)))
547
    (memq italic '(italic oblique))))
Sam Steingold's avatar
Sam Steingold committed
548

Gerd Moellmann's avatar
Gerd Moellmann committed
549 550 551 552 553 554 555


;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;;; Face documentation.
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;

(defun face-documentation (face)
556 557 558 559 560 561 562
  "Get the documentation string for FACE.
If FACE is a face-alias, get the documentation for the target face."
  (let ((alias (get face 'face-alias))
        doc)
    (if alias
        (progn
          (setq doc (get alias 'face-documentation))
563
	  (format "%s is an alias for the face `%s'.%s" face alias
564 565 566
                  (if doc (format "\n%s" doc)
                    "")))
      (get face 'face-documentation))))
Gerd Moellmann's avatar
Gerd Moellmann committed
567 568 569 570


(defun set-face-documentation (face string)
  "Set the documentation string for FACE to STRING."
571
  ;; Perhaps the text should go in DOC.
572
  (put face 'face-documentation (purecopy string)))
Gerd Moellmann's avatar
Gerd Moellmann committed
573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592


(defalias 'face-doc-string 'face-documentation)
(defalias 'set-face-doc-string 'set-face-documentation)



;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;; Setting face attributes.
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;


(defun set-face-attribute (face frame &rest args)
  "Set attributes of FACE on FRAME from ARGS.

FRAME nil means change attributes on all frames.  FRAME t means change
the default for new frames (this is done automatically each time an
attribute is changed on all frames).

ARGS must come in pairs ATTRIBUTE VALUE.  ATTRIBUTE must be a valid
Juanma Barranquero's avatar
Juanma Barranquero committed
593
face attribute name.  All attributes can be set to `unspecified';
Gerd Moellmann's avatar
Gerd Moellmann committed
594 595 596 597 598 599
this fact is not further mentioned below.

The following attributes are recognized:

`:family'

Chong Yidong's avatar
Chong Yidong committed
600
VALUE must be a string specifying the font family, e.g. ``monospace'',
Gerd Moellmann's avatar
Gerd Moellmann committed
601 602 603
or a fontset alias name.  If a font family is specified, wild-cards `*'
and `?' are allowed.

604 605 606 607 608 609
`:foundry'

VALUE must be a string specifying the font foundry,
e.g. ``adobe''.  If a font foundry is specified, wild-cards `*'
and `?' are allowed.

Gerd Moellmann's avatar
Gerd Moellmann committed
610 611 612 613 614 615 616 617 618
`:width'

VALUE specifies the relative proportionate width of the font to use.
It must be one of the symbols `ultra-condensed', `extra-condensed',
`condensed', `semi-condensed', `normal', `semi-expanded', `expanded',
`extra-expanded', or `ultra-expanded'.

`:height'

Miles Bader's avatar
Miles Bader committed
619 620 621 622
VALUE must be either an integer specifying the height of the font to use
in 1/10 pt, a floating point number specifying the amount by which to
scale any underlying face, or a function, which is called with the old
height (from the underlying face), and should return the new height.
Gerd Moellmann's avatar
Gerd Moellmann committed
623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671

`:weight'

VALUE specifies the weight of the font to use.  It must be one of the
symbols `ultra-bold', `extra-bold', `bold', `semi-bold', `normal',
`semi-light', `light', `extra-light', `ultra-light'.

`:slant'

VALUE specifies the slant of the font to use.  It must be one of the
symbols `italic', `oblique', `normal', `reverse-italic', or
`reverse-oblique'.

`:foreground', `:background'

VALUE must be a color name, a string.

`:underline'

VALUE specifies whether characters in FACE should be underlined.  If
VALUE is t, underline with foreground color of the face.  If VALUE is
a string, underline with that color.  If VALUE is nil, explicitly
don't underline.

`:overline'

VALUE specifies whether characters in FACE should be overlined.  If
VALUE is t, overline with foreground color of the face.  If VALUE is a
string, overline with that color.  If VALUE is nil, explicitly don't
overline.

`:strike-through'

VALUE specifies whether characters in FACE should be drawn with a line
striking through them.  If VALUE is t, use the foreground color of the
face.  If VALUE is a string, strike-through with that color.  If VALUE
is nil, explicitly don't strike through.

`:box'

VALUE specifies whether characters in FACE should have a box drawn
around them.  If VALUE is nil, explicitly don't draw boxes.  If
VALUE is t, draw a box with lines of width 1 in the foreground color
of the face.  If VALUE is a string, the string must be a color name,
and the box is drawn in that color with a line width of 1.  Otherwise,
VALUE must be a property list of the form `(:line-width WIDTH
:color COLOR :style STYLE)'.  If a keyword/value pair is missing from
the property list, a default value will be used for the value, as
specified below.  WIDTH specifies the width of the lines to draw; it
672 673 674
defaults to 1.  If WIDTH is negative, the absolute value is the width
of the lines, and draw top/bottom lines inside the characters area,
not around it.  COLOR is the name of the color to draw in, default is
Gerd Moellmann's avatar
Gerd Moellmann committed
675 676 677 678 679 680 681 682 683 684 685
the foreground color of the face for simple boxes, and the background
color of the face for 3D boxes.  STYLE specifies whether a 3D box
should be draw.  If STYLE is `released-button', draw a box looking
like a released 3D button.  If STYLE is `pressed-button' draw a box
that appears like a pressed button.  If STYLE is nil, the default if
the property list doesn't contain a style specification, draw a 2D
box.

`:inverse-video'

VALUE specifies whether characters in FACE should be displayed in
Dave Love's avatar
Dave Love committed
686
inverse video.  VALUE must be one of t or nil.
Gerd Moellmann's avatar
Gerd Moellmann committed
687 688 689 690 691 692 693 694 695 696

`:stipple'

If VALUE is a string, it must be the name of a file of pixmap data.
The directories listed in the `x-bitmap-file-path' variable are
searched.  Alternatively, VALUE 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.  VALUE nil means
explicitly don't use a stipple pattern.

697 698 699
For convenience, attributes `:family', `:foundry', `:width',
`:height', `:weight', and `:slant' may also be set in one step
from an X font name:
Gerd Moellmann's avatar
Gerd Moellmann committed
700 701 702 703 704 705 706 707 708

`:font'

Set font-related face attributes from VALUE.  VALUE must be a valid
XLFD font name.  If it is a font name pattern, the first matching font
will be used.

For compatibility with Emacs 20, keywords `:bold' and `:italic' can
be used to specify that a bold or italic font should be used.  VALUE
Miles Bader's avatar
Miles Bader committed
709 710 711 712 713 714 715
must be t or nil in that case.  A value of `unspecified' is not allowed.

`:inherit'

VALUE is the name of a face from which to inherit attributes, or a list
of face names.  Attributes from inherited faces are merged into the face
like an underlying face would be, with higher priority than underlying faces."
716 717 718 719
  (setq args (purecopy args))
  (let ((where (if (null frame) 0 frame))
	(spec args)
	family foundry)
720 721
    ;; If we set the new-frame defaults, this face is modified outside Custom.
    (if (memq where '(0 t))
722
	(put (or (get face 'face-alias) face) 'face-modified t))
723 724 725 726 727 728 729 730 731 732 733 734 735
    ;; If family and/or foundry are specified, set it first.  Certain
    ;; face attributes, e.g. :weight semi-condensed, are not supported
    ;; in every font.  See bug#1127.
    (while spec
      (cond ((eq (car spec) :family)
	     (setq family (cadr spec)))
	    ((eq (car spec) :foundry)
	     (setq foundry (cadr spec))))
      (setq spec (cddr spec)))
    (when (or family foundry)
      (when (and (stringp family)
		 (string-match "\\([^-]*\\)-\\([^-]*\\)" family))
	(unless foundry
736 737
	  (setq foundry (match-string 1 family)))
	(setq family (match-string 2 family)))
738
      (when (or (stringp family) (eq family 'unspecified))
739 740
	(internal-set-lisp-face-attribute face :family (purecopy family)
					  where))
741
      (when (or (stringp foundry) (eq foundry 'unspecified))
742 743
	(internal-set-lisp-face-attribute face :foundry (purecopy foundry)
					  where)))
744
    (while args
745
      (unless (memq (car args) '(:family :foundry))
746 747 748
	(internal-set-lisp-face-attribute face (car args)
					  (purecopy (cadr args))
					  where))
749
      (setq args (cddr args)))))
Gerd Moellmann's avatar
Gerd Moellmann committed
750

751
(defun make-face-bold (face &optional frame noerror)
Gerd Moellmann's avatar
Gerd Moellmann committed
752 753
  "Make the font of FACE be bold, if possible.
FRAME nil or not specified means change face on all frames.
754
Argument NOERROR is ignored and retained for compatibility.
Gerd Moellmann's avatar
Gerd Moellmann committed
755
Use `set-face-attribute' for finer control of the font weight."
Eli Zaretskii's avatar
Eli Zaretskii committed
756
  (interactive (list (read-face-name "Make which face bold")))
Gerd Moellmann's avatar
Gerd Moellmann committed
757 758 759
  (set-face-attribute face frame :weight 'bold))


760
(defun make-face-unbold (face &optional frame noerror)
Gerd Moellmann's avatar
Gerd Moellmann committed
761
  "Make the font of FACE be non-bold, if possible.
762 763
FRAME nil or not specified means change face on all frames.
Argument NOERROR is ignored and retained for compatibility."
Eli Zaretskii's avatar
Eli Zaretskii committed
764
  (interactive (list (read-face-name "Make which face non-bold")))
Gerd Moellmann's avatar
Gerd Moellmann committed
765 766
  (set-face-attribute face frame :weight 'normal))

Sam Steingold's avatar
Sam Steingold committed
767

768
(defun make-face-italic (face &optional frame noerror)
Gerd Moellmann's avatar
Gerd Moellmann committed
769 770
  "Make the font of FACE be italic, if possible.
FRAME nil or not specified means change face on all frames.
771
Argument NOERROR is ignored and retained for compatibility.
Gerd Moellmann's avatar
Gerd Moellmann committed
772
Use `set-face-attribute' for finer control of the font slant."
Eli Zaretskii's avatar
Eli Zaretskii committed
773
  (interactive (list (read-face-name "Make which face italic")))
Gerd Moellmann's avatar
Gerd Moellmann committed
774 775 776
  (set-face-attribute face frame :slant 'italic))


777
(defun make-face-unitalic (face &optional frame noerror)
Gerd Moellmann's avatar
Gerd Moellmann committed
778
  "Make the font of FACE be non-italic, if possible.
Dave Love's avatar
Dave Love committed
779 780
FRAME nil or not specified means change face on all frames.
Argument NOERROR is ignored and retained for compatibility."
Eli Zaretskii's avatar
Eli Zaretskii committed
781
  (interactive (list (read-face-name "Make which face non-italic")))
Gerd Moellmann's avatar
Gerd Moellmann committed
782 783
  (set-face-attribute face frame :slant 'normal))

Sam Steingold's avatar
Sam Steingold committed
784

785
(defun make-face-bold-italic (face &optional frame noerror)
Gerd Moellmann's avatar
Gerd Moellmann committed
786 787
  "Make the font of FACE be bold and italic, if possible.
FRAME nil or not specified means change face on all frames.
788
Argument NOERROR is ignored and retained for compatibility.
Gerd Moellmann's avatar
Gerd Moellmann committed
789
Use `set-face-attribute' for finer control of font weight and slant."
Eli Zaretskii's avatar
Eli Zaretskii committed
790
  (interactive (list (read-face-name "Make which face bold-italic")))
Gerd Moellmann's avatar
Gerd Moellmann committed
791 792 793 794 795 796
  (set-face-attribute face frame :weight 'bold :slant 'italic))


(defun set-face-font (face font &optional frame)
  "Change font-related attributes of FACE to those of FONT (a string).
FRAME nil or not specified means change face on all frames.
797 798 799
This sets the attributes `:family', `:foundry', `:width',
`:height', `:weight', and `:slant'.  When called interactively,
prompt for the face and font."
Gerd Moellmann's avatar
Gerd Moellmann committed
800 801 802 803 804 805 806 807 808 809 810
  (interactive (read-face-and-attribute :font))
  (set-face-attribute face frame :font font))


;; Implementation note: Emulating gray background colors with a
;; stipple pattern is now part of the face realization process, and is
;; done in C depending on the frame on which the face is realized.

(defun set-face-background (face color &optional frame)
  "Change the background color of face FACE to COLOR (a string).
FRAME nil or not specified means change face on all frames.
811 812 813
COLOR can be a system-defined color name (see `list-colors-display')
or a hex spec of the form #RRGGBB.
When called interactively, prompts for the face and color."
Gerd Moellmann's avatar
Gerd Moellmann committed
814
  (interactive (read-face-and-attribute :background))
815
  (set-face-attribute face frame :background (or color 'unspecified)))
Gerd Moellmann's avatar
Gerd Moellmann committed
816 817 818 819 820


(defun set-face-foreground (face color &optional frame)
  "Change the foreground color of face FACE to COLOR (a string).
FRAME nil or not specified means change face on all frames.
821 822 823
COLOR can be a system-defined color name (see `list-colors-display')
or a hex spec of the form #RRGGBB.
When called interactively, prompts for the face and color."
Gerd Moellmann's avatar
Gerd Moellmann committed
824
  (interactive (read-face-and-attribute :foreground))
825
  (set-face-attribute face frame :foreground (or color 'unspecified)))
Gerd Moellmann's avatar
Gerd Moellmann committed
826 827 828 829 830


(defun set-face-stipple (face stipple &optional frame)
  "Change the stipple pixmap of face FACE to STIPPLE.
FRAME nil or not specified means change face on all frames.
Dave Love's avatar
Dave Love committed
831
STIPPLE should be a string, the name of a file of pixmap data.
Gerd Moellmann's avatar
Gerd Moellmann committed
832 833 834 835 836 837
The directories listed in the `x-bitmap-file-path' variable are searched.

Alternatively, STIPPLE 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."
  (interactive (read-face-and-attribute :stipple))
838
  (set-face-attribute face frame :stipple (or stipple 'unspecified)))
Gerd Moellmann's avatar
Gerd Moellmann committed
839 840


841
(defun set-face-underline-p (face underline &optional frame)
Gerd Moellmann's avatar
Gerd Moellmann committed
842 843 844 845 846 847 848 849 850 851
  "Specify whether face FACE is underlined.
UNDERLINE nil means FACE explicitly doesn't underline.
UNDERLINE non-nil means FACE explicitly does underlining
with the same of the foreground color.
If UNDERLINE is a string, underline with the color named UNDERLINE.
FRAME nil or not specified means change face on all frames.
Use `set-face-attribute' to ``unspecify'' underlining."
  (interactive
   (let ((list (read-face-and-attribute :underline)))
     (list (car list) (eq (car (cdr list)) t))))
852
  (set-face-attribute face frame :underline underline))
Gerd Moellmann's avatar
Gerd Moellmann committed
853

854 855 856
(define-obsolete-function-alias 'set-face-underline
                                'set-face-underline-p "22.1")

Gerd Moellmann's avatar
Gerd Moellmann committed
857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896

(defun set-face-inverse-video-p (face inverse-video-p &optional frame)
  "Specify whether face FACE is in inverse video.
INVERSE-VIDEO-P non-nil means FACE displays explicitly in inverse video.
INVERSE-VIDEO-P nil means FACE explicitly is not in inverse video.
FRAME nil or not specified means change face on all frames.
Use `set-face-attribute' to ``unspecify'' the inverse video attribute."
  (interactive
   (let ((list (read-face-and-attribute :inverse-video)))
     (list (car list) (eq (car (cdr list)) t))))
  (set-face-attribute face frame :inverse-video inverse-video-p))


(defun set-face-bold-p (face bold-p &optional frame)
  "Specify whether face FACE is bold.
BOLD-P non-nil means FACE should explicitly display bold.
BOLD-P nil means FACE should explicitly display non-bold.
FRAME nil or not specified means change face on all frames.
Use `set-face-attribute' or `modify-face' for finer control."
  (if (null bold-p)
      (make-face-unbold face frame)
    (make-face-bold face frame)))


(defun set-face-italic-p (face italic-p &optional frame)
  "Specify whether face FACE is italic.
ITALIC-P non-nil means FACE should explicitly display italic.
ITALIC-P nil means FACE should explicitly display non-italic.
FRAME nil or not specified means change face on all frames.
Use `set-face-attribute' or `modify-face' for finer control."
  (if (null italic-p)
      (make-face-unitalic face frame)
    (make-face-italic face frame)))


(defalias 'set-face-background-pixmap 'set-face-stipple)


(defun invert-face (face &optional frame)
  "Swap the foreground and background colors of FACE.
897
If FRAME is omitted or nil, it means change face on all frames.
Gerd Moellmann's avatar
Gerd Moellmann committed
898 899 900
If FACE specifies neither foreground nor background color,
set its foreground and background to the background and foreground
of the default face.  Value is FACE."
Eli Zaretskii's avatar
Eli Zaretskii committed
901
  (interactive (list (read-face-name "Invert face")))
Gerd Moellmann's avatar
Gerd Moellmann committed
902 903
  (let ((fg (face-attribute face :foreground frame))
	(bg (face-attribute face :background frame)))
904
    (if (not (and (eq fg 'unspecified) (eq bg 'unspecified)))
Gerd Moellmann's avatar
Gerd Moellmann committed
905 906 907 908 909 910 911 912 913 914 915 916 917
	(set-face-attribute face frame :foreground bg :background fg)
      (set-face-attribute face frame
			  :foreground
			  (face-attribute 'default :background frame)
			  :background
			  (face-attribute 'default :foreground frame))))
  face)


;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;;; Interactively modifying faces.
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;

918
(defun read-face-name (prompt &optional default multiple)
919
  "Read a face, defaulting to the face or faces on the char after point.
920
If it has the property `read-face-name', that overrides the `face' property.
921 922
PROMPT should be a string that describes what the caller will do with the face;
it should not end in a space.
923 924 925
The optional argument DEFAULT provides the value to display in the
minibuffer prompt that is returned if the user just types RET
unless DEFAULT is a string (in which case nil is returned).
926 927 928 929
If MULTIPLE is non-nil, return a list of faces (possibly only one).
Otherwise, return a single face."
  (let ((faceprop (or (get-char-property (point) 'read-face-name)
		      (get-char-property (point) 'face)))
930 931
        (aliasfaces nil)
        (nonaliasfaces nil)
932
	faces)
933 934 935 936
    ;; Try to get a face name from the buffer.
    (if (memq (intern-soft (thing-at-point 'symbol)) (face-list))
	(setq faces (list (intern-soft (thing-at-point 'symbol)))))
    ;; Add the named faces that the `face' property uses.
937 938 939 940
    (if (and (listp faceprop)
	     ;; Don't treat an attribute spec as a list of faces.
	     (not (keywordp (car faceprop)))
	     (not (memq (car faceprop) '(foreground-color background-color))))
941 942 943 944
	(dolist (f faceprop)
	  (if (symbolp f)
	      (push f faces)))
      (if (symbolp faceprop)
945
	  (push faceprop faces)))
946
    (delete-dups faces)
947

948 949 950 951 952 953 954
    ;; Build up the completion tables.
    (mapatoms (lambda (s)
                (if (custom-facep s)
                    (if (get s 'face-alias)
                        (push (symbol-name s) aliasfaces)
                      (push (symbol-name s) nonaliasfaces)))))

955 956 957 958 959
    ;; If we only want one, and the default is more than one,
    ;; discard the unwanted ones now.
    (unless multiple
      (if faces
	  (setq faces (list (car faces)))))
960
    (require 'crm)
961 962
    (let* ((input
	    ;; Read the input.
963
	    (completing-read-multiple
964 965
	     (if (or faces default)
		 (format "%s (default `%s'): " prompt
966
			 (if faces (mapconcat 'symbol-name faces ",")
967
			   default))
968
	       (format "%s: " prompt))
969
	     (completion-table-in-turn nonaliasfaces aliasfaces)
970
	     nil t nil 'face-name-history
971
	     (if faces (mapconcat 'symbol-name faces ","))))
972 973
	   ;; Canonicalize the output.
	   (output
974
	    (cond ((or (equal input "") (equal input '("")))
975
		   (or faces (unless (stringp default) default)))
976 977 978 979 980
		  ((stringp input)
		   (mapcar 'intern (split-string input ", *" t)))
		  ((listp input)
		   (mapcar 'intern input))
		  (input))))
981 982 983 984 985
      ;; Return either a list of faces or just one face.
      (if multiple
	  output
	(car output)))))

986 987
;; Not defined without X, but behind window-system test.
(defvar x-bitmap-file-path)
988

Gerd Moellmann's avatar
Gerd Moellmann committed
989 990 991
(defun face-valid-attribute-values (attribute &optional frame)
  "Return valid values for face attribute ATTRIBUTE.
The optional argument FRAME is used to determine available fonts
Juanma Barranquero's avatar
Juanma Barranquero committed
992 993 994
and colors.  If it is nil or not specified, the selected frame is used.
Value is an alist of (NAME . VALUE) if ATTRIBUTE expects a value out
of a set of discrete values.  Value is `integerp' if ATTRIBUTE expects
Gerd Moellmann's avatar
Gerd Moellmann committed
995
an integer value."
Sam Steingold's avatar
Sam Steingold committed
996 997 998
  (let ((valid
         (case attribute
           (:family
999
            (if (window-system frame)
1000
                (mapcar (lambda (x) (cons x x))
1001
                        (font-family-list))
Sam Steingold's avatar
Sam Steingold committed
1002 1003
	      ;; Only one font on TTYs.
	      (list (cons "default" "default"))))
1004 1005
           (:foundry
	    (list nil))
1006
	   (:width
1007
	    (mapcar #'(lambda (x) (cons (symbol-name (aref x 1)) (aref x 1)))
1008 1009
		    font-width-table))
           (:weight
1010
	    (mapcar #'(lambda (x) (cons (symbol-name (aref x 1)) (aref x 1)))
1011 1012
		    font-weight-table))
	   (:slant
1013
	    (mapcar #'(lambda (x) (cons (symbol-name (aref x 1)) (aref x 1)))
1014 1015 1016 1017
		    font-slant-table))
	   (:inverse-video
	    (mapcar #'(lambda (x) (cons (symbol-name x) x))
		    (internal-lisp-face-attribute-values attribute)))
Sam Steingold's avatar
Sam Steingold committed
1018
           ((:underline :overline :strike-through :box)
1019
            (if (window-system frame)
Sam Steingold's avatar
Sam Steingold committed
1020 1021 1022
                (nconc (mapcar #'(lambda (x) (cons (symbol-name x) x))
                               (internal-lisp-face-attribute-values attribute))
                       (mapcar #'(lambda (c) (cons c c))
1023
                               (defined-colors frame)))
Sam Steingold's avatar
Sam Steingold committed
1024 1025 1026 1027 1028 1029 1030 1031
	      (mapcar #'(lambda (x) (cons (symbol-name x) x))
		      (internal-lisp-face-attribute-values attribute))))
           ((:foreground :background)
            (mapcar #'(lambda (c) (cons c c))
                    (defined-colors frame)))
           ((:height)
            'integerp)
           (:stipple
1032
            (and (memq (window-system frame) '(x ns)) ; No stipple on w32
Sam Steingold's avatar
Sam Steingold committed
1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045
                 (mapcar #'list
                         (apply #'nconc
                                (mapcar (lambda (dir)
                                          (and (file-readable-p dir)
                                               (file-directory-p dir)
                                               (directory-files dir)))
                                        x-bitmap-file-path)))))
           (:inherit
            (cons '("none" . nil)
                  (mapcar #'(lambda (c) (cons (symbol-name c) c))
                          (face-list))))
           (t
            (error "Internal error")))))
Miles Bader's avatar
Miles Bader committed
1046
    (if (and (listp valid) (not (memq attribute '(:inherit))))
1047 1048
	(nconc (list (cons "unspecified" 'unspecified)) valid)
      valid)))
Gerd Moellmann's avatar
Gerd Moellmann committed
1049 1050


1051
(defconst face-attribute-name-alist
Gerd Moellmann's avatar
Gerd Moellmann committed
1052
  '((:family . "font family")
1053
    (:foundry . "font foundry")
Gerd Moellmann's avatar
Gerd Moellmann committed
1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064
    (:width . "character set width")
    (:height . "height in 1/10 pt")
    (:weight . "weight")
    (:slant . "slant")
    (:underline . "underline")
    (:overline . "overline")
    (:strike-through . "strike-through")
    (:box . "box")
    (:inverse-video . "inverse-video display")
    (:foreground . "foreground color")
    (:background . "background color")
Miles Bader's avatar
Miles Bader committed
1065 1066
    (:stipple . "background stipple")
    (:inherit . "inheritance"))
Gerd Moellmann's avatar
Gerd Moellmann committed
1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079
  "An alist of descriptive names for face attributes.
Each element has the form (ATTRIBUTE-NAME . DESCRIPTION) where
ATTRIBUTE-NAME is a face attribute name (a keyword symbol), and
DESCRIPTION is a descriptive name for ATTRIBUTE-NAME.")


(defun face-descriptive-attribute-name (attribute)
  "Return a descriptive name for ATTRIBUTE."
  (cdr (assq attribute face-attribute-name-alist)))


(defun face-read-string (face default name &optional completion-alist)
  "Interactively read a face attribute string value.
Miles Bader's avatar
Miles Bader committed
1080 1081 1082 1083
FACE is the face whose attribute is read.  If non-nil, DEFAULT is the
default string to return if no new value is entered.  NAME is a
descriptive name of the attribute for prompting.  COMPLETION-ALIST is an
alist of valid values, if non-nil.
Gerd Moellmann's avatar
Gerd Moellmann committed
1084

Miles Bader's avatar
Miles Bader committed
1085
Entering nothing accepts the default string DEFAULT.
Gerd Moellmann's avatar
Gerd Moellmann committed
1086
Value is the new attribute value."
Miles Bader's avatar
Miles Bader committed
1087 1088 1089
  ;; Capitalize NAME (we don't use `capitalize' because that capitalizes
  ;; each word in a string separately).
  (setq name (concat (upcase (substring name 0 1)) (substring name 1)))
Gerd Moellmann's avatar
Gerd Moellmann committed
1090 1091 1092
  (let* ((completion-ignore-case t)
	 (value (completing-read
		 (if default
Miles Bader's avatar
Miles Bader committed
1093 1094 1095
		     (format "%s for face `%s' (default %s): "
			     name face default)
		   (format "%s for face `%s': " name face))
1096
		 completion-alist nil nil nil nil default)))
1097
    (if (equal value "") default value)))
Gerd Moellmann's avatar
Gerd Moellmann committed
1098 1099 1100 1101 1102 1103 1104


(defun face-read-integer (face default name)
  "Interactively read an integer face attribute value.
FACE is the face whose attribute is read.  DEFAULT is the default
value to return if no new value is entered.  NAME is a descriptive
name of the attribute for prompting.  Value is the new attribute value."
1105 1106
  (let ((new-value
	 (face-read-string face
Miles Bader's avatar
Miles Bader committed
1107
			   (format "%s" default)
1108 1109
			   name
			   (list (cons "unspecified" 'unspecified)))))
Miles Bader's avatar
Miles Bader committed
1110 1111 1112 1113 1114
    (cond ((equal new-value "unspecified")
	   'unspecified)
	  ((member new-value '("unspecified-fg" "unspecified-bg"))
	   new-value)
	  (t
Juanma Barranquero's avatar