;;; whitespace.el --- warn about and clean bogus whitespaces in the file
-;; Copyright (C) 1999, 2000, 2005 Free Software Foundation, Inc.
+;; Copyright (C) 1999, 2000, 2002, 2003, 2004,
+;; 2005, 2006 Free Software Foundation, Inc.
;; Author: Rajesh Vaidheeswarran <rv@gnu.org>
;; Keywords: convenience
(put 'whitespace-mode-line 'permanent-local nil)
(defvar whitespace-check-buffer-leading nil
- "Test leading whitespace for file in current buffer if t")
+ "Test leading whitespace for file in current buffer if t.")
(make-variable-buffer-local 'whitespace-check-buffer-leading)
(put 'whitespace-check-buffer-leading 'permanent-local nil)
(defvar whitespace-check-buffer-trailing nil
- "Test trailing whitespace for file in current buffer if t")
+ "Test trailing whitespace for file in current buffer if t.")
(make-variable-buffer-local 'whitespace-check-buffer-trailing)
(put 'whitespace-check-buffer-trailing 'permanent-local nil)
(defvar whitespace-check-buffer-indent nil
- "Test indentation whitespace for file in current buffer if t")
+ "Test indentation whitespace for file in current buffer if t.")
(make-variable-buffer-local 'whitespace-check-buffer-indent)
(put 'whitespace-check-buffer-indent 'permanent-local nil)
(defvar whitespace-check-buffer-spacetab nil
- "Test Space-followed-by-TABS whitespace for file in current buffer if t")
+ "Test Space-followed-by-TABS whitespace for file in current buffer if t.")
(make-variable-buffer-local 'whitespace-check-buffer-spacetab)
(put 'whitespace-check-buffer-spacetab 'permanent-local nil)
(defvar whitespace-check-buffer-ateol nil
- "Test end-of-line whitespace for file in current buffer if t")
+ "Test end-of-line whitespace for file in current buffer if t.")
(make-variable-buffer-local 'whitespace-check-buffer-ateol)
(put 'whitespace-check-buffer-ateol 'permanent-local nil)
(defvar whitespace-highlighted-space nil
- "The variable to store the extent to highlight")
+ "The variable to store the extent to highlight.")
(make-variable-buffer-local 'whitespace-highlighted-space)
(put 'whitespace-highlighted-space 'permanent-local nil)
(eval-when-compile
(if (not (fboundp 'defgroup))
(defmacro defgroup (sym memb doc &rest args)
- "Null macro for defgroup in all versions of Emacs that don't define
-defgroup"
+ "Null macro for `defgroup' in all versions of Emacs that don't define it."
t))
(if (not (fboundp 'defcustom))
(defmacro defcustom (sym val doc &rest args)
- "Macro to alias defcustom to defvar in all versions of Emacs that
-don't define defcustom"
+ "Macro to alias `defcustom' to `defvar' in all versions of Emacs that
+don't define it."
`(defvar ,sym ,val ,doc))))
-(if (fboundp 'make-overlay)
- (progn
- (defalias 'whitespace-make-overlay 'make-overlay)
- (defalias 'whitespace-overlay-put 'overlay-put)
- (defalias 'whitespace-delete-overlay 'delete-overlay)
- (defalias 'whitespace-overlay-start 'overlay-start)
- (defalias 'whitespace-overlay-end 'overlay-end)
- (defalias 'whitespace-mode-line-update 'force-mode-line-update))
- (defalias 'whitespace-make-overlay 'make-extent)
- (defalias 'whitespace-overlay-put 'set-extent-property)
- (defalias 'whitespace-delete-overlay 'delete-extent)
- (defalias 'whitespace-overlay-start 'extent-start)
- (defalias 'whitespace-overlay-end 'extent-end)
- (defalias 'whitespace-mode-line-update 'redraw-modeline))
-
-(if (featurep 'xemacs)
-(defgroup whitespace nil
- "Check for and fix five different types of whitespaces in source code."
- ;; Since XEmacs doesn't have a 'convenience group, use the next best group
- ;; which is 'editing?
- :link '(emacs-commentary-link "whitespace.el")
- :group 'editing)
+(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))
+
(defgroup whitespace nil
"Check for and fix five different types of whitespaces in source code."
:version "21.1"
:link '(emacs-commentary-link "whitespace.el")
- :group 'convenience))
+ ;; Since XEmacs doesn't have a 'convenience group, use the next best group
+ ;; which is 'editing?
+ :group (if (featurep 'xemacs) 'editing 'convenience))
(defcustom whitespace-check-leading-whitespace t
- "Flag to check leading whitespace. This is the global for the system.
+ "Flag to check leading whitespace. This is the global for the system.
It can be overriden by setting a buffer local variable
-`whitespace-check-buffer-leading'"
+`whitespace-check-buffer-leading'."
:type 'boolean
:group 'whitespace)
(defcustom whitespace-check-trailing-whitespace t
- "Flag to check trailing whitespace. This is the global for the system.
+ "Flag to check trailing whitespace. This is the global for the system.
It can be overriden by setting a buffer local variable
-`whitespace-check-buffer-trailing'"
+`whitespace-check-buffer-trailing'."
:type 'boolean
:group 'whitespace)
(defcustom whitespace-check-spacetab-whitespace t
- "Flag to check space followed by a TAB. This is the global for the system.
+ "Flag to check space followed by a TAB. This is the global for the system.
It can be overriden by setting a buffer local variable
-`whitespace-check-buffer-spacetab'"
+`whitespace-check-buffer-spacetab'."
:type 'boolean
:group 'whitespace)
:group 'whitespace)
(defcustom whitespace-check-indent-whitespace indent-tabs-mode
- "Flag to check indentation whitespace. This is the global for the system.
+ "Flag to check indentation whitespace. This is the global for the system.
It can be overriden by setting a buffer local variable
-`whitespace-check-buffer-indent'"
+`whitespace-check-buffer-indent'."
:type 'boolean
:group 'whitespace)
:group 'whitespace)
(defcustom whitespace-check-ateol-whitespace t
- "Flag to check end-of-line whitespace. This is the global for the system.
+ "Flag to check end-of-line whitespace. This is the global for the system.
It can be overriden by setting a buffer local variable
-`whitespace-check-buffer-ateol'"
+`whitespace-check-buffer-ateol'."
:type 'boolean
:group 'whitespace)
:group 'whitespace)
(defcustom whitespace-abort-on-error nil
- "While writing a file, abort if the file is unclean. If
-`whitespace-auto-cleanup' is set, that takes precedence over this
-variable."
+ "While writing a file, abort if the file is unclean.
+If `whitespace-auto-cleanup' is set, that takes precedence over
+this variable."
:type 'boolean
:group 'whitespace)
tcl-mode tex-mode texinfo-mode
vrml-mode xml-mode)
- "Major Modes in which we turn on whitespace checking.
+ "Major modes in which we turn on whitespace checking.
These are mostly programming and documentation modes. But you may add other
modes that you want whitespaces checked in by adding something like the
;;;###autoload
(defun whitespace-cleanup ()
"Cleanup the five different kinds of whitespace problems.
-
-Use \\[describe-function] whitespace-describe to read a summary of the
-whitespace problems."
+See `whitespace-buffer' docstring for a summary of the problems."
(interactive)
;; If this buffer really contains a file, then run, else quit.
(whitespace-check-whitespace-mode current-prefix-arg)