| blob | a5ae328f500b8e35f0f4d67ed5fbca9d59cedfba |
1 ;;; whitespace.el --- warn about and clean bogus whitespaces in the file
3 ;; Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004,
4 ;; 2005, 2006 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 2, 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
142 ;; For flavors of Emacs which don't define `defgroup' and `defcustom'.
146 "Null macro for `defgroup' in all versions of Emacs that don't define it."
147 t))
150 "Macro to alias `defcustom' to `defvar' in all versions of Emacs that
151 don't define it."
168 "Check for and fix five different types of whitespaces in source code."
171 ;; Since XEmacs doesn't have a 'convenience group, use the next best group
172 ;; which is 'editing?
176 "Flag to check leading whitespace. This is the global for the system.
177 It can be overriden by setting a buffer local variable
178 `whitespace-check-buffer-leading'."
183 "Flag to check trailing whitespace. This is the global for the system.
184 It can be overriden by setting a buffer local variable
185 `whitespace-check-buffer-trailing'."
190 "Flag to check space followed by a TAB. This is the global for the system.
191 It can be overriden by setting a buffer local variable
192 `whitespace-check-buffer-spacetab'."
197 "Regexp to match one or more spaces followed by a TAB."
202 "Flag to check indentation whitespace. This is the global for the system.
203 It can be overriden by setting a buffer local variable
204 `whitespace-check-buffer-indent'."
209 "Regexp to match multiples of eight spaces near line beginnings.
210 The default value ignores leading TABs."
215 "Flag to check end-of-line whitespace. This is the global for the system.
216 It can be overriden by setting a buffer local variable
217 `whitespace-check-buffer-ateol'."
222 "Regexp to match one or more TABs or spaces at line ends."
227 "The name of the buffer where whitespace related messages will be logged."
232 "If non-nil, this message will be displayed after a whitespace check
233 determines a file to be clean."
238 "While writing a file, abort if the file is unclean.
239 If `whitespace-auto-cleanup' is set, that takes precedence over
240 this variable."
245 "Cleanup a buffer automatically on finding it whitespace unclean."
250 "All whitespace errors will be shown only in the modeline when t.
252 Note that setting this may cause all whitespaces introduced in a file to go
253 unnoticed when the buffer is killed, unless the user visits the `*Whitespace
254 Errors*' buffer before opening (or closing) another file."
259 c-mode c++-mode cc-mode
260 change-log-mode cperl-mode
261 electric-nroff-mode emacs-lisp-mode
262 f90-mode fortran-mode html-mode
263 html3-mode java-mode jde-mode
264 ksh-mode latex-mode LaTeX-mode
265 lisp-mode m4-mode makefile-mode
266 modula-2-mode nroff-mode objc-mode
267 pascal-mode perl-mode prolog-mode
268 python-mode scheme-mode sgml-mode
269 sh-mode shell-script-mode simula-mode
270 tcl-mode tex-mode texinfo-mode
271 vrml-mode xml-mode)
273 "Major modes in which we turn on whitespace checking.
275 These are mostly programming and documentation modes. But you may add other
276 modes that you want whitespaces checked in by adding something like the
277 following to your `.emacs':
279 \(setq whitespace-modes (cons 'my-mode (cons 'my-other-mode
280 whitespace-modes))\)
282 Or, alternately, you can use the Emacs `customize' command to set this."
287 "Period in seconds to rescan modified buffers for whitespace creep.
289 This is the period after which the timer will fire causing
290 `whitespace-rescan-files-in-buffers' to check for whitespace creep in
291 modified buffers.
293 To disable timer scans, set this to zero."
298 "Display whitespace errors on the modeline."
303 "Display the bogus whitespaces by coloring them with the face
304 `whitespace-highlight'."
309 "Faces used in whitespace."
324 "Face used for highlighting the bogus whitespaces that exist in the buffer."
326 ;; backward-compatibility alias
331 minor-mode-alist)))
334 whitespace-check-leading-whitespace)
336 whitespace-check-trailing-whitespace)
338 whitespace-check-indent-whitespace)
340 whitespace-check-spacetab-whitespace)
342 whitespace-check-ateol-whitespace)
345 "Test and set the whitespace-mode in qualifying buffers."
349 t
350 nil))))
352 ;;;###autoload
354 "Toggle the check for leading space in the local buffer."
362 ;;;###autoload
364 "Toggle the check for trailing space in the local buffer."
372 ;;;###autoload
374 "Toggle the check for indentation space in the local buffer."
383 ;;;###autoload
385 "Toggle the check for space-followed-by-TABs in the local buffer."
395 ;;;###autoload
397 "Toggle the check for end-of-line space in the local buffer."
407 ;;;###autoload
409 "Find five different types of white spaces in buffer.
410 These are:
411 1. Leading space \(empty lines at the top of a file\).
412 2. Trailing space \(empty lines at the end of a file\).
413 3. Indentation space \(8 or more spaces, that should be replaced with TABS\).
414 4. Spaces followed by a TAB. \(Almost always, we never want that\).
415 5. Spaces or TABS at the end of a line.
417 Check for whitespace only if this buffer really contains a non-empty file
418 and:
419 1. the major mode is one of the whitespace-modes, or
420 2. `whitespace-buffer' was explicitly called with a prefix argument."
437 nil))
440 nil))
443 whitespace-indent-regexp)
444 nil))
447 whitespace-spacetab-regexp)
448 nil))
451 whitespace-ateol-regexp)
452 nil))
457 ;; Now let's complain if we found any of the above.
459 whitespace-spacetab whitespace-ateol
460 whitespace-trailing))
498 whitespace-this-modeline
504 whitespace-filename)))
507 whitespace-clean-msg))))))))
508 whitespace-error))
510 ;;;###autoload
512 "Check the region for whitespace errors."
519 ;;;###autoload
521 "Cleanup the five different kinds of whitespace problems.
522 It normally applies to the whole buffer, but in Transient Mark mode
523 when the mark is active it applies to the region.
524 See `whitespace-buffer' docstring for a summary of the problems."
531 ;; If this buffer really contains a file, then run, else quit.
538 ;; since all printable TABS should be 8, irrespective of how
539 ;; they are displayed.
572 ;; Call this recursively till everything is taken care of
575 ;; if we are done, talk to the user
584 ;;;###autoload
586 "Whitespace cleanup on the region."
595 "Return t if the current buffer has leading newline characters.
596 If highlighting is enabled, highlight these characters."
602 t)))
605 "Remove any leading newline characters from current buffer."
612 "Return t if the current buffer has extra trailing newline characters.
613 If highlighting is enabled, highlight these characters."
620 t)))
623 "Remove extra trailing newline characters from current buffer."
632 "Search for any given whitespace REGEXP."
644 "Search for any given whitespace REGEXP and replace it with the NEWREGEXP."
651 "Search for 8/more spaces at the start of a line and replace it with tabs."
661 "Return the list of whitespaces whose testing has been suppressed."
669 unchecked-spaces
670 nil)))
673 "Update modeline with whitespace errors.
674 Also with whitespaces whose testing has been turned off."
678 ;; Whitespace errors
681 ;; Whitespace suppressed errors
686 ;; Add the whitespace modeline prefix
689 nil))
693 "Highlight the current line, unhighlighting a previously jumped to line."
699 "Unhighlight the currently highlight line."
706 "Add a buffer and its file to the whitespace monitor list.
708 The buffer named BUF-NAME and its associated file BUF-FILE are now monitored
709 periodically for whitespace."
711 whitespace-all-buffer-files)))
715 "Tickle timer to periodically to scan qualifying files for whitespace creep.
717 If timer is not set, then set it to scan the files in
718 `whitespace-all-buffer-files' periodically (defined by
719 `whitespace-rescan-timer-time') for whitespace creep."
723 'whitespace-rescan-files-in-buffers nil
724 whitespace-rescan-timer-time))))
727 "Check monitored files for whitespace creep since last scan."
729 buffile bufname thiselt buf)
742 ;;(message "buffer %s live" bufname)
746 ;;(message "checking for whitespace in %s" bufname)
749 ;;(message "cleaning up whitespace in %s" bufname)
752 ;;(message "whitespace-buffer %s." (buffer-name))
754 ;;(message "Removing %s from refresh list" bufname)
756 ;;(message "Removing %s from refresh list" bufname)
760 "Refresh the list of files to be rescanned for whitespace creep."
768 ;;;###autoload
771 ;;;###autoload
773 "Toggle using Whitespace mode in new buffers.
774 With ARG, turn the mode on iff ARG is positive.
776 When this mode is active, `whitespace-buffer' is added to
777 `find-file-hook' and `kill-buffer-hook'."
778 :global t
789 ;;;###autoload
791 "Hook function to be called on the buffer when whitespace check is enabled.
792 This is meant to be added buffer-locally to `write-file-functions'."
800 buffer-file-name))))
801 nil)
812 ;; arch-tag: 4ff44e87-b63c-402d-95a6-15e51e58bd0c
813 ;;; whitespace.el ends here