face-remap.el 17.1 KB
Newer Older
1 2
;;; face-remap.el --- Functions for managing `face-remapping-alist'
;;
3
;; Copyright (C) 2008-2012 Free Software Foundation, Inc.
4 5
;;
;; Author: Miles Bader <miles@gnu.org>
Juri Linkov's avatar
Juri Linkov committed
6
;; Keywords: faces, face remapping, display, user commands
7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38
;;
;; This file is part of GNU Emacs.
;;
;; GNU Emacs is free software: you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
;;
;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.
;;
;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
;;

;;; Commentary:

;;
;; This file defines some simple operations that can be used for
;; maintaining the `face-remapping-alist' in a cooperative way.  This is
;; especially important for the `default' face.
;;
;; Each face-remapping definition in `face-remapping-alist' added by
;; this code uses the form:
;;
;;   (face RELATIVE_SPECS_1 RELATIVE_SPECS_2 ... BASE_SPECS)
;;
;; The "specs" values are a lists of face names or face attribute-value
;; pairs, and are merged together, with earlier values taking precedence.
;;
39 40
;; The RELATIVE_SPECS_* values are added by `face-remap-add-relative'
;; (and removed by `face-remap-remove-relative', and are intended for
41 42 43 44 45 46 47
;; face "modifications" (such as increasing the size).  Typical users of
;; relative specs would be minor modes.
;;
;; BASE_SPECS is the lowest-priority value, and by default is just the
;; face name, which causes the global definition of that face to be used.
;;
;; A non-default value of BASE_SPECS may also be set using
48
;; `face-remap-set-base'.  Because this _overwrites_ the default
49
;; value inheriting from the global face definition, it is up to the
50 51
;; caller of face-remap-set-base to add such inheritance if it is
;; desired.  A typical use of face-remap-set-base would be a major
52 53 54 55 56 57 58 59 60 61 62 63
;; mode setting face remappings, e.g., of the default face.
;;
;; All modifications cause face-remapping-alist to be made buffer-local.
;;


;;; Code:


;; ----------------------------------------------------------------
;; Utility functions

64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105
;; Names of face attributes corresponding to lisp face-vector positions.
;; This variable should probably be defined in C code where the actual
;; definitions are available.
;;
(defvar internal-lisp-face-attributes
  [nil
   :family :foundry :swidth :height :weight :slant :underline :inverse
   :foreground :background :stipple :overline :strike :box
   :font :inherit :fontset :vector])

(defun face-attrs-more-relative-p (attrs1 attrs2)
"Return true if ATTRS1 contains a greater number of relative
face-attributes than ATTRS2.  A face attribute is considered
relative if `face-attribute-relative-p' returns non-nil.

ATTRS1 and ATTRS2 may be any value suitable for a `face' text
property, including face names, lists of face names,
face-attribute plists, etc.

This function can be used as a predicate with `sort', to sort
face lists so that more specific faces are located near the end."
  (unless (vectorp attrs1)
    (setq attrs1 (face-attributes-as-vector attrs1)))
  (unless (vectorp attrs2)
    (setq attrs2 (face-attributes-as-vector attrs2)))
  (let ((rel1-count 0) (rel2-count 0))
    (dotimes (i (length attrs1))
      (let ((attr (aref internal-lisp-face-attributes i)))
	(when attr
	  (when (face-attribute-relative-p attr (aref attrs1 i))
	    (setq rel1-count (+ rel1-count 1)))
	  (when (face-attribute-relative-p attr (aref attrs2 i))
	    (setq rel2-count (+ rel2-count 1))))))
    (< rel1-count rel2-count)))

(defun face-remap-order (entry)
  "Order ENTRY so that more relative face specs are near the beginning.
The list structure of ENTRY may be destructively modified."
  (setq entry (nreverse entry))
  (setcdr entry (sort (cdr entry) 'face-attrs-more-relative-p))
  (nreverse entry))

106
;;;###autoload
107
(defun face-remap-add-relative (face &rest specs)
108
  "Add a face remapping entry of FACE to SPECS in the current buffer.
109
Return a cookie which can be used to delete this remapping with
110
`face-remap-remove-relative'.
111

112 113 114 115 116 117 118 119 120 121 122
The remaining arguments, SPECS, should be either a list of face
names, or a property list of face attribute/value pairs.  The
remapping specified by SPECS takes effect alongside the
remappings from other calls to `face-remap-add-relative', as well
as the normal definition of FACE (at lowest priority).  This
function tries to sort multiple remappings for the same face, so
that remappings specifying relative face attributes are applied
after remappings specifying absolute face attributes.

The base (lowest priority) remapping may be set to something
other than the normal definition of FACE via `face-remap-set-base'."
123 124
  (while (and (consp specs) (null (cdr specs)))
    (setq specs (car specs)))
125 126 127 128 129
  (make-local-variable 'face-remapping-alist)
  (let ((entry (assq face face-remapping-alist)))
    (when (null entry)
      (setq entry (list face face))	; explicitly merge with global def
      (push entry face-remapping-alist))
130
    (setcdr entry (face-remap-order (cons specs (cdr entry))))
131 132
    (cons face specs)))

133 134
(defun face-remap-remove-relative (cookie)
  "Remove a face remapping previously added by `face-remap-add-relative'.
135 136 137 138 139 140 141 142 143 144 145 146 147
COOKIE should be the return value from that function."
  (let ((remapping (assq (car cookie) face-remapping-alist)))
    (when remapping
      (let ((updated-entries (remq (cdr cookie) (cdr remapping))))
	(unless (eq updated-entries (cdr remapping))
	  (setcdr remapping updated-entries)
	  (when (or (null updated-entries)
		    (and (eq (car-safe updated-entries) (car cookie))
			 (null (cdr updated-entries))))
	    (setq face-remapping-alist
		  (remq remapping face-remapping-alist)))
	  (cdr cookie))))))

148
;;;###autoload
149
(defun face-remap-reset-base (face)
150 151 152
  "Set the base remapping of FACE to the normal definition of FACE.
This causes the remappings specified by `face-remap-add-relative'
to apply on top of the normal definition of FACE."
153 154 155 156 157 158 159 160 161 162 163
  (let ((entry (assq face face-remapping-alist)))
    (when entry
      ;; If there's nothing except a base remapping, we simply remove
      ;; the entire remapping entry, as setting the base to the default
      ;; would be the same as the global definition.  Otherwise, we
      ;; modify the base remapping.
      (if (null (cddr entry))		; nothing except base remapping
	  (setq face-remapping-alist	; so remove entire entry
		(remq entry face-remapping-alist))
	(setcar (last entry) face)))))  ; otherwise, just inherit global def

164
;;;###autoload
165
(defun face-remap-set-base (face &rest specs)
166
  "Set the base remapping of FACE in the current buffer to SPECS.
167 168 169 170 171 172 173 174 175
This causes the remappings specified by `face-remap-add-relative'
to apply on top of the face specification given by SPECS.  SPECS
should be either a list of face names, or a property list of face
attribute/value pairs.

If SPECS is empty, call `face-remap-reset-base' to use the normal
definition of FACE as the base remapping; note that this is
different from SPECS containing a single value `nil', which means
not to inherit from the global definition of FACE at all."
176 177
  (while (and (consp specs) (not (null (car specs))) (null (cdr specs)))
    (setq specs (car specs)))
178 179 180
  (if (or (null specs)
	  (and (eq (car specs) face) (null (cdr specs)))) ; default
      ;; Set entry back to default
181
      (face-remap-reset-base face)
182 183 184 185 186 187
    ;; Set the base remapping
    (make-local-variable 'face-remapping-alist)
    (let ((entry (assq face face-remapping-alist)))
      (if entry
	  (setcar (last entry) specs)	; overwrite existing base entry
	(push (list face specs) face-remapping-alist)))))
188

189 190 191 192 193 194 195 196

;; ----------------------------------------------------------------
;; text-scale-mode

(defcustom text-scale-mode-step 1.2
  "Scale factor used by `text-scale-mode'.
Each positive or negative step scales the default face height by this amount."
  :group 'display
197 198
  :type 'number
  :version "23.1")
199 200 201 202 203 204 205 206 207 208 209 210 211 212

;; current remapping cookie for text-scale-mode
(defvar text-scale-mode-remapping nil)
(make-variable-buffer-local 'text-scale-mode-remapping)

;; Lighter displayed for text-scale-mode in mode-line minor-mode list
(defvar text-scale-mode-lighter "+0")
(make-variable-buffer-local 'text-scale-mode-lighter)

;; Number of steps that text-scale-mode will increase/decrease text height
(defvar text-scale-mode-amount 0)
(make-variable-buffer-local 'text-scale-mode-amount)

(define-minor-mode text-scale-mode
213
  "Minor mode for displaying buffer text in a larger/smaller font.
214 215 216
With a prefix argument ARG, enable the mode if ARG is positive,
and disable it otherwise.  If called from Lisp, enable the mode
if ARG is omitted or nil.
217 218

The amount of scaling is determined by the variable
219 220 221 222
`text-scale-mode-amount': one step scales the global default
face size by the value of the variable `text-scale-mode-step'
\(a negative amount shrinks the text).

Miles Bader's avatar
Miles Bader committed
223 224 225 226
The `text-scale-increase', `text-scale-decrease', and
`text-scale-set' functions may be used to interactively modify
the variable `text-scale-mode-amount' (they also enable or
disable `text-scale-mode' as necessary)."
227 228
  :lighter (" " text-scale-mode-lighter)
  (when text-scale-mode-remapping
229
    (face-remap-remove-relative text-scale-mode-remapping))
230 231 232 233 234
  (setq text-scale-mode-lighter
	(format (if (>= text-scale-mode-amount 0) "+%d" "%d")
		text-scale-mode-amount))
  (setq text-scale-mode-remapping
	(and text-scale-mode
235
	     (face-remap-add-relative 'default
236 237 238 239 240
					  :height
					  (expt text-scale-mode-step
						text-scale-mode-amount))))
  (force-window-update (current-buffer)))

Miles Bader's avatar
Miles Bader committed
241 242 243 244 245 246 247 248 249 250 251 252 253
;;;###autoload
(defun text-scale-set (level)
  "Set the scale factor of the default face in the current buffer to LEVEL.
If LEVEL is non-zero, `text-scale-mode' is enabled, otherwise it is disabled.

LEVEL is a number of steps, with 0 representing the default size.
Each step scales the height of the default face by the variable
`text-scale-mode-step' (a negative number decreases the height by
the same amount)."
  (interactive "p")
  (setq text-scale-mode-amount level)
  (text-scale-mode (if (zerop text-scale-mode-amount) -1 1)))

254
;;;###autoload
255
(defun text-scale-increase (inc)
256 257 258 259 260 261 262
  "Increase the height of the default face in the current buffer by INC steps.
If the new height is other than the default, `text-scale-mode' is enabled.

Each step scales the height of the default face by the variable
`text-scale-mode-step' (a negative number of steps decreases the
height by the same amount).  As a special case, an argument of 0
will remove any scaling currently active."
263
  (interactive "p")
264 265
  (setq text-scale-mode-amount
	(if (= inc 0) 0 (+ (if text-scale-mode text-scale-mode-amount 0) inc)))
266 267 268
  (text-scale-mode (if (zerop text-scale-mode-amount) -1 1)))

;;;###autoload
269
(defun text-scale-decrease (dec)
270
  "Decrease the height of the default face in the current buffer by DEC steps.
271
See `text-scale-increase' for more details."
272
  (interactive "p")
273
  (text-scale-increase (- dec)))
274

275 276 277 278
;;;###autoload (define-key ctl-x-map [(control ?+)] 'text-scale-adjust)
;;;###autoload (define-key ctl-x-map [(control ?-)] 'text-scale-adjust)
;;;###autoload (define-key ctl-x-map [(control ?=)] 'text-scale-adjust)
;;;###autoload (define-key ctl-x-map [(control ?0)] 'text-scale-adjust)
279
;;;###autoload
280
(defun text-scale-adjust (inc)
281 282 283
  "Increase or decrease the height of the default face in the current buffer.

The actual adjustment made depends on the final component of the
284
key-binding used to invoke the command, with all modifiers removed:
285 286 287 288 289 290

   +, =   Increase the default face height by one step
   -      Decrease the default face height by one step
   0      Reset the default face height to the global default

Then, continue to read input events and further adjust the face
291 292
height as long as the input event read (with all modifiers removed)
is one of the above.
293 294 295 296 297 298 299

Each step scales the height of the default face by the variable
`text-scale-mode-step' (a negative number of steps decreases the
height by the same amount).  As a special case, an argument of 0
will remove any scaling currently active.

This command is a special-purpose wrapper around the
300 301 302 303
`text-scale-increase' command which makes repetition convenient
even when it is bound in a non-top-level keymap.  For binding in
a top-level keymap, `text-scale-increase' or
`text-scale-decrease' may be more appropriate."
304
  (interactive "p")
305
  (let ((first t)
306
	(step t)
307 308
	(ev last-command-event)
	(echo-keystrokes nil))
309 310 311 312 313 314 315 316
    (while step
      (let ((base (event-basic-type ev)))
	(cond ((or (eq base ?+) (eq base ?=))
	       (setq step inc))
	      ((eq base ?-)
	       (setq step (- inc)))
	      ((eq base ?0)
	       (setq step 0))
317
	      (first
318 319 320 321
	       (setq step inc))
	      (t
	       (setq step nil))))
      (when step
322
	(text-scale-increase step)
323
	(setq inc 1 first nil)
324
	(setq ev (read-event "+,-,0 for further adjustment: "))))
325 326
    (push ev unread-command-events)))

327 328

;; ----------------------------------------------------------------
Miles Bader's avatar
Miles Bader committed
329
;; buffer-face-mode
330

Miles Bader's avatar
Miles Bader committed
331 332 333 334 335
(defcustom buffer-face-mode-face 'variable-pitch
  "The face specification used by `buffer-face-mode'.
It may contain any value suitable for a `face' text property,
including a face name, a list of face names, a face-attribute
plist, etc."
336 337
  :group 'display
  :version "23.1")
338

Miles Bader's avatar
Miles Bader committed
339 340 341
;; current remapping cookie for  buffer-face-mode
(defvar buffer-face-mode-remapping nil)
(make-variable-buffer-local 'buffer-face-mode-remapping)
342

Miles Bader's avatar
Miles Bader committed
343
;;;###autoload
Miles Bader's avatar
Miles Bader committed
344 345
(define-minor-mode buffer-face-mode
  "Minor mode for a buffer-specific default face.
346 347 348 349
With a prefix argument ARG, enable the mode if ARG is positive,
and disable it otherwise.  If called from Lisp, enable the mode
if ARG is omitted or nil.  When enabled, the face specified by the
variable `buffer-face-mode-face' is used to display the buffer text."
Miles Bader's avatar
Miles Bader committed
350 351 352 353 354 355
  :lighter " BufFace"
  (when buffer-face-mode-remapping
    (face-remap-remove-relative buffer-face-mode-remapping))
  (setq buffer-face-mode-remapping
	(and buffer-face-mode
	     (face-remap-add-relative 'default buffer-face-mode-face)))
356 357
  (force-window-update (current-buffer)))

Miles Bader's avatar
Miles Bader committed
358
;;;###autoload
359 360 361 362 363 364 365 366
(defun buffer-face-set (&rest specs)
  "Enable `buffer-face-mode', using face specs SPECS.
SPECS can be any value suitable for the `face' text property,
including a face name, a list of face names, or a face-attribute
If SPECS is nil, then `buffer-face-mode' is disabled.

This function will make the variable `buffer-face-mode-face'
buffer local, and set it to FACE."
Miles Bader's avatar
Miles Bader committed
367
  (interactive (list (read-face-name "Set buffer face")))
368 369 370
  (while (and (consp specs) (null (cdr specs)))
    (setq specs (car specs)))
  (if (null specs)
Miles Bader's avatar
Miles Bader committed
371
      (buffer-face-mode 0)
372
    (set (make-local-variable 'buffer-face-mode-face) specs)
Miles Bader's avatar
Miles Bader committed
373 374 375
    (buffer-face-mode t)))

;;;###autoload
376 377 378 379
(defun buffer-face-toggle (&rest specs)
  "Toggle `buffer-face-mode', using face specs SPECS.
SPECS can be any value suitable for the `face' text property,
including a face name, a list of face names, or a face-attribute
Miles Bader's avatar
Miles Bader committed
380 381

If `buffer-face-mode' is already enabled, and is currently using
382
the face specs SPECS, then it is disabled; if buffer-face-mode is
Miles Bader's avatar
Miles Bader committed
383
disabled, or is enabled and currently displaying some other face,
384 385 386 387
then is left enabled, but the face changed to reflect SPECS.

This function will make the variable `buffer-face-mode-face'
buffer local, and set it to SPECS."
Miles Bader's avatar
Miles Bader committed
388
  (interactive (list buffer-face-mode-face))
389 390 391 392
  (while (and (consp specs) (null (cdr specs)))
    (setq specs (car specs)))
  (if (or (null specs)
	  (and buffer-face-mode (equal buffer-face-mode-face specs)))
Miles Bader's avatar
Miles Bader committed
393
      (buffer-face-mode 0)
394
    (set (make-local-variable 'buffer-face-mode-face) specs)
Miles Bader's avatar
Miles Bader committed
395 396
    (buffer-face-mode t)))

397 398 399 400 401 402 403 404 405 406
(defun buffer-face-mode-invoke (specs arg &optional interactive)
  "Enable or disable `buffer-face-mode' using face specs SPECS, and argument ARG.
ARG controls whether the mode is enabled or disabled, and is
interpreted in the usual manner for minor-mode commands.

SPECS can be any value suitable for the `face' text property,
including a face name, a list of face names, or a face-attribute

If INTERACTIVE is non-nil, a message will be displayed describing the result.

407
This is a wrapper function which calls `buffer-face-set' or
408 409 410
`buffer-face-toggle' (depending on ARG), and prints a status
message in the echo area.  In many cases one of those functions
may be more appropriate."
Miles Bader's avatar
Miles Bader committed
411 412
  (let ((last-message (current-message)))
    (if (or (eq arg 'toggle) (not arg))
413 414
	(buffer-face-toggle specs)
      (buffer-face-set (and (> (prefix-numeric-value arg) 0) specs)))
Miles Bader's avatar
Miles Bader committed
415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430
    (when interactive
      (unless (and (current-message)
		   (not (equal last-message (current-message))))
	(message "Buffer-Face mode %sabled"
		 (if buffer-face-mode "en" "dis"))))))


;; ----------------------------------------------------------------
;; variable-pitch-mode

;;;###autoload
(defun variable-pitch-mode (&optional arg)
  "Variable-pitch default-face mode.
An interface to `buffer-face-mode' which uses the `variable-pitch' face.
Besides the choice of face, it is the same as `buffer-face-mode'."
  (interactive (list (or current-prefix-arg 'toggle)))
431 432
  (buffer-face-mode-invoke 'variable-pitch arg
			   (called-interactively-p 'interactive)))
Miles Bader's avatar
Miles Bader committed
433

434 435 436 437

(provide 'face-remap)

;;; face-remap.el ends here