Commit | Line | Data |
---|---|---|
fa157191 | 1 | ;;; icomplete.el --- minibuffer completion incremental feedback |
239c87a1 | 2 | |
0d30b337 | 3 | ;; Copyright (C) 1992, 1993, 1994, 1997, 1999, 2001, 2002, 2003, |
409cc4a3 | 4 | ;; 2004, 2005, 2006, 2007, 2008 Free Software Foundation, Inc. |
d462ff97 | 5 | |
1934dbf4 GM |
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. | |
be010748 | 10 | ;; Keywords: help, abbrev |
d462ff97 | 11 | |
239c87a1 | 12 | ;; This file is part of GNU Emacs. |
d462ff97 | 13 | |
eb3fa2cf | 14 | ;; GNU Emacs is free software: you can redistribute it and/or modify |
239c87a1 | 15 | ;; it under the terms of the GNU General Public License as published by |
eb3fa2cf GM |
16 | ;; the Free Software Foundation, either version 3 of the License, or |
17 | ;; (at your option) any later version. | |
d462ff97 | 18 | |
239c87a1 RS |
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. | |
c89164c5 | 23 | |
239c87a1 | 24 | ;; You should have received a copy of the GNU General Public License |
eb3fa2cf | 25 | ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. |
d462ff97 | 26 | |
239c87a1 | 27 | ;;; Commentary: |
d462ff97 | 28 | |
b578f267 EN |
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. | |
33 | ||
5e537651 | 34 | ;; See `icomplete-completions' docstring for a description of the |
b578f267 EN |
35 | ;; icomplete display format. |
36 | ||
37 | ;; See the `icomplete-minibuffer-setup-hook' docstring for a means to | |
38 | ;; customize icomplete setup for interoperation with other | |
39 | ;; minibuffer-oriented packages. | |
40 | ||
1934dbf4 GM |
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. | |
92f7d003 | 49 | |
b578f267 EN |
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 | |
5e537651 | 54 | ;; contributors: Noah Friedman (restructuring as minor mode), Colin |
1be5a284 | 55 | ;; Rafferty (lemacs reconciliation), Lars Lindberg, RMS, and others. |
b578f267 EN |
56 | |
57 | ;; klm. | |
c89164c5 | 58 | |
239c87a1 RS |
59 | ;;; Code: |
60 | ||
61 | ;;;_* Provide | |
d462ff97 RS |
62 | (provide 'icomplete) |
63 | ||
5e537651 SE |
64 | |
65 | (defgroup icomplete nil | |
66 | "Show completions dynamically in minibuffer." | |
67 | :prefix "icomplete-" | |
68 | :group 'minibuffer) | |
69 | ||
c2d0b538 SM |
70 | (defvar icomplete-prospects-length 80) |
71 | (make-obsolete-variable | |
72 | 'icomplete-prospects-length 'icomplete-prospects-height "23.1") | |
73 | ||
1934dbf4 | 74 | ;;;_* User Customization variables |
c2d0b538 SM |
75 | (defcustom icomplete-prospects-height |
76 | ;; 20 is an estimated common size for the prompt + minibuffer content, to | |
77 | ;; try to guess the number of lines used up by icomplete-prospects-length. | |
78 | (+ 1 (/ (+ icomplete-prospects-length 20) (window-width))) | |
79 | "Maximum number of lines to use in the minibuffer." | |
80 | :type 'integer) | |
1934dbf4 | 81 | |
5e537651 | 82 | (defcustom icomplete-compute-delay .3 |
077aec27 JB |
83 | "Completions-computation stall, used only with large-number completions. |
84 | See `icomplete-delay-completions-threshold'." | |
5e537651 SE |
85 | :type 'number |
86 | :group 'icomplete) | |
87 | ||
88 | (defcustom icomplete-delay-completions-threshold 400 | |
077aec27 | 89 | "Pending-completions number over which to apply `icomplete-compute-delay'." |
5e537651 SE |
90 | :type 'integer |
91 | :group 'icomplete) | |
92 | ||
93 | (defcustom icomplete-max-delay-chars 3 | |
077aec27 | 94 | "Maximum number of initial chars to apply icomplete compute delay." |
5e537651 SE |
95 | :type 'integer |
96 | :group 'icomplete) | |
97 | ||
98 | (defcustom icomplete-show-key-bindings t | |
077aec27 | 99 | "If non-nil, show key bindings as well as completion for sole matches." |
5e537651 SE |
100 | :type 'boolean |
101 | :group 'icomplete) | |
102 | ||
103 | (defcustom icomplete-minibuffer-setup-hook nil | |
077aec27 | 104 | "Icomplete-specific customization of minibuffer setup. |
239c87a1 | 105 | |
4837b516 | 106 | This hook is run during minibuffer setup if icomplete is active. |
239c87a1 | 107 | It is intended for use in customizing icomplete for interoperation |
9c8acefd | 108 | with other features and packages. For instance: |
239c87a1 | 109 | |
92f7d003 | 110 | \(add-hook 'icomplete-minibuffer-setup-hook |
239c87a1 RS |
111 | \(function |
112 | \(lambda () | |
9c8acefd EZ |
113 | \(make-local-variable 'max-mini-window-height) |
114 | \(setq max-mini-window-height 3)))) | |
239c87a1 | 115 | |
9c8acefd | 116 | will constrain Emacs to a maximum minibuffer height of 3 lines when |
5e537651 SE |
117 | icompletion is occurring." |
118 | :type 'hook | |
119 | :group 'icomplete) | |
120 | ||
121 | ||
122 | ;;;_* Initialization | |
d462ff97 | 123 | |
c89164c5 | 124 | ;;;_ + Internal Variables |
47fda8fc | 125 | ;;;_ = icomplete-eoinput nil |
31d4b748 SM |
126 | (defvar icomplete-overlay (make-overlay (point-min) (point-min) nil t t) |
127 | "Overlay used to display the list of completions.") | |
128 | ||
239c87a1 RS |
129 | ;;;_ = icomplete-pre-command-hook |
130 | (defvar icomplete-pre-command-hook nil | |
131 | "Incremental-minibuffer-completion pre-command-hook. | |
132 | ||
133 | Is run in minibuffer before user input when `icomplete-mode' is non-nil. | |
134 | Use `icomplete-mode' function to set it up properly for incremental | |
135 | minibuffer completion.") | |
136 | (add-hook 'icomplete-pre-command-hook 'icomplete-tidy) | |
137 | ;;;_ = icomplete-post-command-hook | |
138 | (defvar icomplete-post-command-hook nil | |
139 | "Incremental-minibuffer-completion post-command-hook. | |
140 | ||
141 | Is run in minibuffer after user input when `icomplete-mode' is non-nil. | |
142 | Use `icomplete-mode' function to set it up properly for incremental | |
143 | minibuffer completion.") | |
144 | (add-hook 'icomplete-post-command-hook 'icomplete-exhibit) | |
145 | ||
92f7d003 | 146 | (defun icomplete-get-keys (func-name) |
1be5a284 RS |
147 | "Return strings naming keys bound to `func-name', or nil if none. |
148 | Examines the prior, not current, buffer, presuming that current buffer | |
149 | is minibuffer." | |
150 | (if (commandp func-name) | |
92f7d003 KH |
151 | (save-excursion |
152 | (let* ((sym (intern func-name)) | |
78421c58 | 153 | (buf (other-buffer nil t)) |
4afd234b | 154 | (keys (with-current-buffer buf (where-is-internal sym)))) |
92f7d003 KH |
155 | (if keys |
156 | (concat "<" | |
157 | (mapconcat 'key-description | |
158 | (sort keys | |
159 | #'(lambda (x y) | |
160 | (< (length x) (length y)))) | |
161 | ", ") | |
162 | ">")))))) | |
397e713b CY |
163 | ;;;_ = icomplete-with-completion-tables |
164 | (defvar icomplete-with-completion-tables '(internal-complete-buffer) | |
165 | "Specialized completion tables with which icomplete should operate. | |
166 | ||
167 | Icomplete does not operate with any specialized completion tables | |
168 | except those on this list.") | |
92f7d003 | 169 | |
239c87a1 | 170 | ;;;_ > icomplete-mode (&optional prefix) |
c89164c5 | 171 | ;;;###autoload |
47fda8fc | 172 | (define-minor-mode icomplete-mode |
4b404c58 | 173 | "Toggle incremental minibuffer completion for this Emacs session. |
4837b516 GM |
174 | With a numeric argument, turn Icomplete mode on if ARG is positive, |
175 | otherwise turn it off." | |
47fda8fc SM |
176 | :global t :group 'icomplete |
177 | (if icomplete-mode | |
4b404c58 GM |
178 | ;; The following is not really necessary after first time - |
179 | ;; no great loss. | |
47fda8fc SM |
180 | (add-hook 'minibuffer-setup-hook 'icomplete-minibuffer-setup) |
181 | (remove-hook 'minibuffer-setup-hook 'icomplete-minibuffer-setup))) | |
239c87a1 RS |
182 | |
183 | ;;;_ > icomplete-simple-completing-p () | |
184 | (defun icomplete-simple-completing-p () | |
239c87a1 RS |
185 | "Non-nil if current window is minibuffer that's doing simple completion. |
186 | ||
187 | Conditions are: | |
188 | the selected window is a minibuffer, | |
189 | and not in the middle of macro execution, | |
47fda8fc | 190 | and `minibuffer-completion-table' is not a symbol (which would |
81276211 | 191 | indicate some non-standard, non-simple completion mechanism, |
239c87a1 RS |
192 | like file-name and other custom-func completions)." |
193 | ||
194 | (and (window-minibuffer-p (selected-window)) | |
efcf38c7 | 195 | (not executing-kbd-macro) |
c22e3cd4 | 196 | minibuffer-completion-table |
397e713b | 197 | (or (not (functionp minibuffer-completion-table)) |
476d2aef | 198 | (eq icomplete-with-completion-tables t) |
397e713b | 199 | (member minibuffer-completion-table |
3f56acf9 | 200 | icomplete-with-completion-tables)))) |
d183f322 | 201 | |
239c87a1 | 202 | ;;;_ > icomplete-minibuffer-setup () |
239c87a1 | 203 | (defun icomplete-minibuffer-setup () |
239c87a1 | 204 | "Run in minibuffer on activation to establish incremental completion. |
d183f322 | 205 | Usually run by inclusion in `minibuffer-setup-hook'." |
47fda8fc SM |
206 | (when (and icomplete-mode (icomplete-simple-completing-p)) |
207 | (add-hook 'pre-command-hook | |
208 | (lambda () (run-hooks 'icomplete-pre-command-hook)) | |
209 | nil t) | |
210 | (add-hook 'post-command-hook | |
211 | (lambda () (run-hooks 'icomplete-post-command-hook)) | |
212 | nil t) | |
213 | (run-hooks 'icomplete-minibuffer-setup-hook))) | |
1934dbf4 GM |
214 | ;\f |
215 | ||
216 | ||
239c87a1 RS |
217 | ;;;_* Completion |
218 | ||
219 | ;;;_ > icomplete-tidy () | |
220 | (defun icomplete-tidy () | |
221 | "Remove completions display \(if any) prior to new user input. | |
d183f322 | 222 | Should be run in on the minibuffer `pre-command-hook'. See `icomplete-mode' |
239c87a1 | 223 | and `minibuffer-setup-hook'." |
31d4b748 | 224 | (delete-overlay icomplete-overlay)) |
d183f322 | 225 | |
239c87a1 | 226 | ;;;_ > icomplete-exhibit () |
d462ff97 | 227 | (defun icomplete-exhibit () |
239c87a1 | 228 | "Insert icomplete completions display. |
d183f322 | 229 | Should be run via minibuffer `post-command-hook'. See `icomplete-mode' |
239c87a1 | 230 | and `minibuffer-setup-hook'." |
fe689fb6 | 231 | (when (and icomplete-mode (icomplete-simple-completing-p)) |
47fda8fc SM |
232 | (save-excursion |
233 | (goto-char (point-max)) | |
d462ff97 | 234 | ; Insert the match-status information: |
47fda8fc SM |
235 | (if (and (> (point-max) (minibuffer-prompt-end)) |
236 | buffer-undo-list ; Wait for some user input. | |
237 | (or | |
238 | ;; Don't bother with delay after certain number of chars: | |
239 | (> (- (point) (field-beginning)) icomplete-max-delay-chars) | |
240 | ;; Don't delay if alternatives number is small enough: | |
241 | (and (sequencep minibuffer-completion-table) | |
242 | (< (length minibuffer-completion-table) | |
243 | icomplete-delay-completions-threshold)) | |
244 | ;; Delay - give some grace time for next keystroke, before | |
245 | ;; embarking on computing completions: | |
246 | (sit-for icomplete-compute-delay))) | |
247 | (let ((text (while-no-input | |
9a84ddd8 RS |
248 | (icomplete-completions |
249 | (field-string) | |
250 | minibuffer-completion-table | |
251 | minibuffer-completion-predicate | |
31d4b748 | 252 | (not minibuffer-completion-confirm)))) |
7a78ffec EZ |
253 | (buffer-undo-list t) |
254 | deactivate-mark) | |
9a84ddd8 | 255 | ;; Do nothing if while-no-input was aborted. |
31d4b748 SM |
256 | (when (stringp text) |
257 | (move-overlay icomplete-overlay (point) (point) (current-buffer)) | |
258 | ;; The current C cursor code doesn't know to use the overlay's | |
259 | ;; marker's stickiness to figure out whether to place the cursor | |
260 | ;; before or after the string, so let's spoon-feed it the pos. | |
261 | (put-text-property 0 1 'cursor t text) | |
262 | (overlay-put icomplete-overlay 'after-string text))))))) | |
d183f322 | 263 | |
239c87a1 RS |
264 | ;;;_ > icomplete-completions (name candidates predicate require-match) |
265 | (defun icomplete-completions (name candidates predicate require-match) | |
d462ff97 RS |
266 | "Identify prospective candidates for minibuffer completion. |
267 | ||
c89164c5 | 268 | The display is updated with each minibuffer keystroke during |
d462ff97 RS |
269 | minibuffer completion. |
270 | ||
271 | Prospective completion suffixes (if any) are displayed, bracketed by | |
272 | one of \(), \[], or \{} pairs. The choice of brackets is as follows: | |
273 | ||
274 | \(...) - a single prospect is identified and matching is enforced, | |
275 | \[...] - a single prospect is identified but matching is optional, or | |
276 | \{...} - multiple prospects, separated by commas, are indicated, and | |
81276211 | 277 | further input is required to distinguish a single one. |
d462ff97 | 278 | |
81276211 | 279 | The displays for unambiguous matches have ` [Matched]' appended |
d183f322 | 280 | \(whether complete or not), or ` \[No matches]', if no eligible |
1be5a284 | 281 | matches exist. \(Keybindings for uniquely matched commands |
92f7d003 KH |
282 | are exhibited within the square braces.)" |
283 | ||
31d4b748 SM |
284 | (let* ((comps (completion-all-sorted-completions)) |
285 | (last (if (consp comps) (last comps))) | |
286 | (base-size (cdr last)) | |
476d2aef SM |
287 | (open-bracket (if require-match "(" "[")) |
288 | (close-bracket (if require-match ")" "]"))) | |
c2d0b538 | 289 | ;; `concat'/`mapconcat' is the slow part. |
31d4b748 | 290 | (if (not (consp comps)) |
476d2aef | 291 | (format " %sNo matches%s" open-bracket close-bracket) |
31d4b748 | 292 | (if last (setcdr last nil)) |
be91065f SM |
293 | (let* ((most-try |
294 | (if (and base-size (> base-size 0)) | |
295 | (completion-try-completion | |
296 | name candidates predicate (length name)) | |
297 | ;; If the `comps' are 0-based, the result should be | |
298 | ;; the same with `comps'. | |
299 | (completion-try-completion | |
300 | name comps nil (length name)))) | |
31d4b748 SM |
301 | (most (if (consp most-try) (car most-try) |
302 | (if most-try (car comps) ""))) | |
476d2aef SM |
303 | ;; Compare name and most, so we can determine if name is |
304 | ;; a prefix of most, or something else. | |
305 | (compare (compare-strings name nil nil | |
306 | most nil nil completion-ignore-case)) | |
307 | (determ (unless (or (eq t compare) (eq t most-try) | |
308 | (= (setq compare (1- (abs compare))) | |
309 | (length most))) | |
310 | (concat open-bracket | |
311 | (cond | |
312 | ((= compare (length name)) | |
313 | ;; Typical case: name is a prefix. | |
314 | (substring most compare)) | |
315 | ((< compare 5) most) | |
316 | (t (concat "..." (substring most compare)))) | |
317 | close-bracket))) | |
47fda8fc | 318 | ;;"-prospects" - more than one candidate |
c2d0b538 SM |
319 | (prospects-len (+ (length determ) 6 ;; take {,...} into account |
320 | (string-width (buffer-string)))) | |
321 | (prospects-max | |
322 | ;; Max total length to use, including the minibuffer content. | |
29f313d7 | 323 | (* (+ icomplete-prospects-height |
c2d0b538 SM |
324 | ;; If the minibuffer content already uses up more than |
325 | ;; one line, increase the allowable space accordingly. | |
326 | (/ prospects-len (window-width))) | |
327 | (window-width))) | |
476d2aef SM |
328 | (prefix-len |
329 | ;; Find the common prefix among `comps'. | |
330 | (if (eq t (compare-strings (car comps) nil (length most) | |
31d4b748 | 331 | most nil nil completion-ignore-case)) |
476d2aef SM |
332 | ;; Common case. |
333 | (length most) | |
334 | ;; Else, use try-completion. | |
335 | (let ((comps-prefix (try-completion "" comps))) | |
336 | (and (stringp comps-prefix) | |
337 | (length comps-prefix))))) | |
338 | ||
7d94fb17 | 339 | prospects most-is-exact comp limit) |
31d4b748 | 340 | (if (eq most-try t) ;; (or (null (cdr comps)) |
1934dbf4 | 341 | (setq prospects nil) |
7d94fb17 | 342 | (while (and comps (not limit)) |
476d2aef SM |
343 | (setq comp |
344 | (if prefix-len (substring (car comps) prefix-len) (car comps)) | |
1934dbf4 GM |
345 | comps (cdr comps)) |
346 | (cond ((string-equal comp "") (setq most-is-exact t)) | |
347 | ((member comp prospects)) | |
c2d0b538 SM |
348 | (t (setq prospects-len |
349 | (+ (string-width comp) 1 prospects-len)) | |
350 | (if (< prospects-len prospects-max) | |
31d4b748 | 351 | (push comp prospects) |
7d94fb17 | 352 | (setq limit t)))))) |
31d4b748 SM |
353 | ;; Restore the base-size info, since completion-all-sorted-completions |
354 | ;; is cached. | |
355 | (if last (setcdr last base-size)) | |
1934dbf4 GM |
356 | (if prospects |
357 | (concat determ | |
47fda8fc | 358 | "{" |
1934dbf4 | 359 | (and most-is-exact ",") |
31d4b748 SM |
360 | (mapconcat 'identity (nreverse prospects) ",") |
361 | (and limit ",...") | |
47fda8fc | 362 | "}") |
1934dbf4 GM |
363 | (concat determ |
364 | " [Matched" | |
365 | (let ((keys (and icomplete-show-key-bindings | |
366 | (commandp (intern-soft most)) | |
367 | (icomplete-get-keys most)))) | |
47fda8fc | 368 | (if keys (concat "; " keys) "")) |
1934dbf4 | 369 | "]")))))) |
d462ff97 | 370 | |
476d2aef SM |
371 | ;;_* Local emacs vars. |
372 | ;;Local variables: | |
373 | ;;allout-layout: (-2 :) | |
374 | ;;End: | |
d462ff97 | 375 | |
47fda8fc | 376 | ;; arch-tag: 339ec25a-0741-4eb6-be63-997532e89b0f |
d462ff97 | 377 | ;;; icomplete.el ends here |