| blob | b2ef06c9584f7f1b0ac7d20546ba103e8ffb1953 |
1 ;;; whitespace.el --- warn about and clean bogus whitespaces in the file
3 ;; Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004,
4 ;; 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
6 ;; Author: Rajesh Vaidheeswarran <rv@gnu.org>
7 ;; Keywords: convenience
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, 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., 51 Franklin Street, Fifth Floor,
24 ;; Boston, MA 02110-1301, 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
113 ;;;###autoload(put 'whitespace-check-buffer-leading 'safe-local-variable 'booleanp)
118 ;;;###autoload(put 'whitespace-check-buffer-trailing 'safe-local-variable 'booleanp)
123 ;;;###autoload(put 'whitespace-check-buffer-indent 'safe-local-variable 'booleanp)
128 ;;;###autoload(put 'whitespace-check-buffer-spacetab 'safe-local-variable 'booleanp)
133 ;;;###autoload(put 'whitespace-check-buffer-ateol 'safe-local-variable 'booleanp)
153 "Check for and fix five different types of whitespaces in source code."
156 ;; Since XEmacs doesn't have a 'convenience group, use the next best group
157 ;; which is 'editing?
161 "Flag to check leading whitespace. This is the global for the system.
162 It can be overridden by setting a buffer local variable
163 `whitespace-check-buffer-leading'."
168 "Flag to check trailing whitespace. This is the global for the system.
169 It can be overridden by setting a buffer local variable
170 `whitespace-check-buffer-trailing'."
175 "Flag to check space followed by a TAB. This is the global for the system.
176 It can be overridden by setting a buffer local variable
177 `whitespace-check-buffer-spacetab'."
182 "Regexp to match one or more spaces followed by a TAB."
187 "Flag to check indentation whitespace. This is the global for the system.
188 It can be overridden by setting a buffer local variable
189 `whitespace-check-buffer-indent'."
194 "Regexp to match multiples of eight spaces near line beginnings.
195 The default value ignores leading TABs."
200 "Flag to check end-of-line whitespace. This is the global for the system.
201 It can be overridden by setting a buffer local variable
202 `whitespace-check-buffer-ateol'."
207 "Regexp to match one or more TABs or spaces at line ends."
212 "The name of the buffer where whitespace related messages will be logged."
217 "If non-nil, this message will be displayed after a whitespace check
218 determines a file to be clean."
223 "While writing a file, abort if the file is unclean.
224 If `whitespace-auto-cleanup' is set, that takes precedence over
225 this variable."
230 "Cleanup a buffer automatically on finding it whitespace unclean."
235 "All whitespace errors will be shown only in the modeline when t.
237 Note that setting this may cause all whitespaces introduced in a file to go
238 unnoticed when the buffer is killed, unless the user visits the `*Whitespace
239 Errors*' buffer before opening (or closing) another file."
244 c-mode c++-mode cc-mode
245 change-log-mode cperl-mode
246 electric-nroff-mode emacs-lisp-mode
247 f90-mode fortran-mode html-mode
248 html3-mode java-mode jde-mode
249 ksh-mode latex-mode LaTeX-mode
250 lisp-mode m4-mode makefile-mode
251 modula-2-mode nroff-mode objc-mode
252 pascal-mode perl-mode prolog-mode
253 python-mode scheme-mode sgml-mode
254 sh-mode shell-script-mode simula-mode
255 tcl-mode tex-mode texinfo-mode
256 vrml-mode xml-mode)
258 "Major modes in which we turn on whitespace checking.
260 These are mostly programming and documentation modes. But you may add other
261 modes that you want whitespaces checked in by adding something like the
262 following to your `.emacs':
264 \(setq whitespace-modes (cons 'my-mode (cons 'my-other-mode
265 whitespace-modes))\)
267 Or, alternately, you can use the Emacs `customize' command to set this."
272 "Period in seconds to rescan modified buffers for whitespace creep.
274 This is the period after which the timer will fire causing
275 `whitespace-rescan-files-in-buffers' to check for whitespace creep in
276 modified buffers.
278 To disable timer scans, set this to zero."
283 "Display whitespace errors on the modeline."
288 "Display the bogus whitespaces by coloring them with the face
289 `whitespace-highlight'."
294 "Faces used in whitespace."
309 "Face used for highlighting the bogus whitespaces that exist in the buffer."
311 ;; backward-compatibility alias
316 minor-mode-alist)))
319 whitespace-check-leading-whitespace)
321 whitespace-check-trailing-whitespace)
323 whitespace-check-indent-whitespace)
325 whitespace-check-spacetab-whitespace)
327 whitespace-check-ateol-whitespace)
330 "Test and set the whitespace-mode in qualifying buffers."
334 t
335 nil))))
337 ;;;###autoload
339 "Toggle the check for leading space in the local buffer."
347 ;;;###autoload
349 "Toggle the check for trailing space in the local buffer."
357 ;;;###autoload
359 "Toggle the check for indentation space in the local buffer."
368 ;;;###autoload
370 "Toggle the check for space-followed-by-TABs in the local buffer."
380 ;;;###autoload
382 "Toggle the check for end-of-line space in the local buffer."
392 ;;;###autoload
394 "Find five different types of white spaces in buffer.
395 These are:
396 1. Leading space \(empty lines at the top of a file\).
397 2. Trailing space \(empty lines at the end of a file\).
398 3. Indentation space \(8 or more spaces, that should be replaced with TABS\).
399 4. Spaces followed by a TAB. \(Almost always, we never want that\).
400 5. Spaces or TABS at the end of a line.
402 Check for whitespace only if this buffer really contains a non-empty file
403 and:
404 1. the major mode is one of the whitespace-modes, or
405 2. `whitespace-buffer' was explicitly called with a prefix argument."
422 nil))
425 nil))
428 whitespace-indent-regexp)
429 nil))
432 whitespace-spacetab-regexp)
433 nil))
436 whitespace-ateol-regexp)
437 nil))
442 ;; Now let's complain if we found any of the above.
444 whitespace-spacetab whitespace-ateol
445 whitespace-trailing))
483 whitespace-this-modeline
489 whitespace-filename)))
492 whitespace-clean-msg))))))))
493 whitespace-error))
495 ;;;###autoload
497 "Check the region for whitespace errors."
504 ;;;###autoload
506 "Cleanup the five different kinds of whitespace problems.
507 It normally applies to the whole buffer, but in Transient Mark mode
508 when the mark is active it applies to the region.
509 See `whitespace-buffer' docstring for a summary of the problems."
516 ;; If this buffer really contains a file, then run, else quit.
523 ;; since all printable TABS should be 8, irrespective of how
524 ;; they are displayed.
557 ;; Call this recursively till everything is taken care of
560 ;; if we are done, talk to the user
569 ;;;###autoload
571 "Whitespace cleanup on the region."
580 "Return t if the current buffer has leading newline characters.
581 If highlighting is enabled, highlight these characters."
587 t)))
590 "Remove any leading newline characters from current buffer."
597 "Return t if the current buffer has extra trailing newline characters.
598 If highlighting is enabled, highlight these characters."
605 t)))
608 "Remove extra trailing newline characters from current buffer."
617 "Search for any given whitespace REGEXP."
629 "Search for any given whitespace REGEXP and replace it with the NEWREGEXP."
636 "Search for 8/more spaces at the start of a line and replace it with tabs."
646 "Return the list of whitespaces whose testing has been suppressed."
654 unchecked-spaces
655 nil)))
658 "Update modeline with whitespace errors.
659 Also with whitespaces whose testing has been turned off."
663 ;; Whitespace errors
666 ;; Whitespace suppressed errors
671 ;; Add the whitespace modeline prefix
674 nil))
678 "Highlight the current line, unhighlighting a previously jumped to line."
684 "Unhighlight the currently highlight line."
691 "Add a buffer and its file to the whitespace monitor list.
693 The buffer named BUF-NAME and its associated file BUF-FILE are now monitored
694 periodically for whitespace."
696 whitespace-all-buffer-files)))
700 "Tickle timer to periodically to scan qualifying files for whitespace creep.
702 If timer is not set, then set it to scan the files in
703 `whitespace-all-buffer-files' periodically (defined by
704 `whitespace-rescan-timer-time') for whitespace creep."
710 'whitespace-rescan-files-in-buffers nil
711 whitespace-rescan-timer-time))))
714 "Check monitored files for whitespace creep since last scan."
716 buffile bufname thiselt buf)
729 ;;(message "buffer %s live" bufname)
733 ;;(message "checking for whitespace in %s" bufname)
736 ;;(message "cleaning up whitespace in %s" bufname)
739 ;;(message "whitespace-buffer %s." (buffer-name))
741 ;;(message "Removing %s from refresh list" bufname)
743 ;;(message "Removing %s from refresh list" bufname)
747 "Refresh the list of files to be rescanned for whitespace creep."
755 ;;;###autoload
758 ;;;###autoload
760 "Toggle using Whitespace mode in new buffers.
761 With ARG, turn the mode on if ARG is positive, otherwise turn it off.
763 When this mode is active, `whitespace-buffer' is added to
764 `find-file-hook' and `kill-buffer-hook'."
765 :global t
776 ;;;###autoload
778 "Hook function to be called on the buffer when whitespace check is enabled.
779 This is meant to be added buffer-locally to `write-file-functions'."
786 buffer-file-name)))
787 nil)
790 "Unload the whitespace library."
792 ;; if whitespace-unload-hook is defined, let's get rid of it
793 ;; and recursively call `unload-feature'
795 ;; this only happens in the recursive call
801 ;; continue standard unloading
802 nil))
813 ;; arch-tag: 4ff44e87-b63c-402d-95a6-15e51e58bd0c
814 ;;; whitespace.el ends here