-;;;_. icomplete.el - minibuffer completion incremental feedback
+;;; icomplete.el --- minibuffer completion incremental feedback
-;;; Copyright (C) 1992, 1993, 1994 Free Software Foundation, Inc.
+;; Copyright (C) 1992, 1993, 1994, 1997 Free Software Foundation, Inc.
-;;; Author: Ken Manheimer <klm@nist.gov>
-;;; Maintainer: Ken Manheimer <klm@nist.gov>
-;;; Version: Id: icomplete.el,v 4.3 1994/08/31 18:48:29 klm Exp
-;;; Created: Mar 1993 klm@nist.gov - first release to usenet
-;;; Keywords: help, abbrev
+;; Author: Ken Manheimer <klm@python.org>
+;; Maintainer: Ken Manheimer <klm@python.org>
+;; Created: Mar 1993 klm@nist.gov - first release to usenet
+;; Keywords: help, abbrev
;; This file is part of GNU Emacs.
;; 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 Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
+;; along with GNU Emacs; see the file COPYING. If not, write to the
+;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
+;; Boston, MA 02111-1307, USA.
;;; Commentary:
-;;; Loading this package implements a more fine-grained minibuffer
-;;; completion feedback scheme. Prospective completions are concisely
-;;; indicated within the minibuffer itself, with each successive
-;;; keystroke.
-
-;;; See 'icomplete-completions' docstring for a description of the
-;;; icomplete display format.
-
-;;; See the `icomplete-minibuffer-setup-hook' docstring for a means to
-;;; customize icomplete setup for interoperation with other
-;;; minibuffer-oriented packages.
-
-;;; To activate icomplete mode, simply load the package. You can
-;;; subsequently deactivate it by invoking the function icomplete-mode
-;;; with a negative prefix-arg (C-U -1 ESC-x icomplete-mode). Also,
-;;; you can prevent activation of the mode during package load by
-;;; first setting the variable `icomplete-mode' to nil. Icompletion
-;;; can be enabled any time after the package is loaded by invoking
-;;; icomplete-mode without a prefix arg.
-
-;;; Thanks to everyone for their suggestions for refinements of this
-;;; package. I particularly have to credit Michael Cook, who
-;;; implemented an incremental completion style in his 'iswitch'
-;;; functions that served as a model for icomplete. Some other
-;;; contributors: Noah Freidman (restructuring as minor mode), Colin
-;;; Rafferty (lemacs reconciliation), Lars Lindberg, RMS, and
-;;; others.
-
-;;; klm.
+;; Loading this package implements a more fine-grained minibuffer
+;; completion feedback scheme. Prospective completions are concisely
+;; indicated within the minibuffer itself, with each successive
+;; keystroke.
+
+;; See `icomplete-completions' docstring for a description of the
+;; icomplete display format.
+
+;; See the `icomplete-minibuffer-setup-hook' docstring for a means to
+;; customize icomplete setup for interoperation with other
+;; minibuffer-oriented packages.
+
+;; To activate icomplete mode, simply add the following to .emacs:
+;; (icomplete-mode)
+;; You can subsequently deactivate it by invoking the function
+;; icomplete-mode with a negative prefix-arg (C-U -1 ESC-x
+;; icomplete-mode). Also, you can prevent activation of the mode
+;; during package load by first setting the variable `icomplete-mode'
+;; to nil. Icompletion can be enabled any time after the package is
+;; loaded by invoking icomplete-mode without a prefix arg.
+
+;; This version of icomplete runs on Emacs 19.18 and later. (It
+;; depends on the incorporation of minibuffer-setup-hook.) The elisp
+;; archives, ftp://archive.cis.ohio-state.edu/pub/gnu/emacs/elisp-archive,
+;; probably still has a version that works in GNU Emacs v18.
+
+;; Thanks to everyone for their suggestions for refinements of this
+;; package. I particularly have to credit Michael Cook, who
+;; implemented an incremental completion style in his 'iswitch'
+;; functions that served as a model for icomplete. Some other
+;; contributors: Noah Friedman (restructuring as minor mode), Colin
+;; Rafferty (lemacs reconciliation), Lars Lindberg, RMS, and others.
+
+;; klm.
;;; Code:
;;;_* Provide
(provide 'icomplete)
-;;;_* User Customization variables
-;;;_* Initialization
-;;;_ = icomplete-minibuffer-setup-hook
-(defvar icomplete-minibuffer-setup-hook nil
+(defgroup icomplete nil
+ "Show completions dynamically in minibuffer."
+ :prefix "icomplete-"
+ :group 'minibuffer)
+
+;;;_* User Customization variables
+(defcustom icomplete-mode nil
+ "*Non-nil enables incremental minibuffer completion.
+As text is typed into the minibuffer, prospective completions are indicated
+in the minibuffer.
+You must modify via \\[customize] for this variable to have an effect."
+ :set (lambda (symbol value)
+ (icomplete-mode (if value 1 -1)))
+ :initialize 'custom-initialize-default
+ :type 'boolean
+ :group 'icomplete
+ :require 'icomplete)
+
+(defcustom icomplete-compute-delay .3
+ "*Completions-computation stall, used only with large-number
+completions - see `icomplete-delay-completions-threshold'."
+ :type 'number
+ :group 'icomplete)
+
+(defcustom icomplete-delay-completions-threshold 400
+ "*Pending-completions number over which to apply icomplete-compute-delay."
+ :type 'integer
+ :group 'icomplete)
+
+(defcustom icomplete-max-delay-chars 3
+ "*Maximum number of initial chars to apply icomplete compute delay."
+ :type 'integer
+ :group 'icomplete)
+
+(defcustom icomplete-show-key-bindings t
+ "*If non-nil, show key bindings as well as completion for sole matches."
+ :type 'boolean
+ :group 'icomplete)
+
+(defcustom icomplete-minibuffer-setup-hook nil
"*Icomplete-specific customization of minibuffer setup.
This hook is run during minibuffer setup iff icomplete will be active.
It is intended for use in customizing icomplete for interoperation
with other packages. For instance:
- \(add-hook 'icomplete-minibuffer-setup-hook
+ \(add-hook 'icomplete-minibuffer-setup-hook
\(function
\(lambda ()
\(make-local-variable 'resize-minibuffer-window-max-height)
\(setq resize-minibuffer-window-max-height 3))))
will constrain rsz-mini to a maximum minibuffer height of 3 lines when
-icompletion is occurring.")
+icompletion is occurring."
+ :type 'hook
+ :group 'icomplete)
+
+
+;;;_* Initialization
;;;_ + Internal Variables
-;;;_ = icomplete-mode
-(defvar icomplete-mode t
- "Non-nil enables incremental minibuffer completion, once
-`\\[icomplete-mode]' function has set things up.")
;;;_ = icomplete-eoinput 1
(defvar icomplete-eoinput 1
"Point where minibuffer input ends and completion info begins.")
minibuffer completion.")
(add-hook 'icomplete-post-command-hook 'icomplete-exhibit)
+(defun icomplete-get-keys (func-name)
+ "Return strings naming keys bound to `func-name', or nil if none.
+Examines the prior, not current, buffer, presuming that current buffer
+is minibuffer."
+ (if (commandp func-name)
+ (save-excursion
+ (let* ((sym (intern func-name))
+ (buf (other-buffer))
+ (map (save-excursion (set-buffer buf) (current-local-map)))
+ (keys (where-is-internal sym map)))
+ (if keys
+ (concat "<"
+ (mapconcat 'key-description
+ (sort keys
+ #'(lambda (x y)
+ (< (length x) (length y))))
+ ", ")
+ ">"))))))
+
;;;_ > icomplete-mode (&optional prefix)
;;;###autoload
(defun icomplete-mode (&optional prefix)
- "Activate incremental minibuffer completion for this emacs session,
-or deactivate with negative prefix arg."
+ "Activate incremental minibuffer completion for this Emacs session.
+Deactivates with negative universal argument."
(interactive "p")
(or prefix (setq prefix 0))
(cond ((>= prefix 0)
;;;_ > icomplete-simple-completing-p ()
(defun icomplete-simple-completing-p ()
-
"Non-nil if current window is minibuffer that's doing simple completion.
Conditions are:
the selected window is a minibuffer,
and not in the middle of macro execution,
and minibuffer-completion-table is not a symbol (which would
- indicate some non-standard, non-simple completion mechansm,
+ indicate some non-standard, non-simple completion mechanism,
like file-name and other custom-func completions)."
(and (window-minibuffer-p (selected-window))
- (not executing-macro)
+ (not executing-kbd-macro)
(not (symbolp minibuffer-completion-table))))
+
;;;_ > icomplete-minibuffer-setup ()
;;;###autoload
(defun icomplete-minibuffer-setup ()
-
"Run in minibuffer on activation to establish incremental completion.
-
-Usually run by inclusion in minibuffer-setup-hook."
-
+Usually run by inclusion in `minibuffer-setup-hook'."
(cond ((and icomplete-mode (icomplete-simple-completing-p))
- (make-local-variable 'pre-command-hook)
- (setq pre-command-hook (copy-sequence pre-command-hook))
+ (make-local-hook 'pre-command-hook)
(add-hook 'pre-command-hook
(function (lambda ()
- (run-hooks 'icomplete-pre-command-hook))))
- (make-local-variable 'post-command-hook)
- (setq post-command-hook (copy-sequence post-command-hook))
+ (run-hooks 'icomplete-pre-command-hook)))
+ nil t)
+ (make-local-hook 'post-command-hook)
(add-hook 'post-command-hook
(function (lambda ()
- (run-hooks 'icomplete-post-command-hook))))
+ (run-hooks 'icomplete-post-command-hook)))
+ nil t)
(run-hooks 'icomplete-minibuffer-setup-hook))))
-
+\f
;;;_* Completion
;;;_ > icomplete-tidy ()
(defun icomplete-tidy ()
"Remove completions display \(if any) prior to new user input.
-
-Should be run in on the minibuffer pre-command-hook. See `icomplete-mode'
+Should be run in on the minibuffer `pre-command-hook'. See `icomplete-mode'
and `minibuffer-setup-hook'."
(if (icomplete-simple-completing-p)
(if (and (boundp 'icomplete-eoinput)
;; Reestablish the local variable 'cause minibuffer-setup is weird:
(make-local-variable 'icomplete-eoinput)
(setq icomplete-eoinput 1))))
+
;;;_ > icomplete-exhibit ()
(defun icomplete-exhibit ()
"Insert icomplete completions display.
-
-Should be run via minibuffer post-command-hook. See `icomplete-mode'
+Should be run via minibuffer `post-command-hook'. See `icomplete-mode'
and `minibuffer-setup-hook'."
(if (icomplete-simple-completing-p)
(let ((contents (buffer-substring (point-min)(point-max)))
(make-local-variable 'icomplete-eoinput))
(setq icomplete-eoinput (point))
; Insert the match-status information:
- (if (> (point-max) 1)
+ (if (and (> (point-max) 1)
+ (or
+ ;; Don't bother with delay after certain number of chars:
+ (> (point-max) icomplete-max-delay-chars)
+ ;; Don't delay if alternatives number is small enough:
+ (if minibuffer-completion-table
+ (cond ((numberp minibuffer-completion-table)
+ (< minibuffer-completion-table
+ icomplete-delay-completions-threshold))
+ ((sequencep minibuffer-completion-table)
+ (< (length minibuffer-completion-table)
+ icomplete-delay-completions-threshold))
+ ))
+ ;; Delay - give some grace time for next keystroke, before
+ ;; embarking on computing completions:
+ (sit-for icomplete-compute-delay)))
(insert-string
(icomplete-completions contents
minibuffer-completion-table
minibuffer-completion-predicate
(not
minibuffer-completion-confirm))))))))
+
;;;_ > icomplete-completions (name candidates predicate require-match)
(defun icomplete-completions (name candidates predicate require-match)
"Identify prospective candidates for minibuffer completion.
\(...) - a single prospect is identified and matching is enforced,
\[...] - a single prospect is identified but matching is optional, or
\{...} - multiple prospects, separated by commas, are indicated, and
- further input is required to distingish a single one.
+ further input is required to distinguish a single one.
+
+The displays for unambiguous matches have ` [Matched]' appended
+\(whether complete or not), or ` \[No matches]', if no eligible
+matches exist. \(Keybindings for uniquely matched commands
+are exhibited within the square braces.)"
-The displays for disambiguous matches have \" [Matched]\" appended
-\(whether complete or not), or \" \[No matches]\", if no eligible
-matches exist."
+ ;; 'all-completions' doesn't like empty
+ ;; minibuffer-completion-table's (ie: (nil))
+ (if (and (listp candidates) (null (car candidates)))
+ (setq candidates nil))
(let ((comps (all-completions name candidates predicate))
; "-determined" - only one candidate
(open-bracket-prospects "{")
(close-bracket-prospects "}")
)
- (cond ((null comps) (format " %sNo matches%s"
- open-bracket-determined
- close-bracket-determined))
- ((null (cdr comps)) ;one match
- (concat (if (and (> (length (car comps))
- (length name)))
- (concat open-bracket-determined
- (substring (car comps) (length name))
- close-bracket-determined)
- "")
- " [Matched]"))
- (t ;multiple matches
- (let* ((most (try-completion name candidates predicate))
- (most-len (length most))
- most-is-exact
- (alternatives
- (apply
- (function concat)
- (cdr (apply
- (function nconc)
- (mapcar '(lambda (com)
- (if (= (length com) most-len)
- ;; Most is one exact match,
- ;; note that and leave out
- ;; for later indication:
- (progn
- (setq most-is-exact t)
- ())
- (list ","
- (substring com
- most-len))))
- comps))))))
- (concat (and (> most-len (length name))
- (concat open-bracket-determined
- (substring most (length name))
- close-bracket-determined))
- open-bracket-prospects
- (if most-is-exact
- (concat "," alternatives)
- alternatives)
- close-bracket-prospects))))))
-
-;;;_ + Initialization
-;;; If user hasn't setq-default icomplete-mode to nil, then setup for
-;;; activation:
-(if icomplete-mode
- (icomplete-mode))
+ (catch 'input
+ (cond ((null comps) (format " %sNo matches%s"
+ open-bracket-determined
+ close-bracket-determined))
+ ((null (cdr comps)) ;one match
+ (concat (if (and (> (length (car comps))
+ (length name)))
+ (concat open-bracket-determined
+ (substring (car comps) (length name))
+ close-bracket-determined)
+ "")
+ " [Matched"
+ (let ((keys (and icomplete-show-key-bindings
+ (commandp (intern-soft (car comps)))
+ (icomplete-get-keys (car comps)))))
+ (if keys
+ (concat "; " keys)
+ ""))
+ "]"))
+ (t ;multiple matches
+ (let* ((most
+ (try-completion name candidates
+ (and predicate
+ ;; Wrap predicate in impatience - ie,
+ ;; `throw' up when pending input is
+ ;; noticed. Adds some overhead to
+ ;; predicate, but should be worth it.
+ (function
+ (lambda (item)
+ (if (input-pending-p)
+ (throw 'input "")
+ (apply predicate
+ item nil)))))))
+ (most-len (length most))
+ most-is-exact
+ (alternatives
+ (substring
+ (apply (function concat)
+ (mapcar (function
+ (lambda (com)
+ (if (input-pending-p)
+ (throw 'input ""))
+ (if (= (length com) most-len)
+ ;; Most is one exact match,
+ ;; note that and leave out
+ ;; for later indication:
+ (progn
+ (setq most-is-exact t)
+ ())
+ (concat ","
+ (substring com
+ most-len)))))
+ comps))
+ 1)))
+ (concat (and (> most-len (length name))
+ (concat open-bracket-determined
+ (substring most (length name))
+ close-bracket-determined))
+ open-bracket-prospects
+ (if most-is-exact
+ ;; Add a ',' at the front to indicate "complete but
+ ;; not unique":
+ (concat "," alternatives)
+ alternatives)
+ close-bracket-prospects)))))))
+(if icomplete-mode
+ (icomplete-mode 1))
;;;_* Local emacs vars.
;;;Local variables:
;;;End:
;;; icomplete.el ends here
-