lisp/faces.el

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