2001-07-16 12:23:00 +00:00
|
|
|
;;; whitespace.el --- warn about and clean bogus whitespaces in the file
|
1999-09-07 11:28:47 +00:00
|
|
|
|
2005-08-06 22:13:43 +00:00
|
|
|
;; Copyright (C) 1999, 2000, 2002, 2003, 2004,
|
|
|
|
;; 2005 Free Software Foundation, Inc.
|
1999-09-07 11:28:47 +00:00
|
|
|
|
2000-05-31 18:39:14 +00:00
|
|
|
;; Author: Rajesh Vaidheeswarran <rv@gnu.org>
|
1999-09-07 11:28:47 +00:00
|
|
|
;; Keywords: convenience
|
|
|
|
|
|
|
|
;; This file is part of GNU Emacs.
|
|
|
|
|
|
|
|
;; GNU Emacs is free software; you can redistribute it and/or modify
|
|
|
|
;; it under the terms of the GNU General Public License as published by
|
|
|
|
;; the Free Software Foundation; either version 2, or (at your option)
|
|
|
|
;; any later version.
|
|
|
|
|
|
|
|
;; GNU Emacs is distributed in the hope that it will be useful,
|
|
|
|
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
|
;; GNU General Public License for more details.
|
|
|
|
|
|
|
|
;; You should have received a copy of the GNU General Public License
|
|
|
|
;; along with GNU Emacs; see the file COPYING. If not, write to the
|
2005-07-04 23:32:44 +00:00
|
|
|
;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
|
|
|
|
;; Boston, MA 02110-1301, USA.
|
1999-09-07 11:28:47 +00:00
|
|
|
|
|
|
|
;;; Commentary:
|
2003-06-11 03:50:45 +00:00
|
|
|
;;
|
|
|
|
;; URL: http://www.dsmit.com/lisp/
|
|
|
|
;;
|
2002-09-11 21:30:25 +00:00
|
|
|
;; The whitespace library is intended to find and help fix five different types
|
|
|
|
;; of whitespace problems that commonly exist in source code.
|
2003-06-11 03:50:45 +00:00
|
|
|
;;
|
2002-09-11 21:30:25 +00:00
|
|
|
;; 1. Leading space (empty lines at the top of a file).
|
|
|
|
;; 2. Trailing space (empty lines at the end of a file).
|
|
|
|
;; 3. Indentation space (8 or more spaces at beginning of line, that should be
|
2003-09-29 18:05:31 +00:00
|
|
|
;; replaced with TABS).
|
2002-09-11 21:30:25 +00:00
|
|
|
;; 4. Spaces followed by a TAB. (Almost always, we never want that).
|
|
|
|
;; 5. Spaces or TABS at the end of a line.
|
2003-06-11 03:50:45 +00:00
|
|
|
;;
|
2002-09-11 21:30:25 +00:00
|
|
|
;; Whitespace errors are reported in a buffer, and on the modeline.
|
2003-06-11 03:50:45 +00:00
|
|
|
;;
|
2002-09-11 21:30:25 +00:00
|
|
|
;; Modeline will show a W:<x>!<y> to denote a particular type of whitespace,
|
|
|
|
;; where `x' and `y' can be one (or more) of:
|
2003-06-11 03:50:45 +00:00
|
|
|
;;
|
2002-09-11 21:30:25 +00:00
|
|
|
;; e - End-of-Line whitespace.
|
|
|
|
;; i - Indentation whitespace.
|
|
|
|
;; l - Leading whitespace.
|
|
|
|
;; s - Space followed by Tab.
|
|
|
|
;; t - Trailing whitespace.
|
2003-06-11 03:50:45 +00:00
|
|
|
;;
|
2002-09-11 21:30:25 +00:00
|
|
|
;; If any of the whitespace checks is turned off, the modeline will display a
|
|
|
|
;; !<y>.
|
2003-06-11 03:50:45 +00:00
|
|
|
;;
|
2002-09-11 21:30:25 +00:00
|
|
|
;; (since (3) is the most controversial one, here is the rationale: Most
|
|
|
|
;; terminal drivers and printer drivers have TAB configured or even
|
|
|
|
;; hardcoded to be 8 spaces. (Some of them allow configuration, but almost
|
|
|
|
;; always they default to 8.)
|
2003-06-11 03:50:45 +00:00
|
|
|
;;
|
2002-09-11 21:30:25 +00:00
|
|
|
;; Changing `tab-width' to other than 8 and editing will cause your code to
|
|
|
|
;; look different from within Emacs, and say, if you cat it or more it, or
|
|
|
|
;; even print it.
|
2003-06-11 03:50:45 +00:00
|
|
|
;;
|
2002-09-11 21:30:25 +00:00
|
|
|
;; Almost all the popular programming modes let you define an offset (like
|
|
|
|
;; c-basic-offset or perl-indent-level) to configure the offset, so you
|
|
|
|
;; should never have to set your `tab-width' to be other than 8 in all
|
|
|
|
;; these modes. In fact, with an indent level of say, 4, 2 TABS will cause
|
|
|
|
;; Emacs to replace your 8 spaces with one \t (try it). If vi users in
|
|
|
|
;; your office complain, tell them to use vim, which distinguishes between
|
|
|
|
;; tabstop and shiftwidth (vi equivalent of our offsets), and also ask them
|
|
|
|
;; to set smarttab.)
|
2003-06-11 03:50:45 +00:00
|
|
|
;;
|
2002-09-11 21:30:25 +00:00
|
|
|
;; All the above have caused (and will cause) unwanted codeline integration and
|
|
|
|
;; merge problems.
|
2003-06-11 03:50:45 +00:00
|
|
|
;;
|
2002-09-11 21:30:25 +00:00
|
|
|
;; whitespace.el will complain if it detects whitespaces on opening a file, and
|
|
|
|
;; warn you on closing a file also (in case you had inserted any
|
|
|
|
;; whitespaces during the process of your editing).
|
2003-06-11 03:50:45 +00:00
|
|
|
;;
|
1999-09-07 11:28:47 +00:00
|
|
|
;; Exported functions:
|
2003-06-11 03:50:45 +00:00
|
|
|
;;
|
1999-09-07 11:28:47 +00:00
|
|
|
;; `whitespace-buffer' - To check the current buffer for whitespace problems.
|
|
|
|
;; `whitespace-cleanup' - To cleanup all whitespaces in the current buffer.
|
1999-09-10 02:42:59 +00:00
|
|
|
;; `whitespace-region' - To check between point and mark for whitespace
|
|
|
|
;; problems.
|
|
|
|
;; `whitespace-cleanup-region' - To cleanup all whitespaces between point
|
|
|
|
;; and mark in the current buffer.
|
1999-09-07 11:28:47 +00:00
|
|
|
|
|
|
|
;;; Code:
|
|
|
|
|
2005-04-11 23:25:46 +00:00
|
|
|
(defvar whitespace-version "3.5" "Version of the whitespace library.")
|
1999-09-07 11:28:47 +00:00
|
|
|
|
1999-09-10 02:42:59 +00:00
|
|
|
(defvar whitespace-all-buffer-files nil
|
|
|
|
"An associated list of buffers and files checked for whitespace cleanliness.
|
1999-09-07 11:28:47 +00:00
|
|
|
|
1999-09-10 02:42:59 +00:00
|
|
|
This is to enable periodic checking of whitespace cleanliness in the files
|
|
|
|
visited by the buffers.")
|
1999-09-07 11:28:47 +00:00
|
|
|
|
1999-09-10 02:42:59 +00:00
|
|
|
(defvar whitespace-rescan-timer nil
|
|
|
|
"Timer object used to rescan the files in buffers that have been modified.")
|
1999-09-07 11:28:47 +00:00
|
|
|
|
1999-10-30 19:21:43 +00:00
|
|
|
;; Tell Emacs about this new kind of minor mode
|
|
|
|
(defvar whitespace-mode nil
|
|
|
|
"Non-nil when Whitespace mode (a minor mode) is enabled.")
|
|
|
|
(make-variable-buffer-local 'whitespace-mode)
|
|
|
|
(put 'whitespace-mode 'permanent-local nil)
|
|
|
|
|
|
|
|
(defvar whitespace-mode-line nil
|
|
|
|
"String to display in the mode line for Whitespace mode.")
|
|
|
|
(make-variable-buffer-local 'whitespace-mode-line)
|
|
|
|
(put 'whitespace-mode-line 'permanent-local nil)
|
|
|
|
|
2001-03-22 21:30:11 +00:00
|
|
|
(defvar whitespace-check-buffer-leading nil
|
(whitespace-check-buffer-leading, whitespace-check-buffer-trailing,
whitespace-check-buffer-indent, whitespace-check-buffer-spacetab,
whitespace-check-buffer-ateol, whitespace-highlighted-space,
whitespace-check-leading-whitespace, whitespace-check-trailing-whitespace,
whitespace-check-spacetab-whitespace, whitespace-check-indent-whitespace,
whitespace-check-ateol-whitespace, whitespace-abort-on-error, whitespace-modes):
Fix typos in docstrings.
(defgroup, defcustom): Doc fix.
2005-07-13 10:32:08 +00:00
|
|
|
"Test leading whitespace for file in current buffer if t.")
|
2001-03-22 21:30:11 +00:00
|
|
|
(make-variable-buffer-local 'whitespace-check-buffer-leading)
|
|
|
|
(put 'whitespace-check-buffer-leading 'permanent-local nil)
|
|
|
|
|
|
|
|
(defvar whitespace-check-buffer-trailing nil
|
(whitespace-check-buffer-leading, whitespace-check-buffer-trailing,
whitespace-check-buffer-indent, whitespace-check-buffer-spacetab,
whitespace-check-buffer-ateol, whitespace-highlighted-space,
whitespace-check-leading-whitespace, whitespace-check-trailing-whitespace,
whitespace-check-spacetab-whitespace, whitespace-check-indent-whitespace,
whitespace-check-ateol-whitespace, whitespace-abort-on-error, whitespace-modes):
Fix typos in docstrings.
(defgroup, defcustom): Doc fix.
2005-07-13 10:32:08 +00:00
|
|
|
"Test trailing whitespace for file in current buffer if t.")
|
2001-03-22 21:30:11 +00:00
|
|
|
(make-variable-buffer-local 'whitespace-check-buffer-trailing)
|
|
|
|
(put 'whitespace-check-buffer-trailing 'permanent-local nil)
|
|
|
|
|
|
|
|
(defvar whitespace-check-buffer-indent nil
|
(whitespace-check-buffer-leading, whitespace-check-buffer-trailing,
whitespace-check-buffer-indent, whitespace-check-buffer-spacetab,
whitespace-check-buffer-ateol, whitespace-highlighted-space,
whitespace-check-leading-whitespace, whitespace-check-trailing-whitespace,
whitespace-check-spacetab-whitespace, whitespace-check-indent-whitespace,
whitespace-check-ateol-whitespace, whitespace-abort-on-error, whitespace-modes):
Fix typos in docstrings.
(defgroup, defcustom): Doc fix.
2005-07-13 10:32:08 +00:00
|
|
|
"Test indentation whitespace for file in current buffer if t.")
|
2001-03-22 21:30:11 +00:00
|
|
|
(make-variable-buffer-local 'whitespace-check-buffer-indent)
|
|
|
|
(put 'whitespace-check-buffer-indent 'permanent-local nil)
|
|
|
|
|
|
|
|
(defvar whitespace-check-buffer-spacetab nil
|
(whitespace-check-buffer-leading, whitespace-check-buffer-trailing,
whitespace-check-buffer-indent, whitespace-check-buffer-spacetab,
whitespace-check-buffer-ateol, whitespace-highlighted-space,
whitespace-check-leading-whitespace, whitespace-check-trailing-whitespace,
whitespace-check-spacetab-whitespace, whitespace-check-indent-whitespace,
whitespace-check-ateol-whitespace, whitespace-abort-on-error, whitespace-modes):
Fix typos in docstrings.
(defgroup, defcustom): Doc fix.
2005-07-13 10:32:08 +00:00
|
|
|
"Test Space-followed-by-TABS whitespace for file in current buffer if t.")
|
2001-03-22 21:30:11 +00:00
|
|
|
(make-variable-buffer-local 'whitespace-check-buffer-spacetab)
|
|
|
|
(put 'whitespace-check-buffer-spacetab 'permanent-local nil)
|
|
|
|
|
|
|
|
(defvar whitespace-check-buffer-ateol nil
|
(whitespace-check-buffer-leading, whitespace-check-buffer-trailing,
whitespace-check-buffer-indent, whitespace-check-buffer-spacetab,
whitespace-check-buffer-ateol, whitespace-highlighted-space,
whitespace-check-leading-whitespace, whitespace-check-trailing-whitespace,
whitespace-check-spacetab-whitespace, whitespace-check-indent-whitespace,
whitespace-check-ateol-whitespace, whitespace-abort-on-error, whitespace-modes):
Fix typos in docstrings.
(defgroup, defcustom): Doc fix.
2005-07-13 10:32:08 +00:00
|
|
|
"Test end-of-line whitespace for file in current buffer if t.")
|
2001-03-22 21:30:11 +00:00
|
|
|
(make-variable-buffer-local 'whitespace-check-buffer-ateol)
|
|
|
|
(put 'whitespace-check-buffer-ateol 'permanent-local nil)
|
|
|
|
|
2001-12-13 17:34:57 +00:00
|
|
|
(defvar whitespace-highlighted-space nil
|
(whitespace-check-buffer-leading, whitespace-check-buffer-trailing,
whitespace-check-buffer-indent, whitespace-check-buffer-spacetab,
whitespace-check-buffer-ateol, whitespace-highlighted-space,
whitespace-check-leading-whitespace, whitespace-check-trailing-whitespace,
whitespace-check-spacetab-whitespace, whitespace-check-indent-whitespace,
whitespace-check-ateol-whitespace, whitespace-abort-on-error, whitespace-modes):
Fix typos in docstrings.
(defgroup, defcustom): Doc fix.
2005-07-13 10:32:08 +00:00
|
|
|
"The variable to store the extent to highlight.")
|
2001-12-13 17:34:57 +00:00
|
|
|
(make-variable-buffer-local 'whitespace-highlighted-space)
|
|
|
|
(put 'whitespace-highlighted-space 'permanent-local nil)
|
|
|
|
|
1999-10-30 21:10:54 +00:00
|
|
|
;; For flavors of Emacs which don't define `defgroup' and `defcustom'.
|
1999-09-10 02:42:59 +00:00
|
|
|
(eval-when-compile
|
1999-10-30 21:10:54 +00:00
|
|
|
(if (not (fboundp 'defgroup))
|
|
|
|
(defmacro defgroup (sym memb doc &rest args)
|
(whitespace-check-buffer-leading, whitespace-check-buffer-trailing,
whitespace-check-buffer-indent, whitespace-check-buffer-spacetab,
whitespace-check-buffer-ateol, whitespace-highlighted-space,
whitespace-check-leading-whitespace, whitespace-check-trailing-whitespace,
whitespace-check-spacetab-whitespace, whitespace-check-indent-whitespace,
whitespace-check-ateol-whitespace, whitespace-abort-on-error, whitespace-modes):
Fix typos in docstrings.
(defgroup, defcustom): Doc fix.
2005-07-13 10:32:08 +00:00
|
|
|
"Null macro for `defgroup' in all versions of Emacs that don't define it."
|
1999-10-30 21:10:54 +00:00
|
|
|
t))
|
|
|
|
(if (not (fboundp 'defcustom))
|
|
|
|
(defmacro defcustom (sym val doc &rest args)
|
(whitespace-check-buffer-leading, whitespace-check-buffer-trailing,
whitespace-check-buffer-indent, whitespace-check-buffer-spacetab,
whitespace-check-buffer-ateol, whitespace-highlighted-space,
whitespace-check-leading-whitespace, whitespace-check-trailing-whitespace,
whitespace-check-spacetab-whitespace, whitespace-check-indent-whitespace,
whitespace-check-ateol-whitespace, whitespace-abort-on-error, whitespace-modes):
Fix typos in docstrings.
(defgroup, defcustom): Doc fix.
2005-07-13 10:32:08 +00:00
|
|
|
"Macro to alias `defcustom' to `defvar' in all versions of Emacs that
|
|
|
|
don't define it."
|
1999-10-30 21:10:54 +00:00
|
|
|
`(defvar ,sym ,val ,doc))))
|
1999-09-07 11:28:47 +00:00
|
|
|
|
2005-07-16 17:10:58 +00:00
|
|
|
(defalias 'whitespace-make-overlay
|
|
|
|
(if (featurep 'xemacs) 'make-extent 'make-overlay))
|
|
|
|
(defalias 'whitespace-overlay-put
|
|
|
|
(if (featurep 'xemacs) 'set-extent-property 'overlay-put))
|
|
|
|
(defalias 'whitespace-delete-overlay
|
|
|
|
(if (featurep 'xemacs) 'delete-extent 'delete-overlay))
|
|
|
|
(defalias 'whitespace-overlay-start
|
|
|
|
(if (featurep 'xemacs) 'extent-start 'overlay-start))
|
|
|
|
(defalias 'whitespace-overlay-end
|
|
|
|
(if (featurep 'xemacs) 'extent-end 'overlay-end))
|
|
|
|
(defalias 'whitespace-mode-line-update
|
|
|
|
(if (featurep 'xemacs) 'redraw-modeline 'force-mode-line-update))
|
|
|
|
|
2000-10-15 17:07:55 +00:00
|
|
|
(defgroup whitespace nil
|
|
|
|
"Check for and fix five different types of whitespaces in source code."
|
|
|
|
:version "21.1"
|
2003-06-11 03:50:45 +00:00
|
|
|
:link '(emacs-commentary-link "whitespace.el")
|
2005-07-16 17:10:58 +00:00
|
|
|
;; Since XEmacs doesn't have a 'convenience group, use the next best group
|
|
|
|
;; which is 'editing?
|
|
|
|
:group (if (featurep 'xemacs) 'editing 'convenience))
|
1999-09-07 11:28:47 +00:00
|
|
|
|
1999-09-14 22:30:11 +00:00
|
|
|
(defcustom whitespace-check-leading-whitespace t
|
(whitespace-check-buffer-leading, whitespace-check-buffer-trailing,
whitespace-check-buffer-indent, whitespace-check-buffer-spacetab,
whitespace-check-buffer-ateol, whitespace-highlighted-space,
whitespace-check-leading-whitespace, whitespace-check-trailing-whitespace,
whitespace-check-spacetab-whitespace, whitespace-check-indent-whitespace,
whitespace-check-ateol-whitespace, whitespace-abort-on-error, whitespace-modes):
Fix typos in docstrings.
(defgroup, defcustom): Doc fix.
2005-07-13 10:32:08 +00:00
|
|
|
"Flag to check leading whitespace. This is the global for the system.
|
2001-03-22 21:30:11 +00:00
|
|
|
It can be overriden by setting a buffer local variable
|
(whitespace-check-buffer-leading, whitespace-check-buffer-trailing,
whitespace-check-buffer-indent, whitespace-check-buffer-spacetab,
whitespace-check-buffer-ateol, whitespace-highlighted-space,
whitespace-check-leading-whitespace, whitespace-check-trailing-whitespace,
whitespace-check-spacetab-whitespace, whitespace-check-indent-whitespace,
whitespace-check-ateol-whitespace, whitespace-abort-on-error, whitespace-modes):
Fix typos in docstrings.
(defgroup, defcustom): Doc fix.
2005-07-13 10:32:08 +00:00
|
|
|
`whitespace-check-buffer-leading'."
|
1999-09-14 22:30:11 +00:00
|
|
|
:type 'boolean
|
|
|
|
:group 'whitespace)
|
|
|
|
|
|
|
|
(defcustom whitespace-check-trailing-whitespace t
|
(whitespace-check-buffer-leading, whitespace-check-buffer-trailing,
whitespace-check-buffer-indent, whitespace-check-buffer-spacetab,
whitespace-check-buffer-ateol, whitespace-highlighted-space,
whitespace-check-leading-whitespace, whitespace-check-trailing-whitespace,
whitespace-check-spacetab-whitespace, whitespace-check-indent-whitespace,
whitespace-check-ateol-whitespace, whitespace-abort-on-error, whitespace-modes):
Fix typos in docstrings.
(defgroup, defcustom): Doc fix.
2005-07-13 10:32:08 +00:00
|
|
|
"Flag to check trailing whitespace. This is the global for the system.
|
2001-03-22 21:30:11 +00:00
|
|
|
It can be overriden by setting a buffer local variable
|
(whitespace-check-buffer-leading, whitespace-check-buffer-trailing,
whitespace-check-buffer-indent, whitespace-check-buffer-spacetab,
whitespace-check-buffer-ateol, whitespace-highlighted-space,
whitespace-check-leading-whitespace, whitespace-check-trailing-whitespace,
whitespace-check-spacetab-whitespace, whitespace-check-indent-whitespace,
whitespace-check-ateol-whitespace, whitespace-abort-on-error, whitespace-modes):
Fix typos in docstrings.
(defgroup, defcustom): Doc fix.
2005-07-13 10:32:08 +00:00
|
|
|
`whitespace-check-buffer-trailing'."
|
1999-09-14 22:30:11 +00:00
|
|
|
:type 'boolean
|
|
|
|
:group 'whitespace)
|
|
|
|
|
|
|
|
(defcustom whitespace-check-spacetab-whitespace t
|
(whitespace-check-buffer-leading, whitespace-check-buffer-trailing,
whitespace-check-buffer-indent, whitespace-check-buffer-spacetab,
whitespace-check-buffer-ateol, whitespace-highlighted-space,
whitespace-check-leading-whitespace, whitespace-check-trailing-whitespace,
whitespace-check-spacetab-whitespace, whitespace-check-indent-whitespace,
whitespace-check-ateol-whitespace, whitespace-abort-on-error, whitespace-modes):
Fix typos in docstrings.
(defgroup, defcustom): Doc fix.
2005-07-13 10:32:08 +00:00
|
|
|
"Flag to check space followed by a TAB. This is the global for the system.
|
2001-03-22 21:30:11 +00:00
|
|
|
It can be overriden by setting a buffer local variable
|
(whitespace-check-buffer-leading, whitespace-check-buffer-trailing,
whitespace-check-buffer-indent, whitespace-check-buffer-spacetab,
whitespace-check-buffer-ateol, whitespace-highlighted-space,
whitespace-check-leading-whitespace, whitespace-check-trailing-whitespace,
whitespace-check-spacetab-whitespace, whitespace-check-indent-whitespace,
whitespace-check-ateol-whitespace, whitespace-abort-on-error, whitespace-modes):
Fix typos in docstrings.
(defgroup, defcustom): Doc fix.
2005-07-13 10:32:08 +00:00
|
|
|
`whitespace-check-buffer-spacetab'."
|
1999-09-14 22:30:11 +00:00
|
|
|
:type 'boolean
|
|
|
|
:group 'whitespace)
|
|
|
|
|
2001-12-13 17:34:57 +00:00
|
|
|
(defcustom whitespace-spacetab-regexp "[ ]+\t"
|
1999-09-14 22:30:11 +00:00
|
|
|
"Regexp to match a space followed by a TAB."
|
2000-10-15 17:07:55 +00:00
|
|
|
:type 'regexp
|
1999-09-10 02:42:59 +00:00
|
|
|
:group 'whitespace)
|
1999-09-07 11:28:47 +00:00
|
|
|
|
2001-08-20 20:56:08 +00:00
|
|
|
(defcustom whitespace-check-indent-whitespace indent-tabs-mode
|
(whitespace-check-buffer-leading, whitespace-check-buffer-trailing,
whitespace-check-buffer-indent, whitespace-check-buffer-spacetab,
whitespace-check-buffer-ateol, whitespace-highlighted-space,
whitespace-check-leading-whitespace, whitespace-check-trailing-whitespace,
whitespace-check-spacetab-whitespace, whitespace-check-indent-whitespace,
whitespace-check-ateol-whitespace, whitespace-abort-on-error, whitespace-modes):
Fix typos in docstrings.
(defgroup, defcustom): Doc fix.
2005-07-13 10:32:08 +00:00
|
|
|
"Flag to check indentation whitespace. This is the global for the system.
|
2001-03-22 21:30:11 +00:00
|
|
|
It can be overriden by setting a buffer local variable
|
(whitespace-check-buffer-leading, whitespace-check-buffer-trailing,
whitespace-check-buffer-indent, whitespace-check-buffer-spacetab,
whitespace-check-buffer-ateol, whitespace-highlighted-space,
whitespace-check-leading-whitespace, whitespace-check-trailing-whitespace,
whitespace-check-spacetab-whitespace, whitespace-check-indent-whitespace,
whitespace-check-ateol-whitespace, whitespace-abort-on-error, whitespace-modes):
Fix typos in docstrings.
(defgroup, defcustom): Doc fix.
2005-07-13 10:32:08 +00:00
|
|
|
`whitespace-check-buffer-indent'."
|
1999-09-14 22:30:11 +00:00
|
|
|
:type 'boolean
|
|
|
|
:group 'whitespace)
|
|
|
|
|
1999-09-10 02:42:59 +00:00
|
|
|
(defcustom whitespace-indent-regexp (concat "^\\(\t*\\) " " ")
|
|
|
|
"Regexp to match (any TABS followed by) 8/more whitespaces at start of line."
|
2000-10-15 17:07:55 +00:00
|
|
|
:type 'regexp
|
1999-09-10 02:42:59 +00:00
|
|
|
:group 'whitespace)
|
|
|
|
|
1999-09-14 22:30:11 +00:00
|
|
|
(defcustom whitespace-check-ateol-whitespace t
|
(whitespace-check-buffer-leading, whitespace-check-buffer-trailing,
whitespace-check-buffer-indent, whitespace-check-buffer-spacetab,
whitespace-check-buffer-ateol, whitespace-highlighted-space,
whitespace-check-leading-whitespace, whitespace-check-trailing-whitespace,
whitespace-check-spacetab-whitespace, whitespace-check-indent-whitespace,
whitespace-check-ateol-whitespace, whitespace-abort-on-error, whitespace-modes):
Fix typos in docstrings.
(defgroup, defcustom): Doc fix.
2005-07-13 10:32:08 +00:00
|
|
|
"Flag to check end-of-line whitespace. This is the global for the system.
|
2001-03-22 21:30:11 +00:00
|
|
|
It can be overriden by setting a buffer local variable
|
(whitespace-check-buffer-leading, whitespace-check-buffer-trailing,
whitespace-check-buffer-indent, whitespace-check-buffer-spacetab,
whitespace-check-buffer-ateol, whitespace-highlighted-space,
whitespace-check-leading-whitespace, whitespace-check-trailing-whitespace,
whitespace-check-spacetab-whitespace, whitespace-check-indent-whitespace,
whitespace-check-ateol-whitespace, whitespace-abort-on-error, whitespace-modes):
Fix typos in docstrings.
(defgroup, defcustom): Doc fix.
2005-07-13 10:32:08 +00:00
|
|
|
`whitespace-check-buffer-ateol'."
|
1999-09-14 22:30:11 +00:00
|
|
|
:type 'boolean
|
|
|
|
:group 'whitespace)
|
|
|
|
|
2001-12-13 17:34:57 +00:00
|
|
|
;; (defcustom whitespace-ateol-regexp "[ \t]$"
|
|
|
|
(defcustom whitespace-ateol-regexp "[ \t]+$"
|
1999-09-10 02:42:59 +00:00
|
|
|
"Regexp to match a TAB or a space at the EOL."
|
2000-10-15 17:07:55 +00:00
|
|
|
:type 'regexp
|
1999-09-10 02:42:59 +00:00
|
|
|
:group 'whitespace)
|
|
|
|
|
|
|
|
(defcustom whitespace-errbuf "*Whitespace Errors*"
|
2000-10-15 17:07:55 +00:00
|
|
|
"The name of the buffer where whitespace related messages will be logged."
|
1999-09-10 02:42:59 +00:00
|
|
|
:type 'string
|
|
|
|
:group 'whitespace)
|
|
|
|
|
2003-09-29 18:05:31 +00:00
|
|
|
(defcustom whitespace-clean-msg "clean."
|
|
|
|
"If non-nil, this message will be displayed after a whitespace check
|
|
|
|
determines a file to be clean."
|
|
|
|
:type 'string
|
|
|
|
:group 'whitespace)
|
|
|
|
|
2001-08-20 20:56:08 +00:00
|
|
|
(defcustom whitespace-abort-on-error nil
|
(whitespace-check-buffer-leading, whitespace-check-buffer-trailing,
whitespace-check-buffer-indent, whitespace-check-buffer-spacetab,
whitespace-check-buffer-ateol, whitespace-highlighted-space,
whitespace-check-leading-whitespace, whitespace-check-trailing-whitespace,
whitespace-check-spacetab-whitespace, whitespace-check-indent-whitespace,
whitespace-check-ateol-whitespace, whitespace-abort-on-error, whitespace-modes):
Fix typos in docstrings.
(defgroup, defcustom): Doc fix.
2005-07-13 10:32:08 +00:00
|
|
|
"While writing a file, abort if the file is unclean.
|
|
|
|
If `whitespace-auto-cleanup' is set, that takes precedence over
|
|
|
|
this variable."
|
2001-08-20 20:56:08 +00:00
|
|
|
:type 'boolean
|
|
|
|
:group 'whitespace)
|
|
|
|
|
1999-09-10 02:42:59 +00:00
|
|
|
(defcustom whitespace-auto-cleanup nil
|
|
|
|
"Cleanup a buffer automatically on finding it whitespace unclean."
|
1999-09-07 11:28:47 +00:00
|
|
|
:type 'boolean
|
|
|
|
:group 'whitespace)
|
|
|
|
|
|
|
|
(defcustom whitespace-silent nil
|
1999-09-10 02:42:59 +00:00
|
|
|
"All whitespace errors will be shown only in the modeline when t.
|
1999-09-07 11:28:47 +00:00
|
|
|
|
|
|
|
Note that setting this may cause all whitespaces introduced in a file to go
|
|
|
|
unnoticed when the buffer is killed, unless the user visits the `*Whitespace
|
1999-09-10 02:42:59 +00:00
|
|
|
Errors*' buffer before opening (or closing) another file."
|
1999-09-07 11:28:47 +00:00
|
|
|
:type 'boolean
|
|
|
|
:group 'whitespace)
|
|
|
|
|
|
|
|
(defcustom whitespace-modes '(ada-mode asm-mode autoconf-mode awk-mode
|
1999-09-14 22:30:11 +00:00
|
|
|
c-mode c++-mode cc-mode
|
|
|
|
change-log-mode cperl-mode
|
1999-09-07 11:28:47 +00:00
|
|
|
electric-nroff-mode emacs-lisp-mode
|
|
|
|
f90-mode fortran-mode html-mode
|
|
|
|
html3-mode java-mode jde-mode
|
|
|
|
ksh-mode latex-mode LaTeX-mode
|
|
|
|
lisp-mode m4-mode makefile-mode
|
|
|
|
modula-2-mode nroff-mode objc-mode
|
|
|
|
pascal-mode perl-mode prolog-mode
|
|
|
|
python-mode scheme-mode sgml-mode
|
1999-09-14 22:30:11 +00:00
|
|
|
sh-mode shell-script-mode simula-mode
|
|
|
|
tcl-mode tex-mode texinfo-mode
|
|
|
|
vrml-mode xml-mode)
|
1999-09-07 11:28:47 +00:00
|
|
|
|
(whitespace-check-buffer-leading, whitespace-check-buffer-trailing,
whitespace-check-buffer-indent, whitespace-check-buffer-spacetab,
whitespace-check-buffer-ateol, whitespace-highlighted-space,
whitespace-check-leading-whitespace, whitespace-check-trailing-whitespace,
whitespace-check-spacetab-whitespace, whitespace-check-indent-whitespace,
whitespace-check-ateol-whitespace, whitespace-abort-on-error, whitespace-modes):
Fix typos in docstrings.
(defgroup, defcustom): Doc fix.
2005-07-13 10:32:08 +00:00
|
|
|
"Major modes in which we turn on whitespace checking.
|
1999-09-07 11:28:47 +00:00
|
|
|
|
2000-10-15 17:07:55 +00:00
|
|
|
These are mostly programming and documentation modes. But you may add other
|
1999-09-10 02:42:59 +00:00
|
|
|
modes that you want whitespaces checked in by adding something like the
|
|
|
|
following to your `.emacs':
|
1999-09-07 11:28:47 +00:00
|
|
|
|
1999-09-10 02:42:59 +00:00
|
|
|
\(setq whitespace-modes (cons 'my-mode (cons 'my-other-mode
|
|
|
|
whitespace-modes))\)
|
1999-09-07 11:28:47 +00:00
|
|
|
|
1999-09-10 02:42:59 +00:00
|
|
|
Or, alternately, you can use the Emacs `customize' command to set this."
|
2000-10-15 17:07:55 +00:00
|
|
|
:type '(repeat symbol)
|
1999-09-10 02:42:59 +00:00
|
|
|
:group 'whitespace)
|
1999-09-07 11:28:47 +00:00
|
|
|
|
2000-05-31 18:39:14 +00:00
|
|
|
(defcustom whitespace-rescan-timer-time 600
|
1999-09-10 02:42:59 +00:00
|
|
|
"Period in seconds to rescan modified buffers for whitespace creep.
|
|
|
|
|
|
|
|
This is the period after which the timer will fire causing
|
|
|
|
`whitespace-rescan-files-in-buffers' to check for whitespace creep in
|
1999-09-14 22:30:11 +00:00
|
|
|
modified buffers.
|
|
|
|
|
|
|
|
To disable timer scans, set this to zero."
|
1999-09-07 11:28:47 +00:00
|
|
|
:type 'integer
|
|
|
|
:group 'whitespace)
|
|
|
|
|
1999-10-30 19:21:43 +00:00
|
|
|
(defcustom whitespace-display-in-modeline t
|
|
|
|
"Display whitespace errors on the modeline."
|
|
|
|
:type 'boolean
|
|
|
|
:group 'whitespace)
|
1999-09-07 11:28:47 +00:00
|
|
|
|
2001-12-13 17:34:57 +00:00
|
|
|
(defcustom whitespace-display-spaces-in-color t
|
2005-06-10 08:13:51 +00:00
|
|
|
"Display the bogus whitespaces by coloring them with the face
|
|
|
|
`whitespace-highlight'."
|
2001-12-13 17:34:57 +00:00
|
|
|
:type 'boolean
|
|
|
|
:group 'whitespace)
|
|
|
|
|
|
|
|
(defgroup whitespace-faces nil
|
|
|
|
"Faces used in whitespace."
|
|
|
|
:prefix "whitespace-"
|
|
|
|
:group 'whitespace
|
|
|
|
:group 'faces)
|
|
|
|
|
2005-06-10 08:13:51 +00:00
|
|
|
(defface whitespace-highlight '((((class color) (background light))
|
|
|
|
(:background "green1"))
|
|
|
|
(((class color) (background dark))
|
|
|
|
(:background "sea green"))
|
|
|
|
(((class grayscale mono)
|
|
|
|
(background light))
|
|
|
|
(:background "black"))
|
|
|
|
(((class grayscale mono)
|
|
|
|
(background dark))
|
|
|
|
(:background "white")))
|
2001-12-13 17:34:57 +00:00
|
|
|
"Face used for highlighting the bogus whitespaces that exist in the buffer."
|
|
|
|
:group 'whitespace-faces)
|
2005-06-10 08:13:51 +00:00
|
|
|
;; backward-compatibility alias
|
|
|
|
(put 'whitespace-highlight-face 'face-alias 'whitespace-highlight)
|
2001-12-13 17:34:57 +00:00
|
|
|
|
1999-09-07 11:28:47 +00:00
|
|
|
(if (not (assoc 'whitespace-mode minor-mode-alist))
|
|
|
|
(setq minor-mode-alist (cons '(whitespace-mode whitespace-mode-line)
|
|
|
|
minor-mode-alist)))
|
|
|
|
|
2001-03-22 21:30:11 +00:00
|
|
|
(set-default 'whitespace-check-buffer-leading
|
|
|
|
whitespace-check-leading-whitespace)
|
|
|
|
(set-default 'whitespace-check-buffer-trailing
|
|
|
|
whitespace-check-trailing-whitespace)
|
|
|
|
(set-default 'whitespace-check-buffer-indent
|
|
|
|
whitespace-check-indent-whitespace)
|
|
|
|
(set-default 'whitespace-check-buffer-spacetab
|
|
|
|
whitespace-check-spacetab-whitespace)
|
|
|
|
(set-default 'whitespace-check-buffer-ateol
|
|
|
|
whitespace-check-ateol-whitespace)
|
|
|
|
|
1999-09-07 11:28:47 +00:00
|
|
|
(defun whitespace-check-whitespace-mode (&optional arg)
|
1999-09-10 02:42:59 +00:00
|
|
|
"Test and set the whitespace-mode in qualifying buffers."
|
1999-09-07 11:28:47 +00:00
|
|
|
(if (null whitespace-mode)
|
|
|
|
(setq whitespace-mode
|
|
|
|
(if (or arg (member major-mode whitespace-modes))
|
|
|
|
t
|
|
|
|
nil))))
|
|
|
|
|
2001-03-22 21:30:11 +00:00
|
|
|
;;;###autoload
|
|
|
|
(defun whitespace-toggle-leading-check ()
|
|
|
|
"Toggle the check for leading space in the local buffer."
|
|
|
|
(interactive)
|
|
|
|
(let ((current-val whitespace-check-buffer-leading))
|
|
|
|
(setq whitespace-check-buffer-leading (not current-val))
|
|
|
|
(message "Will%s check for leading space in buffer."
|
|
|
|
(if whitespace-check-buffer-leading "" " not"))
|
|
|
|
(if whitespace-check-buffer-leading (whitespace-buffer-leading))))
|
|
|
|
|
|
|
|
;;;###autoload
|
|
|
|
(defun whitespace-toggle-trailing-check ()
|
|
|
|
"Toggle the check for trailing space in the local buffer."
|
|
|
|
(interactive)
|
|
|
|
(let ((current-val whitespace-check-buffer-trailing))
|
|
|
|
(setq whitespace-check-buffer-trailing (not current-val))
|
|
|
|
(message "Will%s check for trailing space in buffer."
|
|
|
|
(if whitespace-check-buffer-trailing "" " not"))
|
|
|
|
(if whitespace-check-buffer-trailing (whitespace-buffer-trailing))))
|
|
|
|
|
|
|
|
;;;###autoload
|
|
|
|
(defun whitespace-toggle-indent-check ()
|
|
|
|
"Toggle the check for indentation space in the local buffer."
|
|
|
|
(interactive)
|
|
|
|
(let ((current-val whitespace-check-buffer-indent))
|
|
|
|
(setq whitespace-check-buffer-indent (not current-val))
|
|
|
|
(message "Will%s check for indentation space in buffer."
|
|
|
|
(if whitespace-check-buffer-indent "" " not"))
|
|
|
|
(if whitespace-check-buffer-indent
|
|
|
|
(whitespace-buffer-search whitespace-indent-regexp))))
|
|
|
|
|
|
|
|
;;;###autoload
|
|
|
|
(defun whitespace-toggle-spacetab-check ()
|
|
|
|
"Toggle the check for space-followed-by-TABs in the local buffer."
|
|
|
|
(interactive)
|
|
|
|
(let ((current-val whitespace-check-buffer-spacetab))
|
|
|
|
(setq whitespace-check-buffer-spacetab (not current-val))
|
|
|
|
(message "Will%s check for space-followed-by-TABs in buffer."
|
|
|
|
(if whitespace-check-buffer-spacetab "" " not"))
|
|
|
|
(if whitespace-check-buffer-spacetab
|
|
|
|
(whitespace-buffer-search whitespace-spacetab-regexp))))
|
|
|
|
|
|
|
|
|
|
|
|
;;;###autoload
|
|
|
|
(defun whitespace-toggle-ateol-check ()
|
|
|
|
"Toggle the check for end-of-line space in the local buffer."
|
|
|
|
(interactive)
|
|
|
|
(let ((current-val whitespace-check-buffer-ateol))
|
|
|
|
(setq whitespace-check-buffer-ateol (not current-val))
|
|
|
|
(message "Will%s check for end-of-line space in buffer."
|
|
|
|
(if whitespace-check-buffer-ateol "" " not"))
|
|
|
|
(if whitespace-check-buffer-ateol
|
|
|
|
(whitespace-buffer-search whitespace-ateol-regexp))))
|
|
|
|
|
|
|
|
|
1999-09-10 02:42:59 +00:00
|
|
|
;;;###autoload
|
1999-09-07 11:28:47 +00:00
|
|
|
(defun whitespace-buffer (&optional quiet)
|
2000-10-15 17:07:55 +00:00
|
|
|
"Find five different types of white spaces in buffer.
|
|
|
|
These are:
|
1999-09-07 11:28:47 +00:00
|
|
|
1. Leading space \(empty lines at the top of a file\).
|
|
|
|
2. Trailing space \(empty lines at the end of a file\).
|
|
|
|
3. Indentation space \(8 or more spaces, that should be replaced with TABS\).
|
|
|
|
4. Spaces followed by a TAB. \(Almost always, we never want that\).
|
|
|
|
5. Spaces or TABS at the end of a line.
|
|
|
|
|
|
|
|
Check for whitespace only if this buffer really contains a non-empty file
|
|
|
|
and:
|
|
|
|
1. the major mode is one of the whitespace-modes, or
|
1999-09-10 02:42:59 +00:00
|
|
|
2. `whitespace-buffer' was explicitly called with a prefix argument."
|
1999-09-07 11:28:47 +00:00
|
|
|
(interactive)
|
1999-10-30 19:21:43 +00:00
|
|
|
(let ((whitespace-error nil))
|
|
|
|
(whitespace-check-whitespace-mode current-prefix-arg)
|
|
|
|
(if (and buffer-file-name (> (buffer-size) 0) whitespace-mode)
|
|
|
|
(progn
|
|
|
|
(whitespace-check-buffer-list (buffer-name) buffer-file-name)
|
|
|
|
(whitespace-tickle-timer)
|
2001-12-13 17:34:57 +00:00
|
|
|
(whitespace-unhighlight-the-space)
|
1999-10-30 19:21:43 +00:00
|
|
|
(if whitespace-auto-cleanup
|
|
|
|
(if buffer-read-only
|
|
|
|
(if (not quiet)
|
|
|
|
(message "Can't cleanup: %s is read-only" (buffer-name)))
|
|
|
|
(whitespace-cleanup))
|
2001-03-22 21:30:11 +00:00
|
|
|
(let ((whitespace-leading (if whitespace-check-buffer-leading
|
1999-10-30 19:21:43 +00:00
|
|
|
(whitespace-buffer-leading)
|
|
|
|
nil))
|
2001-03-22 21:30:11 +00:00
|
|
|
(whitespace-trailing (if whitespace-check-buffer-trailing
|
1999-10-30 19:21:43 +00:00
|
|
|
(whitespace-buffer-trailing)
|
|
|
|
nil))
|
2001-03-22 21:30:11 +00:00
|
|
|
(whitespace-indent (if whitespace-check-buffer-indent
|
1999-09-14 22:30:11 +00:00
|
|
|
(whitespace-buffer-search
|
1999-10-30 19:21:43 +00:00
|
|
|
whitespace-indent-regexp)
|
1999-09-14 22:30:11 +00:00
|
|
|
nil))
|
2001-03-22 21:30:11 +00:00
|
|
|
(whitespace-spacetab (if whitespace-check-buffer-spacetab
|
1999-10-30 19:21:43 +00:00
|
|
|
(whitespace-buffer-search
|
|
|
|
whitespace-spacetab-regexp)
|
|
|
|
nil))
|
2001-03-22 21:30:11 +00:00
|
|
|
(whitespace-ateol (if whitespace-check-buffer-ateol
|
1999-10-30 19:21:43 +00:00
|
|
|
(whitespace-buffer-search
|
|
|
|
whitespace-ateol-regexp)
|
|
|
|
nil))
|
|
|
|
(whitespace-errmsg nil)
|
|
|
|
(whitespace-filename buffer-file-name)
|
|
|
|
(whitespace-this-modeline ""))
|
|
|
|
|
|
|
|
;; Now let's complain if we found any of the above.
|
|
|
|
(setq whitespace-error (or whitespace-leading whitespace-indent
|
|
|
|
whitespace-spacetab whitespace-ateol
|
|
|
|
whitespace-trailing))
|
|
|
|
|
|
|
|
(if whitespace-error
|
1999-09-07 11:28:47 +00:00
|
|
|
(progn
|
1999-10-30 19:21:43 +00:00
|
|
|
(setq whitespace-errmsg
|
|
|
|
(concat whitespace-filename " contains:\n"
|
|
|
|
(if whitespace-leading
|
|
|
|
"Leading whitespace\n")
|
|
|
|
(if whitespace-indent
|
|
|
|
(concat "Indentation whitespace"
|
|
|
|
whitespace-indent "\n"))
|
|
|
|
(if whitespace-spacetab
|
|
|
|
(concat "Space followed by Tab"
|
|
|
|
whitespace-spacetab "\n"))
|
|
|
|
(if whitespace-ateol
|
|
|
|
(concat "End-of-line whitespace"
|
|
|
|
whitespace-ateol "\n"))
|
|
|
|
(if whitespace-trailing
|
|
|
|
"Trailing whitespace\n")
|
|
|
|
"\ntype `M-x whitespace-cleanup' to "
|
|
|
|
"cleanup the file."))
|
|
|
|
(setq whitespace-this-modeline
|
|
|
|
(concat (if whitespace-ateol "e")
|
|
|
|
(if whitespace-indent "i")
|
|
|
|
(if whitespace-leading "l")
|
|
|
|
(if whitespace-spacetab "s")
|
|
|
|
(if whitespace-trailing "t")))))
|
|
|
|
(whitespace-update-modeline whitespace-this-modeline)
|
2005-04-08 14:40:57 +00:00
|
|
|
(if (get-buffer whitespace-errbuf)
|
|
|
|
(kill-buffer whitespace-errbuf))
|
|
|
|
(with-current-buffer (get-buffer-create whitespace-errbuf)
|
1999-10-30 19:21:43 +00:00
|
|
|
(if whitespace-errmsg
|
|
|
|
(progn
|
|
|
|
(insert whitespace-errmsg)
|
|
|
|
(if (not (or quiet whitespace-silent))
|
2005-04-08 14:40:57 +00:00
|
|
|
(display-buffer (current-buffer) t))
|
1999-10-30 19:21:43 +00:00
|
|
|
(if (not quiet)
|
|
|
|
(message "Whitespaces: [%s%s] in %s"
|
|
|
|
whitespace-this-modeline
|
|
|
|
(let ((whitespace-unchecked
|
|
|
|
(whitespace-unchecked-whitespaces)))
|
|
|
|
(if whitespace-unchecked
|
|
|
|
(concat "!" whitespace-unchecked)
|
|
|
|
""))
|
|
|
|
whitespace-filename)))
|
2003-09-29 18:05:31 +00:00
|
|
|
(if (and (not quiet) (not (equal whitespace-clean-msg "")))
|
|
|
|
(message "%s %s" whitespace-filename
|
|
|
|
whitespace-clean-msg))))))))
|
2005-04-08 14:40:57 +00:00
|
|
|
whitespace-error))
|
1999-09-07 11:28:47 +00:00
|
|
|
|
1999-09-10 02:42:59 +00:00
|
|
|
;;;###autoload
|
1999-09-07 11:28:47 +00:00
|
|
|
(defun whitespace-region (s e)
|
2000-10-15 17:07:55 +00:00
|
|
|
"Check the region for whitespace errors."
|
1999-09-07 11:28:47 +00:00
|
|
|
(interactive "r")
|
|
|
|
(save-excursion
|
|
|
|
(save-restriction
|
|
|
|
(narrow-to-region s e)
|
|
|
|
(whitespace-buffer))))
|
|
|
|
|
1999-09-10 02:42:59 +00:00
|
|
|
;;;###autoload
|
1999-09-07 11:28:47 +00:00
|
|
|
(defun whitespace-cleanup ()
|
1999-09-10 02:42:59 +00:00
|
|
|
"Cleanup the five different kinds of whitespace problems.
|
|
|
|
|
|
|
|
Use \\[describe-function] whitespace-describe to read a summary of the
|
|
|
|
whitespace problems."
|
1999-09-07 11:28:47 +00:00
|
|
|
(interactive)
|
|
|
|
;; If this buffer really contains a file, then run, else quit.
|
|
|
|
(whitespace-check-whitespace-mode current-prefix-arg)
|
|
|
|
(if (and buffer-file-name whitespace-mode)
|
|
|
|
(let ((whitespace-any nil)
|
|
|
|
(whitespace-tabwith 8)
|
|
|
|
(whitespace-tabwith-saved tab-width))
|
|
|
|
|
|
|
|
;; since all printable TABS should be 8, irrespective of how
|
|
|
|
;; they are displayed.
|
|
|
|
(setq tab-width whitespace-tabwith)
|
|
|
|
|
2001-03-22 21:30:11 +00:00
|
|
|
(if (and whitespace-check-buffer-leading
|
1999-09-14 22:30:11 +00:00
|
|
|
(whitespace-buffer-leading))
|
1999-09-07 11:28:47 +00:00
|
|
|
(progn
|
|
|
|
(whitespace-buffer-leading-cleanup)
|
|
|
|
(setq whitespace-any t)))
|
|
|
|
|
2001-03-22 21:30:11 +00:00
|
|
|
(if (and whitespace-check-buffer-trailing
|
1999-09-14 22:30:11 +00:00
|
|
|
(whitespace-buffer-trailing))
|
1999-09-07 11:28:47 +00:00
|
|
|
(progn
|
|
|
|
(whitespace-buffer-trailing-cleanup)
|
|
|
|
(setq whitespace-any t)))
|
|
|
|
|
2001-03-22 21:30:11 +00:00
|
|
|
(if (and whitespace-check-buffer-indent
|
1999-09-14 22:30:11 +00:00
|
|
|
(whitespace-buffer-search whitespace-indent-regexp))
|
1999-09-07 11:28:47 +00:00
|
|
|
(progn
|
|
|
|
(whitespace-indent-cleanup)
|
|
|
|
(setq whitespace-any t)))
|
|
|
|
|
2001-03-22 21:30:11 +00:00
|
|
|
(if (and whitespace-check-buffer-spacetab
|
1999-09-14 22:30:11 +00:00
|
|
|
(whitespace-buffer-search whitespace-spacetab-regexp))
|
1999-09-07 11:28:47 +00:00
|
|
|
(progn
|
|
|
|
(whitespace-buffer-cleanup whitespace-spacetab-regexp "\t")
|
|
|
|
(setq whitespace-any t)))
|
|
|
|
|
2001-03-22 21:30:11 +00:00
|
|
|
(if (and whitespace-check-buffer-ateol
|
1999-09-14 22:30:11 +00:00
|
|
|
(whitespace-buffer-search whitespace-ateol-regexp))
|
1999-09-07 11:28:47 +00:00
|
|
|
(progn
|
|
|
|
(whitespace-buffer-cleanup whitespace-ateol-regexp "")
|
|
|
|
(setq whitespace-any t)))
|
|
|
|
|
|
|
|
;; Call this recursively till everything is taken care of
|
1999-09-14 22:30:11 +00:00
|
|
|
(if whitespace-any
|
|
|
|
(whitespace-cleanup)
|
1999-09-07 11:28:47 +00:00
|
|
|
(progn
|
2003-06-11 04:00:33 +00:00
|
|
|
(if (not whitespace-silent)
|
|
|
|
(message "%s clean" buffer-file-name))
|
1999-10-30 19:21:43 +00:00
|
|
|
(whitespace-update-modeline)))
|
1999-09-07 11:28:47 +00:00
|
|
|
(setq tab-width whitespace-tabwith-saved))))
|
|
|
|
|
1999-09-10 02:42:59 +00:00
|
|
|
;;;###autoload
|
1999-09-07 11:28:47 +00:00
|
|
|
(defun whitespace-cleanup-region (s e)
|
2000-10-15 17:07:55 +00:00
|
|
|
"Whitespace cleanup on the region."
|
1999-09-07 11:28:47 +00:00
|
|
|
(interactive "r")
|
|
|
|
(save-excursion
|
|
|
|
(save-restriction
|
|
|
|
(narrow-to-region s e)
|
|
|
|
(whitespace-cleanup))
|
|
|
|
(whitespace-buffer t)))
|
|
|
|
|
|
|
|
(defun whitespace-buffer-leading ()
|
|
|
|
"Check to see if there are any empty lines at the top of the file."
|
|
|
|
(save-excursion
|
|
|
|
(let ((pmin nil)
|
|
|
|
(pmax nil))
|
|
|
|
(goto-char (point-min))
|
|
|
|
(beginning-of-line)
|
|
|
|
(setq pmin (point))
|
|
|
|
(end-of-line)
|
|
|
|
(setq pmax (point))
|
2005-04-11 23:47:54 +00:00
|
|
|
(if (equal pmin pmax)
|
2001-12-13 17:34:57 +00:00
|
|
|
(progn
|
2005-04-11 23:47:54 +00:00
|
|
|
(whitespace-highlight-the-space pmin (1+ pmax))
|
2001-12-13 17:34:57 +00:00
|
|
|
t)
|
1999-09-07 11:28:47 +00:00
|
|
|
nil))))
|
|
|
|
|
|
|
|
(defun whitespace-buffer-leading-cleanup ()
|
1999-09-10 02:42:59 +00:00
|
|
|
"Remove any empty lines at the top of the file."
|
1999-09-07 11:28:47 +00:00
|
|
|
(save-excursion
|
2005-07-08 22:33:00 +00:00
|
|
|
(goto-char (point-min))
|
|
|
|
(skip-chars-forward "\n")
|
|
|
|
(delete-region (point-min) (point))))
|
1999-09-07 11:28:47 +00:00
|
|
|
|
|
|
|
(defun whitespace-buffer-trailing ()
|
|
|
|
"Check to see if are is more than one empty line at the bottom."
|
|
|
|
(save-excursion
|
|
|
|
(let ((pmin nil)
|
|
|
|
(pmax nil))
|
|
|
|
(goto-char (point-max))
|
|
|
|
(beginning-of-line)
|
|
|
|
(setq pmin (point))
|
|
|
|
(end-of-line)
|
|
|
|
(setq pmax (point))
|
|
|
|
(if (equal pmin pmax)
|
|
|
|
(progn
|
|
|
|
(goto-char (- (point) 1))
|
|
|
|
(beginning-of-line)
|
|
|
|
(setq pmin (point))
|
|
|
|
(end-of-line)
|
|
|
|
(setq pmax (point))
|
2005-04-11 23:47:54 +00:00
|
|
|
(if (equal pmin pmax)
|
2001-12-13 17:34:57 +00:00
|
|
|
(progn
|
2005-04-11 23:47:54 +00:00
|
|
|
(whitespace-highlight-the-space (- pmin 1) pmax)
|
2001-12-13 17:34:57 +00:00
|
|
|
t)
|
1999-09-07 11:28:47 +00:00
|
|
|
nil))
|
|
|
|
nil))))
|
|
|
|
|
|
|
|
(defun whitespace-buffer-trailing-cleanup ()
|
|
|
|
"Delete all the empty lines at the bottom."
|
|
|
|
(save-excursion
|
2005-07-08 22:33:00 +00:00
|
|
|
(goto-char (point-max))
|
|
|
|
(skip-chars-backward "\n")
|
|
|
|
(if (not (bolp))
|
|
|
|
(forward-char 1))
|
|
|
|
(delete-region (point) (point-max))))
|
1999-09-07 11:28:47 +00:00
|
|
|
|
|
|
|
(defun whitespace-buffer-search (regexp)
|
|
|
|
"Search for any given whitespace REGEXP."
|
|
|
|
(let ((whitespace-retval ""))
|
|
|
|
(save-excursion
|
|
|
|
(goto-char (point-min))
|
|
|
|
(while (re-search-forward regexp nil t)
|
2001-12-13 17:34:57 +00:00
|
|
|
(progn
|
|
|
|
(setq whitespace-retval (format "%s %s" whitespace-retval
|
|
|
|
(match-beginning 0)))
|
|
|
|
(whitespace-highlight-the-space (match-beginning 0) (match-end 0))))
|
1999-09-07 11:28:47 +00:00
|
|
|
(if (equal "" whitespace-retval)
|
|
|
|
nil
|
|
|
|
whitespace-retval))))
|
|
|
|
|
|
|
|
(defun whitespace-buffer-cleanup (regexp newregexp)
|
|
|
|
"Search for any given whitespace REGEXP and replace it with the NEWREGEXP."
|
|
|
|
(save-excursion
|
|
|
|
(goto-char (point-min))
|
|
|
|
(while (re-search-forward regexp nil t)
|
|
|
|
(replace-match newregexp))))
|
|
|
|
|
|
|
|
(defun whitespace-indent-cleanup ()
|
1999-09-10 02:42:59 +00:00
|
|
|
"Search for 8/more spaces at the start of a line and replace it with tabs."
|
1999-09-07 11:28:47 +00:00
|
|
|
(save-excursion
|
|
|
|
(goto-char (point-min))
|
|
|
|
(while (re-search-forward whitespace-indent-regexp nil t)
|
|
|
|
(let ((column (current-column))
|
|
|
|
(indent-tabs-mode t))
|
|
|
|
(delete-region (match-beginning 0) (point))
|
|
|
|
(indent-to column)))))
|
|
|
|
|
1999-10-30 19:21:43 +00:00
|
|
|
(defun whitespace-unchecked-whitespaces ()
|
|
|
|
"Return the list of whitespaces whose testing has been suppressed."
|
2001-03-22 21:30:11 +00:00
|
|
|
(let ((unchecked-spaces
|
|
|
|
(concat (if (not whitespace-check-buffer-ateol) "e")
|
|
|
|
(if (not whitespace-check-buffer-indent) "i")
|
|
|
|
(if (not whitespace-check-buffer-leading) "l")
|
|
|
|
(if (not whitespace-check-buffer-spacetab) "s")
|
|
|
|
(if (not whitespace-check-buffer-trailing) "t"))))
|
|
|
|
(if (not (equal unchecked-spaces ""))
|
|
|
|
unchecked-spaces
|
1999-10-30 19:21:43 +00:00
|
|
|
nil)))
|
|
|
|
|
|
|
|
(defun whitespace-update-modeline (&optional whitespace-err)
|
2000-10-15 17:07:55 +00:00
|
|
|
"Update modeline with whitespace errors.
|
|
|
|
Also with whitespaces whose testing has been turned off."
|
1999-10-30 19:21:43 +00:00
|
|
|
(if whitespace-display-in-modeline
|
1999-10-31 13:59:19 +00:00
|
|
|
(progn
|
|
|
|
(setq whitespace-mode-line nil)
|
|
|
|
;; Whitespace errors
|
|
|
|
(if (and whitespace-err (not (equal whitespace-err "")))
|
|
|
|
(setq whitespace-mode-line whitespace-err))
|
|
|
|
;; Whitespace suppressed errors
|
|
|
|
(let ((whitespace-unchecked (whitespace-unchecked-whitespaces)))
|
|
|
|
(if whitespace-unchecked
|
|
|
|
(setq whitespace-mode-line
|
|
|
|
(concat whitespace-mode-line "!" whitespace-unchecked))))
|
|
|
|
;; Add the whitespace modeline prefix
|
|
|
|
(setq whitespace-mode-line (if whitespace-mode-line
|
|
|
|
(concat " W:" whitespace-mode-line)
|
|
|
|
nil))
|
2001-12-13 17:34:57 +00:00
|
|
|
(whitespace-mode-line-update))))
|
1999-09-14 22:30:11 +00:00
|
|
|
|
2001-12-13 17:34:57 +00:00
|
|
|
(defun whitespace-highlight-the-space (b e)
|
|
|
|
"Highlight the current line, unhighlighting a previously jumped to line."
|
|
|
|
(if whitespace-display-spaces-in-color
|
2005-04-08 14:40:57 +00:00
|
|
|
(let ((ol (whitespace-make-overlay b e)))
|
|
|
|
(push ol whitespace-highlighted-space)
|
2005-06-10 08:13:51 +00:00
|
|
|
(whitespace-overlay-put ol 'face 'whitespace-highlight))))
|
2001-12-13 17:34:57 +00:00
|
|
|
;; (add-hook 'pre-command-hook 'whitespace-unhighlight-the-space))
|
|
|
|
|
2005-04-11 18:39:13 +00:00
|
|
|
(defun whitespace-unhighlight-the-space()
|
2001-12-13 17:34:57 +00:00
|
|
|
"Unhighlight the currently highlight line."
|
|
|
|
(if (and whitespace-display-spaces-in-color whitespace-highlighted-space)
|
2005-04-08 14:40:57 +00:00
|
|
|
(progn
|
|
|
|
(mapc 'whitespace-delete-overlay whitespace-highlighted-space)
|
2001-12-13 17:34:57 +00:00
|
|
|
(setq whitespace-highlighted-space nil))
|
|
|
|
(remove-hook 'pre-command-hook 'whitespace-unhighlight-the-space)))
|
1999-09-07 11:28:47 +00:00
|
|
|
|
|
|
|
(defun whitespace-check-buffer-list (buf-name buf-file)
|
1999-09-10 02:42:59 +00:00
|
|
|
"Add a buffer and its file to the whitespace monitor list.
|
|
|
|
|
|
|
|
The buffer named BUF-NAME and its associated file BUF-FILE are now monitored
|
|
|
|
periodically for whitespace."
|
1999-09-07 11:28:47 +00:00
|
|
|
(if (and whitespace-mode (not (member (list buf-file buf-name)
|
|
|
|
whitespace-all-buffer-files)))
|
|
|
|
(add-to-list 'whitespace-all-buffer-files (list buf-file buf-name))))
|
|
|
|
|
|
|
|
(defun whitespace-tickle-timer ()
|
1999-09-10 02:42:59 +00:00
|
|
|
"Tickle timer to periodically to scan qualifying files for whitespace creep.
|
|
|
|
|
|
|
|
If timer is not set, then set it to scan the files in
|
|
|
|
`whitespace-all-buffer-files' periodically (defined by
|
|
|
|
`whitespace-rescan-timer-time') for whitespace creep."
|
1999-09-14 22:30:11 +00:00
|
|
|
(if (and whitespace-rescan-timer-time (not whitespace-rescan-timer))
|
1999-09-07 11:28:47 +00:00
|
|
|
(setq whitespace-rescan-timer
|
2000-10-15 17:07:55 +00:00
|
|
|
(add-timeout whitespace-rescan-timer-time
|
|
|
|
'whitespace-rescan-files-in-buffers nil
|
|
|
|
whitespace-rescan-timer-time))))
|
1999-09-07 11:28:47 +00:00
|
|
|
|
|
|
|
(defun whitespace-rescan-files-in-buffers (&optional arg)
|
1999-09-10 02:42:59 +00:00
|
|
|
"Check monitored files for whitespace creep since last scan."
|
1999-09-07 11:28:47 +00:00
|
|
|
(let ((whitespace-all-my-files whitespace-all-buffer-files)
|
1999-09-10 02:42:59 +00:00
|
|
|
buffile bufname thiselt buf)
|
1999-09-07 11:28:47 +00:00
|
|
|
(if (not whitespace-all-my-files)
|
|
|
|
(progn
|
2000-10-15 17:07:55 +00:00
|
|
|
(disable-timeout whitespace-rescan-timer)
|
1999-09-07 11:28:47 +00:00
|
|
|
(setq whitespace-rescan-timer nil))
|
|
|
|
(while whitespace-all-my-files
|
|
|
|
(setq thiselt (car whitespace-all-my-files))
|
|
|
|
(setq whitespace-all-my-files (cdr whitespace-all-my-files))
|
|
|
|
(setq buffile (car thiselt))
|
|
|
|
(setq bufname (cadr thiselt))
|
|
|
|
(setq buf (get-buffer bufname))
|
|
|
|
(if (buffer-live-p buf)
|
|
|
|
(save-excursion
|
|
|
|
;;(message "buffer %s live" bufname)
|
|
|
|
(set-buffer bufname)
|
|
|
|
(if whitespace-mode
|
|
|
|
(progn
|
|
|
|
;;(message "checking for whitespace in %s" bufname)
|
|
|
|
(if whitespace-auto-cleanup
|
|
|
|
(progn
|
|
|
|
;;(message "cleaning up whitespace in %s" bufname)
|
|
|
|
(whitespace-cleanup))
|
|
|
|
(progn
|
|
|
|
;;(message "whitespace-buffer %s." (buffer-name))
|
|
|
|
(whitespace-buffer t))))
|
|
|
|
;;(message "Removing %s from refresh list" bufname)
|
|
|
|
(whitespace-refresh-rescan-list buffile bufname)))
|
|
|
|
;;(message "Removing %s from refresh list" bufname)
|
|
|
|
(whitespace-refresh-rescan-list buffile bufname))))))
|
|
|
|
|
|
|
|
(defun whitespace-refresh-rescan-list (buffile bufname)
|
1999-09-10 02:42:59 +00:00
|
|
|
"Refresh the list of files to be rescaned for whitespace creep."
|
1999-09-07 11:28:47 +00:00
|
|
|
(if whitespace-all-buffer-files
|
2000-10-15 17:07:55 +00:00
|
|
|
(setq whitespace-all-buffer-files
|
|
|
|
(delete (list buffile bufname) whitespace-all-buffer-files))
|
|
|
|
(when whitespace-rescan-timer
|
|
|
|
(disable-timeout whitespace-rescan-timer)
|
|
|
|
(setq whitespace-rescan-timer nil))))
|
|
|
|
|
2004-08-22 17:04:22 +00:00
|
|
|
;;;###autoload
|
|
|
|
(defalias 'global-whitespace-mode 'whitespace-global-mode)
|
|
|
|
|
2000-10-15 17:07:55 +00:00
|
|
|
;;;###autoload
|
2002-09-11 21:30:25 +00:00
|
|
|
(define-minor-mode whitespace-global-mode
|
2000-10-15 17:07:55 +00:00
|
|
|
"Toggle using Whitespace mode in new buffers.
|
2003-09-29 18:05:31 +00:00
|
|
|
With ARG, turn the mode on iff ARG is positive.
|
2000-10-15 17:07:55 +00:00
|
|
|
|
|
|
|
When this mode is active, `whitespace-buffer' is added to
|
2002-09-11 21:30:25 +00:00
|
|
|
`find-file-hook' and `kill-buffer-hook'."
|
2003-05-13 14:30:58 +00:00
|
|
|
:global t
|
|
|
|
:group 'whitespace
|
2002-09-11 21:30:25 +00:00
|
|
|
(if whitespace-global-mode
|
1999-09-07 11:28:47 +00:00
|
|
|
(progn
|
2002-09-11 21:30:25 +00:00
|
|
|
(add-hook 'find-file-hook 'whitespace-buffer)
|
|
|
|
(add-hook 'write-file-functions 'whitespace-write-file-hook nil t)
|
2000-10-15 17:07:55 +00:00
|
|
|
(add-hook 'kill-buffer-hook 'whitespace-buffer))
|
2002-09-11 21:30:25 +00:00
|
|
|
(remove-hook 'find-file-hook 'whitespace-buffer)
|
|
|
|
(remove-hook 'write-file-functions 'whitespace-write-file-hook t)
|
2000-10-15 17:07:55 +00:00
|
|
|
(remove-hook 'kill-buffer-hook 'whitespace-buffer)))
|
1999-09-07 11:28:47 +00:00
|
|
|
|
2001-08-20 20:56:08 +00:00
|
|
|
;;;###autoload
|
|
|
|
(defun whitespace-write-file-hook ()
|
2002-09-11 21:30:25 +00:00
|
|
|
"Hook function to be called on the buffer when whitespace check is enabled.
|
|
|
|
This is meant to be added buffer-locally to `write-file-functions'."
|
2001-08-20 20:56:08 +00:00
|
|
|
(interactive)
|
|
|
|
(let ((werr nil))
|
|
|
|
(if whitespace-auto-cleanup
|
|
|
|
(whitespace-cleanup)
|
|
|
|
(setq werr (whitespace-buffer)))
|
|
|
|
(if (and whitespace-abort-on-error werr)
|
|
|
|
(error (concat "Abort write due to whitespaces in "
|
|
|
|
buffer-file-name))))
|
|
|
|
nil)
|
|
|
|
|
2000-10-15 17:07:55 +00:00
|
|
|
(defun whitespace-unload-hook ()
|
2002-09-11 21:30:25 +00:00
|
|
|
(remove-hook 'find-file-hook 'whitespace-buffer)
|
2002-09-13 06:21:51 +00:00
|
|
|
(remove-hook 'write-file-functions 'whitespace-write-file-hook t)
|
2000-10-15 17:07:55 +00:00
|
|
|
(remove-hook 'kill-buffer-hook 'whitespace-buffer))
|
|
|
|
|
2004-10-16 15:26:23 +00:00
|
|
|
(add-hook 'whitespace-unload-hook 'whitespace-unload-hook)
|
|
|
|
|
1999-09-07 11:28:47 +00:00
|
|
|
(provide 'whitespace)
|
2003-09-01 15:45:59 +00:00
|
|
|
|
2005-04-08 14:40:57 +00:00
|
|
|
;; arch-tag: 4ff44e87-b63c-402d-95a6-15e51e58bd0c
|
1999-09-07 11:28:47 +00:00
|
|
|
;;; whitespace.el ends here
|