lisp/faces.el

   1 ;;; faces.el --- Lisp faces
   2
   3 ;; Copyright (C) 1992, 1993, 1994, 1995, 1996, 1998, 1999, 2000, 2001
   4 ;;   Free Software Foundation, Inc.
   5
   6 ;; Maintainer: FSF
   7
   8 ;; This file is part of GNU Emacs.
   9
  10 ;; GNU Emacs is free software; you can redistribute it and/or modify
  11 ;; it under the terms of the GNU General Public License as published by
  12 ;; the Free Software Foundation; either version 2, or (at your option)
  13 ;; any later version.
  14
  15 ;; GNU Emacs is distributed in the hope that it will be useful,
  16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18 ;; GNU General Public License for more details.
  19
  20 ;; You should have received a copy of the GNU General Public License
  21 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
  22 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  23 ;; Boston, MA 02111-1307, USA.
  24
  25 ;;; Commentary:
  26
  27 ;;; Code:
  28
  29 (eval-when-compile
  30   (require 'cl)
  31   ;; Warning suppression -- can't require x-win in batch:
  32   (autoload 'xw-defined-colors "x-win"))
  33
  34 (require 'cus-face)
  35
  36 \f
  37 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
  38 ;;; Font selection.
  39 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
  40
  41 (defgroup font-selection nil
  42   "Influencing face font selection."
  43   :group 'faces)
  44
  45
  46 (defcustom face-font-selection-order
  47   '(:width :height :weight :slant)
  48   "*A list specifying how face font selection chooses fonts.
  49 Each of the four symbols `:width', `:height', `:weight', and `:slant'
  50 must appear once in the list, and the list must not contain any other
  51 elements.  Font selection tries to find a best matching font for
  52 those face attributes first that appear first in the list.  For
  53 example, if `:slant' appears before `:height', font selection first
  54 tries to find a font with a suitable slant, even if this results in
  55 a font height that isn't optimal."
  56   :tag "Font selection order."
  57   :type '(list symbol symbol symbol symbol)
  58   :group 'font-selection
  59   :set #'(lambda (symbol value)
  60            (set-default symbol value)
  61            (internal-set-font-selection-order value)))
  62
  63
  64 ;; This is defined originally in xfaces.c.
  65 (defcustom face-font-family-alternatives
  66   '(("courier" "fixed")
  67     ("helv" "helvetica" "arial" "fixed"))
  68   "*Alist of alternative font family names.
  69 Each element has the the form (FAMILY ALTERNATIVE1 ALTERNATIVE2 ...).
  70 If fonts of family FAMILY can't be loaded, try ALTERNATIVE1, then
  71 ALTERNATIVE2 etc."
  72   :tag "Alternative font families to try."
  73   :type '(repeat (repeat string))
  74   :group 'font-selection
  75   :set #'(lambda (symbol value)
  76            (set-default symbol value)
  77            (internal-set-alternative-font-family-alist value)))
  78
  79
  80 ;; This is defined originally in xfaces.c.
  81 (defcustom face-font-registry-alternatives
  82   '(("gb2312.1980" "gb2312.80&gb8565.88" "gbk*")
  83     ("jisx0208.1990" "jisx0208.1983" "jisx0208.1978")
  84     ("ksc5601.1989" "ksx1001.1992" "ksc5601.1987")
  85     ("muletibetan-2" "muletibetan-0"))
  86   "*Alist of alternative font registry names.
  87 Each element has the the form (REGISTRY ALTERNATIVE1 ALTERNATIVE2 ...).
  88 If fonts of registry REGISTRY can be loaded, font selection
  89 tries to find a best matching font among all fonts of registry
  90 REGISTRY, ALTERNATIVE1, ALTERNATIVE2, and etc."
  91   :tag "Alternative font registries to try."
  92   :type '(repeat (repeat string))
  93   :version "21.1"
  94   :group 'font-selection
  95   :set #'(lambda (symbol value)
  96            (set-default symbol value)
  97            (internal-set-alternative-font-registry-alist value)))
  98
  99
 100 \f
 101 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 102 ;;; Creation, copying.
 103 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 104
 105
 106 (defun face-list ()
 107   "Return a list of all defined face names."
 108   (mapcar #'car face-new-frame-defaults))
 109
 110
 111 ;;; ### If not frame-local initialize by what X resources?
 112
 113 (defun make-face (face &optional no-init-from-resources)
 114   "Define a new face with name FACE, a symbol.
 115 NO-INIT-FROM-RESOURCES non-nil means don't initialize frame-local
 116 variants of FACE from X resources.  (X resources recognized are found
 117 in the global variable `face-x-resources'.)  If FACE is already known
 118 as a face, leave it unmodified.  Value is FACE."
 119   (interactive "SMake face: ")
 120   (unless (facep face)
 121     ;; Make frame-local faces (this also makes the global one).
 122     (dolist (frame (frame-list))
 123       (internal-make-lisp-face face frame))
 124     ;; Add the face to the face menu.
 125     (when (fboundp 'facemenu-add-new-face)
 126       (facemenu-add-new-face face))
 127     ;; Define frame-local faces for all frames from X resources.
 128     (unless no-init-from-resources
 129       (make-face-x-resource-internal face)))
 130   face)
 131
 132
 133 (defun make-empty-face (face)
 134   "Define a new, empty face with name FACE.
 135 If the face already exists, it is left unmodified.  Value is FACE."
 136   (interactive "SMake empty face: ")
 137   (make-face face 'no-init-from-resources))
 138
 139
 140 (defun copy-face (old-face new-face &optional frame new-frame)
 141   "Define a face just like OLD-FACE, with name NEW-FACE.
 142
 143 If NEW-FACE already exists as a face, it is modified to be like
 144 OLD-FACE.  If it doesn't already exist, it is created.
 145
 146 If the optional argument FRAME is given as a frame,  NEW-FACE is
 147 changed on FRAME only.
 148 If FRAME is t, the frame-independent default specification for OLD-FACE
 149 is copied to NEW-FACE.
 150 If FRAME is nil, copying is done for the frame-independent defaults
 151 and for each existing frame.
 152
 153 If the optional fourth argument NEW-FRAME is given,
 154 copy the information from face OLD-FACE on frame FRAME
 155 to NEW-FACE on frame NEW-FRAME."
 156   (let ((inhibit-quit t))
 157     (if (null frame)
 158         (progn
 159           (dolist (frame (frame-list))
 160             (copy-face old-face new-face frame))
 161           (copy-face old-face new-face t))
 162       (internal-copy-lisp-face old-face new-face frame new-frame))
 163     new-face))
 164
 165
 166 \f
 167 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 168 ;;; Obsolete functions
 169 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 170
 171 ;; The functions in this section are defined because Lisp packages use
 172 ;; them, despite the prefix `internal-' suggesting that they are
 173 ;; private to the face implementation.
 174
 175 (defun internal-find-face (name &optional frame)
 176   "Retrieve the face named NAME.
 177 Return nil if there is no such face.
 178 If the optional argument FRAME is given, this gets the face NAME for
 179 that frame; otherwise, it uses the selected frame.
 180 If FRAME is the symbol t, then the global, non-frame face is returned.
 181 If NAME is already a face, it is simply returned.
 182
 183 This function is defined for compatibility with Emacs 20.2.  It
 184 should not be used anymore."
 185   (facep name))
 186 (make-obsolete 'internal-find-face 'facep "21.1")
 187
 188
 189 (defun internal-get-face (name &optional frame)
 190   "Retrieve the face named NAME; error if there is none.
 191 If the optional argument FRAME is given, this gets the face NAME for
 192 that frame; otherwise, it uses the selected frame.
 193 If FRAME is the symbol t, then the global, non-frame face is returned.
 194 If NAME is already a face, it is simply returned.
 195
 196 This function is defined for compatibility with Emacs 20.2.  It
 197 should not be used anymore."
 198   (or (internal-find-face name frame)
 199       (check-face name)))
 200 (make-obsolete 'internal-get-face "See `facep' and `check-face'." "21.1")
 201
 202 \f
 203 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 204 ;;; Predicates, type checks.
 205 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 206
 207 (defun facep (face)
 208   "Return non-nil if FACE is a face name."
 209   (internal-lisp-face-p face))
 210
 211
 212 (defun check-face (face)
 213   "Signal an error if FACE doesn't name a face.
 214 Value is FACE."
 215   (unless (facep face)
 216     (error "Not a face: %s" face))
 217   face)
 218
 219
 220 ;; The ID returned is not to be confused with the internally used IDs
 221 ;; of realized faces.  The ID assigned to Lisp faces is used to
 222 ;; support faces in display table entries.
 223
 224 (defun face-id (face &optional frame)
 225   "Return the interNal ID of face with name FACE.
 226 If optional argument FRAME is nil or omitted, use the selected frame."
 227   (check-face face)
 228   (get face 'face))
 229
 230
 231 (defun face-equal (face1 face2 &optional frame)
 232   "Non-nil if faces FACE1 and FACE2 are equal.
 233 Faces are considered equal if all their attributes are equal.
 234 If the optional argument FRAME is given, report on face FACE in that frame.
 235 If FRAME is t, report on the defaults for face FACE (for new frames).
 236 If FRAME is omitted or nil, use the selected frame."
 237   (internal-lisp-face-equal-p face1 face2 frame))
 238
 239
 240 (defun face-differs-from-default-p (face &optional frame)
 241   "Non-nil if FACE displays differently from the default face.
 242 If the optional argument FRAME is given, report on face FACE in that frame.
 243 If FRAME is t, report on the defaults for face FACE (for new frames).
 244 If FRAME is omitted or nil, use the selected frame.
 245 A face is considered to be ``the same'' as the default face if it is
 246 actually specified in the same way (equal attributes) or if it is
 247 fully-unspecified, and thus inherits the attributes of any face it
 248 is displayed on top of."
 249   (cond ((eq frame t) (setq frame nil))
 250         ((null frame) (setq frame (selected-frame))))
 251   (let* ((v1 (internal-lisp-face-p face frame))
 252          (n (if v1 (length v1) 0))
 253          (v2 (internal-lisp-face-p 'default frame))
 254          (i 1))
 255     (unless v1
 256       (error "Not a face: %S" face))
 257     (while (and (< i n)
 258                 (or (eq 'unspecified (aref v1 i))
 259                     (equal (aref v1 i) (aref v2 i))))
 260       (setq i (1+ i)))
 261     (< i n)))
 262
 263
 264 (defun face-nontrivial-p (face &optional frame)
 265   "True if face FACE has some non-nil attribute.
 266 If the optional argument FRAME is given, report on face FACE in that frame.
 267 If FRAME is t, report on the defaults for face FACE (for new frames).
 268 If FRAME is omitted or nil, use the selected frame."
 269   (not (internal-lisp-face-empty-p face frame)))
 270
 271
 272 \f
 273 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 274 ;;; Setting face attributes from X resources.
 275 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 276
 277 (defcustom face-x-resources
 278   '((:family (".attributeFamily" . "Face.AttributeFamily"))
 279     (:width (".attributeWidth" . "Face.AttributeWidth"))
 280     (:height (".attributeHeight" . "Face.AttributeHeight"))
 281     (:weight (".attributeWeight" . "Face.AttributeWeight"))
 282     (:slant (".attributeSlant" . "Face.AttributeSlant"))
 283     (:foreground (".attributeForeground" . "Face.AttributeForeground"))
 284     (:background (".attributeBackground" . "Face.AttributeBackground"))
 285     (:overline (".attributeOverline" . "Face.AttributeOverline"))
 286     (:strike-through (".attributeStrikeThrough" . "Face.AttributeStrikeThrough"))
 287     (:box (".attributeBox" . "Face.AttributeBox"))
 288     (:underline (".attributeUnderline" . "Face.AttributeUnderline"))
 289     (:inverse-video (".attributeInverse" . "Face.AttributeInverse"))
 290     (:stipple
 291      (".attributeStipple" . "Face.AttributeStipple")
 292      (".attributeBackgroundPixmap" . "Face.AttributeBackgroundPixmap"))
 293     (:bold (".attributeBold" . "Face.AttributeBold"))
 294     (:italic (".attributeItalic" . "Face.AttributeItalic"))
 295     (:font (".attributeFont" . "Face.AttributeFont"))
 296     (:inherit (".attributeInherit" . "Face.AttributeInherit")))
 297   "*List of X resources and classes for face attributes.
 298 Each element has the form (ATTRIBUTE ENTRY1 ENTRY2...) where ATTRIBUTE is
 299 the name of a face attribute, and each ENTRY is a cons of the form
 300 (RESOURCE . CLASS) with RESOURCE being the resource and CLASS being the
 301 X resource class for the attribute."
 302   :type '(repeat (cons symbol (repeat (cons string string))))
 303   :group 'faces)
 304
 305
 306 (defun set-face-attribute-from-resource (face attribute resource class frame)
 307   "Set FACE's ATTRIBUTE from X resource RESOURCE, class CLASS on FRAME.
 308 Value is the attribute value specified by the resource, or nil
 309 if not present.  This function displays a message if the resource
 310 specifies an invalid attribute."
 311   (let* ((face-name (face-name face))
 312          (value (internal-face-x-get-resource (concat face-name resource)
 313                                               class frame)))
 314     (when value
 315       (condition-case ()
 316           (internal-set-lisp-face-attribute-from-resource
 317            face attribute (downcase value) frame)
 318         (error
 319          (message "Face %s, frame %s: invalid attribute %s %s from X resource"
 320                   face-name frame attribute value))))
 321     value))
 322
 323
 324 (defun set-face-attributes-from-resources (face frame)
 325   "Set attributes of FACE from X resources for FRAME."
 326   (when (memq (framep frame) '(x w32 mac))
 327     (dolist (definition face-x-resources)
 328       (let ((attribute (car definition)))
 329         (dolist (entry (cdr definition))
 330           (set-face-attribute-from-resource face attribute (car entry)
 331                                             (cdr entry) frame))))))
 332
 333
 334 (defun make-face-x-resource-internal (face &optional frame)
 335   "Fill frame-local FACE on FRAME from X resources.
 336 FRAME nil or not specified means do it for all frames."
 337   (if (null frame)
 338       (dolist (frame (frame-list))
 339         (set-face-attributes-from-resources face frame))
 340     (set-face-attributes-from-resources face frame)))
 341
 342
 343 \f
 344 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 345 ;;; Retrieving face attributes.
 346 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 347
 348 (defun face-name (face)
 349   "Return the name of face FACE."
 350   (symbol-name (check-face face)))
 351
 352
 353 (defun face-attribute (face attribute &optional frame)
 354   "Return the value of FACE's ATTRIBUTE on FRAME.
 355 If the optional argument FRAME is given, report on face FACE in that frame.
 356 If FRAME is t, report on the defaults for face FACE (for new frames).
 357 If FRAME is omitted or nil, use the selected frame."
 358   (internal-get-lisp-face-attribute face attribute frame))
 359
 360
 361 (defun face-foreground (face &optional frame)
 362   "Return the foreground color name of FACE, or nil if unspecified.
 363 If the optional argument FRAME is given, report on face FACE in that frame.
 364 If FRAME is t, report on the defaults for face FACE (for new frames).
 365 If FRAME is omitted or nil, use the selected frame."
 366   (let ((value (internal-get-lisp-face-attribute face :foreground frame)))
 367     (if (eq value 'unspecified)
 368         nil
 369       value)))
 370
 371
 372 (defun face-background (face &optional frame)
 373   "Return the background color name of FACE, or nil if unspecified.
 374 If the optional argument FRAME is given, report on face FACE in that frame.
 375 If FRAME is t, report on the defaults for face FACE (for new frames).
 376 If FRAME is omitted or nil, use the selected frame."
 377   (let ((value (internal-get-lisp-face-attribute face :background frame)))
 378     (if (eq value 'unspecified)
 379         nil
 380       value)))
 381
 382
 383 (defun face-stipple (face &optional frame)
 384  "Return the stipple pixmap name of FACE, or nil if unspecified.
 385 If the optional argument FRAME is given, report on face FACE in that frame.
 386 If FRAME is t, report on the defaults for face FACE (for new frames).
 387 If FRAME is omitted or nil, use the selected frame."
 388   (let ((value (internal-get-lisp-face-attribute face :stipple frame)))
 389     (if (eq value 'unspecified)
 390         nil
 391       value)))
 392
 393
 394 (defalias 'face-background-pixmap 'face-stipple)
 395
 396
 397 (defun face-underline-p (face &optional frame)
 398  "Return non-nil if FACE is underlined.
 399 If the optional argument FRAME is given, report on face FACE in that frame.
 400 If FRAME is t, report on the defaults for face FACE (for new frames).
 401 If FRAME is omitted or nil, use the selected frame."
 402  (eq (face-attribute face :underline frame) t))
 403
 404
 405 (defun face-inverse-video-p (face &optional frame)
 406  "Return non-nil if FACE is in inverse video on FRAME.
 407 If the optional argument FRAME is given, report on face FACE in that frame.
 408 If FRAME is t, report on the defaults for face FACE (for new frames).
 409 If FRAME is omitted or nil, use the selected frame."
 410  (eq (face-attribute face :inverse-video frame) t))
 411
 412
 413 (defun face-bold-p (face &optional frame)
 414   "Return non-nil if the font of FACE is bold on FRAME.
 415 If the optional argument FRAME is given, report on face FACE in that frame.
 416 If FRAME is t, report on the defaults for face FACE (for new frames).
 417 If FRAME is omitted or nil, use the selected frame.
 418 Use `face-attribute' for finer control."
 419   (let ((bold (face-attribute face :weight frame)))
 420     (memq bold '(semi-bold bold extra-bold ultra-bold))))
 421
 422
 423 (defun face-italic-p (face &optional frame)
 424   "Return non-nil if the font of FACE is italic on FRAME.
 425 If the optional argument FRAME is given, report on face FACE in that frame.
 426 If FRAME is t, report on the defaults for face FACE (for new frames).
 427 If FRAME is omitted or nil, use the selected frame.
 428 Use `face-attribute' for finer control."
 429   (let ((italic (face-attribute face :slant frame)))
 430     (memq italic '(italic oblique))))
 431
 432
 433 \f
 434 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 435 ;;; Face documentation.
 436 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 437
 438 (defun face-documentation (face)
 439   "Get the documentation string for FACE."
 440   (get face 'face-documentation))
 441
 442
 443 (defun set-face-documentation (face string)
 444   "Set the documentation string for FACE to STRING."
 445   ;; Perhaps the text should go in DOC.
 446   (put face 'face-documentation (purecopy string)))
 447
 448
 449 (defalias 'face-doc-string 'face-documentation)
 450 (defalias 'set-face-doc-string 'set-face-documentation)
 451
 452
 453 \f
 454 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 455 ;; Setting face attributes.
 456 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 457
 458
 459 (defun set-face-attribute (face frame &rest args)
 460   "Set attributes of FACE on FRAME from ARGS.
 461
 462 FRAME nil means change attributes on all frames.  FRAME t means change
 463 the default for new frames (this is done automatically each time an
 464 attribute is changed on all frames).
 465
 466 ARGS must come in pairs ATTRIBUTE VALUE.  ATTRIBUTE must be a valid
 467 face attribute name.  All attributes can be set to `unspecified';
 468 this fact is not further mentioned below.
 469
 470 The following attributes are recognized:
 471
 472 `:family'
 473
 474 VALUE must be a string specifying the font family, e.g. ``courier'',
 475 or a fontset alias name.  If a font family is specified, wild-cards `*'
 476 and `?' are allowed.
 477
 478 `:width'
 479
 480 VALUE specifies the relative proportionate width of the font to use.
 481 It must be one of the symbols `ultra-condensed', `extra-condensed',
 482 `condensed', `semi-condensed', `normal', `semi-expanded', `expanded',
 483 `extra-expanded', or `ultra-expanded'.
 484
 485 `:height'
 486
 487 VALUE must be either an integer specifying the height of the font to use
 488 in 1/10 pt, a floating point number specifying the amount by which to
 489 scale any underlying face, or a function, which is called with the old
 490 height (from the underlying face), and should return the new height.
 491
 492 `:weight'
 493
 494 VALUE specifies the weight of the font to use.  It must be one of the
 495 symbols `ultra-bold', `extra-bold', `bold', `semi-bold', `normal',
 496 `semi-light', `light', `extra-light', `ultra-light'.
 497
 498 `:slant'
 499
 500 VALUE specifies the slant of the font to use.  It must be one of the
 501 symbols `italic', `oblique', `normal', `reverse-italic', or
 502 `reverse-oblique'.
 503
 504 `:foreground', `:background'
 505
 506 VALUE must be a color name, a string.
 507
 508 `:underline'
 509
 510 VALUE specifies whether characters in FACE should be underlined.  If
 511 VALUE is t, underline with foreground color of the face.  If VALUE is
 512 a string, underline with that color.  If VALUE is nil, explicitly
 513 don't underline.
 514
 515 `:overline'
 516
 517 VALUE specifies whether characters in FACE should be overlined.  If
 518 VALUE is t, overline with foreground color of the face.  If VALUE is a
 519 string, overline with that color.  If VALUE is nil, explicitly don't
 520 overline.
 521
 522 `:strike-through'
 523
 524 VALUE specifies whether characters in FACE should be drawn with a line
 525 striking through them.  If VALUE is t, use the foreground color of the
 526 face.  If VALUE is a string, strike-through with that color.  If VALUE
 527 is nil, explicitly don't strike through.
 528
 529 `:box'
 530
 531 VALUE specifies whether characters in FACE should have a box drawn
 532 around them.  If VALUE is nil, explicitly don't draw boxes.  If
 533 VALUE is t, draw a box with lines of width 1 in the foreground color
 534 of the face.  If VALUE is a string, the string must be a color name,
 535 and the box is drawn in that color with a line width of 1.  Otherwise,
 536 VALUE must be a property list of the form `(:line-width WIDTH
 537 :color COLOR :style STYLE)'.  If a keyword/value pair is missing from
 538 the property list, a default value will be used for the value, as
 539 specified below.  WIDTH specifies the width of the lines to draw; it
 540 defaults to 1.  If WIDTH is negative, the absolute value is the width
 541 of the lines, and draw top/bottom lines inside the characters area,
 542 not around it.  COLOR is the name of the color to draw in, default is
 543 the foreground color of the face for simple boxes, and the background
 544 color of the face for 3D boxes.  STYLE specifies whether a 3D box
 545 should be draw.  If STYLE is `released-button', draw a box looking
 546 like a released 3D button.  If STYLE is `pressed-button' draw a box
 547 that appears like a pressed button.  If STYLE is nil, the default if
 548 the property list doesn't contain a style specification, draw a 2D
 549 box.
 550
 551 `:inverse-video'
 552
 553 VALUE specifies whether characters in FACE should be displayed in
 554 inverse video.  VALUE must be one of t or nil.
 555
 556 `:stipple'
 557
 558 If VALUE is a string, it must be the name of a file of pixmap data.
 559 The directories listed in the `x-bitmap-file-path' variable are
 560 searched.  Alternatively, VALUE may be a list of the form (WIDTH
 561 HEIGHT DATA) where WIDTH and HEIGHT are the size in pixels, and DATA
 562 is a string containing the raw bits of the bitmap.  VALUE nil means
 563 explicitly don't use a stipple pattern.
 564
 565 For convenience, attributes `:family', `:width', `:height', `:weight',
 566 and `:slant' may also be set in one step from an X font name:
 567
 568 `:font'
 569
 570 Set font-related face attributes from VALUE.  VALUE must be a valid
 571 XLFD font name.  If it is a font name pattern, the first matching font
 572 will be used.
 573
 574 For compatibility with Emacs 20, keywords `:bold' and `:italic' can
 575 be used to specify that a bold or italic font should be used.  VALUE
 576 must be t or nil in that case.  A value of `unspecified' is not allowed.
 577
 578 `:inherit'
 579
 580 VALUE is the name of a face from which to inherit attributes, or a list
 581 of face names.  Attributes from inherited faces are merged into the face
 582 like an underlying face would be, with higher priority than underlying faces."
 583   (let ((where (if (null frame) 0 frame)))
 584     (setq args (purecopy args))
 585     (while args
 586       (internal-set-lisp-face-attribute face (car args)
 587                                         (purecopy (cadr args))
 588                                         where)
 589       (setq args (cdr (cdr args))))))
 590
 591
 592 (defun make-face-bold (face &optional frame noerror)
 593   "Make the font of FACE be bold, if possible.
 594 FRAME nil or not specified means change face on all frames.
 595 Argument NOERROR is ignored and retained for compatibility.
 596 Use `set-face-attribute' for finer control of the font weight."
 597   (interactive (list (read-face-name "Make which face bold ")))
 598   (set-face-attribute face frame :weight 'bold))
 599
 600
 601 (defun make-face-unbold (face &optional frame noerror)
 602   "Make the font of FACE be non-bold, if possible.
 603 FRAME nil or not specified means change face on all frames.
 604 Argument NOERROR is ignored and retained for compatibility."
 605   (interactive (list (read-face-name "Make which face non-bold ")))
 606   (set-face-attribute face frame :weight 'normal))
 607
 608
 609 (defun make-face-italic (face &optional frame noerror)
 610   "Make the font of FACE be italic, if possible.
 611 FRAME nil or not specified means change face on all frames.
 612 Argument NOERROR is ignored and retained for compatibility.
 613 Use `set-face-attribute' for finer control of the font slant."
 614   (interactive (list (read-face-name "Make which face italic ")))
 615   (set-face-attribute face frame :slant 'italic))
 616
 617
 618 (defun make-face-unitalic (face &optional frame noerror)
 619   "Make the font of FACE be non-italic, if possible.
 620 FRAME nil or not specified means change face on all frames.
 621 Argument NOERROR is ignored and retained for compatibility."
 622   (interactive (list (read-face-name "Make which face non-italic ")))
 623   (set-face-attribute face frame :slant 'normal))
 624
 625
 626 (defun make-face-bold-italic (face &optional frame noerror)
 627   "Make the font of FACE be bold and italic, if possible.
 628 FRAME nil or not specified means change face on all frames.
 629 Argument NOERROR is ignored and retained for compatibility.
 630 Use `set-face-attribute' for finer control of font weight and slant."
 631   (interactive (list (read-face-name "Make which face bold-italic: ")))
 632   (set-face-attribute face frame :weight 'bold :slant 'italic))
 633
 634
 635 (defun set-face-font (face font &optional frame)
 636   "Change font-related attributes of FACE to those of FONT (a string).
 637 FRAME nil or not specified means change face on all frames.
 638 This sets the attributes `:family', `:width', `:height', `:weight',
 639 and `:slant'.  When called interactively, prompt for the face and font."
 640   (interactive (read-face-and-attribute :font))
 641   (set-face-attribute face frame :font font))
 642
 643
 644 ;; Implementation note: Emulating gray background colors with a
 645 ;; stipple pattern is now part of the face realization process, and is
 646 ;; done in C depending on the frame on which the face is realized.
 647
 648 (defun set-face-background (face color &optional frame)
 649   "Change the background color of face FACE to COLOR (a string).
 650 FRAME nil or not specified means change face on all frames.
 651 When called interactively, prompt for the face and color."
 652   (interactive (read-face-and-attribute :background))
 653   (set-face-attribute face frame :background (or color 'unspecified)))
 654
 655
 656 (defun set-face-foreground (face color &optional frame)
 657   "Change the foreground color of face FACE to COLOR (a string).
 658 FRAME nil or not specified means change face on all frames.
 659 When called interactively, prompt for the face and color."
 660   (interactive (read-face-and-attribute :foreground))
 661   (set-face-attribute face frame :foreground (or color 'unspecified)))
 662
 663
 664 (defun set-face-stipple (face stipple &optional frame)
 665   "Change the stipple pixmap of face FACE to STIPPLE.
 666 FRAME nil or not specified means change face on all frames.
 667 STIPPLE should be a string, the name of a file of pixmap data.
 668 The directories listed in the `x-bitmap-file-path' variable are searched.
 669
 670 Alternatively, STIPPLE may be a list of the form (WIDTH HEIGHT DATA)
 671 where WIDTH and HEIGHT are the size in pixels,
 672 and DATA is a string, containing the raw bits of the bitmap."
 673   (interactive (read-face-and-attribute :stipple))
 674   (set-face-attribute face frame :stipple (or stipple 'unspecified)))
 675
 676
 677 (defun set-face-underline (face underline &optional frame)
 678   "Specify whether face FACE is underlined.
 679 UNDERLINE nil means FACE explicitly doesn't underline.
 680 UNDERLINE non-nil means FACE explicitly does underlining
 681 with the same of the foreground color.
 682 If UNDERLINE is a string, underline with the color named UNDERLINE.
 683 FRAME nil or not specified means change face on all frames.
 684 Use `set-face-attribute' to ``unspecify'' underlining."
 685   (interactive
 686    (let ((list (read-face-and-attribute :underline)))
 687      (list (car list) (eq (car (cdr list)) t))))
 688   (set-face-attribute face frame :underline underline))
 689
 690
 691 (defun set-face-underline-p (face underline-p &optional frame)
 692   "Specify whether face FACE is underlined.
 693 UNDERLINE-P nil means FACE explicitly doesn't underline.
 694 UNDERLINE-P non-nil means FACE explicitly does underlining.
 695 FRAME nil or not specified means change face on all frames.
 696 Use `set-face-attribute' to ``unspecify'' underlining."
 697   (interactive
 698    (let ((list (read-face-and-attribute :underline)))
 699      (list (car list) (eq (car (cdr list)) t))))
 700   (set-face-attribute face frame :underline underline-p))
 701
 702
 703 (defun set-face-inverse-video-p (face inverse-video-p &optional frame)
 704   "Specify whether face FACE is in inverse video.
 705 INVERSE-VIDEO-P non-nil means FACE displays explicitly in inverse video.
 706 INVERSE-VIDEO-P nil means FACE explicitly is not in inverse video.
 707 FRAME nil or not specified means change face on all frames.
 708 Use `set-face-attribute' to ``unspecify'' the inverse video attribute."
 709   (interactive
 710    (let ((list (read-face-and-attribute :inverse-video)))
 711      (list (car list) (eq (car (cdr list)) t))))
 712   (set-face-attribute face frame :inverse-video inverse-video-p))
 713
 714
 715 (defun set-face-bold-p (face bold-p &optional frame)
 716   "Specify whether face FACE is bold.
 717 BOLD-P non-nil means FACE should explicitly display bold.
 718 BOLD-P nil means FACE should explicitly display non-bold.
 719 FRAME nil or not specified means change face on all frames.
 720 Use `set-face-attribute' or `modify-face' for finer control."
 721   (if (null bold-p)
 722       (make-face-unbold face frame)
 723     (make-face-bold face frame)))
 724
 725
 726 (defun set-face-italic-p (face italic-p &optional frame)
 727   "Specify whether face FACE is italic.
 728 ITALIC-P non-nil means FACE should explicitly display italic.
 729 ITALIC-P nil means FACE should explicitly display non-italic.
 730 FRAME nil or not specified means change face on all frames.
 731 Use `set-face-attribute' or `modify-face' for finer control."
 732   (if (null italic-p)
 733       (make-face-unitalic face frame)
 734     (make-face-italic face frame)))
 735
 736
 737 (defalias 'set-face-background-pixmap 'set-face-stipple)
 738
 739
 740 (defun invert-face (face &optional frame)
 741   "Swap the foreground and background colors of FACE.
 742 FRAME nil or not specified means change face on all frames.
 743 If FACE specifies neither foreground nor background color,
 744 set its foreground and background to the background and foreground
 745 of the default face.  Value is FACE."
 746   (interactive (list (read-face-name "Invert face ")))
 747   (let ((fg (face-attribute face :foreground frame))
 748         (bg (face-attribute face :background frame)))
 749     (if (or fg bg)
 750         (set-face-attribute face frame :foreground bg :background fg)
 751       (set-face-attribute face frame
 752                           :foreground
 753                           (face-attribute 'default :background frame)
 754                           :background
 755                           (face-attribute 'default :foreground frame))))
 756   face)
 757
 758 \f
 759 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 760 ;;; Interactively modifying faces.
 761 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 762
 763 (defun read-face-name (prompt)
 764   "Read and return a face symbol, prompting with PROMPT.
 765 Value is a symbol naming a known face."
 766   (let ((face-list (mapcar #'(lambda (x) (cons (symbol-name x) x))
 767                            (face-list)))
 768         (def (thing-at-point 'symbol))
 769         face)
 770     (cond ((assoc def face-list)
 771            (setq prompt (concat prompt " (default " def "): ")))
 772           (t (setq def nil)
 773              (setq prompt (concat prompt ": "))))
 774     (while (equal "" (setq face (completing-read
 775                                  prompt face-list nil t nil nil def))))
 776     (intern face)))
 777
 778
 779 (defun face-valid-attribute-values (attribute &optional frame)
 780   "Return valid values for face attribute ATTRIBUTE.
 781 The optional argument FRAME is used to determine available fonts
 782 and colors.  If it is nil or not specified, the selected frame is
 783 used.  Value is an alist of (NAME . VALUE) if ATTRIBUTE expects a value
 784 out of a set of discrete values.  Value is `integerp' if ATTRIBUTE expects
 785 an integer value."
 786   (let ((valid
 787          (case attribute
 788            (:family
 789             (if window-system
 790                 (mapcar #'(lambda (x) (cons (car x) (car x)))
 791                         (x-font-family-list))
 792               ;; Only one font on TTYs.
 793               (list (cons "default" "default"))))
 794            ((:width :weight :slant :inverse-video)
 795             (mapcar #'(lambda (x) (cons (symbol-name x) x))
 796                     (internal-lisp-face-attribute-values attribute)))
 797            ((:underline :overline :strike-through :box)
 798             (if window-system
 799                 (nconc (mapcar #'(lambda (x) (cons (symbol-name x) x))
 800                                (internal-lisp-face-attribute-values attribute))
 801                        (mapcar #'(lambda (c) (cons c c))
 802                                (x-defined-colors frame)))
 803               (mapcar #'(lambda (x) (cons (symbol-name x) x))
 804                       (internal-lisp-face-attribute-values attribute))))
 805            ((:foreground :background)
 806             (mapcar #'(lambda (c) (cons c c))
 807                     (defined-colors frame)))
 808            ((:height)
 809             'integerp)
 810            (:stipple
 811             (and (memq window-system '(x w32 mac))
 812                  (mapcar #'list
 813                          (apply #'nconc
 814                                 (mapcar (lambda (dir)
 815                                           (and (file-readable-p dir)
 816                                                (file-directory-p dir)
 817                                                (directory-files dir)))
 818                                         x-bitmap-file-path)))))
 819            (:inherit
 820             (cons '("none" . nil)
 821                   (mapcar #'(lambda (c) (cons (symbol-name c) c))
 822                           (face-list))))
 823            (t
 824             (error "Internal error")))))
 825     (if (and (listp valid) (not (memq attribute '(:inherit))))
 826         (nconc (list (cons "unspecified" 'unspecified)) valid)
 827       valid)))
 828
 829
 830 (defvar face-attribute-name-alist
 831   '((:family . "font family")
 832     (:width . "character set width")
 833     (:height . "height in 1/10 pt")
 834     (:weight . "weight")
 835     (:slant . "slant")
 836     (:underline . "underline")
 837     (:overline . "overline")
 838     (:strike-through . "strike-through")
 839     (:box . "box")
 840     (:inverse-video . "inverse-video display")
 841     (:foreground . "foreground color")
 842     (:background . "background color")
 843     (:stipple . "background stipple")
 844     (:inherit . "inheritance"))
 845   "An alist of descriptive names for face attributes.
 846 Each element has the form (ATTRIBUTE-NAME . DESCRIPTION) where
 847 ATTRIBUTE-NAME is a face attribute name (a keyword symbol), and
 848 DESCRIPTION is a descriptive name for ATTRIBUTE-NAME.")
 849
 850
 851 (defun face-descriptive-attribute-name (attribute)
 852   "Return a descriptive name for ATTRIBUTE."
 853   (cdr (assq attribute face-attribute-name-alist)))
 854
 855
 856 (defun face-read-string (face default name &optional completion-alist)
 857   "Interactively read a face attribute string value.
 858 FACE is the face whose attribute is read.  If non-nil, DEFAULT is the
 859 default string to return if no new value is entered.  NAME is a
 860 descriptive name of the attribute for prompting.  COMPLETION-ALIST is an
 861 alist of valid values, if non-nil.
 862
 863 Entering nothing accepts the default string DEFAULT.
 864 Value is the new attribute value."
 865   ;; Capitalize NAME (we don't use `capitalize' because that capitalizes
 866   ;; each word in a string separately).
 867   (setq name (concat (upcase (substring name 0 1)) (substring name 1)))
 868   (let* ((completion-ignore-case t)
 869          (value (completing-read
 870                  (if default
 871                      (format "%s for face `%s' (default %s): "
 872                              name face default)
 873                    (format "%s for face `%s': " name face))
 874                  completion-alist)))
 875     (if (equal value "") default value)))
 876
 877
 878 (defun face-read-integer (face default name)
 879   "Interactively read an integer face attribute value.
 880 FACE is the face whose attribute is read.  DEFAULT is the default
 881 value to return if no new value is entered.  NAME is a descriptive
 882 name of the attribute for prompting.  Value is the new attribute value."
 883   (let ((new-value
 884          (face-read-string face
 885                            (format "%s" default)
 886                            name
 887                            (list (cons "unspecified" 'unspecified)))))
 888     (cond ((equal new-value "unspecified")
 889            'unspecified)
 890           ((member new-value '("unspecified-fg" "unspecified-bg"))
 891            new-value)
 892           (t
 893            (string-to-int new-value)))))
 894
 895
 896 (defun read-face-attribute (face attribute &optional frame)
 897   "Interactively read a new value for FACE's ATTRIBUTE.
 898 Optional argument FRAME nil or unspecified means read an attribute value
 899 of a global face.  Value is the new attribute value."
 900   (let* ((old-value (face-attribute face attribute frame))
 901          (attribute-name (face-descriptive-attribute-name attribute))
 902          (valid (face-valid-attribute-values attribute frame))
 903          new-value)
 904     ;; Represent complex attribute values as strings by printing them
 905     ;; out.  Stipple can be a vector; (WIDTH HEIGHT DATA).  Box can be
 906     ;; a list `(:width WIDTH :color COLOR)' or `(:width WIDTH :shadow
 907     ;; SHADOW)'.
 908     (when (and (or (eq attribute :stipple)
 909                    (eq attribute :box))
 910                (or (consp old-value)
 911                    (vectorp old-value)))
 912       (setq old-value (prin1-to-string old-value)))
 913     (cond ((listp valid)
 914            (let ((default
 915                    (or (car (rassoc old-value valid))
 916                        (format "%s" old-value))))
 917              (setq new-value
 918                    (face-read-string face default attribute-name valid))
 919              (if (equal new-value default)
 920                  ;; Nothing changed, so don't bother with all the stuff
 921                  ;; below.  In particular, this avoids a non-tty color
 922                  ;; from being canonicalized for a tty when the user
 923                  ;; just uses the default.
 924                  (setq new-value old-value)
 925                ;; Terminal frames can support colors that don't appear
 926                ;; explicitly in VALID, using color approximation code
 927                ;; in tty-colors.el.
 928                (when (and (memq attribute '(:foreground :background))
 929                           (not (memq window-system '(x w32 mac)))
 930                           (not (member new-value
 931                                        '("unspecified"
 932                                          "unspecified-fg" "unspecified-bg"))))
 933                  (setq new-value (car (tty-color-desc new-value frame))))
 934                (when (assoc new-value valid)
 935                  (setq new-value (cdr (assoc new-value valid)))))))
 936           ((eq valid 'integerp)
 937            (setq new-value (face-read-integer face old-value attribute-name)))
 938           (t (error "Internal error")))
 939     ;; Convert stipple and box value text we read back to a list or
 940     ;; vector if it looks like one.  This makes the assumption that a
 941     ;; pixmap file name won't start with an open-paren.
 942     (when (and (or (eq attribute :stipple)
 943                    (eq attribute :box))
 944                (stringp new-value)
 945                (string-match "^[[(]" new-value))
 946       (setq new-value (read new-value)))
 947     new-value))
 948
 949
 950 (defun read-face-font (face &optional frame)
 951   "Read the name of a font for FACE on FRAME.
 952 If optional argument FRAME Is nil or omitted, use the selected frame."
 953   (let ((completion-ignore-case t))
 954     (completing-read (format "Set font attributes of face `%s' from font: " face)
 955                      (mapcar 'list (x-list-fonts "*" nil frame)))))
 956
 957
 958 (defun read-all-face-attributes (face &optional frame)
 959   "Interactively read all attributes for FACE.
 960 If optional argument FRAME Is nil or omitted, use the selected frame.
 961 Value is a property list of attribute names and new values."
 962   (let (result)
 963     (dolist (attribute face-attribute-name-alist result)
 964       (setq result (cons (car attribute)
 965                          (cons (read-face-attribute face (car attribute) frame)
 966                                result))))))
 967
 968 (defun modify-face (&optional face foreground background stipple
 969                               bold-p italic-p underline-p inverse-p frame)
 970   "Modify attributes of faces interactively.
 971 If optional argument FRAME is nil or omitted, modify the face used
 972 for newly created frame, i.e. the global face.
 973 For non-interactive use, `set-face-attribute' is preferred.
 974 When called from elisp, if FACE is nil, all arguments but FRAME are ignored
 975 and the face and its settings are obtained by querying the user."
 976   (interactive)
 977   (if face
 978       (set-face-attribute face frame
 979                           :foreground (or foreground 'unspecified)
 980                           :background (or background 'unspecified)
 981                           :stipple stipple
 982                           :bold bold-p
 983                           :italic italic-p
 984                           :underline underline-p
 985                           :inverse-video inverse-p)
 986     (setq face (read-face-name "Modify face"))
 987     (apply #'set-face-attribute face frame
 988            (read-all-face-attributes face frame))))
 989
 990 (defun read-face-and-attribute (attribute &optional frame)
 991   "Read face name and face attribute value.
 992 ATTRIBUTE is the attribute whose new value is read.
 993 FRAME nil or unspecified means read attribute value of global face.
 994 Value is a list (FACE NEW-VALUE) where FACE is the face read
 995 \(a symbol), and NEW-VALUE is value read."
 996   (cond ((eq attribute :font)
 997          (let* ((prompt "Set font-related attributes of face")
 998                 (face (read-face-name prompt))
 999                 (font (read-face-font face frame)))
1000            (list face font)))
1001         (t
1002          (let* ((attribute-name (face-descriptive-attribute-name attribute))
1003                 (prompt (format "Set %s of face" attribute-name))
1004                 (face (read-face-name prompt))
1005                 (new-value (read-face-attribute face attribute frame)))
1006            (list face new-value)))))
1007
1008
1009 \f
1010 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1011 ;;; Listing faces.
1012 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1013
1014 (defvar list-faces-sample-text
1015   "abcdefghijklmnopqrstuvwxyz ABCDEFGHIJKLMNOPQRSTUVWXYZ"
1016   "*Text string to display as the sample text for `list-faces-display'.")
1017
1018
1019 ;; The name list-faces would be more consistent, but let's avoid a
1020 ;; conflict with Lucid, which uses that name differently.
1021
1022 (defun list-faces-display ()
1023   "List all faces, using the same sample text in each.
1024 The sample text is a string that comes from the variable
1025 `list-faces-sample-text'."
1026   (interactive)
1027   (let ((faces (sort (face-list) #'string-lessp))
1028         (face nil)
1029         (frame (selected-frame))
1030         disp-frame window face-name)
1031     (with-output-to-temp-buffer "*Faces*"
1032       (save-excursion
1033         (set-buffer standard-output)
1034         (setq truncate-lines t)
1035         (insert
1036          (substitute-command-keys
1037           (concat
1038            "Use "
1039            (if (display-mouse-p) "\\[help-follow-mouse] or ")
1040            "\\[help-follow] on a face name to customize it\n"
1041            "or on its sample text for a decription of the face.\n\n")))
1042         (setq help-xref-stack nil)
1043         (while faces
1044           (setq face (car faces))
1045           (setq faces (cdr faces))
1046           (setq face-name (symbol-name face))
1047           (insert (format "%25s " face-name))
1048           ;; Hyperlink to a customization buffer for the face.  Using
1049           ;; the help xref mechanism may not be the best way.
1050           (save-excursion
1051             (save-match-data
1052               (search-backward face-name)
1053               (help-xref-button 0 (lambda (f)
1054                                     (if help-xref-stack
1055                                         (pop help-xref-stack))
1056                                     (customize-face f))
1057                                 face-name
1058                                 "mouse-2: customize this face")))
1059           (let ((beg (point)))
1060             (insert list-faces-sample-text)
1061             ;; Hyperlink to a help buffer for the face.
1062             (save-excursion
1063               (save-match-data
1064                 (search-backward list-faces-sample-text)
1065                 (help-xref-button 0 #'describe-face face
1066                                   "mouse-2: describe this face")))
1067             (insert "\n")
1068             (put-text-property beg (1- (point)) 'face face)
1069             ;; If the sample text has multiple lines, line up all of them.
1070             (goto-char beg)
1071             (forward-line 1)
1072             (while (not (eobp))
1073               (insert "                          ")
1074               (forward-line 1))))
1075         (goto-char (point-min)))
1076       (print-help-return-message))
1077     ;; If the *Faces* buffer appears in a different frame,
1078     ;; copy all the face definitions from FRAME,
1079     ;; so that the display will reflect the frame that was selected.
1080     (setq window (get-buffer-window (get-buffer "*Faces*") t))
1081     (setq disp-frame (if window (window-frame window)
1082                        (car (frame-list))))
1083     (or (eq frame disp-frame)
1084         (let ((faces (face-list)))
1085           (while faces
1086             (copy-face (car faces) (car faces) frame disp-frame)
1087             (setq faces (cdr faces)))))))
1088
1089
1090 (defun describe-face (face &optional frame)
1091   "Display the properties of face FACE on FRAME.
1092 If the optional argument FRAME is given, report on face FACE in that frame.
1093 If FRAME is t, report on the defaults for face FACE (for new frames).
1094 If FRAME is omitted or nil, use the selected frame."
1095   (interactive (list (read-face-name "Describe face")))
1096   (let* ((attrs '((:family . "Family")
1097                   (:width . "Width")
1098                   (:height . "Height")
1099                   (:weight . "Weight")
1100                   (:slant . "Slant")
1101                   (:foreground . "Foreground")
1102                   (:background . "Background")
1103                   (:underline . "Underline")
1104                   (:overline . "Overline")
1105                   (:strike-through . "Strike-through")
1106                   (:box . "Box")
1107                   (:inverse-video . "Inverse")
1108                   (:stipple . "Stipple")
1109                   (:font . "Font or fontset")
1110                   (:inherit . "Inherit")))
1111         (max-width (apply #'max (mapcar #'(lambda (x) (length (cdr x)))
1112                                         attrs))))
1113     (with-output-to-temp-buffer "*Help*"
1114       (save-excursion
1115         (set-buffer standard-output)
1116         (dolist (a attrs)
1117           (let ((attr (face-attribute face (car a) frame)))
1118             (insert (make-string (- max-width (length (cdr a))) ?\ )
1119                     (cdr a) ": " (format "%s" attr) "\n")))
1120         (insert "\nDocumentation:\n\n"
1121                 (or (face-documentation face)
1122                     "not documented as a face."))
1123         (let ((customize-label "customize"))
1124           (terpri)
1125           (terpri)
1126           (princ (concat "You can " customize-label " this face."))
1127           (with-current-buffer "*Help*"
1128             (save-excursion
1129               (re-search-backward
1130                (concat "\\(" customize-label "\\)") nil t)
1131               (help-xref-button 1 #'customize-face face
1132                                 "mouse-2, RET: customize face")))))
1133       (print-help-return-message)
1134       (with-current-buffer "*Help*"
1135         (help-setup-xref (list #'describe-face face) (interactive-p))
1136         (buffer-string)))))
1137 \f
1138 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1139 ;;; Face specifications (defface).
1140 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1141
1142 ;; Parameter FRAME Is kept for call compatibility to with previous
1143 ;; face implementation.
1144
1145 (defun face-attr-construct (face &optional frame)
1146   "Return a defface-style attribute list for FACE on FRAME.
1147 Value is a property list of pairs ATTRIBUTE VALUE for all specified
1148 face attributes of FACE where ATTRIBUTE is the attribute name and
1149 VALUE is the specified value of that attribute."
1150   (let (result)
1151     (dolist (entry face-attribute-name-alist result)
1152       (let* ((attribute (car entry))
1153              (value (face-attribute face attribute)))
1154         (unless (eq value 'unspecified)
1155           (setq result (nconc (list attribute value) result)))))))
1156
1157
1158 (defun face-spec-set-match-display (display frame)
1159   "Non-nil if DISPLAY matches FRAME.
1160 DISPLAY is part of a spec such as can be used in `defface'.
1161 If FRAME is nil, the current FRAME is used."
1162   (let* ((conjuncts display)
1163          conjunct req options
1164          ;; t means we have succeeded against all the conjuncts in
1165          ;; DISPLAY that have been tested so far.
1166          (match t))
1167     (if (eq conjuncts t)
1168         (setq conjuncts nil))
1169     (while (and conjuncts match)
1170       (setq conjunct (car conjuncts)
1171             conjuncts (cdr conjuncts)
1172             req (car conjunct)
1173             options (cdr conjunct)
1174             match (cond ((eq req 'type)
1175                          (or (memq window-system options)
1176                              ;; FIXME: This should be revisited to use
1177                              ;; display-graphic-p, provided that the
1178                              ;; color selection depends on the number
1179                              ;; of supported colors, and all defface's
1180                              ;; are changed to look at number of colors
1181                              ;; instead of (type graphic) etc.
1182                              (and (null window-system)
1183                                   (memq 'tty options))
1184                              (and (memq 'motif options)
1185                                   (featurep 'motif))
1186                              (and (memq 'lucid options)
1187                                   (featurep 'x-toolkit)
1188                                   (not (featurep 'motif)))
1189                              (and (memq 'x-toolkit options)
1190                                   (featurep 'x-toolkit))))
1191                         ((eq req 'class)
1192                          (memq (frame-parameter frame 'display-type) options))
1193                         ((eq req 'background)
1194                          (memq (frame-parameter frame 'background-mode)
1195                                options))
1196                         (t (error "Unknown req `%S' with options `%S'"
1197                                   req options)))))
1198     match))
1199
1200
1201 (defun face-spec-choose (spec &optional frame)
1202   "Choose the proper attributes for FRAME, out of SPEC.
1203 If SPEC is nil, return nil."
1204   (unless frame
1205     (setq frame (selected-frame)))
1206   (let ((tail spec)
1207         result)
1208     (while tail
1209       (let* ((entry (pop tail))
1210              (display (car entry))
1211              (attrs (cdr entry)))
1212         (when (face-spec-set-match-display display frame)
1213           (setq result (if (listp (car attrs))
1214                            ;; Old-style entry, the attribute list is the
1215                            ;; first element.
1216                            (car attrs)
1217                          attrs)
1218                 tail nil))))
1219     result))
1220
1221
1222 (defun face-spec-reset-face (face &optional frame)
1223   "Reset all attributes of FACE on FRAME to unspecified."
1224   (let ((attrs face-attribute-name-alist))
1225     (while attrs
1226       (let ((attr-and-name (car attrs)))
1227         (set-face-attribute face frame (car attr-and-name) 'unspecified))
1228       (setq attrs (cdr attrs)))))
1229
1230
1231 (defun face-spec-set (face spec &optional frame)
1232   "Set FACE's attributes according to the first matching entry in SPEC.
1233 FRAME is the frame whose frame-local face is set.  FRAME nil means
1234 do it on all frames.  See `defface' for information about SPEC.
1235 If SPEC is nil, do nothing."
1236   (let ((attrs (face-spec-choose spec frame)))
1237     (when attrs
1238       (face-spec-reset-face face frame))
1239     (while attrs
1240       (let ((attribute (car attrs))
1241             (value (car (cdr attrs))))
1242         ;; Support some old-style attribute names and values.
1243         (case attribute
1244           (:bold (setq attribute :weight value (if value 'bold 'normal)))
1245           (:italic (setq attribute :slant value (if value 'italic 'normal)))
1246           ((:foreground :background)
1247            ;; Compatibility with 20.x.  Some bogus face specs seem to
1248            ;; exist containing things like `:foreground nil'.
1249            (if (null value) (setq value 'unspecified)))
1250           (t (unless (assq attribute face-x-resources)
1251                (setq attribute nil))))
1252         (when attribute
1253           (set-face-attribute face frame attribute value)))
1254       (setq attrs (cdr (cdr attrs))))))
1255
1256
1257 (defun face-attr-match-p (face attrs &optional frame)
1258   "Return t if attributes of FACE match values in plist ATTRS.
1259 Optional parameter FRAME is the frame whose definition of FACE
1260 is used.  If nil or omitted, use the selected frame."
1261   (unless frame
1262     (setq frame (selected-frame)))
1263   (let ((list face-attribute-name-alist)
1264         (match t))
1265     (while (and match (not (null list)))
1266       (let* ((attr (car (car list)))
1267              (specified-value
1268               (if (plist-member attrs attr)
1269                   (plist-get attrs attr)
1270                 'unspecified))
1271              (value-now (face-attribute face attr frame)))
1272         (setq match (equal specified-value value-now))
1273         (setq list (cdr list))))
1274     match))
1275
1276 (defun face-spec-match-p (face spec &optional frame)
1277   "Return t if FACE, on FRAME, matches what SPEC says it should look like."
1278   (face-attr-match-p face (face-spec-choose spec frame) frame))
1279
1280 (defsubst face-default-spec (face)
1281   "Return the default face-spec for FACE, ignoring any user customization.
1282 If there is no default for FACE, return nil."
1283   (get face 'face-defface-spec))
1284
1285 (defsubst face-user-default-spec (face)
1286   "Return the user's customized face-spec for FACE, or the default if none.
1287 If there is neither a user setting nor a default for FACE, return nil."
1288   (or (get face 'saved-face)
1289       (face-default-spec face)))
1290
1291 \f
1292 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1293 ;;; Frame-type independent color support.
1294 ;;; We keep the old x-* names as aliases for back-compatibility.
1295 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1296
1297 (defun defined-colors (&optional frame)
1298   "Return a list of colors supported for a particular frame.
1299 The argument FRAME specifies which frame to try.
1300 The value may be different for frames on different display types.
1301 If FRAME doesn't support colors, the value is nil."
1302   (if (memq (framep (or frame (selected-frame))) '(x w32 mac))
1303       (xw-defined-colors frame)
1304     (mapcar 'car (tty-color-alist frame))))
1305 (defalias 'x-defined-colors 'defined-colors)
1306
1307 (defun color-defined-p (color &optional frame)
1308   "Return non-nil if color COLOR is supported on frame FRAME.
1309 If FRAME is omitted or nil, use the selected frame.
1310 If COLOR is the symbol `unspecified' or one of the strings
1311 \"unspecified-fg\" or \"unspecified-bg\", the value is nil."
1312   (if (member color '(unspecified "unspecified-bg" "unspecified-fg"))
1313       nil
1314     (if (member (framep (or frame (selected-frame))) '(x w32 mac))
1315         (xw-color-defined-p color frame)
1316       (numberp (tty-color-translate color frame)))))
1317 (defalias 'x-color-defined-p 'color-defined-p)
1318
1319 (defun color-values (color &optional frame)
1320   "Return a description of the color named COLOR on frame FRAME.
1321 The value is a list of integer RGB values--\(RED GREEN BLUE\).
1322 These values appear to range from 0 65535; white is \(65535 65535 65535\).
1323 If FRAME is omitted or nil, use the selected frame.
1324 If FRAME cannot display COLOR, the value is nil.
1325 If COLOR is the symbol `unspecified' or one of the strings
1326 \"unspecified-fg\" or \"unspecified-bg\", the value is nil."
1327   (if (member color '(unspecified "unspecified-fg" "unspecified-bg"))
1328       nil
1329     (if (memq (framep (or frame (selected-frame))) '(x w32 mac))
1330         (xw-color-values color frame)
1331       (tty-color-values color frame))))
1332 (defalias 'x-color-values 'color-values)
1333
1334 (defun display-color-p (&optional display)
1335   "Return t if DISPLAY supports color.
1336 The optional argument DISPLAY specifies which display to ask about.
1337 DISPLAY should be either a frame or a display name (a string).
1338 If omitted or nil, that stands for the selected frame's display."
1339   (if (memq (framep-on-display display) '(x w32 mac))
1340       (xw-display-color-p display)
1341     (tty-display-color-p display)))
1342 (defalias 'x-display-color-p 'display-color-p)
1343
1344 (defun display-grayscale-p (&optional display)
1345   "Return non-nil if frames on DISPLAY can display shades of gray."
1346   (let ((frame-type (framep-on-display display)))
1347     (cond
1348      ((memq frame-type '(x w32 mac))
1349       (x-display-grayscale-p display))
1350      (t
1351       (> (tty-color-gray-shades display) 2)))))
1352
1353 \f
1354 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1355 ;;; Background mode.
1356 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1357
1358 (defcustom frame-background-mode nil
1359   "*The brightness of the background.
1360 Set this to the symbol `dark' if your background color is dark, `light' if
1361 your background is light, or nil (default) if you want Emacs to
1362 examine the brightness for you.  Don't set this variable with `setq';
1363 this won't have the expected effect."
1364   :group 'faces
1365   :set #'(lambda (var value)
1366            (set-default var value)
1367            (mapc 'frame-set-background-mode (frame-list)))
1368   :initialize 'custom-initialize-changed
1369   :type '(choice (choice-item dark)
1370                  (choice-item light)
1371                  (choice-item :tag "default" nil)))
1372
1373
1374 (defun frame-set-background-mode (frame)
1375   "Set up display-dependent faces on FRAME.
1376 Display-dependent faces are those which have different definitions
1377 according to the `background-mode' and `display-type' frame parameters."
1378   (let* ((bg-resource
1379           (and window-system
1380                (x-get-resource ".backgroundMode" "BackgroundMode")))
1381          (bg-color (frame-parameter frame 'background-color))
1382          (bg-mode
1383           (cond (frame-background-mode)
1384                 (bg-resource
1385                  (intern (downcase bg-resource)))
1386                 ((and (null window-system) (null bg-color))
1387                  ;; No way to determine this automatically (?).
1388                  'dark)
1389                 ;; Unspecified frame background color can only happen
1390                 ;; on tty's.
1391                 ((member bg-color '(unspecified "unspecified-bg"))
1392                  'dark)
1393                 ((equal bg-color "unspecified-fg") ; inverted colors
1394                  'light)
1395                 ((>= (apply '+ (x-color-values bg-color frame))
1396                     ;; Just looking at the screen, colors whose
1397                     ;; values add up to .6 of the white total
1398                     ;; still look dark to me.
1399                     (* (apply '+ (x-color-values "white" frame)) .6))
1400                  'light)
1401                 (t 'dark)))
1402          (display-type
1403           (cond ((null window-system)
1404                  (if (tty-display-color-p frame) 'color 'mono))
1405                 ((x-display-color-p frame)
1406                  'color)
1407                 ((x-display-grayscale-p frame)
1408                  'grayscale)
1409                 (t 'mono)))
1410          (old-bg-mode
1411           (frame-parameter frame 'background-mode))
1412          (old-display-type
1413           (frame-parameter frame 'display-type)))
1414
1415     (unless (and (eq bg-mode old-bg-mode) (eq display-type old-display-type))
1416       (let ((locally-modified-faces nil))
1417         ;; Before modifying the frame parameters, we collect a list of
1418         ;; faces that don't match what their face-spec says they should
1419         ;; look like; we then avoid changing these faces below.  A
1420         ;; negative list is used on the assumption that most faces will
1421         ;; be unmodified, so we can avoid consing in the common case.
1422         (dolist (face (face-list))
1423           (when (not (face-spec-match-p face
1424                                         (face-user-default-spec face)
1425                                         (selected-frame)))
1426             (push face locally-modified-faces)))
1427         ;; Now change to the new frame parameters
1428         (modify-frame-parameters frame
1429                                  (list (cons 'background-mode bg-mode)
1430                                        (cons 'display-type display-type)))
1431         ;; For all named faces, choose face specs matching the new frame
1432         ;; parameters, unless they have been locally modified.
1433         (dolist (face (face-list))
1434           (unless (memq face locally-modified-faces)
1435             (face-spec-set face (face-user-default-spec face) frame)))))))
1436
1437 \f
1438 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1439 ;;; Frame creation.
1440 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1441
1442 (defun x-handle-named-frame-geometry (parameters)
1443   "Add geometry parameters for a named frame to parameter list PARAMETERS.
1444 Value is the new parameter list."
1445   (let* ((name (or (cdr (assq 'name parameters))
1446                    (cdr (assq 'name default-frame-alist))))
1447          (x-resource-name name)
1448          (res-geometry (if name (x-get-resource "geometry" "Geometry"))))
1449     (when res-geometry
1450       (let ((parsed (x-parse-geometry res-geometry)))
1451         ;; If the resource specifies a position, call the position
1452         ;; and size "user-specified".
1453         (when (or (assq 'top parsed)
1454                   (assq 'left parsed))
1455           (setq parsed (append '((user-position . t) (user-size . t)) parsed)))
1456         ;; Put the geometry parameters at the end.  Copy
1457         ;; default-frame-alist so that they go after it.
1458         (setq parameters (append parameters default-frame-alist parsed))))
1459     parameters))
1460
1461
1462 (defun x-handle-reverse-video (frame parameters)
1463   "Handle the reverse-video frame parameter and X resource.
1464 `x-create-frame' does not handle this one."
1465   (when (cdr (or (assq 'reverse parameters)
1466                  (assq 'reverse default-frame-alist)
1467                  (let ((resource (x-get-resource "reverseVideo"
1468                                                  "ReverseVideo")))
1469                    (if resource
1470                        (cons nil (member (downcase resource)
1471                                          '("on" "true")))))))
1472       (let* ((params (frame-parameters frame))
1473              (bg (cdr (assq 'foreground-color params)))
1474              (fg (cdr (assq 'background-color params))))
1475         (modify-frame-parameters frame
1476                                  (list (cons 'foreground-color fg)
1477                                        (cons 'background-color bg)))
1478         (if (equal bg (cdr (assq 'border-color params)))
1479             (modify-frame-parameters frame
1480                                      (list (cons 'border-color fg))))
1481         (if (equal bg (cdr (assq 'mouse-color params)))
1482             (modify-frame-parameters frame
1483                                      (list (cons 'mouse-color fg))))
1484         (if (equal bg (cdr (assq 'cursor-color params)))
1485             (modify-frame-parameters frame
1486                                      (list (cons 'cursor-color fg)))))))
1487
1488
1489 (defun x-create-frame-with-faces (&optional parameters)
1490   "Create a frame from optional frame parameters PARAMETERS.
1491 Parameters not specified by PARAMETERS are taken from
1492 `default-frame-alist'.  If PARAMETERS specify a frame name,
1493 handle X geometry resources for that name.  If either PARAMETERS
1494 or `default-frame-alist' contains a `reverse' parameter, or
1495 the X resource ``reverseVideo'' is present, handle that.
1496 Value is the new frame created."
1497   (setq parameters (x-handle-named-frame-geometry parameters))
1498   (let ((visibility-spec (assq 'visibility parameters))
1499         (frame-list (frame-list))
1500         (frame (x-create-frame (cons '(visibility . nil) parameters)))
1501         success)
1502     (unwind-protect
1503         (progn
1504           (x-handle-reverse-video frame parameters)
1505           (frame-set-background-mode frame)
1506           (face-set-after-frame-default frame)
1507           (if (or (null frame-list) (null visibility-spec))
1508               (make-frame-visible frame)
1509             (modify-frame-parameters frame (list visibility-spec)))
1510           (setq success t))
1511       (unless success
1512         (delete-frame frame)))
1513     frame))
1514
1515
1516 (defun face-set-after-frame-default (frame)
1517   "Set frame-local faces of FRAME from face specs and resources.
1518 Initialize colors of certain faces from frame parameters."
1519   (dolist (face (face-list))
1520     (face-spec-set face (face-user-default-spec face) frame)
1521     (internal-merge-in-global-face face frame)
1522     (when (and (memq window-system '(x w32 mac))
1523                (or (not (boundp 'inhibit-default-face-x-resources))
1524                    (not (eq face 'default))))
1525       (make-face-x-resource-internal face frame)))
1526
1527   ;; Initialize attributes from frame parameters.
1528   (let ((params '((foreground-color default :foreground)
1529                   (background-color default :background)
1530                   (border-color border :background)
1531                   (cursor-color cursor :background)
1532                   (scroll-bar-foreground scroll-bar :foreground)
1533                   (scroll-bar-background scroll-bar :background)
1534                   (mouse-color mouse :background))))
1535     (dolist (param params)
1536       (let ((frame-param (frame-parameter frame (nth 0 param)))
1537             (face (nth 1 param))
1538             (attr (nth 2 param)))
1539         (when (and frame-param
1540                    ;; Don't override face attributes explicitly
1541                    ;; specified for new frames.
1542                    (eq (face-attribute face attr t) 'unspecified))
1543           (set-face-attribute face frame attr frame-param))))))
1544
1545
1546 (defun tty-handle-reverse-video (frame parameters)
1547   "Handle the reverse-video frame parameter for terminal frames."
1548   (when (cdr (or (assq 'reverse parameters)
1549                  (assq 'reverse default-frame-alist)))
1550     (let* ((params (frame-parameters frame))
1551            (bg (cdr (assq 'foreground-color params)))
1552            (fg (cdr (assq 'background-color params))))
1553       (modify-frame-parameters frame
1554                                (list (cons 'foreground-color fg)
1555                                      (cons 'background-color bg)))
1556       (if (equal bg (cdr (assq 'mouse-color params)))
1557           (modify-frame-parameters frame
1558                                    (list (cons 'mouse-color fg))))
1559       (if (equal bg (cdr (assq 'cursor-color params)))
1560           (modify-frame-parameters frame
1561                                    (list (cons 'cursor-color fg)))))))
1562
1563
1564 (defun tty-create-frame-with-faces (&optional parameters)
1565   "Create a frame from optional frame parameters PARAMETERS.
1566 Parameters not specified by PARAMETERS are taken from
1567 `default-frame-alist'.  If either PARAMETERS or `default-frame-alist'
1568 contains a `reverse' parameter, handle that.  Value is the new frame
1569 created."
1570   (let ((frame (make-terminal-frame parameters))
1571         success)
1572     (unwind-protect
1573         (progn
1574           (tty-handle-reverse-video frame (frame-parameters frame))
1575           (frame-set-background-mode frame)
1576           (face-set-after-frame-default frame)
1577           (setq success t))
1578       (unless success
1579         (delete-frame frame)))
1580     frame))
1581
1582
1583 ;; Called from C function init_display to initialize faces of the
1584 ;; dumped terminal frame on startup.
1585
1586 (defun tty-set-up-initial-frame-faces ()
1587   (let ((frame (selected-frame)))
1588     (frame-set-background-mode frame)
1589     (face-set-after-frame-default frame)))
1590
1591
1592
1593 \f
1594 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1595 ;;; Compatiblity with 20.2
1596 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1597
1598 ;; Update a frame's faces when we change its default font.
1599
1600 (defalias 'frame-update-faces 'ignore)
1601 (make-obsolete 'frame-update-faces "No longer necessary" "21.1")
1602
1603 ;; Update the colors of FACE, after FRAME's own colors have been
1604 ;; changed.
1605
1606 (defalias 'frame-update-face-colors 'frame-set-background-mode)
1607 (make-obsolete 'frame-update-face-colors 'frame-set-background-mode "21.1")
1608
1609 \f
1610 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1611 ;;; Standard faces.
1612 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1613
1614 (defgroup basic-faces nil
1615   "The standard faces of Emacs."
1616   :group 'faces)
1617
1618
1619 (defface default
1620   '((t nil))
1621   "Basic default face."
1622   :group 'basic-faces)
1623
1624
1625 (defface mode-line
1626   '((((type x w32 mac) (class color))
1627      (:box (:line-width -1 :style released-button)
1628            :background "grey75" :foreground "black"))
1629     (t
1630      (:inverse-video t)))
1631   "Basic mode line face."
1632   :version "21.1"
1633   :group 'modeline
1634   :group 'basic-faces)
1635
1636 ;; Make `modeline' an alias for `mode-line', for compatibility.
1637 (put 'modeline 'face-alias 'mode-line)
1638
1639 (defface header-line
1640   '((((type tty))
1641      ;; This used to be `:inverse-video t', but that doesn't look very
1642      ;; good when combined with inverse-video mode-lines and multiple
1643      ;; windows.  Underlining looks better, and is more consistent with
1644      ;; the window-system face variants, which deemphasize the
1645      ;; header-line in relation to the mode-line face.  If a terminal
1646      ;; can't underline, then the header-line will end up without any
1647      ;; highlighting; this may be too confusing in general, although it
1648      ;; happens to look good with the only current use of header-lines,
1649      ;; the info browser. XXX
1650      :underline t)
1651     (((class color grayscale) (background light))
1652      :inherit mode-line
1653      :background "grey90" :foreground "grey20"
1654      :box nil)
1655     (((class color grayscale) (background dark))
1656      :inherit mode-line
1657      :background "grey20" :foreground "grey90"
1658      :box nil)
1659     (((class mono) (background light))
1660      :inherit mode-line
1661      :background "white" :foreground "black"
1662      :inverse-video nil
1663      :box nil
1664      :underline t)
1665     (((class mono) (background dark))
1666      :inherit mode-line
1667      :background "black" :foreground "white"
1668      :inverse-video nil
1669      :box nil
1670      :underline t)
1671     (t
1672      :inverse-video t))
1673   "Basic header-line face."
1674   :version "21.1"
1675   :group 'basic-faces)
1676
1677
1678 (defface tool-bar
1679   '((((type x w32 mac) (class color))
1680      (:box (:line-width 1 :style released-button)
1681            :background "grey75" :foreground "black"))
1682     (((type x) (class mono))
1683      (:box (:line-width 1 :style released-button)
1684            :background "grey" :foreground "black"))
1685     (t
1686      ()))
1687   "Basic tool-bar face."
1688   :version "21.1"
1689   :group 'basic-faces)
1690
1691
1692 (defface region
1693   '((((type tty) (class color))
1694      (:background "blue" :foreground "white"))
1695     (((type tty) (class mono))
1696      (:inverse-video t))
1697     (((class color) (background dark))
1698      (:background "blue3"))
1699     (((class color) (background light))
1700      (:background "lightgoldenrod2"))
1701     (t (:background "gray")))
1702   "Basic face for highlighting the region."
1703   :version "21.1"
1704   :group 'basic-faces)
1705
1706
1707 (defface fringe
1708   '((((class color) (background light))
1709        (:background "grey95"))
1710       (((class color) (background dark))
1711        (:background "grey10"))
1712       (t
1713        (:background "gray")))
1714   "Basic face for the fringes to the left and right of windows under X."
1715   :version "21.1"
1716   :group 'frames
1717   :group 'basic-faces)
1718
1719
1720 (defface scroll-bar '()
1721   "Basic face for the scroll bar colors under X."
1722   :version "21.1"
1723   :group 'frames
1724   :group 'basic-faces)
1725
1726
1727 (defface menu
1728   '((((type tty))
1729      :inverse-video t)
1730     (((type x-toolkit))
1731      )
1732     (t
1733      :inverse-video t))
1734   "Basic face for the font and colors of the menu bar and popup menus."
1735   :version "21.1"
1736   :group 'menu
1737   :group 'basic-faces)
1738
1739
1740 (defface border '()
1741   "Basic face for the frame border under X."
1742   :version "21.1"
1743   :group 'frames
1744   :group 'basic-faces)
1745
1746
1747 (defface cursor '()
1748   "Basic face for the cursor color under X."
1749   :version "21.1"
1750   :group 'cursor
1751   :group 'basic-faces)
1752
1753
1754 (defface mouse '()
1755   "Basic face for the mouse color under X."
1756   :version "21.1"
1757   :group 'mouse
1758   :group 'basic-faces)
1759
1760
1761 (defface bold '((t (:weight bold)))
1762   "Basic bold face."
1763   :group 'basic-faces)
1764
1765
1766 (defface italic '((t (:slant italic)))
1767   "Basic italic font."
1768   :group 'basic-faces)
1769
1770
1771 (defface bold-italic '((t (:weight bold :slant italic)))
1772   "Basic bold-italic face."
1773   :group 'basic-faces)
1774
1775
1776 (defface underline '((t (:underline t)))
1777   "Basic underlined face."
1778   :group 'basic-faces)
1779
1780
1781 (defface highlight
1782   '((((type tty) (class color))
1783      (:background "green"))
1784     (((class color) (background light))
1785      (:background "darkseagreen2"))
1786     (((class color) (background dark))
1787      (:background "darkolivegreen"))
1788     (t (:inverse-video t)))
1789   "Basic face for highlighting."
1790   :group 'basic-faces)
1791
1792
1793 (defface secondary-selection
1794   '((((type tty) (class color))
1795      (:background "cyan" :foreground "black"))
1796     (((class color) (background light))
1797      (:background "yellow"))
1798     (((class color) (background dark))
1799      (:background "SkyBlue4"))
1800     (t (:inverse-video t)))
1801   "Basic face for displaying the secondary selection."
1802   :group 'basic-faces)
1803
1804
1805 (defface fixed-pitch '((t (:family "courier")))
1806   "The basic fixed-pitch face."
1807   :group 'basic-faces)
1808
1809
1810 (defface variable-pitch '((t (:family "helv")))
1811   "The basic variable-pitch face."
1812   :group 'basic-faces)
1813
1814
1815 (defface trailing-whitespace
1816   '((((class color) (background light))
1817      (:background "red"))
1818     (((class color) (background dark))
1819      (:background "red"))
1820     (t (:inverse-video t)))
1821   "Basic face for highlighting trailing whitespace."
1822   :version "21.1"
1823   :group 'font-lock                     ; like `show-trailing-whitespace'
1824   :group 'basic-faces)
1825
1826
1827 \f
1828 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1829 ;;; Manipulating font names.
1830 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1831
1832 ;; This is here for compatibilty with Emacs 20.2.  For example,
1833 ;; international/fontset.el uses x-resolve-font-name.  The following
1834 ;; functions are not used in the face implementation itself.
1835
1836 (defvar x-font-regexp nil)
1837 (defvar x-font-regexp-head nil)
1838 (defvar x-font-regexp-weight nil)
1839 (defvar x-font-regexp-slant nil)
1840
1841 (defconst x-font-regexp-weight-subnum 1)
1842 (defconst x-font-regexp-slant-subnum 2)
1843 (defconst x-font-regexp-swidth-subnum 3)
1844 (defconst x-font-regexp-adstyle-subnum 4)
1845
1846 ;;; Regexps matching font names in "Host Portable Character Representation."
1847 ;;;
1848 (let ((-                "[-?]")
1849       (foundry          "[^-]+")
1850       (family           "[^-]+")
1851       (weight           "\\(bold\\|demibold\\|medium\\)")               ; 1
1852 ;     (weight\?         "\\(\\*\\|bold\\|demibold\\|medium\\|\\)")      ; 1
1853       (weight\?         "\\([^-]*\\)")                                  ; 1
1854       (slant            "\\([ior]\\)")                                  ; 2
1855 ;     (slant\?          "\\([ior?*]?\\)")                               ; 2
1856       (slant\?          "\\([^-]?\\)")                                  ; 2
1857 ;     (swidth           "\\(\\*\\|normal\\|semicondensed\\|\\)")        ; 3
1858       (swidth           "\\([^-]*\\)")                                  ; 3
1859 ;     (adstyle          "\\(\\*\\|sans\\|\\)")                          ; 4
1860       (adstyle          "\\([^-]*\\)")                                  ; 4
1861       (pixelsize        "[0-9]+")
1862       (pointsize        "[0-9][0-9]+")
1863       (resx             "[0-9][0-9]+")
1864       (resy             "[0-9][0-9]+")
1865       (spacing          "[cmp?*]")
1866       (avgwidth         "[0-9]+")
1867       (registry         "[^-]+")
1868       (encoding         "[^-]+")
1869       )
1870   (setq x-font-regexp
1871         (concat "\\`\\*?[-?*]"
1872                 foundry - family - weight\? - slant\? - swidth - adstyle -
1873                 pixelsize - pointsize - resx - resy - spacing - avgwidth -
1874                 registry - encoding "\\*?\\'"
1875                 ))
1876   (setq x-font-regexp-head
1877         (concat "\\`[-?*]" foundry - family - weight\? - slant\?
1878                 "\\([-*?]\\|\\'\\)"))
1879   (setq x-font-regexp-slant (concat - slant -))
1880   (setq x-font-regexp-weight (concat - weight -))
1881   nil)
1882
1883
1884 (defun x-resolve-font-name (pattern &optional face frame)
1885   "Return a font name matching PATTERN.
1886 All wildcards in PATTERN are instantiated.
1887 If PATTERN is nil, return the name of the frame's base font, which never
1888 contains wildcards.
1889 Given optional arguments FACE and FRAME, return a font which is
1890 also the same size as FACE on FRAME, or fail."
1891   (or (symbolp face)
1892       (setq face (face-name face)))
1893   (and (eq frame t)
1894        (setq frame nil))
1895   (if pattern
1896       ;; Note that x-list-fonts has code to handle a face with nil as its font.
1897       (let ((fonts (x-list-fonts pattern face frame 1)))
1898         (or fonts
1899             (if face
1900                 (if (string-match "\\*" pattern)
1901                     (if (null (face-font face))
1902                         (error "No matching fonts are the same height as the frame default font")
1903                       (error "No matching fonts are the same height as face `%s'" face))
1904                   (if (null (face-font face))
1905                       (error "Height of font `%s' doesn't match the frame default font"
1906                              pattern)
1907                     (error "Height of font `%s' doesn't match face `%s'"
1908                            pattern face)))
1909               (error "No fonts match `%s'" pattern)))
1910         (car fonts))
1911     (cdr (assq 'font (frame-parameters (selected-frame))))))
1912
1913
1914 (defun x-frob-font-weight (font which)
1915   (let ((case-fold-search t))
1916     (cond ((string-match x-font-regexp font)
1917            (concat (substring font 0
1918                               (match-beginning x-font-regexp-weight-subnum))
1919                    which
1920                    (substring font (match-end x-font-regexp-weight-subnum)
1921                               (match-beginning x-font-regexp-adstyle-subnum))
1922                    ;; Replace the ADD_STYLE_NAME field with *
1923                    ;; because the info in it may not be the same
1924                    ;; for related fonts.
1925                    "*"
1926                    (substring font (match-end x-font-regexp-adstyle-subnum))))
1927           ((string-match x-font-regexp-head font)
1928            (concat (substring font 0 (match-beginning 1)) which
1929                    (substring font (match-end 1))))
1930           ((string-match x-font-regexp-weight font)
1931            (concat (substring font 0 (match-beginning 1)) which
1932                    (substring font (match-end 1)))))))
1933 (make-obsolete 'x-frob-font-weight 'make-face-... "21.1")
1934
1935 (defun x-frob-font-slant (font which)
1936   (let ((case-fold-search t))
1937     (cond ((string-match x-font-regexp font)
1938            (concat (substring font 0
1939                               (match-beginning x-font-regexp-slant-subnum))
1940                    which
1941                    (substring font (match-end x-font-regexp-slant-subnum)
1942                               (match-beginning x-font-regexp-adstyle-subnum))
1943                    ;; Replace the ADD_STYLE_NAME field with *
1944                    ;; because the info in it may not be the same
1945                    ;; for related fonts.
1946                    "*"
1947                    (substring font (match-end x-font-regexp-adstyle-subnum))))
1948           ((string-match x-font-regexp-head font)
1949            (concat (substring font 0 (match-beginning 2)) which
1950                    (substring font (match-end 2))))
1951           ((string-match x-font-regexp-slant font)
1952            (concat (substring font 0 (match-beginning 1)) which
1953                    (substring font (match-end 1)))))))
1954 (make-obsolete 'x-frob-font-slant 'make-face-... "21.1")
1955
1956 (defun x-make-font-bold (font)
1957   "Given an X font specification, make a bold version of it.
1958 If that can't be done, return nil."
1959   (x-frob-font-weight font "bold"))
1960 (make-obsolete 'x-make-font-bold 'make-face-bold "21.1")
1961
1962 (defun x-make-font-demibold (font)
1963   "Given an X font specification, make a demibold version of it.
1964 If that can't be done, return nil."
1965   (x-frob-font-weight font "demibold"))
1966 (make-obsolete 'x-make-font-demibold 'make-face-bold "21.1")
1967
1968 (defun x-make-font-unbold (font)
1969   "Given an X font specification, make a non-bold version of it.
1970 If that can't be done, return nil."
1971   (x-frob-font-weight font "medium"))
1972 (make-obsolete 'x-make-font-unbold 'make-face-unbold "21.1")
1973
1974 (defun x-make-font-italic (font)
1975   "Given an X font specification, make an italic version of it.
1976 If that can't be done, return nil."
1977   (x-frob-font-slant font "i"))
1978 (make-obsolete 'x-make-font-italic 'make-face-italic "21.1")
1979
1980 (defun x-make-font-oblique (font) ; you say tomayto...
1981   "Given an X font specification, make an oblique version of it.
1982 If that can't be done, return nil."
1983   (x-frob-font-slant font "o"))
1984 (make-obsolete 'x-make-font-oblique 'make-face-italic "21.1")
1985
1986 (defun x-make-font-unitalic (font)
1987   "Given an X font specification, make a non-italic version of it.
1988 If that can't be done, return nil."
1989   (x-frob-font-slant font "r"))
1990 (make-obsolete 'x-make-font-unitalic 'make-face-unitalic "21.1")
1991
1992 (defun x-make-font-bold-italic (font)
1993   "Given an X font specification, make a bold and italic version of it.
1994 If that can't be done, return nil."
1995   (and (setq font (x-make-font-bold font))
1996        (x-make-font-italic font)))
1997 (make-obsolete 'x-make-font-bold-italic 'make-face-bold-italic "21.1")
1998
1999 (provide 'faces)
2000
2001 ;;; faces.el ends here