lisp/faces.el

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