;;; whitespace.el --- Warn about and clean bogus whitespaces in the file.
-;; Copyright (C) 1999 Free Software Foundation, Inc.
+;; Copyright (C) 1999-2000 Free Software Foundation, Inc.
-;; Author: Rajesh Vaidheeswarran <rv@dsmit.com>
+;; Author: Rajesh Vaidheeswarran <rv@gnu.org>
;; Keywords: convenience
;; This file is part of GNU Emacs.
;;; Code:
-;; add a hook to find-file-hooks and kill-buffer-hook
-(add-hook 'find-file-hooks 'whitespace-buffer)
-(add-hook 'kill-buffer-hook 'whitespace-buffer)
-
-(defvar whitespace-version "2.3" "Version of the whitespace library.")
-;; Find out what type of Emacs we are running in.
-(defvar whitespace-running-emacs (if (string-match "XEmacs\\|Lucid"
- emacs-version) nil t)
- "If this is Emacs, not XEmacs, this is t.")
-
-(if whitespace-running-emacs (require 'timer))
+(defvar whitespace-version "2.8" "Version of the whitespace library.")
(defvar whitespace-all-buffer-files nil
"An associated list of buffers and files checked for whitespace cleanliness.
(defvar whitespace-rescan-timer nil
"Timer object used to rescan the files in buffers that have been modified.")
-;; For users of Emacs 19.x, defgroup and defcustom are not defined.
+;; 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)
-(eval-when-compile
- (if (< (string-to-int emacs-version) 20)
- (progn
- (defmacro defgroup (sym memb doc &rest args)
- "Null macro for defgroup in all versions of Emacs < 20.x"
- t)
- (defmacro defcustom (sym val doc &rest args)
- "Macro to alias defcustom to defvar in all versions of Emacs < 20.x"
- `(defvar ,sym ,val ,doc)))))
+(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)
+;; For flavors of Emacs which don't define `defgroup' and `defcustom'.
+(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"
+ 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"
+ `(defvar ,sym ,val ,doc))))
+
+(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?
- :group (if whitespace-running-emacs 'convenience 'editing))
+ :group 'editing)
+(defgroup whitespace nil
+ "Check for and fix five different types of whitespaces in source code."
+ :version "21.1"
+ :group 'convenience))
(defcustom whitespace-check-leading-whitespace t
"Flag to check leading whitespace."
(defcustom whitespace-spacetab-regexp " \t"
"Regexp to match a space followed by a TAB."
- :type 'string
+ :type 'regexp
:group 'whitespace)
(defcustom whitespace-check-indent-whitespace t
(defcustom whitespace-indent-regexp (concat "^\\(\t*\\) " " ")
"Regexp to match (any TABS followed by) 8/more whitespaces at start of line."
- :type 'string
+ :type 'regexp
:group 'whitespace)
(defcustom whitespace-check-ateol-whitespace t
(defcustom whitespace-ateol-regexp "[ \t]$"
"Regexp to match a TAB or a space at the EOL."
- :type 'string
+ :type 'regexp
:group 'whitespace)
(defcustom whitespace-errbuf "*Whitespace Errors*"
- "The buffer where whitespace related messages will be logged."
+ "The name of the buffer where whitespace related messages will be logged."
:type 'string
:group 'whitespace)
"Major Modes in which we turn on whitespace checking.
-These are mostly programming and documentation modes. But you may add other
+These are mostly programming and documentation modes. But you may add other
modes that you want whitespaces checked in by adding something like the
following to your `.emacs':
whitespace-modes))\)
Or, alternately, you can use the Emacs `customize' command to set this."
+ :type '(repeat symbol)
:group 'whitespace)
-(defcustom whitespace-rescan-timer-time 60
+(defcustom whitespace-rescan-timer-time 600
"Period in seconds to rescan modified buffers for whitespace creep.
This is the period after which the timer will fire causing
:type 'integer
:group 'whitespace)
-;; 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)
+(defcustom whitespace-display-in-modeline t
+ "Display whitespace errors on the modeline."
+ :type 'boolean
+ :group 'whitespace)
(if (not (assoc 'whitespace-mode minor-mode-alist))
(setq minor-mode-alist (cons '(whitespace-mode whitespace-mode-line)
;;;###autoload
(defun whitespace-buffer (&optional quiet)
- "Find five different types of white spaces in buffer:
-
+ "Find five different types of white spaces in buffer.
+These are:
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\).
1. the major mode is one of the whitespace-modes, or
2. `whitespace-buffer' was explicitly called with a prefix argument."
(interactive)
- (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)
- (if whitespace-auto-cleanup
- (if (and (not quiet) buffer-read-only)
- (message "Can't Cleanup: %s is read-only." (buffer-name))
- (whitespace-cleanup))
- (let ((whitespace-leading (if whitespace-check-leading-whitespace
- (whitespace-buffer-leading)
- nil))
- (whitespace-trailing (if whitespace-check-trailing-whitespace
- (whitespace-buffer-trailing)
- nil))
- (whitespace-indent (if whitespace-check-indent-whitespace
- (whitespace-buffer-search
- whitespace-indent-regexp)
- nil))
- (whitespace-spacetab (if whitespace-check-spacetab-whitespace
+ (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)
+ (if whitespace-auto-cleanup
+ (if buffer-read-only
+ (if (not quiet)
+ (message "Can't cleanup: %s is read-only" (buffer-name)))
+ (whitespace-cleanup))
+ (let ((whitespace-leading (if whitespace-check-leading-whitespace
+ (whitespace-buffer-leading)
+ nil))
+ (whitespace-trailing (if whitespace-check-trailing-whitespace
+ (whitespace-buffer-trailing)
+ nil))
+ (whitespace-indent (if whitespace-check-indent-whitespace
(whitespace-buffer-search
- whitespace-spacetab-regexp)
+ whitespace-indent-regexp)
nil))
- (whitespace-ateol (if whitespace-check-ateol-whitespace
- (whitespace-buffer-search
- whitespace-ateol-regexp)
- nil))
- (whitespace-errmsg nil)
- (whitespace-error 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
- (progn
- (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 "
- "`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")))
- (setq whitespace-mode-line
- (concat " W:" whitespace-this-modeline))
- (whitespace-force-mode-line-update)))
-
- ;; Now test and set the whitespaces that are not checked.
- (whitespace-display-unchecked-whitespaces
- (if whitespace-error
- (concat " W:" whitespace-this-modeline)))
- (save-excursion
- (get-buffer-create whitespace-errbuf)
- (kill-buffer whitespace-errbuf)
- (get-buffer-create whitespace-errbuf)
- (set-buffer whitespace-errbuf)
- (if whitespace-errmsg
+ (whitespace-spacetab (if whitespace-check-spacetab-whitespace
+ (whitespace-buffer-search
+ whitespace-spacetab-regexp)
+ nil))
+ (whitespace-ateol (if whitespace-check-ateol-whitespace
+ (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
(progn
- (insert whitespace-errmsg)
- (if (not (or quiet whitespace-silent))
- (display-buffer whitespace-errbuf t))
- (if (not quiet)
- (message "Whitespaces: [%s] in %s"
- whitespace-this-modeline
- whitespace-filename)))
- (if (not quiet)
- (message "%s clean" whitespace-filename)))))))))
+ (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)
+ (save-excursion
+ (get-buffer-create whitespace-errbuf)
+ (kill-buffer whitespace-errbuf)
+ (get-buffer-create whitespace-errbuf)
+ (set-buffer whitespace-errbuf)
+ (if whitespace-errmsg
+ (progn
+ (insert whitespace-errmsg)
+ (if (not (or quiet whitespace-silent))
+ (display-buffer whitespace-errbuf t))
+ (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)))
+ (if (not quiet)
+ (message "%s clean" whitespace-filename))))))))
+ (if whitespace-error
+ t
+ nil)))
;;;###autoload
(defun whitespace-region (s e)
- "Check a region specified by point and mark for whitespace errors."
+ "Check the region for whitespace errors."
(interactive "r")
(save-excursion
(save-restriction
(whitespace-cleanup)
(progn
(message "%s clean" buffer-file-name)
- (setq whitespace-mode-line nil)
- (whitespace-force-mode-line-update)
- (whitespace-display-unchecked-whitespaces)))
+ (whitespace-update-modeline)))
(setq tab-width whitespace-tabwith-saved))))
;;;###autoload
(defun whitespace-cleanup-region (s e)
- "Whitespace cleanup on a region specified by point and mark."
+ "Whitespace cleanup on the region."
(interactive "r")
(save-excursion
(save-restriction
(delete-region (match-beginning 0) (point))
(indent-to column)))))
-(defun whitespace-display-unchecked-whitespaces (&optional whitespace-str)
- "Update modeline with whitespaces whose testing has been turned off."
+(defun whitespace-unchecked-whitespaces ()
+ "Return the list of whitespaces whose testing has been suppressed."
(let ((whitespace-this-modeline
(concat (if (not whitespace-check-ateol-whitespace) "e")
(if (not whitespace-check-indent-whitespace) "i")
(if (not whitespace-check-leading-whitespace) "l")
(if (not whitespace-check-spacetab-whitespace) "s")
(if (not whitespace-check-trailing-whitespace) "t"))))
- (setq whitespace-mode-line whitespace-str)
(if (not (equal whitespace-this-modeline ""))
- (setq whitespace-mode-line
- (concat whitespace-str " Woff:" whitespace-this-modeline)))
- (whitespace-force-mode-line-update)))
+ whitespace-this-modeline
+ nil)))
+
+(defun whitespace-update-modeline (&optional whitespace-err)
+ "Update modeline with whitespace errors.
+Also with whitespaces whose testing has been turned off."
+ (if whitespace-display-in-modeline
+ (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))
+ (whitespace-force-mode-line-update))))
;; Force mode line updation for different Emacs versions
(defun whitespace-force-mode-line-update ()
"Force the mode line update for different flavors of Emacs."
- (if whitespace-running-emacs
- (force-mode-line-update) ; Emacs
- (redraw-modeline))) ; XEmacs
+ (if (fboundp 'redraw-modeline)
+ (redraw-modeline) ; XEmacs
+ (force-mode-line-update))) ; Emacs
(defun whitespace-check-buffer-list (buf-name buf-file)
"Add a buffer and its file to the whitespace monitor list.
`whitespace-rescan-timer-time') for whitespace creep."
(if (and whitespace-rescan-timer-time (not whitespace-rescan-timer))
(setq whitespace-rescan-timer
- (if whitespace-running-emacs
- (run-at-time nil whitespace-rescan-timer-time
- 'whitespace-rescan-files-in-buffers)
- (add-timeout whitespace-rescan-timer-time
- 'whitespace-rescan-files-in-buffers nil
- whitespace-rescan-timer-time)))))
+ (add-timeout whitespace-rescan-timer-time
+ 'whitespace-rescan-files-in-buffers nil
+ whitespace-rescan-timer-time))))
(defun whitespace-rescan-files-in-buffers (&optional arg)
"Check monitored files for whitespace creep since last scan."
buffile bufname thiselt buf)
(if (not whitespace-all-my-files)
(progn
- (if whitespace-running-emacs
- (cancel-timer whitespace-rescan-timer)
- (disable-timeout whitespace-rescan-timer))
+ (disable-timeout whitespace-rescan-timer)
(setq whitespace-rescan-timer nil))
(while whitespace-all-my-files
(setq thiselt (car whitespace-all-my-files))
(defun whitespace-refresh-rescan-list (buffile bufname)
"Refresh the list of files to be rescaned for whitespace creep."
(if whitespace-all-buffer-files
+ (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))))
+
+;;;###autoload
+(defcustom whitespace-global-mode nil
+ "Toggle global Whitespace mode.
+
+Setting this variable directly does not take effect;
+use either \\[customize] or the function `whitespace-global-mode'
+\(which see)."
+ :set (lambda (sym val)
+ (whitespace-global-mode (or value 0)))
+ :initialize 'custom-initialize-default
+ :type 'boolean
+ :group 'whitespace
+ :require 'whitespace)
+
+(defun whitespace-global-mode (&optional arg)
+ "Toggle using Whitespace mode in new buffers.
+With ARG, turn the mode on if and only iff ARG is positive.
+
+When this mode is active, `whitespace-buffer' is added to
+`find-file-hooks' and `kill-buffer-hook'."
+ (interactive "P")
+ (setq arg (if arg
+ (> (prefix-numeric-value arg) 0)
+ (not whitespace-global-mode)))
+ (if arg
(progn
- (setq whitespace-all-buffer-files
- (delete (list buffile bufname) whitespace-all-buffer-files)))
- (progn
- (if (and whitespace-running-emacs (timerp whitespace-rescan-timer))
- (cancel-timer whitespace-rescan-timer))
- (if (and (not whitespace-running-emacs) whitespace-rescan-timer)
- (disable-timeout whitespace-rescan-timer))
- (if whitespace-rescan-timer
- (setq whitespace-rescan-timer nil)))))
+ (add-hook 'find-file-hooks 'whitespace-buffer)
+ (add-hook 'kill-buffer-hook 'whitespace-buffer))
+ (remove-hook 'find-file-hooks 'whitespace-buffer)
+ (remove-hook 'kill-buffer-hook 'whitespace-buffer)))
;;;###autoload
(defun whitespace-describe ()
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
replaced with TABS).
-4. Spaces followed by a TAB. (Almost always, we never want that).
+4. Spaces followed by a TAB. (Almost always, we never want that).
5. Spaces or TABS at the end of a line.
Whitespace errors are reported in a buffer, and on the modeline.
-Modeline will show a W:<x> to denote a particular type of whitespace, where
-`x' can be one (or more) of:
+Modeline will show a W:<x>!<y> to denote a particular type of whitespace,
+where `x' and `y' can be one (or more) of:
e - End-of-Line whitespace.
i - Indentation whitespace.
t - Trailing whitespace.
If any of the whitespace checks is turned off, the modeline will display a
-Woff:<x>, where `x' can be one (or more) of the above.
+!<y>.
(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
+ hardcoded to be 8 spaces. (Some of them allow configuration, but almost
always they default to 8.)
- Changing tab-width to other than 8 and editing will cause your code to
+ 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.
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
+ 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.)
merge problems.
whitespace.el will complain if it detects whitespaces on opening a file, and
-warn you on closing a file also. (if in case you had inserted any
-whitespaces during the process of your editing.)"
+warn you on closing a file also (in case you had inserted any
+whitespaces during the process of your editing)."
(interactive)
(message "Use C-h f whitespace-describe to read about whitespace.el v%s."
whitespace-version))
+(defun whitespace-unload-hook ()
+ (remove-hook 'find-file-hooks 'whitespace-buffer)
+ (remove-hook 'kill-buffer-hook 'whitespace-buffer))
+
(provide 'whitespace)
;;; whitespace.el ends here
HCoop / bpt / emacs.git / blobdiff