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