| blob | ac31a4d820b7f4520feb24aaa9e1efb54543e995 |
1 ;;; whitespace.el --- warn about and clean bogus whitespaces in the file
3 ;; Copyright (C) 1999, 2000, 2005 Free Software Foundation, Inc.
5 ;; Author: Rajesh Vaidheeswarran <rv@gnu.org>
6 ;; Keywords: convenience
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software; you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation; either version 2, or (at your option)
13 ;; any later version.
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs; see the file COPYING. If not, write to the
22 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
23 ;; Boston, MA 02110-1301, USA.
25 ;;; Commentary:
26 ;;
27 ;; URL: http://www.dsmit.com/lisp/
28 ;;
29 ;; The whitespace library is intended to find and help fix five different types
30 ;; of whitespace problems that commonly exist in source code.
31 ;;
32 ;; 1. Leading space (empty lines at the top of a file).
33 ;; 2. Trailing space (empty lines at the end of a file).
34 ;; 3. Indentation space (8 or more spaces at beginning of line, that should be
35 ;; replaced with TABS).
36 ;; 4. Spaces followed by a TAB. (Almost always, we never want that).
37 ;; 5. Spaces or TABS at the end of a line.
38 ;;
39 ;; Whitespace errors are reported in a buffer, and on the modeline.
40 ;;
41 ;; Modeline will show a W:<x>!<y> to denote a particular type of whitespace,
42 ;; where `x' and `y' can be one (or more) of:
43 ;;
44 ;; e - End-of-Line whitespace.
45 ;; i - Indentation whitespace.
46 ;; l - Leading whitespace.
47 ;; s - Space followed by Tab.
48 ;; t - Trailing whitespace.
49 ;;
50 ;; If any of the whitespace checks is turned off, the modeline will display a
51 ;; !<y>.
52 ;;
53 ;; (since (3) is the most controversial one, here is the rationale: Most
54 ;; terminal drivers and printer drivers have TAB configured or even
55 ;; hardcoded to be 8 spaces. (Some of them allow configuration, but almost
56 ;; always they default to 8.)
57 ;;
58 ;; Changing `tab-width' to other than 8 and editing will cause your code to
59 ;; look different from within Emacs, and say, if you cat it or more it, or
60 ;; even print it.
61 ;;
62 ;; Almost all the popular programming modes let you define an offset (like
63 ;; c-basic-offset or perl-indent-level) to configure the offset, so you
64 ;; should never have to set your `tab-width' to be other than 8 in all
65 ;; these modes. In fact, with an indent level of say, 4, 2 TABS will cause
66 ;; Emacs to replace your 8 spaces with one \t (try it). If vi users in
67 ;; your office complain, tell them to use vim, which distinguishes between
68 ;; tabstop and shiftwidth (vi equivalent of our offsets), and also ask them
69 ;; to set smarttab.)
70 ;;
71 ;; All the above have caused (and will cause) unwanted codeline integration and
72 ;; merge problems.
73 ;;
74 ;; whitespace.el will complain if it detects whitespaces on opening a file, and
75 ;; warn you on closing a file also (in case you had inserted any
76 ;; whitespaces during the process of your editing).
77 ;;
78 ;; Exported functions:
79 ;;
80 ;; `whitespace-buffer' - To check the current buffer for whitespace problems.
81 ;; `whitespace-cleanup' - To cleanup all whitespaces in the current buffer.
82 ;; `whitespace-region' - To check between point and mark for whitespace
83 ;; problems.
84 ;; `whitespace-cleanup-region' - To cleanup all whitespaces between point
85 ;; and mark in the current buffer.
87 ;;; Code:
92 "An associated list of buffers and files checked for whitespace cleanliness.
94 This is to enable periodic checking of whitespace cleanliness in the files
100 ;; Tell Emacs about this new kind of minor mode
141 ;; For flavors of Emacs which don't define `defgroup' and `defcustom'.
145 "Null macro for `defgroup' in all versions of Emacs that don't define it."
146 t))
149 "Macro to alias `defcustom' to `defvar' in all versions of Emacs that
150 don't define it."
167 "Check for and fix five different types of whitespaces in source code."
170 ;; Since XEmacs doesn't have a 'convenience group, use the next best group
171 ;; which is 'editing?
175 "Flag to check leading whitespace. This is the global for the system.
176 It can be overriden by setting a buffer local variable
177 `whitespace-check-buffer-leading'."
182 "Flag to check trailing whitespace. This is the global for the system.
183 It can be overriden by setting a buffer local variable
184 `whitespace-check-buffer-trailing'."
189 "Flag to check space followed by a TAB. This is the global for the system.
190 It can be overriden by setting a buffer local variable
191 `whitespace-check-buffer-spacetab'."
196 "Regexp to match a space followed by a TAB."
201 "Flag to check indentation whitespace. This is the global for the system.
202 It can be overriden by setting a buffer local variable
203 `whitespace-check-buffer-indent'."
208 "Regexp to match (any TABS followed by) 8/more whitespaces at start of line."
213 "Flag to check end-of-line whitespace. This is the global for the system.
214 It can be overriden by setting a buffer local variable
215 `whitespace-check-buffer-ateol'."
219 ;; (defcustom whitespace-ateol-regexp "[ \t]$"
221 "Regexp to match a TAB or a space at the EOL."
226 "The name of the buffer where whitespace related messages will be logged."
231 "If non-nil, this message will be displayed after a whitespace check
232 determines a file to be clean."
237 "While writing a file, abort if the file is unclean.
238 If `whitespace-auto-cleanup' is set, that takes precedence over
239 this variable."
244 "Cleanup a buffer automatically on finding it whitespace unclean."
249 "All whitespace errors will be shown only in the modeline when t.
251 Note that setting this may cause all whitespaces introduced in a file to go
252 unnoticed when the buffer is killed, unless the user visits the `*Whitespace
253 Errors*' buffer before opening (or closing) another file."
258 c-mode c++-mode cc-mode
259 change-log-mode cperl-mode
260 electric-nroff-mode emacs-lisp-mode
261 f90-mode fortran-mode html-mode
262 html3-mode java-mode jde-mode
263 ksh-mode latex-mode LaTeX-mode
264 lisp-mode m4-mode makefile-mode
265 modula-2-mode nroff-mode objc-mode
266 pascal-mode perl-mode prolog-mode
267 python-mode scheme-mode sgml-mode
268 sh-mode shell-script-mode simula-mode
269 tcl-mode tex-mode texinfo-mode
270 vrml-mode xml-mode)
272 "Major modes in which we turn on whitespace checking.
274 These are mostly programming and documentation modes. But you may add other
275 modes that you want whitespaces checked in by adding something like the
276 following to your `.emacs':
278 \(setq whitespace-modes (cons 'my-mode (cons 'my-other-mode
279 whitespace-modes))\)
281 Or, alternately, you can use the Emacs `customize' command to set this."
286 "Period in seconds to rescan modified buffers for whitespace creep.
288 This is the period after which the timer will fire causing
289 `whitespace-rescan-files-in-buffers' to check for whitespace creep in
290 modified buffers.
292 To disable timer scans, set this to zero."
297 "Display whitespace errors on the modeline."
302 "Display the bogus whitespaces by coloring them with the face
303 `whitespace-highlight'."
308 "Faces used in whitespace."
323 "Face used for highlighting the bogus whitespaces that exist in the buffer."
325 ;; backward-compatibility alias
330 minor-mode-alist)))
333 whitespace-check-leading-whitespace)
335 whitespace-check-trailing-whitespace)
337 whitespace-check-indent-whitespace)
339 whitespace-check-spacetab-whitespace)
341 whitespace-check-ateol-whitespace)
344 "Test and set the whitespace-mode in qualifying buffers."
348 t
349 nil))))
351 ;;;###autoload
353 "Toggle the check for leading space in the local buffer."
361 ;;;###autoload
363 "Toggle the check for trailing space in the local buffer."
371 ;;;###autoload
373 "Toggle the check for indentation space in the local buffer."
382 ;;;###autoload
384 "Toggle the check for space-followed-by-TABs in the local buffer."
394 ;;;###autoload
396 "Toggle the check for end-of-line space in the local buffer."
406 ;;;###autoload
408 "Find five different types of white spaces in buffer.
409 These are:
410 1. Leading space \(empty lines at the top of a file\).
411 2. Trailing space \(empty lines at the end of a file\).
412 3. Indentation space \(8 or more spaces, that should be replaced with TABS\).
413 4. Spaces followed by a TAB. \(Almost always, we never want that\).
414 5. Spaces or TABS at the end of a line.
416 Check for whitespace only if this buffer really contains a non-empty file
417 and:
418 1. the major mode is one of the whitespace-modes, or
419 2. `whitespace-buffer' was explicitly called with a prefix argument."
435 nil))
438 nil))
441 whitespace-indent-regexp)
442 nil))
445 whitespace-spacetab-regexp)
446 nil))
449 whitespace-ateol-regexp)
450 nil))
455 ;; Now let's complain if we found any of the above.
457 whitespace-spacetab whitespace-ateol
458 whitespace-trailing))
496 whitespace-this-modeline
502 whitespace-filename)))
505 whitespace-clean-msg))))))))
506 whitespace-error))
508 ;;;###autoload
510 "Check the region for whitespace errors."
517 ;;;###autoload
519 "Cleanup the five different kinds of whitespace problems.
522 whitespace problems."
524 ;; If this buffer really contains a file, then run, else quit.
531 ;; since all printable TABS should be 8, irrespective of how
532 ;; they are displayed.
565 ;; Call this recursively till everything is taken care of
574 ;;;###autoload
576 "Whitespace cleanup on the region."
585 "Check to see if there are any empty lines at the top of the file."
597 t)
598 nil))))
601 "Remove any empty lines at the top of the file."
608 "Check to see if are is more than one empty line at the bottom."
627 t)
628 nil))
629 nil))))
632 "Delete all the empty lines at the bottom."
641 "Search for any given whitespace REGEXP."
651 nil
652 whitespace-retval))))
655 "Search for any given whitespace REGEXP and replace it with the NEWREGEXP."
662 "Search for 8/more spaces at the start of a line and replace it with tabs."
672 "Return the list of whitespaces whose testing has been suppressed."
680 unchecked-spaces
681 nil)))
684 "Update modeline with whitespace errors.
685 Also with whitespaces whose testing has been turned off."
689 ;; Whitespace errors
692 ;; Whitespace suppressed errors
697 ;; Add the whitespace modeline prefix
700 nil))
704 "Highlight the current line, unhighlighting a previously jumped to line."
709 ;; (add-hook 'pre-command-hook 'whitespace-unhighlight-the-space))
712 "Unhighlight the currently highlight line."
720 "Add a buffer and its file to the whitespace monitor list.
722 The buffer named BUF-NAME and its associated file BUF-FILE are now monitored
723 periodically for whitespace."
725 whitespace-all-buffer-files)))
729 "Tickle timer to periodically to scan qualifying files for whitespace creep.
731 If timer is not set, then set it to scan the files in
732 `whitespace-all-buffer-files' periodically (defined by
733 `whitespace-rescan-timer-time') for whitespace creep."
737 'whitespace-rescan-files-in-buffers nil
738 whitespace-rescan-timer-time))))
741 "Check monitored files for whitespace creep since last scan."
743 buffile bufname thiselt buf)
756 ;;(message "buffer %s live" bufname)
760 ;;(message "checking for whitespace in %s" bufname)
763 ;;(message "cleaning up whitespace in %s" bufname)
766 ;;(message "whitespace-buffer %s." (buffer-name))
768 ;;(message "Removing %s from refresh list" bufname)
770 ;;(message "Removing %s from refresh list" bufname)
774 "Refresh the list of files to be rescaned for whitespace creep."
782 ;;;###autoload
785 ;;;###autoload
787 "Toggle using Whitespace mode in new buffers.
788 With ARG, turn the mode on iff ARG is positive.
790 When this mode is active, `whitespace-buffer' is added to
791 `find-file-hook' and `kill-buffer-hook'."
792 :global t
803 ;;;###autoload
805 "Hook function to be called on the buffer when whitespace check is enabled.
806 This is meant to be added buffer-locally to `write-file-functions'."
814 buffer-file-name))))
815 nil)
826 ;; arch-tag: 4ff44e87-b63c-402d-95a6-15e51e58bd0c
827 ;;; whitespace.el ends here