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