-;;; icomplete.el - minibuffer completion incremental feedback
-;;; This package is in the public domain.
+;;; icomplete.el --- minibuffer completion incremental feedback
-;;; Author: Ken Manheimer <klm@nist.gov>
-;;; Maintainer: Ken Manheimer <klm@nist.gov>
-;;; Version: icomplete.el,v 3.3 1993/12/11 11:27:35 klm Exp klm
-;;; Created: Mar 1993 klm@nist.gov - first release to usenet
-;;; Keywords: help, abbrev
+;; Copyright (C) 1992, 1993, 1994, 1997, 1999, 2001, 2002, 2003,
+;; 2004, 2005, 2006 Free Software Foundation, Inc.
+
+;; Author: Ken Manheimer <klm@i.am>
+;; Maintainer: Ken Manheimer <klm@i.am>
+;; Created: Mar 1993 Ken Manheimer, klm@nist.gov - first release to usenet
+;; Last update: Ken Manheimer <klm@i.am>, 11/18/1999.
+;; Keywords: help, abbrev
+
+;; This file is part of GNU Emacs.
+
+;; GNU Emacs is free software; you can redistribute it and/or modify
+;; it under the terms of the GNU General Public License as published by
+;; the Free Software Foundation; either version 2, or (at your option)
+;; any later version.
+
+;; GNU Emacs is distributed in the hope that it will be useful,
+;; but WITHOUT ANY WARRANTY; without even the implied warranty of
+;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+;; 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, Inc., 51 Franklin Street, Fifth Floor,
+;; Boston, MA 02110-1301, USA.
;;; Commentary:
-;;; Loading this package implements a more finely-grained completion
-;;; feedback scheme, indicating, within the minibuffer, the
-;;; prospective minibuffer completion candidates, as you type. See
-;;; the documentation string for 'icomplete-prompt' for a specific
-;;; description of icompletion.
+;; 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.
-;;; It should run on most version of Emacs 19 (including Lucid emacs
-;;; 19 - thanks to the efforts of Colin Rafferty (craffert@lehman.com)
-;;; - thanks, Colin!) This version of icomplete will *not* work on
-;;; Emacs 18 versions - the elisp archives, at
-;;; archive.cis.ohio-state.edu:/pub/gnu/emacs/elisp-archive, probably
-;;; still has a version that works in GNU Emacs v18.
+;; See `icomplete-completions' docstring for a description of the
+;; icomplete display format.
-;;; Thanks to Colin Rafferty for assistance reconciling for lemacs,
-;;; and to Michael Cook, who implemented an incremental completion
-;;; style in his 'iswitch' functions that served as the basis for
-;;; icomplete.
+;; See the `icomplete-minibuffer-setup-hook' docstring for a means to
+;; customize icomplete setup for interoperation with other
+;; minibuffer-oriented packages.
-;;; Code:
+;; To activate icomplete mode, load the package and use the
+;; `icomplete-mode' function. 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 Friedman (restructuring as minor mode), Colin
+;; Rafferty (lemacs reconciliation), Lars Lindberg, RMS, and others.
-;;;_* (Allout outline root topic. Please leave this in.)
+;; klm.
-;;;_ + Provide
+;;; Code:
+
+;;;_* Provide
(provide 'icomplete)
-;;;_ + User Customization variables
-;;;_ = icomplete-inhibit
-(defvar icomplete-inhibit nil
- "*Set this variable to t at any time to inhibit icomplete.")
+
+(defgroup icomplete nil
+ "Show completions dynamically in minibuffer."
+ :prefix "icomplete-"
+ :group 'minibuffer)
+
+;;;_* User Customization variables
+(defcustom icomplete-prospects-length 80
+ "*Length of string displaying the prospects."
+ :type 'integer
+ :group '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 features and packages. For instance:
+
+ \(add-hook 'icomplete-minibuffer-setup-hook
+ \(function
+ \(lambda ()
+ \(make-local-variable 'max-mini-window-height)
+ \(setq max-mini-window-height 3))))
+
+will constrain Emacs to a maximum minibuffer height of 3 lines when
+icompletion is occurring."
+ :type 'hook
+ :group 'icomplete)
+
+
+;;;_* Initialization
;;;_ + Internal Variables
-;;;_ = icomplete-eoinput 1
-(defvar icomplete-eoinput 1
+;;;_ = icomplete-eoinput nil
+(defvar icomplete-eoinput nil
"Point where minibuffer input ends and completion info begins.")
(make-variable-buffer-local 'icomplete-eoinput)
-
-;;;_ > icomplete-prime-session ()
+;;;_ = icomplete-pre-command-hook
+(defvar icomplete-pre-command-hook nil
+ "Incremental-minibuffer-completion pre-command-hook.
+
+Is run in minibuffer before user input when `icomplete-mode' is non-nil.
+Use `icomplete-mode' function to set it up properly for incremental
+minibuffer completion.")
+(add-hook 'icomplete-pre-command-hook 'icomplete-tidy)
+;;;_ = icomplete-post-command-hook
+(defvar icomplete-post-command-hook nil
+ "Incremental-minibuffer-completion post-command-hook.
+
+Is run in minibuffer after user input when `icomplete-mode' is non-nil.
+Use `icomplete-mode' function to set it up properly for incremental
+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 nil t))
+ (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-prime-session ()
-
- "Prep emacs v 19 for more finely-grained minibuffer completion-feedback.
-
-You can inhibit icomplete after loading by setting icomplete-inhibit
-non-nil. Set the var back to nil to re-enable icomplete."
-
- ;; For emacs v19.18 and later revs, the icomplete key function is
- ;; installed in 'minibuffer-setup-hook'. Global pre- and post-
- ;; command-hook functions are used in v19.17 and earlier v19 revs."
-
- (let* ((v19-rev (and (string-match "^19\\.\\([0-9]+\\)" emacs-version)
- (string-to-int (substring emacs-version
- (match-beginning 1)
- (match-end 1))))))
-
- (cond ((and v19-rev ; emacs v 19, some rev,
- (> v19-rev 17))
- ;; Post v19rev17, has minibuffer-setup-hook, use it:
- (add-hook 'minibuffer-setup-hook 'icomplete-prime-minibuffer))
- (v19-rev
- ;; v19rev17 and prior (including lucid): use global
- ;; pre- and post-command-hooks, instead:
- (add-hook 'pre-command-hook 'icomplete-pre-command-hook 'append)
- (add-hook 'post-command-hook
- 'icomplete-post-command-hook 'append))
- ((format "icomplete: non v19 emacs, %s - %s"
- emacs-version "try elisp-archive icomplete")))))
-;;;_ > icomplete-prime-minibuffer ()
-(defun icomplete-prime-minibuffer ()
-
- "Prep emacs, v 19.18 or later, for icomplete.
-
-\(In emacs v19.17 and earlier, and in lemacs, icomplete-prime-session
-is used, instead to establish global hooks.\)
-
-Run via minibuffer-setup-hook, adds icomplete pre- and post-command
-hooks at the start of each minibuffer."
-
- ;; Append the hooks to avoid as much as posssible interference from
- ;; other hooks that foul up minibuffer quit.
- (make-local-variable 'pre-command-hook)
- (make-local-variable 'post-command-hook)
- (add-hook 'pre-command-hook 'icomplete-pre-command-hook)
- (add-hook 'post-command-hook 'icomplete-post-command-hook))
-;;;_ > icomplete-window-minibuffer-p ()
-(defmacro icomplete-window-minibuffer-p ()
-
- "Returns non-nil if current window is a minibuffer window.
-
-Trivially equates to '(window-minibuffer-p (selected-window))', with
-the argument definitely provided for emacsen that require it, eg Lucid."
-
- '(window-minibuffer-p (selected-window)))
-
-;;;_ + Completion
-
-;;;_ - Completion feedback hooks
-;;;_ > icomplete-pre-command-hook ()
-(defun icomplete-pre-command-hook ()
- "Cleanup completions display before user's new command is dealt with."
- (if (and (icomplete-window-minibuffer-p)
- (not executing-macro)
- (not (symbolp minibuffer-completion-table))
- (not icomplete-inhibit))
- (if (and (boundp 'icomplete-eoinput)
- icomplete-eoinput)
- (if (> icomplete-eoinput (point-max))
- ;; Oops, got rug pulled out from under us - reinit:
- (setq icomplete-eoinput (point-max))
- (let ((buffer-undo-list buffer-undo-list )) ; prevent entry
- (delete-region icomplete-eoinput (point-max))))
- ;; Reestablish the local variable 'cause minibuffer-setup is weird:
- (make-local-variable 'icomplete-eoinput)
- (setq icomplete-eoinput 1))))
-;;;_ > icomplete-post-command-hook ()
-(defun icomplete-post-command-hook ()
- "Exhibit completions, leaving bookkeeping so pre- hook can tidy up."
-
- (if (and (icomplete-window-minibuffer-p) ; ... in a minibuffer.
- (not executing-macro)
- (not icomplete-inhibit) ; ... not specifically inhibited.
- ;(sit-for 0) ; ... redisplay and if there's input
- ; waiting, then don't icomplete
- ; (stigs suggestion) (too jumpy!)
- ;; Inhibit for file-name and other custom-func completions:
- (not (symbolp minibuffer-completion-table))
- )
- (let ((buffer-undo-list buffer-undo-list )) ; prevent entry
- (icomplete-exhibit))))
-;;;_ > icomplete-window-setup-hook ()
-(defun icomplete-window-setup-hook ()
- "Exhibit completions, leaving bookkeeping so pre- hook can tidy up."
-
- (if (and (icomplete-window-minibuffer-p) ; ... in a minibuffer.
- )
- (message "ic ws doing")(sit-for 1)))
-;;;_ > icomplete-exhibit ()
+(define-minor-mode icomplete-mode
+ "Toggle incremental minibuffer completion for this Emacs session.
+With a numeric argument, turn Icomplete mode on iff ARG is positive."
+ :global t :group 'icomplete
+ (if icomplete-mode
+ ;; The following is not really necessary after first time -
+ ;; no great loss.
+ (add-hook 'minibuffer-setup-hook 'icomplete-minibuffer-setup)
+ (remove-hook 'minibuffer-setup-hook 'icomplete-minibuffer-setup)))
+
+;;;_ > 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 mechanism,
+ like file-name and other custom-func completions)."
+
+ (and (window-minibuffer-p (selected-window))
+ (not executing-kbd-macro)
+ minibuffer-completion-table
+ ;; (or minibuffer-completing-file-name
+ (not (functionp minibuffer-completion-table)))) ;; )
+
+;;;_ > icomplete-minibuffer-setup ()
+(defun icomplete-minibuffer-setup ()
+ "Run in minibuffer on activation to establish incremental completion.
+Usually run by inclusion in `minibuffer-setup-hook'."
+ (when (and icomplete-mode (icomplete-simple-completing-p))
+ (add-hook 'pre-command-hook
+ (lambda () (run-hooks 'icomplete-pre-command-hook))
+ nil t)
+ (add-hook 'post-command-hook
+ (lambda () (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'
+and `minibuffer-setup-hook'."
+ (when icomplete-eoinput
+
+ (unless (>= icomplete-eoinput (point-max))
+ (let ((buffer-undo-list t)) ; prevent entry
+ (delete-region icomplete-eoinput (point-max))))
+
+ ;; Reestablish the safe value.
+ (setq icomplete-eoinput nil)))
+
+;;;_ > icomplete-exhibit ()
(defun icomplete-exhibit ()
- "Insert icomplete completions display."
- (if (not (symbolp minibuffer-completion-table))
- (let ((contents (buffer-substring (point-min)(point-max)))
- (buffer-undo-list t))
- (save-excursion
- (goto-char (point-max))
- ; Register the end of input, so we
- ; know where the extra stuff
- ; (match-status info) begins:
- (if (not (boundp 'icomplete-eoinput))
- ;; In case it got wiped out by major mode business:
- (make-local-variable 'icomplete-eoinput))
- (setq icomplete-eoinput (point))
+ "Insert icomplete completions display.
+Should be run via minibuffer `post-command-hook'. See `icomplete-mode'
+and `minibuffer-setup-hook'."
+ (when (icomplete-simple-completing-p)
+ (save-excursion
+ (goto-char (point-max))
+ ;; Register the end of input, so we know where the extra stuff
+ ;; (match-status info) begins:
+ (setq icomplete-eoinput (point))
; Insert the match-status information:
- (if (> (point-max) 1)
- (insert-string
- (icomplete-prompt contents
- minibuffer-completion-table
- minibuffer-completion-predicate
- (not
- minibuffer-completion-confirm))))))))
-
-;;;_ - Completion feedback producer
-;;;_ > icomplete-prompt (name candidates predicate require-match)
-(defun icomplete-prompt (name candidates predicate require-match)
+ (if (and (> (point-max) (minibuffer-prompt-end))
+ buffer-undo-list ; Wait for some user input.
+ (or
+ ;; Don't bother with delay after certain number of chars:
+ (> (- (point) (field-beginning)) icomplete-max-delay-chars)
+ ;; Don't delay if alternatives number is small enough:
+ (and (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)))
+ (let ((text (while-no-input
+ (list
+ (icomplete-completions
+ (field-string)
+ minibuffer-completion-table
+ minibuffer-completion-predicate
+ (not minibuffer-completion-confirm)))))
+ (buffer-undo-list t))
+ ;; Do nothing if while-no-input was aborted.
+ (if (consp text) (insert (car text))))))))
+
+;;;_ > icomplete-completions (name candidates predicate require-match)
+(defun icomplete-completions (name candidates predicate require-match)
"Identify prospective candidates for minibuffer completion.
The display is updated with each minibuffer keystroke during
\(...) - 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 disambiguous matches have \" [Matched]\" appended
-\(whether complete or not), or \" \[No matches]\", if no eligible
-matches exist."
+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.)"
+
+ ;; '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-determined (if require-match "(" "["))
- (close-bracket-determined (if require-match ")" "]"))
- ;"-prospects" - more than 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
- 'concat
- (cdr (apply 'append
- (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
-(icomplete-prime-session)
-
-
-;;;_ + Local emacs vars.
-'(
-Local variables:
-eval: (save-excursion
- (if (not (condition-case err (outline-mode t)
- (wrong-number-of-arguments nil)))
- (progn
- (message
- "Allout outline-mode not loaded, not adjusting buffer exposure")
- (sit-for 1))
- (message "Adjusting '%s' visibility" (buffer-name))
- (outline-lead-with-comment-string ";;;_")
- (goto-char 0)
- (outline-exposure -1 0)))
-End:)
-
+ (close-bracket-determined (if require-match ")" "]")))
+ ;; `concat'/`mapconcat' is the slow part. With the introduction of
+ ;; `icomplete-prospects-length', there is no need for `catch'/`throw'.
+ (if (null comps) (format " %sNo matches%s"
+ open-bracket-determined
+ close-bracket-determined)
+ (let* ((most-try (try-completion name (mapcar (function list) comps)))
+ (most (if (stringp most-try) most-try (car comps)))
+ (most-len (length most))
+ (determ (and (> most-len (length name))
+ (concat open-bracket-determined
+ (substring most (length name))
+ close-bracket-determined)))
+ ;;"-prospects" - more than one candidate
+ (prospects-len 0)
+ prospects most-is-exact comp)
+ (if (eq most-try t)
+ (setq prospects nil)
+ (while (and comps (< prospects-len icomplete-prospects-length))
+ (setq comp (substring (car comps) most-len)
+ comps (cdr comps))
+ (cond ((string-equal comp "") (setq most-is-exact t))
+ ((member comp prospects))
+ (t (setq prospects (cons comp prospects)
+ prospects-len (+ (length comp) 1 prospects-len))))))
+ (if prospects
+ (concat determ
+ "{"
+ (and most-is-exact ",")
+ (mapconcat 'identity
+ (sort prospects (function string-lessp))
+ ",")
+ (and comps ",...")
+ "}")
+ (concat determ
+ " [Matched"
+ (let ((keys (and icomplete-show-key-bindings
+ (commandp (intern-soft most))
+ (icomplete-get-keys most))))
+ (if keys (concat "; " keys) ""))
+ "]"))))))
+
+;;;_* Local emacs vars.
+;;;Local variables:
+;;;allout-layout: (-2 :)
+;;;End:
+
+;; arch-tag: 339ec25a-0741-4eb6-be63-997532e89b0f
;;; icomplete.el ends here
-