(diary-file): Doc fix.
[bpt/emacs.git] / lisp / iswitchb.el
index 068f5ff..4e89659 100644 (file)
@@ -1,7 +1,7 @@
 ;;; iswitchb.el --- switch between buffers using substrings
 
 ;; Copyright (C) 1996, 1997, 2000, 2001, 2002, 2003, 2004,
-;;   2005, 2006, 2007 Free Software Foundation, Inc.
+;;   2005, 2006, 2007, 2008 Free Software Foundation, Inc.
 
 ;; Author: Stephen Eglen <stephen@gnu.org>
 ;; Maintainer: Stephen Eglen <stephen@gnu.org>
 
 ;;; Code:
 
-;; CL needed for cadr and last
-(if (not (and (fboundp 'cadr)
-             (fboundp 'last)))
-    (require 'cl))
-
 (require 'font-lock)
 
-;; Set up the custom library.
-;; taken from http://www.dina.kvl.dk/~abraham/custom/
-(eval-and-compile
-  (condition-case ()
-      (require 'custom)
-    (error nil))
-  (if (and (featurep 'custom) (fboundp 'custom-declare-variable))
-      nil ;; We've got what we needed
-    ;; We have the old custom-library, hack around it!
-    (defmacro defgroup (&rest args)
-      nil)
-    (defmacro defcustom (var value doc &rest args)
-      `(defvar ,var ,value ,doc))))
-
 ;;; User Variables
 ;;
 ;; These are some things you might want to change.
@@ -289,7 +270,7 @@ is temporarily case sensitive."
   "*List of regexps or functions matching buffer names to ignore.
 For example, traditional behavior is not to list buffers whose names begin
 with a space, for which the regexp is `^ '.  See the source file for
-example functions that filter buffernames."
+example functions that filter buffer names."
   :type '(repeat (choice regexp function))
   :group 'iswitchb)
 (put 'iswitchb-buffer-ignore 'risky-local-variable t)
@@ -325,15 +306,14 @@ window with completion alternatives, or `iswitchb-next-match' or
   :type 'hook
   :group 'iswitchb)
 
-;;; Examples for setting the value of iswitchb-buffer-ignore
-;(defun iswitchb-ignore-c-mode (name)
-;  "Ignore all c mode buffers -- example function for iswitchb."
-;  (save-excursion
-;    (set-buffer name)
-;    (string-match "^C$" mode-name)))
+;; Examples for setting the value of iswitchb-buffer-ignore
+;;(defun iswitchb-ignore-c-mode (name)
+;;  "Ignore all c mode buffers -- example function for iswitchb."
+;;  (with-current-buffer name
+;;    (derived-mode-p 'c-mode)))
 
-;(setq iswitchb-buffer-ignore '("^ " iswitchb-ignore-c-mode))
-;(setq iswitchb-buffer-ignore '("^ " "\\.c$" "\\.h$"))
+;;(setq iswitchb-buffer-ignore '("^ " iswitchb-ignore-c-mode))
+;;(setq iswitchb-buffer-ignore '("^ " "\\.c\\'" "\\.h\\'"))
 
 (defcustom iswitchb-default-method  'always-frame
     "*How to switch to new buffer when using `iswitchb-buffer'.
@@ -374,7 +354,7 @@ See also `iswitchb-newbuffer'."
   :group 'iswitchb)
 
 (defcustom iswitchb-use-faces t
-  "*Non-nil means use font-lock fonts for showing first match."
+  "*Non-nil means use font-lock faces for showing first match."
   :type 'boolean
   :group 'iswitchb)
 (define-obsolete-variable-alias 'iswitchb-use-fonts 'iswitchb-use-faces "22.1")
@@ -396,7 +376,7 @@ See documentation of `walk-windows' for useful values.")
 (defcustom iswitchb-minibuffer-setup-hook nil
   "Iswitchb-specific customization of minibuffer setup.
 
-This hook is run during minibuffer setup iff `iswitchb' will be active.
+This hook is run during minibuffer setup if `iswitchb' is active.
 For instance:
 \(add-hook 'iswitchb-minibuffer-setup-hook
          '\(lambda () (set (make-local-variable 'max-mini-window-height) 3)))
@@ -541,9 +521,7 @@ selected.")
 
 ;;; ISWITCHB KEYMAP
 (defun iswitchb-define-mode-map ()
-  "Set up the keymap for `iswitchb-buffer'.
-This is obsolete.  Use \\[iswitchb-mode] or customize the
-variable `iswitchb-mode'."
+  "Set up the keymap for `iswitchb-buffer'."
   (interactive)
   (let (map)
     ;; generated every time so that it can inherit new functions.
@@ -564,6 +542,10 @@ variable `iswitchb-mode'."
     (setq iswitchb-mode-map map)
     (run-hooks 'iswitchb-define-mode-map-hook)))
 
+(make-obsolete 'iswitchb-define-mode-map
+              "use M-x iswitchb-mode or customize the variable `iswitchb-mode'."
+              "21.1")
+
 ;;; MAIN FUNCTION
 (defun iswitchb ()
   "Switch to buffer matching a substring.
@@ -624,7 +606,7 @@ Return the name of a buffer selected.
 PROMPT is the prompt to give to the user.
 DEFAULT if given is the default buffer to be selected, which will
 go to the front of the list.
-If REQUIRE-MATCH is non-nil, an existing-buffer must be selected.
+If REQUIRE-MATCH is non-nil, an existing buffer must be selected.
 If START is a string, the selection process is started with that
 string.
 If MATCHES-SET is non-nil, the buflist is not updated before
@@ -703,7 +685,7 @@ the selection process begins.  Used by isearchb.el."
   "Find common completion of `iswitchb-text' in `iswitchb-matches'.
 The result is stored in `iswitchb-common-match-string'."
 
-  (let* (val)
+  (let (val)
     (setq  iswitchb-common-match-string nil)
     (if (and iswitchb-matches
             (not iswitchb-regexp) ;; testing
@@ -793,8 +775,7 @@ If no buffer exactly matching the prompt exists, maybe create a new one."
   (setq iswitchb-exit 'findfile)
   (exit-minibuffer))
 
-(eval-when-compile
-  (defvar recentf-list))
+(defvar recentf-list)
 
 (defun iswitchb-next-match ()
   "Put first element of `iswitchb-matches' at the end of the list."
@@ -903,7 +884,7 @@ current frame, rather than all frames, regardless of value of
   "Set `iswitchb-matches' to the list of buffers matching prompt."
   (if iswitchb-rescan
       (setq iswitchb-matches
-           (let* ((buflist iswitchb-buflist))
+           (let ((buflist iswitchb-buflist))
              (iswitchb-get-matched-buffers iswitchb-text iswitchb-regexp
                                            buflist))
            iswitchb-virtual-buffers nil)))
@@ -913,7 +894,7 @@ current frame, rather than all frames, regardless of value of
   "Return buffers matching REGEXP.
 If STRING-FORMAT is nil, consider REGEXP as just a string.
 BUFFER-LIST can be list of buffers or list of strings."
-  (let* ((case-fold-search (iswitchb-case))
+  (let ((case-fold-search (iswitchb-case))
          name ret)
     (if (null string-format) (setq regexp (regexp-quote regexp)))
     (setq iswitchb-invalid-regexp nil)
@@ -1066,7 +1047,7 @@ Return the modified list with the last element prepended to it."
 ;;; VISIT CHOSEN BUFFER
 (defun iswitchb-visit-buffer (buffer)
   "Visit buffer named BUFFER according to `iswitchb-method'."
-  (let* (win  newframe)
+  (let (win newframe)
     (cond
      ((eq iswitchb-method 'samewindow)
       (switch-to-buffer buffer))
@@ -1138,9 +1119,7 @@ If BUFFER is visible in the current frame, return nil."
 (defun iswitchb-default-keybindings ()
   "Set up default keybindings for `iswitchb-buffer'.
 Call this function to override the normal bindings.  This function also
-adds a hook to the minibuffer.
-
-Obsolescent.  Use `iswitchb-mode'."
+adds a hook to the minibuffer."
   (interactive)
   (add-hook 'minibuffer-setup-hook 'iswitchb-minibuffer-setup)
   (global-set-key "\C-xb" 'iswitchb-buffer)
@@ -1148,6 +1127,8 @@ Obsolescent.  Use `iswitchb-mode'."
   (global-set-key "\C-x4\C-o" 'iswitchb-display-buffer)
   (global-set-key "\C-x5b" 'iswitchb-buffer-other-frame))
 
+(make-obsolete 'iswitchb-default-keybindings 'iswitchb-mode "21.1")
+
 (defun iswitchb-buffer ()
   "Switch to another buffer.
 
@@ -1250,9 +1231,8 @@ Copied from `icomplete-exhibit' with two changes:
          (insert (iswitchb-completions
                   contents))))))
 
-(eval-when-compile
-  (defvar most-len)
-  (defvar most-is-exact))
+(defvar most-len)
+(defvar most-is-exact)
 
 (defun iswitchb-output-completion (com)
   (if (= (length com) most-len)
@@ -1440,7 +1420,7 @@ This is an example function which can be hooked on to
     (iswitchb-to-end summaries)))
 
 (defun iswitchb-case ()
-  "Return non-nil iff we should ignore case when matching.
+  "Return non-nil if we should ignore case when matching.
 See the variable `iswitchb-case' for details."
   (if iswitchb-case
       (if (featurep 'xemacs)
@@ -1450,7 +1430,7 @@ See the variable `iswitchb-case' for details."
 ;;;###autoload
 (define-minor-mode iswitchb-mode
   "Toggle Iswitchb global minor mode.
-With arg, turn Iswitchb mode on if and only iff ARG is positive.
+With arg, turn Iswitchb mode on if ARG is positive, otherwise turn it off.
 This mode enables switching between buffers using substrings.  See
 `iswitchb' for details."
   nil nil iswitchb-global-map :global t :group 'iswitchb