| blob | 02c8115f23a961a685aa7cf7b12b918d903a93ae |
1 ;;; whitespace.el --- warn about and clean bogus whitespaces in the file
3 ;; Copyright (C) 1999-2012 Free Software Foundation, Inc.
5 ;; Author: Rajesh Vaidheeswarran <rv@gnu.org>
6 ;; Keywords: convenience
7 ;; Obsolete-since: 23.1
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 3 of the License, or
14 ;; (at your option) 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. If not, see <http://www.gnu.org/licenses/>.
24 ;;; Commentary:
26 ;; URL: http://www.dsmit.com/lisp/
27 ;;
28 ;; The whitespace library is intended to find and help fix five different types
29 ;; of whitespace problems that commonly exist in source code.
30 ;;
31 ;; 1. Leading space (empty lines at the top of a file).
32 ;; 2. Trailing space (empty lines at the end of a file).
33 ;; 3. Indentation space (8 or more spaces at beginning of line, that should be
34 ;; replaced with TABS).
35 ;; 4. Spaces followed by a TAB. (Almost always, we never want that).
36 ;; 5. Spaces or TABS at the end of a line.
37 ;;
38 ;; Whitespace errors are reported in a buffer, and on the mode line.
39 ;;
40 ;; Mode line will show a W:<x>!<y> to denote a particular type of whitespace,
41 ;; where `x' and `y' can be one (or more) of:
42 ;;
43 ;; e - End-of-Line whitespace.
44 ;; i - Indentation whitespace.
45 ;; l - Leading whitespace.
46 ;; s - Space followed by Tab.
47 ;; t - Trailing whitespace.
48 ;;
49 ;; If any of the whitespace checks is turned off, the mode line will display a
50 ;; !<y>.
51 ;;
52 ;; (since (3) is the most controversial one, here is the rationale: Most
53 ;; terminal drivers and printer drivers have TAB configured or even
54 ;; hardcoded to be 8 spaces. (Some of them allow configuration, but almost
55 ;; always they default to 8.)
56 ;;
57 ;; Changing `tab-width' to other than 8 and editing will cause your code to
58 ;; look different from within Emacs, and say, if you cat it or more it, or
59 ;; even print it.
60 ;;
61 ;; Almost all the popular programming modes let you define an offset (like
62 ;; c-basic-offset or perl-indent-level) to configure the offset, so you
63 ;; should never have to set your `tab-width' to be other than 8 in all
64 ;; these modes. In fact, with an indent level of say, 4, 2 TABS will cause
65 ;; Emacs to replace your 8 spaces with one \t (try it). If vi users in
66 ;; your office complain, tell them to use vim, which distinguishes between
67 ;; tabstop and shiftwidth (vi equivalent of our offsets), and also ask them
68 ;; to set smarttab.)
69 ;;
70 ;; All the above have caused (and will cause) unwanted codeline integration and
71 ;; merge problems.
72 ;;
73 ;; whitespace.el will complain if it detects whitespaces on opening a file, and
74 ;; warn you on closing a file also (in case you had inserted any
75 ;; whitespaces during the process of your editing).
76 ;;
77 ;; Exported functions:
78 ;;
79 ;; `whitespace-buffer' - To check the current buffer for whitespace problems.
80 ;; `whitespace-cleanup' - To cleanup all whitespaces in the current buffer.
81 ;; `whitespace-region' - To check between point and mark for whitespace
82 ;; problems.
83 ;; `whitespace-cleanup-region' - To cleanup all whitespaces between point
84 ;; and mark in the current buffer.
86 ;;; Code:
91 "An associated list of buffers and files checked for whitespace cleanliness.
93 This is to enable periodic checking of whitespace cleanliness in the files
99 ;; Tell Emacs about this new kind of minor mode
111 ;;;###autoload(put 'whitespace-check-buffer-leading 'safe-local-variable 'booleanp)
116 ;;;###autoload(put 'whitespace-check-buffer-trailing 'safe-local-variable 'booleanp)
121 ;;;###autoload(put 'whitespace-check-buffer-indent 'safe-local-variable 'booleanp)
126 ;;;###autoload(put 'whitespace-check-buffer-spacetab 'safe-local-variable 'booleanp)
131 ;;;###autoload(put 'whitespace-check-buffer-ateol 'safe-local-variable 'booleanp)
151 "Check for and fix five different types of whitespaces in source code."
154 ;; Since XEmacs doesn't have a 'convenience group, use the next best group
155 ;; which is 'editing?
159 "Flag to check leading whitespace. This is the global for the system.
160 It can be overridden by setting a buffer local variable
161 `whitespace-check-buffer-leading'."
166 "Flag to check trailing whitespace. This is the global for the system.
167 It can be overridden by setting a buffer local variable
168 `whitespace-check-buffer-trailing'."
173 "Flag to check space followed by a TAB. This is the global for the system.
174 It can be overridden by setting a buffer local variable
175 `whitespace-check-buffer-spacetab'."
180 "Regexp to match one or more spaces followed by a TAB."
185 "Flag to check indentation whitespace. This is the global for the system.
186 It can be overridden by setting a buffer local variable
187 `whitespace-check-buffer-indent'."
192 "Regexp to match multiples of eight spaces near line beginnings.
193 The default value ignores leading TABs."
198 "Flag to check end-of-line whitespace. This is the global for the system.
199 It can be overridden by setting a buffer local variable
200 `whitespace-check-buffer-ateol'."
205 "Regexp to match one or more TABs or spaces at line ends."
210 "The name of the buffer where whitespace related messages will be logged."
215 "If non-nil, this message will be displayed after a whitespace check
216 determines a file to be clean."
221 "While writing a file, abort if the file is unclean.
222 If `whitespace-auto-cleanup' is set, that takes precedence over
223 this variable."
228 "Cleanup a buffer automatically on finding it whitespace unclean."
233 "All whitespace errors will be shown only in the mode line when t.
235 Note that setting this may cause all whitespaces introduced in a file to go
236 unnoticed when the buffer is killed, unless the user visits the `*Whitespace
237 Errors*' buffer before opening (or closing) another file."
242 c-mode c++-mode cc-mode
243 change-log-mode cperl-mode
244 electric-nroff-mode emacs-lisp-mode
245 f90-mode fortran-mode html-mode
246 html3-mode java-mode jde-mode
247 ksh-mode latex-mode LaTeX-mode
248 lisp-mode m4-mode makefile-mode
249 modula-2-mode nroff-mode objc-mode
250 pascal-mode perl-mode prolog-mode
251 python-mode scheme-mode sgml-mode
252 sh-mode shell-script-mode simula-mode
253 tcl-mode tex-mode texinfo-mode
254 vrml-mode xml-mode)
256 "Major modes in which we turn on whitespace checking.
258 These are mostly programming and documentation modes. But you may add other
259 modes that you want whitespaces checked in by adding something like the
260 following to your `.emacs':
262 \(setq whitespace-modes (cons 'my-mode (cons 'my-other-mode
263 whitespace-modes))\)
265 Or, alternately, you can use the Emacs `customize' command to set this."
270 "Period in seconds to rescan modified buffers for whitespace creep.
272 This is the period after which the timer will fire causing
273 `whitespace-rescan-files-in-buffers' to check for whitespace creep in
274 modified buffers.
276 To disable timer scans, set this to zero."
281 "Display whitespace errors on the modeline."
286 "Display the bogus whitespaces by coloring them with the face
287 `whitespace-highlight'."
292 "Faces used in whitespace."
307 "Face used for highlighting the bogus whitespaces that exist in the buffer."
314 minor-mode-alist)))
317 whitespace-check-leading-whitespace)
319 whitespace-check-trailing-whitespace)
321 whitespace-check-indent-whitespace)
323 whitespace-check-spacetab-whitespace)
325 whitespace-check-ateol-whitespace)
328 "Test and set the whitespace-mode in qualifying buffers."
332 t
333 nil))))
335 ;;;###autoload
337 "Toggle the check for leading space in the local buffer."
345 ;;;###autoload
347 "Toggle the check for trailing space in the local buffer."
355 ;;;###autoload
357 "Toggle the check for indentation space in the local buffer."
366 ;;;###autoload
368 "Toggle the check for space-followed-by-TABs in the local buffer."
378 ;;;###autoload
380 "Toggle the check for end-of-line space in the local buffer."
390 ;;;###autoload
392 "Find five different types of white spaces in buffer.
393 These are:
394 1. Leading space \(empty lines at the top of a file\).
395 2. Trailing space \(empty lines at the end of a file\).
396 3. Indentation space \(8 or more spaces, that should be replaced with TABS\).
397 4. Spaces followed by a TAB. \(Almost always, we never want that\).
398 5. Spaces or TABS at the end of a line.
400 Check for whitespace only if this buffer really contains a non-empty file
401 and:
402 1. the major mode is one of the whitespace-modes, or
403 2. `whitespace-buffer' was explicitly called with a prefix argument."
420 nil))
423 nil))
426 whitespace-indent-regexp)
427 nil))
430 whitespace-spacetab-regexp)
431 nil))
434 whitespace-ateol-regexp)
435 nil))
440 ;; Now let's complain if we found any of the above.
442 whitespace-spacetab whitespace-ateol
443 whitespace-trailing))
481 whitespace-this-modeline
487 whitespace-filename)))
490 whitespace-clean-msg))))))))
491 whitespace-error))
493 ;;;###autoload
495 "Check the region for whitespace errors."
502 ;;;###autoload
504 "Cleanup the five different kinds of whitespace problems.
505 It normally applies to the whole buffer, but in Transient Mark mode
506 when the mark is active it applies to the region.
507 See `whitespace-buffer' docstring for a summary of the problems."
514 ;; If this buffer really contains a file, then run, else quit.
521 ;; since all printable TABS should be 8, irrespective of how
522 ;; they are displayed.
555 ;; Call this recursively till everything is taken care of
558 ;; if we are done, talk to the user
567 ;;;###autoload
569 "Whitespace cleanup on the region."
578 "Return t if the current buffer has leading newline characters.
579 If highlighting is enabled, highlight these characters."
585 t)))
588 "Remove any leading newline characters from current buffer."
595 "Return t if the current buffer has extra trailing newline characters.
596 If highlighting is enabled, highlight these characters."
603 t)))
606 "Remove extra trailing newline characters from current buffer."
615 "Search for any given whitespace REGEXP."
627 "Search for any given whitespace REGEXP and replace it with the NEWREGEXP."
634 "Search for 8/more spaces at the start of a line and replace it with tabs."
644 "Return the list of whitespaces whose testing has been suppressed."
652 unchecked-spaces
653 nil)))
656 "Update mode line with whitespace errors.
657 Also with whitespaces whose testing has been turned off."
661 ;; Whitespace errors
664 ;; Whitespace suppressed errors
669 ;; Add the whitespace modeline prefix
672 nil))
676 "Highlight the current line, unhighlighting a previously jumped to line."
682 "Unhighlight the currently highlight line."
689 "Add a buffer and its file to the whitespace monitor list.
691 The buffer named BUF-NAME and its associated file BUF-FILE are now monitored
692 periodically for whitespace."
694 whitespace-all-buffer-files)))
698 "Tickle timer to periodically to scan qualifying files for whitespace creep.
700 If timer is not set, then set it to scan the files in
701 `whitespace-all-buffer-files' periodically (defined by
702 `whitespace-rescan-timer-time') for whitespace creep."
708 'whitespace-rescan-files-in-buffers nil
709 whitespace-rescan-timer-time))))
712 "Check monitored files for whitespace creep since last scan."
714 buffile bufname thiselt buf)
727 ;;(message "buffer %s live" bufname)
730 ;;(message "checking for whitespace in %s" bufname)
733 ;;(message "cleaning up whitespace in %s" bufname)
736 ;;(message "whitespace-buffer %s." (buffer-name))
738 ;;(message "Removing %s from refresh list" bufname)
740 ;;(message "Removing %s from refresh list" bufname)
744 "Refresh the list of files to be rescanned for whitespace creep."
752 ;;;###autoload
755 ;;;###autoload
757 "Toggle using Whitespace mode in new buffers.
758 With ARG, turn the mode on if ARG is positive, otherwise turn it off.
760 When this mode is active, `whitespace-buffer' is added to
761 `find-file-hook' and `kill-buffer-hook'."
762 :global t
773 ;;;###autoload
775 "Hook function to be called on the buffer when whitespace check is enabled.
776 This is meant to be added buffer-locally to `write-file-functions'."
783 buffer-file-name)))
784 nil)
787 "Unload the whitespace library."
789 ;; if whitespace-unload-hook is defined, let's get rid of it
790 ;; and recursively call `unload-feature'
792 ;; this only happens in the recursive call
798 ;; continue standard unloading
799 nil))
810 ;;; whitespace.el ends here