| blob | 6f99f07692f9b752857b66d0a4dd52ad3e9d030f |
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.17 2001/08/20 10:05:03 gerd 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
89 ;; For flavors of Emacs which don't define `defgroup' and `defcustom'.
93 "Null macro for defgroup in all versions of Emacs that don't define
94 defgroup"
95 t))
98 "Macro to alias defcustom to defvar in all versions of Emacs that
99 don't define defcustom"
104 "Check for and fix five different types of whitespaces in source code."
105 ;; Since XEmacs doesn't have a 'convenience group, use the next best group
106 ;; which is 'editing?
109 "Check for and fix five different types of whitespaces in source code."
114 "Flag to check leading whitespace. This is the global for the system.
115 It can be overriden by setting a buffer local variable
116 `whitespace-check-buffer-leading'"
121 "Flag to check trailing whitespace. This is the global for the system.
122 It can be overriden by setting a buffer local variable
123 `whitespace-check-buffer-trailing'"
128 "Flag to check space followed by a TAB. This is the global for the system.
129 It can be overriden by setting a buffer local variable
130 `whitespace-check-buffer-spacetab'"
135 "Regexp to match a space followed by a TAB."
140 "Flag to check indentation whitespace. This is the global for the system.
141 It can be overriden by setting a buffer local variable
142 `whitespace-check-buffer-indent'"
147 "Regexp to match (any TABS followed by) 8/more whitespaces at start of line."
152 "Flag to check end-of-line whitespace. This is the global for the system.
153 It can be overriden by setting a buffer local variable
154 `whitespace-check-buffer-ateol'"
159 "Regexp to match a TAB or a space at the EOL."
164 "The name of the buffer where whitespace related messages will be logged."
169 "While writing a file, abort if the file is unclean. If
170 `whitespace-auto-cleanup' is set, that takes precedence over this
171 variable."
176 "Cleanup a buffer automatically on finding it whitespace unclean."
181 "All whitespace errors will be shown only in the modeline when t.
183 Note that setting this may cause all whitespaces introduced in a file to go
184 unnoticed when the buffer is killed, unless the user visits the `*Whitespace
185 Errors*' buffer before opening (or closing) another file."
190 c-mode c++-mode cc-mode
191 change-log-mode cperl-mode
192 electric-nroff-mode emacs-lisp-mode
193 f90-mode fortran-mode html-mode
194 html3-mode java-mode jde-mode
195 ksh-mode latex-mode LaTeX-mode
196 lisp-mode m4-mode makefile-mode
197 modula-2-mode nroff-mode objc-mode
198 pascal-mode perl-mode prolog-mode
199 python-mode scheme-mode sgml-mode
200 sh-mode shell-script-mode simula-mode
201 tcl-mode tex-mode texinfo-mode
202 vrml-mode xml-mode)
204 "Major Modes in which we turn on whitespace checking.
206 These are mostly programming and documentation modes. But you may add other
207 modes that you want whitespaces checked in by adding something like the
208 following to your `.emacs':
210 \(setq whitespace-modes (cons 'my-mode (cons 'my-other-mode
211 whitespace-modes))\)
213 Or, alternately, you can use the Emacs `customize' command to set this."
218 "Period in seconds to rescan modified buffers for whitespace creep.
220 This is the period after which the timer will fire causing
221 `whitespace-rescan-files-in-buffers' to check for whitespace creep in
222 modified buffers.
224 To disable timer scans, set this to zero."
229 "Display whitespace errors on the modeline."
235 minor-mode-alist)))
238 whitespace-check-leading-whitespace)
240 whitespace-check-trailing-whitespace)
242 whitespace-check-indent-whitespace)
244 whitespace-check-spacetab-whitespace)
246 whitespace-check-ateol-whitespace)
249 "Test and set the whitespace-mode in qualifying buffers."
253 t
254 nil))))
256 ;;;###autoload
258 "Toggle the check for leading space in the local buffer."
266 ;;;###autoload
268 "Toggle the check for trailing space in the local buffer."
276 ;;;###autoload
278 "Toggle the check for indentation space in the local buffer."
287 ;;;###autoload
289 "Toggle the check for space-followed-by-TABs in the local buffer."
299 ;;;###autoload
301 "Toggle the check for end-of-line space in the local buffer."
311 ;;;###autoload
313 "Find five different types of white spaces in buffer.
314 These are:
315 1. Leading space \(empty lines at the top of a file\).
316 2. Trailing space \(empty lines at the end of a file\).
317 3. Indentation space \(8 or more spaces, that should be replaced with TABS\).
318 4. Spaces followed by a TAB. \(Almost always, we never want that\).
319 5. Spaces or TABS at the end of a line.
321 Check for whitespace only if this buffer really contains a non-empty file
322 and:
323 1. the major mode is one of the whitespace-modes, or
324 2. `whitespace-buffer' was explicitly called with a prefix argument."
339 nil))
342 nil))
345 whitespace-indent-regexp)
346 nil))
349 whitespace-spacetab-regexp)
350 nil))
353 whitespace-ateol-regexp)
354 nil))
359 ;; Now let's complain if we found any of the above.
361 whitespace-spacetab whitespace-ateol
362 whitespace-trailing))
402 whitespace-this-modeline
408 whitespace-filename)))
412 t
413 nil)))
415 ;;;###autoload
417 "Check the region for whitespace errors."
424 ;;;###autoload
426 "Cleanup the five different kinds of whitespace problems.
429 whitespace problems."
431 ;; If this buffer really contains a file, then run, else quit.
438 ;; since all printable TABS should be 8, irrespective of how
439 ;; they are displayed.
472 ;; Call this recursively till everything is taken care of
480 ;;;###autoload
482 "Whitespace cleanup on the region."
491 "Check to see if there are any empty lines at the top of the file."
501 t
502 nil))))
505 "Remove any empty lines at the top of the file."
520 "Check to see if are is more than one empty line at the bottom."
537 t
538 nil))
539 nil))))
542 "Delete all the empty lines at the bottom."
566 "Search for any given whitespace REGEXP."
574 nil
575 whitespace-retval))))
578 "Search for any given whitespace REGEXP and replace it with the NEWREGEXP."
585 "Search for 8/more spaces at the start of a line and replace it with tabs."
595 "Return the list of whitespaces whose testing has been suppressed."
603 unchecked-spaces
604 nil)))
607 "Update modeline with whitespace errors.
608 Also with whitespaces whose testing has been turned off."
612 ;; Whitespace errors
615 ;; Whitespace suppressed errors
620 ;; Add the whitespace modeline prefix
623 nil))
626 ;; Force mode line updation for different Emacs versions
628 "Force the mode line update for different flavors of Emacs."
634 "Add a buffer and its file to the whitespace monitor list.
636 The buffer named BUF-NAME and its associated file BUF-FILE are now monitored
637 periodically for whitespace."
639 whitespace-all-buffer-files)))
643 "Tickle timer to periodically to scan qualifying files for whitespace creep.
645 If timer is not set, then set it to scan the files in
646 `whitespace-all-buffer-files' periodically (defined by
647 `whitespace-rescan-timer-time') for whitespace creep."
651 'whitespace-rescan-files-in-buffers nil
652 whitespace-rescan-timer-time))))
655 "Check monitored files for whitespace creep since last scan."
657 buffile bufname thiselt buf)
670 ;;(message "buffer %s live" bufname)
674 ;;(message "checking for whitespace in %s" bufname)
677 ;;(message "cleaning up whitespace in %s" bufname)
680 ;;(message "whitespace-buffer %s." (buffer-name))
682 ;;(message "Removing %s from refresh list" bufname)
684 ;;(message "Removing %s from refresh list" bufname)
688 "Refresh the list of files to be rescaned for whitespace creep."
696 ;;;###autoload
698 "Toggle global Whitespace mode.
700 Setting this variable directly does not take effect;
702 \(which see)."
710 ;;;###autoload
712 "Toggle using Whitespace mode in new buffers.
713 With ARG, turn the mode on if and only iff ARG is positive.
715 When this mode is active, `whitespace-buffer' is added to
716 `find-file-hooks' and `kill-buffer-hook'."
730 ;;;###autoload
732 "The local-write-file-hook to be called on the buffer when
733 whitespace check is enabled."
741 buffer-file-name))))
742 nil)
744 ;;;###autoload
746 "A summary of whitespaces and what this library can do about them.
748 The whitespace library is intended to find and help fix five different types
749 of whitespace problems that commonly exist in source code.
751 1. Leading space (empty lines at the top of a file).
752 2. Trailing space (empty lines at the end of a file).
753 3. Indentation space (8 or more spaces at beginning of line, that should be
754 replaced with TABS).
755 4. Spaces followed by a TAB. (Almost always, we never want that).
756 5. Spaces or TABS at the end of a line.
758 Whitespace errors are reported in a buffer, and on the modeline.
760 Modeline will show a W:<x>!<y> to denote a particular type of whitespace,
761 where `x' and `y' can be one (or more) of:
763 e - End-of-Line whitespace.
764 i - Indentation whitespace.
765 l - Leading whitespace.
766 s - Space followed by Tab.
767 t - Trailing whitespace.
769 If any of the whitespace checks is turned off, the modeline will display a
770 !<y>.
772 (since (3) is the most controversial one, here is the rationale: Most
773 terminal drivers and printer drivers have TAB configured or even
774 hardcoded to be 8 spaces. (Some of them allow configuration, but almost
775 always they default to 8.)
777 Changing `tab-width' to other than 8 and editing will cause your code to
778 look different from within Emacs, and say, if you cat it or more it, or
779 even print it.
781 Almost all the popular programming modes let you define an offset (like
782 c-basic-offset or perl-indent-level) to configure the offset, so you
783 should never have to set your `tab-width' to be other than 8 in all these
784 modes. In fact, with an indent level of say, 4, 2 TABS will cause Emacs
786 office complain, tell them to use vim, which distinguishes between
787 tabstop and shiftwidth (vi equivalent of our offsets), and also ask them
788 to set smarttab.)
790 All the above have caused (and will cause) unwanted codeline integration and
791 merge problems.
793 whitespace.el will complain if it detects whitespaces on opening a file, and
794 warn you on closing a file also (in case you had inserted any
795 whitespaces during the process of your editing)."
798 whitespace-version))
807 ;;; whitespace.el ends here