| blob | e8c4dd4b9dd180a83e465fde3c862b55bc5b93d6 |
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.18 2001/08/20 20:56:08 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:
28 ;; Whitespace.el URL: http://www.dsmit.com/lisp/
30 ;; Exported functions:
32 ;; `whitespace-buffer' - To check the current buffer for whitespace problems.
33 ;; `whitespace-cleanup' - To cleanup all whitespaces in the current buffer.
34 ;; `whitespace-region' - To check between point and mark for whitespace
35 ;; problems.
36 ;; `whitespace-cleanup-region' - To cleanup all whitespaces between point
37 ;; and mark in the current buffer.
38 ;; `whitespace-describe' - A simple introduction to the library.
40 ;;; Code:
45 "An associated list of buffers and files checked for whitespace cleanliness.
47 This is to enable periodic checking of whitespace cleanliness in the files
53 ;; Tell Emacs about this new kind of minor mode
94 ;; For flavors of Emacs which don't define `defgroup' and `defcustom'.
98 "Null macro for defgroup in all versions of Emacs that don't define
99 defgroup"
100 t))
103 "Macro to alias defcustom to defvar in all versions of Emacs that
104 don't define defcustom"
124 "Check for and fix five different types of whitespaces in source code."
125 ;; Since XEmacs doesn't have a 'convenience group, use the next best group
126 ;; which is 'editing?
129 "Check for and fix five different types of whitespaces in source code."
134 "Flag to check leading whitespace. This is the global for the system.
135 It can be overriden by setting a buffer local variable
136 `whitespace-check-buffer-leading'"
141 "Flag to check trailing whitespace. This is the global for the system.
142 It can be overriden by setting a buffer local variable
143 `whitespace-check-buffer-trailing'"
148 "Flag to check space followed by a TAB. This is the global for the system.
149 It can be overriden by setting a buffer local variable
150 `whitespace-check-buffer-spacetab'"
155 "Regexp to match a space followed by a TAB."
160 "Flag to check indentation whitespace. This is the global for the system.
161 It can be overriden by setting a buffer local variable
162 `whitespace-check-buffer-indent'"
167 "Regexp to match (any TABS followed by) 8/more whitespaces at start of line."
172 "Flag to check end-of-line whitespace. This is the global for the system.
173 It can be overriden by setting a buffer local variable
174 `whitespace-check-buffer-ateol'"
178 ;; (defcustom whitespace-ateol-regexp "[ \t]$"
180 "Regexp to match a TAB or a space at the EOL."
185 "The name of the buffer where whitespace related messages will be logged."
190 "While writing a file, abort if the file is unclean. If
191 `whitespace-auto-cleanup' is set, that takes precedence over this
192 variable."
197 "Cleanup a buffer automatically on finding it whitespace unclean."
202 "All whitespace errors will be shown only in the modeline when t.
204 Note that setting this may cause all whitespaces introduced in a file to go
205 unnoticed when the buffer is killed, unless the user visits the `*Whitespace
206 Errors*' buffer before opening (or closing) another file."
211 c-mode c++-mode cc-mode
212 change-log-mode cperl-mode
213 electric-nroff-mode emacs-lisp-mode
214 f90-mode fortran-mode html-mode
215 html3-mode java-mode jde-mode
216 ksh-mode latex-mode LaTeX-mode
217 lisp-mode m4-mode makefile-mode
218 modula-2-mode nroff-mode objc-mode
219 pascal-mode perl-mode prolog-mode
220 python-mode scheme-mode sgml-mode
221 sh-mode shell-script-mode simula-mode
222 tcl-mode tex-mode texinfo-mode
223 vrml-mode xml-mode)
225 "Major Modes in which we turn on whitespace checking.
227 These are mostly programming and documentation modes. But you may add other
228 modes that you want whitespaces checked in by adding something like the
229 following to your `.emacs':
231 \(setq whitespace-modes (cons 'my-mode (cons 'my-other-mode
232 whitespace-modes))\)
234 Or, alternately, you can use the Emacs `customize' command to set this."
239 "Period in seconds to rescan modified buffers for whitespace creep.
241 This is the period after which the timer will fire causing
242 `whitespace-rescan-files-in-buffers' to check for whitespace creep in
243 modified buffers.
245 To disable timer scans, set this to zero."
250 "Display whitespace errors on the modeline."
255 "Display the bogus whitespaces by coloring them with
256 `whitespace-highlight-face'."
261 "Faces used in whitespace."
276 "Face used for highlighting the bogus whitespaces that exist in the buffer."
281 minor-mode-alist)))
284 whitespace-check-leading-whitespace)
286 whitespace-check-trailing-whitespace)
288 whitespace-check-indent-whitespace)
290 whitespace-check-spacetab-whitespace)
292 whitespace-check-ateol-whitespace)
295 "Test and set the whitespace-mode in qualifying buffers."
299 t
300 nil))))
302 ;;;###autoload
304 "Toggle the check for leading space in the local buffer."
312 ;;;###autoload
314 "Toggle the check for trailing space in the local buffer."
322 ;;;###autoload
324 "Toggle the check for indentation space in the local buffer."
333 ;;;###autoload
335 "Toggle the check for space-followed-by-TABs in the local buffer."
345 ;;;###autoload
347 "Toggle the check for end-of-line space in the local buffer."
357 ;;;###autoload
359 "Find five different types of white spaces in buffer.
360 These are:
361 1. Leading space \(empty lines at the top of a file\).
362 2. Trailing space \(empty lines at the end of a file\).
363 3. Indentation space \(8 or more spaces, that should be replaced with TABS\).
364 4. Spaces followed by a TAB. \(Almost always, we never want that\).
365 5. Spaces or TABS at the end of a line.
367 Check for whitespace only if this buffer really contains a non-empty file
368 and:
369 1. the major mode is one of the whitespace-modes, or
370 2. `whitespace-buffer' was explicitly called with a prefix argument."
386 nil))
389 nil))
392 whitespace-indent-regexp)
393 nil))
396 whitespace-spacetab-regexp)
397 nil))
400 whitespace-ateol-regexp)
401 nil))
406 ;; Now let's complain if we found any of the above.
408 whitespace-spacetab whitespace-ateol
409 whitespace-trailing))
449 whitespace-this-modeline
455 whitespace-filename)))
459 t
460 nil)))
462 ;;;###autoload
464 "Check the region for whitespace errors."
471 ;;;###autoload
473 "Cleanup the five different kinds of whitespace problems.
476 whitespace problems."
478 ;; If this buffer really contains a file, then run, else quit.
485 ;; since all printable TABS should be 8, irrespective of how
486 ;; they are displayed.
519 ;; Call this recursively till everything is taken care of
527 ;;;###autoload
529 "Whitespace cleanup on the region."
538 "Check to see if there are any empty lines at the top of the file."
550 t)
551 nil))))
554 "Remove any empty lines at the top of the file."
569 "Check to see if are is more than one empty line at the bottom."
588 t)
589 nil))
590 nil))))
593 "Delete all the empty lines at the bottom."
617 "Search for any given whitespace REGEXP."
627 nil
628 whitespace-retval))))
631 "Search for any given whitespace REGEXP and replace it with the NEWREGEXP."
638 "Search for 8/more spaces at the start of a line and replace it with tabs."
648 "Return the list of whitespaces whose testing has been suppressed."
656 unchecked-spaces
657 nil)))
660 "Update modeline with whitespace errors.
661 Also with whitespaces whose testing has been turned off."
665 ;; Whitespace errors
668 ;; Whitespace suppressed errors
673 ;; Add the whitespace modeline prefix
676 nil))
680 "Highlight the current line, unhighlighting a previously jumped to line."
688 ;; (add-hook 'pre-command-hook 'whitespace-unhighlight-the-space))
691 "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 rescaned for whitespace creep."
765 ;;;###autoload
767 "Toggle global Whitespace mode.
769 Setting this variable directly does not take effect;
771 \(which see)."
779 ;;;###autoload
781 "Toggle using Whitespace mode in new buffers.
782 With ARG, turn the mode on if and only iff ARG is positive.
784 When this mode is active, `whitespace-buffer' is added to
785 `find-file-hooks' and `kill-buffer-hook'."
799 ;;;###autoload
801 "The local-write-file-hook to be called on the buffer when
802 whitespace check is enabled."
810 buffer-file-name))))
811 nil)
813 ;;;###autoload
815 "A summary of whitespaces and what this library can do about them.
817 The whitespace library is intended to find and help fix five different types
818 of whitespace problems that commonly exist in source code.
820 1. Leading space (empty lines at the top of a file).
821 2. Trailing space (empty lines at the end of a file).
822 3. Indentation space (8 or more spaces at beginning of line, that should be
823 replaced with TABS).
824 4. Spaces followed by a TAB. (Almost always, we never want that).
825 5. Spaces or TABS at the end of a line.
827 Whitespace errors are reported in a buffer, and on the modeline.
829 Modeline will show a W:<x>!<y> to denote a particular type of whitespace,
830 where `x' and `y' can be one (or more) of:
832 e - End-of-Line whitespace.
833 i - Indentation whitespace.
834 l - Leading whitespace.
835 s - Space followed by Tab.
836 t - Trailing whitespace.
838 If any of the whitespace checks is turned off, the modeline will display a
839 !<y>.
841 (since (3) is the most controversial one, here is the rationale: Most
842 terminal drivers and printer drivers have TAB configured or even
843 hardcoded to be 8 spaces. (Some of them allow configuration, but almost
844 always they default to 8.)
846 Changing `tab-width' to other than 8 and editing will cause your code to
847 look different from within Emacs, and say, if you cat it or more it, or
848 even print it.
850 Almost all the popular programming modes let you define an offset (like
851 c-basic-offset or perl-indent-level) to configure the offset, so you
852 should never have to set your `tab-width' to be other than 8 in all these
853 modes. In fact, with an indent level of say, 4, 2 TABS will cause Emacs
855 office complain, tell them to use vim, which distinguishes between
856 tabstop and shiftwidth (vi equivalent of our offsets), and also ask them
857 to set smarttab.)
859 All the above have caused (and will cause) unwanted codeline integration and
860 merge problems.
862 whitespace.el will complain if it detects whitespaces on opening a file, and
863 warn you on closing a file also (in case you had inserted any
864 whitespaces during the process of your editing)."
867 whitespace-version))
875 ;;; whitespace.el ends here