| blob | c0d9280a4415e6efa66df36683aaf89932c1b2f9 |
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., 59 Temple Place - Suite 330,
23 ;; Boston, MA 02111-1307, 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
146 defgroup"
147 t))
150 "Macro to alias defcustom to defvar in all versions of Emacs that
151 don't define defcustom"
171 "Check for and fix five different types of whitespaces in source code."
172 ;; Since XEmacs doesn't have a 'convenience group, use the next best group
173 ;; which is 'editing?
177 "Check for and fix five different types of whitespaces in source code."
183 "Flag to check leading whitespace. This is the global for the system.
184 It can be overriden by setting a buffer local variable
185 `whitespace-check-buffer-leading'"
190 "Flag to check trailing whitespace. This is the global for the system.
191 It can be overriden by setting a buffer local variable
192 `whitespace-check-buffer-trailing'"
197 "Flag to check space followed by a TAB. This is the global for the system.
198 It can be overriden by setting a buffer local variable
199 `whitespace-check-buffer-spacetab'"
204 "Regexp to match a space followed by a TAB."
209 "Flag to check indentation whitespace. This is the global for the system.
210 It can be overriden by setting a buffer local variable
211 `whitespace-check-buffer-indent'"
216 "Regexp to match (any TABS followed by) 8/more whitespaces at start of line."
221 "Flag to check end-of-line whitespace. This is the global for the system.
222 It can be overriden by setting a buffer local variable
223 `whitespace-check-buffer-ateol'"
227 ;; (defcustom whitespace-ateol-regexp "[ \t]$"
229 "Regexp to match a TAB or a space at the EOL."
234 "The name of the buffer where whitespace related messages will be logged."
239 "If non-nil, this message will be displayed after a whitespace check
240 determines a file to be clean."
245 "While writing a file, abort if the file is unclean. If
246 `whitespace-auto-cleanup' is set, that takes precedence over this
247 variable."
252 "Cleanup a buffer automatically on finding it whitespace unclean."
257 "All whitespace errors will be shown only in the modeline when t.
259 Note that setting this may cause all whitespaces introduced in a file to go
260 unnoticed when the buffer is killed, unless the user visits the `*Whitespace
261 Errors*' buffer before opening (or closing) another file."
266 c-mode c++-mode cc-mode
267 change-log-mode cperl-mode
268 electric-nroff-mode emacs-lisp-mode
269 f90-mode fortran-mode html-mode
270 html3-mode java-mode jde-mode
271 ksh-mode latex-mode LaTeX-mode
272 lisp-mode m4-mode makefile-mode
273 modula-2-mode nroff-mode objc-mode
274 pascal-mode perl-mode prolog-mode
275 python-mode scheme-mode sgml-mode
276 sh-mode shell-script-mode simula-mode
277 tcl-mode tex-mode texinfo-mode
278 vrml-mode xml-mode)
280 "Major Modes in which we turn on whitespace checking.
282 These are mostly programming and documentation modes. But you may add other
283 modes that you want whitespaces checked in by adding something like the
284 following to your `.emacs':
286 \(setq whitespace-modes (cons 'my-mode (cons 'my-other-mode
287 whitespace-modes))\)
289 Or, alternately, you can use the Emacs `customize' command to set this."
294 "Period in seconds to rescan modified buffers for whitespace creep.
296 This is the period after which the timer will fire causing
297 `whitespace-rescan-files-in-buffers' to check for whitespace creep in
298 modified buffers.
300 To disable timer scans, set this to zero."
305 "Display whitespace errors on the modeline."
310 "Display the bogus whitespaces by coloring them with
311 `whitespace-highlight-face'."
316 "Faces used in whitespace."
331 "Face used for highlighting the bogus whitespaces that exist in the buffer."
336 minor-mode-alist)))
339 whitespace-check-leading-whitespace)
341 whitespace-check-trailing-whitespace)
343 whitespace-check-indent-whitespace)
345 whitespace-check-spacetab-whitespace)
347 whitespace-check-ateol-whitespace)
350 "Test and set the whitespace-mode in qualifying buffers."
354 t
355 nil))))
357 ;;;###autoload
359 "Toggle the check for leading space in the local buffer."
367 ;;;###autoload
369 "Toggle the check for trailing space in the local buffer."
377 ;;;###autoload
379 "Toggle the check for indentation space in the local buffer."
388 ;;;###autoload
390 "Toggle the check for space-followed-by-TABs in the local buffer."
400 ;;;###autoload
402 "Toggle the check for end-of-line space in the local buffer."
412 ;;;###autoload
414 "Find five different types of white spaces in buffer.
415 These are:
416 1. Leading space \(empty lines at the top of a file\).
417 2. Trailing space \(empty lines at the end of a file\).
418 3. Indentation space \(8 or more spaces, that should be replaced with TABS\).
419 4. Spaces followed by a TAB. \(Almost always, we never want that\).
420 5. Spaces or TABS at the end of a line.
422 Check for whitespace only if this buffer really contains a non-empty file
423 and:
424 1. the major mode is one of the whitespace-modes, or
425 2. `whitespace-buffer' was explicitly called with a prefix argument."
441 nil))
444 nil))
447 whitespace-indent-regexp)
448 nil))
451 whitespace-spacetab-regexp)
452 nil))
455 whitespace-ateol-regexp)
456 nil))
461 ;; Now let's complain if we found any of the above.
463 whitespace-spacetab whitespace-ateol
464 whitespace-trailing))
502 whitespace-this-modeline
508 whitespace-filename)))
511 whitespace-clean-msg))))))))
512 whitespace-error))
514 ;;;###autoload
516 "Check the region for whitespace errors."
523 ;;;###autoload
525 "Cleanup the five different kinds of whitespace problems.
528 whitespace problems."
530 ;; If this buffer really contains a file, then run, else quit.
537 ;; since all printable TABS should be 8, irrespective of how
538 ;; they are displayed.
571 ;; Call this recursively till everything is taken care of
580 ;;;###autoload
582 "Whitespace cleanup on the region."
591 "Check to see if there are any empty lines at the top of the file."
603 t)
604 nil))))
607 "Remove any empty lines at the top of the file."
622 "Check to see if are is more than one empty line at the bottom."
641 t)
642 nil))
643 nil))))
646 "Delete all the empty lines at the bottom."
670 "Search for any given whitespace REGEXP."
680 nil
681 whitespace-retval))))
684 "Search for any given whitespace REGEXP and replace it with the NEWREGEXP."
691 "Search for 8/more spaces at the start of a line and replace it with tabs."
701 "Return the list of whitespaces whose testing has been suppressed."
709 unchecked-spaces
710 nil)))
713 "Update modeline with whitespace errors.
714 Also with whitespaces whose testing has been turned off."
718 ;; Whitespace errors
721 ;; Whitespace suppressed errors
726 ;; Add the whitespace modeline prefix
729 nil))
733 "Highlight the current line, unhighlighting a previously jumped to line."
738 ;; (add-hook 'pre-command-hook 'whitespace-unhighlight-the-space))
741 "Unhighlight the currently highlight line."
749 "Add a buffer and its file to the whitespace monitor list.
751 The buffer named BUF-NAME and its associated file BUF-FILE are now monitored
752 periodically for whitespace."
754 whitespace-all-buffer-files)))
758 "Tickle timer to periodically to scan qualifying files for whitespace creep.
760 If timer is not set, then set it to scan the files in
761 `whitespace-all-buffer-files' periodically (defined by
762 `whitespace-rescan-timer-time') for whitespace creep."
766 'whitespace-rescan-files-in-buffers nil
767 whitespace-rescan-timer-time))))
770 "Check monitored files for whitespace creep since last scan."
772 buffile bufname thiselt buf)
785 ;;(message "buffer %s live" bufname)
789 ;;(message "checking for whitespace in %s" bufname)
792 ;;(message "cleaning up whitespace in %s" bufname)
795 ;;(message "whitespace-buffer %s." (buffer-name))
797 ;;(message "Removing %s from refresh list" bufname)
799 ;;(message "Removing %s from refresh list" bufname)
803 "Refresh the list of files to be rescaned for whitespace creep."
811 ;;;###autoload
814 ;;;###autoload
816 "Toggle using Whitespace mode in new buffers.
817 With ARG, turn the mode on iff ARG is positive.
819 When this mode is active, `whitespace-buffer' is added to
820 `find-file-hook' and `kill-buffer-hook'."
821 :global t
832 ;;;###autoload
834 "Hook function to be called on the buffer when whitespace check is enabled.
835 This is meant to be added buffer-locally to `write-file-functions'."
843 buffer-file-name))))
844 nil)
855 ;; arch-tag: 4ff44e87-b63c-402d-95a6-15e51e58bd0c
856 ;;; whitespace.el ends here