faces.el 96.7 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-1996, 1998-2012  Free Software Foundation, Inc.
Eric S. Raymond's avatar
Eric S. Raymond committed
4

5
;; Maintainer: FSF
Pavel Janík's avatar
Pavel Janík committed
6
;; Keywords: internal
7
;; Package: emacs
8

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

11
;; GNU Emacs is free software: you can redistribute it and/or modify
Eric S. Raymond's avatar
Eric S. Raymond committed
12
;; it under the terms of the GNU General Public License as published by
13 14
;; 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
15 16 17 18 19 20 21

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

;;; Commentary:

;;; Code:

28
(eval-when-compile
29 30
  (require 'cl))

31 32 33 34 35 36 37 38 39 40
(defcustom term-file-prefix (purecopy "term/")
  "If non-nil, Emacs startup performs terminal-specific initialization.
It does this by: (load (concat term-file-prefix (getenv \"TERM\")))

You may set this variable to nil in your init file if you do not wish
the terminal-initialization file to be loaded."
  :type '(choice (const :tag "No terminal-specific initialization" nil)
		 (string :tag "Name of directory with term files"))
  :group 'terminals)

Glenn Morris's avatar
Glenn Morris committed
41
(declare-function xw-defined-colors "term/common-win" (&optional frame))
Gerd Moellmann's avatar
Gerd Moellmann committed
42

43
(defvar help-xref-stack-item)
44 45 46 47 48 49

(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
50 51 52 53 54 55 56 57 58 59 60 61

;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;;; 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
62
  "A list specifying how face font selection chooses fonts.
Gerd Moellmann's avatar
Gerd Moellmann committed
63 64
Each of the four symbols `:width', `:height', `:weight', and `:slant'
must appear once in the list, and the list must not contain any other
65
elements.  Font selection first tries to find a best matching font
66
for those face attributes that appear before in the list.  For
Gerd Moellmann's avatar
Gerd Moellmann committed
67 68 69
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
70
  :tag "Font selection order"
Gerd Moellmann's avatar
Gerd Moellmann committed
71
  :type '(list symbol symbol symbol symbol)
Gerd Moellmann's avatar
Gerd Moellmann committed
72 73 74 75 76
  :group 'font-selection
  :set #'(lambda (symbol value)
	   (set-default symbol value)
	   (internal-set-font-selection-order value)))

77

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


99 100
;; This is defined originally in xfaces.c.
(defcustom face-font-registry-alternatives
101
  (mapcar (lambda (arg) (mapcar 'purecopy arg))
102
  (if (eq system-type 'windows-nt)
103
      '(("iso8859-1" "ms-oemlatin")
104
	("gb2312.1980" "gb2312" "gbk" "gb18030")
105 106 107
	("jisx0208.1990" "jisx0208.1983" "jisx0208.1978")
	("ksc5601.1989" "ksx1001.1992" "ksc5601.1987")
	("muletibetan-2" "muletibetan-0"))
108
    '(("gb2312.1980" "gb2312.80&gb8565.88" "gbk" "gb18030")
109 110
      ("jisx0208.1990" "jisx0208.1983" "jisx0208.1978")
      ("ksc5601.1989" "ksx1001.1992" "ksc5601.1987")
111
      ("muletibetan-2" "muletibetan-0"))))
Lute Kamstra's avatar
Lute Kamstra committed
112
  "Alist of alternative font registry names.
Pavel Janík's avatar
Pavel Janík committed
113
Each element has the form (REGISTRY ALTERNATIVE1 ALTERNATIVE2 ...).
114 115 116
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
117
  :tag "Alternative font registries to try"
118
  :type '(repeat (repeat string))
119
  :version "21.1"
120 121 122 123 124
  :group 'font-selection
  :set #'(lambda (symbol value)
	   (set-default symbol value)
	   (internal-set-alternative-font-registry-alist value)))

125

Gerd Moellmann's avatar
Gerd Moellmann committed
126 127 128 129 130 131
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;;; Creation, copying.
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;


(defun face-list ()
132
  "Return a list of all defined faces."
Gerd Moellmann's avatar
Gerd Moellmann committed
133 134 135 136
  (mapcar #'car face-new-frame-defaults))

(defun make-face (face &optional no-init-from-resources)
  "Define a new face with name FACE, a symbol.
137 138 139 140 141
Do not call this directly from Lisp code; use `defface' instead.

If NO-INIT-FROM-RESOURCES is non-nil, don't initialize face
attributes from X resources.  If FACE is already known as a face,
leave it unmodified.  Return FACE."
142 143
  (interactive (list (read-from-minibuffer
		      "Make face: " nil nil t 'face-name-history)))
Gerd Moellmann's avatar
Gerd Moellmann committed
144 145 146 147 148 149 150 151 152 153 154 155 156 157
  (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.
158
Do not call this directly from Lisp code; use `defface' instead."
159 160
  (interactive (list (read-from-minibuffer
		      "Make empty face: " nil nil t 'face-name-history)))
Gerd Moellmann's avatar
Gerd Moellmann committed
161 162 163
  (make-face face 'no-init-from-resources))

(defun copy-face (old-face new-face &optional frame new-frame)
164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179
  "Define a face named NEW-FACE, which is a copy of OLD-FACE.
This function does not copy face customization data, so NEW-FACE
will not be made customizable.  Most Lisp code should not call
this function; use `defface' with :inherit instead.

If NEW-FACE already exists as a face, modify it to be like
OLD-FACE.  If NEW-FACE doesn't already exist, create it.

If the optional argument FRAME is a frame, change NEW-FACE on
FRAME only.  If FRAME is t, copy the frame-independent default
specification for OLD-FACE to NEW-FACE.  If FRAME is nil, copy
the defaults as well as the faces on each existing frame.

If the optional fourth argument NEW-FRAME is given, copy the
information from face OLD-FACE on frame FRAME to NEW-FACE on
frame NEW-FRAME.  In this case, FRAME must not be nil."
Gerd Moellmann's avatar
Gerd Moellmann committed
180 181 182
  (let ((inhibit-quit t))
    (if (null frame)
	(progn
183 184 185 186
	  (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
187 188 189
	  (dolist (frame (frame-list))
	    (copy-face old-face new-face frame))
	  (copy-face old-face new-face t))
190
      (make-empty-face new-face)
Gerd Moellmann's avatar
Gerd Moellmann committed
191 192 193 194 195 196 197 198 199
      (internal-copy-lisp-face old-face new-face frame new-frame))
    new-face))

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

(defun facep (face)
Richard M. Stallman's avatar
Richard M. Stallman committed
200 201
  "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
202 203 204 205 206 207 208 209 210 211 212 213 214 215 216
  (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.

217
(defun face-id (face &optional _frame)
Juanma Barranquero's avatar
Juanma Barranquero committed
218
  "Return the internal ID of face with name FACE.
219
If FACE is a face-alias, return the ID of the target face.
Richard M. Stallman's avatar
Richard M. Stallman committed
220 221
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
222
  (check-face face)
223 224
  (or (get face 'face)
      (face-id (get face 'face-alias))))
Gerd Moellmann's avatar
Gerd Moellmann committed
225 226 227 228

(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.
229 230
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
231 232 233 234 235
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)
236
  "Return non-nil if FACE displays differently from the default face.
Gerd Moellmann's avatar
Gerd Moellmann committed
237 238
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).
239
If FRAME is omitted or nil, use the selected frame."
240
  (let ((attrs
241
	 (delq :inherit (mapcar 'car face-attribute-name-alist)))
242 243 244 245 246 247 248 249 250 251
	(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
252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267


(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
268 269 270
  (mapcar
   (lambda (arg)
     ;; FIXME; can we purecopy some of the conses too?
271 272
     (cons (car arg)
	   (cons (purecopy (car (cdr arg))) (purecopy (cdr (cdr arg))))))
Gerd Moellmann's avatar
Gerd Moellmann committed
273
  '((:family (".attributeFamily" . "Face.AttributeFamily"))
274
    (:foundry (".attributeFoundry" . "Face.AttributeFoundry"))
Gerd Moellmann's avatar
Gerd Moellmann committed
275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290
    (: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"))
291
    (:font (".attributeFont" . "Face.AttributeFont"))
292
    (:inherit (".attributeInherit" . "Face.AttributeInherit"))))
Lute Kamstra's avatar
Lute Kamstra committed
293
  "List of X resources and classes for face attributes.
Gerd Moellmann's avatar
Gerd Moellmann committed
294 295
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
296
\(RESOURCE . CLASS) with RESOURCE being the resource and CLASS being the
Gerd Moellmann's avatar
Gerd Moellmann committed
297
X resource class for the attribute."
298
  :type '(repeat (cons symbol (repeat (cons string string))))
Gerd Moellmann's avatar
Gerd Moellmann committed
299 300 301
  :group 'faces)


302 303 304 305 306 307
(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
308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327
(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."
328
  (when (memq (framep frame) '(x w32))
Gerd Moellmann's avatar
Gerd Moellmann committed
329 330 331 332 333
    (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
334 335


Gerd Moellmann's avatar
Gerd Moellmann committed
336 337 338 339 340 341 342 343 344 345 346 347 348 349
(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.
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;

350
(defun face-name (face)
Eric S. Raymond's avatar
Eric S. Raymond committed
351
  "Return the name of face FACE."
Gerd Moellmann's avatar
Gerd Moellmann committed
352 353 354
  (symbol-name (check-face face)))


355 356 357
(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).
358
If FRAME is omitted or nil the value describes the default attributes,
359 360
but if you specify FRAME, the value describes the attributes
of FACE on FRAME."
361 362 363
  (mapcar (lambda (pair)
	    (let ((attr (car pair)))
	      (cons attr (face-attribute face attr (or frame t)))))
364 365
  	  face-attribute-name-alist))

366
(defun face-attribute (face attribute &optional frame inherit)
Gerd Moellmann's avatar
Gerd Moellmann committed
367 368 369
  "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).
370
If FRAME is omitted or nil, use the selected frame.
Gerd Moellmann's avatar
Gerd Moellmann committed
371

372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388
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))
389 390 391 392 393
          (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)))))
394 395 396
    (when (and inherit
	       (not (eq inherit t))
	       (face-attribute-relative-p attribute value))
397
      ;; We should merge with INHERIT as well
398 399
      (setq value (face-attribute-merged-with attribute value inherit frame)))
    value))
Gerd Moellmann's avatar
Gerd Moellmann committed
400

401 402 403
(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.
404
\[This is an internal function.]"
405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429
  (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
430 431 432
  "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).
433
If FRAME is omitted or nil, use the selected frame.
Gerd Moellmann's avatar
Gerd Moellmann committed
434

435 436 437 438 439 440 441 442 443 444 445 446 447 448 449
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
450 451 452
  "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).
453
If FRAME is omitted or nil, use the selected frame.
Gerd Moellmann's avatar
Gerd Moellmann committed
454

455 456 457 458 459 460 461 462 463 464 465 466 467 468 469
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
470 471 472
 "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).
473 474 475 476 477 478 479 480 481 482 483 484 485 486 487
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
488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515


(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)))
516
    (memq bold '(semi-bold bold extra-bold ultra-bold))))
Gerd Moellmann's avatar
Gerd Moellmann committed
517 518 519 520 521 522 523 524 525


(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)))
526
    (memq italic '(italic oblique))))
Sam Steingold's avatar
Sam Steingold committed
527

Gerd Moellmann's avatar
Gerd Moellmann committed
528 529 530 531 532 533 534

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

(defun face-documentation (face)
535 536 537 538 539 540 541
  "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))
542
	  (format "%s is an alias for the face `%s'.%s" face alias
543 544 545
                  (if doc (format "\n%s" doc)
                    "")))
      (get face 'face-documentation))))
Gerd Moellmann's avatar
Gerd Moellmann committed
546 547 548 549


(defun set-face-documentation (face string)
  "Set the documentation string for FACE to STRING."
550
  ;; Perhaps the text should go in DOC.
551
  (put face 'face-documentation (purecopy string)))
Gerd Moellmann's avatar
Gerd Moellmann committed
552 553 554 555 556 557 558 559 560 561 562 563 564 565


(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.
566 567
This function overrides the face attributes specified by FACE's
face spec.  It is mostly intended for internal use only.
Gerd Moellmann's avatar
Gerd Moellmann committed
568

569 570 571
If FRAME is nil, set the attributes for all existing frames, as
well as the default for new frames.  If FRAME is t, change the
default for new frames only.
Gerd Moellmann's avatar
Gerd Moellmann committed
572

573 574 575
ARGS must come in pairs ATTRIBUTE VALUE.  ATTRIBUTE must be a
valid face attribute name.  All attributes can be set to
`unspecified'; this fact is not further mentioned below.
Gerd Moellmann's avatar
Gerd Moellmann committed
576 577 578 579 580

The following attributes are recognized:

`:family'

581 582
VALUE must be a string specifying the font family
\(e.g. \"Monospace\") or a fontset.
Gerd Moellmann's avatar
Gerd Moellmann committed
583

584 585 586 587 588 589
`: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
590 591 592 593 594 595 596 597 598
`: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'

599 600 601
VALUE specifies the relative or absolute height of the font.  An
absolute height is an integer, and specifies font height in units
of 1/10 pt.  A relative height is either a floating point number,
602
which specifies a scaling factor for the underlying face height;
603 604 605
or a function that takes a single argument (the underlying face
height) and returns the new height.  Note that for the `default'
face, you must specify an absolute height (since there is nothing
606
for it to be relative to).
Gerd Moellmann's avatar
Gerd Moellmann committed
607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625

`: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'

626 627 628 629 630 631 632 633 634 635 636 637 638 639 640
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.

Otherwise, VALUE must be a property list of the form:

`(:color COLOR :style STYLE)'.

COLOR can be a either a color name string or `foreground-color'.
STYLE can be either `line' or `wave'.
If a keyword/value pair is missing from the property list, a
default value will be used for the value.
The default value of COLOR is the foreground color of the face.
The default value of STYLE is `line'.
Gerd Moellmann's avatar
Gerd Moellmann committed
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

`: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
667 668 669
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
670 671 672 673 674 675 676 677 678 679 680
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
681
inverse video.  VALUE must be one of t or nil.
Gerd Moellmann's avatar
Gerd Moellmann committed
682 683 684 685 686 687 688 689 690 691

`: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.

692 693 694
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
695 696 697

`:font'

698 699 700 701
Set font-related face attributes from VALUE.  VALUE must be a
valid font name or font object.  Setting this attribute will also
set the `:family', `:foundry', `:width', `:height', `:weight',
and `:slant' attributes.
Miles Bader's avatar
Miles Bader committed
702 703 704

`:inherit'

705 706 707 708 709 710 711 712 713 714 715 716 717
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.

For backward compatibility, the keywords `:bold' and `:italic'
can be used to specify weight and slant respectively.  This usage
is considered obsolete.  For these two keywords, the VALUE must
be either t or nil.  A value of t for `:bold' is equivalent to
setting `:weight' to `bold', and a value of t for `:italic' is
equivalent to setting `:slant' to `italic'.  But if `:weight' is
specified in the face spec, `:bold' is ignored, and if `:slant'
is specified, `:italic' is ignored."
718 719 720 721
  (setq args (purecopy args))
  (let ((where (if (null frame) 0 frame))
	(spec args)
	family foundry)
722 723
    ;; If we set the new-frame defaults, this face is modified outside Custom.
    (if (memq where '(0 t))
724
	(put (or (get face 'face-alias) face) 'face-modified t))
725 726 727 728 729 730 731 732 733 734 735 736 737
    ;; 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
738 739
	  (setq foundry (match-string 1 family)))
	(setq family (match-string 2 family)))
740
      (when (or (stringp family) (eq family 'unspecified))
741 742
	(internal-set-lisp-face-attribute face :family (purecopy family)
					  where))
743
      (when (or (stringp foundry) (eq foundry 'unspecified))
744 745
	(internal-set-lisp-face-attribute face :foundry (purecopy foundry)
					  where)))
746
    (while args
747
      (unless (memq (car args) '(:family :foundry))
748 749 750
	(internal-set-lisp-face-attribute face (car args)
					  (purecopy (cadr args))
					  where))
751
      (setq args (cddr args)))))
Gerd Moellmann's avatar
Gerd Moellmann committed
752

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


762
(defun make-face-unbold (face &optional frame _noerror)
Gerd Moellmann's avatar
Gerd Moellmann committed
763
  "Make the font of FACE be non-bold, if possible.
764 765
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
766
  (interactive (list (read-face-name "Make which face non-bold")))
Gerd Moellmann's avatar
Gerd Moellmann committed
767 768
  (set-face-attribute face frame :weight 'normal))

Sam Steingold's avatar
Sam Steingold committed
769

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


779
(defun make-face-unitalic (face &optional frame _noerror)
Gerd Moellmann's avatar
Gerd Moellmann committed
780
  "Make the font of FACE be non-italic, if possible.
Dave Love's avatar
Dave Love committed
781 782
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
783
  (interactive (list (read-face-name "Make which face non-italic")))
Gerd Moellmann's avatar
Gerd Moellmann committed
784 785
  (set-face-attribute face frame :slant 'normal))

Sam Steingold's avatar
Sam Steingold committed
786

787
(defun make-face-bold-italic (face &optional frame _noerror)
Gerd Moellmann's avatar
Gerd Moellmann committed
788 789
  "Make the font of FACE be bold and italic, if possible.
FRAME nil or not specified means change face on all frames.
790
Argument NOERROR is ignored and retained for compatibility.
Gerd Moellmann's avatar
Gerd Moellmann committed
791
Use `set-face-attribute' for finer control of font weight and slant."
Eli Zaretskii's avatar
Eli Zaretskii committed
792
  (interactive (list (read-face-name "Make which face bold-italic")))
Gerd Moellmann's avatar
Gerd Moellmann committed
793 794 795 796 797 798
  (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.
799 800 801
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
802 803 804 805 806 807 808 809 810 811 812
  (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.
813 814 815
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
816
  (interactive (read-face-and-attribute :background))
817
  (set-face-attribute face frame :background (or color 'unspecified)))
Gerd Moellmann's avatar
Gerd Moellmann committed
818 819 820 821 822


(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.
823 824 825
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
826
  (interactive (read-face-and-attribute :foreground))
827
  (set-face-attribute face frame :foreground (or color 'unspecified)))
Gerd Moellmann's avatar
Gerd Moellmann committed
828 829 830 831 832


(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
833
STIPPLE should be a string, the name of a file of pixmap data.
Gerd Moellmann's avatar
Gerd Moellmann committed
834 835 836 837 838 839
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))
840
  (set-face-attribute face frame :stipple (or stipple 'unspecified)))
Gerd Moellmann's avatar
Gerd Moellmann committed
841 842


843
(defun set-face-underline-p (face underline &optional frame)
Gerd Moellmann's avatar
Gerd Moellmann committed
844 845 846 847 848 849 850 851 852 853
  "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))))
854
  (set-face-attribute face frame :underline underline))
Gerd Moellmann's avatar
Gerd Moellmann committed
855

856 857 858
(define-obsolete-function-alias 'set-face-underline
                                'set-face-underline-p "22.1")

Gerd Moellmann's avatar
Gerd Moellmann committed
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 897 898

(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.
899
If FRAME is omitted or nil, it means change face on all frames.
Gerd Moellmann's avatar
Gerd Moellmann committed
900 901 902
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
903
  (interactive (list (read-face-name "Invert face")))
Gerd Moellmann's avatar
Gerd Moellmann committed
904 905
  (let ((fg (face-attribute face :foreground frame))
	(bg (face-attribute face :background frame)))
906
    (if (not (and (eq fg 'unspecified) (eq bg 'unspecified)))
Gerd Moellmann's avatar
Gerd Moellmann committed
907 908 909 910 911 912 913 914 915 916 917 918 919
	(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.
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;

920
(defun read-face-name (prompt &optional default multiple)
921
  "Read a face, defaulting to the face or faces on the char after point.
922
If it has the property `read-face-name', that overrides the `face' property.
923 924
PROMPT should be a string that describes what the caller will do with the face;
it should not end in a space.
925 926 927
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).
928 929 930 931
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)))
932 933
        (aliasfaces nil)
        (nonaliasfaces nil)
934
	faces)
935 936 937 938
    ;; 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.
939 940 941 942
    (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))))
943 944 945 946
	(dolist (f faceprop)
	  (if (symbolp f)
	      (push f faces)))
      (if (symbolp faceprop)
947
	  (push faceprop faces)))
948
    (delete-dups faces)
949

950 951 952 953 954 955 956
    ;; 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)))))

957 958 959 960 961
    ;; 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)))))
962
    (require 'crm)
963 964
    (let* ((input
	    ;; Read the input.
965
	    (completing-read-multiple
966 967
	     (if (or faces default)
		 (format "%s (default `%s'): " prompt
968
			 (if faces (mapconcat 'symbol-name faces ",")
969
			   default))
970
	       (format "%s: " prompt))
971
	     (completion-table-in-turn nonaliasfaces aliasfaces)
972
	     nil t nil 'face-name-history
973
	     (if faces (mapconcat 'symbol-name faces ","))))
974 975
	   ;; Canonicalize the output.
	   (output
976
	    (cond ((or (equal input "") (equal input '("")))
977
		   (or faces (unless (stringp default) default)))
978 979 980 981 982
		  ((stringp input)
		   (mapcar 'intern (split-string input ", *" t)))
		  ((listp input)
		   (mapcar 'intern input))
		  (input))))
983 984 985 986 987
      ;; Return either a list of faces or just one face.
      (if multiple
	  output
	(car output)))))

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

Gerd Moellmann's avatar
Gerd Moellmann committed
991 992 993
(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
994 995 996
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
997
an integer value."
Sam Steingold's avatar
Sam Steingold committed
998 999 1000
  (let ((valid
         (case attribute
           (:family
1001
            (if (window-system frame)
1002
                (mapcar (lambda (x) (cons x x))
1003
                        (font-family-list))
Sam Steingold's avatar
Sam Steingold committed
1004 1005
	      ;; Only one font on TTYs.
	      (list (cons "default" "default"))))
1006 1007
           (:foundry
	    (list nil))
1008
	   (:width
1009
	    (mapcar #'(lambda (x) (cons (symbol-name (aref x 1)) (aref x 1)))
1010 1011
		    font-width-table))
           (:weight
1012
	    (mapcar #'(lambda (x) (cons (symbol-name (aref x 1)) (aref x 1)))
1013 1014
		    font-weight-table))
	   (:slant
1015
	    (mapcar #'(lambda (x) (cons (symbol-name (aref x 1)) (aref x 1)))
1016 1017 1018 1019
		    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
1020
           ((:underline :overline :strike-through :box)
1021
            (if (window-system frame)
Sam Steingold's avatar
Sam Steingold committed
1022 1023 1024
                (nconc (mapcar #'(lambda (x) (cons (symbol-name x) x))
                               (internal-lisp-face-attribute-values attribute))
                       (mapcar #'(lambda (c) (cons c c))
1025
                               (defined-colors frame)))
Sam Steingold's avatar
Sam Steingold committed
1026 1027 1028 1029 1030 1031 1032 1033
	      (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
1034
            (and (memq (window-system frame) '(x ns)) ; No stipple on w32
Sam Steingold's avatar
Sam Steingold committed
1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047
                 (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
1048
    (if (and (listp valid) (not (memq attribute '(:inherit))))
1049 1050
	(nconc (list (cons "unspecified" 'unspecified)) valid)
      valid)))
Gerd Moellmann's avatar
Gerd Moellmann committed
1051 1052


1053
(defconst face-attribute-name-alist
Gerd Moellmann's avatar
Gerd Moellmann committed
1054
  '((:family . "font family")
1055
    (:foundry . "font foundry")
Gerd Moellmann's avatar
Gerd Moellmann committed
1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066
    (: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
1067 1068
    (:stipple . "background stipple")
    (:inherit . "inheritance"))
Gerd Moellmann's avatar
Gerd Moellmann committed
1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081
  "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
1082 1083 1084 1085
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
1086

Miles Bader's avatar
Miles Bader committed
1087
Entering nothing accepts the default string DEFAULT.
Gerd Moellmann's avatar
Gerd Moellmann committed
1088
Value is the new attribute value."
Miles Bader's avatar
Miles Bader committed
1089 1090 1091
  ;; 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
1092 1093 1094
  (let* ((completion-ignore-case t)
	 (value (completing-read
		 (if default
Miles Bader's avatar
Miles Bader committed
1095 1096 1097
		     (format "%s for face `%s' (default %s): "
			     name face default)
		   (format "%s for face `%s': " name face))
1098
		 completion-alist nil nil nil nil default)))
1099
    (if (equal value "") default value)))
Gerd Moellmann's avatar
Gerd Moellmann committed
1100 1101 1102 1103 1104 1105 1106