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