Commit | Line | Data |
---|---|---|
fa157191 | 1 | ;;; icomplete.el --- minibuffer completion incremental feedback |
239c87a1 | 2 | |
4b404c58 GM |
3 | ;; Copyright (C) 1992, 1993, 1994, 1997, 1999, 2001 |
4 | ;;; 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 | |
239c87a1 RS |
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 2, or (at your option) | |
17 | ;; 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 |
b578f267 EN |
25 | ;; along with GNU Emacs; see the file COPYING. If not, write to the |
26 | ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330, | |
27 | ;; Boston, MA 02111-1307, USA. | |
d462ff97 | 28 | |
239c87a1 | 29 | ;;; Commentary: |
d462ff97 | 30 | |
b578f267 EN |
31 | ;; Loading this package implements a more fine-grained minibuffer |
32 | ;; completion feedback scheme. Prospective completions are concisely | |
33 | ;; indicated within the minibuffer itself, with each successive | |
34 | ;; keystroke. | |
35 | ||
5e537651 | 36 | ;; See `icomplete-completions' docstring for a description of the |
b578f267 EN |
37 | ;; icomplete display format. |
38 | ||
39 | ;; See the `icomplete-minibuffer-setup-hook' docstring for a means to | |
40 | ;; customize icomplete setup for interoperation with other | |
41 | ;; minibuffer-oriented packages. | |
42 | ||
1934dbf4 GM |
43 | ;; To activate icomplete mode, load the package and use the |
44 | ;; `icomplete-mode' function. You can subsequently deactivate it by | |
45 | ;; invoking the function icomplete-mode with a negative prefix-arg | |
46 | ;; (C-U -1 ESC-x icomplete-mode). Also, you can prevent activation of | |
47 | ;; the mode during package load by first setting the variable | |
48 | ;; `icomplete-mode' to nil. Icompletion can be enabled any time after | |
49 | ;; the package is loaded by invoking icomplete-mode without a prefix | |
50 | ;; arg. | |
92f7d003 | 51 | |
b578f267 EN |
52 | ;; Thanks to everyone for their suggestions for refinements of this |
53 | ;; package. I particularly have to credit Michael Cook, who | |
54 | ;; implemented an incremental completion style in his 'iswitch' | |
55 | ;; functions that served as a model for icomplete. Some other | |
5e537651 | 56 | ;; contributors: Noah Friedman (restructuring as minor mode), Colin |
1be5a284 | 57 | ;; Rafferty (lemacs reconciliation), Lars Lindberg, RMS, and others. |
b578f267 EN |
58 | |
59 | ;; klm. | |
c89164c5 | 60 | |
239c87a1 RS |
61 | ;;; Code: |
62 | ||
63 | ;;;_* Provide | |
d462ff97 RS |
64 | (provide 'icomplete) |
65 | ||
5e537651 SE |
66 | |
67 | (defgroup icomplete nil | |
68 | "Show completions dynamically in minibuffer." | |
69 | :prefix "icomplete-" | |
70 | :group 'minibuffer) | |
71 | ||
5e537651 | 72 | (defcustom icomplete-mode nil |
1934dbf4 | 73 | "*Toggle incremental minibuffer completion. |
71296446 | 74 | As text is typed into the minibuffer, prospective completions are indicated |
5e537651 | 75 | in the minibuffer. |
73a3ea5a DL |
76 | Setting this variable directly does not take effect; |
77 | use either \\[customize] or the function `icomplete-mode'." | |
5e537651 SE |
78 | :set (lambda (symbol value) |
79 | (icomplete-mode (if value 1 -1))) | |
80 | :initialize 'custom-initialize-default | |
81 | :type 'boolean | |
82 | :group 'icomplete | |
83 | :require 'icomplete) | |
84 | ||
1934dbf4 GM |
85 | ;;;_* User Customization variables |
86 | (defcustom icomplete-prospects-length 80 | |
87 | "*Length of string displaying the prospects." | |
88 | :type 'integer | |
89 | :group 'icomplete) | |
90 | ||
5e537651 | 91 | (defcustom icomplete-compute-delay .3 |
92f7d003 | 92 | "*Completions-computation stall, used only with large-number |
5e537651 SE |
93 | completions - see `icomplete-delay-completions-threshold'." |
94 | :type 'number | |
95 | :group 'icomplete) | |
96 | ||
97 | (defcustom icomplete-delay-completions-threshold 400 | |
98 | "*Pending-completions number over which to apply icomplete-compute-delay." | |
99 | :type 'integer | |
100 | :group 'icomplete) | |
101 | ||
102 | (defcustom icomplete-max-delay-chars 3 | |
103 | "*Maximum number of initial chars to apply icomplete compute delay." | |
104 | :type 'integer | |
105 | :group 'icomplete) | |
106 | ||
107 | (defcustom icomplete-show-key-bindings t | |
108 | "*If non-nil, show key bindings as well as completion for sole matches." | |
109 | :type 'boolean | |
110 | :group 'icomplete) | |
111 | ||
112 | (defcustom icomplete-minibuffer-setup-hook nil | |
239c87a1 RS |
113 | "*Icomplete-specific customization of minibuffer setup. |
114 | ||
115 | This hook is run during minibuffer setup iff icomplete will be active. | |
116 | It is intended for use in customizing icomplete for interoperation | |
9c8acefd | 117 | with other features and packages. For instance: |
239c87a1 | 118 | |
92f7d003 | 119 | \(add-hook 'icomplete-minibuffer-setup-hook |
239c87a1 RS |
120 | \(function |
121 | \(lambda () | |
9c8acefd EZ |
122 | \(make-local-variable 'max-mini-window-height) |
123 | \(setq max-mini-window-height 3)))) | |
239c87a1 | 124 | |
9c8acefd | 125 | will constrain Emacs to a maximum minibuffer height of 3 lines when |
5e537651 SE |
126 | icompletion is occurring." |
127 | :type 'hook | |
128 | :group 'icomplete) | |
129 | ||
130 | ||
131 | ;;;_* Initialization | |
d462ff97 | 132 | |
c89164c5 RS |
133 | ;;;_ + Internal Variables |
134 | ;;;_ = icomplete-eoinput 1 | |
d462ff97 RS |
135 | (defvar icomplete-eoinput 1 |
136 | "Point where minibuffer input ends and completion info begins.") | |
137 | (make-variable-buffer-local 'icomplete-eoinput) | |
239c87a1 RS |
138 | ;;;_ = icomplete-pre-command-hook |
139 | (defvar icomplete-pre-command-hook nil | |
140 | "Incremental-minibuffer-completion pre-command-hook. | |
141 | ||
142 | Is run in minibuffer before user input when `icomplete-mode' is non-nil. | |
143 | Use `icomplete-mode' function to set it up properly for incremental | |
144 | minibuffer completion.") | |
145 | (add-hook 'icomplete-pre-command-hook 'icomplete-tidy) | |
146 | ;;;_ = icomplete-post-command-hook | |
147 | (defvar icomplete-post-command-hook nil | |
148 | "Incremental-minibuffer-completion post-command-hook. | |
149 | ||
150 | Is run in minibuffer after user input when `icomplete-mode' is non-nil. | |
151 | Use `icomplete-mode' function to set it up properly for incremental | |
152 | minibuffer completion.") | |
153 | (add-hook 'icomplete-post-command-hook 'icomplete-exhibit) | |
154 | ||
92f7d003 | 155 | (defun icomplete-get-keys (func-name) |
1be5a284 RS |
156 | "Return strings naming keys bound to `func-name', or nil if none. |
157 | Examines the prior, not current, buffer, presuming that current buffer | |
158 | is minibuffer." | |
159 | (if (commandp func-name) | |
92f7d003 KH |
160 | (save-excursion |
161 | (let* ((sym (intern func-name)) | |
1be5a284 RS |
162 | (buf (other-buffer)) |
163 | (map (save-excursion (set-buffer buf) (current-local-map))) | |
164 | (keys (where-is-internal sym map))) | |
92f7d003 KH |
165 | (if keys |
166 | (concat "<" | |
167 | (mapconcat 'key-description | |
168 | (sort keys | |
169 | #'(lambda (x y) | |
170 | (< (length x) (length y)))) | |
171 | ", ") | |
172 | ">")))))) | |
173 | ||
239c87a1 | 174 | ;;;_ > icomplete-mode (&optional prefix) |
c89164c5 | 175 | ;;;###autoload |
4b404c58 GM |
176 | (defun icomplete-mode (&optional arg) |
177 | "Toggle incremental minibuffer completion for this Emacs session. | |
178 | With a numeric argument, turn Icomplete mode on iff ARG is positive." | |
179 | (interactive "P") | |
180 | (let ((on-p (if (null arg) | |
181 | (not icomplete-mode) | |
182 | (> (prefix-numeric-value arg) 0)))) | |
183 | (setq icomplete-mode on-p) | |
184 | (when on-p | |
185 | ;; The following is not really necessary after first time - | |
186 | ;; no great loss. | |
187 | (add-hook 'minibuffer-setup-hook 'icomplete-minibuffer-setup)))) | |
239c87a1 RS |
188 | |
189 | ;;;_ > icomplete-simple-completing-p () | |
190 | (defun icomplete-simple-completing-p () | |
239c87a1 RS |
191 | "Non-nil if current window is minibuffer that's doing simple completion. |
192 | ||
193 | Conditions are: | |
194 | the selected window is a minibuffer, | |
195 | and not in the middle of macro execution, | |
196 | and minibuffer-completion-table is not a symbol (which would | |
81276211 | 197 | indicate some non-standard, non-simple completion mechanism, |
239c87a1 RS |
198 | like file-name and other custom-func completions)." |
199 | ||
200 | (and (window-minibuffer-p (selected-window)) | |
efcf38c7 | 201 | (not executing-kbd-macro) |
239c87a1 | 202 | (not (symbolp minibuffer-completion-table)))) |
d183f322 | 203 | |
239c87a1 RS |
204 | ;;;_ > icomplete-minibuffer-setup () |
205 | ;;;###autoload | |
206 | (defun icomplete-minibuffer-setup () | |
239c87a1 | 207 | "Run in minibuffer on activation to establish incremental completion. |
d183f322 | 208 | Usually run by inclusion in `minibuffer-setup-hook'." |
239c87a1 | 209 | (cond ((and icomplete-mode (icomplete-simple-completing-p)) |
239c87a1 RS |
210 | (add-hook 'pre-command-hook |
211 | (function (lambda () | |
d183f322 RS |
212 | (run-hooks 'icomplete-pre-command-hook))) |
213 | nil t) | |
239c87a1 RS |
214 | (add-hook 'post-command-hook |
215 | (function (lambda () | |
d183f322 RS |
216 | (run-hooks 'icomplete-post-command-hook))) |
217 | nil t) | |
239c87a1 | 218 | (run-hooks 'icomplete-minibuffer-setup-hook)))) |
1934dbf4 GM |
219 | ;\f |
220 | ||
221 | ||
239c87a1 RS |
222 | ;;;_* Completion |
223 | ||
224 | ;;;_ > icomplete-tidy () | |
225 | (defun icomplete-tidy () | |
226 | "Remove completions display \(if any) prior to new user input. | |
d183f322 | 227 | Should be run in on the minibuffer `pre-command-hook'. See `icomplete-mode' |
239c87a1 RS |
228 | and `minibuffer-setup-hook'." |
229 | (if (icomplete-simple-completing-p) | |
d462ff97 RS |
230 | (if (and (boundp 'icomplete-eoinput) |
231 | icomplete-eoinput) | |
239c87a1 | 232 | |
d462ff97 RS |
233 | (if (> icomplete-eoinput (point-max)) |
234 | ;; Oops, got rug pulled out from under us - reinit: | |
235 | (setq icomplete-eoinput (point-max)) | |
c89164c5 | 236 | (let ((buffer-undo-list buffer-undo-list )) ; prevent entry |
d462ff97 | 237 | (delete-region icomplete-eoinput (point-max)))) |
239c87a1 | 238 | |
c89164c5 | 239 | ;; Reestablish the local variable 'cause minibuffer-setup is weird: |
d462ff97 RS |
240 | (make-local-variable 'icomplete-eoinput) |
241 | (setq icomplete-eoinput 1)))) | |
d183f322 | 242 | |
239c87a1 | 243 | ;;;_ > icomplete-exhibit () |
d462ff97 | 244 | (defun icomplete-exhibit () |
239c87a1 | 245 | "Insert icomplete completions display. |
d183f322 | 246 | Should be run via minibuffer `post-command-hook'. See `icomplete-mode' |
239c87a1 RS |
247 | and `minibuffer-setup-hook'." |
248 | (if (icomplete-simple-completing-p) | |
e8306224 | 249 | (let ((contents (buffer-substring (minibuffer-prompt-end)(point-max))) |
d462ff97 RS |
250 | (buffer-undo-list t)) |
251 | (save-excursion | |
252 | (goto-char (point-max)) | |
253 | ; Register the end of input, so we | |
254 | ; know where the extra stuff | |
255 | ; (match-status info) begins: | |
256 | (if (not (boundp 'icomplete-eoinput)) | |
257 | ;; In case it got wiped out by major mode business: | |
258 | (make-local-variable 'icomplete-eoinput)) | |
259 | (setq icomplete-eoinput (point)) | |
260 | ; Insert the match-status information: | |
8caa4ef5 | 261 | (if (and (> (point-max) (minibuffer-prompt-end)) |
92f7d003 KH |
262 | (or |
263 | ;; Don't bother with delay after certain number of chars: | |
264 | (> (point-max) icomplete-max-delay-chars) | |
265 | ;; Don't delay if alternatives number is small enough: | |
266 | (if minibuffer-completion-table | |
267 | (cond ((numberp minibuffer-completion-table) | |
268 | (< minibuffer-completion-table | |
269 | icomplete-delay-completions-threshold)) | |
270 | ((sequencep minibuffer-completion-table) | |
271 | (< (length minibuffer-completion-table) | |
272 | icomplete-delay-completions-threshold)) | |
273 | )) | |
274 | ;; Delay - give some grace time for next keystroke, before | |
275 | ;; embarking on computing completions: | |
276 | (sit-for icomplete-compute-delay))) | |
555185de | 277 | (insert |
239c87a1 RS |
278 | (icomplete-completions contents |
279 | minibuffer-completion-table | |
280 | minibuffer-completion-predicate | |
281 | (not | |
282 | minibuffer-completion-confirm)))))))) | |
d183f322 | 283 | |
239c87a1 RS |
284 | ;;;_ > icomplete-completions (name candidates predicate require-match) |
285 | (defun icomplete-completions (name candidates predicate require-match) | |
d462ff97 RS |
286 | "Identify prospective candidates for minibuffer completion. |
287 | ||
c89164c5 | 288 | The display is updated with each minibuffer keystroke during |
d462ff97 RS |
289 | minibuffer completion. |
290 | ||
291 | Prospective completion suffixes (if any) are displayed, bracketed by | |
292 | one of \(), \[], or \{} pairs. The choice of brackets is as follows: | |
293 | ||
294 | \(...) - a single prospect is identified and matching is enforced, | |
295 | \[...] - a single prospect is identified but matching is optional, or | |
296 | \{...} - multiple prospects, separated by commas, are indicated, and | |
81276211 | 297 | further input is required to distinguish a single one. |
d462ff97 | 298 | |
81276211 | 299 | The displays for unambiguous matches have ` [Matched]' appended |
d183f322 | 300 | \(whether complete or not), or ` \[No matches]', if no eligible |
1be5a284 | 301 | matches exist. \(Keybindings for uniquely matched commands |
92f7d003 KH |
302 | are exhibited within the square braces.)" |
303 | ||
304 | ;; 'all-completions' doesn't like empty | |
305 | ;; minibuffer-completion-table's (ie: (nil)) | |
306 | (if (and (listp candidates) (null (car candidates))) | |
307 | (setq candidates nil)) | |
d462ff97 RS |
308 | |
309 | (let ((comps (all-completions name candidates predicate)) | |
310 | ; "-determined" - only one candidate | |
311 | (open-bracket-determined (if require-match "(" "[")) | |
1934dbf4 GM |
312 | (close-bracket-determined (if require-match ")" "]"))) |
313 | ;; `concat'/`mapconcat' is the slow part. With the introduction of | |
314 | ;; `icomplete-prospects-length', there is no need for `catch'/`throw'. | |
315 | (if (null comps) (format " %sNo matches%s" | |
316 | open-bracket-determined | |
317 | close-bracket-determined) | |
318 | (let* ((most-try (try-completion name (mapcar (function list) comps))) | |
319 | (most (if (stringp most-try) most-try (car comps))) | |
320 | (most-len (length most)) | |
321 | (determ (and (> most-len (length name)) | |
322 | (concat open-bracket-determined | |
323 | (substring most (length name)) | |
324 | close-bracket-determined))) | |
325 | (open-bracket-prospects "{") | |
326 | (close-bracket-prospects "}") | |
d462ff97 | 327 | ;"-prospects" - more than one candidate |
1934dbf4 GM |
328 | (prospects-len 0) |
329 | prospects most-is-exact comp) | |
330 | (if (eq most-try t) | |
331 | (setq prospects nil) | |
332 | (while (and comps (< prospects-len icomplete-prospects-length)) | |
333 | (setq comp (substring (car comps) most-len) | |
334 | comps (cdr comps)) | |
335 | (cond ((string-equal comp "") (setq most-is-exact t)) | |
336 | ((member comp prospects)) | |
337 | (t (setq prospects (cons comp prospects) | |
338 | prospects-len (+ (length comp) 1 prospects-len)))))) | |
339 | (if prospects | |
340 | (concat determ | |
341 | open-bracket-prospects | |
342 | (and most-is-exact ",") | |
343 | (mapconcat 'identity | |
344 | (sort prospects (function string-lessp)) | |
345 | ",") | |
346 | (and comps ",...") | |
347 | close-bracket-prospects) | |
348 | (concat determ | |
349 | " [Matched" | |
350 | (let ((keys (and icomplete-show-key-bindings | |
351 | (commandp (intern-soft most)) | |
352 | (icomplete-get-keys most)))) | |
353 | (if keys | |
354 | (concat "; " keys) | |
355 | "")) | |
356 | "]")))))) | |
d462ff97 | 357 | |
5e537651 SE |
358 | (if icomplete-mode |
359 | (icomplete-mode 1)) | |
360 | ||
239c87a1 RS |
361 | ;;;_* Local emacs vars. |
362 | ;;;Local variables: | |
363 | ;;;outline-layout: (-2 :) | |
364 | ;;;End: | |
d462ff97 | 365 | |
6b61353c | 366 | ;;; arch-tag: 339ec25a-0741-4eb6-be63-997532e89b0f |
d462ff97 | 367 | ;;; icomplete.el ends here |