| blob | a250f24ddaa28e4a89565aa48730f7461ea21758 |
1 ;;; whitespace.el --- warn about and clean bogus whitespaces in the file
3 ;; Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004,
4 ;; 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
6 ;; Author: Rajesh Vaidheeswarran <rv@gnu.org>
7 ;; Keywords: convenience
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software; you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation; either version 3, or (at your option)
14 ;; any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs; see the file COPYING. If not, write to the
23 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
24 ;; Boston, MA 02110-1301, USA.
26 ;;; Commentary:
27 ;;
28 ;; URL: http://www.dsmit.com/lisp/
29 ;;
30 ;; The whitespace library is intended to find and help fix five different types
31 ;; of whitespace problems that commonly exist in source code.
32 ;;
33 ;; 1. Leading space (empty lines at the top of a file).
34 ;; 2. Trailing space (empty lines at the end of a file).
35 ;; 3. Indentation space (8 or more spaces at beginning of line, that should be
36 ;; replaced with TABS).
37 ;; 4. Spaces followed by a TAB. (Almost always, we never want that).
38 ;; 5. Spaces or TABS at the end of a line.
39 ;;
40 ;; Whitespace errors are reported in a buffer, and on the modeline.
41 ;;
42 ;; Modeline will show a W:<x>!<y> to denote a particular type of whitespace,
43 ;; where `x' and `y' can be one (or more) of:
44 ;;
45 ;; e - End-of-Line whitespace.
46 ;; i - Indentation whitespace.
47 ;; l - Leading whitespace.
48 ;; s - Space followed by Tab.
49 ;; t - Trailing whitespace.
50 ;;
51 ;; If any of the whitespace checks is turned off, the modeline will display a
52 ;; !<y>.
53 ;;
54 ;; (since (3) is the most controversial one, here is the rationale: Most
55 ;; terminal drivers and printer drivers have TAB configured or even
56 ;; hardcoded to be 8 spaces. (Some of them allow configuration, but almost
57 ;; always they default to 8.)
58 ;;
59 ;; Changing `tab-width' to other than 8 and editing will cause your code to
60 ;; look different from within Emacs, and say, if you cat it or more it, or
61 ;; even print it.
62 ;;
63 ;; Almost all the popular programming modes let you define an offset (like
64 ;; c-basic-offset or perl-indent-level) to configure the offset, so you
65 ;; should never have to set your `tab-width' to be other than 8 in all
66 ;; these modes. In fact, with an indent level of say, 4, 2 TABS will cause
67 ;; Emacs to replace your 8 spaces with one \t (try it). If vi users in
68 ;; your office complain, tell them to use vim, which distinguishes between
69 ;; tabstop and shiftwidth (vi equivalent of our offsets), and also ask them
70 ;; to set smarttab.)
71 ;;
72 ;; All the above have caused (and will cause) unwanted codeline integration and
73 ;; merge problems.
74 ;;
75 ;; whitespace.el will complain if it detects whitespaces on opening a file, and
76 ;; warn you on closing a file also (in case you had inserted any
77 ;; whitespaces during the process of your editing).
78 ;;
79 ;; Exported functions:
80 ;;
81 ;; `whitespace-buffer' - To check the current buffer for whitespace problems.
82 ;; `whitespace-cleanup' - To cleanup all whitespaces in the current buffer.
83 ;; `whitespace-region' - To check between point and mark for whitespace
84 ;; problems.
85 ;; `whitespace-cleanup-region' - To cleanup all whitespaces between point
86 ;; and mark in the current buffer.
88 ;;; Code:
93 "An associated list of buffers and files checked for whitespace cleanliness.
95 This is to enable periodic checking of whitespace cleanliness in the files
101 ;; Tell Emacs about this new kind of minor mode
113 ;;;###autoload(put 'whitespace-check-buffer-leading 'safe-local-variable 'booleanp)
118 ;;;###autoload(put 'whitespace-check-buffer-trailing 'safe-local-variable 'booleanp)
123 ;;;###autoload(put 'whitespace-check-buffer-indent 'safe-local-variable 'booleanp)
128 ;;;###autoload(put 'whitespace-check-buffer-spacetab 'safe-local-variable 'booleanp)
133 ;;;###autoload(put 'whitespace-check-buffer-ateol 'safe-local-variable 'booleanp)
139 ;; For flavors of Emacs which don't define `defgroup' and `defcustom'.
143 "Null macro for `defgroup' in all versions of Emacs that don't define it."
144 t))
147 "Macro to alias `defcustom' to `defvar' in all versions of Emacs that
148 don't define it."
165 "Check for and fix five different types of whitespaces in source code."
168 ;; Since XEmacs doesn't have a 'convenience group, use the next best group
169 ;; which is 'editing?
173 "Flag to check leading whitespace. This is the global for the system.
174 It can be overridden by setting a buffer local variable
175 `whitespace-check-buffer-leading'."
180 "Flag to check trailing whitespace. This is the global for the system.
181 It can be overridden by setting a buffer local variable
182 `whitespace-check-buffer-trailing'."
187 "Flag to check space followed by a TAB. This is the global for the system.
188 It can be overridden by setting a buffer local variable
189 `whitespace-check-buffer-spacetab'."
194 "Regexp to match one or more spaces followed by a TAB."
199 "Flag to check indentation whitespace. This is the global for the system.
200 It can be overridden by setting a buffer local variable
201 `whitespace-check-buffer-indent'."
206 "Regexp to match multiples of eight spaces near line beginnings.
207 The default value ignores leading TABs."
212 "Flag to check end-of-line whitespace. This is the global for the system.
213 It can be overridden by setting a buffer local variable
214 `whitespace-check-buffer-ateol'."
219 "Regexp to match one or more TABs or spaces at line ends."
224 "The name of the buffer where whitespace related messages will be logged."
229 "If non-nil, this message will be displayed after a whitespace check
230 determines a file to be clean."
235 "While writing a file, abort if the file is unclean.
236 If `whitespace-auto-cleanup' is set, that takes precedence over
237 this variable."
242 "Cleanup a buffer automatically on finding it whitespace unclean."
247 "All whitespace errors will be shown only in the modeline when t.
249 Note that setting this may cause all whitespaces introduced in a file to go
250 unnoticed when the buffer is killed, unless the user visits the `*Whitespace
251 Errors*' buffer before opening (or closing) another file."
256 c-mode c++-mode cc-mode
257 change-log-mode cperl-mode
258 electric-nroff-mode emacs-lisp-mode
259 f90-mode fortran-mode html-mode
260 html3-mode java-mode jde-mode
261 ksh-mode latex-mode LaTeX-mode
262 lisp-mode m4-mode makefile-mode
263 modula-2-mode nroff-mode objc-mode
264 pascal-mode perl-mode prolog-mode
265 python-mode scheme-mode sgml-mode
266 sh-mode shell-script-mode simula-mode
267 tcl-mode tex-mode texinfo-mode
268 vrml-mode xml-mode)
270 "Major modes in which we turn on whitespace checking.
272 These are mostly programming and documentation modes. But you may add other
273 modes that you want whitespaces checked in by adding something like the
274 following to your `.emacs':
276 \(setq whitespace-modes (cons 'my-mode (cons 'my-other-mode
277 whitespace-modes))\)
279 Or, alternately, you can use the Emacs `customize' command to set this."
284 "Period in seconds to rescan modified buffers for whitespace creep.
286 This is the period after which the timer will fire causing
287 `whitespace-rescan-files-in-buffers' to check for whitespace creep in
288 modified buffers.
290 To disable timer scans, set this to zero."
295 "Display whitespace errors on the modeline."
300 "Display the bogus whitespaces by coloring them with the face
301 `whitespace-highlight'."
306 "Faces used in whitespace."
321 "Face used for highlighting the bogus whitespaces that exist in the buffer."
323 ;; backward-compatibility alias
328 minor-mode-alist)))
331 whitespace-check-leading-whitespace)
333 whitespace-check-trailing-whitespace)
335 whitespace-check-indent-whitespace)
337 whitespace-check-spacetab-whitespace)
339 whitespace-check-ateol-whitespace)
342 "Test and set the whitespace-mode in qualifying buffers."
346 t
347 nil))))
349 ;;;###autoload
351 "Toggle the check for leading space in the local buffer."
359 ;;;###autoload
361 "Toggle the check for trailing space in the local buffer."
369 ;;;###autoload
371 "Toggle the check for indentation space in the local buffer."
380 ;;;###autoload
382 "Toggle the check for space-followed-by-TABs in the local buffer."
392 ;;;###autoload
394 "Toggle the check for end-of-line space in the local buffer."
404 ;;;###autoload
406 "Find five different types of white spaces in buffer.
407 These are:
408 1. Leading space \(empty lines at the top of a file\).
409 2. Trailing space \(empty lines at the end of a file\).
410 3. Indentation space \(8 or more spaces, that should be replaced with TABS\).
411 4. Spaces followed by a TAB. \(Almost always, we never want that\).
412 5. Spaces or TABS at the end of a line.
414 Check for whitespace only if this buffer really contains a non-empty file
415 and:
416 1. the major mode is one of the whitespace-modes, or
417 2. `whitespace-buffer' was explicitly called with a prefix argument."
434 nil))
437 nil))
440 whitespace-indent-regexp)
441 nil))
444 whitespace-spacetab-regexp)
445 nil))
448 whitespace-ateol-regexp)
449 nil))
454 ;; Now let's complain if we found any of the above.
456 whitespace-spacetab whitespace-ateol
457 whitespace-trailing))
495 whitespace-this-modeline
501 whitespace-filename)))
504 whitespace-clean-msg))))))))
505 whitespace-error))
507 ;;;###autoload
509 "Check the region for whitespace errors."
516 ;;;###autoload
518 "Cleanup the five different kinds of whitespace problems.
519 It normally applies to the whole buffer, but in Transient Mark mode
520 when the mark is active it applies to the region.
521 See `whitespace-buffer' docstring for a summary of the problems."
528 ;; If this buffer really contains a file, then run, else quit.
535 ;; since all printable TABS should be 8, irrespective of how
536 ;; they are displayed.
569 ;; Call this recursively till everything is taken care of
572 ;; if we are done, talk to the user
581 ;;;###autoload
583 "Whitespace cleanup on the region."
592 "Return t if the current buffer has leading newline characters.
593 If highlighting is enabled, highlight these characters."
599 t)))
602 "Remove any leading newline characters from current buffer."
609 "Return t if the current buffer has extra trailing newline characters.
610 If highlighting is enabled, highlight these characters."
617 t)))
620 "Remove extra trailing newline characters from current buffer."
629 "Search for any given whitespace REGEXP."
641 "Search for any given whitespace REGEXP and replace it with the NEWREGEXP."
648 "Search for 8/more spaces at the start of a line and replace it with tabs."
658 "Return the list of whitespaces whose testing has been suppressed."
666 unchecked-spaces
667 nil)))
670 "Update modeline with whitespace errors.
671 Also with whitespaces whose testing has been turned off."
675 ;; Whitespace errors
678 ;; Whitespace suppressed errors
683 ;; Add the whitespace modeline prefix
686 nil))
690 "Highlight the current line, unhighlighting a previously jumped to line."
696 "Unhighlight the currently highlight line."
703 "Add a buffer and its file to the whitespace monitor list.
705 The buffer named BUF-NAME and its associated file BUF-FILE are now monitored
706 periodically for whitespace."
708 whitespace-all-buffer-files)))
712 "Tickle timer to periodically to scan qualifying files for whitespace creep.
714 If timer is not set, then set it to scan the files in
715 `whitespace-all-buffer-files' periodically (defined by
716 `whitespace-rescan-timer-time') for whitespace creep."
720 'whitespace-rescan-files-in-buffers nil
721 whitespace-rescan-timer-time))))
724 "Check monitored files for whitespace creep since last scan."
726 buffile bufname thiselt buf)
739 ;;(message "buffer %s live" bufname)
743 ;;(message "checking for whitespace in %s" bufname)
746 ;;(message "cleaning up whitespace in %s" bufname)
749 ;;(message "whitespace-buffer %s." (buffer-name))
751 ;;(message "Removing %s from refresh list" bufname)
753 ;;(message "Removing %s from refresh list" bufname)
757 "Refresh the list of files to be rescanned for whitespace creep."
765 ;;;###autoload
768 ;;;###autoload
770 "Toggle using Whitespace mode in new buffers.
771 With ARG, turn the mode on if ARG is positive, otherwise turn it off.
773 When this mode is active, `whitespace-buffer' is added to
774 `find-file-hook' and `kill-buffer-hook'."
775 :global t
786 ;;;###autoload
788 "Hook function to be called on the buffer when whitespace check is enabled.
789 This is meant to be added buffer-locally to `write-file-functions'."
796 buffer-file-name))))
797 nil)
800 "Unload the whitespace library."
802 ;; if whitespace-unload-hook is defined, let's get rid of it
803 ;; and recursively call `unload-feature'
805 ;; this only happens in the recursive call
811 ;; continue standard unloading
812 nil))
823 ;; arch-tag: 4ff44e87-b63c-402d-95a6-15e51e58bd0c
824 ;;; whitespace.el ends here