Spelling fixes.
[emacs.git] / lisp / icomplete.el
blob7620adb3c9c6a67fedc8e5acfe2ed9068f6d1f8a
1 ;;; icomplete.el --- minibuffer completion incremental feedback
3 ;; Copyright (C) 1992-1994, 1997, 1999, 2001-2013 Free Software
4 ;; Foundation, Inc.
6 ;; Author: Ken Manheimer <klm@i.am>
7 ;; Maintainer: Ken Manheimer <klm@i.am>
8 ;; Created: Mar 1993 Ken Manheimer, klm@nist.gov - first release to usenet
9 ;; Last update: Ken Manheimer <klm@i.am>, 11/18/1999.
10 ;; Keywords: help, abbrev
12 ;; This file is part of GNU Emacs.
14 ;; GNU Emacs is free software: you can redistribute it and/or modify
15 ;; it under the terms of the GNU General Public License as published by
16 ;; the Free Software Foundation, either version 3 of the License, or
17 ;; (at your option) any later version.
19 ;; GNU Emacs is distributed in the hope that it will be useful,
20 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
21 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 ;; GNU General Public License for more details.
24 ;; You should have received a copy of the GNU General Public License
25 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
27 ;;; Commentary:
29 ;; Loading this package implements a more fine-grained minibuffer
30 ;; completion feedback scheme. Prospective completions are concisely
31 ;; indicated within the minibuffer itself, with each successive
32 ;; keystroke.
34 ;; See `icomplete-completions' docstring for a description of the
35 ;; icomplete display format.
37 ;; See the `icomplete-minibuffer-setup-hook' docstring for a means to
38 ;; customize icomplete setup for interoperation with other
39 ;; minibuffer-oriented packages.
41 ;; To activate icomplete mode, load the package and use the
42 ;; `icomplete-mode' function. You can subsequently deactivate it by
43 ;; invoking the function icomplete-mode with a negative prefix-arg
44 ;; (C-U -1 ESC-x icomplete-mode). Also, you can prevent activation of
45 ;; the mode during package load by first setting the variable
46 ;; `icomplete-mode' to nil. Icompletion can be enabled any time after
47 ;; the package is loaded by invoking icomplete-mode without a prefix
48 ;; arg.
50 ;; Thanks to everyone for their suggestions for refinements of this
51 ;; package. I particularly have to credit Michael Cook, who
52 ;; implemented an incremental completion style in his 'iswitch'
53 ;; functions that served as a model for icomplete. Some other
54 ;; contributors: Noah Friedman (restructuring as minor mode), Colin
55 ;; Rafferty (lemacs reconciliation), Lars Lindberg, RMS, and others.
57 ;; klm.
59 ;;; Code:
61 ;;;_* Provide
62 (provide 'icomplete)
65 (defgroup icomplete nil
66 "Show completions dynamically in minibuffer."
67 :prefix "icomplete-"
68 :group 'minibuffer)
70 (defvar icomplete-prospects-length 80)
71 (make-obsolete-variable
72 'icomplete-prospects-length 'icomplete-prospects-height "23.1")
74 (defcustom icomplete-separator " | "
75 "String used by icomplete to separate alternatives in the minibuffer."
76 :type 'string
77 :version "24.4")
79 (defcustom icomplete-hide-common-prefix t
80 "When non-nil, hide common prefix from completion candidates.
81 When nil, show candidates in full."
82 :type 'boolean
83 :version "24.4"
84 :group 'icomplete)
86 (defface icomplete-first-match '((t :weight bold))
87 "Face used by icomplete for highlighting first match."
88 :version "24.4"
89 :group 'icomplete)
91 ;;;_* User Customization variables
92 (defcustom icomplete-prospects-height
93 ;; 20 is an estimated common size for the prompt + minibuffer content, to
94 ;; try to guess the number of lines used up by icomplete-prospects-length.
95 (+ 1 (/ (+ icomplete-prospects-length 20) (window-width)))
96 "Maximum number of lines to use in the minibuffer."
97 :type 'integer
98 :group 'icomplete
99 :version "23.1")
101 (defcustom icomplete-compute-delay .3
102 "Completions-computation stall, used only with large-number completions.
103 See `icomplete-delay-completions-threshold'."
104 :type 'number
105 :group 'icomplete)
107 (defcustom icomplete-delay-completions-threshold 400
108 "Pending-completions number over which to apply `icomplete-compute-delay'."
109 :type 'integer
110 :group 'icomplete)
112 (defcustom icomplete-max-delay-chars 3
113 "Maximum number of initial chars to apply icomplete compute delay."
114 :type 'integer
115 :group 'icomplete)
117 (defvar icomplete-in-buffer nil
118 "If non-nil, also use Icomplete when completing in non-mini buffers.")
120 (defcustom icomplete-minibuffer-setup-hook nil
121 "Icomplete-specific customization of minibuffer setup.
123 This hook is run during minibuffer setup if icomplete is active.
124 It is intended for use in customizing icomplete for interoperation
125 with other features and packages. For instance:
127 \(add-hook 'icomplete-minibuffer-setup-hook
128 \(function
129 \(lambda ()
130 \(make-local-variable 'max-mini-window-height)
131 \(setq max-mini-window-height 3))))
133 will constrain Emacs to a maximum minibuffer height of 3 lines when
134 icompletion is occurring."
135 :type 'hook
136 :group 'icomplete)
139 ;;;_* Initialization
141 ;;;_ + Internal Variables
142 ;;;_ = icomplete-eoinput nil
143 (defvar icomplete-overlay (make-overlay (point-min) (point-min) nil t t)
144 "Overlay used to display the list of completions.")
146 (defun icomplete-pre-command-hook ()
147 (let ((non-essential t))
148 (icomplete-tidy)))
150 (defun icomplete-post-command-hook ()
151 (let ((non-essential t)) ;E.g. don't prompt for password!
152 (icomplete-exhibit)))
154 ;;;_ = icomplete-with-completion-tables
155 (defcustom icomplete-with-completion-tables t
156 "Specialized completion tables with which icomplete should operate.
158 Icomplete does not operate with any specialized completion tables
159 except those on this list."
160 :version "24.4"
161 :type '(choice (const :tag "All" t)
162 (repeat function)))
164 (defvar icomplete-minibuffer-map
165 (let ((map (make-sparse-keymap)))
166 (define-key map [?\M-\t] 'minibuffer-force-complete)
167 (define-key map [?\C-j] 'minibuffer-force-complete-and-exit)
168 (define-key map [?\C-.] 'icomplete-forward-completions)
169 (define-key map [?\C-,] 'icomplete-backward-completions)
170 map))
172 (defun icomplete-forward-completions ()
173 "Step forward completions by one entry.
174 Second entry becomes the first and can be selected with
175 `minibuffer-force-complete-and-exit'."
176 (interactive)
177 (let* ((beg (icomplete--field-beg))
178 (end (icomplete--field-end))
179 (comps (completion-all-sorted-completions beg end))
180 (last (last comps)))
181 (when comps
182 (setcdr last (cons (car comps) (cdr last)))
183 (completion--cache-all-sorted-completions beg end (cdr comps)))))
185 (defun icomplete-backward-completions ()
186 "Step backward completions by one entry.
187 Last entry becomes the first and can be selected with
188 `minibuffer-force-complete-and-exit'."
189 (interactive)
190 (let* ((beg (icomplete--field-beg))
191 (end (icomplete--field-end))
192 (comps (completion-all-sorted-completions beg end))
193 (last-but-one (last comps 2))
194 (last (cdr last-but-one)))
195 (when (consp last) ; At least two elements in comps
196 (setcdr last-but-one (cdr last))
197 (push (car last) comps)
198 (completion--cache-all-sorted-completions beg end comps))))
200 ;;;_ > icomplete-mode (&optional prefix)
201 ;;;###autoload
202 (define-minor-mode icomplete-mode
203 "Toggle incremental minibuffer completion (Icomplete mode).
204 With a prefix argument ARG, enable Icomplete mode if ARG is
205 positive, and disable it otherwise. If called from Lisp, enable
206 the mode if ARG is omitted or nil."
207 :global t :group 'icomplete
208 (remove-hook 'minibuffer-setup-hook #'icomplete-minibuffer-setup)
209 (remove-hook 'completion-in-region-mode-hook #'icomplete--in-region-setup)
210 (when icomplete-mode
211 (when icomplete-in-buffer
212 (add-hook 'completion-in-region-mode-hook #'icomplete--in-region-setup))
213 (add-hook 'minibuffer-setup-hook #'icomplete-minibuffer-setup)))
215 (defun icomplete--completion-table ()
216 (if (window-minibuffer-p) minibuffer-completion-table
217 (or (nth 2 completion-in-region--data)
218 (message "In %S (w=%S): %S"
219 (current-buffer) (selected-window) (window-minibuffer-p)))))
220 (defun icomplete--completion-predicate ()
221 (if (window-minibuffer-p) minibuffer-completion-predicate
222 (nth 3 completion-in-region--data)))
223 (defun icomplete--field-string ()
224 (if (window-minibuffer-p) (minibuffer-contents)
225 (buffer-substring-no-properties
226 (nth 0 completion-in-region--data)
227 (nth 1 completion-in-region--data))))
228 (defun icomplete--field-beg ()
229 (if (window-minibuffer-p) (minibuffer-prompt-end)
230 (nth 0 completion-in-region--data)))
231 (defun icomplete--field-end ()
232 (if (window-minibuffer-p) (point-max)
233 (nth 1 completion-in-region--data)))
235 ;;;_ > icomplete-simple-completing-p ()
236 (defun icomplete-simple-completing-p ()
237 "Non-nil if current window is minibuffer that's doing simple completion.
239 Conditions are:
240 the selected window is a minibuffer,
241 and not in the middle of macro execution,
242 and the completion table is not a function (which would
243 indicate some non-standard, non-simple completion mechanism,
244 like file-name and other custom-func completions)."
246 (unless executing-kbd-macro
247 (let ((table (icomplete--completion-table)))
248 (and table
249 (or (not (functionp table))
250 (eq icomplete-with-completion-tables t)
251 (member table icomplete-with-completion-tables))))))
253 ;;;_ > icomplete-minibuffer-setup ()
254 (defun icomplete-minibuffer-setup ()
255 "Run in minibuffer on activation to establish incremental completion.
256 Usually run by inclusion in `minibuffer-setup-hook'."
257 (when (and icomplete-mode (icomplete-simple-completing-p))
258 (set (make-local-variable 'completion-show-inline-help) nil)
259 (use-local-map (make-composed-keymap icomplete-minibuffer-map
260 (current-local-map)))
261 (add-hook 'pre-command-hook #'icomplete-pre-command-hook nil t)
262 (add-hook 'post-command-hook #'icomplete-post-command-hook nil t)
263 (run-hooks 'icomplete-minibuffer-setup-hook)))
265 (defvar icomplete--in-region-buffer nil)
267 (defun icomplete--in-region-setup ()
268 (when (or (not completion-in-region-mode)
269 (and icomplete--in-region-buffer
270 (not (eq icomplete--in-region-buffer (current-buffer)))))
271 (with-current-buffer (or icomplete--in-region-buffer (current-buffer))
272 (setq icomplete--in-region-buffer nil)
273 (delete-overlay icomplete-overlay)
274 (kill-local-variable 'completion-show-inline-help)
275 (remove-hook 'pre-command-hook 'icomplete-pre-command-hook t)
276 (remove-hook 'post-command-hook 'icomplete-post-command-hook t)
277 (message nil)))
278 (when (and completion-in-region-mode
279 icomplete-mode (icomplete-simple-completing-p))
280 (setq icomplete--in-region-buffer (current-buffer))
281 (set (make-local-variable 'completion-show-inline-help) nil)
282 (let ((tem (assq 'completion-in-region-mode
283 minor-mode-overriding-map-alist)))
284 (unless (memq icomplete-minibuffer-map (cdr tem))
285 (setcdr tem (make-composed-keymap icomplete-minibuffer-map
286 (cdr tem)))))
287 (add-hook 'pre-command-hook 'icomplete-pre-command-hook nil t)
288 (add-hook 'post-command-hook 'icomplete-post-command-hook nil t)))
292 ;;;_* Completion
294 ;;;_ > icomplete-tidy ()
295 (defun icomplete-tidy ()
296 "Remove completions display \(if any) prior to new user input.
297 Should be run in on the minibuffer `pre-command-hook'. See `icomplete-mode'
298 and `minibuffer-setup-hook'."
299 (delete-overlay icomplete-overlay))
301 ;;;_ > icomplete-exhibit ()
302 (defun icomplete-exhibit ()
303 "Insert icomplete completions display.
304 Should be run via minibuffer `post-command-hook'. See `icomplete-mode'
305 and `minibuffer-setup-hook'."
306 (when (and icomplete-mode
307 (icomplete-simple-completing-p)) ;Shouldn't be necessary.
308 (save-excursion
309 (goto-char (point-max))
310 ; Insert the match-status information:
311 (if (and (> (icomplete--field-end) (icomplete--field-beg))
312 buffer-undo-list ; Wait for some user input.
314 ;; Don't bother with delay after certain number of chars:
315 (> (- (point) (icomplete--field-beg))
316 icomplete-max-delay-chars)
317 ;; Don't delay if the completions are known.
318 completion-all-sorted-completions
319 ;; Don't delay if alternatives number is small enough:
320 (and (sequencep (icomplete--completion-table))
321 (< (length (icomplete--completion-table))
322 icomplete-delay-completions-threshold))
323 ;; Delay - give some grace time for next keystroke, before
324 ;; embarking on computing completions:
325 (sit-for icomplete-compute-delay)))
326 (let* ((field-string (icomplete--field-string))
327 (text (while-no-input
328 (icomplete-completions
329 field-string
330 (icomplete--completion-table)
331 (icomplete--completion-predicate)
332 (if (window-minibuffer-p)
333 (not minibuffer-completion-confirm)))))
334 (buffer-undo-list t)
335 deactivate-mark)
336 ;; Do nothing if while-no-input was aborted.
337 (when (stringp text)
338 (move-overlay icomplete-overlay (point) (point) (current-buffer))
339 ;; The current C cursor code doesn't know to use the overlay's
340 ;; marker's stickiness to figure out whether to place the cursor
341 ;; before or after the string, so let's spoon-feed it the pos.
342 (put-text-property 0 1 'cursor t text)
343 (overlay-put icomplete-overlay 'after-string text)))))))
345 ;;;_ > icomplete-completions (name candidates predicate require-match)
346 (defun icomplete-completions (name candidates predicate require-match)
347 "Identify prospective candidates for minibuffer completion.
349 The display is updated with each minibuffer keystroke during
350 minibuffer completion.
352 Prospective completion suffixes (if any) are displayed, bracketed by
353 one of \(), \[], or \{} pairs. The choice of brackets is as follows:
355 \(...) - a single prospect is identified and matching is enforced,
356 \[...] - a single prospect is identified but matching is optional, or
357 \{...} - multiple prospects, separated by commas, are indicated, and
358 further input is required to distinguish a single one.
360 The displays for unambiguous matches have ` [Matched]' appended
361 \(whether complete or not), or ` \[No matches]', if no eligible
362 matches exist. \(Keybindings for uniquely matched commands
363 are exhibited within the square braces.)"
365 (let* ((minibuffer-completion-table candidates)
366 (minibuffer-completion-predicate predicate)
367 (md (completion--field-metadata (icomplete--field-beg)))
368 (comps (completion-all-sorted-completions
369 (icomplete--field-beg) (icomplete--field-end)))
370 (last (if (consp comps) (last comps)))
371 (base-size (cdr last))
372 (open-bracket (if require-match "(" "["))
373 (close-bracket (if require-match ")" "]")))
374 ;; `concat'/`mapconcat' is the slow part.
375 (if (not (consp comps))
376 (progn ;;(debug (format "Candidates=%S field=%S" candidates name))
377 (format " %sNo matches%s" open-bracket close-bracket))
378 (if last (setcdr last nil))
379 (let* ((most-try
380 (if (and base-size (> base-size 0))
381 (completion-try-completion
382 name candidates predicate (length name) md)
383 ;; If the `comps' are 0-based, the result should be
384 ;; the same with `comps'.
385 (completion-try-completion
386 name comps nil (length name) md)))
387 (most (if (consp most-try) (car most-try)
388 (if most-try (car comps) "")))
389 ;; Compare name and most, so we can determine if name is
390 ;; a prefix of most, or something else.
391 (compare (compare-strings name nil nil
392 most nil nil completion-ignore-case))
393 (determ (unless (or (eq t compare) (eq t most-try)
394 (= (setq compare (1- (abs compare)))
395 (length most)))
396 (concat open-bracket
397 (cond
398 ((= compare (length name))
399 ;; Typical case: name is a prefix.
400 (substring most compare))
401 ;; Don't bother truncating if it doesn't gain
402 ;; us at least 2 columns.
403 ((< compare 3) most)
404 (t (concat "…" (substring most compare))))
405 close-bracket)))
406 ;;"-prospects" - more than one candidate
407 (prospects-len (+ (string-width
408 (or determ (concat open-bracket close-bracket)))
409 (string-width icomplete-separator)
410 3 ;; take {…} into account
411 (string-width (buffer-string))))
412 (prospects-max
413 ;; Max total length to use, including the minibuffer content.
414 (* (+ icomplete-prospects-height
415 ;; If the minibuffer content already uses up more than
416 ;; one line, increase the allowable space accordingly.
417 (/ prospects-len (window-width)))
418 (window-width)))
419 (prefix (when icomplete-hide-common-prefix
420 (try-completion "" comps)))
421 (prefix-len
422 ;; Find the common prefix among `comps'.
423 ;; We can't use the optimization below because its assumptions
424 ;; aren't always true, e.g. when completion-cycling (bug#10850):
425 ;; (if (eq t (compare-strings (car comps) nil (length most)
426 ;; most nil nil completion-ignore-case))
427 ;; ;; Common case.
428 ;; (length most)
429 ;; Else, use try-completion.
430 (and (stringp prefix) (length prefix))) ;;)
431 prospects comp limit)
432 (if (or (eq most-try t) (not (consp (cdr comps))))
433 (setq prospects nil)
434 (when (member name comps)
435 ;; NAME is complete but not unique. This scenario poses
436 ;; following UI issues:
438 ;; - When `icomplete-hide-common-prefix' is non-nil, NAME
439 ;; is stripped empty. This would make the entry
440 ;; inconspicuous.
442 ;; - Due to sorting of completions, NAME may not be the
443 ;; first of the prospects and could be hidden deep in
444 ;; the displayed string.
446 ;; - Because of `icomplete-prospects-height' , NAME may
447 ;; not even be displayed to the user.
449 ;; To circumvent all the above problems, provide a visual
450 ;; cue to the user via an "empty string" in the try
451 ;; completion field.
452 (setq determ (concat open-bracket "" close-bracket)))
453 ;; Compute prospects for display.
454 (while (and comps (not limit))
455 (setq comp
456 (if prefix-len (substring (car comps) prefix-len) (car comps))
457 comps (cdr comps))
458 (setq prospects-len
459 (+ (string-width comp)
460 (string-width icomplete-separator)
461 prospects-len))
462 (if (< prospects-len prospects-max)
463 (push comp prospects)
464 (setq limit t))))
465 (setq prospects (nreverse prospects))
466 ;; Decorate first of the prospects.
467 (when prospects
468 (let ((first (copy-sequence (pop prospects))))
469 (put-text-property 0 (length first)
470 'face 'icomplete-first-match first)
471 (push first prospects)))
472 ;; Restore the base-size info, since completion-all-sorted-completions
473 ;; is cached.
474 (if last (setcdr last base-size))
475 (if prospects
476 (concat determ
478 (mapconcat 'identity prospects icomplete-separator)
479 (and limit (concat icomplete-separator "…"))
480 "}")
481 (concat determ " [Matched]"))))))
483 ;;_* Local emacs vars.
484 ;;Local variables:
485 ;;allout-layout: (-2 :)
486 ;;End:
488 ;;; icomplete.el ends here