| blob | a833e85fa3f7be97b6525cb566db4820600c0ba6 |
1 ;;; whitespace.el --- warn about and clean bogus whitespaces in the file
3 ;; Copyright (C) 1999, 2000 Free Software Foundation, Inc.
5 ;; Author: Rajesh Vaidheeswarran <rv@gnu.org>
6 ;; Keywords: convenience
8 ;; $Id: whitespace.el,v 1.24 2003/06/11 03:50:45 rv Exp $
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., 59 Temple Place - Suite 330,
24 ;; Boston, MA 02111-1307, 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
147 defgroup"
148 t))
151 "Macro to alias defcustom to defvar in all versions of Emacs that
152 don't define defcustom"
172 "Check for and fix five different types of whitespaces in source code."
173 ;; Since XEmacs doesn't have a 'convenience group, use the next best group
174 ;; which is 'editing?
178 "Check for and fix five different types of whitespaces in source code."
184 "Flag to check leading whitespace. This is the global for the system.
185 It can be overriden by setting a buffer local variable
186 `whitespace-check-buffer-leading'"
191 "Flag to check trailing whitespace. This is the global for the system.
192 It can be overriden by setting a buffer local variable
193 `whitespace-check-buffer-trailing'"
198 "Flag to check space followed by a TAB. This is the global for the system.
199 It can be overriden by setting a buffer local variable
200 `whitespace-check-buffer-spacetab'"
205 "Regexp to match a space followed by a TAB."
210 "Flag to check indentation whitespace. This is the global for the system.
211 It can be overriden by setting a buffer local variable
212 `whitespace-check-buffer-indent'"
217 "Regexp to match (any TABS followed by) 8/more whitespaces at start of line."
222 "Flag to check end-of-line whitespace. This is the global for the system.
223 It can be overriden by setting a buffer local variable
224 `whitespace-check-buffer-ateol'"
228 ;; (defcustom whitespace-ateol-regexp "[ \t]$"
230 "Regexp to match a TAB or a space at the EOL."
235 "The name of the buffer where whitespace related messages will be logged."
240 "While writing a file, abort if the file is unclean. If
241 `whitespace-auto-cleanup' is set, that takes precedence over this
242 variable."
247 "Cleanup a buffer automatically on finding it whitespace unclean."
252 "All whitespace errors will be shown only in the modeline when t.
254 Note that setting this may cause all whitespaces introduced in a file to go
255 unnoticed when the buffer is killed, unless the user visits the `*Whitespace
256 Errors*' buffer before opening (or closing) another file."
261 c-mode c++-mode cc-mode
262 change-log-mode cperl-mode
263 electric-nroff-mode emacs-lisp-mode
264 f90-mode fortran-mode html-mode
265 html3-mode java-mode jde-mode
266 ksh-mode latex-mode LaTeX-mode
267 lisp-mode m4-mode makefile-mode
268 modula-2-mode nroff-mode objc-mode
269 pascal-mode perl-mode prolog-mode
270 python-mode scheme-mode sgml-mode
271 sh-mode shell-script-mode simula-mode
272 tcl-mode tex-mode texinfo-mode
273 vrml-mode xml-mode)
275 "Major Modes in which we turn on whitespace checking.
277 These are mostly programming and documentation modes. But you may add other
278 modes that you want whitespaces checked in by adding something like the
279 following to your `.emacs':
281 \(setq whitespace-modes (cons 'my-mode (cons 'my-other-mode
282 whitespace-modes))\)
284 Or, alternately, you can use the Emacs `customize' command to set this."
289 "Period in seconds to rescan modified buffers for whitespace creep.
291 This is the period after which the timer will fire causing
292 `whitespace-rescan-files-in-buffers' to check for whitespace creep in
293 modified buffers.
295 To disable timer scans, set this to zero."
300 "Display whitespace errors on the modeline."
305 "Display the bogus whitespaces by coloring them with
306 `whitespace-highlight-face'."
311 "Faces used in whitespace."
326 "Face used for highlighting the bogus whitespaces that exist in the buffer."
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."
436 nil))
439 nil))
442 whitespace-indent-regexp)
443 nil))
446 whitespace-spacetab-regexp)
447 nil))
450 whitespace-ateol-regexp)
451 nil))
456 ;; Now let's complain if we found any of the above.
458 whitespace-spacetab whitespace-ateol
459 whitespace-trailing))
499 whitespace-this-modeline
505 whitespace-filename)))
509 t
510 nil)))
512 ;;;###autoload
514 "Check the region for whitespace errors."
521 ;;;###autoload
523 "Cleanup the five different kinds of whitespace problems.
526 whitespace 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
578 ;;;###autoload
580 "Whitespace cleanup on the region."
589 "Check to see if there are any empty lines at the top of the file."
601 t)
602 nil))))
605 "Remove any empty lines at the top of the file."
620 "Check to see if are is more than one empty line at the bottom."
639 t)
640 nil))
641 nil))))
644 "Delete all the empty lines at the bottom."
668 "Search for any given whitespace REGEXP."
678 nil
679 whitespace-retval))))
682 "Search for any given whitespace REGEXP and replace it with the NEWREGEXP."
689 "Search for 8/more spaces at the start of a line and replace it with tabs."
699 "Return the list of whitespaces whose testing has been suppressed."
707 unchecked-spaces
708 nil)))
711 "Update modeline with whitespace errors.
712 Also with whitespaces whose testing has been turned off."
716 ;; Whitespace errors
719 ;; Whitespace suppressed errors
724 ;; Add the whitespace modeline prefix
727 nil))
731 "Highlight the current line, unhighlighting a previously jumped to line."
739 ;; (add-hook 'pre-command-hook 'whitespace-unhighlight-the-space))
742 "Unhighlight the currently highlight line."
754 "Add a buffer and its file to the whitespace monitor list.
756 The buffer named BUF-NAME and its associated file BUF-FILE are now monitored
757 periodically for whitespace."
759 whitespace-all-buffer-files)))
763 "Tickle timer to periodically to scan qualifying files for whitespace creep.
765 If timer is not set, then set it to scan the files in
766 `whitespace-all-buffer-files' periodically (defined by
767 `whitespace-rescan-timer-time') for whitespace creep."
771 'whitespace-rescan-files-in-buffers nil
772 whitespace-rescan-timer-time))))
775 "Check monitored files for whitespace creep since last scan."
777 buffile bufname thiselt buf)
790 ;;(message "buffer %s live" bufname)
794 ;;(message "checking for whitespace in %s" bufname)
797 ;;(message "cleaning up whitespace in %s" bufname)
800 ;;(message "whitespace-buffer %s." (buffer-name))
802 ;;(message "Removing %s from refresh list" bufname)
804 ;;(message "Removing %s from refresh list" bufname)
808 "Refresh the list of files to be rescaned for whitespace creep."
816 ;;;###autoload
818 "Toggle using Whitespace mode in new buffers.
819 With ARG, turn the mode on if and only iff ARG is positive.
821 When this mode is active, `whitespace-buffer' is added to
822 `find-file-hook' and `kill-buffer-hook'."
823 :global t
834 ;;;###autoload
836 "Hook function to be called on the buffer when whitespace check is enabled.
837 This is meant to be added buffer-locally to `write-file-functions'."
845 buffer-file-name))))
846 nil)
854 ;;; whitespace.el ends here