;ELC ;;; Compiled by pot@pot.cnuce.cnr.it on Tue Mar 18 15:53:24 2003 ;;; from file /home/pot/gnu/emacs-pretest.new/lisp/whitespace.el ;;; in Emacs version 21.3 ;;; with bytecomp version 2.85.4.1 ;;; with all optimizations. ;;; This file uses dynamic docstrings, first added in Emacs 19.29. (if (and (boundp 'emacs-version) (< (aref emacs-version (1- (length emacs-version))) ?A) (or (and (boundp 'epoch::version) epoch::version) (string-lessp emacs-version "19.29"))) (error "`whitespace.el' was compiled for Emacs 19.29 or later")) ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; #@36 Version of the whitespace library. (defvar whitespace-version "3.1" (#$ . 622)) #@177 An associated list of buffers and files checked for whitespace cleanliness. This is to enable periodic checking of whitespace cleanliness in the files visited by the buffers. (defvar whitespace-all-buffer-files nil (#$ . 709)) #@75 Timer object used to rescan the files in buffers that have been modified. (defvar whitespace-rescan-timer nil (#$ . 943)) #@57 Non-nil when Whitespace mode (a minor mode) is enabled. (defvar whitespace-mode nil (#$ . 1071)) (byte-code "\300\301!\210\302\301\303\304#\207" [make-variable-buffer-local whitespace-mode put permanent-local nil] 4) #@57 String to display in the mode line for Whitespace mode. (defvar whitespace-mode-line nil (#$ . 1294)) (byte-code "\300\301!\210\302\301\303\304#\207" [make-variable-buffer-local whitespace-mode-line put permanent-local nil] 4) #@57 Test leading whitespace for file in current buffer if t (defvar whitespace-check-buffer-leading nil (#$ . 1527)) (byte-code "\300\301!\210\302\301\303\304#\207" [make-variable-buffer-local whitespace-check-buffer-leading put permanent-local nil] 4) #@58 Test trailing whitespace for file in current buffer if t (defvar whitespace-check-buffer-trailing nil (#$ . 1782)) (byte-code "\300\301!\210\302\301\303\304#\207" [make-variable-buffer-local whitespace-check-buffer-trailing put permanent-local nil] 4) #@61 Test indentation whitespace for file in current buffer if t (defvar whitespace-check-buffer-indent nil (#$ . 2040)) (byte-code "\300\301!\210\302\301\303\304#\207" [make-variable-buffer-local whitespace-check-buffer-indent put permanent-local nil] 4) #@72 Test Space-followed-by-TABS whitespace for file in current buffer if t (defvar whitespace-check-buffer-spacetab nil (#$ . 2297)) (byte-code "\300\301!\210\302\301\303\304#\207" [make-variable-buffer-local whitespace-check-buffer-spacetab put permanent-local nil] 4) #@61 Test end-of-line whitespace for file in current buffer if t (defvar whitespace-check-buffer-ateol nil (#$ . 2569)) (byte-code "\300\301!\210\302\301\303\304#\210\305\306!\203\307\310\304\311\312\313%\210\202&\307\310\304\311\314\315\312\316&\210\304\207" [make-variable-buffer-local whitespace-check-buffer-ateol put permanent-local nil featurep xemacs custom-declare-group whitespace "Check for and fix five different types of whitespaces in source code." :group editing :version "21.1" convenience] 8) #@159 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' (custom-declare-variable 'whitespace-check-leading-whitespace 't '(#$ . 3084) :type 'boolean :group 'whitespace) #@161 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' (custom-declare-variable 'whitespace-check-trailing-whitespace 't '(#$ . 3362) :type 'boolean :group 'whitespace) #@165 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' (custom-declare-variable 'whitespace-check-spacetab-whitespace 't '(#$ . 3643) :type 'boolean :group 'whitespace) #@44 Regexp to match a space followed by a TAB. (custom-declare-variable 'whitespace-spacetab-regexp '" " '(#$ . 3927) :type 'regexp :group 'whitespace) #@162 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' (custom-declare-variable 'whitespace-check-indent-whitespace 'indent-tabs-mode '(#$ . 4083) :type 'boolean :group 'whitespace) #@77 Regexp to match (any TABS followed by) 8/more whitespaces at start of line. (custom-declare-variable 'whitespace-indent-regexp '(concat "^\\( *\\) " " ") '(#$ . 4377) :type 'regexp :group 'whitespace) #@161 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' (custom-declare-variable 'whitespace-check-ateol-whitespace 't '(#$ . 4591) :type 'boolean :group 'whitespace) #@46 Regexp to match a TAB or a space at the EOL. (custom-declare-variable 'whitespace-ateol-regexp '"[ ]$" '(#$ . 4868) :type 'regexp :group 'whitespace) #@74 The name of the buffer where whitespace related messages will be logged. (custom-declare-variable 'whitespace-errbuf '"*Whitespace Errors*" '(#$ . 5025) :type 'string :group 'whitespace) #@132 While writing a file, abort if the file is unclean. If `whitespace-auto-cleanup' is set, that takes precedence over this variable. (custom-declare-variable 'whitespace-abort-on-error 'nil '(#$ . 5219) :type 'boolean :group 'whitespace) #@66 Cleanup a buffer automatically on finding it whitespace unclean. (custom-declare-variable 'whitespace-auto-cleanup 'nil '(#$ . 5461) :type 'boolean :group 'whitespace) #@278 All whitespace errors will be shown only in the modeline when t. 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 Errors*' buffer before opening (or closing) another file. (custom-declare-variable 'whitespace-silent 'nil '(#$ . 5636) :type 'boolean :group 'whitespace) #@394 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 following to your `.emacs': (setq whitespace-modes (cons 'my-mode (cons 'my-other-mode whitespace-modes))) Or, alternately, you can use the Emacs `customize' command to set this. (custom-declare-variable 'whitespace-modes ''(ada-mode asm-mode autoconf-mode awk-mode c-mode c++-mode cc-mode change-log-mode cperl-mode 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 sh-mode shell-script-mode simula-mode tcl-mode tex-mode texinfo-mode vrml-mode xml-mode) '(#$ . 6017) :type '(repeat symbol) :group 'whitespace) #@259 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 modified buffers. To disable timer scans, set this to zero. (custom-declare-variable 'whitespace-rescan-timer-time '600 '(#$ . 6964) :type 'integer :group 'whitespace) #@44 Display whitespace errors on the modeline. (custom-declare-variable 'whitespace-display-in-modeline 't '(#$ . 7336) :type 'boolean :group 'whitespace) (byte-code "\306\307\"\204 \310B\311\312 \"\210\311\313\n\"\210\311\314 \"\210\311\315\f\"\210\311\316 \"\207" [minor-mode-alist whitespace-check-leading-whitespace whitespace-check-trailing-whitespace whitespace-check-indent-whitespace whitespace-check-spacetab-whitespace whitespace-check-ateol-whitespace assoc whitespace-mode (whitespace-mode whitespace-mode-line) set-default whitespace-check-buffer-leading whitespace-check-buffer-trailing whitespace-check-buffer-indent whitespace-check-buffer-spacetab whitespace-check-buffer-ateol] 3) #@57 Test and set the whitespace-mode in qualifying buffers. (defalias 'whitespace-check-whitespace-mode #[(&optional arg) "?\205 \204\n \235\205\304\211\207" [whitespace-mode arg major-mode whitespace-modes t] 2 (#$ . 8041)]) #@57 Toggle the check for leading space in the local buffer. (defalias 'whitespace-toggle-leading-check #[nil "\211?\302\303\203\304\202\305\"\210\205\306 )\207" [whitespace-check-buffer-leading current-val message "Will%s check for leading space in buffer." "" " not" whitespace-buffer-leading] 4 (#$ . 8277) nil]) #@58 Toggle the check for trailing space in the local buffer. (defalias 'whitespace-toggle-trailing-check #[nil "\211?\302\303\203\304\202\305\"\210\205\306 )\207" [whitespace-check-buffer-trailing current-val message "Will%s check for trailing space in buffer." "" " not" whitespace-buffer-trailing] 4 (#$ . 8605) nil]) #@61 Toggle the check for indentation space in the local buffer. (defalias 'whitespace-toggle-indent-check #[nil "\211?\303\304\203\305\202\306\"\210\205\307\n!)\207" [whitespace-check-buffer-indent current-val whitespace-indent-regexp message "Will%s check for indentation space in buffer." "" " not" whitespace-buffer-search] 4 (#$ . 8938) nil]) #@66 Toggle the check for space-followed-by-TABs in the local buffer. (defalias 'whitespace-toggle-spacetab-check #[nil "\211?\303\304\203\305\202\306\"\210\205\307\n!)\207" [whitespace-check-buffer-spacetab current-val whitespace-spacetab-regexp message "Will%s check for space-followed-by-TABs in buffer." "" " not" whitespace-buffer-search] 4 (#$ . 9298) nil]) #@61 Toggle the check for end-of-line space in the local buffer. (defalias 'whitespace-toggle-ateol-check #[nil "\211?\303\304\203\305\202\306\"\210\205\307\n!)\207" [whitespace-check-buffer-ateol current-val whitespace-ateol-regexp message "Will%s check for end-of-line space in buffer." "" " not" whitespace-buffer-search] 4 (#$ . 9674) nil]) #@556 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). 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 2. `whitespace-buffer' was explicitly called with a prefix argument. (defalias 'whitespace-buffer #[(&optional quiet) "\306\307 !\210\n\203E\310 \311V\203E \203E\312\313 \n\"\210\314 \210\f\203: \2034+\204E\315\316\313 \"\210\202E\317 \210\202E,\205A\320 -\205H\321 .\205Q\322/!0\205Z\3221!2\205c\3223!\306\n\323456789:\211;\206\2139\206\2138\206\2137\206\213:\211\203\3455\324;\205\231\3259\205\243\3269\327Q8\205\255\3308\327Q7\205\267\3317\327Q:\205\275\332\333\334\260 67\205\311\3359\205\317\336;\205\325\3378\205\333\340:\205\341\341\2604\3424!\210\212\343\203/\351>P\2020\323)5$\210\202C+\204C\315\3525\"\210. \205J\346)\207" [whitespace-error current-prefix-arg buffer-file-name whitespace-mode whitespace-auto-cleanup buffer-read-only nil whitespace-check-whitespace-mode buffer-size 0 whitespace-check-buffer-list buffer-name whitespace-tickle-timer message "Can't cleanup: %s is read-only" whitespace-cleanup whitespace-buffer-leading whitespace-buffer-trailing whitespace-buffer-search "" " contains:\n" "Leading whitespace\n" "Indentation whitespace" "\n" "Space followed by Tab" "End-of-line whitespace" "Trailing whitespace\n" "\ntype `M-x whitespace-cleanup' to " "cleanup the file." "e" "i" "l" "s" "t" whitespace-update-modeline get-buffer-create kill-buffer display-buffer t "Whitespaces: [%s%s] in %s" whitespace-unchecked-whitespaces "!" "%s clean" quiet whitespace-check-buffer-leading whitespace-check-buffer-trailing whitespace-check-buffer-indent whitespace-indent-regexp whitespace-check-buffer-spacetab whitespace-spacetab-regexp whitespace-check-buffer-ateol whitespace-ateol-regexp whitespace-this-modeline whitespace-filename whitespace-errmsg whitespace-ateol whitespace-spacetab whitespace-indent whitespace-trailing whitespace-leading whitespace-errbuf whitespace-silent whitespace-unchecked] 10 (#$ . 10032) nil]) #@41 Check the region for whitespace errors. (defalias 'whitespace-region #[(s e) "\212\214 }\210\302 *\207" [s e whitespace-buffer] 2 (#$ . 12563) "r"]) #@150 Cleanup the five different kinds of whitespace problems. Use \[describe-function] whitespace-describe to read a summary of the whitespace problems. (defalias 'whitespace-cleanup #[nil "\306!\210 \205\210\n\205\210\307\310  \203%\311 \203%\312 \210\313\2035\314 \2035\315 \210\313\203G\316!\203G\317 \210\313\203\\\316!\203\\\320\321\"\210\313\203q\316!\203q\320\322\"\210\313\203|\323 \210\202\204\324\325 \"\210\326 \210\f\211+\207" [current-prefix-arg buffer-file-name whitespace-mode tab-width whitespace-tabwith-saved whitespace-tabwith whitespace-check-whitespace-mode nil 8 whitespace-buffer-leading whitespace-buffer-leading-cleanup t whitespace-buffer-trailing whitespace-buffer-trailing-cleanup whitespace-buffer-search whitespace-indent-cleanup whitespace-buffer-cleanup " " "" whitespace-cleanup message "%s clean" whitespace-update-modeline whitespace-any whitespace-check-buffer-leading whitespace-check-buffer-trailing whitespace-check-buffer-indent whitespace-indent-regexp whitespace-check-buffer-spacetab whitespace-spacetab-regexp whitespace-check-buffer-ateol whitespace-ateol-regexp] 3 (#$ . 12720) nil]) #@35 Whitespace cleanup on the region. (defalias 'whitespace-cleanup-region #[(s e) "\212\214 }\210\302 \210)\303\304!)\207" [s e whitespace-cleanup whitespace-buffer t] 2 (#$ . 13905) "r"]) #@67 Check to see if there are any empty lines at the top of the file. (defalias 'whitespace-buffer-leading #[nil "\212\302\211eb\210\303 \210`\302\210` \232\205\304+\207" [pmax pmin nil beginning-of-line t] 2 (#$ . 14098)]) #@48 Remove any empty lines at the top of the file. (defalias 'whitespace-buffer-leading-cleanup #[nil "\212\302\211eb\210\303 \210`\302\210` \232\205\304 \210\305 +\207" [pmax pmin nil beginning-of-line kill-line whitespace-buffer-leading-cleanup] 2 (#$ . 14332)]) #@64 Check to see if are is more than one empty line at the bottom. (defalias 'whitespace-buffer-trailing #[nil "\212\302\211db\210\303 \210`\302\210` \232\205-`Sb\210\303 \210`\302\210` \232\205-\304+\207" [pmax pmin nil beginning-of-line t] 2 (#$ . 14607)]) #@43 Delete all the empty lines at the bottom. (defalias 'whitespace-buffer-trailing-cleanup #[nil "\212\302\211db\210\303 \210`\302\210` \232\2058 Sb\210\303 \210`\302\210` \232\2058dSb\210\303 \210\304 \210\305 +\207" [pmax pmin nil beginning-of-line kill-line whitespace-buffer-trailing-cleanup] 2 (#$ . 14880)]) #@41 Search for any given whitespace REGEXP. (defalias 'whitespace-buffer-search #[(regexp) "\302\212eb\210\303 \304\305#\203\306\307\310\224#\202\302\232?\205 *\207" [whitespace-retval regexp "" re-search-forward nil t format "%s %s" 0] 4 (#$ . 15209)]) #@75 Search for any given whitespace REGEXP and replace it with the NEWREGEXP. (defalias 'whitespace-buffer-cleanup #[(regexp newregexp) "\212eb\210\302\303\304#\205\305 !\210\202)\207" [regexp newregexp re-search-forward nil t replace-match] 4 (#$ . 15475)]) #@75 Search for 8/more spaces at the start of a line and replace it with tabs. (defalias 'whitespace-indent-cleanup #[nil "\212eb\210\303\304\305#\205i\305\306\224`|\210\nj\210*\202)\207" [whitespace-indent-regexp indent-tabs-mode column re-search-forward nil t 0] 4 (#$ . 15741)]) #@67 Return the list of whitespaces whose testing has been suppressed. (defalias 'whitespace-unchecked-whitespaces #[nil "?\205\306 ?\205\f\307\n?\205\310 ?\205\311\f?\205\312\260\211\313\232?\205) )\207" [whitespace-check-buffer-ateol whitespace-check-buffer-indent whitespace-check-buffer-leading whitespace-check-buffer-spacetab whitespace-check-buffer-trailing unchecked-spaces "e" "i" "l" "s" "t" ""] 6 (#$ . 16031)]) #@98 Update modeline with whitespace errors. Also with whitespaces whose testing has been turned off. (defalias 'whitespace-update-modeline #[(&optional whitespace-err) "\205)\304\n\203\n\305\232\204\n\306 \211\203 \307 Q) \205&\310 P\311 \207" [whitespace-display-in-modeline whitespace-mode-line whitespace-err whitespace-unchecked nil "" whitespace-unchecked-whitespaces "!" " W:" whitespace-force-mode-line-update] 4 (#$ . 16468)]) #@60 Force the mode line update for different flavors of Emacs. (defalias 'whitespace-force-mode-line-update #[nil "\300\301!\203 \301 \207\302 \207" [fboundp redraw-modeline force-mode-line-update] 2 (#$ . 16919)]) #@166 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. (defalias 'whitespace-check-buffer-list #[(buf-name buf-file) "\205 \nD \235?\205\304\303 \nD\"\207" [whitespace-mode buf-file buf-name whitespace-all-buffer-files add-to-list] 4 (#$ . 17138)]) #@241 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. (defalias 'whitespace-tickle-timer #[nil "\205 ?\205\302\303\304$\211\207" [whitespace-rescan-timer-time whitespace-rescan-timer add-timeout whitespace-rescan-files-in-buffers nil] 5 (#$ . 17509)]) #@61 Check monitored files for whitespace creep since last scan. (defalias 'whitespace-rescan-files-in-buffers #[(&optional arg) "\306\211\211\211\211\204\307!\210\306\211\202e \205e @ A\n@\n\211A@)\310 !\311 !\203]\212 q\210\203T\203M\312 \210\202Y\313\314!\210\202Y\315\f \"\210)\202\315\f \"\210\202-\207" [whitespace-all-buffer-files buf thiselt bufname buffile whitespace-all-my-files nil disable-timeout get-buffer buffer-live-p whitespace-cleanup whitespace-buffer t whitespace-refresh-rescan-list whitespace-rescan-timer x whitespace-mode whitespace-auto-cleanup] 6 (#$ . 17961)]) #@64 Refresh the list of files to be rescaned for whitespace creep. (defalias 'whitespace-refresh-rescan-list #[(buffile bufname) "\203 \304 \nD\"\211\207 \205\305 !\210\306\211\207" [whitespace-all-buffer-files buffile bufname whitespace-rescan-timer delete disable-timeout nil] 3 (#$ . 18585)]) #@164 Toggle global Whitespace mode. Setting this variable directly does not take effect; use either \[customize] or the function `whitespace-global-mode' (which see). (custom-declare-variable 'whitespace-global-mode 'nil '(#$ . 18891) :set (lambda (sym val) (whitespace-global-mode (or val 0))) :initialize 'custom-initialize-default :type 'boolean :group 'whitespace :require 'whitespace) #@207 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'. (defalias 'whitespace-global-mode #[(&optional arg) "\203\f\302!\303V\202 ?\211\203\"\304\305\306\"\210\304\307\310\"\210\304\311\306\"\207\312\305\306\"\210\312\307\310\"\210\312\311\306\"\207" [arg whitespace-global-mode prefix-numeric-value 0 add-hook find-file-hooks whitespace-buffer local-write-file-hooks whitespace-write-file-hook kill-buffer-hook remove-hook] 4 (#$ . 19284) "P"]) #@88 The local-write-file-hook to be called on the buffer when whitespace check is enabled. (defalias 'whitespace-write-file-hook #[nil "\304 \203\f\305 \210\202\306 \n\203\203\307\310 P!\210)\304\207" [werr whitespace-auto-cleanup whitespace-abort-on-error buffer-file-name nil whitespace-cleanup whitespace-buffer error "Abort write due to whitespaces in "] 3 (#$ . 19893) nil]) #@2177 A summary of whitespaces and what this library can do about them. The whitespace library is intended to find and help fix five different types of whitespace problems that commonly exist in source code. 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 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. Whitespace errors are reported in a buffer, and on the modeline. Modeline will show a W:! 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. l - Leading whitespace. s - Space followed by Tab. t - Trailing whitespace. If any of the whitespace checks is turned off, the modeline will display a !. (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.) 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 (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.) All the above have caused (and will cause) unwanted codeline integration and merge problems. 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). (defalias 'whitespace-describe #[nil "\301\302\"\207" [whitespace-version message "Use C-h f whitespace-describe to read about whitespace.el v%s."] 3 (#$ . 20287) nil]) (defalias 'whitespace-unload-hook #[nil "\300\301\302\"\210\300\303\304\"\210\300\305\302\"\207" [remove-hook find-file-hooks whitespace-buffer local-write-file-hooks whitespace-write-file-hook kill-buffer-hook] 3]) (provide 'whitespace)