;;; icomplete.el --- minibuffer completion incremental feedback
-;; Copyright (C) 1992, 1993, 1994, 1997, 1999, 2001
-;;; Free Software Foundation, Inc.
+;; Copyright (C) 1992, 1993, 1994, 1997, 1999, 2001, 2002, 2003,
+;; 2004, 2005, 2006, 2007, 2008, 2009 Free Software Foundation, Inc.
;; Author: Ken Manheimer <klm@i.am>
;; Maintainer: Ken Manheimer <klm@i.am>
;; This file is part of GNU Emacs.
-;; GNU Emacs is free software; you can redistribute it and/or modify
+;; 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.
+;; the Free Software Foundation, either version 3 of the License, 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
;; 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., 59 Temple Place - Suite 330,
-;; Boston, MA 02111-1307, USA.
+;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
;;; Commentary:
:prefix "icomplete-"
:group 'minibuffer)
-(defcustom icomplete-mode nil
- "*Toggle incremental minibuffer completion.
-As text is typed into the minibuffer, prospective completions are indicated
-in the minibuffer.
-Setting this variable directly does not take effect;
-use either \\[customize] or the function `icomplete-mode'."
- :set (lambda (symbol value)
- (icomplete-mode (if value 1 -1)))
- :initialize 'custom-initialize-default
- :type 'boolean
- :group 'icomplete
- :require 'icomplete)
+(defvar icomplete-prospects-length 80)
+(make-obsolete-variable
+ 'icomplete-prospects-length 'icomplete-prospects-height "23.1")
;;;_* User Customization variables
-(defcustom icomplete-prospects-length 80
- "*Length of string displaying the prospects."
+(defcustom icomplete-prospects-height
+ ;; 20 is an estimated common size for the prompt + minibuffer content, to
+ ;; try to guess the number of lines used up by icomplete-prospects-length.
+ (+ 1 (/ (+ icomplete-prospects-length 20) (window-width)))
+ "Maximum number of lines to use in the minibuffer."
:type 'integer
- :group 'icomplete)
+ :group 'icomplete
+ :version "23.1")
(defcustom icomplete-compute-delay .3
- "*Completions-computation stall, used only with large-number
-completions - see `icomplete-delay-completions-threshold'."
+ "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."
+ "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."
+ "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."
+ "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.
+ "Icomplete-specific customization of minibuffer setup.
-This hook is run during minibuffer setup iff icomplete will be active.
+This hook is run during minibuffer setup if icomplete is active.
It is intended for use in customizing icomplete for interoperation
with other features and packages. For instance:
;;;_* Initialization
;;;_ + Internal Variables
-;;;_ = icomplete-eoinput 1
-(defvar icomplete-eoinput 1
- "Point where minibuffer input ends and completion info begins.")
-(make-variable-buffer-local 'icomplete-eoinput)
+;;;_ = icomplete-eoinput nil
+(defvar icomplete-overlay (make-overlay (point-min) (point-min) nil t t)
+ "Overlay used to display the list of completions.")
+
;;;_ = icomplete-pre-command-hook
(defvar icomplete-pre-command-hook nil
"Incremental-minibuffer-completion pre-command-hook.
(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.
+ "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)
+ (when (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))))
- ", ")
- ">"))))))
+ (buf (other-buffer nil t))
+ (keys (with-current-buffer buf (where-is-internal sym))))
+ (when keys
+ (concat "<"
+ (mapconcat 'key-description
+ (sort keys
+ #'(lambda (x y)
+ (< (length x) (length y))))
+ ", ")
+ ">"))))))
+;;;_ = icomplete-with-completion-tables
+(defvar icomplete-with-completion-tables '(internal-complete-buffer)
+ "Specialized completion tables with which icomplete should operate.
+
+Icomplete does not operate with any specialized completion tables
+except those on this list.")
;;;_ > icomplete-mode (&optional prefix)
;;;###autoload
-(defun icomplete-mode (&optional arg)
+(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."
- (interactive "P")
- (let ((on-p (if (null arg)
- (not icomplete-mode)
- (> (prefix-numeric-value arg) 0))))
- (setq icomplete-mode on-p)
- (when on-p
+With a numeric argument, turn Icomplete mode on if ARG is positive,
+otherwise turn it off."
+ :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))))
+ (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 ()
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
+ 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)
- (not (symbolp minibuffer-completion-table))))
+ minibuffer-completion-table
+ (or (not (functionp minibuffer-completion-table))
+ (eq icomplete-with-completion-tables t)
+ (member minibuffer-completion-table
+ icomplete-with-completion-tables))))
;;;_ > 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'."
- (cond ((and icomplete-mode (icomplete-simple-completing-p))
- (add-hook 'pre-command-hook
- (function (lambda ()
- (run-hooks 'icomplete-pre-command-hook)))
- nil t)
- (add-hook 'post-command-hook
- (function (lambda ()
- (run-hooks 'icomplete-post-command-hook)))
- nil t)
- (run-hooks 'icomplete-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
"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'."
- (if (icomplete-simple-completing-p)
- (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))))
+ (delete-overlay icomplete-overlay))
;;;_ > icomplete-exhibit ()
(defun icomplete-exhibit ()
"Insert icomplete completions display.
Should be run via minibuffer `post-command-hook'. See `icomplete-mode'
and `minibuffer-setup-hook'."
- (if (icomplete-simple-completing-p)
- (let ((contents (buffer-substring (minibuffer-prompt-end)(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))
+ (when (and icomplete-mode (icomplete-simple-completing-p))
+ (save-excursion
+ (goto-char (point-max))
; Insert the match-status information:
- (if (and (> (point-max) (minibuffer-prompt-end))
- (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
- (icomplete-completions contents
- minibuffer-completion-table
- minibuffer-completion-predicate
- (not
- minibuffer-completion-confirm))))))))
+ (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
+ (icomplete-completions
+ (field-string)
+ minibuffer-completion-table
+ minibuffer-completion-predicate
+ (not minibuffer-completion-confirm))))
+ (buffer-undo-list t)
+ deactivate-mark)
+ ;; Do nothing if while-no-input was aborted.
+ (when (stringp text)
+ (move-overlay icomplete-overlay (point) (point) (current-buffer))
+ ;; The current C cursor code doesn't know to use the overlay's
+ ;; marker's stickiness to figure out whether to place the cursor
+ ;; before or after the string, so let's spoon-feed it the pos.
+ (put-text-property 0 1 'cursor t text)
+ (overlay-put icomplete-overlay 'after-string text)))))))
;;;_ > icomplete-completions (name candidates predicate require-match)
(defun icomplete-completions (name candidates predicate require-match)
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 ")" "]")))
- ;; `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)))
- (open-bracket-prospects "{")
- (close-bracket-prospects "}")
- ;"-prospects" - more than one candidate
- (prospects-len 0)
- prospects most-is-exact comp)
- (if (eq most-try t)
+ (let* ((comps (completion-all-sorted-completions))
+ (last (if (consp comps) (last comps)))
+ (base-size (cdr last))
+ (open-bracket (if require-match "(" "["))
+ (close-bracket (if require-match ")" "]")))
+ ;; `concat'/`mapconcat' is the slow part.
+ (if (not (consp comps))
+ (format " %sNo matches%s" open-bracket close-bracket)
+ (if last (setcdr last nil))
+ (let* ((most-try
+ (if (and base-size (> base-size 0))
+ (completion-try-completion
+ name candidates predicate (length name))
+ ;; If the `comps' are 0-based, the result should be
+ ;; the same with `comps'.
+ (completion-try-completion
+ name comps nil (length name))))
+ (most (if (consp most-try) (car most-try)
+ (if most-try (car comps) "")))
+ ;; Compare name and most, so we can determine if name is
+ ;; a prefix of most, or something else.
+ (compare (compare-strings name nil nil
+ most nil nil completion-ignore-case))
+ (determ (unless (or (eq t compare) (eq t most-try)
+ (= (setq compare (1- (abs compare)))
+ (length most)))
+ (concat open-bracket
+ (cond
+ ((= compare (length name))
+ ;; Typical case: name is a prefix.
+ (substring most compare))
+ ((< compare 5) most)
+ (t (concat "..." (substring most compare))))
+ close-bracket)))
+ ;;"-prospects" - more than one candidate
+ (prospects-len (+ (length determ) 6 ;; take {,...} into account
+ (string-width (buffer-string))))
+ (prospects-max
+ ;; Max total length to use, including the minibuffer content.
+ (* (+ icomplete-prospects-height
+ ;; If the minibuffer content already uses up more than
+ ;; one line, increase the allowable space accordingly.
+ (/ prospects-len (window-width)))
+ (window-width)))
+ (prefix-len
+ ;; Find the common prefix among `comps'.
+ (if (eq t (compare-strings (car comps) nil (length most)
+ most nil nil completion-ignore-case))
+ ;; Common case.
+ (length most)
+ ;; Else, use try-completion.
+ (let ((comps-prefix (try-completion "" comps)))
+ (and (stringp comps-prefix)
+ (length comps-prefix)))))
+
+ prospects most-is-exact comp limit)
+ (if (eq most-try t) ;; (or (null (cdr comps))
(setq prospects nil)
- (while (and comps (< prospects-len icomplete-prospects-length))
- (setq comp (substring (car comps) most-len)
+ (while (and comps (not limit))
+ (setq comp
+ (if prefix-len (substring (car comps) prefix-len) (car comps))
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))))))
+ (t (setq prospects-len
+ (+ (string-width comp) 1 prospects-len))
+ (if (< prospects-len prospects-max)
+ (push comp prospects)
+ (setq limit t))))))
+ ;; Restore the base-size info, since completion-all-sorted-completions
+ ;; is cached.
+ (if last (setcdr last base-size))
(if prospects
(concat determ
- open-bracket-prospects
+ "{"
(and most-is-exact ",")
- (mapconcat 'identity
- (sort prospects (function string-lessp))
- ",")
- (and comps ",...")
- close-bracket-prospects)
+ (mapconcat 'identity (nreverse prospects) ",")
+ (and limit ",...")
+ "}")
(concat determ
" [Matched"
(let ((keys (and icomplete-show-key-bindings
(commandp (intern-soft most))
(icomplete-get-keys most))))
- (if keys
- (concat "; " keys)
- ""))
+ (if keys (concat "; " keys) ""))
"]"))))))
-(if icomplete-mode
- (icomplete-mode 1))
-
-;;;_* Local emacs vars.
-;;;Local variables:
-;;;outline-layout: (-2 :)
-;;;End:
+;;_* Local emacs vars.
+;;Local variables:
+;;allout-layout: (-2 :)
+;;End:
+;; arch-tag: 339ec25a-0741-4eb6-be63-997532e89b0f
;;; icomplete.el ends here