ChangeLog fix
[emacs.git] / lisp / whitespace.el
blob801cdc52047bd571371aff96f07c8428bce2c372
1 ;;; whitespace.el --- minor mode to visualize TAB, (HARD) SPACE, NEWLINE
3 ;; Copyright (C) 2000-2013 Free Software Foundation, Inc.
5 ;; Author: Vinicius Jose Latorre <viniciusjl@ig.com.br>
6 ;; Maintainer: Vinicius Jose Latorre <viniciusjl@ig.com.br>
7 ;; Keywords: data, wp
8 ;; Version: 13.2.2
9 ;; X-URL: http://www.emacswiki.org/cgi-bin/wiki/ViniciusJoseLatorre
11 ;; This file is part of GNU Emacs.
13 ;; GNU Emacs is free software: you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation, either version 3 of the License, or
16 ;; (at your option) any later version.
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
26 ;;; Commentary:
28 ;; ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
30 ;; Introduction
31 ;; ------------
33 ;; This package is a minor mode to visualize blanks (TAB, (HARD) SPACE
34 ;; and NEWLINE).
36 ;; whitespace uses two ways to visualize blanks: faces and display
37 ;; table.
39 ;; * Faces are used to highlight the background with a color.
40 ;; whitespace uses font-lock to highlight blank characters.
42 ;; * Display table changes the way a character is displayed, that is,
43 ;; it provides a visual mark for characters, for example, at the end
44 ;; of line (?\xB6), at SPACEs (?\xB7) and at TABs (?\xBB).
46 ;; The `whitespace-style' variable selects which way blanks are
47 ;; visualized.
49 ;; Note that when whitespace is turned on, whitespace saves the
50 ;; font-lock state, that is, if font-lock is on or off. And
51 ;; whitespace restores the font-lock state when it is turned off. So,
52 ;; if whitespace is turned on and font-lock is off, whitespace also
53 ;; turns on the font-lock to highlight blanks, but the font-lock will
54 ;; be turned off when whitespace is turned off. Thus, turn on
55 ;; font-lock before whitespace is on, if you want that font-lock
56 ;; continues on after whitespace is turned off.
58 ;; When whitespace is on, it takes care of highlighting some special
59 ;; characters over the default mechanism of `nobreak-char-display'
60 ;; (which see) and `show-trailing-whitespace' (which see).
62 ;; The trailing spaces are not highlighted while point is at end of line.
63 ;; Also the spaces at beginning of buffer are not highlighted while point is at
64 ;; beginning of buffer; and the spaces at end of buffer are not highlighted
65 ;; while point is at end of buffer.
67 ;; There are two ways of using whitespace: local and global.
69 ;; * Local whitespace affects only the current buffer.
71 ;; * Global whitespace affects all current and future buffers. That
72 ;; is, if you turn on global whitespace and then create a new
73 ;; buffer, the new buffer will also have whitespace on. The
74 ;; `whitespace-global-modes' variable controls which major-mode will
75 ;; be automagically turned on.
77 ;; You can mix the local and global usage without any conflict. But
78 ;; local whitespace has priority over global whitespace. Whitespace
79 ;; mode is active in a buffer if you have enabled it in that buffer or
80 ;; if you have enabled it globally.
82 ;; When global and local whitespace are on:
84 ;; * if local whitespace is turned off, whitespace is turned off for
85 ;; the current buffer only.
87 ;; * if global whitespace is turned off, whitespace continues on only
88 ;; in the buffers in which local whitespace is on.
90 ;; To use whitespace, insert in your ~/.emacs:
92 ;; (require 'whitespace)
94 ;; Or autoload at least one of the commands`whitespace-mode',
95 ;; `whitespace-toggle-options', `global-whitespace-mode' or
96 ;; `global-whitespace-toggle-options'. For example:
98 ;; (autoload 'whitespace-mode "whitespace"
99 ;; "Toggle whitespace visualization." t)
100 ;; (autoload 'whitespace-toggle-options "whitespace"
101 ;; "Toggle local `whitespace-mode' options." t)
103 ;; whitespace was inspired by:
105 ;; whitespace.el Rajesh Vaidheeswarran <rv@gnu.org>
106 ;; Warn about and clean bogus whitespaces in the file
107 ;; (inspired the idea to warn and clean some blanks)
108 ;; This was the original `whitespace.el' which was replaced by
109 ;; `blank-mode.el'. And later `blank-mode.el' was renamed to
110 ;; `whitespace.el'.
112 ;; show-whitespace-mode.el Aurelien Tisne <aurelien.tisne@free.fr>
113 ;; Simple mode to highlight whitespaces
114 ;; (inspired the idea to use font-lock)
116 ;; whitespace-mode.el Lawrence Mitchell <wence@gmx.li>
117 ;; Major mode for editing Whitespace
118 ;; (inspired the idea to use display table)
120 ;; visws.el Miles Bader <miles@gnu.org>
121 ;; Make whitespace visible
122 ;; (handle display table, his code was modified, but the main
123 ;; idea was kept)
126 ;; Using whitespace
127 ;; ----------------
129 ;; There is no problem if you mix local and global minor mode usage.
131 ;; * LOCAL whitespace:
132 ;; + To toggle whitespace options locally, type:
134 ;; M-x whitespace-toggle-options RET
136 ;; + To activate whitespace locally, type:
138 ;; C-u 1 M-x whitespace-mode RET
140 ;; + To deactivate whitespace locally, type:
142 ;; C-u 0 M-x whitespace-mode RET
144 ;; + To toggle whitespace locally, type:
146 ;; M-x whitespace-mode RET
148 ;; * GLOBAL whitespace:
149 ;; + To toggle whitespace options globally, type:
151 ;; M-x global-whitespace-toggle-options RET
153 ;; + To activate whitespace globally, type:
155 ;; C-u 1 M-x global-whitespace-mode RET
157 ;; + To deactivate whitespace globally, type:
159 ;; C-u 0 M-x global-whitespace-mode RET
161 ;; + To toggle whitespace globally, type:
163 ;; M-x global-whitespace-mode RET
165 ;; There are also the following useful commands:
167 ;; `whitespace-newline-mode'
168 ;; Toggle NEWLINE minor mode visualization ("nl" on mode line).
170 ;; `global-whitespace-newline-mode'
171 ;; Toggle NEWLINE global minor mode visualization ("NL" on mode line).
173 ;; `whitespace-report'
174 ;; Report some blank problems in buffer.
176 ;; `whitespace-report-region'
177 ;; Report some blank problems in a region.
179 ;; `whitespace-cleanup'
180 ;; Cleanup some blank problems in all buffer or at region.
182 ;; `whitespace-cleanup-region'
183 ;; Cleanup some blank problems at region.
185 ;; The problems, which are cleaned up, are:
187 ;; 1. empty lines at beginning of buffer.
188 ;; 2. empty lines at end of buffer.
189 ;; If `whitespace-style' includes the value `empty', remove all
190 ;; empty lines at beginning and/or end of buffer.
192 ;; 3. 8 or more SPACEs at beginning of line.
193 ;; If `whitespace-style' includes the value `indentation':
194 ;; replace 8 or more SPACEs at beginning of line by TABs, if
195 ;; `indent-tabs-mode' is non-nil; otherwise, replace TABs by
196 ;; SPACEs.
197 ;; If `whitespace-style' includes the value `indentation::tab',
198 ;; replace 8 or more SPACEs at beginning of line by TABs.
199 ;; If `whitespace-style' includes the value `indentation::space',
200 ;; replace TABs by SPACEs.
202 ;; 4. SPACEs before TAB.
203 ;; If `whitespace-style' includes the value `space-before-tab':
204 ;; replace SPACEs by TABs, if `indent-tabs-mode' is non-nil;
205 ;; otherwise, replace TABs by SPACEs.
206 ;; If `whitespace-style' includes the value
207 ;; `space-before-tab::tab', replace SPACEs by TABs.
208 ;; If `whitespace-style' includes the value
209 ;; `space-before-tab::space', replace TABs by SPACEs.
211 ;; 5. SPACEs or TABs at end of line.
212 ;; If `whitespace-style' includes the value `trailing', remove all
213 ;; SPACEs or TABs at end of line.
215 ;; 6. 8 or more SPACEs after TAB.
216 ;; If `whitespace-style' includes the value `space-after-tab':
217 ;; replace SPACEs by TABs, if `indent-tabs-mode' is non-nil;
218 ;; otherwise, replace TABs by SPACEs.
219 ;; If `whitespace-style' includes the value `space-after-tab::tab',
220 ;; replace SPACEs by TABs.
221 ;; If `whitespace-style' includes the value
222 ;; `space-after-tab::space', replace TABs by SPACEs.
225 ;; Hooks
226 ;; -----
228 ;; whitespace has the following hook variables:
230 ;; `whitespace-mode-hook'
231 ;; It is evaluated always when whitespace is turned on locally.
233 ;; `global-whitespace-mode-hook'
234 ;; It is evaluated always when whitespace is turned on globally.
236 ;; `whitespace-load-hook'
237 ;; It is evaluated after whitespace package is loaded.
240 ;; Options
241 ;; -------
243 ;; Below it's shown a brief description of whitespace options, please,
244 ;; see the options declaration in the code for a long documentation.
246 ;; `whitespace-style' Specify which kind of blank is
247 ;; visualized.
249 ;; `whitespace-space' Face used to visualize SPACE.
251 ;; `whitespace-hspace' Face used to visualize HARD SPACE.
253 ;; `whitespace-tab' Face used to visualize TAB.
255 ;; `whitespace-newline' Face used to visualize NEWLINE char
256 ;; mapping.
258 ;; `whitespace-trailing' Face used to visualize trailing
259 ;; blanks.
261 ;; `whitespace-line' Face used to visualize "long" lines.
263 ;; `whitespace-space-before-tab' Face used to visualize SPACEs
264 ;; before TAB.
266 ;; `whitespace-indentation' Face used to visualize 8 or more
267 ;; SPACEs at beginning of line.
269 ;; `whitespace-empty' Face used to visualize empty lines at
270 ;; beginning and/or end of buffer.
272 ;; `whitespace-space-after-tab' Face used to visualize 8 or more
273 ;; SPACEs after TAB.
275 ;; `whitespace-space-regexp' Specify SPACE characters regexp.
277 ;; `whitespace-hspace-regexp' Specify HARD SPACE characters regexp.
279 ;; `whitespace-tab-regexp' Specify TAB characters regexp.
281 ;; `whitespace-trailing-regexp' Specify trailing characters regexp.
283 ;; `whitespace-space-before-tab-regexp' Specify SPACEs before TAB
284 ;; regexp.
286 ;; `whitespace-indentation-regexp' Specify regexp for 8 or more
287 ;; SPACEs at beginning of line.
289 ;; `whitespace-empty-at-bob-regexp' Specify regexp for empty lines
290 ;; at beginning of buffer.
292 ;; `whitespace-empty-at-eob-regexp' Specify regexp for empty lines
293 ;; at end of buffer.
295 ;; `whitespace-space-after-tab-regexp' Specify regexp for 8 or more
296 ;; SPACEs after TAB.
298 ;; `whitespace-line-column' Specify column beyond which the line
299 ;; is highlighted.
301 ;; `whitespace-display-mappings' Specify an alist of mappings
302 ;; for displaying characters.
304 ;; `whitespace-global-modes' Modes for which global
305 ;; `whitespace-mode' is automagically
306 ;; turned on.
308 ;; `whitespace-action' Specify which action is taken when a
309 ;; buffer is visited or written.
312 ;; Acknowledgments
313 ;; ---------------
315 ;; Thanks to felix (EmacsWiki) for keeping highlight when switching between
316 ;; major modes on a file.
318 ;; Thanks to David Reitter <david.reitter@gmail.com> for suggesting a
319 ;; `whitespace-newline' initialization with low contrast relative to
320 ;; the background color.
322 ;; Thanks to Stephen Deasey <sdeasey@gmail.com> for the
323 ;; `indent-tabs-mode' usage suggestion.
325 ;; Thanks to Eric Cooper <ecc@cmu.edu> for the suggestion to have hook
326 ;; actions when buffer is written as the original whitespace package
327 ;; had.
329 ;; Thanks to nschum (EmacsWiki) for the idea about highlight "long"
330 ;; lines tail. See EightyColumnRule (EmacsWiki).
332 ;; Thanks to Juri Linkov <juri@jurta.org> for suggesting:
333 ;; * `define-minor-mode'.
334 ;; * `global-whitespace-*' name for global commands.
336 ;; Thanks to Robert J. Chassell <bob@gnu.org> for doc fix and testing.
338 ;; Thanks to Drew Adams <drew.adams@oracle.com> for toggle commands
339 ;; suggestion.
341 ;; Thanks to Antti Kaihola <antti.kaihola@linux-aktivaattori.org> for
342 ;; helping to fix `find-file-hooks' reference.
344 ;; Thanks to Andreas Roehler <andreas.roehler@easy-emacs.de> for
345 ;; indicating defface byte-compilation warnings.
347 ;; Thanks to TimOCallaghan (EmacsWiki) for the idea about highlight
348 ;; "long" lines. See EightyColumnRule (EmacsWiki).
350 ;; Thanks to Yanghui Bian <yanghuibian@gmail.com> for indicating a new
351 ;; NEWLINE character mapping.
353 ;; Thanks to Pete Forman <pete.forman@westgeo.com> for indicating
354 ;; whitespace-mode.el on XEmacs.
356 ;; Thanks to Miles Bader <miles@gnu.org> for handling display table via
357 ;; visws.el (his code was modified, but the main idea was kept).
359 ;; Thanks to:
360 ;; Rajesh Vaidheeswarran <rv@gnu.org> (original) whitespace.el
361 ;; Aurelien Tisne <aurelien.tisne@free.fr> show-whitespace-mode.el
362 ;; Lawrence Mitchell <wence@gmx.li> whitespace-mode.el
363 ;; Miles Bader <miles@gnu.org> visws.el
364 ;; And to all people who contributed with them.
367 ;; ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
369 ;;; code:
372 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
373 ;;;; User Variables:
376 ;;; Interface to the command system
379 (defgroup whitespace nil
380 "Visualize blanks (TAB, (HARD) SPACE and NEWLINE)."
381 :link '(emacs-library-link :tag "Source Lisp File" "whitespace.el")
382 :version "23.1"
383 :group 'convenience)
386 (defcustom whitespace-style
387 '(face
388 tabs spaces trailing lines space-before-tab newline
389 indentation empty space-after-tab
390 space-mark tab-mark newline-mark)
391 "Specify which kind of blank is visualized.
393 It's a list containing some or all of the following values:
395 face enable all visualization via faces (see below).
397 trailing trailing blanks are visualized via faces.
398 It has effect only if `face' (see above)
399 is present in `whitespace-style'.
401 tabs TABs are visualized via faces.
402 It has effect only if `face' (see above)
403 is present in `whitespace-style'.
405 spaces SPACEs and HARD SPACEs are visualized via
406 faces.
407 It has effect only if `face' (see above)
408 is present in `whitespace-style'.
410 lines lines which have columns beyond
411 `whitespace-line-column' are highlighted via
412 faces.
413 Whole line is highlighted.
414 It has precedence over `lines-tail' (see
415 below).
416 It has effect only if `face' (see above)
417 is present in `whitespace-style'.
419 lines-tail lines which have columns beyond
420 `whitespace-line-column' are highlighted via
421 faces.
422 But only the part of line which goes
423 beyond `whitespace-line-column' column.
424 It has effect only if `lines' (see above)
425 is not present in `whitespace-style'
426 and if `face' (see above) is present in
427 `whitespace-style'.
429 newline NEWLINEs are visualized via faces.
430 It has effect only if `face' (see above)
431 is present in `whitespace-style'.
433 empty empty lines at beginning and/or end of buffer
434 are visualized via faces.
435 It has effect only if `face' (see above)
436 is present in `whitespace-style'.
438 indentation::tab 8 or more SPACEs at beginning of line are
439 visualized via faces.
440 It has effect only if `face' (see above)
441 is present in `whitespace-style'.
443 indentation::space TABs at beginning of line are visualized via
444 faces.
445 It has effect only if `face' (see above)
446 is present in `whitespace-style'.
448 indentation 8 or more SPACEs at beginning of line are
449 visualized, if `indent-tabs-mode' (which see)
450 is non-nil; otherwise, TABs at beginning of
451 line are visualized via faces.
452 It has effect only if `face' (see above)
453 is present in `whitespace-style'.
455 space-after-tab::tab 8 or more SPACEs after a TAB are
456 visualized via faces.
457 It has effect only if `face' (see above)
458 is present in `whitespace-style'.
460 space-after-tab::space TABs are visualized when 8 or more
461 SPACEs occur after a TAB, via faces.
462 It has effect only if `face' (see above)
463 is present in `whitespace-style'.
465 space-after-tab 8 or more SPACEs after a TAB are
466 visualized, if `indent-tabs-mode'
467 (which see) is non-nil; otherwise,
468 the TABs are visualized via faces.
469 It has effect only if `face' (see above)
470 is present in `whitespace-style'.
472 space-before-tab::tab SPACEs before TAB are visualized via
473 faces.
474 It has effect only if `face' (see above)
475 is present in `whitespace-style'.
477 space-before-tab::space TABs are visualized when SPACEs occur
478 before TAB, via faces.
479 It has effect only if `face' (see above)
480 is present in `whitespace-style'.
482 space-before-tab SPACEs before TAB are visualized, if
483 `indent-tabs-mode' (which see) is
484 non-nil; otherwise, the TABs are
485 visualized via faces.
486 It has effect only if `face' (see above)
487 is present in `whitespace-style'.
489 space-mark SPACEs and HARD SPACEs are visualized via
490 display table.
492 tab-mark TABs are visualized via display table.
494 newline-mark NEWLINEs are visualized via display table.
496 Any other value is ignored.
498 If nil, don't visualize TABs, (HARD) SPACEs and NEWLINEs via faces and
499 via display table.
501 There is an evaluation order for some values, if they are
502 included in `whitespace-style' list. For example, if
503 indentation, indentation::tab and/or indentation::space are
504 included in `whitespace-style' list. The evaluation order for
505 these values is:
507 * For indentation:
508 1. indentation
509 2. indentation::tab
510 3. indentation::space
512 * For SPACEs after TABs:
513 1. space-after-tab
514 2. space-after-tab::tab
515 3. space-after-tab::space
517 * For SPACEs before TABs:
518 1. space-before-tab
519 2. space-before-tab::tab
520 3. space-before-tab::space
522 So, for example, if indentation and indentation::space are
523 included in `whitespace-style' list, the indentation value is
524 evaluated instead of indentation::space value.
526 One reason for not visualize spaces via faces (if `face' is not
527 included in `whitespace-style') is to use exclusively for
528 cleaning up a buffer. See `whitespace-cleanup' and
529 `whitespace-cleanup-region' for documentation.
531 See also `whitespace-display-mappings' for documentation."
532 :type '(repeat :tag "Kind of Blank"
533 (choice :tag "Kind of Blank Face"
534 (const :tag "(Face) Face visualization"
535 face)
536 (const :tag "(Face) Trailing TABs, SPACEs and HARD SPACEs"
537 trailing)
538 (const :tag "(Face) SPACEs and HARD SPACEs"
539 spaces)
540 (const :tag "(Face) TABs" tabs)
541 (const :tag "(Face) Lines" lines)
542 (const :tag "(Face) SPACEs before TAB"
543 space-before-tab)
544 (const :tag "(Face) NEWLINEs" newline)
545 (const :tag "(Face) Indentation SPACEs"
546 indentation)
547 (const :tag "(Face) Empty Lines At BOB And/Or EOB"
548 empty)
549 (const :tag "(Face) SPACEs after TAB"
550 space-after-tab)
551 (const :tag "(Mark) SPACEs and HARD SPACEs"
552 space-mark)
553 (const :tag "(Mark) TABs" tab-mark)
554 (const :tag "(Mark) NEWLINEs" newline-mark)))
555 :group 'whitespace)
557 (defvar whitespace-space 'whitespace-space
558 "Symbol face used to visualize SPACE.
559 Used when `whitespace-style' includes the value `spaces'.")
560 (make-obsolete-variable 'whitespace-space "use the face instead" "24.4")
563 (defface whitespace-space
564 '((((class color) (background dark))
565 :background "grey20" :foreground "darkgray")
566 (((class color) (background light))
567 :background "LightYellow" :foreground "lightgray")
568 (t :inverse-video t))
569 "Face used to visualize SPACE."
570 :group 'whitespace)
573 (defvar whitespace-hspace 'whitespace-hspace
574 "Symbol face used to visualize HARD SPACE.
575 Used when `whitespace-style' includes the value `spaces'.")
576 (make-obsolete-variable 'whitespace-hspace "use the face instead" "24.4")
578 (defface whitespace-hspace ; 'nobreak-space
579 '((((class color) (background dark))
580 :background "grey24" :foreground "darkgray")
581 (((class color) (background light))
582 :background "LemonChiffon3" :foreground "lightgray")
583 (t :inverse-video t))
584 "Face used to visualize HARD SPACE."
585 :group 'whitespace)
588 (defvar whitespace-tab 'whitespace-tab
589 "Symbol face used to visualize TAB.
590 Used when `whitespace-style' includes the value `tabs'.")
591 (make-obsolete-variable 'whitespace-tab "use the face instead" "24.4")
593 (defface whitespace-tab
594 '((((class color) (background dark))
595 :background "grey22" :foreground "darkgray")
596 (((class color) (background light))
597 :background "beige" :foreground "lightgray")
598 (t :inverse-video t))
599 "Face used to visualize TAB."
600 :group 'whitespace)
603 (defvar whitespace-newline 'whitespace-newline
604 "Symbol face used to visualize NEWLINE char mapping.
605 See `whitespace-display-mappings'.
606 Used when `whitespace-style' includes the values `newline-mark'
607 and `newline'.")
608 (make-obsolete-variable 'whitespace-newline "use the face instead" "24.4")
610 (defface whitespace-newline
611 '((default :weight normal)
612 (((class color) (background dark)) :foreground "darkgray")
613 (((class color) (min-colors 88) (background light)) :foreground "lightgray")
614 ;; Displays with 16 colors use lightgray as background, so using a
615 ;; lightgray foreground makes the newline mark invisible.
616 (((class color) (background light)) :foreground "brown")
617 (t :underline t))
618 "Face used to visualize NEWLINE char mapping.
620 See `whitespace-display-mappings'."
621 :group 'whitespace)
624 (defvar whitespace-trailing 'whitespace-trailing
625 "Symbol face used to visualize trailing blanks.
626 Used when `whitespace-style' includes the value `trailing'.")
627 (make-obsolete-variable 'whitespace-trailing "use the face instead" "24.4")
629 (defface whitespace-trailing ; 'trailing-whitespace
630 '((default :weight bold)
631 (((class mono)) :inverse-video t :underline t)
632 (t :background "red1" :foreground "yellow"))
633 "Face used to visualize trailing blanks."
634 :group 'whitespace)
637 (defvar whitespace-line 'whitespace-line
638 "Symbol face used to visualize \"long\" lines.
639 See `whitespace-line-column'.
640 Used when `whitespace-style' includes the value `line'.")
641 (make-obsolete-variable 'whitespace-line "use the face instead" "24.4")
643 (defface whitespace-line
644 '((((class mono)) :inverse-video t :weight bold :underline t)
645 (t :background "gray20" :foreground "violet"))
646 "Face used to visualize \"long\" lines.
648 See `whitespace-line-column'."
649 :group 'whitespace)
652 (defvar whitespace-space-before-tab 'whitespace-space-before-tab
653 "Symbol face used to visualize SPACEs before TAB.
654 Used when `whitespace-style' includes the value `space-before-tab'.")
655 (make-obsolete-variable 'whitespace-space-before-tab
656 "use the face instead" "24.4")
658 (defface whitespace-space-before-tab
659 '((((class mono)) :inverse-video t :weight bold :underline t)
660 (t :background "DarkOrange" :foreground "firebrick"))
661 "Face used to visualize SPACEs before TAB."
662 :group 'whitespace)
665 (defvar whitespace-indentation 'whitespace-indentation
666 "Symbol face used to visualize 8 or more SPACEs at beginning of line.
667 Used when `whitespace-style' includes the value `indentation'.")
668 (make-obsolete-variable 'whitespace-indentation "use the face instead" "24.4")
670 (defface whitespace-indentation
671 '((((class mono)) :inverse-video t :weight bold :underline t)
672 (t :background "yellow" :foreground "firebrick"))
673 "Face used to visualize 8 or more SPACEs at beginning of line."
674 :group 'whitespace)
677 (defvar whitespace-empty 'whitespace-empty
678 "Symbol face used to visualize empty lines at beginning and/or end of buffer.
679 Used when `whitespace-style' includes the value `empty'.")
680 (make-obsolete-variable 'whitespace-empty "use the face instead" "24.4")
682 (defface whitespace-empty
683 '((((class mono)) :inverse-video t :weight bold :underline t)
684 (t :background "yellow" :foreground "firebrick"))
685 "Face used to visualize empty lines at beginning and/or end of buffer."
686 :group 'whitespace)
689 (defvar whitespace-space-after-tab 'whitespace-space-after-tab
690 "Symbol face used to visualize 8 or more SPACEs after TAB.
691 Used when `whitespace-style' includes the value `space-after-tab'.")
692 (make-obsolete-variable 'whitespace-space-after-tab
693 "use the face instead" "24.4")
695 (defface whitespace-space-after-tab
696 '((((class mono)) :inverse-video t :weight bold :underline t)
697 (t :background "yellow" :foreground "firebrick"))
698 "Face used to visualize 8 or more SPACEs after TAB."
699 :group 'whitespace)
702 (defcustom whitespace-hspace-regexp
703 "\\(\u00A0+\\)"
704 "Specify HARD SPACE characters regexp.
706 Here are some examples:
708 \"\\\\(^\\xA0+\\\\)\" \
709 visualize only leading HARD SPACEs.
710 \"\\\\(\\xA0+$\\\\)\" \
711 visualize only trailing HARD SPACEs.
712 \"\\\\(^\\xA0+\\\\|\\xA0+$\\\\)\" \
713 visualize leading and/or trailing HARD SPACEs.
714 \"\\t\\\\(\\xA0+\\\\)\\t\" \
715 visualize only HARD SPACEs between TABs.
717 NOTE: Enclose always by \\\\( and \\\\) the elements to highlight.
718 Use exactly one pair of enclosing \\\\( and \\\\).
720 Used when `whitespace-style' includes `spaces'."
721 :type '(regexp :tag "HARD SPACE Chars")
722 :group 'whitespace)
725 (defcustom whitespace-space-regexp "\\( +\\)"
726 "Specify SPACE characters regexp.
728 If you're using `mule' package, there may be other characters
729 besides \" \" that should be considered SPACE.
731 Here are some examples:
733 \"\\\\(^ +\\\\)\" visualize only leading SPACEs.
734 \"\\\\( +$\\\\)\" visualize only trailing SPACEs.
735 \"\\\\(^ +\\\\| +$\\\\)\" \
736 visualize leading and/or trailing SPACEs.
737 \"\\t\\\\( +\\\\)\\t\" visualize only SPACEs between TABs.
739 NOTE: Enclose always by \\\\( and \\\\) the elements to highlight.
740 Use exactly one pair of enclosing \\\\( and \\\\).
742 Used when `whitespace-style' includes `spaces'."
743 :type '(regexp :tag "SPACE Chars")
744 :group 'whitespace)
747 (defcustom whitespace-tab-regexp "\\(\t+\\)"
748 "Specify TAB characters regexp.
750 If you're using `mule' package, there may be other characters
751 besides \"\\t\" that should be considered TAB.
753 Here are some examples:
755 \"\\\\(^\\t+\\\\)\" visualize only leading TABs.
756 \"\\\\(\\t+$\\\\)\" visualize only trailing TABs.
757 \"\\\\(^\\t+\\\\|\\t+$\\\\)\" \
758 visualize leading and/or trailing TABs.
759 \" \\\\(\\t+\\\\) \" visualize only TABs between SPACEs.
761 NOTE: Enclose always by \\\\( and \\\\) the elements to highlight.
762 Use exactly one pair of enclosing \\\\( and \\\\).
764 Used when `whitespace-style' includes `tabs'."
765 :type '(regexp :tag "TAB Chars")
766 :group 'whitespace)
769 (defcustom whitespace-trailing-regexp
770 "\\([\t \u00A0]+\\)$"
771 "Specify trailing characters regexp.
773 There may be other characters besides:
775 \" \" \"\\t\" \"\\u00A0\"
777 that should be considered blank.
779 NOTE: Enclose always by \"\\\\(\" and \"\\\\)$\" the elements to highlight.
780 Use exactly one pair of enclosing elements above.
782 Used when `whitespace-style' includes `trailing'."
783 :type '(regexp :tag "Trailing Chars")
784 :group 'whitespace)
787 (defcustom whitespace-space-before-tab-regexp "\\( +\\)\\(\t+\\)"
788 "Specify SPACEs before TAB regexp.
790 Used when `whitespace-style' includes `space-before-tab',
791 `space-before-tab::tab' or `space-before-tab::space'."
792 :type '(regexp :tag "SPACEs Before TAB")
793 :group 'whitespace)
796 (defcustom whitespace-indentation-regexp
797 '("^\t*\\(\\( \\{%d\\}\\)+\\)[^\n\t]"
798 . "^ *\\(\t+\\)[^\n]")
799 "Specify regexp for 8 or more SPACEs at beginning of line.
801 It is a cons where the cons car is used for SPACEs visualization
802 and the cons cdr is used for TABs visualization.
804 Used when `whitespace-style' includes `indentation',
805 `indentation::tab' or `indentation::space'."
806 :type '(cons (string :tag "Indentation SPACEs")
807 (string :tag "Indentation TABs"))
808 :group 'whitespace)
811 (defcustom whitespace-empty-at-bob-regexp "^\\(\\([ \t]*\n\\)+\\)"
812 "Specify regexp for empty lines at beginning of buffer.
814 Used when `whitespace-style' includes `empty'."
815 :type '(regexp :tag "Empty Lines At Beginning Of Buffer")
816 :group 'whitespace)
819 (defcustom whitespace-empty-at-eob-regexp "^\\([ \t\n]+\\)"
820 "Specify regexp for empty lines at end of buffer.
822 Used when `whitespace-style' includes `empty'."
823 :type '(regexp :tag "Empty Lines At End Of Buffer")
824 :group 'whitespace)
827 (defcustom whitespace-space-after-tab-regexp
828 '("\t+\\(\\( \\{%d\\}\\)+\\)"
829 . "\\(\t+\\) +")
830 "Specify regexp for 8 or more SPACEs after TAB.
832 It is a cons where the cons car is used for SPACEs visualization
833 and the cons cdr is used for TABs visualization.
835 Used when `whitespace-style' includes `space-after-tab',
836 `space-after-tab::tab' or `space-after-tab::space'."
837 :type '(cons (string :tag "SPACEs After TAB")
838 string)
839 :group 'whitespace)
842 (defcustom whitespace-line-column 80
843 "Specify column beyond which the line is highlighted.
845 It must be an integer or nil. If nil, the `fill-column' variable value is
846 used.
848 Used when `whitespace-style' includes `lines' or `lines-tail'."
849 :type '(choice :tag "Line Length Limit"
850 (integer :tag "Line Length")
851 (const :tag "Use fill-column" nil))
852 :group 'whitespace)
855 ;; Hacked from `visible-whitespace-mappings' in visws.el
856 (defcustom whitespace-display-mappings
858 (space-mark ?\ [?\u00B7] [?.]) ; space - centered dot
859 (space-mark ?\xA0 [?\u00A4] [?_]) ; hard space - currency
860 ;; NEWLINE is displayed using the face `whitespace-newline'
861 (newline-mark ?\n [?$ ?\n]) ; eol - dollar sign
862 ;; (newline-mark ?\n [?\u21B5 ?\n] [?$ ?\n]) ; eol - downwards arrow
863 ;; (newline-mark ?\n [?\u00B6 ?\n] [?$ ?\n]) ; eol - pilcrow
864 ;; (newline-mark ?\n [?\u00AF ?\n] [?$ ?\n]) ; eol - overscore
865 ;; (newline-mark ?\n [?\u00AC ?\n] [?$ ?\n]) ; eol - negation
866 ;; (newline-mark ?\n [?\u00B0 ?\n] [?$ ?\n]) ; eol - degrees
868 ;; WARNING: the mapping below has a problem.
869 ;; When a TAB occupies exactly one column, it will display the
870 ;; character ?\xBB at that column followed by a TAB which goes to
871 ;; the next TAB column.
872 ;; If this is a problem for you, please, comment the line below.
873 (tab-mark ?\t [?\u00BB ?\t] [?\\ ?\t]) ; tab - left quote mark
875 "Specify an alist of mappings for displaying characters.
877 Each element has the following form:
879 (KIND CHAR VECTOR...)
881 Where:
883 KIND is the kind of character.
884 It can be one of the following symbols:
886 tab-mark for TAB character
888 space-mark for SPACE or HARD SPACE character
890 newline-mark for NEWLINE character
892 CHAR is the character to be mapped.
894 VECTOR is a vector of characters to be displayed in place of CHAR.
895 The first display vector that can be displayed is used;
896 if no display vector for a mapping can be displayed, then
897 that character is displayed unmodified.
899 The NEWLINE character is displayed using the face given by
900 `whitespace-newline' variable.
902 Used when `whitespace-style' includes `tab-mark', `space-mark' or
903 `newline-mark'."
904 :type '(repeat
905 (list :tag "Character Mapping"
906 (choice :tag "Char Kind"
907 (const :tag "Tab" tab-mark)
908 (const :tag "Space" space-mark)
909 (const :tag "Newline" newline-mark))
910 (character :tag "Char")
911 (repeat :inline t :tag "Vector List"
912 (vector :tag ""
913 (repeat :inline t
914 :tag "Vector Characters"
915 (character :tag "Char"))))))
916 :group 'whitespace)
919 (defcustom whitespace-global-modes t
920 "Modes for which global `whitespace-mode' is automagically turned on.
922 Global `whitespace-mode' is controlled by the command
923 `global-whitespace-mode'.
925 If nil, means no modes have `whitespace-mode' automatically
926 turned on.
928 If t, all modes that support `whitespace-mode' have it
929 automatically turned on.
931 Else it should be a list of `major-mode' symbol names for which
932 `whitespace-mode' should be automatically turned on. The sense
933 of the list is negated if it begins with `not'. For example:
935 (c-mode c++-mode)
937 means that `whitespace-mode' is turned on for buffers in C and
938 C++ modes only."
939 :type '(choice :tag "Global Modes"
940 (const :tag "None" nil)
941 (const :tag "All" t)
942 (set :menu-tag "Mode Specific" :tag "Modes"
943 :value (not)
944 (const :tag "Except" not)
945 (repeat :inline t
946 (symbol :tag "Mode"))))
947 :group 'whitespace)
950 (defcustom whitespace-action nil
951 "Specify which action is taken when a buffer is visited or written.
953 It's a list containing some or all of the following values:
955 nil no action is taken.
957 cleanup cleanup any bogus whitespace always when local
958 whitespace is turned on.
959 See `whitespace-cleanup' and
960 `whitespace-cleanup-region'.
962 report-on-bogus report if there is any bogus whitespace always
963 when local whitespace is turned on.
965 auto-cleanup cleanup any bogus whitespace when buffer is
966 written.
967 See `whitespace-cleanup' and
968 `whitespace-cleanup-region'.
970 abort-on-bogus abort if there is any bogus whitespace and the
971 buffer is written.
973 warn-if-read-only give a warning if `cleanup' or `auto-cleanup'
974 is included in `whitespace-action' and the
975 buffer is read-only.
977 Any other value is treated as nil."
978 :type '(choice :tag "Actions"
979 (const :tag "None" nil)
980 (repeat :tag "Action List"
981 (choice :tag "Action"
982 (const :tag "Cleanup When On" cleanup)
983 (const :tag "Report On Bogus" report-on-bogus)
984 (const :tag "Auto Cleanup" auto-cleanup)
985 (const :tag "Abort On Bogus" abort-on-bogus)
986 (const :tag "Warn If Read-Only" warn-if-read-only))))
987 :group 'whitespace)
990 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
991 ;;;; User commands - Local mode
994 ;;;###autoload
995 (define-minor-mode whitespace-mode
996 "Toggle whitespace visualization (Whitespace mode).
997 With a prefix argument ARG, enable Whitespace mode if ARG is
998 positive, and disable it otherwise. If called from Lisp, enable
999 the mode if ARG is omitted or nil.
1001 See also `whitespace-style', `whitespace-newline' and
1002 `whitespace-display-mappings'."
1003 :lighter " ws"
1004 :init-value nil
1005 :global nil
1006 :group 'whitespace
1007 (cond
1008 (noninteractive ; running a batch job
1009 (setq whitespace-mode nil))
1010 (whitespace-mode ; whitespace-mode on
1011 (whitespace-turn-on)
1012 (whitespace-action-when-on))
1013 (t ; whitespace-mode off
1014 (whitespace-turn-off))))
1017 ;;;###autoload
1018 (define-minor-mode whitespace-newline-mode
1019 "Toggle newline visualization (Whitespace Newline mode).
1020 With a prefix argument ARG, enable Whitespace Newline mode if ARG
1021 is positive, and disable it otherwise. If called from Lisp,
1022 enable the mode if ARG is omitted or nil.
1024 Use `whitespace-newline-mode' only for NEWLINE visualization
1025 exclusively. For other visualizations, including NEWLINE
1026 visualization together with (HARD) SPACEs and/or TABs, please,
1027 use `whitespace-mode'.
1029 See also `whitespace-newline' and `whitespace-display-mappings'."
1030 :lighter " nl"
1031 :init-value nil
1032 :global nil
1033 :group 'whitespace
1034 (let ((whitespace-style '(face newline-mark newline)))
1035 (whitespace-mode (if whitespace-newline-mode
1036 1 -1)))
1037 ;; sync states (running a batch job)
1038 (setq whitespace-newline-mode whitespace-mode))
1041 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1042 ;;;; User commands - Global mode
1045 ;;;###autoload
1046 (define-minor-mode global-whitespace-mode
1047 "Toggle whitespace visualization globally (Global Whitespace mode).
1048 With a prefix argument ARG, enable Global Whitespace mode if ARG
1049 is positive, and disable it otherwise. If called from Lisp,
1050 enable it if ARG is omitted or nil.
1052 See also `whitespace-style', `whitespace-newline' and
1053 `whitespace-display-mappings'."
1054 :lighter " WS"
1055 :init-value nil
1056 :global t
1057 :group 'whitespace
1058 (cond
1059 (noninteractive ; running a batch job
1060 (setq global-whitespace-mode nil))
1061 (global-whitespace-mode ; global-whitespace-mode on
1062 (save-current-buffer
1063 (add-hook 'find-file-hook 'whitespace-turn-on-if-enabled)
1064 (add-hook 'after-change-major-mode-hook 'whitespace-turn-on-if-enabled)
1065 (dolist (buffer (buffer-list)) ; adjust all local mode
1066 (set-buffer buffer)
1067 (unless whitespace-mode
1068 (whitespace-turn-on-if-enabled)))))
1069 (t ; global-whitespace-mode off
1070 (save-current-buffer
1071 (remove-hook 'find-file-hook 'whitespace-turn-on-if-enabled)
1072 (remove-hook 'after-change-major-mode-hook 'whitespace-turn-on-if-enabled)
1073 (dolist (buffer (buffer-list)) ; adjust all local mode
1074 (set-buffer buffer)
1075 (unless whitespace-mode
1076 (whitespace-turn-off)))))))
1078 (defvar whitespace-enable-predicate
1079 (lambda ()
1080 (and (cond
1081 ((eq whitespace-global-modes t))
1082 ((listp whitespace-global-modes)
1083 (if (eq (car-safe whitespace-global-modes) 'not)
1084 (not (memq major-mode (cdr whitespace-global-modes)))
1085 (memq major-mode whitespace-global-modes)))
1086 (t nil))
1087 ;; ...we have a display (we're running a batch job)
1088 (not noninteractive)
1089 ;; ...the buffer is not internal (name starts with a space)
1090 (not (eq (aref (buffer-name) 0) ?\ ))
1091 ;; ...the buffer is not special (name starts with *)
1092 (or (not (eq (aref (buffer-name) 0) ?*))
1093 ;; except the scratch buffer.
1094 (string= (buffer-name) "*scratch*"))))
1095 "Predicate to decide which buffers obey `global-whitespace-mode'.
1096 This function is called with no argument and should return non-nil
1097 if the current buffer should obey `global-whitespace-mode'.
1098 This variable is normally modified via `add-function'.")
1100 (defun whitespace-turn-on-if-enabled ()
1101 (when (funcall whitespace-enable-predicate)
1102 (whitespace-turn-on)))
1104 ;;;###autoload
1105 (define-minor-mode global-whitespace-newline-mode
1106 "Toggle global newline visualization (Global Whitespace Newline mode).
1107 With a prefix argument ARG, enable Global Whitespace Newline mode
1108 if ARG is positive, and disable it otherwise. If called from
1109 Lisp, enable it if ARG is omitted or nil.
1111 Use `global-whitespace-newline-mode' only for NEWLINE
1112 visualization exclusively. For other visualizations, including
1113 NEWLINE visualization together with (HARD) SPACEs and/or TABs,
1114 please use `global-whitespace-mode'.
1116 See also `whitespace-newline' and `whitespace-display-mappings'."
1117 :lighter " NL"
1118 :init-value nil
1119 :global t
1120 :group 'whitespace
1121 (let ((whitespace-style '(newline-mark newline)))
1122 (global-whitespace-mode (if global-whitespace-newline-mode
1123 1 -1))
1124 ;; sync states (running a batch job)
1125 (setq global-whitespace-newline-mode global-whitespace-mode)))
1128 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1129 ;;;; User commands - Toggle
1132 (defconst whitespace-style-value-list
1133 '(face
1134 tabs
1135 spaces
1136 trailing
1137 lines
1138 lines-tail
1139 newline
1140 empty
1141 indentation
1142 indentation::tab
1143 indentation::space
1144 space-after-tab
1145 space-after-tab::tab
1146 space-after-tab::space
1147 space-before-tab
1148 space-before-tab::tab
1149 space-before-tab::space
1150 help-newline ; value used by `whitespace-insert-option-mark'
1151 tab-mark
1152 space-mark
1153 newline-mark
1155 "List of valid `whitespace-style' values.")
1158 (defconst whitespace-toggle-option-alist
1159 '((?f . face)
1160 (?t . tabs)
1161 (?s . spaces)
1162 (?r . trailing)
1163 (?l . lines)
1164 (?L . lines-tail)
1165 (?n . newline)
1166 (?e . empty)
1167 (?\C-i . indentation)
1168 (?I . indentation::tab)
1169 (?i . indentation::space)
1170 (?\C-a . space-after-tab)
1171 (?A . space-after-tab::tab)
1172 (?a . space-after-tab::space)
1173 (?\C-b . space-before-tab)
1174 (?B . space-before-tab::tab)
1175 (?b . space-before-tab::space)
1176 (?T . tab-mark)
1177 (?S . space-mark)
1178 (?N . newline-mark)
1179 (?x . whitespace-style)
1181 "Alist of toggle options.
1183 Each element has the form:
1185 (CHAR . SYMBOL)
1187 Where:
1189 CHAR is a char which the user will have to type.
1191 SYMBOL is a valid symbol associated with CHAR.
1192 See `whitespace-style-value-list'.")
1195 (defvar whitespace-active-style nil
1196 "Used to save locally `whitespace-style' value.")
1198 (defvar whitespace-indent-tabs-mode indent-tabs-mode
1199 "Used to save locally `indent-tabs-mode' value.")
1201 (defvar whitespace-tab-width tab-width
1202 "Used to save locally `tab-width' value.")
1204 (defvar whitespace-point (point)
1205 "Used to save locally current point value.
1206 Used by function `whitespace-trailing-regexp' (which see).")
1208 (defvar whitespace-font-lock-refontify nil
1209 "Used to save locally the font-lock refontify state.
1210 Used by function `whitespace-post-command-hook' (which see).")
1212 (defvar whitespace-bob-marker nil
1213 "Used to save locally the bob marker value.
1214 Used by function `whitespace-post-command-hook' (which see).")
1216 (defvar whitespace-eob-marker nil
1217 "Used to save locally the eob marker value.
1218 Used by function `whitespace-post-command-hook' (which see).")
1220 (defvar whitespace-buffer-changed nil
1221 "Used to indicate locally if buffer changed.
1222 Used by `whitespace-post-command-hook' and `whitespace-buffer-changed'
1223 functions (which see).")
1226 ;;;###autoload
1227 (defun whitespace-toggle-options (arg)
1228 "Toggle local `whitespace-mode' options.
1230 If local whitespace-mode is off, toggle the option given by ARG
1231 and turn on local whitespace-mode.
1233 If local whitespace-mode is on, toggle the option given by ARG
1234 and restart local whitespace-mode.
1236 Interactively, it reads one of the following chars:
1238 CHAR MEANING
1239 (VIA FACES)
1240 f toggle face visualization
1241 t toggle TAB visualization
1242 s toggle SPACE and HARD SPACE visualization
1243 r toggle trailing blanks visualization
1244 l toggle \"long lines\" visualization
1245 L toggle \"long lines\" tail visualization
1246 n toggle NEWLINE visualization
1247 e toggle empty line at bob and/or eob visualization
1248 C-i toggle indentation SPACEs visualization (via `indent-tabs-mode')
1249 I toggle indentation SPACEs visualization
1250 i toggle indentation TABs visualization
1251 C-a toggle SPACEs after TAB visualization (via `indent-tabs-mode')
1252 A toggle SPACEs after TAB: SPACEs visualization
1253 a toggle SPACEs after TAB: TABs visualization
1254 C-b toggle SPACEs before TAB visualization (via `indent-tabs-mode')
1255 B toggle SPACEs before TAB: SPACEs visualization
1256 b toggle SPACEs before TAB: TABs visualization
1258 (VIA DISPLAY TABLE)
1259 T toggle TAB visualization
1260 S toggle SPACEs before TAB visualization
1261 N toggle NEWLINE visualization
1263 x restore `whitespace-style' value
1264 ? display brief help
1266 Non-interactively, ARG should be a symbol or a list of symbols.
1267 The valid symbols are:
1269 face toggle face visualization
1270 tabs toggle TAB visualization
1271 spaces toggle SPACE and HARD SPACE visualization
1272 trailing toggle trailing blanks visualization
1273 lines toggle \"long lines\" visualization
1274 lines-tail toggle \"long lines\" tail visualization
1275 newline toggle NEWLINE visualization
1276 empty toggle empty line at bob and/or eob visualization
1277 indentation toggle indentation SPACEs visualization
1278 indentation::tab toggle indentation SPACEs visualization
1279 indentation::space toggle indentation TABs visualization
1280 space-after-tab toggle SPACEs after TAB visualization
1281 space-after-tab::tab toggle SPACEs after TAB: SPACEs visualization
1282 space-after-tab::space toggle SPACEs after TAB: TABs visualization
1283 space-before-tab toggle SPACEs before TAB visualization
1284 space-before-tab::tab toggle SPACEs before TAB: SPACEs visualization
1285 space-before-tab::space toggle SPACEs before TAB: TABs visualization
1287 tab-mark toggle TAB visualization
1288 space-mark toggle SPACEs before TAB visualization
1289 newline-mark toggle NEWLINE visualization
1291 whitespace-style restore `whitespace-style' value
1293 See `whitespace-style' and `indent-tabs-mode' for documentation."
1294 (interactive (whitespace-interactive-char t))
1295 (let ((whitespace-style
1296 (whitespace-toggle-list t arg whitespace-active-style)))
1297 (whitespace-mode 0)
1298 (whitespace-mode 1)))
1301 (defvar whitespace-toggle-style nil
1302 "Used to toggle the global `whitespace-style' value.")
1305 ;;;###autoload
1306 (defun global-whitespace-toggle-options (arg)
1307 "Toggle global `whitespace-mode' options.
1309 If global whitespace-mode is off, toggle the option given by ARG
1310 and turn on global whitespace-mode.
1312 If global whitespace-mode is on, toggle the option given by ARG
1313 and restart global whitespace-mode.
1315 Interactively, it accepts one of the following chars:
1317 CHAR MEANING
1318 (VIA FACES)
1319 f toggle face visualization
1320 t toggle TAB visualization
1321 s toggle SPACE and HARD SPACE visualization
1322 r toggle trailing blanks visualization
1323 l toggle \"long lines\" visualization
1324 L toggle \"long lines\" tail visualization
1325 n toggle NEWLINE visualization
1326 e toggle empty line at bob and/or eob visualization
1327 C-i toggle indentation SPACEs visualization (via `indent-tabs-mode')
1328 I toggle indentation SPACEs visualization
1329 i toggle indentation TABs visualization
1330 C-a toggle SPACEs after TAB visualization (via `indent-tabs-mode')
1331 A toggle SPACEs after TAB: SPACEs visualization
1332 a toggle SPACEs after TAB: TABs visualization
1333 C-b toggle SPACEs before TAB visualization (via `indent-tabs-mode')
1334 B toggle SPACEs before TAB: SPACEs visualization
1335 b toggle SPACEs before TAB: TABs visualization
1337 (VIA DISPLAY TABLE)
1338 T toggle TAB visualization
1339 S toggle SPACEs before TAB visualization
1340 N toggle NEWLINE visualization
1342 x restore `whitespace-style' value
1343 ? display brief help
1345 Non-interactively, ARG should be a symbol or a list of symbols.
1346 The valid symbols are:
1348 face toggle face visualization
1349 tabs toggle TAB visualization
1350 spaces toggle SPACE and HARD SPACE visualization
1351 trailing toggle trailing blanks visualization
1352 lines toggle \"long lines\" visualization
1353 lines-tail toggle \"long lines\" tail visualization
1354 newline toggle NEWLINE visualization
1355 empty toggle empty line at bob and/or eob visualization
1356 indentation toggle indentation SPACEs visualization
1357 indentation::tab toggle indentation SPACEs visualization
1358 indentation::space toggle indentation TABs visualization
1359 space-after-tab toggle SPACEs after TAB visualization
1360 space-after-tab::tab toggle SPACEs after TAB: SPACEs visualization
1361 space-after-tab::space toggle SPACEs after TAB: TABs visualization
1362 space-before-tab toggle SPACEs before TAB visualization
1363 space-before-tab::tab toggle SPACEs before TAB: SPACEs visualization
1364 space-before-tab::space toggle SPACEs before TAB: TABs visualization
1366 tab-mark toggle TAB visualization
1367 space-mark toggle SPACEs before TAB visualization
1368 newline-mark toggle NEWLINE visualization
1370 whitespace-style restore `whitespace-style' value
1372 See `whitespace-style' and `indent-tabs-mode' for documentation."
1373 (interactive (whitespace-interactive-char nil))
1374 (let ((whitespace-style
1375 (whitespace-toggle-list nil arg whitespace-toggle-style)))
1376 (setq whitespace-toggle-style whitespace-style)
1377 (global-whitespace-mode 0)
1378 (global-whitespace-mode 1)))
1381 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1382 ;;;; User commands - Cleanup
1385 ;;;###autoload
1386 (defun whitespace-cleanup ()
1387 "Cleanup some blank problems in all buffer or at region.
1389 It usually applies to the whole buffer, but in transient mark
1390 mode when the mark is active, it applies to the region. It also
1391 applies to the region when it is not in transient mark mode, the
1392 mark is active and \\[universal-argument] was pressed just before
1393 calling `whitespace-cleanup' interactively.
1395 See also `whitespace-cleanup-region'.
1397 The problems cleaned up are:
1399 1. empty lines at beginning of buffer.
1400 2. empty lines at end of buffer.
1401 If `whitespace-style' includes the value `empty', remove all
1402 empty lines at beginning and/or end of buffer.
1404 3. 8 or more SPACEs at beginning of line.
1405 If `whitespace-style' includes the value `indentation':
1406 replace 8 or more SPACEs at beginning of line by TABs, if
1407 `indent-tabs-mode' is non-nil; otherwise, replace TABs by
1408 SPACEs.
1409 If `whitespace-style' includes the value `indentation::tab',
1410 replace 8 or more SPACEs at beginning of line by TABs.
1411 If `whitespace-style' includes the value `indentation::space',
1412 replace TABs by SPACEs.
1414 4. SPACEs before TAB.
1415 If `whitespace-style' includes the value `space-before-tab':
1416 replace SPACEs by TABs, if `indent-tabs-mode' is non-nil;
1417 otherwise, replace TABs by SPACEs.
1418 If `whitespace-style' includes the value
1419 `space-before-tab::tab', replace SPACEs by TABs.
1420 If `whitespace-style' includes the value
1421 `space-before-tab::space', replace TABs by SPACEs.
1423 5. SPACEs or TABs at end of line.
1424 If `whitespace-style' includes the value `trailing', remove
1425 all SPACEs or TABs at end of line.
1427 6. 8 or more SPACEs after TAB.
1428 If `whitespace-style' includes the value `space-after-tab':
1429 replace SPACEs by TABs, if `indent-tabs-mode' is non-nil;
1430 otherwise, replace TABs by SPACEs.
1431 If `whitespace-style' includes the value
1432 `space-after-tab::tab', replace SPACEs by TABs.
1433 If `whitespace-style' includes the value
1434 `space-after-tab::space', replace TABs by SPACEs.
1436 See `whitespace-style', `indent-tabs-mode' and `tab-width' for
1437 documentation."
1438 (interactive "@")
1439 (cond
1440 ;; read-only buffer
1441 (buffer-read-only
1442 (whitespace-warn-read-only "cleanup"))
1443 ;; region active
1444 ((and (or transient-mark-mode
1445 current-prefix-arg)
1446 mark-active)
1447 ;; PROBLEMs 1 and 2 are not handled in region
1448 ;; PROBLEM 3: 8 or more SPACEs at bol
1449 ;; PROBLEM 4: SPACEs before TAB
1450 ;; PROBLEM 5: SPACEs or TABs at eol
1451 ;; PROBLEM 6: 8 or more SPACEs after TAB
1452 (whitespace-cleanup-region (region-beginning) (region-end)))
1453 ;; whole buffer
1455 (save-excursion
1456 (save-match-data ;FIXME: Why?
1457 ;; PROBLEM 1: empty lines at bob
1458 ;; PROBLEM 2: empty lines at eob
1459 ;; ACTION: remove all empty lines at bob and/or eob
1460 (when (memq 'empty whitespace-style)
1461 (let (overwrite-mode) ; enforce no overwrite
1462 (goto-char (point-min))
1463 (when (looking-at whitespace-empty-at-bob-regexp)
1464 (delete-region (match-beginning 1) (match-end 1)))
1465 (when (re-search-forward
1466 (concat whitespace-empty-at-eob-regexp "\\'") nil t)
1467 (delete-region (match-beginning 1) (match-end 1)))))))
1468 ;; PROBLEM 3: 8 or more SPACEs at bol
1469 ;; PROBLEM 4: SPACEs before TAB
1470 ;; PROBLEM 5: SPACEs or TABs at eol
1471 ;; PROBLEM 6: 8 or more SPACEs after TAB
1472 (whitespace-cleanup-region (point-min) (point-max)))))
1475 ;;;###autoload
1476 (defun whitespace-cleanup-region (start end)
1477 "Cleanup some blank problems at region.
1479 The problems cleaned up are:
1481 1. 8 or more SPACEs at beginning of line.
1482 If `whitespace-style' includes the value `indentation':
1483 replace 8 or more SPACEs at beginning of line by TABs, if
1484 `indent-tabs-mode' is non-nil; otherwise, replace TABs by
1485 SPACEs.
1486 If `whitespace-style' includes the value `indentation::tab',
1487 replace 8 or more SPACEs at beginning of line by TABs.
1488 If `whitespace-style' includes the value `indentation::space',
1489 replace TABs by SPACEs.
1491 2. SPACEs before TAB.
1492 If `whitespace-style' includes the value `space-before-tab':
1493 replace SPACEs by TABs, if `indent-tabs-mode' is non-nil;
1494 otherwise, replace TABs by SPACEs.
1495 If `whitespace-style' includes the value
1496 `space-before-tab::tab', replace SPACEs by TABs.
1497 If `whitespace-style' includes the value
1498 `space-before-tab::space', replace TABs by SPACEs.
1500 3. SPACEs or TABs at end of line.
1501 If `whitespace-style' includes the value `trailing', remove
1502 all SPACEs or TABs at end of line.
1504 4. 8 or more SPACEs after TAB.
1505 If `whitespace-style' includes the value `space-after-tab':
1506 replace SPACEs by TABs, if `indent-tabs-mode' is non-nil;
1507 otherwise, replace TABs by SPACEs.
1508 If `whitespace-style' includes the value
1509 `space-after-tab::tab', replace SPACEs by TABs.
1510 If `whitespace-style' includes the value
1511 `space-after-tab::space', replace TABs by SPACEs.
1513 See `whitespace-style', `indent-tabs-mode' and `tab-width' for
1514 documentation."
1515 (interactive "@r")
1516 (if buffer-read-only
1517 ;; read-only buffer
1518 (whitespace-warn-read-only "cleanup region")
1519 ;; non-read-only buffer
1520 (let ((rstart (min start end))
1521 (rend (copy-marker (max start end)))
1522 (indent-tabs-mode whitespace-indent-tabs-mode)
1523 (tab-width whitespace-tab-width)
1524 overwrite-mode ; enforce no overwrite
1525 tmp)
1526 (save-excursion
1527 (save-match-data ;FIXME: Why?
1528 ;; PROBLEM 1: 8 or more SPACEs at bol
1529 (cond
1530 ;; ACTION: replace 8 or more SPACEs at bol by TABs, if
1531 ;; `indent-tabs-mode' is non-nil; otherwise, replace TABs
1532 ;; by SPACEs.
1533 ((memq 'indentation whitespace-style)
1534 (let ((regexp (whitespace-indentation-regexp)))
1535 (goto-char rstart)
1536 (while (re-search-forward regexp rend t)
1537 (setq tmp (current-indentation))
1538 (goto-char (match-beginning 0))
1539 (delete-horizontal-space)
1540 (unless (eolp)
1541 (indent-to tmp)))))
1542 ;; ACTION: replace 8 or more SPACEs at bol by TABs.
1543 ((memq 'indentation::tab whitespace-style)
1544 (whitespace-replace-action
1545 'tabify rstart rend
1546 (whitespace-indentation-regexp 'tab) 0))
1547 ;; ACTION: replace TABs by SPACEs.
1548 ((memq 'indentation::space whitespace-style)
1549 (whitespace-replace-action
1550 'untabify rstart rend
1551 (whitespace-indentation-regexp 'space) 0)))
1552 ;; PROBLEM 3: SPACEs or TABs at eol
1553 ;; ACTION: remove all SPACEs or TABs at eol
1554 (when (memq 'trailing whitespace-style)
1555 (whitespace-replace-action
1556 'delete-region rstart rend
1557 whitespace-trailing-regexp 1))
1558 ;; PROBLEM 4: 8 or more SPACEs after TAB
1559 (cond
1560 ;; ACTION: replace 8 or more SPACEs by TABs, if
1561 ;; `indent-tabs-mode' is non-nil; otherwise, replace TABs
1562 ;; by SPACEs.
1563 ((memq 'space-after-tab whitespace-style)
1564 (whitespace-replace-action
1565 (if whitespace-indent-tabs-mode 'tabify 'untabify)
1566 rstart rend (whitespace-space-after-tab-regexp) 1))
1567 ;; ACTION: replace 8 or more SPACEs by TABs.
1568 ((memq 'space-after-tab::tab whitespace-style)
1569 (whitespace-replace-action
1570 'tabify rstart rend
1571 (whitespace-space-after-tab-regexp 'tab) 1))
1572 ;; ACTION: replace TABs by SPACEs.
1573 ((memq 'space-after-tab::space whitespace-style)
1574 (whitespace-replace-action
1575 'untabify rstart rend
1576 (whitespace-space-after-tab-regexp 'space) 1)))
1577 ;; PROBLEM 2: SPACEs before TAB
1578 (cond
1579 ;; ACTION: replace SPACEs before TAB by TABs, if
1580 ;; `indent-tabs-mode' is non-nil; otherwise, replace TABs
1581 ;; by SPACEs.
1582 ((memq 'space-before-tab whitespace-style)
1583 (whitespace-replace-action
1584 (if whitespace-indent-tabs-mode 'tabify 'untabify)
1585 rstart rend whitespace-space-before-tab-regexp
1586 (if whitespace-indent-tabs-mode 0 2)))
1587 ;; ACTION: replace SPACEs before TAB by TABs.
1588 ((memq 'space-before-tab::tab whitespace-style)
1589 (whitespace-replace-action
1590 'tabify rstart rend
1591 whitespace-space-before-tab-regexp 0))
1592 ;; ACTION: replace TABs by SPACEs.
1593 ((memq 'space-before-tab::space whitespace-style)
1594 (whitespace-replace-action
1595 'untabify rstart rend
1596 whitespace-space-before-tab-regexp 2)))))
1597 (set-marker rend nil)))) ; point marker to nowhere
1600 (defun whitespace-replace-action (action rstart rend regexp index)
1601 "Do ACTION in the string matched by REGEXP between RSTART and REND.
1603 INDEX is the level group matched by REGEXP and used by ACTION.
1605 See also `tab-width'."
1606 (goto-char rstart)
1607 (while (re-search-forward regexp rend t)
1608 (goto-char (match-end index))
1609 (funcall action (match-beginning index) (match-end index))))
1612 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1613 ;;;; User command - report
1616 (defun whitespace-regexp (regexp &optional kind)
1617 "Return REGEXP depending on `whitespace-indent-tabs-mode'."
1618 (cond
1619 ((or (eq kind 'tab)
1620 whitespace-indent-tabs-mode)
1621 (format (car regexp) whitespace-tab-width))
1622 ((or (eq kind 'space)
1623 (not whitespace-indent-tabs-mode))
1624 (cdr regexp))))
1627 (defun whitespace-indentation-regexp (&optional kind)
1628 "Return the indentation regexp depending on `whitespace-indent-tabs-mode'."
1629 (whitespace-regexp whitespace-indentation-regexp kind))
1632 (defun whitespace-space-after-tab-regexp (&optional kind)
1633 "Return the space-after-tab regexp depending on `whitespace-indent-tabs-mode'."
1634 (whitespace-regexp whitespace-space-after-tab-regexp kind))
1637 (defconst whitespace-report-list
1638 (list
1639 (cons 'empty whitespace-empty-at-bob-regexp)
1640 (cons 'empty whitespace-empty-at-eob-regexp)
1641 (cons 'trailing whitespace-trailing-regexp)
1642 (cons 'indentation nil)
1643 (cons 'indentation::tab nil)
1644 (cons 'indentation::space nil)
1645 (cons 'space-before-tab whitespace-space-before-tab-regexp)
1646 (cons 'space-before-tab::tab whitespace-space-before-tab-regexp)
1647 (cons 'space-before-tab::space whitespace-space-before-tab-regexp)
1648 (cons 'space-after-tab nil)
1649 (cons 'space-after-tab::tab nil)
1650 (cons 'space-after-tab::space nil)
1652 "List of whitespace bogus symbol and corresponding regexp.")
1655 (defconst whitespace-report-text
1656 '( ;; `indent-tabs-mode' has non-nil value
1658 Whitespace Report
1660 Current Setting Whitespace Problem
1662 empty [] [] empty lines at beginning of buffer
1663 empty [] [] empty lines at end of buffer
1664 trailing [] [] SPACEs or TABs at end of line
1665 indentation [] [] 8 or more SPACEs at beginning of line
1666 indentation::tab [] [] 8 or more SPACEs at beginning of line
1667 indentation::space [] [] TABs at beginning of line
1668 space-before-tab [] [] SPACEs before TAB
1669 space-before-tab::tab [] [] SPACEs before TAB: SPACEs
1670 space-before-tab::space [] [] SPACEs before TAB: TABs
1671 space-after-tab [] [] 8 or more SPACEs after TAB
1672 space-after-tab::tab [] [] 8 or more SPACEs after TAB: SPACEs
1673 space-after-tab::space [] [] 8 or more SPACEs after TAB: TABs
1675 indent-tabs-mode =
1676 tab-width = \n\n"
1677 . ;; `indent-tabs-mode' has nil value
1679 Whitespace Report
1681 Current Setting Whitespace Problem
1683 empty [] [] empty lines at beginning of buffer
1684 empty [] [] empty lines at end of buffer
1685 trailing [] [] SPACEs or TABs at end of line
1686 indentation [] [] TABs at beginning of line
1687 indentation::tab [] [] 8 or more SPACEs at beginning of line
1688 indentation::space [] [] TABs at beginning of line
1689 space-before-tab [] [] SPACEs before TAB
1690 space-before-tab::tab [] [] SPACEs before TAB: SPACEs
1691 space-before-tab::space [] [] SPACEs before TAB: TABs
1692 space-after-tab [] [] 8 or more SPACEs after TAB
1693 space-after-tab::tab [] [] 8 or more SPACEs after TAB: SPACEs
1694 space-after-tab::space [] [] 8 or more SPACEs after TAB: TABs
1696 indent-tabs-mode =
1697 tab-width = \n\n")
1698 "Text for whitespace bogus report.
1700 It is a cons of strings, where the car part is used when
1701 `indent-tabs-mode' is non-nil, and the cdr part is used when
1702 `indent-tabs-mode' is nil.")
1705 (defconst whitespace-report-buffer-name "*Whitespace Report*"
1706 "The buffer name for whitespace bogus report.")
1709 ;;;###autoload
1710 (defun whitespace-report (&optional force report-if-bogus)
1711 "Report some whitespace problems in buffer.
1713 Return nil if there is no whitespace problem; otherwise, return
1714 non-nil.
1716 If FORCE is non-nil or \\[universal-argument] was pressed just
1717 before calling `whitespace-report' interactively, it forces
1718 `whitespace-style' to have:
1720 empty
1721 trailing
1722 indentation
1723 space-before-tab
1724 space-after-tab
1726 If REPORT-IF-BOGUS is non-nil, it reports only when there are any
1727 whitespace problems in buffer.
1729 Report if some of the following whitespace problems exist:
1731 * If `indent-tabs-mode' is non-nil:
1732 empty 1. empty lines at beginning of buffer.
1733 empty 2. empty lines at end of buffer.
1734 trailing 3. SPACEs or TABs at end of line.
1735 indentation 4. 8 or more SPACEs at beginning of line.
1736 space-before-tab 5. SPACEs before TAB.
1737 space-after-tab 6. 8 or more SPACEs after TAB.
1739 * If `indent-tabs-mode' is nil:
1740 empty 1. empty lines at beginning of buffer.
1741 empty 2. empty lines at end of buffer.
1742 trailing 3. SPACEs or TABs at end of line.
1743 indentation 4. TABS at beginning of line.
1744 space-before-tab 5. SPACEs before TAB.
1745 space-after-tab 6. 8 or more SPACEs after TAB.
1747 See `whitespace-style' for documentation.
1748 See also `whitespace-cleanup' and `whitespace-cleanup-region' for
1749 cleaning up these problems."
1750 (interactive (list current-prefix-arg))
1751 (whitespace-report-region (point-min) (point-max)
1752 force report-if-bogus))
1755 ;;;###autoload
1756 (defun whitespace-report-region (start end &optional force report-if-bogus)
1757 "Report some whitespace problems in a region.
1759 Return nil if there is no whitespace problem; otherwise, return
1760 non-nil.
1762 If FORCE is non-nil or \\[universal-argument] was pressed just
1763 before calling `whitespace-report-region' interactively, it
1764 forces `whitespace-style' to have:
1766 empty
1767 indentation
1768 space-before-tab
1769 trailing
1770 space-after-tab
1772 If REPORT-IF-BOGUS is non-nil, it reports only when there are any
1773 whitespace problems in buffer.
1775 Report if some of the following whitespace problems exist:
1777 * If `indent-tabs-mode' is non-nil:
1778 empty 1. empty lines at beginning of buffer.
1779 empty 2. empty lines at end of buffer.
1780 trailing 3. SPACEs or TABs at end of line.
1781 indentation 4. 8 or more SPACEs at beginning of line.
1782 space-before-tab 5. SPACEs before TAB.
1783 space-after-tab 6. 8 or more SPACEs after TAB.
1785 * If `indent-tabs-mode' is nil:
1786 empty 1. empty lines at beginning of buffer.
1787 empty 2. empty lines at end of buffer.
1788 trailing 3. SPACEs or TABs at end of line.
1789 indentation 4. TABS at beginning of line.
1790 space-before-tab 5. SPACEs before TAB.
1791 space-after-tab 6. 8 or more SPACEs after TAB.
1793 See `whitespace-style' for documentation.
1794 See also `whitespace-cleanup' and `whitespace-cleanup-region' for
1795 cleaning up these problems."
1796 (interactive "r")
1797 (setq force (or current-prefix-arg force))
1798 (save-excursion
1799 (save-match-data ;FIXME: Why?
1800 (let* ((has-bogus nil)
1801 (rstart (min start end))
1802 (rend (max start end))
1803 (bogus-list
1804 (mapcar
1805 #'(lambda (option)
1806 (when force
1807 (add-to-list 'whitespace-style (car option)))
1808 (goto-char rstart)
1809 (let ((regexp
1810 (cond
1811 ((eq (car option) 'indentation)
1812 (whitespace-indentation-regexp))
1813 ((eq (car option) 'indentation::tab)
1814 (whitespace-indentation-regexp 'tab))
1815 ((eq (car option) 'indentation::space)
1816 (whitespace-indentation-regexp 'space))
1817 ((eq (car option) 'space-after-tab)
1818 (whitespace-space-after-tab-regexp))
1819 ((eq (car option) 'space-after-tab::tab)
1820 (whitespace-space-after-tab-regexp 'tab))
1821 ((eq (car option) 'space-after-tab::space)
1822 (whitespace-space-after-tab-regexp 'space))
1824 (cdr option)))))
1825 (and (re-search-forward regexp rend t)
1826 (setq has-bogus t))))
1827 whitespace-report-list)))
1828 (when (if report-if-bogus has-bogus t)
1829 (whitespace-kill-buffer whitespace-report-buffer-name)
1830 ;; `whitespace-indent-tabs-mode' is local to current buffer
1831 ;; `whitespace-tab-width' is local to current buffer
1832 (let ((ws-indent-tabs-mode whitespace-indent-tabs-mode)
1833 (ws-tab-width whitespace-tab-width))
1834 (with-current-buffer (get-buffer-create
1835 whitespace-report-buffer-name)
1836 (erase-buffer)
1837 (insert (if ws-indent-tabs-mode
1838 (car whitespace-report-text)
1839 (cdr whitespace-report-text)))
1840 (goto-char (point-min))
1841 (forward-line 3)
1842 (dolist (option whitespace-report-list)
1843 (forward-line 1)
1844 (whitespace-mark-x
1845 27 (memq (car option) whitespace-style))
1846 (whitespace-mark-x 7 (car bogus-list))
1847 (setq bogus-list (cdr bogus-list)))
1848 (forward-line 1)
1849 (whitespace-insert-value ws-indent-tabs-mode)
1850 (whitespace-insert-value ws-tab-width)
1851 (when has-bogus
1852 (goto-char (point-max))
1853 (insert " Type `M-x whitespace-cleanup'"
1854 " to cleanup the buffer.\n\n"
1855 " Type `M-x whitespace-cleanup-region'"
1856 " to cleanup a region.\n\n"))
1857 (whitespace-display-window (current-buffer)))))
1858 has-bogus))))
1861 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1862 ;;;; Internal functions
1865 (defvar whitespace-font-lock-keywords nil
1866 "Used to save the value `whitespace-color-on' adds to `font-lock-keywords'.")
1869 (defconst whitespace-help-text
1871 Whitespace Toggle Options | scroll up : SPC or > |
1872 | scroll down: M-SPC or < |
1873 FACES \\__________________________/
1874 [] f - toggle face visualization
1875 [] t - toggle TAB visualization
1876 [] s - toggle SPACE and HARD SPACE visualization
1877 [] r - toggle trailing blanks visualization
1878 [] l - toggle \"long lines\" visualization
1879 [] L - toggle \"long lines\" tail visualization
1880 [] n - toggle NEWLINE visualization
1881 [] e - toggle empty line at bob and/or eob visualization
1882 [] C-i - toggle indentation SPACEs visualization (via `indent-tabs-mode')
1883 [] I - toggle indentation SPACEs visualization
1884 [] i - toggle indentation TABs visualization
1885 [] C-a - toggle SPACEs after TAB visualization (via `indent-tabs-mode')
1886 [] A - toggle SPACEs after TAB: SPACEs visualization
1887 [] a - toggle SPACEs after TAB: TABs visualization
1888 [] C-b - toggle SPACEs before TAB visualization (via `indent-tabs-mode')
1889 [] B - toggle SPACEs before TAB: SPACEs visualization
1890 [] b - toggle SPACEs before TAB: TABs visualization
1892 DISPLAY TABLE
1893 [] T - toggle TAB visualization
1894 [] S - toggle SPACE and HARD SPACE visualization
1895 [] N - toggle NEWLINE visualization
1897 x - restore `whitespace-style' value
1899 ? - display this text\n\n"
1900 "Text for whitespace toggle options.")
1903 (defconst whitespace-help-buffer-name "*Whitespace Toggle Options*"
1904 "The buffer name for whitespace toggle options.")
1907 (defun whitespace-insert-value (value)
1908 "Insert VALUE at column 20 of next line."
1909 (forward-line 1)
1910 (move-to-column 20 t)
1911 (insert (format "%s" value)))
1914 (defun whitespace-mark-x (nchars condition)
1915 "Insert the mark ('X' or ' ') after NCHARS depending on CONDITION."
1916 (forward-char nchars)
1917 (insert (if condition "X" " ")))
1920 (defun whitespace-insert-option-mark (the-list the-value)
1921 "Insert the option mark ('X' or ' ') in toggle options buffer."
1922 (goto-char (point-min))
1923 (forward-line 2)
1924 (dolist (sym the-list)
1925 (if (eq sym 'help-newline)
1926 (forward-line 2)
1927 (forward-line 1)
1928 (whitespace-mark-x 2 (memq sym the-value)))))
1931 (defun whitespace-help-on (style)
1932 "Display the whitespace toggle options."
1933 (unless (get-buffer whitespace-help-buffer-name)
1934 (delete-other-windows)
1935 (let ((buffer (get-buffer-create whitespace-help-buffer-name)))
1936 (with-current-buffer buffer
1937 (erase-buffer)
1938 (insert whitespace-help-text)
1939 (whitespace-insert-option-mark
1940 whitespace-style-value-list style)
1941 (whitespace-display-window buffer)))))
1944 (defun whitespace-display-window (buffer)
1945 "Display BUFFER in a new window."
1946 (goto-char (point-min))
1947 (set-buffer-modified-p nil)
1948 (when (< (window-height) (* 2 window-min-height))
1949 (kill-buffer buffer)
1950 (error "Window height is too small; \
1951 can't split window to display whitespace toggle options"))
1952 (let ((win (split-window)))
1953 (set-window-buffer win buffer)
1954 (shrink-window-if-larger-than-buffer win)))
1957 (defun whitespace-kill-buffer (buffer-name)
1958 "Kill buffer BUFFER-NAME and windows related with it."
1959 (let ((buffer (get-buffer buffer-name)))
1960 (when buffer
1961 (delete-windows-on buffer)
1962 (kill-buffer buffer))))
1965 (defun whitespace-help-off ()
1966 "Remove the buffer and window of the whitespace toggle options."
1967 (whitespace-kill-buffer whitespace-help-buffer-name))
1970 (defun whitespace-help-scroll (&optional up)
1971 "Scroll help window, if it exists.
1973 If UP is non-nil, scroll up; otherwise, scroll down."
1974 (condition-case nil
1975 (let ((buffer (get-buffer whitespace-help-buffer-name)))
1976 (if buffer
1977 (with-selected-window (get-buffer-window buffer)
1978 (if up
1979 (scroll-up 3)
1980 (scroll-down 3)))
1981 (ding)))
1982 ;; handler
1983 ((error)
1984 ;; just ignore error
1988 (defun whitespace-interactive-char (local-p)
1989 "Interactive function to read a char and return a symbol.
1991 If LOCAL-P is non-nil, it uses a local context; otherwise, it
1992 uses a global context.
1994 It accepts one of the following chars:
1996 CHAR MEANING
1997 (VIA FACES)
1998 f toggle face visualization
1999 t toggle TAB visualization
2000 s toggle SPACE and HARD SPACE visualization
2001 r toggle trailing blanks visualization
2002 l toggle \"long lines\" visualization
2003 L toggle \"long lines\" tail visualization
2004 n toggle NEWLINE visualization
2005 e toggle empty line at bob and/or eob visualization
2006 C-i toggle indentation SPACEs visualization (via `indent-tabs-mode')
2007 I toggle indentation SPACEs visualization
2008 i toggle indentation TABs visualization
2009 C-a toggle SPACEs after TAB visualization (via `indent-tabs-mode')
2010 A toggle SPACEs after TAB: SPACEs visualization
2011 a toggle SPACEs after TAB: TABs visualization
2012 C-b toggle SPACEs before TAB visualization (via `indent-tabs-mode')
2013 B toggle SPACEs before TAB: SPACEs visualization
2014 b toggle SPACEs before TAB: TABs visualization
2016 (VIA DISPLAY TABLE)
2017 T toggle TAB visualization
2018 S toggle SPACE and HARD SPACE visualization
2019 N toggle NEWLINE visualization
2021 x restore `whitespace-style' value
2022 ? display brief help
2024 See also `whitespace-toggle-option-alist'."
2025 (let* ((is-off (not (if local-p
2026 whitespace-mode
2027 global-whitespace-mode)))
2028 (style (cond (is-off whitespace-style) ; use default value
2029 (local-p whitespace-active-style)
2030 (t whitespace-toggle-style)))
2031 (prompt
2032 (format "Whitespace Toggle %s (type ? for further options)-"
2033 (if local-p "Local" "Global")))
2034 ch sym)
2035 ;; read a valid option and get the corresponding symbol
2036 (save-window-excursion
2037 (condition-case data
2038 (progn
2039 (while
2040 ;; while condition
2041 (progn
2042 (setq ch (read-char prompt))
2043 (not
2044 (setq sym
2045 (cdr
2046 (assq ch whitespace-toggle-option-alist)))))
2047 ;; while body
2048 (cond
2049 ((eq ch ?\?) (whitespace-help-on style))
2050 ((eq ch ?\ ) (whitespace-help-scroll t))
2051 ((eq ch ?\M- ) (whitespace-help-scroll))
2052 ((eq ch ?>) (whitespace-help-scroll t))
2053 ((eq ch ?<) (whitespace-help-scroll))
2054 (t (ding))))
2055 (whitespace-help-off)
2056 (message " ")) ; clean echo area
2057 ;; handler
2058 ((quit error)
2059 (whitespace-help-off)
2060 (error (error-message-string data)))))
2061 (list sym))) ; return the appropriate symbol
2064 (defun whitespace-toggle-list (local-p arg the-list)
2065 "Toggle options in THE-LIST based on list ARG.
2067 If LOCAL-P is non-nil, it uses a local context; otherwise, it
2068 uses a global context.
2070 ARG is a list of options to be toggled.
2072 THE-LIST is a list of options. This list will be toggled and the
2073 resultant list will be returned."
2074 (unless (if local-p whitespace-mode global-whitespace-mode)
2075 (setq the-list whitespace-style))
2076 (setq the-list (copy-sequence the-list)) ; keep original list
2077 (dolist (sym (if (listp arg) arg (list arg)))
2078 (cond
2079 ;; ignore help value
2080 ((eq sym 'help-newline))
2081 ;; restore default values
2082 ((eq sym 'whitespace-style)
2083 (setq the-list whitespace-style))
2084 ;; toggle valid values
2085 ((memq sym whitespace-style-value-list)
2086 (setq the-list (if (memq sym the-list)
2087 (delq sym the-list)
2088 (cons sym the-list))))))
2089 the-list)
2092 (defvar whitespace-display-table nil
2093 "Used to save a local display table.")
2095 (defvar whitespace-display-table-was-local nil
2096 "Used to remember whether a buffer initially had a local display table.")
2099 (defun whitespace-turn-on ()
2100 "Turn on whitespace visualization."
2101 ;; prepare local hooks
2102 (add-hook 'write-file-functions 'whitespace-write-file-hook nil t)
2103 ;; create whitespace local buffer environment
2104 (set (make-local-variable 'whitespace-font-lock-keywords) nil)
2105 (set (make-local-variable 'whitespace-display-table) nil)
2106 (set (make-local-variable 'whitespace-display-table-was-local) nil)
2107 (set (make-local-variable 'whitespace-active-style)
2108 (if (listp whitespace-style)
2109 whitespace-style
2110 (list whitespace-style)))
2111 (set (make-local-variable 'whitespace-indent-tabs-mode)
2112 indent-tabs-mode)
2113 (set (make-local-variable 'whitespace-tab-width)
2114 tab-width)
2115 ;; turn on whitespace
2116 (when whitespace-active-style
2117 (whitespace-color-on)
2118 (whitespace-display-char-on)))
2121 (defun whitespace-turn-off ()
2122 "Turn off whitespace visualization."
2123 (remove-hook 'write-file-functions 'whitespace-write-file-hook t)
2124 (when whitespace-active-style
2125 (whitespace-color-off)
2126 (whitespace-display-char-off)))
2129 (defun whitespace-style-face-p ()
2130 "Return t if there is some visualization via face."
2131 (and (memq 'face whitespace-active-style)
2132 (or (memq 'tabs whitespace-active-style)
2133 (memq 'spaces whitespace-active-style)
2134 (memq 'trailing whitespace-active-style)
2135 (memq 'lines whitespace-active-style)
2136 (memq 'lines-tail whitespace-active-style)
2137 (memq 'newline whitespace-active-style)
2138 (memq 'empty whitespace-active-style)
2139 (memq 'indentation whitespace-active-style)
2140 (memq 'indentation::tab whitespace-active-style)
2141 (memq 'indentation::space whitespace-active-style)
2142 (memq 'space-after-tab whitespace-active-style)
2143 (memq 'space-after-tab::tab whitespace-active-style)
2144 (memq 'space-after-tab::space whitespace-active-style)
2145 (memq 'space-before-tab whitespace-active-style)
2146 (memq 'space-before-tab::tab whitespace-active-style)
2147 (memq 'space-before-tab::space whitespace-active-style))))
2150 (defun whitespace-color-on ()
2151 "Turn on color visualization."
2152 (when (whitespace-style-face-p)
2153 ;; save current point and refontify when necessary
2154 (set (make-local-variable 'whitespace-point)
2155 (point))
2156 (set (make-local-variable 'whitespace-font-lock-refontify)
2158 (set (make-local-variable 'whitespace-bob-marker)
2159 (point-min-marker))
2160 (set (make-local-variable 'whitespace-eob-marker)
2161 (point-max-marker))
2162 (set (make-local-variable 'whitespace-buffer-changed)
2163 nil)
2164 (add-hook 'post-command-hook #'whitespace-post-command-hook nil t)
2165 (add-hook 'before-change-functions #'whitespace-buffer-changed nil t)
2166 ;; Add whitespace-mode color into font lock.
2167 (setq
2168 whitespace-font-lock-keywords
2170 ,@(when (memq 'spaces whitespace-active-style)
2171 ;; Show SPACEs.
2172 `((,whitespace-space-regexp 1 whitespace-space t)
2173 ;; Show HARD SPACEs.
2174 (,whitespace-hspace-regexp 1 whitespace-hspace t)))
2175 ,@(when (memq 'tabs whitespace-active-style)
2176 ;; Show TABs.
2177 `((,whitespace-tab-regexp 1 whitespace-tab t)))
2178 ,@(when (memq 'trailing whitespace-active-style)
2179 ;; Show trailing blanks.
2180 `((,#'whitespace-trailing-regexp 1 whitespace-trailing t)))
2181 ,@(when (or (memq 'lines whitespace-active-style)
2182 (memq 'lines-tail whitespace-active-style))
2183 ;; Show "long" lines.
2184 `((,(let ((line-column (or whitespace-line-column fill-column)))
2185 (format
2186 "^\\([^\t\n]\\{%s\\}\\|[^\t\n]\\{0,%s\\}\t\\)\\{%d\\}%s\\(.+\\)$"
2187 whitespace-tab-width
2188 (1- whitespace-tab-width)
2189 (/ line-column whitespace-tab-width)
2190 (let ((rem (% line-column whitespace-tab-width)))
2191 (if (zerop rem)
2193 (format ".\\{%d\\}" rem)))))
2194 ,(if (memq 'lines whitespace-active-style)
2195 0 ; whole line
2196 2) ; line tail
2197 whitespace-line prepend)))
2198 ,@(when (or (memq 'space-before-tab whitespace-active-style)
2199 (memq 'space-before-tab::tab whitespace-active-style)
2200 (memq 'space-before-tab::space whitespace-active-style))
2201 `((,whitespace-space-before-tab-regexp
2202 ,(cond
2203 ((memq 'space-before-tab whitespace-active-style)
2204 ;; Show SPACEs before TAB (indent-tabs-mode).
2205 (if whitespace-indent-tabs-mode 1 2))
2206 ((memq 'space-before-tab::tab whitespace-active-style)
2208 ((memq 'space-before-tab::space whitespace-active-style)
2210 whitespace-space-before-tab t)))
2211 ,@(when (or (memq 'indentation whitespace-active-style)
2212 (memq 'indentation::tab whitespace-active-style)
2213 (memq 'indentation::space whitespace-active-style))
2214 `((,(cond
2215 ((memq 'indentation whitespace-active-style)
2216 ;; Show indentation SPACEs (indent-tabs-mode).
2217 (whitespace-indentation-regexp))
2218 ((memq 'indentation::tab whitespace-active-style)
2219 ;; Show indentation SPACEs (SPACEs).
2220 (whitespace-indentation-regexp 'tab))
2221 ((memq 'indentation::space whitespace-active-style)
2222 ;; Show indentation SPACEs (TABs).
2223 (whitespace-indentation-regexp 'space)))
2224 1 whitespace-indentation t)))
2225 ,@(when (memq 'empty whitespace-active-style)
2226 ;; Show empty lines at beginning of buffer.
2227 `((,#'whitespace-empty-at-bob-regexp
2228 1 whitespace-empty t)
2229 ;; Show empty lines at end of buffer.
2230 (,#'whitespace-empty-at-eob-regexp
2231 1 whitespace-empty t)))
2232 ,@(when (or (memq 'space-after-tab whitespace-active-style)
2233 (memq 'space-after-tab::tab whitespace-active-style)
2234 (memq 'space-after-tab::space whitespace-active-style))
2235 `((,(cond
2236 ((memq 'space-after-tab whitespace-active-style)
2237 ;; Show SPACEs after TAB (indent-tabs-mode).
2238 (whitespace-space-after-tab-regexp))
2239 ((memq 'space-after-tab::tab whitespace-active-style)
2240 ;; Show SPACEs after TAB (SPACEs).
2241 (whitespace-space-after-tab-regexp 'tab))
2242 ((memq 'space-after-tab::space whitespace-active-style)
2243 ;; Show SPACEs after TAB (TABs).
2244 (whitespace-space-after-tab-regexp 'space)))
2245 1 whitespace-space-after-tab t)))))
2246 (font-lock-add-keywords nil whitespace-font-lock-keywords t)
2247 (when font-lock-mode
2248 (font-lock-fontify-buffer))))
2251 (defun whitespace-color-off ()
2252 "Turn off color visualization."
2253 ;; turn off font lock
2254 (when (whitespace-style-face-p)
2255 (remove-hook 'post-command-hook #'whitespace-post-command-hook t)
2256 (remove-hook 'before-change-functions #'whitespace-buffer-changed t)
2257 (font-lock-remove-keywords nil whitespace-font-lock-keywords)
2258 (when font-lock-mode
2259 (font-lock-fontify-buffer))))
2262 (defun whitespace-trailing-regexp (limit)
2263 "Match trailing spaces which do not contain the point at end of line."
2264 (let ((status t))
2265 (while (if (re-search-forward whitespace-trailing-regexp limit t)
2266 (= whitespace-point (match-end 1)) ;; loop if point at eol
2267 (setq status nil))) ;; end of buffer
2268 status))
2271 (defun whitespace-empty-at-bob-regexp (limit)
2272 "Match spaces at beginning of buffer which do not contain the point at \
2273 beginning of buffer."
2274 (let ((b (point))
2276 (cond
2277 ;; at bob
2278 ((= b 1)
2279 (setq r (and (/= whitespace-point 1)
2280 (looking-at whitespace-empty-at-bob-regexp)))
2281 (set-marker whitespace-bob-marker (if r (match-end 1) b)))
2282 ;; inside bob empty region
2283 ((<= limit whitespace-bob-marker)
2284 (setq r (looking-at whitespace-empty-at-bob-regexp))
2285 (if r
2286 (when (< (match-end 1) limit)
2287 (set-marker whitespace-bob-marker (match-end 1)))
2288 (set-marker whitespace-bob-marker b)))
2289 ;; intersection with end of bob empty region
2290 ((<= b whitespace-bob-marker)
2291 (setq r (looking-at whitespace-empty-at-bob-regexp))
2292 (set-marker whitespace-bob-marker (if r (match-end 1) b)))
2293 ;; it is not inside bob empty region
2295 (setq r nil)))
2296 ;; move to end of matching
2297 (and r (goto-char (match-end 1)))
2301 (defsubst whitespace-looking-back (regexp limit)
2302 (save-excursion
2303 (when (/= 0 (skip-chars-backward " \t\n" limit))
2304 (unless (bolp)
2305 (forward-line 1))
2306 (looking-at regexp))))
2309 (defun whitespace-empty-at-eob-regexp (limit)
2310 "Match spaces at end of buffer which do not contain the point at end of \
2311 buffer."
2312 (let ((b (point))
2313 (e (1+ (buffer-size)))
2315 (cond
2316 ;; at eob
2317 ((= limit e)
2318 (when (/= whitespace-point e)
2319 (goto-char limit)
2320 (setq r (whitespace-looking-back whitespace-empty-at-eob-regexp b)))
2321 (if r
2322 (set-marker whitespace-eob-marker (match-beginning 1))
2323 (set-marker whitespace-eob-marker limit)
2324 (goto-char b))) ; return back to initial position
2325 ;; inside eob empty region
2326 ((>= b whitespace-eob-marker)
2327 (goto-char limit)
2328 (setq r (whitespace-looking-back whitespace-empty-at-eob-regexp b))
2329 (if r
2330 (when (> (match-beginning 1) b)
2331 (set-marker whitespace-eob-marker (match-beginning 1)))
2332 (set-marker whitespace-eob-marker limit)
2333 (goto-char b))) ; return back to initial position
2334 ;; intersection with beginning of eob empty region
2335 ((>= limit whitespace-eob-marker)
2336 (goto-char limit)
2337 (setq r (whitespace-looking-back whitespace-empty-at-eob-regexp b))
2338 (if r
2339 (set-marker whitespace-eob-marker (match-beginning 1))
2340 (set-marker whitespace-eob-marker limit)
2341 (goto-char b))) ; return back to initial position
2342 ;; it is not inside eob empty region
2344 (setq r nil)))
2348 (defun whitespace-buffer-changed (_beg _end)
2349 "Set `whitespace-buffer-changed' variable to t."
2350 (setq whitespace-buffer-changed t))
2353 (defun whitespace-post-command-hook ()
2354 "Save current point into `whitespace-point' variable.
2355 Also refontify when necessary."
2356 (setq whitespace-point (point)) ; current point position
2357 (let ((refontify
2359 ;; it is at end of line ...
2360 (and (eolp)
2361 ;; ... with trailing SPACE or TAB
2362 (or (= (preceding-char) ?\ )
2363 (= (preceding-char) ?\t)))
2364 ;; it is at beginning of buffer (bob)
2365 (= whitespace-point 1)
2366 ;; the buffer was modified and ...
2367 (and whitespace-buffer-changed
2369 ;; ... or inside bob whitespace region
2370 (<= whitespace-point whitespace-bob-marker)
2371 ;; ... or at bob whitespace region border
2372 (and (= whitespace-point (1+ whitespace-bob-marker))
2373 (= (preceding-char) ?\n))))
2374 ;; it is at end of buffer (eob)
2375 (= whitespace-point (1+ (buffer-size)))
2376 ;; the buffer was modified and ...
2377 (and whitespace-buffer-changed
2379 ;; ... or inside eob whitespace region
2380 (>= whitespace-point whitespace-eob-marker)
2381 ;; ... or at eob whitespace region border
2382 (and (= whitespace-point (1- whitespace-eob-marker))
2383 (= (following-char) ?\n)))))))
2384 (when (or refontify (> whitespace-font-lock-refontify 0))
2385 (setq whitespace-buffer-changed nil)
2386 ;; adjust refontify counter
2387 (setq whitespace-font-lock-refontify
2388 (if refontify
2390 (1- whitespace-font-lock-refontify)))
2391 ;; refontify
2392 (jit-lock-refontify))))
2395 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2396 ;;;; Hacked from visws.el (Miles Bader <miles@gnu.org>)
2399 (defun whitespace-style-mark-p ()
2400 "Return t if there is some visualization via display table."
2401 (or (memq 'tab-mark whitespace-active-style)
2402 (memq 'space-mark whitespace-active-style)
2403 (memq 'newline-mark whitespace-active-style)))
2406 (defsubst whitespace-char-valid-p (char)
2407 ;; This check should be improved!!!
2408 (or (< char 256)
2409 (characterp char)))
2412 (defun whitespace-display-vector-p (vec)
2413 "Return true if every character in vector VEC can be displayed."
2414 (let ((i (length vec)))
2415 (when (> i 0)
2416 (while (and (>= (setq i (1- i)) 0)
2417 (whitespace-char-valid-p (aref vec i))))
2418 (< i 0))))
2421 (defun whitespace-display-char-on ()
2422 "Turn on character display mapping."
2423 (when (and whitespace-display-mappings
2424 (whitespace-style-mark-p))
2425 (let (vecs vec)
2426 ;; Remember whether a buffer has a local display table.
2427 (unless whitespace-display-table-was-local
2428 (setq whitespace-display-table-was-local t
2429 whitespace-display-table
2430 (copy-sequence buffer-display-table))
2431 ;; Assure `buffer-display-table' is unique
2432 ;; when two or more windows are visible.
2433 (setq buffer-display-table
2434 (copy-sequence buffer-display-table)))
2435 (unless buffer-display-table
2436 (setq buffer-display-table (make-display-table)))
2437 (dolist (entry whitespace-display-mappings)
2438 ;; check if it is to display this mark
2439 (when (memq (car entry) whitespace-style)
2440 ;; Get a displayable mapping.
2441 (setq vecs (cddr entry))
2442 (while (and vecs
2443 (not (whitespace-display-vector-p (car vecs))))
2444 (setq vecs (cdr vecs)))
2445 ;; Display a valid mapping.
2446 (when vecs
2447 (setq vec (copy-sequence (car vecs)))
2448 ;; NEWLINE char
2449 (when (and (eq (cadr entry) ?\n)
2450 (memq 'newline whitespace-active-style))
2451 ;; Only insert face bits on NEWLINE char mapping to avoid
2452 ;; obstruction of other faces like TABs and (HARD) SPACEs
2453 ;; faces, font-lock faces, etc.
2454 (dotimes (i (length vec))
2455 (or (eq (aref vec i) ?\n)
2456 (aset vec i
2457 (make-glyph-code (aref vec i)
2458 whitespace-newline)))))
2459 ;; Display mapping
2460 (aset buffer-display-table (cadr entry) vec)))))))
2463 (defun whitespace-display-char-off ()
2464 "Turn off character display mapping."
2465 (and whitespace-display-mappings
2466 (whitespace-style-mark-p)
2467 whitespace-display-table-was-local
2468 (setq whitespace-display-table-was-local nil
2469 buffer-display-table whitespace-display-table)))
2472 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2473 ;;;; Hook
2476 (defun whitespace-action-when-on ()
2477 "Action to be taken always when local whitespace is turned on."
2478 (cond ((memq 'cleanup whitespace-action)
2479 (whitespace-cleanup))
2480 ((memq 'report-on-bogus whitespace-action)
2481 (whitespace-report nil t))))
2484 (defun whitespace-write-file-hook ()
2485 "Action to be taken when buffer is written.
2486 It should be added buffer-locally to `write-file-functions'."
2487 (cond ((memq 'auto-cleanup whitespace-action)
2488 (whitespace-cleanup))
2489 ((memq 'abort-on-bogus whitespace-action)
2490 (when (whitespace-report nil t)
2491 (error "Abort write due to whitespace problems in %s"
2492 (buffer-name)))))
2493 nil) ; continue hook processing
2496 (defun whitespace-warn-read-only (msg)
2497 "Warn if buffer is read-only."
2498 (when (memq 'warn-if-read-only whitespace-action)
2499 (message "Can't %s: %s is read-only" msg (buffer-name))))
2502 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2505 (defun whitespace-unload-function ()
2506 "Unload the whitespace library."
2507 (global-whitespace-mode -1)
2508 ;; be sure all local whitespace mode is turned off
2509 (save-current-buffer
2510 (dolist (buf (buffer-list))
2511 (set-buffer buf)
2512 (whitespace-mode -1)))
2513 nil) ; continue standard unloading
2516 (provide 'whitespace)
2519 (run-hooks 'whitespace-load-hook)
2522 ;;; whitespace.el ends here