lisp/faces.el

   1 ;;; faces.el --- Lisp faces
   2
   3 ;; Copyright (C) 1992, 1993, 1994, 1995, 1996, 1998, 1999, 2000, 2001,
   4 ;;   2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010
   5 ;;   Free Software Foundation, Inc.
   6
   7 ;; Maintainer: FSF
   8 ;; Keywords: internal
   9 ;; Package: emacs
  10
  11 ;; This file is part of GNU Emacs.
  12
  13 ;; GNU Emacs is free software: you can redistribute it and/or modify
  14 ;; it under the terms of the GNU General Public License as published by
  15 ;; the Free Software Foundation, either version 3 of the License, or
  16 ;; (at your option) any later version.
  17
  18 ;; GNU Emacs is distributed in the hope that it will be useful,
  19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21 ;; GNU General Public License for more details.
  22
  23 ;; You should have received a copy of the GNU General Public License
  24 ;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
  25
  26 ;;; Commentary:
  27
  28 ;;; Code:
  29
  30 (eval-when-compile
  31   (require 'cl))
  32
  33 (declare-function xw-defined-colors "term/x-win" (&optional frame))
  34
  35 (defvar help-xref-stack-item)
  36
  37 (defvar face-name-history nil
  38   "History list for some commands that read face names.
  39 Maximum length of the history list is determined by the value
  40 of `history-length', which see.")
  41
  42 \f
  43 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
  44 ;;; Font selection.
  45 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
  46
  47 (defgroup font-selection nil
  48   "Influencing face font selection."
  49   :group 'faces)
  50
  51
  52 (defcustom face-font-selection-order
  53   '(:width :height :weight :slant)
  54   "A list specifying how face font selection chooses fonts.
  55 Each of the four symbols `:width', `:height', `:weight', and `:slant'
  56 must appear once in the list, and the list must not contain any other
  57 elements.  Font selection first tries to find a best matching font
  58 for those face attributes that appear before in the list.  For
  59 example, if `:slant' appears before `:height', font selection first
  60 tries to find a font with a suitable slant, even if this results in
  61 a font height that isn't optimal."
  62   :tag "Font selection order"
  63   :type '(list symbol symbol symbol symbol)
  64   :group 'font-selection
  65   :set #'(lambda (symbol value)
  66            (set-default symbol value)
  67            (internal-set-font-selection-order value)))
  68
  69
  70 ;; In the absence of Fontconfig support, Monospace and Sans Serif are
  71 ;; unavailable, and we fall back on the courier and helv families,
  72 ;; which are generally available.
  73 (defcustom face-font-family-alternatives
  74   (mapcar (lambda (arg) (mapcar 'purecopy arg))
  75   '(("Monospace" "courier" "fixed")
  76     ("courier" "CMU Typewriter Text" "fixed")
  77     ("Sans Serif" "helv" "helvetica" "arial" "fixed")
  78     ("helv" "helvetica" "arial" "fixed")))
  79   "Alist of alternative font family names.
  80 Each element has the form (FAMILY ALTERNATIVE1 ALTERNATIVE2 ...).
  81 If fonts of family FAMILY can't be loaded, try ALTERNATIVE1, then
  82 ALTERNATIVE2 etc."
  83   :tag "Alternative font families to try"
  84   :type '(repeat (repeat string))
  85   :group 'font-selection
  86   :set #'(lambda (symbol value)
  87            (set-default symbol value)
  88            (internal-set-alternative-font-family-alist value)))
  89
  90
  91 ;; This is defined originally in xfaces.c.
  92 (defcustom face-font-registry-alternatives
  93   (mapcar (lambda (arg) (mapcar 'purecopy arg))
  94   (if (eq system-type 'windows-nt)
  95       '(("iso8859-1" "ms-oemlatin")
  96         ("gb2312.1980" "gb2312" "gbk" "gb18030")
  97         ("jisx0208.1990" "jisx0208.1983" "jisx0208.1978")
  98         ("ksc5601.1989" "ksx1001.1992" "ksc5601.1987")
  99         ("muletibetan-2" "muletibetan-0"))
 100     '(("gb2312.1980" "gb2312.80&gb8565.88" "gbk" "gb18030")
 101       ("jisx0208.1990" "jisx0208.1983" "jisx0208.1978")
 102       ("ksc5601.1989" "ksx1001.1992" "ksc5601.1987")
 103       ("muletibetan-2" "muletibetan-0"))))
 104   "Alist of alternative font registry names.
 105 Each element has the form (REGISTRY ALTERNATIVE1 ALTERNATIVE2 ...).
 106 If fonts of registry REGISTRY can be loaded, font selection
 107 tries to find a best matching font among all fonts of registry
 108 REGISTRY, ALTERNATIVE1, ALTERNATIVE2, and etc."
 109   :tag "Alternative font registries to try"
 110   :type '(repeat (repeat string))
 111   :version "21.1"
 112   :group 'font-selection
 113   :set #'(lambda (symbol value)
 114            (set-default symbol value)
 115            (internal-set-alternative-font-registry-alist value)))
 116
 117 \f
 118 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 119 ;;; Creation, copying.
 120 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 121
 122
 123 (defun face-list ()
 124   "Return a list of all defined face names."
 125   (mapcar #'car face-new-frame-defaults))
 126
 127
 128 ;;; ### If not frame-local initialize by what X resources?
 129
 130 (defun make-face (face &optional no-init-from-resources)
 131   "Define a new face with name FACE, a symbol.
 132 NO-INIT-FROM-RESOURCES non-nil means don't initialize frame-local
 133 variants of FACE from X resources.  (X resources recognized are found
 134 in the global variable `face-x-resources'.)  If FACE is already known
 135 as a face, leave it unmodified.  Value is FACE."
 136   (interactive (list (read-from-minibuffer
 137                       "Make face: " nil nil t 'face-name-history)))
 138   (unless (facep face)
 139     ;; Make frame-local faces (this also makes the global one).
 140     (dolist (frame (frame-list))
 141       (internal-make-lisp-face face frame))
 142     ;; Add the face to the face menu.
 143     (when (fboundp 'facemenu-add-new-face)
 144       (facemenu-add-new-face face))
 145     ;; Define frame-local faces for all frames from X resources.
 146     (unless no-init-from-resources
 147       (make-face-x-resource-internal face)))
 148   face)
 149
 150
 151 (defun make-empty-face (face)
 152   "Define a new, empty face with name FACE.
 153 If the face already exists, it is left unmodified.  Value is FACE."
 154   (interactive (list (read-from-minibuffer
 155                       "Make empty face: " nil nil t 'face-name-history)))
 156   (make-face face 'no-init-from-resources))
 157
 158
 159 (defun copy-face (old-face new-face &optional frame new-frame)
 160   "Define a face just like OLD-FACE, with name NEW-FACE.
 161
 162 If NEW-FACE already exists as a face, it is modified to be like
 163 OLD-FACE.  If it doesn't already exist, it is created.
 164
 165 If the optional argument FRAME is given as a frame, NEW-FACE is
 166 changed on FRAME only.
 167 If FRAME is t, the frame-independent default specification for OLD-FACE
 168 is copied to NEW-FACE.
 169 If FRAME is nil, copying is done for the frame-independent defaults
 170 and for each existing frame.
 171
 172 If the optional fourth argument NEW-FRAME is given,
 173 copy the information from face OLD-FACE on frame FRAME
 174 to NEW-FACE on frame NEW-FRAME.  In this case, FRAME may not be nil."
 175   (let ((inhibit-quit t))
 176     (if (null frame)
 177         (progn
 178           (when new-frame
 179             (error "Copying face %s from all frames to one frame"
 180                    old-face))
 181           (make-empty-face new-face)
 182           (dolist (frame (frame-list))
 183             (copy-face old-face new-face frame))
 184           (copy-face old-face new-face t))
 185       (make-empty-face new-face)
 186       (internal-copy-lisp-face old-face new-face frame new-frame))
 187     new-face))
 188
 189
 190 \f
 191 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 192 ;;; Obsolete functions
 193 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 194
 195 ;; The functions in this section are defined because Lisp packages use
 196 ;; them, despite the prefix `internal-' suggesting that they are
 197 ;; private to the face implementation.
 198
 199 (defun internal-find-face (name &optional frame)
 200   "Retrieve the face named NAME.
 201 Return nil if there is no such face.
 202 If NAME is already a face, it is simply returned.
 203 The optional argument FRAME is ignored."
 204   (facep name))
 205 (make-obsolete 'internal-find-face 'facep "21.1")
 206
 207
 208 (defun internal-get-face (name &optional frame)
 209   "Retrieve the face named NAME; error if there is none.
 210 If NAME is already a face, it is simply returned.
 211 The optional argument FRAME is ignored."
 212   (or (facep name)
 213       (check-face name)))
 214 (make-obsolete 'internal-get-face "see `facep' and `check-face'." "21.1")
 215
 216 \f
 217 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 218 ;;; Predicates, type checks.
 219 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 220
 221 (defun facep (face)
 222   "Return non-nil if FACE is a face name; nil otherwise.
 223 A face name can be a string or a symbol."
 224   (internal-lisp-face-p face))
 225
 226
 227 (defun check-face (face)
 228   "Signal an error if FACE doesn't name a face.
 229 Value is FACE."
 230   (unless (facep face)
 231     (error "Not a face: %s" face))
 232   face)
 233
 234
 235 ;; The ID returned is not to be confused with the internally used IDs
 236 ;; of realized faces.  The ID assigned to Lisp faces is used to
 237 ;; support faces in display table entries.
 238
 239 (defun face-id (face &optional frame)
 240   "Return the internal ID of face with name FACE.
 241 If FACE is a face-alias, return the ID of the target face.
 242 The optional argument FRAME is ignored, since the internal face ID
 243 of a face name is the same for all frames."
 244   (check-face face)
 245   (or (get face 'face)
 246       (face-id (get face 'face-alias))))
 247
 248 (defun face-equal (face1 face2 &optional frame)
 249   "Non-nil if faces FACE1 and FACE2 are equal.
 250 Faces are considered equal if all their attributes are equal.
 251 If the optional argument FRAME is given, report on FACE1 and FACE2 in that frame.
 252 If FRAME is t, report on the defaults for FACE1 and FACE2 (for new frames).
 253 If FRAME is omitted or nil, use the selected frame."
 254   (internal-lisp-face-equal-p face1 face2 frame))
 255
 256
 257 (defun face-differs-from-default-p (face &optional frame)
 258   "Return non-nil if FACE displays differently from the default face.
 259 If the optional argument FRAME is given, report on face FACE in that frame.
 260 If FRAME is t, report on the defaults for face FACE (for new frames).
 261 If FRAME is omitted or nil, use the selected frame."
 262   (let ((attrs
 263          (delq :inherit (mapcar 'car face-attribute-name-alist)))
 264         (differs nil))
 265     (while (and attrs (not differs))
 266       (let* ((attr (pop attrs))
 267              (attr-val (face-attribute face attr frame t)))
 268         (when (and
 269                (not (eq attr-val 'unspecified))
 270                (display-supports-face-attributes-p (list attr attr-val)
 271                                                    frame))
 272           (setq differs attr))))
 273     differs))
 274
 275
 276 (defun face-nontrivial-p (face &optional frame)
 277   "True if face FACE has some non-nil attribute.
 278 If the optional argument FRAME is given, report on face FACE in that frame.
 279 If FRAME is t, report on the defaults for face FACE (for new frames).
 280 If FRAME is omitted or nil, use the selected frame."
 281   (not (internal-lisp-face-empty-p face frame)))
 282
 283
 284 \f
 285 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 286 ;;; Setting face attributes from X resources.
 287 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 288
 289 (defcustom face-x-resources
 290   (mapcar
 291    (lambda (arg)
 292      ;; FIXME; can we purecopy some of the conses too?
 293      (cons (car arg)
 294            (cons (purecopy (car (cdr arg))) (purecopy (cdr (cdr arg))))))
 295   '((:family (".attributeFamily" . "Face.AttributeFamily"))
 296     (:foundry (".attributeFoundry" . "Face.AttributeFoundry"))
 297     (:width (".attributeWidth" . "Face.AttributeWidth"))
 298     (:height (".attributeHeight" . "Face.AttributeHeight"))
 299     (:weight (".attributeWeight" . "Face.AttributeWeight"))
 300     (:slant (".attributeSlant" . "Face.AttributeSlant"))
 301     (:foreground (".attributeForeground" . "Face.AttributeForeground"))
 302     (:background (".attributeBackground" . "Face.AttributeBackground"))
 303     (:overline (".attributeOverline" . "Face.AttributeOverline"))
 304     (:strike-through (".attributeStrikeThrough" . "Face.AttributeStrikeThrough"))
 305     (:box (".attributeBox" . "Face.AttributeBox"))
 306     (:underline (".attributeUnderline" . "Face.AttributeUnderline"))
 307     (:inverse-video (".attributeInverse" . "Face.AttributeInverse"))
 308     (:stipple
 309      (".attributeStipple" . "Face.AttributeStipple")
 310      (".attributeBackgroundPixmap" . "Face.AttributeBackgroundPixmap"))
 311     (:bold (".attributeBold" . "Face.AttributeBold"))
 312     (:italic (".attributeItalic" . "Face.AttributeItalic"))
 313     (:font (".attributeFont" . "Face.AttributeFont"))
 314     (:inherit (".attributeInherit" . "Face.AttributeInherit"))))
 315   "List of X resources and classes for face attributes.
 316 Each element has the form (ATTRIBUTE ENTRY1 ENTRY2...) where ATTRIBUTE is
 317 the name of a face attribute, and each ENTRY is a cons of the form
 318 \(RESOURCE . CLASS) with RESOURCE being the resource and CLASS being the
 319 X resource class for the attribute."
 320   :type '(repeat (cons symbol (repeat (cons string string))))
 321   :group 'faces)
 322
 323
 324 (declare-function internal-face-x-get-resource "xfaces.c"
 325                   (resource class frame))
 326
 327 (declare-function internal-set-lisp-face-attribute-from-resource "xfaces.c"
 328                   (face attr value &optional frame))
 329
 330 (defun set-face-attribute-from-resource (face attribute resource class frame)
 331   "Set FACE's ATTRIBUTE from X resource RESOURCE, class CLASS on FRAME.
 332 Value is the attribute value specified by the resource, or nil
 333 if not present.  This function displays a message if the resource
 334 specifies an invalid attribute."
 335   (let* ((face-name (face-name face))
 336          (value (internal-face-x-get-resource (concat face-name resource)
 337                                               class frame)))
 338     (when value
 339       (condition-case ()
 340           (internal-set-lisp-face-attribute-from-resource
 341            face attribute (downcase value) frame)
 342         (error
 343          (message "Face %s, frame %s: invalid attribute %s %s from X resource"
 344                   face-name frame attribute value))))
 345     value))
 346
 347
 348 (defun set-face-attributes-from-resources (face frame)
 349   "Set attributes of FACE from X resources for FRAME."
 350   (when (memq (framep frame) '(x w32))
 351     (dolist (definition face-x-resources)
 352       (let ((attribute (car definition)))
 353         (dolist (entry (cdr definition))
 354           (set-face-attribute-from-resource face attribute (car entry)
 355                                             (cdr entry) frame))))))
 356
 357
 358 (defun make-face-x-resource-internal (face &optional frame)
 359   "Fill frame-local FACE on FRAME from X resources.
 360 FRAME nil or not specified means do it for all frames."
 361   (if (null frame)
 362       (dolist (frame (frame-list))
 363         (set-face-attributes-from-resources face frame))
 364     (set-face-attributes-from-resources face frame)))
 365
 366
 367 \f
 368 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 369 ;;; Retrieving face attributes.
 370 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 371
 372 (defun face-name (face)
 373   "Return the name of face FACE."
 374   (symbol-name (check-face face)))
 375
 376
 377 (defun face-all-attributes (face &optional frame)
 378   "Return an alist stating the attributes of FACE.
 379 Each element of the result has the form (ATTR-NAME . ATTR-VALUE).
 380 If FRAME is omitted or nil the value describes the default attributes,
 381 but if you specify FRAME, the value describes the attributes
 382 of FACE on FRAME."
 383   (mapcar (lambda (pair)
 384             (let ((attr (car pair)))
 385               (cons attr (face-attribute face attr (or frame t)))))
 386           face-attribute-name-alist))
 387
 388 (defun face-attribute (face attribute &optional frame inherit)
 389   "Return the value of FACE's ATTRIBUTE on FRAME.
 390 If the optional argument FRAME is given, report on face FACE in that frame.
 391 If FRAME is t, report on the defaults for face FACE (for new frames).
 392 If FRAME is omitted or nil, use the selected frame.
 393
 394 If INHERIT is nil, only attributes directly defined by FACE are considered,
 395   so the return value may be `unspecified', or a relative value.
 396 If INHERIT is non-nil, FACE's definition of ATTRIBUTE is merged with the
 397   faces specified by its `:inherit' attribute; however the return value
 398   may still be `unspecified' or relative.
 399 If INHERIT is a face or a list of faces, then the result is further merged
 400   with that face (or faces), until it becomes specified and absolute.
 401
 402 To ensure that the return value is always specified and absolute, use a
 403 value of `default' for INHERIT; this will resolve any unspecified or
 404 relative values by merging with the `default' face (which is always
 405 completely specified)."
 406   (let ((value (internal-get-lisp-face-attribute face attribute frame)))
 407     (when (and inherit (face-attribute-relative-p attribute value))
 408       ;; VALUE is relative, so merge with inherited faces
 409       (let ((inh-from (face-attribute face :inherit frame)))
 410         (unless (or (null inh-from) (eq inh-from 'unspecified))
 411           (condition-case nil
 412               (setq value
 413                     (face-attribute-merged-with attribute value inh-from frame))
 414             ;; The `inherit' attribute may point to non existent faces.
 415             (error nil)))))
 416     (when (and inherit
 417                (not (eq inherit t))
 418                (face-attribute-relative-p attribute value))
 419       ;; We should merge with INHERIT as well
 420       (setq value (face-attribute-merged-with attribute value inherit frame)))
 421     value))
 422
 423 (defun face-attribute-merged-with (attribute value faces &optional frame)
 424   "Merges ATTRIBUTE, initially VALUE, with faces from FACES until absolute.
 425 FACES may be either a single face or a list of faces.
 426 \[This is an internal function.]"
 427   (cond ((not (face-attribute-relative-p attribute value))
 428          value)
 429         ((null faces)
 430          value)
 431         ((consp faces)
 432          (face-attribute-merged-with
 433           attribute
 434           (face-attribute-merged-with attribute value (car faces) frame)
 435           (cdr faces)
 436           frame))
 437         (t
 438          (merge-face-attribute attribute
 439                                value
 440                                (face-attribute faces attribute frame t)))))
 441
 442
 443 (defmacro face-attribute-specified-or (value &rest body)
 444   "Return VALUE, unless it's `unspecified', in which case evaluate BODY and return the result."
 445   (let ((temp (make-symbol "value")))
 446     `(let ((,temp ,value))
 447        (if (not (eq ,temp 'unspecified))
 448            ,temp
 449          ,@body))))
 450
 451 (defun face-foreground (face &optional frame inherit)
 452   "Return the foreground color name of FACE, or nil if unspecified.
 453 If the optional argument FRAME is given, report on face FACE in that frame.
 454 If FRAME is t, report on the defaults for face FACE (for new frames).
 455 If FRAME is omitted or nil, use the selected frame.
 456
 457 If INHERIT is nil, only a foreground color directly defined by FACE is
 458   considered, so the return value may be nil.
 459 If INHERIT is t, and FACE doesn't define a foreground color, then any
 460   foreground color that FACE inherits through its `:inherit' attribute
 461   is considered as well; however the return value may still be nil.
 462 If INHERIT is a face or a list of faces, then it is used to try to
 463   resolve an unspecified foreground color.
 464
 465 To ensure that a valid color is always returned, use a value of
 466 `default' for INHERIT; this will resolve any unspecified values by
 467 merging with the `default' face (which is always completely specified)."
 468   (face-attribute-specified-or (face-attribute face :foreground frame inherit)
 469                                nil))
 470
 471 (defun face-background (face &optional frame inherit)
 472   "Return the background color name of FACE, or nil if unspecified.
 473 If the optional argument FRAME is given, report on face FACE in that frame.
 474 If FRAME is t, report on the defaults for face FACE (for new frames).
 475 If FRAME is omitted or nil, use the selected frame.
 476
 477 If INHERIT is nil, only a background color directly defined by FACE is
 478   considered, so the return value may be nil.
 479 If INHERIT is t, and FACE doesn't define a background color, then any
 480   background color that FACE inherits through its `:inherit' attribute
 481   is considered as well; however the return value may still be nil.
 482 If INHERIT is a face or a list of faces, then it is used to try to
 483   resolve an unspecified background color.
 484
 485 To ensure that a valid color is always returned, use a value of
 486 `default' for INHERIT; this will resolve any unspecified values by
 487 merging with the `default' face (which is always completely specified)."
 488   (face-attribute-specified-or (face-attribute face :background frame inherit)
 489                                nil))
 490
 491 (defun face-stipple (face &optional frame inherit)
 492  "Return the stipple pixmap name of FACE, or nil if unspecified.
 493 If the optional argument FRAME is given, report on face FACE in that frame.
 494 If FRAME is t, report on the defaults for face FACE (for new frames).
 495 If FRAME is omitted or nil, use the selected frame.
 496
 497 If INHERIT is nil, only a stipple directly defined by FACE is
 498   considered, so the return value may be nil.
 499 If INHERIT is t, and FACE doesn't define a stipple, then any stipple
 500   that FACE inherits through its `:inherit' attribute is considered as
 501   well; however the return value may still be nil.
 502 If INHERIT is a face or a list of faces, then it is used to try to
 503   resolve an unspecified stipple.
 504
 505 To ensure that a valid stipple or nil is always returned, use a value of
 506 `default' for INHERIT; this will resolve any unspecified values by merging
 507 with the `default' face (which is always completely specified)."
 508   (face-attribute-specified-or (face-attribute face :stipple frame inherit)
 509                                nil))
 510
 511
 512 (defalias 'face-background-pixmap 'face-stipple)
 513
 514
 515 (defun face-underline-p (face &optional frame)
 516  "Return non-nil if FACE is underlined.
 517 If the optional argument FRAME is given, report on face FACE in that frame.
 518 If FRAME is t, report on the defaults for face FACE (for new frames).
 519 If FRAME is omitted or nil, use the selected frame."
 520  (eq (face-attribute face :underline frame) t))
 521
 522
 523 (defun face-inverse-video-p (face &optional frame)
 524  "Return non-nil if FACE is in inverse video on FRAME.
 525 If the optional argument FRAME is given, report on face FACE in that frame.
 526 If FRAME is t, report on the defaults for face FACE (for new frames).
 527 If FRAME is omitted or nil, use the selected frame."
 528  (eq (face-attribute face :inverse-video frame) t))
 529
 530
 531 (defun face-bold-p (face &optional frame)
 532   "Return non-nil if the font of FACE is bold on FRAME.
 533 If the optional argument FRAME is given, report on face FACE in that frame.
 534 If FRAME is t, report on the defaults for face FACE (for new frames).
 535 If FRAME is omitted or nil, use the selected frame.
 536 Use `face-attribute' for finer control."
 537   (let ((bold (face-attribute face :weight frame)))
 538     (memq bold '(semi-bold bold extra-bold ultra-bold))))
 539
 540
 541 (defun face-italic-p (face &optional frame)
 542   "Return non-nil if the font of FACE is italic on FRAME.
 543 If the optional argument FRAME is given, report on face FACE in that frame.
 544 If FRAME is t, report on the defaults for face FACE (for new frames).
 545 If FRAME is omitted or nil, use the selected frame.
 546 Use `face-attribute' for finer control."
 547   (let ((italic (face-attribute face :slant frame)))
 548     (memq italic '(italic oblique))))
 549
 550
 551 \f
 552 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 553 ;;; Face documentation.
 554 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 555
 556 (defun face-documentation (face)
 557   "Get the documentation string for FACE.
 558 If FACE is a face-alias, get the documentation for the target face."
 559   (let ((alias (get face 'face-alias))
 560         doc)
 561     (if alias
 562         (progn
 563           (setq doc (get alias 'face-documentation))
 564           (format "%s is an alias for the face `%s'.%s" face alias
 565                   (if doc (format "\n%s" doc)
 566                     "")))
 567       (get face 'face-documentation))))
 568
 569
 570 (defun set-face-documentation (face string)
 571   "Set the documentation string for FACE to STRING."
 572   ;; Perhaps the text should go in DOC.
 573   (put face 'face-documentation (purecopy string)))
 574
 575
 576 (defalias 'face-doc-string 'face-documentation)
 577 (defalias 'set-face-doc-string 'set-face-documentation)
 578
 579
 580 \f
 581 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 582 ;; Setting face attributes.
 583 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 584
 585
 586 (defun set-face-attribute (face frame &rest args)
 587   "Set attributes of FACE on FRAME from ARGS.
 588
 589 FRAME nil means change attributes on all frames.  FRAME t means change
 590 the default for new frames (this is done automatically each time an
 591 attribute is changed on all frames).
 592
 593 ARGS must come in pairs ATTRIBUTE VALUE.  ATTRIBUTE must be a valid
 594 face attribute name.  All attributes can be set to `unspecified';
 595 this fact is not further mentioned below.
 596
 597 The following attributes are recognized:
 598
 599 `:family'
 600
 601 VALUE must be a string specifying the font family, e.g. ``monospace'',
 602 or a fontset alias name.  If a font family is specified, wild-cards `*'
 603 and `?' are allowed.
 604
 605 `:foundry'
 606
 607 VALUE must be a string specifying the font foundry,
 608 e.g. ``adobe''.  If a font foundry is specified, wild-cards `*'
 609 and `?' are allowed.
 610
 611 `:width'
 612
 613 VALUE specifies the relative proportionate width of the font to use.
 614 It must be one of the symbols `ultra-condensed', `extra-condensed',
 615 `condensed', `semi-condensed', `normal', `semi-expanded', `expanded',
 616 `extra-expanded', or `ultra-expanded'.
 617
 618 `:height'
 619
 620 VALUE must be either an integer specifying the height of the font to use
 621 in 1/10 pt, a floating point number specifying the amount by which to
 622 scale any underlying face, or a function, which is called with the old
 623 height (from the underlying face), and should return the new height.
 624
 625 `:weight'
 626
 627 VALUE specifies the weight of the font to use.  It must be one of the
 628 symbols `ultra-bold', `extra-bold', `bold', `semi-bold', `normal',
 629 `semi-light', `light', `extra-light', `ultra-light'.
 630
 631 `:slant'
 632
 633 VALUE specifies the slant of the font to use.  It must be one of the
 634 symbols `italic', `oblique', `normal', `reverse-italic', or
 635 `reverse-oblique'.
 636
 637 `:foreground', `:background'
 638
 639 VALUE must be a color name, a string.
 640
 641 `:underline'
 642
 643 VALUE specifies whether characters in FACE should be underlined.  If
 644 VALUE is t, underline with foreground color of the face.  If VALUE is
 645 a string, underline with that color.  If VALUE is nil, explicitly
 646 don't underline.
 647
 648 `:overline'
 649
 650 VALUE specifies whether characters in FACE should be overlined.  If
 651 VALUE is t, overline with foreground color of the face.  If VALUE is a
 652 string, overline with that color.  If VALUE is nil, explicitly don't
 653 overline.
 654
 655 `:strike-through'
 656
 657 VALUE specifies whether characters in FACE should be drawn with a line
 658 striking through them.  If VALUE is t, use the foreground color of the
 659 face.  If VALUE is a string, strike-through with that color.  If VALUE
 660 is nil, explicitly don't strike through.
 661
 662 `:box'
 663
 664 VALUE specifies whether characters in FACE should have a box drawn
 665 around them.  If VALUE is nil, explicitly don't draw boxes.  If
 666 VALUE is t, draw a box with lines of width 1 in the foreground color
 667 of the face.  If VALUE is a string, the string must be a color name,
 668 and the box is drawn in that color with a line width of 1.  Otherwise,
 669 VALUE must be a property list of the form `(:line-width WIDTH
 670 :color COLOR :style STYLE)'.  If a keyword/value pair is missing from
 671 the property list, a default value will be used for the value, as
 672 specified below.  WIDTH specifies the width of the lines to draw; it
 673 defaults to 1.  If WIDTH is negative, the absolute value is the width
 674 of the lines, and draw top/bottom lines inside the characters area,
 675 not around it.  COLOR is the name of the color to draw in, default is
 676 the foreground color of the face for simple boxes, and the background
 677 color of the face for 3D boxes.  STYLE specifies whether a 3D box
 678 should be draw.  If STYLE is `released-button', draw a box looking
 679 like a released 3D button.  If STYLE is `pressed-button' draw a box
 680 that appears like a pressed button.  If STYLE is nil, the default if
 681 the property list doesn't contain a style specification, draw a 2D
 682 box.
 683
 684 `:inverse-video'
 685
 686 VALUE specifies whether characters in FACE should be displayed in
 687 inverse video.  VALUE must be one of t or nil.
 688
 689 `:stipple'
 690
 691 If VALUE is a string, it must be the name of a file of pixmap data.
 692 The directories listed in the `x-bitmap-file-path' variable are
 693 searched.  Alternatively, VALUE may be a list of the form (WIDTH
 694 HEIGHT DATA) where WIDTH and HEIGHT are the size in pixels, and DATA
 695 is a string containing the raw bits of the bitmap.  VALUE nil means
 696 explicitly don't use a stipple pattern.
 697
 698 For convenience, attributes `:family', `:foundry', `:width',
 699 `:height', `:weight', and `:slant' may also be set in one step
 700 from an X font name:
 701
 702 `:font'
 703
 704 Set font-related face attributes from VALUE.  VALUE must be a valid
 705 XLFD font name.  If it is a font name pattern, the first matching font
 706 will be used.
 707
 708 For compatibility with Emacs 20, keywords `:bold' and `:italic' can
 709 be used to specify that a bold or italic font should be used.  VALUE
 710 must be t or nil in that case.  A value of `unspecified' is not allowed.
 711
 712 `:inherit'
 713
 714 VALUE is the name of a face from which to inherit attributes, or a list
 715 of face names.  Attributes from inherited faces are merged into the face
 716 like an underlying face would be, with higher priority than underlying faces."
 717   (setq args (purecopy args))
 718   (let ((where (if (null frame) 0 frame))
 719         (spec args)
 720         family foundry)
 721     ;; If we set the new-frame defaults, this face is modified outside Custom.
 722     (if (memq where '(0 t))
 723         (put (or (get face 'face-alias) face) 'face-modified t))
 724     ;; If family and/or foundry are specified, set it first.  Certain
 725     ;; face attributes, e.g. :weight semi-condensed, are not supported
 726     ;; in every font.  See bug#1127.
 727     (while spec
 728       (cond ((eq (car spec) :family)
 729              (setq family (cadr spec)))
 730             ((eq (car spec) :foundry)
 731              (setq foundry (cadr spec))))
 732       (setq spec (cddr spec)))
 733     (when (or family foundry)
 734       (when (and (stringp family)
 735                  (string-match "\\([^-]*\\)-\\([^-]*\\)" family))
 736         (unless foundry
 737           (setq foundry (match-string 1 family)))
 738         (setq family (match-string 2 family)))
 739       (when (or (stringp family) (eq family 'unspecified))
 740         (internal-set-lisp-face-attribute face :family (purecopy family)
 741                                           where))
 742       (when (or (stringp foundry) (eq foundry 'unspecified))
 743         (internal-set-lisp-face-attribute face :foundry (purecopy foundry)
 744                                           where)))
 745     (while args
 746       (unless (memq (car args) '(:family :foundry))
 747         (internal-set-lisp-face-attribute face (car args)
 748                                           (purecopy (cadr args))
 749                                           where))
 750       (setq args (cddr args)))))
 751
 752 (defun make-face-bold (face &optional frame noerror)
 753   "Make the font of FACE be bold, if possible.
 754 FRAME nil or not specified means change face on all frames.
 755 Argument NOERROR is ignored and retained for compatibility.
 756 Use `set-face-attribute' for finer control of the font weight."
 757   (interactive (list (read-face-name "Make which face bold")))
 758   (set-face-attribute face frame :weight 'bold))
 759
 760
 761 (defun make-face-unbold (face &optional frame noerror)
 762   "Make the font of FACE be non-bold, if possible.
 763 FRAME nil or not specified means change face on all frames.
 764 Argument NOERROR is ignored and retained for compatibility."
 765   (interactive (list (read-face-name "Make which face non-bold")))
 766   (set-face-attribute face frame :weight 'normal))
 767
 768
 769 (defun make-face-italic (face &optional frame noerror)
 770   "Make the font of FACE be italic, if possible.
 771 FRAME nil or not specified means change face on all frames.
 772 Argument NOERROR is ignored and retained for compatibility.
 773 Use `set-face-attribute' for finer control of the font slant."
 774   (interactive (list (read-face-name "Make which face italic")))
 775   (set-face-attribute face frame :slant 'italic))
 776
 777
 778 (defun make-face-unitalic (face &optional frame noerror)
 779   "Make the font of FACE be non-italic, if possible.
 780 FRAME nil or not specified means change face on all frames.
 781 Argument NOERROR is ignored and retained for compatibility."
 782   (interactive (list (read-face-name "Make which face non-italic")))
 783   (set-face-attribute face frame :slant 'normal))
 784
 785
 786 (defun make-face-bold-italic (face &optional frame noerror)
 787   "Make the font of FACE be bold and italic, if possible.
 788 FRAME nil or not specified means change face on all frames.
 789 Argument NOERROR is ignored and retained for compatibility.
 790 Use `set-face-attribute' for finer control of font weight and slant."
 791   (interactive (list (read-face-name "Make which face bold-italic")))
 792   (set-face-attribute face frame :weight 'bold :slant 'italic))
 793
 794
 795 (defun set-face-font (face font &optional frame)
 796   "Change font-related attributes of FACE to those of FONT (a string).
 797 FRAME nil or not specified means change face on all frames.
 798 This sets the attributes `:family', `:foundry', `:width',
 799 `:height', `:weight', and `:slant'.  When called interactively,
 800 prompt for the face and font."
 801   (interactive (read-face-and-attribute :font))
 802   (set-face-attribute face frame :font font))
 803
 804
 805 ;; Implementation note: Emulating gray background colors with a
 806 ;; stipple pattern is now part of the face realization process, and is
 807 ;; done in C depending on the frame on which the face is realized.
 808
 809 (defun set-face-background (face color &optional frame)
 810   "Change the background color of face FACE to COLOR (a string).
 811 FRAME nil or not specified means change face on all frames.
 812 COLOR can be a system-defined color name (see `list-colors-display')
 813 or a hex spec of the form #RRGGBB.
 814 When called interactively, prompts for the face and color."
 815   (interactive (read-face-and-attribute :background))
 816   (set-face-attribute face frame :background (or color 'unspecified)))
 817
 818
 819 (defun set-face-foreground (face color &optional frame)
 820   "Change the foreground color of face FACE to COLOR (a string).
 821 FRAME nil or not specified means change face on all frames.
 822 COLOR can be a system-defined color name (see `list-colors-display')
 823 or a hex spec of the form #RRGGBB.
 824 When called interactively, prompts for the face and color."
 825   (interactive (read-face-and-attribute :foreground))
 826   (set-face-attribute face frame :foreground (or color 'unspecified)))
 827
 828
 829 (defun set-face-stipple (face stipple &optional frame)
 830   "Change the stipple pixmap of face FACE to STIPPLE.
 831 FRAME nil or not specified means change face on all frames.
 832 STIPPLE should be a string, the name of a file of pixmap data.
 833 The directories listed in the `x-bitmap-file-path' variable are searched.
 834
 835 Alternatively, STIPPLE may be a list of the form (WIDTH HEIGHT DATA)
 836 where WIDTH and HEIGHT are the size in pixels,
 837 and DATA is a string, containing the raw bits of the bitmap."
 838   (interactive (read-face-and-attribute :stipple))
 839   (set-face-attribute face frame :stipple (or stipple 'unspecified)))
 840
 841
 842 (defun set-face-underline-p (face underline &optional frame)
 843   "Specify whether face FACE is underlined.
 844 UNDERLINE nil means FACE explicitly doesn't underline.
 845 UNDERLINE non-nil means FACE explicitly does underlining
 846 with the same of the foreground color.
 847 If UNDERLINE is a string, underline with the color named UNDERLINE.
 848 FRAME nil or not specified means change face on all frames.
 849 Use `set-face-attribute' to ``unspecify'' underlining."
 850   (interactive
 851    (let ((list (read-face-and-attribute :underline)))
 852      (list (car list) (eq (car (cdr list)) t))))
 853   (set-face-attribute face frame :underline underline))
 854
 855 (define-obsolete-function-alias 'set-face-underline
 856                                 'set-face-underline-p "22.1")
 857
 858
 859 (defun set-face-inverse-video-p (face inverse-video-p &optional frame)
 860   "Specify whether face FACE is in inverse video.
 861 INVERSE-VIDEO-P non-nil means FACE displays explicitly in inverse video.
 862 INVERSE-VIDEO-P nil means FACE explicitly is not in inverse video.
 863 FRAME nil or not specified means change face on all frames.
 864 Use `set-face-attribute' to ``unspecify'' the inverse video attribute."
 865   (interactive
 866    (let ((list (read-face-and-attribute :inverse-video)))
 867      (list (car list) (eq (car (cdr list)) t))))
 868   (set-face-attribute face frame :inverse-video inverse-video-p))
 869
 870
 871 (defun set-face-bold-p (face bold-p &optional frame)
 872   "Specify whether face FACE is bold.
 873 BOLD-P non-nil means FACE should explicitly display bold.
 874 BOLD-P nil means FACE should explicitly display non-bold.
 875 FRAME nil or not specified means change face on all frames.
 876 Use `set-face-attribute' or `modify-face' for finer control."
 877   (if (null bold-p)
 878       (make-face-unbold face frame)
 879     (make-face-bold face frame)))
 880
 881
 882 (defun set-face-italic-p (face italic-p &optional frame)
 883   "Specify whether face FACE is italic.
 884 ITALIC-P non-nil means FACE should explicitly display italic.
 885 ITALIC-P nil means FACE should explicitly display non-italic.
 886 FRAME nil or not specified means change face on all frames.
 887 Use `set-face-attribute' or `modify-face' for finer control."
 888   (if (null italic-p)
 889       (make-face-unitalic face frame)
 890     (make-face-italic face frame)))
 891
 892
 893 (defalias 'set-face-background-pixmap 'set-face-stipple)
 894
 895
 896 (defun invert-face (face &optional frame)
 897   "Swap the foreground and background colors of FACE.
 898 If FRAME is omitted or nil, it means change face on all frames.
 899 If FACE specifies neither foreground nor background color,
 900 set its foreground and background to the background and foreground
 901 of the default face.  Value is FACE."
 902   (interactive (list (read-face-name "Invert face")))
 903   (let ((fg (face-attribute face :foreground frame))
 904         (bg (face-attribute face :background frame)))
 905     (if (not (and (eq fg 'unspecified) (eq bg 'unspecified)))
 906         (set-face-attribute face frame :foreground bg :background fg)
 907       (set-face-attribute face frame
 908                           :foreground
 909                           (face-attribute 'default :background frame)
 910                           :background
 911                           (face-attribute 'default :foreground frame))))
 912   face)
 913
 914 \f
 915 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 916 ;;; Interactively modifying faces.
 917 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 918
 919 (defun read-face-name (prompt &optional default multiple)
 920   "Read a face, defaulting to the face or faces on the char after point.
 921 If it has the property `read-face-name', that overrides the `face' property.
 922 PROMPT should be a string that describes what the caller will do with the face;
 923 it should not end in a space.
 924 The optional argument DEFAULT provides the value to display in the
 925 minibuffer prompt that is returned if the user just types RET
 926 unless DEFAULT is a string (in which case nil is returned).
 927 If MULTIPLE is non-nil, return a list of faces (possibly only one).
 928 Otherwise, return a single face."
 929   (let ((faceprop (or (get-char-property (point) 'read-face-name)
 930                       (get-char-property (point) 'face)))
 931         (aliasfaces nil)
 932         (nonaliasfaces nil)
 933         faces)
 934     ;; Try to get a face name from the buffer.
 935     (if (memq (intern-soft (thing-at-point 'symbol)) (face-list))
 936         (setq faces (list (intern-soft (thing-at-point 'symbol)))))
 937     ;; Add the named faces that the `face' property uses.
 938     (if (and (listp faceprop)
 939              ;; Don't treat an attribute spec as a list of faces.
 940              (not (keywordp (car faceprop)))
 941              (not (memq (car faceprop) '(foreground-color background-color))))
 942         (dolist (f faceprop)
 943           (if (symbolp f)
 944               (push f faces)))
 945       (if (symbolp faceprop)
 946           (push faceprop faces)))
 947     (delete-dups faces)
 948
 949     ;; Build up the completion tables.
 950     (mapatoms (lambda (s)
 951                 (if (custom-facep s)
 952                     (if (get s 'face-alias)
 953                         (push (symbol-name s) aliasfaces)
 954                       (push (symbol-name s) nonaliasfaces)))))
 955
 956     ;; If we only want one, and the default is more than one,
 957     ;; discard the unwanted ones now.
 958     (unless multiple
 959       (if faces
 960           (setq faces (list (car faces)))))
 961     (require 'crm)
 962     (let* ((input
 963             ;; Read the input.
 964             (completing-read-multiple
 965              (if (or faces default)
 966                  (format "%s (default `%s'): " prompt
 967                          (if faces (mapconcat 'symbol-name faces ",")
 968                            default))
 969                (format "%s: " prompt))
 970              (completion-table-in-turn nonaliasfaces aliasfaces)
 971              nil t nil 'face-name-history
 972              (if faces (mapconcat 'symbol-name faces ","))))
 973            ;; Canonicalize the output.
 974            (output
 975             (cond ((or (equal input "") (equal input '("")))
 976                    (or faces (unless (stringp default) default)))
 977                   ((stringp input)
 978                    (mapcar 'intern (split-string input ", *" t)))
 979                   ((listp input)
 980                    (mapcar 'intern input))
 981                   (input))))
 982       ;; Return either a list of faces or just one face.
 983       (if multiple
 984           output
 985         (car output)))))
 986
 987 ;; Not defined without X, but behind window-system test.
 988 (defvar x-bitmap-file-path)
 989
 990 (defun face-valid-attribute-values (attribute &optional frame)
 991   "Return valid values for face attribute ATTRIBUTE.
 992 The optional argument FRAME is used to determine available fonts
 993 and colors.  If it is nil or not specified, the selected frame is used.
 994 Value is an alist of (NAME . VALUE) if ATTRIBUTE expects a value out
 995 of a set of discrete values.  Value is `integerp' if ATTRIBUTE expects
 996 an integer value."
 997   (let ((valid
 998          (case attribute
 999            (:family
1000             (if (window-system frame)
1001                 (mapcar (lambda (x) (cons x x))
1002                         (font-family-list))
1003               ;; Only one font on TTYs.
1004               (list (cons "default" "default"))))
1005            (:foundry
1006             (list nil))
1007            (:width
1008             (mapcar #'(lambda (x) (cons (symbol-name (aref x 1)) (aref x 1)))
1009                     font-width-table))
1010            (:weight
1011             (mapcar #'(lambda (x) (cons (symbol-name (aref x 1)) (aref x 1)))
1012                     font-weight-table))
1013            (:slant
1014             (mapcar #'(lambda (x) (cons (symbol-name (aref x 1)) (aref x 1)))
1015                     font-slant-table))
1016            (:inverse-video
1017             (mapcar #'(lambda (x) (cons (symbol-name x) x))
1018                     (internal-lisp-face-attribute-values attribute)))
1019            ((:underline :overline :strike-through :box)
1020             (if (window-system frame)
1021                 (nconc (mapcar #'(lambda (x) (cons (symbol-name x) x))
1022                                (internal-lisp-face-attribute-values attribute))
1023                        (mapcar #'(lambda (c) (cons c c))
1024                                (defined-colors frame)))
1025               (mapcar #'(lambda (x) (cons (symbol-name x) x))
1026                       (internal-lisp-face-attribute-values attribute))))
1027            ((:foreground :background)
1028             (mapcar #'(lambda (c) (cons c c))
1029                     (defined-colors frame)))
1030            ((:height)
1031             'integerp)
1032            (:stipple
1033             (and (memq (window-system frame) '(x ns)) ; No stipple on w32
1034                  (mapcar #'list
1035                          (apply #'nconc
1036                                 (mapcar (lambda (dir)
1037                                           (and (file-readable-p dir)
1038                                                (file-directory-p dir)
1039                                                (directory-files dir)))
1040                                         x-bitmap-file-path)))))
1041            (:inherit
1042             (cons '("none" . nil)
1043                   (mapcar #'(lambda (c) (cons (symbol-name c) c))
1044                           (face-list))))
1045            (t
1046             (error "Internal error")))))
1047     (if (and (listp valid) (not (memq attribute '(:inherit))))
1048         (nconc (list (cons "unspecified" 'unspecified)) valid)
1049       valid)))
1050
1051
1052 (defconst face-attribute-name-alist
1053   '((:family . "font family")
1054     (:foundry . "font foundry")
1055     (:width . "character set width")
1056     (:height . "height in 1/10 pt")
1057     (:weight . "weight")
1058     (:slant . "slant")
1059     (:underline . "underline")
1060     (:overline . "overline")
1061     (:strike-through . "strike-through")
1062     (:box . "box")
1063     (:inverse-video . "inverse-video display")
1064     (:foreground . "foreground color")
1065     (:background . "background color")
1066     (:stipple . "background stipple")
1067     (:inherit . "inheritance"))
1068   "An alist of descriptive names for face attributes.
1069 Each element has the form (ATTRIBUTE-NAME . DESCRIPTION) where
1070 ATTRIBUTE-NAME is a face attribute name (a keyword symbol), and
1071 DESCRIPTION is a descriptive name for ATTRIBUTE-NAME.")
1072
1073
1074 (defun face-descriptive-attribute-name (attribute)
1075   "Return a descriptive name for ATTRIBUTE."
1076   (cdr (assq attribute face-attribute-name-alist)))
1077
1078
1079 (defun face-read-string (face default name &optional completion-alist)
1080   "Interactively read a face attribute string value.
1081 FACE is the face whose attribute is read.  If non-nil, DEFAULT is the
1082 default string to return if no new value is entered.  NAME is a
1083 descriptive name of the attribute for prompting.  COMPLETION-ALIST is an
1084 alist of valid values, if non-nil.
1085
1086 Entering nothing accepts the default string DEFAULT.
1087 Value is the new attribute value."
1088   ;; Capitalize NAME (we don't use `capitalize' because that capitalizes
1089   ;; each word in a string separately).
1090   (setq name (concat (upcase (substring name 0 1)) (substring name 1)))
1091   (let* ((completion-ignore-case t)
1092          (value (completing-read
1093                  (if default
1094                      (format "%s for face `%s' (default %s): "
1095                              name face default)
1096                    (format "%s for face `%s': " name face))
1097                  completion-alist nil nil nil nil default)))
1098     (if (equal value "") default value)))
1099
1100
1101 (defun face-read-integer (face default name)
1102   "Interactively read an integer face attribute value.
1103 FACE is the face whose attribute is read.  DEFAULT is the default
1104 value to return if no new value is entered.  NAME is a descriptive
1105 name of the attribute for prompting.  Value is the new attribute value."
1106   (let ((new-value
1107          (face-read-string face
1108                            (format "%s" default)
1109                            name
1110                            (list (cons "unspecified" 'unspecified)))))
1111     (cond ((equal new-value "unspecified")
1112            'unspecified)
1113           ((member new-value '("unspecified-fg" "unspecified-bg"))
1114            new-value)
1115           (t
1116            (string-to-number new-value)))))
1117
1118
1119 (defun read-face-attribute (face attribute &optional frame)
1120   "Interactively read a new value for FACE's ATTRIBUTE.
1121 Optional argument FRAME nil or unspecified means read an attribute value
1122 of a global face.  Value is the new attribute value."
1123   (let* ((old-value (face-attribute face attribute frame))
1124          (attribute-name (face-descriptive-attribute-name attribute))
1125          (valid (face-valid-attribute-values attribute frame))
1126          new-value)
1127     ;; Represent complex attribute values as strings by printing them
1128     ;; out.  Stipple can be a vector; (WIDTH HEIGHT DATA).  Box can be
1129     ;; a list `(:width WIDTH :color COLOR)' or `(:width WIDTH :shadow
1130     ;; SHADOW)'.
1131     (when (and (or (eq attribute :stipple)
1132                    (eq attribute :box))
1133                (or (consp old-value)
1134                    (vectorp old-value)))
1135       (setq old-value (prin1-to-string old-value)))
1136     (cond ((listp valid)
1137            (let ((default
1138                    (or (car (rassoc old-value valid))
1139                        (format "%s" old-value))))
1140              (setq new-value
1141                    (face-read-string face default attribute-name valid))
1142              (if (equal new-value default)
1143                  ;; Nothing changed, so don't bother with all the stuff
1144                  ;; below.  In particular, this avoids a non-tty color
1145                  ;; from being canonicalized for a tty when the user
1146                  ;; just uses the default.
1147                  (setq new-value old-value)
1148                ;; Terminal frames can support colors that don't appear
1149                ;; explicitly in VALID, using color approximation code
1150                ;; in tty-colors.el.
1151                (when (and (memq attribute '(:foreground :background))
1152                           (not (memq (window-system frame) '(x w32 ns)))
1153                           (not (member new-value
1154                                        '("unspecified"
1155                                          "unspecified-fg" "unspecified-bg"))))
1156                  (setq new-value (car (tty-color-desc new-value frame))))
1157                (when (assoc new-value valid)
1158                  (setq new-value (cdr (assoc new-value valid)))))))
1159           ((eq valid 'integerp)
1160            (setq new-value (face-read-integer face old-value attribute-name)))
1161           (t (error "Internal error")))
1162     ;; Convert stipple and box value text we read back to a list or
1163     ;; vector if it looks like one.  This makes the assumption that a
1164     ;; pixmap file name won't start with an open-paren.
1165     (when (and (or (eq attribute :stipple)
1166                    (eq attribute :box))
1167                (stringp new-value)
1168                (string-match "^[[(]" new-value))
1169       (setq new-value (read new-value)))
1170     new-value))
1171
1172 (declare-function fontset-list "fontset.c" ())
1173 (declare-function x-list-fonts "xfaces.c"
1174                   (pattern &optional face frame maximum width))
1175
1176 (defun read-face-font (face &optional frame)
1177   "Read the name of a font for FACE on FRAME.
1178 If optional argument FRAME is nil or omitted, use the selected frame."
1179   (let ((completion-ignore-case t))
1180     (completing-read (format "Set font attributes of face `%s' from font: " face)
1181                      (append (fontset-list) (x-list-fonts "*" nil frame)))))
1182
1183
1184 (defun read-all-face-attributes (face &optional frame)
1185   "Interactively read all attributes for FACE.
1186 If optional argument FRAME is nil or omitted, use the selected frame.
1187 Value is a property list of attribute names and new values."
1188   (let (result)
1189     (dolist (attribute face-attribute-name-alist result)
1190       (setq result (cons (car attribute)
1191                          (cons (read-face-attribute face (car attribute) frame)
1192                                result))))))
1193
1194 (defun modify-face (&optional face foreground background stipple
1195                               bold-p italic-p underline inverse-p frame)
1196   "Modify attributes of faces interactively.
1197 If optional argument FRAME is nil or omitted, modify the face used
1198 for newly created frame, i.e. the global face.
1199 For non-interactive use, `set-face-attribute' is preferred.
1200 When called from Lisp, if FACE is nil, all arguments but FRAME are ignored
1201 and the face and its settings are obtained by querying the user."
1202   (interactive)
1203   (if face
1204       (set-face-attribute face frame
1205                           :foreground (or foreground 'unspecified)
1206                           :background (or background 'unspecified)
1207                           :stipple stipple
1208                           :bold bold-p
1209                           :italic italic-p
1210                           :underline underline
1211                           :inverse-video inverse-p)
1212     (setq face (read-face-name "Modify face"))
1213     (apply #'set-face-attribute face frame
1214            (read-all-face-attributes face frame))))
1215
1216 (defun read-face-and-attribute (attribute &optional frame)
1217   "Read face name and face attribute value.
1218 ATTRIBUTE is the attribute whose new value is read.
1219 FRAME nil or unspecified means read attribute value of global face.
1220 Value is a list (FACE NEW-VALUE) where FACE is the face read
1221 \(a symbol), and NEW-VALUE is value read."
1222   (cond ((eq attribute :font)
1223          (let* ((prompt "Set font-related attributes of face")
1224                 (face (read-face-name prompt))
1225                 (font (read-face-font face frame)))
1226            (list face font)))
1227         (t
1228          (let* ((attribute-name (face-descriptive-attribute-name attribute))
1229                 (prompt (format "Set %s of face" attribute-name))
1230                 (face (read-face-name prompt))
1231                 (new-value (read-face-attribute face attribute frame)))
1232            (list face new-value)))))
1233
1234
1235 \f
1236 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1237 ;;; Listing faces.
1238 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1239
1240 (defconst list-faces-sample-text
1241   "abcdefghijklmnopqrstuvwxyz ABCDEFGHIJKLMNOPQRSTUVWXYZ"
1242   "*Text string to display as the sample text for `list-faces-display'.")
1243
1244
1245 ;; The name list-faces would be more consistent, but let's avoid a
1246 ;; conflict with Lucid, which uses that name differently.
1247
1248 (defvar help-xref-stack)
1249 (defun list-faces-display (&optional regexp)
1250   "List all faces, using the same sample text in each.
1251 The sample text is a string that comes from the variable
1252 `list-faces-sample-text'.
1253
1254 If REGEXP is non-nil, list only those faces with names matching
1255 this regular expression.  When called interactively with a prefix
1256 arg, prompt for a regular expression."
1257   (interactive (list (and current-prefix-arg
1258                           (read-regexp "List faces matching regexp"))))
1259   (let ((all-faces (zerop (length regexp)))
1260         (frame (selected-frame))
1261         (max-length 0)
1262         faces line-format
1263         disp-frame window face-name)
1264     ;; We filter and take the max length in one pass
1265     (setq faces
1266           (delq nil
1267                 (mapcar (lambda (f)
1268                           (let ((s (symbol-name f)))
1269                             (when (or all-faces (string-match regexp s))
1270                               (setq max-length (max (length s) max-length))
1271                               f)))
1272                         (sort (face-list) #'string-lessp))))
1273     (unless faces
1274       (error "No faces matching \"%s\"" regexp))
1275     (setq max-length (1+ max-length)
1276           line-format (format "%%-%ds" max-length))
1277     (with-help-window "*Faces*"
1278       (with-current-buffer standard-output
1279         (setq truncate-lines t)
1280         (insert
1281          (substitute-command-keys
1282           (concat
1283            "Use "
1284            (if (display-mouse-p) "\\[help-follow-mouse] or ")
1285            "\\[help-follow] on a face name to customize it\n"
1286            "or on its sample text for a description of the face.\n\n")))
1287         (setq help-xref-stack nil)
1288         (dolist (face faces)
1289           (setq face-name (symbol-name face))
1290           (insert (format line-format face-name))
1291           ;; Hyperlink to a customization buffer for the face.  Using
1292           ;; the help xref mechanism may not be the best way.
1293           (save-excursion
1294             (save-match-data
1295               (search-backward face-name)
1296               (setq help-xref-stack-item `(list-faces-display ,regexp))
1297               (help-xref-button 0 'help-customize-face face)))
1298           (let ((beg (point))
1299                 (line-beg (line-beginning-position)))
1300             (insert list-faces-sample-text)
1301             ;; Hyperlink to a help buffer for the face.
1302             (save-excursion
1303               (save-match-data
1304                 (search-backward list-faces-sample-text)
1305                 (help-xref-button 0 'help-face face)))
1306             (insert "\n")
1307             (put-text-property beg (1- (point)) 'face face)
1308             ;; Make all face commands default to the proper face
1309             ;; anywhere in the line.
1310             (put-text-property line-beg (1- (point)) 'read-face-name face)
1311             ;; If the sample text has multiple lines, line up all of them.
1312             (goto-char beg)
1313             (forward-line 1)
1314             (while (not (eobp))
1315               (insert-char ?\s max-length)
1316               (forward-line 1))))
1317         (goto-char (point-min))))
1318     ;; If the *Faces* buffer appears in a different frame,
1319     ;; copy all the face definitions from FRAME,
1320     ;; so that the display will reflect the frame that was selected.
1321     (setq window (get-buffer-window (get-buffer "*Faces*") t))
1322     (setq disp-frame (if window (window-frame window)
1323                        (car (frame-list))))
1324     (or (eq frame disp-frame)
1325         (let ((faces (face-list)))
1326           (while faces
1327             (copy-face (car faces) (car faces) frame disp-frame)
1328             (setq faces (cdr faces)))))))
1329
1330
1331 (defun describe-face (face &optional frame)
1332   "Display the properties of face FACE on FRAME.
1333 Interactively, FACE defaults to the faces of the character after point
1334 and FRAME defaults to the selected frame.
1335
1336 If the optional argument FRAME is given, report on face FACE in that frame.
1337 If FRAME is t, report on the defaults for face FACE (for new frames).
1338 If FRAME is omitted or nil, use the selected frame."
1339   (interactive (list (read-face-name "Describe face" 'default t)))
1340   (let* ((attrs '((:family . "Family")
1341                   (:foundry . "Foundry")
1342                   (:width . "Width")
1343                   (:height . "Height")
1344                   (:weight . "Weight")
1345                   (:slant . "Slant")
1346                   (:foreground . "Foreground")
1347                   (:background . "Background")
1348                   (:underline . "Underline")
1349                   (:overline . "Overline")
1350                   (:strike-through . "Strike-through")
1351                   (:box . "Box")
1352                   (:inverse-video . "Inverse")
1353                   (:stipple . "Stipple")
1354                   (:font . "Font")
1355                   (:fontset . "Fontset")
1356                   (:inherit . "Inherit")))
1357         (max-width (apply #'max (mapcar #'(lambda (x) (length (cdr x)))
1358                                         attrs))))
1359     (help-setup-xref (list #'describe-face face)
1360                      (called-interactively-p 'interactive))
1361     (unless face
1362       (setq face 'default))
1363     (if (not (listp face))
1364         (setq face (list face)))
1365     (with-help-window (help-buffer)
1366       (with-current-buffer standard-output
1367         (dolist (f face)
1368           (if (stringp f) (setq f (intern f)))
1369           ;; We may get called for anonymous faces (i.e., faces
1370           ;; expressed using prop-value plists).  Those can't be
1371           ;; usefully customized, so ignore them.
1372           (when (symbolp f)
1373             (insert "Face: " (symbol-name f))
1374             (if (not (facep f))
1375                 (insert "   undefined face.\n")
1376               (let ((customize-label "customize this face")
1377                     file-name)
1378                 (insert (concat " (" (propertize "sample" 'font-lock-face f) ")"))
1379                 (princ (concat " (" customize-label ")\n"))
1380                 ;; FIXME not sure how much of this belongs here, and
1381                 ;; how much in `face-documentation'.  The latter is
1382                 ;; not used much, but needs to return nil for
1383                 ;; undocumented faces.
1384                 (let ((alias (get f 'face-alias))
1385                       (face f)
1386                       obsolete)
1387                   (when alias
1388                     (setq face alias)
1389                     (insert
1390                      (format "\n  %s is an alias for the face `%s'.\n%s"
1391                              f alias
1392                              (if (setq obsolete (get f 'obsolete-face))
1393                                  (format "  This face is obsolete%s; use `%s' instead.\n"
1394                                          (if (stringp obsolete)
1395                                              (format " since %s" obsolete)
1396                                            "")
1397                                          alias)
1398                                ""))))
1399                   (insert "\nDocumentation:\n"
1400                           (or (face-documentation face)
1401                               "Not documented as a face.")
1402                           "\n\n"))
1403                 (with-current-buffer standard-output
1404                   (save-excursion
1405                     (re-search-backward
1406                      (concat "\\(" customize-label "\\)") nil t)
1407                     (help-xref-button 1 'help-customize-face f)))
1408                 (setq file-name (find-lisp-object-file-name f 'defface))
1409                 (when file-name
1410                   (princ "Defined in `")
1411                   (princ (file-name-nondirectory file-name))
1412                   (princ "'")
1413                   ;; Make a hyperlink to the library.
1414                   (save-excursion
1415                     (re-search-backward "`\\([^`']+\\)'" nil t)
1416                     (help-xref-button 1 'help-face-def f file-name))
1417                   (princ ".")
1418                   (terpri)
1419                   (terpri))
1420                 (dolist (a attrs)
1421                   (let ((attr (face-attribute f (car a) frame)))
1422                     (insert (make-string (- max-width (length (cdr a))) ?\s)
1423                             (cdr a) ": " (format "%s" attr))
1424                     (if (and (eq (car a) :inherit)
1425                              (not (eq attr 'unspecified)))
1426                         ;; Make a hyperlink to the parent face.
1427                         (save-excursion
1428                           (re-search-backward ": \\([^:]+\\)" nil t)
1429                           (help-xref-button 1 'help-face attr)))
1430                     (insert "\n")))))
1431             (terpri)))))))
1432
1433 \f
1434 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1435 ;;; Face specifications (defface).
1436 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1437
1438 ;; Parameter FRAME Is kept for call compatibility to with previous
1439 ;; face implementation.
1440
1441 (defun face-attr-construct (face &optional frame)
1442   "Return a `defface'-style attribute list for FACE on FRAME.
1443 Value is a property list of pairs ATTRIBUTE VALUE for all specified
1444 face attributes of FACE where ATTRIBUTE is the attribute name and
1445 VALUE is the specified value of that attribute."
1446   (let (result)
1447     (dolist (entry face-attribute-name-alist result)
1448       (let* ((attribute (car entry))
1449              (value (face-attribute face attribute)))
1450         (unless (eq value 'unspecified)
1451           (setq result (nconc (list attribute value) result)))))))
1452
1453
1454 (defun face-spec-set-match-display (display frame)
1455   "Non-nil if DISPLAY matches FRAME.
1456 DISPLAY is part of a spec such as can be used in `defface'.
1457 If FRAME is nil, the current FRAME is used."
1458   (let* ((conjuncts display)
1459          conjunct req options
1460          ;; t means we have succeeded against all the conjuncts in
1461          ;; DISPLAY that have been tested so far.
1462          (match t))
1463     (if (eq conjuncts t)
1464         (setq conjuncts nil))
1465     (while (and conjuncts match)
1466       (setq conjunct (car conjuncts)
1467             conjuncts (cdr conjuncts)
1468             req (car conjunct)
1469             options (cdr conjunct)
1470             match (cond ((eq req 'type)
1471                          (or (memq (window-system frame) options)
1472                              ;; FIXME: This should be revisited to use
1473                              ;; display-graphic-p, provided that the
1474                              ;; color selection depends on the number
1475                              ;; of supported colors, and all defface's
1476                              ;; are changed to look at number of colors
1477                              ;; instead of (type graphic) etc.
1478                              (and (null (window-system frame))
1479                                   (memq 'tty options))
1480                              (and (memq 'motif options)
1481                                   (featurep 'motif))
1482                              (and (memq 'gtk options)
1483                                   (featurep 'gtk))
1484                              (and (memq 'lucid options)
1485                                   (featurep 'x-toolkit)
1486                                   (not (featurep 'motif))
1487                                   (not (featurep 'gtk)))
1488                              (and (memq 'x-toolkit options)
1489                                   (featurep 'x-toolkit))))
1490                         ((eq req 'min-colors)
1491                          (>= (display-color-cells frame) (car options)))
1492                         ((eq req 'class)
1493                          (memq (frame-parameter frame 'display-type) options))
1494                         ((eq req 'background)
1495                          (memq (frame-parameter frame 'background-mode)
1496                                options))
1497                         ((eq req 'supports)
1498                          (display-supports-face-attributes-p options frame))
1499                         (t (error "Unknown req `%S' with options `%S'"
1500                                   req options)))))
1501     match))
1502
1503
1504 (defun face-spec-choose (spec &optional frame)
1505   "Choose the proper attributes for FRAME, out of SPEC.
1506 If SPEC is nil, return nil."
1507   (unless frame
1508     (setq frame (selected-frame)))
1509   (let ((tail spec)
1510         result defaults)
1511     (while tail
1512       (let* ((entry (pop tail))
1513              (display (car entry))
1514              (attrs (cdr entry))
1515              thisval)
1516         ;; Get the attributes as actually specified by this alternative.
1517         (setq thisval
1518               (if (null (cdr attrs)) ;; was (listp (car attrs))
1519                   ;; Old-style entry, the attribute list is the
1520                   ;; first element.
1521                   (car attrs)
1522                 attrs))
1523
1524         ;; If the condition is `default', that sets the default
1525         ;; for following conditions.
1526         (if (eq display 'default)
1527             (setq defaults thisval)
1528           ;; Otherwise, if it matches, use it.
1529           (when (face-spec-set-match-display display frame)
1530             (setq result thisval)
1531             (setq tail nil)))))
1532     (if defaults (append result defaults) result)))
1533
1534
1535 (defun face-spec-reset-face (face &optional frame)
1536   "Reset all attributes of FACE on FRAME to unspecified."
1537   (let ((attrs face-attribute-name-alist))
1538     (while attrs
1539       (let ((attr-and-name (car attrs)))
1540         (set-face-attribute face frame (car attr-and-name) 'unspecified))
1541       (setq attrs (cdr attrs)))))
1542
1543
1544 (defun face-spec-set (face spec &optional for-defface)
1545   "Set FACE's face spec, which controls its appearance, to SPEC.
1546 If FOR-DEFFACE is t, set the base spec, the one that `defface'
1547   and Custom set.  (In that case, the caller must put it in the
1548   appropriate property, because that depends on the caller.)
1549 If FOR-DEFFACE is nil, set the overriding spec (and store it
1550   in the `face-override-spec' property of FACE).
1551
1552 The appearance of FACE is controlled by the base spec,
1553 by any custom theme specs on top of that, and by the
1554 overriding spec on top of all the rest.
1555
1556 FOR-DEFFACE can also be a frame, in which case we set the
1557 frame-specific attributes of FACE for that frame based on SPEC.
1558 That usage is deprecated.
1559
1560 See `defface' for information about the format and meaning of SPEC."
1561   (if (framep for-defface)
1562       ;; Handle the deprecated case where third arg is a frame.
1563       (face-spec-set-2 face for-defface spec)
1564     (if for-defface
1565         ;; When we reset the face based on its custom spec, then it is
1566         ;; unmodified as far as Custom is concerned.
1567         (put (or (get face 'face-alias) face) 'face-modified nil)
1568       ;; When we change a face based on a spec from outside custom,
1569       ;; record it for future frames.
1570       (put (or (get face 'face-alias) face) 'face-override-spec spec))
1571     ;; Reset each frame according to the rules implied by all its specs.
1572     (dolist (frame (frame-list))
1573       (face-spec-recalc face frame))))
1574
1575 (defun face-spec-recalc (face frame)
1576   "Reset the face attributes of FACE on FRAME according to its specs.
1577 This applies the defface/custom spec first, then the custom theme specs,
1578 then the override spec."
1579   (face-spec-reset-face face frame)
1580   (let ((face-sym (or (get face 'face-alias) face)))
1581     (or (get face 'customized-face)
1582         (get face 'saved-face)
1583         (face-spec-set-2 face frame (face-default-spec face)))
1584     (let ((theme-faces (reverse (get face-sym 'theme-face))))
1585       (dolist (spec theme-faces)
1586         (face-spec-set-2 face frame (cadr spec))))
1587     (face-spec-set-2 face frame (get face-sym 'face-override-spec))))
1588
1589 (defun face-spec-set-2 (face frame spec)
1590   "Set the face attributes of FACE on FRAME according to SPEC."
1591   (let* ((spec (face-spec-choose spec frame))
1592          attrs)
1593     (while spec
1594       (when (assq (car spec) face-x-resources)
1595         (push (car spec) attrs)
1596         (push (cadr spec) attrs))
1597       (setq spec (cddr spec)))
1598     (apply 'set-face-attribute face frame (nreverse attrs))))
1599
1600 (defun face-attr-match-p (face attrs &optional frame)
1601   "Return t if attributes of FACE match values in plist ATTRS.
1602 Optional parameter FRAME is the frame whose definition of FACE
1603 is used.  If nil or omitted, use the selected frame."
1604   (unless frame
1605     (setq frame (selected-frame)))
1606   (let ((list face-attribute-name-alist)
1607         (match t))
1608     (while (and match (not (null list)))
1609       (let* ((attr (car (car list)))
1610              (specified-value
1611               (if (plist-member attrs attr)
1612                   (plist-get attrs attr)
1613                 'unspecified))
1614              (value-now (face-attribute face attr frame)))
1615         (setq match (equal specified-value value-now))
1616         (setq list (cdr list))))
1617     match))
1618
1619 (defun face-spec-match-p (face spec &optional frame)
1620   "Return t if FACE, on FRAME, matches what SPEC says it should look like."
1621   (face-attr-match-p face (face-spec-choose spec frame) frame))
1622
1623 (defsubst face-default-spec (face)
1624   "Return the default face-spec for FACE, ignoring any user customization.
1625 If there is no default for FACE, return nil."
1626   (get face 'face-defface-spec))
1627
1628 (defsubst face-user-default-spec (face)
1629   "Return the user's customized face-spec for FACE, or the default if none.
1630 If there is neither a user setting nor a default for FACE, return nil."
1631   (or (get face 'customized-face)
1632       (get face 'saved-face)
1633       (face-default-spec face)))
1634
1635 \f
1636 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1637 ;;; Frame-type independent color support.
1638 ;;; We keep the old x-* names as aliases for back-compatibility.
1639 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1640
1641 (defun defined-colors (&optional frame)
1642   "Return a list of colors supported for a particular frame.
1643 The argument FRAME specifies which frame to try.
1644 The value may be different for frames on different display types.
1645 If FRAME doesn't support colors, the value is nil.
1646 If FRAME is nil, that stands for the selected frame."
1647   (if (memq (framep (or frame (selected-frame))) '(x w32 ns))
1648       (xw-defined-colors frame)
1649     (mapcar 'car (tty-color-alist frame))))
1650 (defalias 'x-defined-colors 'defined-colors)
1651
1652 (declare-function xw-color-defined-p "xfns.c" (color &optional frame))
1653
1654 (defun color-defined-p (color &optional frame)
1655   "Return non-nil if color COLOR is supported on frame FRAME.
1656 If FRAME is omitted or nil, use the selected frame.
1657 If COLOR is the symbol `unspecified' or one of the strings
1658 \"unspecified-fg\" or \"unspecified-bg\", the value is nil."
1659   (if (member color '(unspecified "unspecified-bg" "unspecified-fg"))
1660       nil
1661     (if (member (framep (or frame (selected-frame))) '(x w32 ns))
1662         (xw-color-defined-p color frame)
1663       (numberp (tty-color-translate color frame)))))
1664 (defalias 'x-color-defined-p 'color-defined-p)
1665
1666 (declare-function xw-color-values "xfns.c" (color &optional frame))
1667
1668 (defun color-values (color &optional frame)
1669   "Return a description of the color named COLOR on frame FRAME.
1670 The value is a list of integer RGB values--(RED GREEN BLUE).
1671 These values appear to range from 0 to 65280 or 65535, depending
1672 on the system; white is \(65280 65280 65280\) or \(65535 65535 65535\).
1673 If FRAME is omitted or nil, use the selected frame.
1674 If FRAME cannot display COLOR, the value is nil.
1675 If COLOR is the symbol `unspecified' or one of the strings
1676 \"unspecified-fg\" or \"unspecified-bg\", the value is nil."
1677   (if (member color '(unspecified "unspecified-fg" "unspecified-bg"))
1678       nil
1679     (if (memq (framep (or frame (selected-frame))) '(x w32 ns))
1680         (xw-color-values color frame)
1681       (tty-color-values color frame))))
1682 (defalias 'x-color-values 'color-values)
1683
1684 (declare-function xw-display-color-p "xfns.c" (&optional terminal))
1685
1686 (defun display-color-p (&optional display)
1687   "Return t if DISPLAY supports color.
1688 The optional argument DISPLAY specifies which display to ask about.
1689 DISPLAY should be either a frame or a display name (a string).
1690 If omitted or nil, that stands for the selected frame's display."
1691   (if (memq (framep-on-display display) '(x w32 ns))
1692       (xw-display-color-p display)
1693     (tty-display-color-p display)))
1694 (defalias 'x-display-color-p 'display-color-p)
1695
1696 (declare-function x-display-grayscale-p "xfns.c" (&optional terminal))
1697
1698 (defun display-grayscale-p (&optional display)
1699   "Return non-nil if frames on DISPLAY can display shades of gray."
1700   (let ((frame-type (framep-on-display display)))
1701     (cond
1702      ((memq frame-type '(x w32 ns))
1703       (x-display-grayscale-p display))
1704      (t
1705       (> (tty-color-gray-shades display) 2)))))
1706
1707 (defun read-color (&optional prompt convert-to-RGB-p allow-empty-name-p msg-p)
1708   "Read a color name or RGB hex value: #RRRRGGGGBBBB.
1709 Completion is available for color names, but not for RGB hex strings.
1710 If the user inputs an RGB hex string, it must have the form
1711 #XXXXXXXXXXXX or XXXXXXXXXXXX, where each X is a hex digit.  The
1712 number of Xs must be a multiple of 3, with the same number of Xs for
1713 each of red, green, and blue.  The order is red, green, blue.
1714
1715 In addition to standard color names and RGB hex values, the following
1716 are available as color candidates.  In each case, the corresponding
1717 color is used.
1718
1719  * `foreground at point'   - foreground under the cursor
1720  * `background at point'   - background under the cursor
1721
1722 Checks input to be sure it represents a valid color.  If not, raises
1723 an error (but see exception for empty input with non-nil
1724 ALLOW-EMPTY-NAME-P).
1725
1726 Optional arg PROMPT is the prompt; if nil, uses a default prompt.
1727
1728 Interactively, or with optional arg CONVERT-TO-RGB-P non-nil, converts
1729 an input color name to an RGB hex string.  Returns the RGB hex string.
1730
1731 Optional arg ALLOW-EMPTY-NAME-P controls what happens if the user
1732 enters an empty color name (that is, just hits `RET').  If non-nil,
1733 then returns an empty color name, \"\".  If nil, then raises an error.
1734 Programs must test for \"\" if ALLOW-EMPTY-NAME-P is non-nil.  They
1735 can then perform an appropriate action in case of empty input.
1736
1737 Interactively, or with optional arg MSG-P non-nil, echoes the color in
1738 a message."
1739   (interactive "i\np\ni\np")    ; Always convert to RGB interactively.
1740   (let* ((completion-ignore-case t)
1741          (colors (append '("foreground at point" "background at point")
1742                          (defined-colors)))
1743          (color (completing-read (or prompt "Color (name or #R+G+B+): ")
1744                                  colors))
1745          hex-string)
1746     (cond ((string= "foreground at point" color)
1747            (setq color (foreground-color-at-point)))
1748           ((string= "background at point" color)
1749            (setq color (background-color-at-point))))
1750     (unless color
1751       (setq color ""))
1752     (setq hex-string
1753           (string-match "^#?\\([a-fA-F0-9][a-fA-F0-9][a-fA-F0-9]\\)+$" color))
1754     (if (and allow-empty-name-p (string= "" color))
1755         ""
1756       (when (and hex-string (not (eq (aref color 0) ?#)))
1757         (setq color (concat "#" color))) ; No #; add it.
1758       (unless hex-string
1759         (when (or (string= "" color) (not (test-completion color colors)))
1760           (error "No such color: %S" color))
1761         (when convert-to-RGB-p
1762           (let ((components (x-color-values color)))
1763             (unless components (error "No such color: %S" color))
1764             (unless (string-match "^#\\([a-fA-F0-9][a-fA-F0-9][a-fA-F0-9]\\)+$" color)
1765               (setq color (format "#%04X%04X%04X"
1766                                   (logand 65535 (nth 0 components))
1767                                   (logand 65535 (nth 1 components))
1768                                   (logand 65535 (nth 2 components))))))))
1769       (when msg-p (message "Color: `%s'" color))
1770       color)))
1771
1772 ;; Commented out because I decided it is better to include the
1773 ;; duplicates in read-color's completion list.
1774
1775 ;; (defun defined-colors-without-duplicates ()
1776 ;;   "Return the list of defined colors, without the no-space versions.
1777 ;; For each color name, we keep the variant that DOES have spaces."
1778 ;;   (let ((result (copy-sequence (defined-colors)))
1779 ;;         to-be-rejected)
1780 ;;     (save-match-data
1781 ;;       (dolist (this result)
1782 ;;         (if (string-match " " this)
1783 ;;             (push (replace-regexp-in-string " " ""
1784 ;;                                             this)
1785 ;;                   to-be-rejected)))
1786 ;;       (dolist (elt to-be-rejected)
1787 ;;         (let ((as-found (car (member-ignore-case elt result))))
1788 ;;           (setq result (delete as-found result)))))
1789 ;;     result))
1790
1791 (defun face-at-point ()
1792   "Return the face of the character after point.
1793 If it has more than one face, return the first one.
1794 Return nil if it has no specified face."
1795   (let* ((faceprop (or (get-char-property (point) 'read-face-name)
1796                        (get-char-property (point) 'face)
1797                        'default))
1798          (face (cond ((symbolp faceprop) faceprop)
1799                      ;; List of faces (don't treat an attribute spec).
1800                      ;; Just use the first face.
1801                      ((and (consp faceprop) (not (keywordp (car faceprop)))
1802                            (not (memq (car faceprop)
1803                                       '(foreground-color background-color))))
1804                       (car faceprop))
1805                      (t nil))))         ; Invalid face value.
1806     (if (facep face) face nil)))
1807
1808 (defun foreground-color-at-point ()
1809   "Return the foreground color of the character after point."
1810   ;; `face-at-point' alone is not sufficient.  It only gets named faces.
1811   ;; Need also pick up any face properties that are not associated with named faces.
1812   (let ((face (or (face-at-point)
1813                   (get-char-property (point) 'read-face-name)
1814                   (get-char-property (point) 'face))))
1815     (cond ((and face (symbolp face))
1816            (let ((value (face-foreground face nil 'default)))
1817              (if (member value '("unspecified-fg" "unspecified-bg"))
1818                  nil
1819                value)))
1820           ((consp face)
1821            (cond ((memq 'foreground-color face) (cdr (memq 'foreground-color face)))
1822                  ((memq ':foreground face) (cadr (memq ':foreground face)))))
1823           (t nil))))                    ; Invalid face value.
1824
1825 (defun background-color-at-point ()
1826   "Return the background color of the character after point."
1827   ;; `face-at-point' alone is not sufficient.  It only gets named faces.
1828   ;; Need also pick up any face properties that are not associated with named faces.
1829   (let ((face (or (face-at-point)
1830                   (get-char-property (point) 'read-face-name)
1831                   (get-char-property (point) 'face))))
1832     (cond ((and face (symbolp face))
1833            (let ((value (face-background face nil 'default)))
1834              (if (member value '("unspecified-fg" "unspecified-bg"))
1835                  nil
1836                value)))
1837           ((consp face)
1838            (cond ((memq 'background-color face) (cdr (memq 'background-color face)))
1839                  ((memq ':background face) (cadr (memq ':background face)))))
1840           (t nil))))                    ; Invalid face value.
1841 \f
1842 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1843 ;;; Background mode.
1844 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1845
1846 (defcustom frame-background-mode nil
1847   "The brightness of the background.
1848 Set this to the symbol `dark' if your background color is dark,
1849 `light' if your background is light, or nil (automatic by default)
1850 if you want Emacs to examine the brightness for you.  Don't set this
1851 variable with `setq'; this won't have the expected effect."
1852   :group 'faces
1853   :set #'(lambda (var value)
1854            (set-default var value)
1855            (mapc 'frame-set-background-mode (frame-list)))
1856   :initialize 'custom-initialize-changed
1857   :type '(choice (const dark)
1858                  (const light)
1859                  (const :tag "automatic" nil)))
1860
1861
1862 (declare-function x-get-resource "frame.c"
1863                   (attribute class &optional component subclass))
1864
1865 (defvar inhibit-frame-set-background-mode nil)
1866
1867 (defun frame-set-background-mode (frame)
1868   "Set up display-dependent faces on FRAME.
1869 Display-dependent faces are those which have different definitions
1870 according to the `background-mode' and `display-type' frame parameters."
1871   (unless inhibit-frame-set-background-mode
1872     (let* ((bg-resource
1873             (and (window-system frame)
1874                  (x-get-resource "backgroundMode" "BackgroundMode")))
1875            (bg-color (frame-parameter frame 'background-color))
1876            (terminal-bg-mode (terminal-parameter frame 'background-mode))
1877            (tty-type (tty-type frame))
1878            (default-bg-mode
1879              (if (or (window-system frame)
1880                      (and tty-type
1881                           (string-match "^\\(xterm\\|\\rxvt\\|dtterm\\|eterm\\)"
1882                                         tty-type)))
1883                  'light
1884                'dark))
1885            (non-default-bg-mode (if (eq default-bg-mode 'light) 'dark 'light))
1886            (bg-mode
1887             (cond (frame-background-mode)
1888                   (bg-resource (intern (downcase bg-resource)))
1889                   (terminal-bg-mode)
1890                   ((equal bg-color "unspecified-fg") ; inverted colors
1891                    non-default-bg-mode)
1892                   ((not (color-values bg-color frame))
1893                    default-bg-mode)
1894                   ((>= (apply '+ (color-values bg-color frame))
1895                        ;; Just looking at the screen, colors whose
1896                        ;; values add up to .6 of the white total
1897                        ;; still look dark to me.
1898                        (* (apply '+ (color-values "white" frame)) .6))
1899                    'light)
1900                   (t 'dark)))
1901            (display-type
1902             (cond ((null (window-system frame))
1903                    (if (tty-display-color-p frame) 'color 'mono))
1904                   ((display-color-p frame)
1905                    'color)
1906                   ((x-display-grayscale-p frame)
1907                    'grayscale)
1908                   (t 'mono)))
1909            (old-bg-mode
1910             (frame-parameter frame 'background-mode))
1911            (old-display-type
1912             (frame-parameter frame 'display-type)))
1913
1914       (unless (and (eq bg-mode old-bg-mode) (eq display-type old-display-type))
1915         (let ((locally-modified-faces nil)
1916               ;; Prevent face-spec-recalc from calling this function
1917               ;; again, resulting in a loop (bug#911).
1918               (inhibit-frame-set-background-mode t))
1919           ;; Before modifying the frame parameters, collect a list of
1920           ;; faces that don't match what their face-spec says they
1921           ;; should look like.  We then avoid changing these faces
1922           ;; below.  These are the faces whose attributes were
1923           ;; modified on FRAME.  We use a negative list on the
1924           ;; assumption that most faces will be unmodified, so we can
1925           ;; avoid consing in the common case.
1926           (dolist (face (face-list))
1927             (and (not (get face 'face-override-spec))
1928                  (not (face-spec-match-p face
1929                                          (face-user-default-spec face)
1930                                          (selected-frame)))
1931                  (push face locally-modified-faces)))
1932           ;; Now change to the new frame parameters
1933           (modify-frame-parameters frame
1934                                    (list (cons 'background-mode bg-mode)
1935                                          (cons 'display-type display-type)))
1936           ;; For all named faces, choose face specs matching the new frame
1937           ;; parameters, unless they have been locally modified.
1938           (dolist (face (face-list))
1939             (unless (memq face locally-modified-faces)
1940               (face-spec-recalc face frame))))))))
1941
1942 \f
1943 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1944 ;;; Frame creation.
1945 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1946
1947 (declare-function x-parse-geometry "frame.c" (string))
1948
1949 (defun x-handle-named-frame-geometry (parameters)
1950   "Add geometry parameters for a named frame to parameter list PARAMETERS.
1951 Value is the new parameter list."
1952   ;; Note that `x-resource-name' has a global meaning.
1953   (let ((x-resource-name (cdr (assq 'name parameters))))
1954     (when x-resource-name
1955       ;; Before checking X resources, we must have an X connection.
1956       (or (window-system)
1957           (x-display-list)
1958           (x-open-connection (or (cdr (assq 'display parameters))
1959                                  x-display-name)))
1960       (let (res-geometry parsed)
1961         (and (setq res-geometry (x-get-resource "geometry" "Geometry"))
1962              (setq parsed (x-parse-geometry res-geometry))
1963              (setq parameters
1964                    (append parameters parsed
1965                            ;; If the resource specifies a position,
1966                            ;; take note of that.
1967                            (if (or (assq 'top parsed) (assq 'left parsed))
1968                                '((user-position . t) (user-size . t)))))))))
1969   parameters)
1970
1971
1972 (defun x-handle-reverse-video (frame parameters)
1973   "Handle the reverse-video frame parameter and X resource.
1974 `x-create-frame' does not handle this one."
1975   (when (cdr (or (assq 'reverse parameters)
1976                  (let ((resource (x-get-resource "reverseVideo"
1977                                                  "ReverseVideo")))
1978                    (if resource
1979                        (cons nil (member (downcase resource)
1980                                          '("on" "true")))))))
1981       (let* ((params (frame-parameters frame))
1982              (bg (cdr (assq 'foreground-color params)))
1983              (fg (cdr (assq 'background-color params))))
1984         (modify-frame-parameters frame
1985                                  (list (cons 'foreground-color fg)
1986                                        (cons 'background-color bg)))
1987         (if (equal bg (cdr (assq 'border-color params)))
1988             (modify-frame-parameters frame
1989                                      (list (cons 'border-color fg))))
1990         (if (equal bg (cdr (assq 'mouse-color params)))
1991             (modify-frame-parameters frame
1992                                      (list (cons 'mouse-color fg))))
1993         (if (equal bg (cdr (assq 'cursor-color params)))
1994             (modify-frame-parameters frame
1995                                      (list (cons 'cursor-color fg)))))))
1996
1997 (declare-function x-create-frame "xfns.c" (parms))
1998 (declare-function x-setup-function-keys "term/x-win" (frame))
1999
2000 (defun x-create-frame-with-faces (&optional parameters)
2001   "Create and return a frame with frame parameters PARAMETERS.
2002 If PARAMETERS specify a frame name, handle X geometry resources
2003 for that name.  If PARAMETERS includes a `reverse' parameter, or
2004 the X resource ``reverseVideo'' is present, handle that."
2005   (setq parameters (x-handle-named-frame-geometry parameters))
2006   (let* ((params (copy-tree parameters))
2007          (visibility-spec (assq 'visibility parameters))
2008          (delayed-params '(foreground-color background-color font
2009                            border-color cursor-color mouse-color
2010                            visibility scroll-bar-foreground
2011                            scroll-bar-background))
2012          frame success)
2013     (dolist (param delayed-params)
2014       (setq params (assq-delete-all param params)))
2015     (setq frame (x-create-frame `((visibility . nil) . ,params)))
2016     (unwind-protect
2017         (progn
2018           (x-setup-function-keys frame)
2019           (x-handle-reverse-video frame parameters)
2020           (frame-set-background-mode frame)
2021           (face-set-after-frame-default frame parameters)
2022           (if (null visibility-spec)
2023               (make-frame-visible frame)
2024             (modify-frame-parameters frame (list visibility-spec)))
2025           (setq success t))
2026       (unless success
2027         (delete-frame frame)))
2028     frame))
2029
2030 (defun face-set-after-frame-default (frame &optional parameters)
2031   "Initialize the frame-local faces of FRAME.
2032 Calculate the face definitions using the face specs, custom theme
2033 settings, X resources, and `face-new-frame-defaults'.
2034 Finally, apply any relevant face attributes found amongst the
2035 frame parameters in PARAMETERS."
2036   (dolist (face (nreverse (face-list))) ;Why reverse?  --Stef
2037     (condition-case ()
2038         (progn
2039           ;; Initialize faces from face spec and custom theme.
2040           (face-spec-recalc face frame)
2041           ;; X resouces for the default face are applied during
2042           ;; x-create-frame.
2043           (and (not (eq face 'default))
2044                (memq (window-system frame) '(x w32))
2045                (make-face-x-resource-internal face frame))
2046           ;; Apply attributes specified by face-new-frame-defaults
2047           (internal-merge-in-global-face face frame))
2048       ;; Don't let invalid specs prevent frame creation.
2049       (error nil)))
2050   ;; Apply attributes specified by frame parameters.
2051   (let ((face-params '((foreground-color default :foreground)
2052                        (background-color default :background)
2053                        (font default :font)
2054                        (border-color border :background)
2055                        (cursor-color cursor :background)
2056                        (scroll-bar-foreground scroll-bar :foreground)
2057                        (scroll-bar-background scroll-bar :background)
2058                        (mouse-color mouse :background))))
2059     (dolist (param face-params)
2060       (let* ((param-name (nth 0 param))
2061              (value (cdr (assq param-name parameters))))
2062         (if value
2063             (set-face-attribute (nth 1 param) frame
2064                                 (nth 2 param) value))))))
2065
2066 (defun tty-handle-reverse-video (frame parameters)
2067   "Handle the reverse-video frame parameter for terminal frames."
2068   (when (cdr (assq 'reverse parameters))
2069     (let* ((params (frame-parameters frame))
2070            (bg (cdr (assq 'foreground-color params)))
2071            (fg (cdr (assq 'background-color params))))
2072       (modify-frame-parameters frame
2073                                (list (cons 'foreground-color fg)
2074                                      (cons 'background-color bg)))
2075       (if (equal bg (cdr (assq 'mouse-color params)))
2076           (modify-frame-parameters frame
2077                                    (list (cons 'mouse-color fg))))
2078       (if (equal bg (cdr (assq 'cursor-color params)))
2079           (modify-frame-parameters frame
2080                                    (list (cons 'cursor-color fg)))))))
2081
2082
2083 (defun tty-create-frame-with-faces (&optional parameters)
2084   "Create and return a frame from optional frame parameters PARAMETERS.
2085 If PARAMETERS contains a `reverse' parameter, handle that."
2086   (let ((frame (make-terminal-frame parameters))
2087         success)
2088     (unwind-protect
2089         (with-selected-frame frame
2090           (tty-handle-reverse-video frame (frame-parameters frame))
2091
2092           (unless (terminal-parameter frame 'terminal-initted)
2093             (set-terminal-parameter frame 'terminal-initted t)
2094             (set-locale-environment nil frame)
2095             (tty-run-terminal-initialization frame))
2096           (frame-set-background-mode frame)
2097           (face-set-after-frame-default frame parameters)
2098           (setq success t))
2099       (unless success
2100         (delete-frame frame)))
2101     frame))
2102
2103 (defun tty-find-type (pred type)
2104   "Return the longest prefix of TYPE to which PRED returns non-nil.
2105 TYPE should be a tty type name such as \"xterm-16color\".
2106
2107 The function tries only those prefixes that are followed by a
2108 dash or underscore in the original type name, like \"xterm\" in
2109 the above example."
2110   (let (hyphend)
2111     (while (and type
2112                 (not (funcall pred type)))
2113       ;; Strip off last hyphen and what follows, then try again
2114       (setq type
2115             (if (setq hyphend (string-match "[-_][^-_]+$" type))
2116                 (substring type 0 hyphend)
2117               nil))))
2118   type)
2119
2120 (defun tty-run-terminal-initialization (frame &optional type)
2121   "Run the special initialization code for the terminal type of FRAME.
2122 The optional TYPE parameter may be used to override the autodetected
2123 terminal type to a different value."
2124   (setq type (or type (tty-type frame)))
2125   ;; Load library for our terminal type.
2126   ;; User init file can set term-file-prefix to nil to prevent this.
2127   (with-selected-frame frame
2128     (unless (null term-file-prefix)
2129       (let* (term-init-func)
2130         ;; First, load the terminal initialization file, if it is
2131         ;; available and it hasn't been loaded already.
2132         (tty-find-type #'(lambda (type)
2133                            (let ((file (locate-library (concat term-file-prefix type))))
2134                              (and file
2135                                   (or (assoc file load-history)
2136                                       (load file t t)))))
2137                        type)
2138         ;; Next, try to find a matching initialization function, and call it.
2139         (tty-find-type #'(lambda (type)
2140                            (fboundp (setq term-init-func
2141                                           (intern (concat "terminal-init-" type)))))
2142                        type)
2143         (when (fboundp term-init-func)
2144           (funcall term-init-func))
2145         (set-terminal-parameter frame 'terminal-initted term-init-func)))))
2146
2147 ;; Called from C function init_display to initialize faces of the
2148 ;; dumped terminal frame on startup.
2149
2150 (defun tty-set-up-initial-frame-faces ()
2151   (let ((frame (selected-frame)))
2152     (frame-set-background-mode frame)
2153     (face-set-after-frame-default frame)))
2154
2155
2156
2157 \f
2158 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2159 ;;; Compatibility with 20.2
2160 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2161
2162 ;; Update a frame's faces when we change its default font.
2163
2164 (defalias 'frame-update-faces 'ignore "")
2165 (make-obsolete 'frame-update-faces "no longer necessary." "21.1")
2166
2167 ;; Update the colors of FACE, after FRAME's own colors have been
2168 ;; changed.
2169
2170 (define-obsolete-function-alias 'frame-update-face-colors
2171     'frame-set-background-mode "21.1")
2172
2173 \f
2174 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2175 ;;; Standard faces.
2176 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2177
2178 (defgroup basic-faces nil
2179   "The standard faces of Emacs."
2180   :group 'faces)
2181
2182 (defface default
2183   '((t nil)) ; If this were nil, face-defface-spec would not be set.
2184   "Basic default face."
2185   :group 'basic-faces)
2186
2187 (defface bold
2188   '((t :weight bold))
2189   "Basic bold face."
2190   :group 'basic-faces)
2191
2192 (defface italic
2193   '((((supports :slant italic))
2194      :slant italic)
2195     (((supports :underline t))
2196      :underline t)
2197     (t
2198      ;; default to italic, even it doesn't appear to be supported,
2199      ;; because in some cases the display engine will do it's own
2200      ;; workaround (to `dim' on ttys)
2201      :slant italic))
2202   "Basic italic face."
2203   :group 'basic-faces)
2204
2205 (defface bold-italic
2206   '((t :weight bold :slant italic))
2207   "Basic bold-italic face."
2208   :group 'basic-faces)
2209
2210 (defface underline
2211   '((((supports :underline t))
2212      :underline t)
2213     (((supports :weight bold))
2214      :weight bold)
2215     (t :underline t))
2216   "Basic underlined face."
2217   :group 'basic-faces)
2218
2219 (defface fixed-pitch
2220   '((t :family "Monospace"))
2221   "The basic fixed-pitch face."
2222   :group 'basic-faces)
2223
2224 (defface variable-pitch
2225   '((t :family "Sans Serif"))
2226   "The basic variable-pitch face."
2227   :group 'basic-faces)
2228
2229 (defface shadow
2230   '((((class color grayscale) (min-colors 88) (background light))
2231      :foreground "grey50")
2232     (((class color grayscale) (min-colors 88) (background dark))
2233      :foreground "grey70")
2234     (((class color) (min-colors 8) (background light))
2235      :foreground "green")
2236     (((class color) (min-colors 8) (background dark))
2237      :foreground "yellow"))
2238   "Basic face for shadowed text."
2239   :group 'basic-faces
2240   :version "22.1")
2241
2242 (defface link
2243   '((((class color) (min-colors 88) (background light))
2244      :foreground "blue1" :underline t)
2245     (((class color) (background light))
2246      :foreground "blue" :underline t)
2247     (((class color) (min-colors 88) (background dark))
2248      :foreground "cyan1" :underline t)
2249     (((class color) (background dark))
2250      :foreground "cyan" :underline t)
2251     (t :inherit underline))
2252   "Basic face for unvisited links."
2253   :group 'basic-faces
2254   :version "22.1")
2255
2256 (defface link-visited
2257   '((default :inherit link)
2258     (((class color) (background light)) :foreground "magenta4")
2259     (((class color) (background dark)) :foreground "violet"))
2260   "Basic face for visited links."
2261   :group 'basic-faces
2262   :version "22.1")
2263
2264 (defface highlight
2265   '((((class color) (min-colors 88) (background light))
2266      :background "darkseagreen2")
2267     (((class color) (min-colors 88) (background dark))
2268      :background "darkolivegreen")
2269     (((class color) (min-colors 16) (background light))
2270      :background "darkseagreen2")
2271     (((class color) (min-colors 16) (background dark))
2272      :background "darkolivegreen")
2273     (((class color) (min-colors 8))
2274      :background "green" :foreground "black")
2275     (t :inverse-video t))
2276   "Basic face for highlighting."
2277   :group 'basic-faces)
2278
2279 ;; Region face: under NS, default to the system-defined selection
2280 ;; color (optimized for the fixed white background of other apps),
2281 ;; if background is light.
2282 (defface region
2283   '((((class color) (min-colors 88) (background dark))
2284      :background "blue3")
2285     (((class color) (min-colors 88) (background light) (type gtk))
2286      :foreground "gtk_selection_fg_color"
2287      :background "gtk_selection_bg_color")
2288     (((class color) (min-colors 88) (background light) (type ns))
2289      :background "ns_selection_color")
2290     (((class color) (min-colors 88) (background light))
2291      :background "lightgoldenrod2")
2292     (((class color) (min-colors 16) (background dark))
2293      :background "blue3")
2294     (((class color) (min-colors 16) (background light))
2295      :background "lightgoldenrod2")
2296     (((class color) (min-colors 8))
2297      :background "blue" :foreground "white")
2298     (((type tty) (class mono))
2299      :inverse-video t)
2300     (t :background "gray"))
2301   "Basic face for highlighting the region."
2302   :version "21.1"
2303   :group 'basic-faces)
2304
2305 (defface secondary-selection
2306   '((((class color) (min-colors 88) (background light))
2307      :background "yellow1")
2308     (((class color) (min-colors 88) (background dark))
2309      :background "SkyBlue4")
2310     (((class color) (min-colors 16) (background light))
2311      :background "yellow")
2312     (((class color) (min-colors 16) (background dark))
2313      :background "SkyBlue4")
2314     (((class color) (min-colors 8))
2315      :background "cyan" :foreground "black")
2316     (t :inverse-video t))
2317   "Basic face for displaying the secondary selection."
2318   :group 'basic-faces)
2319
2320 (defface trailing-whitespace
2321   '((((class color) (background light))
2322      :background "red1")
2323     (((class color) (background dark))
2324      :background "red1")
2325     (t :inverse-video t))
2326   "Basic face for highlighting trailing whitespace."
2327   :version "21.1"
2328   :group 'whitespace-faces      ; like `show-trailing-whitespace'
2329   :group 'basic-faces)
2330
2331 (defface escape-glyph
2332   '((((background dark)) :foreground "cyan")
2333     ;; See the comment in minibuffer-prompt for
2334     ;; the reason not to use blue on MS-DOS.
2335     (((type pc)) :foreground "magenta")
2336     ;; red4 is too dark, but some say blue is too loud.
2337     ;; brown seems to work ok. -- rms.
2338     (t :foreground "brown"))
2339   "Face for characters displayed as sequences using `^' or `\\'."
2340   :group 'basic-faces
2341   :version "22.1")
2342
2343 (defface nobreak-space
2344   '((((class color) (min-colors 88)) :inherit escape-glyph :underline t)
2345     (((class color) (min-colors 8)) :background "magenta")
2346     (t :inverse-video t))
2347   "Face for displaying nobreak space."
2348   :group 'basic-faces
2349   :version "22.1")
2350
2351 (defgroup mode-line-faces nil
2352   "Faces used in the mode line."
2353   :group 'mode-line
2354   :group 'faces
2355   :version "22.1")
2356
2357 (defface mode-line
2358   '((((class color) (min-colors 88))
2359      :box (:line-width -1 :style released-button)
2360      :background "grey75" :foreground "black")
2361     (t
2362      :inverse-video t))
2363   "Basic mode line face for selected window."
2364   :version "21.1"
2365   :group 'mode-line-faces
2366   :group 'basic-faces)
2367 ;; No need to define aliases of this form for new faces.
2368 (define-obsolete-face-alias 'modeline 'mode-line "21.1")
2369
2370 (defface mode-line-inactive
2371   '((default
2372      :inherit mode-line)
2373     (((class color) (min-colors 88) (background light))
2374      :weight light
2375      :box (:line-width -1 :color "grey75" :style nil)
2376      :foreground "grey20" :background "grey90")
2377     (((class color) (min-colors 88) (background dark) )
2378      :weight light
2379      :box (:line-width -1 :color "grey40" :style nil)
2380      :foreground "grey80" :background "grey30"))
2381   "Basic mode line face for non-selected windows."
2382   :version "22.1"
2383   :group 'mode-line-faces
2384   :group 'basic-faces)
2385 (define-obsolete-face-alias 'modeline-inactive 'mode-line-inactive "22.1")
2386
2387 (defface mode-line-highlight
2388   '((((class color) (min-colors 88))
2389      :box (:line-width 2 :color "grey40" :style released-button))
2390     (t
2391      :inherit highlight))
2392   "Basic mode line face for highlighting."
2393   :version "22.1"
2394   :group 'mode-line-faces
2395   :group 'basic-faces)
2396 (define-obsolete-face-alias 'modeline-highlight 'mode-line-highlight "22.1")
2397
2398 (defface mode-line-emphasis
2399   '((t (:weight bold)))
2400   "Face used to emphasize certain mode line features.
2401 Use the face `mode-line-highlight' for features that can be selected."
2402   :version "23.1"
2403   :group 'mode-line-faces
2404   :group 'basic-faces)
2405
2406 (defface mode-line-buffer-id
2407   '((t (:weight bold)))
2408   "Face used for buffer identification parts of the mode line."
2409   :version "22.1"
2410   :group 'mode-line-faces
2411   :group 'basic-faces)
2412 (define-obsolete-face-alias 'modeline-buffer-id 'mode-line-buffer-id "22.1")
2413
2414 (defface header-line
2415   '((default
2416      :inherit mode-line)
2417     (((type tty))
2418      ;; This used to be `:inverse-video t', but that doesn't look very
2419      ;; good when combined with inverse-video mode-lines and multiple
2420      ;; windows.  Underlining looks better, and is more consistent with
2421      ;; the window-system face variants, which deemphasize the
2422      ;; header-line in relation to the mode-line face.  If a terminal
2423      ;; can't underline, then the header-line will end up without any
2424      ;; highlighting; this may be too confusing in general, although it
2425      ;; happens to look good with the only current use of header-lines,
2426      ;; the info browser. XXX
2427      :inverse-video nil        ;Override the value inherited from mode-line.
2428      :underline t)
2429     (((class color grayscale) (background light))
2430      :background "grey90" :foreground "grey20"
2431      :box nil)
2432     (((class color grayscale) (background dark))
2433      :background "grey20" :foreground "grey90"
2434      :box nil)
2435     (((class mono) (background light))
2436      :background "white" :foreground "black"
2437      :inverse-video nil
2438      :box nil
2439      :underline t)
2440     (((class mono) (background dark))
2441      :background "black" :foreground "white"
2442      :inverse-video nil
2443      :box nil
2444      :underline t))
2445   "Basic header-line face."
2446   :version "21.1"
2447   :group 'basic-faces)
2448
2449 (defface vertical-border
2450   '((((type tty)) :inherit mode-line-inactive))
2451   "Face used for vertical window dividers on ttys."
2452   :version "22.1"
2453   :group 'basic-faces)
2454
2455 (defface minibuffer-prompt
2456   '((((background dark)) :foreground "cyan")
2457     ;; Don't use blue because many users of the MS-DOS port customize
2458     ;; their foreground color to be blue.
2459     (((type pc)) :foreground "magenta")
2460     (t :foreground "medium blue"))
2461   "Face for minibuffer prompts.
2462 By default, Emacs automatically adds this face to the value of
2463 `minibuffer-prompt-properties', which is a list of text properties
2464 used to display the prompt text."
2465   :version "22.1"
2466   :group 'basic-faces)
2467
2468 (setq minibuffer-prompt-properties
2469       (append minibuffer-prompt-properties (list 'face 'minibuffer-prompt)))
2470
2471 (defface fringe
2472   '((((class color) (background light))
2473      :background "grey95")
2474     (((class color) (background dark))
2475      :background "grey10")
2476     (t
2477      :background "gray"))
2478   "Basic face for the fringes to the left and right of windows under X."
2479   :version "21.1"
2480   :group 'frames
2481   :group 'basic-faces)
2482
2483 (defface scroll-bar '((t nil))
2484   "Basic face for the scroll bar colors under X."
2485   :version "21.1"
2486   :group 'frames
2487   :group 'basic-faces)
2488
2489 (defface border '((t nil))
2490   "Basic face for the frame border under X."
2491   :version "21.1"
2492   :group 'frames
2493   :group 'basic-faces)
2494
2495 (defface cursor '((t nil))
2496   "Basic face for the cursor color under X.
2497 Note: Other faces cannot inherit from the cursor face."
2498   :version "21.1"
2499   :group 'cursor
2500   :group 'basic-faces)
2501
2502 (put 'cursor 'face-no-inherit t)
2503
2504 (defface mouse '((t nil))
2505   "Basic face for the mouse color under X."
2506   :version "21.1"
2507   :group 'mouse
2508   :group 'basic-faces)
2509
2510 (defface tool-bar
2511   '((default
2512      :box (:line-width 1 :style released-button)
2513      :foreground "black")
2514     (((type x w32 ns) (class color))
2515      :background "grey75")
2516     (((type x) (class mono))
2517      :background "grey"))
2518   "Basic tool-bar face."
2519   :version "21.1"
2520   :group 'basic-faces)
2521
2522 (defface menu
2523   '((((type tty))
2524      :inverse-video t)
2525     (((type x-toolkit))
2526      )
2527     (t
2528      :inverse-video t))
2529   "Basic face for the font and colors of the menu bar and popup menus."
2530   :version "21.1"
2531   :group 'menu
2532   :group 'basic-faces)
2533
2534 (defface help-argument-name '((((supports :slant italic)) :inherit italic))
2535   "Face to highlight argument names in *Help* buffers."
2536   :group 'help)
2537 \f
2538 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2539 ;;; Manipulating font names.
2540 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2541
2542 ;; This is here for compatibilty with Emacs 20.2.  For example,
2543 ;; international/fontset.el uses x-resolve-font-name.  The following
2544 ;; functions are not used in the face implementation itself.
2545
2546 (defvar x-font-regexp nil)
2547 (defvar x-font-regexp-head nil)
2548 (defvar x-font-regexp-weight nil)
2549 (defvar x-font-regexp-slant nil)
2550
2551 (defconst x-font-regexp-weight-subnum 1)
2552 (defconst x-font-regexp-slant-subnum 2)
2553 (defconst x-font-regexp-swidth-subnum 3)
2554 (defconst x-font-regexp-adstyle-subnum 4)
2555
2556 ;;; Regexps matching font names in "Host Portable Character Representation."
2557 ;;;
2558 (let ((-                "[-?]")
2559       (foundry          "[^-]+")
2560       (family           "[^-]+")
2561       (weight           "\\(bold\\|demibold\\|medium\\)")               ; 1
2562 ;     (weight\?         "\\(\\*\\|bold\\|demibold\\|medium\\|\\)")      ; 1
2563       (weight\?         "\\([^-]*\\)")                                  ; 1
2564       (slant            "\\([ior]\\)")                                  ; 2
2565 ;     (slant\?          "\\([ior?*]?\\)")                               ; 2
2566       (slant\?          "\\([^-]?\\)")                                  ; 2
2567 ;     (swidth           "\\(\\*\\|normal\\|semicondensed\\|\\)")        ; 3
2568       (swidth           "\\([^-]*\\)")                                  ; 3
2569 ;     (adstyle          "\\(\\*\\|sans\\|\\)")                          ; 4
2570       (adstyle          "\\([^-]*\\)")                                  ; 4
2571       (pixelsize        "[0-9]+")
2572       (pointsize        "[0-9][0-9]+")
2573       (resx             "[0-9][0-9]+")
2574       (resy             "[0-9][0-9]+")
2575       (spacing          "[cmp?*]")
2576       (avgwidth         "[0-9]+")
2577       (registry         "[^-]+")
2578       (encoding         "[^-]+")
2579       )
2580   (setq x-font-regexp
2581         (purecopy (concat "\\`\\*?[-?*]"
2582                 foundry - family - weight\? - slant\? - swidth - adstyle -
2583                 pixelsize - pointsize - resx - resy - spacing - avgwidth -
2584                 registry - encoding "\\*?\\'"
2585                 )))
2586   (setq x-font-regexp-head
2587         (purecopy (concat "\\`[-?*]" foundry - family - weight\? - slant\?
2588                 "\\([-*?]\\|\\'\\)")))
2589   (setq x-font-regexp-slant (purecopy (concat - slant -)))
2590   (setq x-font-regexp-weight (purecopy (concat - weight -)))
2591   nil)
2592
2593
2594 (defun x-resolve-font-name (pattern &optional face frame)
2595   "Return a font name matching PATTERN.
2596 All wildcards in PATTERN are instantiated.
2597 If PATTERN is nil, return the name of the frame's base font, which never
2598 contains wildcards.
2599 Given optional arguments FACE and FRAME, return a font which is
2600 also the same size as FACE on FRAME, or fail."
2601   (or (symbolp face)
2602       (setq face (face-name face)))
2603   (and (eq frame t)
2604        (setq frame nil))
2605   (if pattern
2606       ;; Note that x-list-fonts has code to handle a face with nil as its font.
2607       (let ((fonts (x-list-fonts pattern face frame 1)))
2608         (or fonts
2609             (if face
2610                 (if (string-match "\\*" pattern)
2611                     (if (null (face-font face))
2612                         (error "No matching fonts are the same height as the frame default font")
2613                       (error "No matching fonts are the same height as face `%s'" face))
2614                   (if (null (face-font face))
2615                       (error "Height of font `%s' doesn't match the frame default font"
2616                              pattern)
2617                     (error "Height of font `%s' doesn't match face `%s'"
2618                            pattern face)))
2619               (error "No fonts match `%s'" pattern)))
2620         (car fonts))
2621     (cdr (assq 'font (frame-parameters (selected-frame))))))
2622
2623
2624 (defun x-frob-font-weight (font which)
2625   (let ((case-fold-search t))
2626     (cond ((string-match x-font-regexp font)
2627            (concat (substring font 0
2628                               (match-beginning x-font-regexp-weight-subnum))
2629                    which
2630                    (substring font (match-end x-font-regexp-weight-subnum)
2631                               (match-beginning x-font-regexp-adstyle-subnum))
2632                    ;; Replace the ADD_STYLE_NAME field with *
2633                    ;; because the info in it may not be the same
2634                    ;; for related fonts.
2635                    "*"
2636                    (substring font (match-end x-font-regexp-adstyle-subnum))))
2637           ((string-match x-font-regexp-head font)
2638            (concat (substring font 0 (match-beginning 1)) which
2639                    (substring font (match-end 1))))
2640           ((string-match x-font-regexp-weight font)
2641            (concat (substring font 0 (match-beginning 1)) which
2642                    (substring font (match-end 1)))))))
2643 (make-obsolete 'x-frob-font-weight 'make-face-... "21.1")
2644
2645 (defun x-frob-font-slant (font which)
2646   (let ((case-fold-search t))
2647     (cond ((string-match x-font-regexp font)
2648            (concat (substring font 0
2649                               (match-beginning x-font-regexp-slant-subnum))
2650                    which
2651                    (substring font (match-end x-font-regexp-slant-subnum)
2652                               (match-beginning x-font-regexp-adstyle-subnum))
2653                    ;; Replace the ADD_STYLE_NAME field with *
2654                    ;; because the info in it may not be the same
2655                    ;; for related fonts.
2656                    "*"
2657                    (substring font (match-end x-font-regexp-adstyle-subnum))))
2658           ((string-match x-font-regexp-head font)
2659            (concat (substring font 0 (match-beginning 2)) which
2660                    (substring font (match-end 2))))
2661           ((string-match x-font-regexp-slant font)
2662            (concat (substring font 0 (match-beginning 1)) which
2663                    (substring font (match-end 1)))))))
2664 (make-obsolete 'x-frob-font-slant 'make-face-... "21.1")
2665
2666 ;; These aliases are here so that we don't get warnings about obsolete
2667 ;; functions from the byte compiler.
2668 (defalias 'internal-frob-font-weight 'x-frob-font-weight)
2669 (defalias 'internal-frob-font-slant 'x-frob-font-slant)
2670
2671 (defun x-make-font-bold (font)
2672   "Given an X font specification, make a bold version of it.
2673 If that can't be done, return nil."
2674   (internal-frob-font-weight font "bold"))
2675 (make-obsolete 'x-make-font-bold 'make-face-bold "21.1")
2676
2677 (defun x-make-font-demibold (font)
2678   "Given an X font specification, make a demibold version of it.
2679 If that can't be done, return nil."
2680   (internal-frob-font-weight font "demibold"))
2681 (make-obsolete 'x-make-font-demibold 'make-face-bold "21.1")
2682
2683 (defun x-make-font-unbold (font)
2684   "Given an X font specification, make a non-bold version of it.
2685 If that can't be done, return nil."
2686   (internal-frob-font-weight font "medium"))
2687 (make-obsolete 'x-make-font-unbold 'make-face-unbold "21.1")
2688
2689 (defun x-make-font-italic (font)
2690   "Given an X font specification, make an italic version of it.
2691 If that can't be done, return nil."
2692   (internal-frob-font-slant font "i"))
2693 (make-obsolete 'x-make-font-italic 'make-face-italic "21.1")
2694
2695 (defun x-make-font-oblique (font) ; you say tomayto...
2696   "Given an X font specification, make an oblique version of it.
2697 If that can't be done, return nil."
2698   (internal-frob-font-slant font "o"))
2699 (make-obsolete 'x-make-font-oblique 'make-face-italic "21.1")
2700
2701 (defun x-make-font-unitalic (font)
2702   "Given an X font specification, make a non-italic version of it.
2703 If that can't be done, return nil."
2704   (internal-frob-font-slant font "r"))
2705 (make-obsolete 'x-make-font-unitalic 'make-face-unitalic "21.1")
2706
2707 (defun x-make-font-bold-italic (font)
2708   "Given an X font specification, make a bold and italic version of it.
2709 If that can't be done, return nil."
2710   (and (setq font (internal-frob-font-weight font "bold"))
2711        (internal-frob-font-slant font "i")))
2712 (make-obsolete 'x-make-font-bold-italic 'make-face-bold-italic "21.1")
2713
2714 (provide 'faces)
2715
2716 ;; arch-tag: 19a4759f-2963-445f-b004-425b9aadd7d6
2717 ;;; faces.el ends here