Commit | Line | Data |
---|---|---|
a647cb26 | 1 | ;;; minibuffer.el --- Minibuffer completion functions -*- lexical-binding: t -*- |
32bae13c | 2 | |
acaf905b | 3 | ;; Copyright (C) 2008-2012 Free Software Foundation, Inc. |
32bae13c SM |
4 | |
5 | ;; Author: Stefan Monnier <monnier@iro.umontreal.ca> | |
bd78fa1d | 6 | ;; Package: emacs |
32bae13c SM |
7 | |
8 | ;; This file is part of GNU Emacs. | |
9 | ||
eb3fa2cf | 10 | ;; GNU Emacs is free software: you can redistribute it and/or modify |
32bae13c SM |
11 | ;; it under the terms of the GNU General Public License as published by |
12 | ;; the Free Software Foundation, either version 3 of the License, or | |
13 | ;; (at your option) any later version. | |
14 | ||
eb3fa2cf | 15 | ;; GNU Emacs is distributed in the hope that it will be useful, |
32bae13c SM |
16 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of |
17 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
18 | ;; GNU General Public License for more details. | |
19 | ||
20 | ;; You should have received a copy of the GNU General Public License | |
eb3fa2cf | 21 | ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. |
32bae13c SM |
22 | |
23 | ;;; Commentary: | |
24 | ||
a38313e1 SM |
25 | ;; Names with "--" are for functions and variables that are meant to be for |
26 | ;; internal use only. | |
27 | ||
28 | ;; Functional completion tables have an extended calling conventions: | |
30a23501 SM |
29 | ;; The `action' can be (additionally to nil, t, and lambda) of the form |
30 | ;; - (boundaries . SUFFIX) in which case it should return | |
f8381803 | 31 | ;; (boundaries START . END). See `completion-boundaries'. |
a38313e1 SM |
32 | ;; Any other return value should be ignored (so we ignore values returned |
33 | ;; from completion tables that don't know about this new `action' form). | |
30a23501 SM |
34 | ;; - `metadata' in which case it should return (metadata . ALIST) where |
35 | ;; ALIST is the metadata of this table. See `completion-metadata'. | |
36 | ;; Any other return value should be ignored (so we ignore values returned | |
37 | ;; from completion tables that don't know about this new `action' form). | |
a38313e1 SM |
38 | |
39 | ;;; Bugs: | |
40 | ||
eee6de73 SM |
41 | ;; - completion-all-sorted-completions list all the completions, whereas |
42 | ;; it should only lists the ones that `try-completion' would consider. | |
43 | ;; E.g. it should honor completion-ignored-extensions. | |
a38313e1 | 44 | ;; - choose-completion can't automatically figure out the boundaries |
528c56e2 SM |
45 | ;; corresponding to the displayed completions because we only |
46 | ;; provide the start info but not the end info in | |
47 | ;; completion-base-position. | |
4fcc3d32 | 48 | ;; - quoting is problematic. E.g. the double-dollar quoting used in |
9bdba5f5 | 49 | ;; substitute-in-file-name (and hence read-file-name-internal) bumps |
4fcc3d32 | 50 | ;; into various bugs: |
528c56e2 SM |
51 | ;; - choose-completion doesn't know how to quote the text it inserts. |
52 | ;; E.g. it fails to double the dollars in file-name completion, or | |
53 | ;; to backslash-escape spaces and other chars in comint completion. | |
3ed8598c | 54 | ;; - when completing ~/tmp/fo$$o, the highlighting in *Completions* |
4fcc3d32 SM |
55 | ;; is off by one position. |
56 | ;; - all code like PCM which relies on all-completions to match | |
57 | ;; its argument gets confused because all-completions returns unquoted | |
58 | ;; texts (as desired for *Completions* output). | |
528c56e2 SM |
59 | ;; - C-x C-f ~/*/sr ? should not list "~/./src". |
60 | ;; - minibuffer-force-complete completes ~/src/emacs/t<!>/lisp/minibuffer.el | |
61 | ;; to ~/src/emacs/trunk/ and throws away lisp/minibuffer.el. | |
ba5ff07b | 62 | |
3911966b SM |
63 | ;;; Todo: |
64 | ||
a2a25d24 | 65 | ;; - for M-x, cycle-sort commands that have no key binding first. |
2dbaa080 SM |
66 | ;; - Make things like icomplete-mode or lightning-completion work with |
67 | ;; completion-in-region-mode. | |
620c53a6 | 68 | ;; - extend `metadata': |
365b9a62 SM |
69 | ;; - quoting/unquoting (so we can complete files names with envvars |
70 | ;; and backslashes, and all-completion can list names without | |
71 | ;; quoting backslashes and dollars). | |
72 | ;; - indicate how to turn all-completion's output into | |
73 | ;; try-completion's output: e.g. completion-ignored-extensions. | |
74 | ;; maybe that could be merged with the "quote" operation above. | |
365b9a62 SM |
75 | ;; - indicate that `all-completions' doesn't do prefix-completion |
76 | ;; but just returns some list that relates in some other way to | |
77 | ;; the provided string (as is the case in filecache.el), in which | |
78 | ;; case partial-completion (for example) doesn't make any sense | |
79 | ;; and neither does the completions-first-difference highlight. | |
902a6d8d SM |
80 | ;; - indicate how to display the completions in *Completions* (turn |
81 | ;; \n into something else, add special boundaries between | |
82 | ;; completions). E.g. when completing from the kill-ring. | |
365b9a62 | 83 | |
528c56e2 | 84 | ;; - case-sensitivity currently confuses two issues: |
ab22be48 | 85 | ;; - whether or not a particular completion table should be case-sensitive |
528c56e2 | 86 | ;; (i.e. whether strings that differ only by case are semantically |
ab22be48 SM |
87 | ;; equivalent) |
88 | ;; - whether the user wants completion to pay attention to case. | |
89 | ;; e.g. we may want to make it possible for the user to say "first try | |
90 | ;; completion case-sensitively, and if that fails, try to ignore case". | |
91 | ||
a38313e1 | 92 | ;; - add support for ** to pcm. |
3911966b SM |
93 | ;; - Add vc-file-name-completion-table to read-file-name-internal. |
94 | ;; - A feature like completing-help.el. | |
32bae13c SM |
95 | |
96 | ;;; Code: | |
97 | ||
98 | (eval-when-compile (require 'cl)) | |
99 | ||
21622c6d SM |
100 | ;;; Completion table manipulation |
101 | ||
a38313e1 | 102 | ;; New completion-table operation. |
f8381803 SM |
103 | (defun completion-boundaries (string table pred suffix) |
104 | "Return the boundaries of the completions returned by TABLE for STRING. | |
a38313e1 | 105 | STRING is the string on which completion will be performed. |
f8381803 SM |
106 | SUFFIX is the string after point. |
107 | The result is of the form (START . END) where START is the position | |
108 | in STRING of the beginning of the completion field and END is the position | |
109 | in SUFFIX of the end of the completion field. | |
f8381803 SM |
110 | E.g. for simple completion tables, the result is always (0 . (length SUFFIX)) |
111 | and for file names the result is the positions delimited by | |
a38313e1 SM |
112 | the closest directory separators." |
113 | (let ((boundaries (if (functionp table) | |
30a23501 SM |
114 | (funcall table string pred |
115 | (cons 'boundaries suffix))))) | |
a38313e1 SM |
116 | (if (not (eq (car-safe boundaries) 'boundaries)) |
117 | (setq boundaries nil)) | |
118 | (cons (or (cadr boundaries) 0) | |
f8381803 | 119 | (or (cddr boundaries) (length suffix))))) |
a38313e1 | 120 | |
620c53a6 SM |
121 | (defun completion-metadata (string table pred) |
122 | "Return the metadata of elements to complete at the end of STRING. | |
123 | This metadata is an alist. Currently understood keys are: | |
124 | - `category': the kind of objects returned by `all-completions'. | |
125 | Used by `completion-category-overrides'. | |
126 | - `annotation-function': function to add annotations in *Completions*. | |
127 | Takes one argument (STRING), which is a possible completion and | |
128 | returns a string to append to STRING. | |
129 | - `display-sort-function': function to sort entries in *Completions*. | |
130 | Takes one argument (COMPLETIONS) and should return a new list | |
131 | of completions. Can operate destructively. | |
132 | - `cycle-sort-function': function to sort entries when cycling. | |
30a23501 SM |
133 | Works like `display-sort-function'. |
134 | The metadata of a completion table should be constant between two boundaries." | |
620c53a6 SM |
135 | (let ((metadata (if (functionp table) |
136 | (funcall table string pred 'metadata)))) | |
137 | (if (eq (car-safe metadata) 'metadata) | |
4cb3bfa0 SM |
138 | metadata |
139 | '(metadata)))) | |
620c53a6 SM |
140 | |
141 | (defun completion--field-metadata (field-start) | |
142 | (completion-metadata (buffer-substring-no-properties field-start (point)) | |
143 | minibuffer-completion-table | |
144 | minibuffer-completion-predicate)) | |
145 | ||
146 | (defun completion-metadata-get (metadata prop) | |
147 | (cdr (assq prop metadata))) | |
148 | ||
e2947429 SM |
149 | (defun completion--some (fun xs) |
150 | "Apply FUN to each element of XS in turn. | |
151 | Return the first non-nil returned value. | |
152 | Like CL's `some'." | |
a647cb26 SM |
153 | (let ((firsterror nil) |
154 | res) | |
e2947429 | 155 | (while (and (not res) xs) |
a38313e1 SM |
156 | (condition-case err |
157 | (setq res (funcall fun (pop xs))) | |
158 | (error (unless firsterror (setq firsterror err)) nil))) | |
159 | (or res | |
160 | (if firsterror (signal (car firsterror) (cdr firsterror)))))) | |
e2947429 | 161 | |
21622c6d SM |
162 | (defun complete-with-action (action table string pred) |
163 | "Perform completion ACTION. | |
164 | STRING is the string to complete. | |
165 | TABLE is the completion table, which should not be a function. | |
166 | PRED is a completion predicate. | |
167 | ACTION can be one of nil, t or `lambda'." | |
a38313e1 SM |
168 | (cond |
169 | ((functionp table) (funcall table string pred action)) | |
30a23501 SM |
170 | ((eq (car-safe action) 'boundaries) nil) |
171 | ((eq action 'metadata) nil) | |
a38313e1 SM |
172 | (t |
173 | (funcall | |
174 | (cond | |
175 | ((null action) 'try-completion) | |
176 | ((eq action t) 'all-completions) | |
177 | (t 'test-completion)) | |
178 | string table pred)))) | |
21622c6d SM |
179 | |
180 | (defun completion-table-dynamic (fun) | |
181 | "Use function FUN as a dynamic completion table. | |
182 | FUN is called with one argument, the string for which completion is required, | |
b95c7600 JB |
183 | and it should return an alist containing all the intended possible completions. |
184 | This alist may be a full list of possible completions so that FUN can ignore | |
185 | the value of its argument. If completion is performed in the minibuffer, | |
186 | FUN will be called in the buffer from which the minibuffer was entered. | |
21622c6d | 187 | |
e8061cd9 | 188 | The result of the `completion-table-dynamic' form is a function |
d9aa6b33 | 189 | that can be used as the COLLECTION argument to `try-completion' and |
b95c7600 | 190 | `all-completions'. See Info node `(elisp)Programmed Completion'." |
a647cb26 | 191 | (lambda (string pred action) |
30a23501 | 192 | (if (or (eq (car-safe action) 'boundaries) (eq action 'metadata)) |
03408648 SM |
193 | ;; `fun' is not supposed to return another function but a plain old |
194 | ;; completion table, whose boundaries are always trivial. | |
195 | nil | |
196 | (with-current-buffer (let ((win (minibuffer-selected-window))) | |
197 | (if (window-live-p win) (window-buffer win) | |
198 | (current-buffer))) | |
199 | (complete-with-action action (funcall fun string) string pred))))) | |
21622c6d SM |
200 | |
201 | (defmacro lazy-completion-table (var fun) | |
202 | "Initialize variable VAR as a lazy completion table. | |
203 | If the completion table VAR is used for the first time (e.g., by passing VAR | |
204 | as an argument to `try-completion'), the function FUN is called with no | |
205 | arguments. FUN must return the completion table that will be stored in VAR. | |
206 | If completion is requested in the minibuffer, FUN will be called in the buffer | |
207 | from which the minibuffer was entered. The return value of | |
208 | `lazy-completion-table' must be used to initialize the value of VAR. | |
209 | ||
210 | You should give VAR a non-nil `risky-local-variable' property." | |
69e018a7 | 211 | (declare (debug (symbolp lambda-expr))) |
21622c6d SM |
212 | (let ((str (make-symbol "string"))) |
213 | `(completion-table-dynamic | |
214 | (lambda (,str) | |
215 | (when (functionp ,var) | |
216 | (setq ,var (,fun))) | |
217 | ,var)))) | |
218 | ||
3dc61a09 SM |
219 | (defun completion-table-case-fold (table &optional dont-fold) |
220 | "Return new completion TABLE that is case insensitive. | |
221 | If DONT-FOLD is non-nil, return a completion table that is | |
222 | case sensitive instead." | |
223 | (lambda (string pred action) | |
224 | (let ((completion-ignore-case (not dont-fold))) | |
225 | (complete-with-action action table string pred)))) | |
e2784c87 | 226 | |
21622c6d | 227 | (defun completion-table-with-context (prefix table string pred action) |
25c0d999 | 228 | ;; TODO: add `suffix' maybe? |
b291b572 SM |
229 | (let ((pred |
230 | (if (not (functionp pred)) | |
231 | ;; Notice that `pred' may not be a function in some abusive cases. | |
232 | pred | |
233 | ;; Predicates are called differently depending on the nature of | |
234 | ;; the completion table :-( | |
235 | (cond | |
236 | ((vectorp table) ;Obarray. | |
237 | (lambda (sym) (funcall pred (concat prefix (symbol-name sym))))) | |
238 | ((hash-table-p table) | |
239 | (lambda (s _v) (funcall pred (concat prefix s)))) | |
240 | ((functionp table) | |
241 | (lambda (s) (funcall pred (concat prefix s)))) | |
242 | (t ;Lists and alists. | |
243 | (lambda (s) | |
244 | (funcall pred (concat prefix (if (consp s) (car s) s))))))))) | |
245 | (if (eq (car-safe action) 'boundaries) | |
246 | (let* ((len (length prefix)) | |
247 | (bound (completion-boundaries string table pred (cdr action)))) | |
248 | (list* 'boundaries (+ (car bound) len) (cdr bound))) | |
249 | (let ((comp (complete-with-action action table string pred))) | |
250 | (cond | |
251 | ;; In case of try-completion, add the prefix. | |
252 | ((stringp comp) (concat prefix comp)) | |
253 | (t comp)))))) | |
21622c6d SM |
254 | |
255 | (defun completion-table-with-terminator (terminator table string pred action) | |
528c56e2 SM |
256 | "Construct a completion table like TABLE but with an extra TERMINATOR. |
257 | This is meant to be called in a curried way by first passing TERMINATOR | |
258 | and TABLE only (via `apply-partially'). | |
259 | TABLE is a completion table, and TERMINATOR is a string appended to TABLE's | |
260 | completion if it is complete. TERMINATOR is also used to determine the | |
a452eee8 SM |
261 | completion suffix's boundary. |
262 | TERMINATOR can also be a cons cell (TERMINATOR . TERMINATOR-REGEXP) | |
263 | in which case TERMINATOR-REGEXP is a regular expression whose submatch | |
264 | number 1 should match TERMINATOR. This is used when there is a need to | |
265 | distinguish occurrences of the TERMINATOR strings which are really terminators | |
c0a193ea SM |
266 | from others (e.g. escaped). In this form, the car of TERMINATOR can also be, |
267 | instead of a string, a function that takes the completion and returns the | |
268 | \"terminated\" string." | |
3e2d70fd SM |
269 | ;; FIXME: This implementation is not right since it only adds the terminator |
270 | ;; in try-completion, so any completion-style that builds the completion via | |
271 | ;; all-completions won't get the terminator, and selecting an entry in | |
272 | ;; *Completions* won't get the terminator added either. | |
25c0d999 | 273 | (cond |
528c56e2 SM |
274 | ((eq (car-safe action) 'boundaries) |
275 | (let* ((suffix (cdr action)) | |
276 | (bounds (completion-boundaries string table pred suffix)) | |
a452eee8 SM |
277 | (terminator-regexp (if (consp terminator) |
278 | (cdr terminator) (regexp-quote terminator))) | |
c0a193ea SM |
279 | (max (and terminator-regexp |
280 | (string-match terminator-regexp suffix)))) | |
528c56e2 SM |
281 | (list* 'boundaries (car bounds) |
282 | (min (cdr bounds) (or max (length suffix)))))) | |
25c0d999 SM |
283 | ((eq action nil) |
284 | (let ((comp (try-completion string table pred))) | |
a452eee8 | 285 | (if (consp terminator) (setq terminator (car terminator))) |
88893215 | 286 | (if (eq comp t) |
c0a193ea SM |
287 | (if (functionp terminator) |
288 | (funcall terminator string) | |
289 | (concat string terminator)) | |
290 | (if (and (stringp comp) (not (zerop (length comp))) | |
291 | ;; Try to avoid the second call to try-completion, since | |
528c56e2 SM |
292 | ;; it may be very inefficient (because `comp' made us |
293 | ;; jump to a new boundary, so we complete in that | |
294 | ;; boundary with an empty start string). | |
c0a193ea SM |
295 | (let ((newbounds (completion-boundaries comp table pred ""))) |
296 | (< (car newbounds) (length comp))) | |
25c0d999 | 297 | (eq (try-completion comp table pred) t)) |
c0a193ea SM |
298 | (if (functionp terminator) |
299 | (funcall terminator comp) | |
300 | (concat comp terminator)) | |
25c0d999 | 301 | comp)))) |
30a23501 SM |
302 | ;; completion-table-with-terminator is always used for |
303 | ;; "sub-completions" so it's only called if the terminator is missing, | |
304 | ;; in which case `test-completion' should return nil. | |
305 | ((eq action 'lambda) nil) | |
306 | (t | |
a38313e1 SM |
307 | ;; FIXME: We generally want the `try' and `all' behaviors to be |
308 | ;; consistent so pcm can merge the `all' output to get the `try' output, | |
309 | ;; but that sometimes clashes with the need for `all' output to look | |
310 | ;; good in *Completions*. | |
125f7951 SM |
311 | ;; (mapcar (lambda (s) (concat s terminator)) |
312 | ;; (all-completions string table pred)))) | |
30a23501 | 313 | (complete-with-action action table string pred)))) |
25c0d999 SM |
314 | |
315 | (defun completion-table-with-predicate (table pred1 strict string pred2 action) | |
316 | "Make a completion table equivalent to TABLE but filtered through PRED1. | |
cf43708e | 317 | PRED1 is a function of one argument which returns non-nil if and only if the |
25c0d999 SM |
318 | argument is an element of TABLE which should be considered for completion. |
319 | STRING, PRED2, and ACTION are the usual arguments to completion tables, | |
320 | as described in `try-completion', `all-completions', and `test-completion'. | |
3911966b SM |
321 | If STRICT is t, the predicate always applies; if nil it only applies if |
322 | it does not reduce the set of possible completions to nothing. | |
25c0d999 SM |
323 | Note: TABLE needs to be a proper completion table which obeys predicates." |
324 | (cond | |
325 | ((and (not strict) (eq action 'lambda)) | |
326 | ;; Ignore pred1 since it doesn't really have to apply anyway. | |
af48580e | 327 | (test-completion string table pred2)) |
25c0d999 SM |
328 | (t |
329 | (or (complete-with-action action table string | |
78054a46 SM |
330 | (if (not (and pred1 pred2)) |
331 | (or pred1 pred2) | |
a647cb26 SM |
332 | (lambda (x) |
333 | ;; Call `pred1' first, so that `pred2' | |
334 | ;; really can't tell that `x' is in table. | |
78054a46 | 335 | (and (funcall pred1 x) (funcall pred2 x))))) |
25c0d999 SM |
336 | ;; If completion failed and we're not applying pred1 strictly, try |
337 | ;; again without pred1. | |
78054a46 | 338 | (and (not strict) pred1 pred2 |
25c0d999 | 339 | (complete-with-action action table string pred2)))))) |
21622c6d | 340 | |
e2947429 SM |
341 | (defun completion-table-in-turn (&rest tables) |
342 | "Create a completion table that tries each table in TABLES in turn." | |
528c56e2 SM |
343 | ;; FIXME: the boundaries may come from TABLE1 even when the completion list |
344 | ;; is returned by TABLE2 (because TABLE1 returned an empty list). | |
a647cb26 SM |
345 | (lambda (string pred action) |
346 | (completion--some (lambda (table) | |
347 | (complete-with-action action table string pred)) | |
348 | tables))) | |
e2947429 | 349 | |
25c0d999 SM |
350 | ;; (defmacro complete-in-turn (a b) `(completion-table-in-turn ,a ,b)) |
351 | ;; (defmacro dynamic-completion-table (fun) `(completion-table-dynamic ,fun)) | |
e2947429 SM |
352 | (define-obsolete-function-alias |
353 | 'complete-in-turn 'completion-table-in-turn "23.1") | |
25c0d999 SM |
354 | (define-obsolete-function-alias |
355 | 'dynamic-completion-table 'completion-table-dynamic "23.1") | |
21622c6d SM |
356 | |
357 | ;;; Minibuffer completion | |
358 | ||
ba5ff07b SM |
359 | (defgroup minibuffer nil |
360 | "Controlling the behavior of the minibuffer." | |
361 | :link '(custom-manual "(emacs)Minibuffer") | |
362 | :group 'environment) | |
363 | ||
32bae13c SM |
364 | (defun minibuffer-message (message &rest args) |
365 | "Temporarily display MESSAGE at the end of the minibuffer. | |
366 | The text is displayed for `minibuffer-message-timeout' seconds, | |
367 | or until the next input event arrives, whichever comes first. | |
368 | Enclose MESSAGE in [...] if this is not yet the case. | |
369 | If ARGS are provided, then pass MESSAGE through `format'." | |
ab22be48 SM |
370 | (if (not (minibufferp (current-buffer))) |
371 | (progn | |
372 | (if args | |
373 | (apply 'message message args) | |
374 | (message "%s" message)) | |
375 | (prog1 (sit-for (or minibuffer-message-timeout 1000000)) | |
376 | (message nil))) | |
377 | ;; Clear out any old echo-area message to make way for our new thing. | |
378 | (message nil) | |
379 | (setq message (if (and (null args) (string-match-p "\\` *\\[.+\\]\\'" message)) | |
380 | ;; Make sure we can put-text-property. | |
381 | (copy-sequence message) | |
382 | (concat " [" message "]"))) | |
383 | (when args (setq message (apply 'format message args))) | |
384 | (let ((ol (make-overlay (point-max) (point-max) nil t t)) | |
385 | ;; A quit during sit-for normally only interrupts the sit-for, | |
386 | ;; but since minibuffer-message is used at the end of a command, | |
387 | ;; at a time when the command has virtually finished already, a C-g | |
388 | ;; should really cause an abort-recursive-edit instead (i.e. as if | |
389 | ;; the C-g had been typed at top-level). Binding inhibit-quit here | |
390 | ;; is an attempt to get that behavior. | |
391 | (inhibit-quit t)) | |
392 | (unwind-protect | |
393 | (progn | |
394 | (unless (zerop (length message)) | |
395 | ;; The current C cursor code doesn't know to use the overlay's | |
396 | ;; marker's stickiness to figure out whether to place the cursor | |
397 | ;; before or after the string, so let's spoon-feed it the pos. | |
398 | (put-text-property 0 1 'cursor t message)) | |
399 | (overlay-put ol 'after-string message) | |
400 | (sit-for (or minibuffer-message-timeout 1000000))) | |
401 | (delete-overlay ol))))) | |
32bae13c SM |
402 | |
403 | (defun minibuffer-completion-contents () | |
404 | "Return the user input in a minibuffer before point as a string. | |
405 | That is what completion commands operate on." | |
406 | (buffer-substring (field-beginning) (point))) | |
407 | ||
408 | (defun delete-minibuffer-contents () | |
409 | "Delete all user input in a minibuffer. | |
410 | If the current buffer is not a minibuffer, erase its entire contents." | |
8c9f211f CY |
411 | ;; We used to do `delete-field' here, but when file name shadowing |
412 | ;; is on, the field doesn't cover the entire minibuffer contents. | |
413 | (delete-region (minibuffer-prompt-end) (point-max))) | |
32bae13c | 414 | |
369e974d CY |
415 | (defvar completion-show-inline-help t |
416 | "If non-nil, print helpful inline messages during completion.") | |
417 | ||
ba5ff07b SM |
418 | (defcustom completion-auto-help t |
419 | "Non-nil means automatically provide help for invalid completion input. | |
420 | If the value is t the *Completion* buffer is displayed whenever completion | |
421 | is requested but cannot be done. | |
422 | If the value is `lazy', the *Completions* buffer is only displayed after | |
423 | the second failed attempt to complete." | |
e1bb0fe5 | 424 | :type '(choice (const nil) (const t) (const lazy)) |
ba5ff07b SM |
425 | :group 'minibuffer) |
426 | ||
2f7f4bee | 427 | (defconst completion-styles-alist |
fcb68f70 SM |
428 | '((emacs21 |
429 | completion-emacs21-try-completion completion-emacs21-all-completions | |
79d74ac5 SM |
430 | "Simple prefix-based completion. |
431 | I.e. when completing \"foo_bar\" (where _ is the position of point), | |
432 | it will consider all completions candidates matching the glob | |
433 | pattern \"foobar*\".") | |
fcb68f70 SM |
434 | (emacs22 |
435 | completion-emacs22-try-completion completion-emacs22-all-completions | |
79d74ac5 SM |
436 | "Prefix completion that only operates on the text before point. |
437 | I.e. when completing \"foo_bar\" (where _ is the position of point), | |
438 | it will consider all completions candidates matching the glob | |
439 | pattern \"foo*\" and will add back \"bar\" to the end of it.") | |
fcb68f70 SM |
440 | (basic |
441 | completion-basic-try-completion completion-basic-all-completions | |
79d74ac5 SM |
442 | "Completion of the prefix before point and the suffix after point. |
443 | I.e. when completing \"foo_bar\" (where _ is the position of point), | |
444 | it will consider all completions candidates matching the glob | |
445 | pattern \"foo*bar*\".") | |
34200787 | 446 | (partial-completion |
fcb68f70 SM |
447 | completion-pcm-try-completion completion-pcm-all-completions |
448 | "Completion of multiple words, each one taken as a prefix. | |
79d74ac5 SM |
449 | I.e. when completing \"l-co_h\" (where _ is the position of point), |
450 | it will consider all completions candidates matching the glob | |
451 | pattern \"l*-co*h*\". | |
452 | Furthermore, for completions that are done step by step in subfields, | |
453 | the method is applied to all the preceding fields that do not yet match. | |
454 | E.g. C-x C-f /u/mo/s TAB could complete to /usr/monnier/src. | |
455 | Additionally the user can use the char \"*\" as a glob pattern.") | |
56d365a9 SM |
456 | (substring |
457 | completion-substring-try-completion completion-substring-all-completions | |
458 | "Completion of the string taken as a substring. | |
459 | I.e. when completing \"foo_bar\" (where _ is the position of point), | |
460 | it will consider all completions candidates matching the glob | |
461 | pattern \"*foo*bar*\".") | |
fcb68f70 SM |
462 | (initials |
463 | completion-initials-try-completion completion-initials-all-completions | |
464 | "Completion of acronyms and initialisms. | |
465 | E.g. can complete M-x lch to list-command-history | |
466 | and C-x C-f ~/sew to ~/src/emacs/work.")) | |
e2947429 | 467 | "List of available completion styles. |
fcb68f70 | 468 | Each element has the form (NAME TRY-COMPLETION ALL-COMPLETIONS DOC): |
26c548b0 | 469 | where NAME is the name that should be used in `completion-styles', |
fcb68f70 SM |
470 | TRY-COMPLETION is the function that does the completion (it should |
471 | follow the same calling convention as `completion-try-completion'), | |
472 | ALL-COMPLETIONS is the function that lists the completions (it should | |
473 | follow the calling convention of `completion-all-completions'), | |
474 | and DOC describes the way this style of completion works.") | |
e2947429 | 475 | |
3dc61a09 SM |
476 | (defconst completion--styles-type |
477 | `(repeat :tag "insert a new menu to add more styles" | |
478 | (choice ,@(mapcar (lambda (x) (list 'const (car x))) | |
479 | completion-styles-alist)))) | |
480 | (defconst completion--cycling-threshold-type | |
481 | '(choice (const :tag "No cycling" nil) | |
482 | (const :tag "Always cycle" t) | |
483 | (integer :tag "Threshold"))) | |
484 | ||
79d74ac5 SM |
485 | (defcustom completion-styles |
486 | ;; First, use `basic' because prefix completion has been the standard | |
487 | ;; for "ever" and works well in most cases, so using it first | |
488 | ;; ensures that we obey previous behavior in most cases. | |
489 | '(basic | |
490 | ;; Then use `partial-completion' because it has proven to | |
491 | ;; be a very convenient extension. | |
492 | partial-completion | |
493 | ;; Finally use `emacs22' so as to maintain (in many/most cases) | |
494 | ;; the previous behavior that when completing "foobar" with point | |
495 | ;; between "foo" and "bar" the completion try to complete "foo" | |
496 | ;; and simply add "bar" to the end of the result. | |
497 | emacs22) | |
265d4549 | 498 | "List of completion styles to use. |
693fbdb6 EZ |
499 | The available styles are listed in `completion-styles-alist'. |
500 | ||
501 | Note that `completion-category-overrides' may override these | |
502 | styles for specific categories, such as files, buffers, etc." | |
3dc61a09 | 503 | :type completion--styles-type |
e2947429 SM |
504 | :group 'minibuffer |
505 | :version "23.1") | |
506 | ||
620c53a6 SM |
507 | (defcustom completion-category-overrides |
508 | '((buffer (styles . (basic substring)))) | |
693fbdb6 | 509 | "List of `completion-styles' overrides for specific categories. |
620c53a6 SM |
510 | Each override has the shape (CATEGORY . ALIST) where ALIST is |
511 | an association list that can specify properties such as: | |
512 | - `styles': the list of `completion-styles' to use for that category. | |
49fe4321 GM |
513 | - `cycle': the `completion-cycle-threshold' to use for that category. |
514 | Categories are symbols such as `buffer' and `file', used when | |
515 | completing buffer and file names, respectively." | |
2bed3f04 | 516 | :version "24.1" |
8ea0a993 SB |
517 | :type `(alist :key-type (choice :tag "Category" |
518 | (const buffer) | |
620c53a6 | 519 | (const file) |
3dc61a09 | 520 | (const unicode-name) |
620c53a6 SM |
521 | symbol) |
522 | :value-type | |
8ea0a993 SB |
523 | (set :tag "Properties to override" |
524 | (cons :tag "Completion Styles" | |
525 | (const :tag "Select a style from the menu;" styles) | |
3dc61a09 | 526 | ,completion--styles-type) |
8ea0a993 SB |
527 | (cons :tag "Completion Cycling" |
528 | (const :tag "Select one value from the menu." cycle) | |
3dc61a09 | 529 | ,completion--cycling-threshold-type)))) |
620c53a6 SM |
530 | |
531 | (defun completion--styles (metadata) | |
532 | (let* ((cat (completion-metadata-get metadata 'category)) | |
533 | (over (assq 'styles (cdr (assq cat completion-category-overrides))))) | |
534 | (if over | |
535 | (delete-dups (append (cdr over) (copy-sequence completion-styles))) | |
536 | completion-styles))) | |
537 | ||
4cb3bfa0 | 538 | (defun completion-try-completion (string table pred point &optional metadata) |
19c04f39 SM |
539 | "Try to complete STRING using completion table TABLE. |
540 | Only the elements of table that satisfy predicate PRED are considered. | |
541 | POINT is the position of point within STRING. | |
542 | The return value can be either nil to indicate that there is no completion, | |
543 | t to indicate that STRING is the only possible completion, | |
544 | or a pair (STRING . NEWPOINT) of the completed result string together with | |
545 | a new position for point." | |
fcb68f70 SM |
546 | (completion--some (lambda (style) |
547 | (funcall (nth 1 (assq style completion-styles-alist)) | |
548 | string table pred point)) | |
4cb3bfa0 SM |
549 | (completion--styles (or metadata |
550 | (completion-metadata | |
551 | (substring string 0 point) | |
552 | table pred))))) | |
e2947429 | 553 | |
4cb3bfa0 | 554 | (defun completion-all-completions (string table pred point &optional metadata) |
19c04f39 SM |
555 | "List the possible completions of STRING in completion table TABLE. |
556 | Only the elements of table that satisfy predicate PRED are considered. | |
557 | POINT is the position of point within STRING. | |
26c548b0 | 558 | The return value is a list of completions and may contain the base-size |
19c04f39 | 559 | in the last `cdr'." |
365b9a62 SM |
560 | ;; FIXME: We need to additionally return the info needed for the |
561 | ;; second part of completion-base-position. | |
fcb68f70 SM |
562 | (completion--some (lambda (style) |
563 | (funcall (nth 2 (assq style completion-styles-alist)) | |
564 | string table pred point)) | |
4cb3bfa0 SM |
565 | (completion--styles (or metadata |
566 | (completion-metadata | |
567 | (substring string 0 point) | |
568 | table pred))))) | |
e2947429 | 569 | |
ba5ff07b SM |
570 | (defun minibuffer--bitset (modified completions exact) |
571 | (logior (if modified 4 0) | |
572 | (if completions 2 0) | |
573 | (if exact 1 0))) | |
574 | ||
c53b9c3b SM |
575 | (defun completion--replace (beg end newtext) |
576 | "Replace the buffer text between BEG and END with NEWTEXT. | |
577 | Moves point to the end of the new text." | |
1d00653d SM |
578 | ;; The properties on `newtext' include things like |
579 | ;; completions-first-difference, which we don't want to include | |
580 | ;; upon insertion. | |
581 | (set-text-properties 0 (length newtext) nil newtext) | |
55586d2a | 582 | ;; Maybe this should be in subr.el. |
c53b9c3b SM |
583 | ;; You'd think this is trivial to do, but details matter if you want |
584 | ;; to keep markers "at the right place" and be robust in the face of | |
585 | ;; after-change-functions that may themselves modify the buffer. | |
55586d2a SM |
586 | (let ((prefix-len 0)) |
587 | ;; Don't touch markers in the shared prefix (if any). | |
588 | (while (and (< prefix-len (length newtext)) | |
589 | (< (+ beg prefix-len) end) | |
590 | (eq (char-after (+ beg prefix-len)) | |
591 | (aref newtext prefix-len))) | |
592 | (setq prefix-len (1+ prefix-len))) | |
593 | (unless (zerop prefix-len) | |
594 | (setq beg (+ beg prefix-len)) | |
595 | (setq newtext (substring newtext prefix-len)))) | |
596 | (let ((suffix-len 0)) | |
597 | ;; Don't touch markers in the shared suffix (if any). | |
598 | (while (and (< suffix-len (length newtext)) | |
599 | (< beg (- end suffix-len)) | |
600 | (eq (char-before (- end suffix-len)) | |
601 | (aref newtext (- (length newtext) suffix-len 1)))) | |
602 | (setq suffix-len (1+ suffix-len))) | |
603 | (unless (zerop suffix-len) | |
604 | (setq end (- end suffix-len)) | |
8348910a SM |
605 | (setq newtext (substring newtext 0 (- suffix-len)))) |
606 | (goto-char beg) | |
96a8a0df | 607 | (insert-and-inherit newtext) |
8348910a SM |
608 | (delete-region (point) (+ (point) (- end beg))) |
609 | (forward-char suffix-len))) | |
c53b9c3b | 610 | |
902a6d8d SM |
611 | (defcustom completion-cycle-threshold nil |
612 | "Number of completion candidates below which cycling is used. | |
613 | Depending on this setting `minibuffer-complete' may use cycling, | |
614 | like `minibuffer-force-complete'. | |
615 | If nil, cycling is never used. | |
616 | If t, cycling is always used. | |
617 | If an integer, cycling is used as soon as there are fewer completion | |
618 | candidates than this number." | |
2bed3f04 | 619 | :version "24.1" |
3dc61a09 | 620 | :type completion--cycling-threshold-type) |
902a6d8d | 621 | |
620c53a6 SM |
622 | (defun completion--cycle-threshold (metadata) |
623 | (let* ((cat (completion-metadata-get metadata 'category)) | |
624 | (over (assq 'cycle (cdr (assq cat completion-category-overrides))))) | |
625 | (if over (cdr over) completion-cycle-threshold))) | |
626 | ||
6175cd08 SM |
627 | (defvar completion-all-sorted-completions nil) |
628 | (make-variable-buffer-local 'completion-all-sorted-completions) | |
629 | (defvar completion-cycling nil) | |
630 | ||
b7e270a2 SM |
631 | (defvar completion-fail-discreetly nil |
632 | "If non-nil, stay quiet when there is no match.") | |
633 | ||
ef80fc09 SM |
634 | (defun completion--message (msg) |
635 | (if completion-show-inline-help | |
636 | (minibuffer-message msg))) | |
637 | ||
a2a25d24 SM |
638 | (defun completion--do-completion (&optional try-completion-function |
639 | expect-exact) | |
32bae13c | 640 | "Do the completion and return a summary of what happened. |
ba5ff07b SM |
641 | M = completion was performed, the text was Modified. |
642 | C = there were available Completions. | |
643 | E = after completion we now have an Exact match. | |
644 | ||
645 | MCE | |
646 | 000 0 no possible completion | |
647 | 001 1 was already an exact and unique completion | |
648 | 010 2 no completion happened | |
649 | 011 3 was already an exact completion | |
650 | 100 4 ??? impossible | |
651 | 101 5 ??? impossible | |
652 | 110 6 some completion happened | |
a2a25d24 SM |
653 | 111 7 completed to an exact completion |
654 | ||
655 | TRY-COMPLETION-FUNCTION is a function to use in place of `try-completion'. | |
656 | EXPECT-EXACT, if non-nil, means that there is no need to tell the user | |
657 | when the buffer's text is already an exact match." | |
a647cb26 SM |
658 | (let* ((beg (field-beginning)) |
659 | (end (field-end)) | |
660 | (string (buffer-substring beg end)) | |
620c53a6 | 661 | (md (completion--field-metadata beg)) |
a647cb26 SM |
662 | (comp (funcall (or try-completion-function |
663 | 'completion-try-completion) | |
664 | string | |
665 | minibuffer-completion-table | |
666 | minibuffer-completion-predicate | |
620c53a6 SM |
667 | (- (point) beg) |
668 | md))) | |
32bae13c | 669 | (cond |
19c04f39 | 670 | ((null comp) |
890429cc | 671 | (minibuffer-hide-completions) |
ef80fc09 | 672 | (unless completion-fail-discreetly |
369e974d | 673 | (ding) |
ef80fc09 | 674 | (completion--message "No match")) |
b7e270a2 | 675 | (minibuffer--bitset nil nil nil)) |
265d4549 | 676 | ((eq t comp) |
890429cc | 677 | (minibuffer-hide-completions) |
a2a25d24 SM |
678 | (goto-char end) |
679 | (completion--done string 'finished | |
680 | (unless expect-exact "Sole completion")) | |
6175cd08 | 681 | (minibuffer--bitset nil nil t)) ;Exact and unique match. |
32bae13c SM |
682 | (t |
683 | ;; `completed' should be t if some completion was done, which doesn't | |
684 | ;; include simply changing the case of the entered string. However, | |
685 | ;; for appearance, the string is rewritten if the case changes. | |
a647cb26 SM |
686 | (let* ((comp-pos (cdr comp)) |
687 | (completion (car comp)) | |
688 | (completed (not (eq t (compare-strings completion nil nil | |
689 | string nil nil t)))) | |
690 | (unchanged (eq t (compare-strings completion nil nil | |
691 | string nil nil nil)))) | |
c53b9c3b | 692 | (if unchanged |
397ae226 | 693 | (goto-char end) |
c53b9c3b SM |
694 | ;; Insert in minibuffer the chars we got. |
695 | (completion--replace beg end completion)) | |
696 | ;; Move point to its completion-mandated destination. | |
697 | (forward-char (- comp-pos (length completion))) | |
ba5ff07b | 698 | |
32bae13c | 699 | (if (not (or unchanged completed)) |
6175cd08 SM |
700 | ;; The case of the string changed, but that's all. We're not sure |
701 | ;; whether this is a unique completion or not, so try again using | |
702 | ;; the real case (this shouldn't recurse again, because the next | |
703 | ;; time try-completion will return either t or the exact string). | |
a2a25d24 | 704 | (completion--do-completion try-completion-function expect-exact) |
32bae13c SM |
705 | |
706 | ;; It did find a match. Do we match some possibility exactly now? | |
620c53a6 | 707 | (let* ((exact (test-completion completion |
a2a25d24 SM |
708 | minibuffer-completion-table |
709 | minibuffer-completion-predicate)) | |
620c53a6 | 710 | (threshold (completion--cycle-threshold md)) |
902a6d8d SM |
711 | (comps |
712 | ;; Check to see if we want to do cycling. We do it | |
713 | ;; here, after having performed the normal completion, | |
714 | ;; so as to take advantage of the difference between | |
715 | ;; try-completion and all-completions, for things | |
716 | ;; like completion-ignored-extensions. | |
620c53a6 | 717 | (when (and threshold |
902a6d8d SM |
718 | ;; Check that the completion didn't make |
719 | ;; us jump to a different boundary. | |
720 | (or (not completed) | |
721 | (< (car (completion-boundaries | |
722 | (substring completion 0 comp-pos) | |
723 | minibuffer-completion-table | |
724 | minibuffer-completion-predicate | |
725 | "")) | |
726 | comp-pos))) | |
727 | (completion-all-sorted-completions)))) | |
6175cd08 | 728 | (completion--flush-all-sorted-completions) |
902a6d8d | 729 | (cond |
6175cd08 SM |
730 | ((and (consp (cdr comps)) ;; There's something to cycle. |
731 | (not (ignore-errors | |
902a6d8d SM |
732 | ;; This signal an (intended) error if comps is too |
733 | ;; short or if completion-cycle-threshold is t. | |
620c53a6 | 734 | (consp (nthcdr threshold comps))))) |
902a6d8d SM |
735 | ;; Fewer than completion-cycle-threshold remaining |
736 | ;; completions: let's cycle. | |
737 | (setq completed t exact t) | |
738 | (setq completion-all-sorted-completions comps) | |
739 | (minibuffer-force-complete)) | |
740 | (completed | |
6175cd08 SM |
741 | ;; We could also decide to refresh the completions, |
742 | ;; if they're displayed (and assuming there are | |
743 | ;; completions left). | |
a2a25d24 SM |
744 | (minibuffer-hide-completions) |
745 | (if exact | |
746 | ;; If completion did not put point at end of field, | |
747 | ;; it's a sign that completion is not finished. | |
748 | (completion--done completion | |
749 | (if (< comp-pos (length completion)) | |
750 | 'exact 'unknown)))) | |
6175cd08 SM |
751 | ;; Show the completion table, if requested. |
752 | ((not exact) | |
ef80fc09 SM |
753 | (if (case completion-auto-help |
754 | (lazy (eq this-command last-command)) | |
755 | (t completion-auto-help)) | |
6175cd08 | 756 | (minibuffer-completion-help) |
ef80fc09 | 757 | (completion--message "Next char not unique"))) |
6175cd08 | 758 | ;; If the last exact completion and this one were the same, it |
ef80fc09 | 759 | ;; means we've already given a "Complete, but not unique" message |
6175cd08 | 760 | ;; and the user's hit TAB again, so now we give him help. |
a2a25d24 SM |
761 | (t |
762 | (if (and (eq this-command last-command) completion-auto-help) | |
763 | (minibuffer-completion-help)) | |
764 | (completion--done completion 'exact | |
765 | (unless expect-exact | |
766 | "Complete, but not unique")))) | |
ba5ff07b SM |
767 | |
768 | (minibuffer--bitset completed t exact)))))))) | |
32bae13c SM |
769 | |
770 | (defun minibuffer-complete () | |
771 | "Complete the minibuffer contents as far as possible. | |
772 | Return nil if there is no valid completion, else t. | |
773 | If no characters can be completed, display a list of possible completions. | |
774 | If you repeat this command after it displayed such a list, | |
775 | scroll the window of possible completions." | |
776 | (interactive) | |
777 | ;; If the previous command was not this, | |
778 | ;; mark the completion buffer obsolete. | |
779 | (unless (eq this-command last-command) | |
6175cd08 | 780 | (completion--flush-all-sorted-completions) |
32bae13c SM |
781 | (setq minibuffer-scroll-window nil)) |
782 | ||
902a6d8d | 783 | (cond |
03408648 SM |
784 | ;; If there's a fresh completion window with a live buffer, |
785 | ;; and this command is repeated, scroll that window. | |
902a6d8d SM |
786 | ((window-live-p minibuffer-scroll-window) |
787 | (let ((window minibuffer-scroll-window)) | |
03408648 SM |
788 | (with-current-buffer (window-buffer window) |
789 | (if (pos-visible-in-window-p (point-max) window) | |
790 | ;; If end is in view, scroll up to the beginning. | |
791 | (set-window-start window (point-min) nil) | |
792 | ;; Else scroll down one screen. | |
793 | (scroll-other-window)) | |
902a6d8d SM |
794 | nil))) |
795 | ;; If we're cycling, keep on cycling. | |
6175cd08 | 796 | ((and completion-cycling completion-all-sorted-completions) |
902a6d8d SM |
797 | (minibuffer-force-complete) |
798 | t) | |
799 | (t (case (completion--do-completion) | |
a38313e1 | 800 | (#b000 nil) |
a38313e1 | 801 | (t t))))) |
32bae13c | 802 | |
d032d5e7 | 803 | (defun completion--flush-all-sorted-completions (&rest _ignore) |
d86d2721 SM |
804 | (remove-hook 'after-change-functions |
805 | 'completion--flush-all-sorted-completions t) | |
6175cd08 | 806 | (setq completion-cycling nil) |
14c24780 SM |
807 | (setq completion-all-sorted-completions nil)) |
808 | ||
30a23501 SM |
809 | (defun completion--metadata (string base md-at-point table pred) |
810 | ;; Like completion-metadata, but for the specific case of getting the | |
811 | ;; metadata at `base', which tends to trigger pathological behavior for old | |
812 | ;; completion tables which don't understand `metadata'. | |
813 | (let ((bounds (completion-boundaries string table pred ""))) | |
814 | (if (eq (car bounds) base) md-at-point | |
815 | (completion-metadata (substring string 0 base) table pred)))) | |
816 | ||
14c24780 SM |
817 | (defun completion-all-sorted-completions () |
818 | (or completion-all-sorted-completions | |
819 | (let* ((start (field-beginning)) | |
820 | (end (field-end)) | |
620c53a6 | 821 | (string (buffer-substring start end)) |
30a23501 | 822 | (md (completion--field-metadata start)) |
620c53a6 SM |
823 | (all (completion-all-completions |
824 | string | |
825 | minibuffer-completion-table | |
826 | minibuffer-completion-predicate | |
827 | (- (point) start) | |
30a23501 | 828 | md)) |
14c24780 | 829 | (last (last all)) |
620c53a6 | 830 | (base-size (or (cdr last) 0)) |
30a23501 SM |
831 | (all-md (completion--metadata (buffer-substring-no-properties |
832 | start (point)) | |
833 | base-size md | |
834 | minibuffer-completion-table | |
835 | minibuffer-completion-predicate)) | |
620c53a6 | 836 | (sort-fun (completion-metadata-get all-md 'cycle-sort-function))) |
14c24780 SM |
837 | (when last |
838 | (setcdr last nil) | |
620c53a6 SM |
839 | (setq all (if sort-fun (funcall sort-fun all) |
840 | ;; Prefer shorter completions, by default. | |
841 | (sort all (lambda (c1 c2) (< (length c1) (length c2)))))) | |
14c24780 | 842 | ;; Prefer recently used completions. |
a2a25d24 SM |
843 | (when (minibufferp) |
844 | (let ((hist (symbol-value minibuffer-history-variable))) | |
845 | (setq all (sort all (lambda (c1 c2) | |
846 | (> (length (member c1 hist)) | |
847 | (length (member c2 hist)))))))) | |
14c24780 SM |
848 | ;; Cache the result. This is not just for speed, but also so that |
849 | ;; repeated calls to minibuffer-force-complete can cycle through | |
850 | ;; all possibilities. | |
851 | (add-hook 'after-change-functions | |
852 | 'completion--flush-all-sorted-completions nil t) | |
853 | (setq completion-all-sorted-completions | |
854 | (nconc all base-size)))))) | |
855 | ||
856 | (defun minibuffer-force-complete () | |
857 | "Complete the minibuffer to an exact match. | |
858 | Repeated uses step through the possible completions." | |
859 | (interactive) | |
860 | ;; FIXME: Need to deal with the extra-size issue here as well. | |
528c56e2 SM |
861 | ;; FIXME: ~/src/emacs/t<M-TAB>/lisp/minibuffer.el completes to |
862 | ;; ~/src/emacs/trunk/ and throws away lisp/minibuffer.el. | |
14c24780 SM |
863 | (let* ((start (field-beginning)) |
864 | (end (field-end)) | |
620c53a6 | 865 | ;; (md (completion--field-metadata start)) |
a2a25d24 SM |
866 | (all (completion-all-sorted-completions)) |
867 | (base (+ start (or (cdr (last all)) 0)))) | |
868 | (cond | |
869 | ((not (consp all)) | |
ef80fc09 | 870 | (completion--message |
a2a25d24 SM |
871 | (if all "No more completions" "No completions"))) |
872 | ((not (consp (cdr all))) | |
873 | (let ((mod (equal (car all) (buffer-substring-no-properties base end)))) | |
874 | (if mod (completion--replace base end (car all))) | |
875 | (completion--done (buffer-substring-no-properties start (point)) | |
876 | 'finished (unless mod "Sole completion")))) | |
877 | (t | |
6175cd08 | 878 | (setq completion-cycling t) |
a2a25d24 SM |
879 | (completion--replace base end (car all)) |
880 | (completion--done (buffer-substring-no-properties start (point)) 'sole) | |
14c24780 SM |
881 | ;; If completing file names, (car all) may be a directory, so we'd now |
882 | ;; have a new set of possible completions and might want to reset | |
883 | ;; completion-all-sorted-completions to nil, but we prefer not to, | |
884 | ;; so that repeated calls minibuffer-force-complete still cycle | |
885 | ;; through the previous possible completions. | |
075518b5 SM |
886 | (let ((last (last all))) |
887 | (setcdr last (cons (car all) (cdr last))) | |
a2a25d24 | 888 | (setq completion-all-sorted-completions (cdr all))))))) |
14c24780 | 889 | |
d1826585 | 890 | (defvar minibuffer-confirm-exit-commands |
a25c543a | 891 | '(minibuffer-complete minibuffer-complete-word PC-complete PC-complete-word) |
d1826585 MB |
892 | "A list of commands which cause an immediately following |
893 | `minibuffer-complete-and-exit' to ask for extra confirmation.") | |
894 | ||
32bae13c | 895 | (defun minibuffer-complete-and-exit () |
bec1e8a5 CY |
896 | "Exit if the minibuffer contains a valid completion. |
897 | Otherwise, try to complete the minibuffer contents. If | |
898 | completion leads to a valid completion, a repetition of this | |
899 | command will exit. | |
900 | ||
901 | If `minibuffer-completion-confirm' is `confirm', do not try to | |
902 | complete; instead, ask for confirmation and accept any input if | |
903 | confirmed. | |
904 | If `minibuffer-completion-confirm' is `confirm-after-completion', | |
905 | do not try to complete; instead, ask for confirmation if the | |
90810a8e CY |
906 | preceding minibuffer command was a member of |
907 | `minibuffer-confirm-exit-commands', and accept the input | |
908 | otherwise." | |
32bae13c | 909 | (interactive) |
a647cb26 SM |
910 | (let ((beg (field-beginning)) |
911 | (end (field-end))) | |
3911966b SM |
912 | (cond |
913 | ;; Allow user to specify null string | |
914 | ((= beg end) (exit-minibuffer)) | |
915 | ((test-completion (buffer-substring beg end) | |
916 | minibuffer-completion-table | |
917 | minibuffer-completion-predicate) | |
365b9a62 SM |
918 | ;; FIXME: completion-ignore-case has various slightly |
919 | ;; incompatible meanings. E.g. it can reflect whether the user | |
920 | ;; wants completion to pay attention to case, or whether the | |
921 | ;; string will be used in a context where case is significant. | |
922 | ;; E.g. usually try-completion should obey the first, whereas | |
923 | ;; test-completion should obey the second. | |
3911966b SM |
924 | (when completion-ignore-case |
925 | ;; Fixup case of the field, if necessary. | |
b0a5a021 | 926 | (let* ((string (buffer-substring beg end)) |
3911966b SM |
927 | (compl (try-completion |
928 | string | |
929 | minibuffer-completion-table | |
930 | minibuffer-completion-predicate))) | |
365b9a62 | 931 | (when (and (stringp compl) (not (equal string compl)) |
3911966b SM |
932 | ;; If it weren't for this piece of paranoia, I'd replace |
933 | ;; the whole thing with a call to do-completion. | |
eee6de73 SM |
934 | ;; This is important, e.g. when the current minibuffer's |
935 | ;; content is a directory which only contains a single | |
936 | ;; file, so `try-completion' actually completes to | |
937 | ;; that file. | |
3911966b | 938 | (= (length string) (length compl))) |
96a8a0df | 939 | (completion--replace beg end compl)))) |
3911966b | 940 | (exit-minibuffer)) |
32bae13c | 941 | |
365b9a62 | 942 | ((memq minibuffer-completion-confirm '(confirm confirm-after-completion)) |
3911966b | 943 | ;; The user is permitted to exit with an input that's rejected |
bec1e8a5 | 944 | ;; by test-completion, after confirming her choice. |
365b9a62 SM |
945 | (if (or (eq last-command this-command) |
946 | ;; For `confirm-after-completion' we only ask for confirmation | |
947 | ;; if trying to exit immediately after typing TAB (this | |
948 | ;; catches most minibuffer typos). | |
949 | (and (eq minibuffer-completion-confirm 'confirm-after-completion) | |
950 | (not (memq last-command minibuffer-confirm-exit-commands)))) | |
3911966b SM |
951 | (exit-minibuffer) |
952 | (minibuffer-message "Confirm") | |
953 | nil)) | |
32bae13c | 954 | |
3911966b SM |
955 | (t |
956 | ;; Call do-completion, but ignore errors. | |
957 | (case (condition-case nil | |
a2a25d24 | 958 | (completion--do-completion nil 'expect-exact) |
3911966b | 959 | (error 1)) |
a38313e1 SM |
960 | ((#b001 #b011) (exit-minibuffer)) |
961 | (#b111 (if (not minibuffer-completion-confirm) | |
962 | (exit-minibuffer) | |
963 | (minibuffer-message "Confirm") | |
964 | nil)) | |
3911966b SM |
965 | (t nil)))))) |
966 | ||
620c53a6 SM |
967 | (defun completion--try-word-completion (string table predicate point md) |
968 | (let ((comp (completion-try-completion string table predicate point md))) | |
19c04f39 SM |
969 | (if (not (consp comp)) |
970 | comp | |
32bae13c | 971 | |
3911966b SM |
972 | ;; If completion finds next char not unique, |
973 | ;; consider adding a space or a hyphen. | |
19c04f39 | 974 | (when (= (length string) (length (car comp))) |
1afbbf85 SM |
975 | ;; Mark the added char with the `completion-word' property, so it |
976 | ;; can be handled specially by completion styles such as | |
977 | ;; partial-completion. | |
978 | ;; We used to remove `partial-completion' from completion-styles | |
979 | ;; instead, but it was too blunt, leading to situations where SPC | |
980 | ;; was the only insertable char at point but minibuffer-complete-word | |
981 | ;; refused inserting it. | |
982 | (let ((exts (mapcar (lambda (str) (propertize str 'completion-try-word t)) | |
983 | '(" " "-"))) | |
19c04f39 SM |
984 | (before (substring string 0 point)) |
985 | (after (substring string point)) | |
986 | tem) | |
987 | (while (and exts (not (consp tem))) | |
3911966b | 988 | (setq tem (completion-try-completion |
19c04f39 | 989 | (concat before (pop exts) after) |
620c53a6 | 990 | table predicate (1+ point) md))) |
19c04f39 | 991 | (if (consp tem) (setq comp tem)))) |
3911966b | 992 | |
32bae13c SM |
993 | ;; Completing a single word is actually more difficult than completing |
994 | ;; as much as possible, because we first have to find the "current | |
995 | ;; position" in `completion' in order to find the end of the word | |
996 | ;; we're completing. Normally, `string' is a prefix of `completion', | |
997 | ;; which makes it trivial to find the position, but with fancier | |
998 | ;; completion (plus env-var expansion, ...) `completion' might not | |
999 | ;; look anything like `string' at all. | |
19c04f39 SM |
1000 | (let* ((comppoint (cdr comp)) |
1001 | (completion (car comp)) | |
1002 | (before (substring string 0 point)) | |
1003 | (combined (concat before "\n" completion))) | |
1004 | ;; Find in completion the longest text that was right before point. | |
1005 | (when (string-match "\\(.+\\)\n.*?\\1" combined) | |
1006 | (let* ((prefix (match-string 1 before)) | |
1007 | ;; We used non-greedy match to make `rem' as long as possible. | |
1008 | (rem (substring combined (match-end 0))) | |
1009 | ;; Find in the remainder of completion the longest text | |
1010 | ;; that was right after point. | |
1011 | (after (substring string point)) | |
1012 | (suffix (if (string-match "\\`\\(.+\\).*\n.*\\1" | |
1013 | (concat after "\n" rem)) | |
1014 | (match-string 1 after)))) | |
1015 | ;; The general idea is to try and guess what text was inserted | |
1016 | ;; at point by the completion. Problem is: if we guess wrong, | |
1017 | ;; we may end up treating as "added by completion" text that was | |
1018 | ;; actually painfully typed by the user. So if we then cut | |
1019 | ;; after the first word, we may throw away things the | |
1020 | ;; user wrote. So let's try to be as conservative as possible: | |
1021 | ;; only cut after the first word, if we're reasonably sure that | |
1022 | ;; our guess is correct. | |
1023 | ;; Note: a quick survey on emacs-devel seemed to indicate that | |
1024 | ;; nobody actually cares about the "word-at-a-time" feature of | |
1025 | ;; minibuffer-complete-word, whose real raison-d'être is that it | |
1026 | ;; tries to add "-" or " ". One more reason to only cut after | |
1027 | ;; the first word, if we're really sure we're right. | |
1028 | (when (and (or suffix (zerop (length after))) | |
1029 | (string-match (concat | |
1030 | ;; Make submatch 1 as small as possible | |
1031 | ;; to reduce the risk of cutting | |
1032 | ;; valuable text. | |
1033 | ".*" (regexp-quote prefix) "\\(.*?\\)" | |
1034 | (if suffix (regexp-quote suffix) "\\'")) | |
1035 | completion) | |
1036 | ;; The new point in `completion' should also be just | |
1037 | ;; before the suffix, otherwise something more complex | |
1038 | ;; is going on, and we're not sure where we are. | |
1039 | (eq (match-end 1) comppoint) | |
1040 | ;; (match-beginning 1)..comppoint is now the stretch | |
1041 | ;; of text in `completion' that was completed at point. | |
1042 | (string-match "\\W" completion (match-beginning 1)) | |
1043 | ;; Is there really something to cut? | |
1044 | (> comppoint (match-end 0))) | |
1045 | ;; Cut after the first word. | |
1046 | (let ((cutpos (match-end 0))) | |
1047 | (setq completion (concat (substring completion 0 cutpos) | |
1048 | (substring completion comppoint))) | |
1049 | (setq comppoint cutpos))))) | |
1050 | ||
1051 | (cons completion comppoint))))) | |
ba5ff07b SM |
1052 | |
1053 | ||
1054 | (defun minibuffer-complete-word () | |
1055 | "Complete the minibuffer contents at most a single word. | |
1056 | After one word is completed as much as possible, a space or hyphen | |
1057 | is added, provided that matches some possible completion. | |
1058 | Return nil if there is no valid completion, else t." | |
1059 | (interactive) | |
3911966b | 1060 | (case (completion--do-completion 'completion--try-word-completion) |
a38313e1 | 1061 | (#b000 nil) |
a38313e1 | 1062 | (t t))) |
ba5ff07b | 1063 | |
890429cc SM |
1064 | (defface completions-annotations '((t :inherit italic)) |
1065 | "Face to use for annotations in the *Completions* buffer.") | |
1066 | ||
8f3b8a5f | 1067 | (defcustom completions-format 'horizontal |
3a9f97fa JL |
1068 | "Define the appearance and sorting of completions. |
1069 | If the value is `vertical', display completions sorted vertically | |
1070 | in columns in the *Completions* buffer. | |
8f3b8a5f | 1071 | If the value is `horizontal', display completions sorted |
3a9f97fa | 1072 | horizontally in alphabetical order, rather than down the screen." |
8f3b8a5f | 1073 | :type '(choice (const horizontal) (const vertical)) |
3a9f97fa JL |
1074 | :group 'minibuffer |
1075 | :version "23.2") | |
1076 | ||
3911966b | 1077 | (defun completion--insert-strings (strings) |
32bae13c SM |
1078 | "Insert a list of STRINGS into the current buffer. |
1079 | Uses columns to keep the listing readable but compact. | |
1080 | It also eliminates runs of equal strings." | |
1081 | (when (consp strings) | |
1082 | (let* ((length (apply 'max | |
1083 | (mapcar (lambda (s) | |
1084 | (if (consp s) | |
e5b5b82d SM |
1085 | (+ (string-width (car s)) |
1086 | (string-width (cadr s))) | |
1087 | (string-width s))) | |
32bae13c SM |
1088 | strings))) |
1089 | (window (get-buffer-window (current-buffer) 0)) | |
1090 | (wwidth (if window (1- (window-width window)) 79)) | |
1091 | (columns (min | |
1092 | ;; At least 2 columns; at least 2 spaces between columns. | |
1093 | (max 2 (/ wwidth (+ 2 length))) | |
1094 | ;; Don't allocate more columns than we can fill. | |
1095 | ;; Windows can't show less than 3 lines anyway. | |
1096 | (max 1 (/ (length strings) 2)))) | |
1097 | (colwidth (/ wwidth columns)) | |
1098 | (column 0) | |
3a9f97fa JL |
1099 | (rows (/ (length strings) columns)) |
1100 | (row 0) | |
ae0bc9fb | 1101 | (first t) |
32bae13c SM |
1102 | (laststring nil)) |
1103 | ;; The insertion should be "sensible" no matter what choices were made | |
1104 | ;; for the parameters above. | |
1105 | (dolist (str strings) | |
f87ff539 | 1106 | (unless (equal laststring str) ; Remove (consecutive) duplicates. |
32bae13c | 1107 | (setq laststring str) |
ae0bc9fb SM |
1108 | ;; FIXME: `string-width' doesn't pay attention to |
1109 | ;; `display' properties. | |
f87ff539 SM |
1110 | (let ((length (if (consp str) |
1111 | (+ (string-width (car str)) | |
1112 | (string-width (cadr str))) | |
1113 | (string-width str)))) | |
3a9f97fa JL |
1114 | (cond |
1115 | ((eq completions-format 'vertical) | |
1116 | ;; Vertical format | |
1117 | (when (> row rows) | |
1118 | (forward-line (- -1 rows)) | |
1119 | (setq row 0 column (+ column colwidth))) | |
1120 | (when (> column 0) | |
1121 | (end-of-line) | |
1122 | (while (> (current-column) column) | |
1123 | (if (eobp) | |
1124 | (insert "\n") | |
1125 | (forward-line 1) | |
1126 | (end-of-line))) | |
1127 | (insert " \t") | |
ae0bc9fb | 1128 | (set-text-properties (1- (point)) (point) |
3a9f97fa JL |
1129 | `(display (space :align-to ,column))))) |
1130 | (t | |
1131 | ;; Horizontal format | |
ae0bc9fb | 1132 | (unless first |
3a9f97fa JL |
1133 | (if (< wwidth (+ (max colwidth length) column)) |
1134 | ;; No space for `str' at point, move to next line. | |
1135 | (progn (insert "\n") (setq column 0)) | |
1136 | (insert " \t") | |
1137 | ;; Leave the space unpropertized so that in the case we're | |
1138 | ;; already past the goal column, there is still | |
1139 | ;; a space displayed. | |
ae0bc9fb | 1140 | (set-text-properties (1- (point)) (point) |
3a9f97fa | 1141 | ;; We can't just set tab-width, because |
3e2d70fd SM |
1142 | ;; completion-setup-function will kill |
1143 | ;; all local variables :-( | |
3a9f97fa JL |
1144 | `(display (space :align-to ,column))) |
1145 | nil)))) | |
ae0bc9fb | 1146 | (setq first nil) |
f87ff539 | 1147 | (if (not (consp str)) |
e59e73d8 | 1148 | (put-text-property (point) (progn (insert str) (point)) |
f87ff539 | 1149 | 'mouse-face 'highlight) |
e59e73d8 | 1150 | (put-text-property (point) (progn (insert (car str)) (point)) |
f87ff539 | 1151 | 'mouse-face 'highlight) |
e59e73d8 | 1152 | (add-text-properties (point) (progn (insert (cadr str)) (point)) |
890429cc | 1153 | '(mouse-face nil |
e59e73d8 | 1154 | face completions-annotations))) |
3a9f97fa JL |
1155 | (cond |
1156 | ((eq completions-format 'vertical) | |
1157 | ;; Vertical format | |
1158 | (if (> column 0) | |
1159 | (forward-line) | |
1160 | (insert "\n")) | |
1161 | (setq row (1+ row))) | |
1162 | (t | |
1163 | ;; Horizontal format | |
1164 | ;; Next column to align to. | |
1165 | (setq column (+ column | |
1166 | ;; Round up to a whole number of columns. | |
1167 | (* colwidth (ceiling length colwidth)))))))))))) | |
32bae13c | 1168 | |
6138158d SM |
1169 | (defvar completion-common-substring nil) |
1170 | (make-obsolete-variable 'completion-common-substring nil "23.1") | |
32bae13c | 1171 | |
21622c6d SM |
1172 | (defvar completion-setup-hook nil |
1173 | "Normal hook run at the end of setting up a completion list buffer. | |
1174 | When this hook is run, the current buffer is the one in which the | |
1175 | command to display the completion list buffer was run. | |
1176 | The completion list buffer is available as the value of `standard-output'. | |
6138158d SM |
1177 | See also `display-completion-list'.") |
1178 | ||
1179 | (defface completions-first-difference | |
1180 | '((t (:inherit bold))) | |
1181 | "Face put on the first uncommon character in completions in *Completions* buffer." | |
1182 | :group 'completion) | |
1183 | ||
1184 | (defface completions-common-part | |
1185 | '((t (:inherit default))) | |
1186 | "Face put on the common prefix substring in completions in *Completions* buffer. | |
1187 | The idea of `completions-common-part' is that you can use it to | |
1188 | make the common parts less visible than normal, so that the rest | |
1189 | of the differing parts is, by contrast, slightly highlighted." | |
1190 | :group 'completion) | |
1191 | ||
125f7951 | 1192 | (defun completion-hilit-commonality (completions prefix-len base-size) |
6138158d | 1193 | (when completions |
125f7951 | 1194 | (let ((com-str-len (- prefix-len (or base-size 0)))) |
6138158d SM |
1195 | (nconc |
1196 | (mapcar | |
457d37ba SM |
1197 | (lambda (elem) |
1198 | (let ((str | |
1199 | ;; Don't modify the string itself, but a copy, since the | |
1200 | ;; the string may be read-only or used for other purposes. | |
1201 | ;; Furthermore, since `completions' may come from | |
1202 | ;; display-completion-list, `elem' may be a list. | |
1203 | (if (consp elem) | |
1204 | (car (setq elem (cons (copy-sequence (car elem)) | |
1205 | (cdr elem)))) | |
1206 | (setq elem (copy-sequence elem))))) | |
1bba1cfc SM |
1207 | (put-text-property 0 |
1208 | ;; If completion-boundaries returns incorrect | |
1209 | ;; values, all-completions may return strings | |
1210 | ;; that don't contain the prefix. | |
1211 | (min com-str-len (length str)) | |
457d37ba SM |
1212 | 'font-lock-face 'completions-common-part |
1213 | str) | |
1214 | (if (> (length str) com-str-len) | |
1215 | (put-text-property com-str-len (1+ com-str-len) | |
1216 | 'font-lock-face 'completions-first-difference | |
1217 | str))) | |
1218 | elem) | |
6138158d SM |
1219 | completions) |
1220 | base-size)))) | |
21622c6d | 1221 | |
7bc7f64d | 1222 | (defun display-completion-list (completions &optional common-substring) |
32bae13c SM |
1223 | "Display the list of completions, COMPLETIONS, using `standard-output'. |
1224 | Each element may be just a symbol or string | |
1225 | or may be a list of two strings to be printed as if concatenated. | |
1226 | If it is a list of two strings, the first is the actual completion | |
1227 | alternative, the second serves as annotation. | |
1228 | `standard-output' must be a buffer. | |
1229 | The actual completion alternatives, as inserted, are given `mouse-face' | |
1230 | properties of `highlight'. | |
1231 | At the end, this runs the normal hook `completion-setup-hook'. | |
1232 | It can find the completion buffer in `standard-output'. | |
7ce8dff2 | 1233 | |
72444d02 | 1234 | The obsolete optional arg COMMON-SUBSTRING, if non-nil, should be a string |
7ce8dff2 CY |
1235 | specifying a common substring for adding the faces |
1236 | `completions-first-difference' and `completions-common-part' to | |
7bc7f64d | 1237 | the completions buffer." |
6138158d SM |
1238 | (if common-substring |
1239 | (setq completions (completion-hilit-commonality | |
125f7951 SM |
1240 | completions (length common-substring) |
1241 | ;; We don't know the base-size. | |
1242 | nil))) | |
32bae13c SM |
1243 | (if (not (bufferp standard-output)) |
1244 | ;; This *never* (ever) happens, so there's no point trying to be clever. | |
1245 | (with-temp-buffer | |
1246 | (let ((standard-output (current-buffer)) | |
1247 | (completion-setup-hook nil)) | |
7bc7f64d | 1248 | (display-completion-list completions common-substring)) |
32bae13c SM |
1249 | (princ (buffer-string))) |
1250 | ||
d5e63715 SM |
1251 | (with-current-buffer standard-output |
1252 | (goto-char (point-max)) | |
1253 | (if (null completions) | |
1254 | (insert "There are no possible completions of what you have typed.") | |
1255 | (insert "Possible completions are:\n") | |
1256 | (completion--insert-strings completions)))) | |
e2947429 | 1257 | |
6138158d SM |
1258 | ;; The hilit used to be applied via completion-setup-hook, so there |
1259 | ;; may still be some code that uses completion-common-substring. | |
7ce8dff2 CY |
1260 | (with-no-warnings |
1261 | (let ((completion-common-substring common-substring)) | |
1262 | (run-hooks 'completion-setup-hook))) | |
32bae13c SM |
1263 | nil) |
1264 | ||
a2a25d24 SM |
1265 | (defvar completion-extra-properties nil |
1266 | "Property list of extra properties of the current completion job. | |
1267 | These include: | |
1268 | `:annotation-function': Function to add annotations in the completions buffer. | |
1269 | The function takes a completion and should either return nil, or a string | |
1270 | that will be displayed next to the completion. The function can access the | |
1271 | completion data via `minibuffer-completion-table' and related variables. | |
1272 | `:exit-function': Function to run after completion is performed. | |
1273 | The function takes at least 2 parameters (STRING and STATUS) where STRING | |
1274 | is the text to which the field was completed and STATUS indicates what | |
1275 | kind of operation happened: if text is now complete it's `finished', if text | |
1276 | cannot be further completed but completion is not finished, it's `sole', if | |
1277 | text is a valid completion but may be further completed, it's `exact', and | |
1278 | other STATUSes may be added in the future.") | |
1279 | ||
ab22be48 SM |
1280 | (defvar completion-annotate-function |
1281 | nil | |
1282 | ;; Note: there's a lot of scope as for when to add annotations and | |
1283 | ;; what annotations to add. E.g. completing-help.el allowed adding | |
1284 | ;; the first line of docstrings to M-x completion. But there's | |
1285 | ;; a tension, since such annotations, while useful at times, can | |
1286 | ;; actually drown the useful information. | |
1287 | ;; So completion-annotate-function should be used parsimoniously, or | |
1288 | ;; else only used upon a user's request (e.g. we could add a command | |
1289 | ;; to completion-list-mode to add annotations to the current | |
1290 | ;; completions). | |
1291 | "Function to add annotations in the *Completions* buffer. | |
1292 | The function takes a completion and should either return nil, or a string that | |
1293 | will be displayed next to the completion. The function can access the | |
1294 | completion table and predicates via `minibuffer-completion-table' and related | |
1295 | variables.") | |
a2a25d24 SM |
1296 | (make-obsolete-variable 'completion-annotate-function |
1297 | 'completion-extra-properties "24.1") | |
1298 | ||
1299 | (defun completion--done (string &optional finished message) | |
1300 | (let* ((exit-fun (plist-get completion-extra-properties :exit-function)) | |
1301 | (pre-msg (and exit-fun (current-message)))) | |
1302 | (assert (memq finished '(exact sole finished unknown))) | |
1303 | ;; FIXME: exit-fun should receive `finished' as a parameter. | |
1304 | (when exit-fun | |
1305 | (when (eq finished 'unknown) | |
1306 | (setq finished | |
1307 | (if (eq (try-completion string | |
1308 | minibuffer-completion-table | |
1309 | minibuffer-completion-predicate) | |
1310 | t) | |
1311 | 'finished 'exact))) | |
1312 | (funcall exit-fun string finished)) | |
1313 | (when (and message | |
1314 | ;; Don't output any message if the exit-fun already did so. | |
1315 | (equal pre-msg (and exit-fun (current-message)))) | |
1316 | (completion--message message)))) | |
ab22be48 | 1317 | |
32bae13c SM |
1318 | (defun minibuffer-completion-help () |
1319 | "Display a list of possible completions of the current minibuffer contents." | |
1320 | (interactive) | |
1321 | (message "Making completion list...") | |
a647cb26 SM |
1322 | (let* ((start (field-beginning)) |
1323 | (end (field-end)) | |
1324 | (string (field-string)) | |
30a23501 | 1325 | (md (completion--field-metadata start)) |
a647cb26 SM |
1326 | (completions (completion-all-completions |
1327 | string | |
1328 | minibuffer-completion-table | |
1329 | minibuffer-completion-predicate | |
620c53a6 | 1330 | (- (point) (field-beginning)) |
30a23501 | 1331 | md))) |
32bae13c | 1332 | (message nil) |
a2a25d24 SM |
1333 | (if (or (null completions) |
1334 | (and (not (consp (cdr completions))) | |
1335 | (equal (car completions) string))) | |
1336 | (progn | |
1337 | ;; If there are no completions, or if the current input is already | |
1338 | ;; the sole completion, then hide (previous&stale) completions. | |
1339 | (minibuffer-hide-completions) | |
1340 | (ding) | |
1341 | (minibuffer-message | |
1342 | (if completions "Sole completion" "No completions"))) | |
1343 | ||
1344 | (let* ((last (last completions)) | |
1345 | (base-size (cdr last)) | |
1346 | (prefix (unless (zerop base-size) (substring string 0 base-size))) | |
30a23501 SM |
1347 | (all-md (completion--metadata (buffer-substring-no-properties |
1348 | start (point)) | |
1349 | base-size md | |
1350 | minibuffer-completion-table | |
1351 | minibuffer-completion-predicate)) | |
620c53a6 SM |
1352 | (afun (or (completion-metadata-get all-md 'annotation-function) |
1353 | (plist-get completion-extra-properties | |
1354 | :annotation-function) | |
1355 | completion-annotate-function)) | |
a2a25d24 SM |
1356 | ;; If the *Completions* buffer is shown in a new |
1357 | ;; window, mark it as softly-dedicated, so bury-buffer in | |
1358 | ;; minibuffer-hide-completions will know whether to | |
1359 | ;; delete the window or not. | |
1360 | (display-buffer-mark-dedicated 'soft)) | |
1361 | (with-output-to-temp-buffer "*Completions*" | |
1362 | ;; Remove the base-size tail because `sort' requires a properly | |
1363 | ;; nil-terminated list. | |
1364 | (when last (setcdr last nil)) | |
a2a25d24 | 1365 | (setq completions |
620c53a6 SM |
1366 | ;; FIXME: This function is for the output of all-completions, |
1367 | ;; not completion-all-completions. Often it's the same, but | |
1368 | ;; not always. | |
1369 | (let ((sort-fun (completion-metadata-get | |
1370 | all-md 'display-sort-function))) | |
1371 | (if sort-fun | |
1372 | (funcall sort-fun completions) | |
1373 | (sort completions 'string-lessp)))) | |
1374 | (when afun | |
1375 | (setq completions | |
a2a25d24 | 1376 | (mapcar (lambda (s) |
620c53a6 | 1377 | (let ((ann (funcall afun s))) |
a2a25d24 | 1378 | (if ann (list s ann) s))) |
620c53a6 | 1379 | completions))) |
a2a25d24 SM |
1380 | |
1381 | (with-current-buffer standard-output | |
1382 | (set (make-local-variable 'completion-base-position) | |
1383 | (list (+ start base-size) | |
1384 | ;; FIXME: We should pay attention to completion | |
1385 | ;; boundaries here, but currently | |
1386 | ;; completion-all-completions does not give us the | |
1387 | ;; necessary information. | |
1388 | end)) | |
1389 | (set (make-local-variable 'completion-list-insert-choice-function) | |
1390 | (let ((ctable minibuffer-completion-table) | |
1391 | (cpred minibuffer-completion-predicate) | |
1392 | (cprops completion-extra-properties)) | |
1393 | (lambda (start end choice) | |
620c53a6 SM |
1394 | (unless (or (zerop (length prefix)) |
1395 | (equal prefix | |
1396 | (buffer-substring-no-properties | |
1397 | (max (point-min) | |
1398 | (- start (length prefix))) | |
1399 | start))) | |
a2a25d24 SM |
1400 | (message "*Completions* out of date")) |
1401 | ;; FIXME: Use `md' to do quoting&terminator here. | |
1402 | (completion--replace start end choice) | |
1403 | (let* ((minibuffer-completion-table ctable) | |
1404 | (minibuffer-completion-predicate cpred) | |
1405 | (completion-extra-properties cprops) | |
1406 | (result (concat prefix choice)) | |
1407 | (bounds (completion-boundaries | |
1408 | result ctable cpred ""))) | |
1409 | ;; If the completion introduces a new field, then | |
1410 | ;; completion is not finished. | |
1411 | (completion--done result | |
1412 | (if (eq (car bounds) (length result)) | |
1413 | 'exact 'finished))))))) | |
1414 | ||
1415 | (display-completion-list completions)))) | |
32bae13c SM |
1416 | nil)) |
1417 | ||
890429cc SM |
1418 | (defun minibuffer-hide-completions () |
1419 | "Get rid of an out-of-date *Completions* buffer." | |
1420 | ;; FIXME: We could/should use minibuffer-scroll-window here, but it | |
1421 | ;; can also point to the minibuffer-parent-window, so it's a bit tricky. | |
1422 | (let ((win (get-buffer-window "*Completions*" 0))) | |
1423 | (if win (with-selected-window win (bury-buffer))))) | |
1424 | ||
32bae13c SM |
1425 | (defun exit-minibuffer () |
1426 | "Terminate this minibuffer argument." | |
1427 | (interactive) | |
1428 | ;; If the command that uses this has made modifications in the minibuffer, | |
1429 | ;; we don't want them to cause deactivation of the mark in the original | |
1430 | ;; buffer. | |
1431 | ;; A better solution would be to make deactivate-mark buffer-local | |
1432 | ;; (or to turn it into a list of buffers, ...), but in the mean time, | |
1433 | ;; this should do the trick in most cases. | |
ba5ff07b | 1434 | (setq deactivate-mark nil) |
32bae13c SM |
1435 | (throw 'exit nil)) |
1436 | ||
1437 | (defun self-insert-and-exit () | |
1438 | "Terminate minibuffer input." | |
1439 | (interactive) | |
8989a920 | 1440 | (if (characterp last-command-event) |
32bae13c SM |
1441 | (call-interactively 'self-insert-command) |
1442 | (ding)) | |
1443 | (exit-minibuffer)) | |
1444 | ||
a185548b | 1445 | (defvar completion-in-region-functions nil |
d1200087 | 1446 | "Wrapper hook around `completion-in-region'. |
a185548b SM |
1447 | The functions on this special hook are called with 5 arguments: |
1448 | NEXT-FUN START END COLLECTION PREDICATE. | |
1449 | NEXT-FUN is a function of four arguments (START END COLLECTION PREDICATE) | |
c8de140b | 1450 | that performs the default operation. The other four arguments are like |
d1200087 | 1451 | the ones passed to `completion-in-region'. The functions on this hook |
a185548b SM |
1452 | are expected to perform completion on START..END using COLLECTION |
1453 | and PREDICATE, either by calling NEXT-FUN or by doing it themselves.") | |
1454 | ||
3e2d70fd SM |
1455 | (defvar completion-in-region--data nil) |
1456 | ||
e240cc21 SM |
1457 | (defvar completion-in-region-mode-predicate nil |
1458 | "Predicate to tell `completion-in-region-mode' when to exit. | |
1459 | It is called with no argument and should return nil when | |
1460 | `completion-in-region-mode' should exit (and hence pop down | |
1461 | the *Completions* buffer).") | |
1462 | ||
1463 | (defvar completion-in-region-mode--predicate nil | |
1464 | "Copy of the value of `completion-in-region-mode-predicate'. | |
1465 | This holds the value `completion-in-region-mode-predicate' had when | |
1466 | we entered `completion-in-region-mode'.") | |
1467 | ||
a185548b SM |
1468 | (defun completion-in-region (start end collection &optional predicate) |
1469 | "Complete the text between START and END using COLLECTION. | |
3e38b2bd | 1470 | Return nil if there is no valid completion, else t. |
08549772 LMI |
1471 | Point needs to be somewhere between START and END. |
1472 | PREDICATE (a function called with no arguments) says when to | |
1473 | exit." | |
a185548b | 1474 | (assert (<= start (point)) (<= (point) end)) |
a185548b | 1475 | (with-wrapper-hook |
d86d2721 SM |
1476 | ;; FIXME: Maybe we should use this hook to provide a "display |
1477 | ;; completions" operation as well. | |
a185548b SM |
1478 | completion-in-region-functions (start end collection predicate) |
1479 | (let ((minibuffer-completion-table collection) | |
1480 | (minibuffer-completion-predicate predicate) | |
1481 | (ol (make-overlay start end nil nil t))) | |
1482 | (overlay-put ol 'field 'completion) | |
e240cc21 SM |
1483 | (when completion-in-region-mode-predicate |
1484 | (completion-in-region-mode 1) | |
1485 | (setq completion-in-region--data | |
1486 | (list (current-buffer) start end collection))) | |
a185548b SM |
1487 | (unwind-protect |
1488 | (call-interactively 'minibuffer-complete) | |
1489 | (delete-overlay ol))))) | |
8ba31f36 | 1490 | |
3e2d70fd SM |
1491 | (defvar completion-in-region-mode-map |
1492 | (let ((map (make-sparse-keymap))) | |
c0a193ea SM |
1493 | ;; FIXME: Only works if completion-in-region-mode was activated via |
1494 | ;; completion-at-point called directly. | |
3e2d70fd SM |
1495 | (define-key map "?" 'completion-help-at-point) |
1496 | (define-key map "\t" 'completion-at-point) | |
1497 | map) | |
1498 | "Keymap activated during `completion-in-region'.") | |
1499 | ||
1500 | ;; It is difficult to know when to exit completion-in-region-mode (i.e. hide | |
1501 | ;; the *Completions*). | |
1502 | ;; - lisp-mode: never. | |
1503 | ;; - comint: only do it if you hit SPC at the right time. | |
1504 | ;; - pcomplete: pop it down on SPC or after some time-delay. | |
1505 | ;; - semantic: use a post-command-hook check similar to this one. | |
1506 | (defun completion-in-region--postch () | |
3e2d70fd SM |
1507 | (or unread-command-events ;Don't pop down the completions in the middle of |
1508 | ;mouse-drag-region/mouse-set-point. | |
1509 | (and completion-in-region--data | |
1510 | (and (eq (car completion-in-region--data) | |
1511 | (current-buffer)) | |
1512 | (>= (point) (nth 1 completion-in-region--data)) | |
1513 | (<= (point) | |
1514 | (save-excursion | |
1515 | (goto-char (nth 2 completion-in-region--data)) | |
1516 | (line-end-position))) | |
2dbaa080 | 1517 | (funcall completion-in-region-mode--predicate))) |
3e2d70fd SM |
1518 | (completion-in-region-mode -1))) |
1519 | ||
1520 | ;; (defalias 'completion-in-region--prech 'completion-in-region--postch) | |
1521 | ||
1522 | (define-minor-mode completion-in-region-mode | |
e1ac4066 GM |
1523 | "Transient minor mode used during `completion-in-region'. |
1524 | With a prefix argument ARG, enable the modemode if ARG is | |
1525 | positive, and disable it otherwise. If called from Lisp, enable | |
1526 | the mode if ARG is omitted or nil." | |
3e2d70fd SM |
1527 | :global t |
1528 | (setq completion-in-region--data nil) | |
1529 | ;; (remove-hook 'pre-command-hook #'completion-in-region--prech) | |
1530 | (remove-hook 'post-command-hook #'completion-in-region--postch) | |
1531 | (setq minor-mode-overriding-map-alist | |
1532 | (delq (assq 'completion-in-region-mode minor-mode-overriding-map-alist) | |
1533 | minor-mode-overriding-map-alist)) | |
1534 | (if (null completion-in-region-mode) | |
2dbaa080 | 1535 | (unless (equal "*Completions*" (buffer-name (window-buffer))) |
41ea9e48 | 1536 | (minibuffer-hide-completions)) |
3e2d70fd | 1537 | ;; (add-hook 'pre-command-hook #'completion-in-region--prech) |
2dbaa080 SM |
1538 | (assert completion-in-region-mode-predicate) |
1539 | (setq completion-in-region-mode--predicate | |
1540 | completion-in-region-mode-predicate) | |
3e2d70fd SM |
1541 | (add-hook 'post-command-hook #'completion-in-region--postch) |
1542 | (push `(completion-in-region-mode . ,completion-in-region-mode-map) | |
1543 | minor-mode-overriding-map-alist))) | |
1544 | ||
1545 | ;; Define-minor-mode added our keymap to minor-mode-map-alist, but we want it | |
1546 | ;; on minor-mode-overriding-map-alist instead. | |
1547 | (setq minor-mode-map-alist | |
1548 | (delq (assq 'completion-in-region-mode minor-mode-map-alist) | |
1549 | minor-mode-map-alist)) | |
1550 | ||
3a07ffce | 1551 | (defvar completion-at-point-functions '(tags-completion-at-point-function) |
51ef56c4 | 1552 | "Special hook to find the completion table for the thing at point. |
d86d2721 SM |
1553 | Each function on this hook is called in turns without any argument and should |
1554 | return either nil to mean that it is not applicable at point, | |
51ef56c4 | 1555 | or a function of no argument to perform completion (discouraged), |
60236b0d | 1556 | or a list of the form (START END COLLECTION . PROPS) where |
51ef56c4 SM |
1557 | START and END delimit the entity to complete and should include point, |
1558 | COLLECTION is the completion table to use to complete it, and | |
1559 | PROPS is a property list for additional information. | |
a2a25d24 SM |
1560 | Currently supported properties are all the properties that can appear in |
1561 | `completion-extra-properties' plus: | |
0ff8e1ba | 1562 | `:predicate' a predicate that completion candidates need to satisfy. |
60236b0d CY |
1563 | `:exclusive' If `no', means that if the completion table fails to |
1564 | match the text at point, then instead of reporting a completion | |
1565 | failure, the completion should try the next completion function.") | |
51ef56c4 | 1566 | |
3e2d70fd | 1567 | (defvar completion--capf-misbehave-funs nil |
0ff8e1ba SM |
1568 | "List of functions found on `completion-at-point-functions' that misbehave. |
1569 | These are functions that neither return completion data nor a completion | |
1570 | function but instead perform completion right away.") | |
3e2d70fd | 1571 | (defvar completion--capf-safe-funs nil |
0ff8e1ba SM |
1572 | "List of well-behaved functions found on `completion-at-point-functions'. |
1573 | These are functions which return proper completion data rather than | |
1574 | a completion function or god knows what else.") | |
3e2d70fd SM |
1575 | |
1576 | (defun completion--capf-wrapper (fun which) | |
d1bb6623 SM |
1577 | ;; FIXME: The safe/misbehave handling assumes that a given function will |
1578 | ;; always return the same kind of data, but this breaks down with functions | |
1579 | ;; like comint-completion-at-point or mh-letter-completion-at-point, which | |
1580 | ;; could be sometimes safe and sometimes misbehaving (and sometimes neither). | |
3e2d70fd SM |
1581 | (if (case which |
1582 | (all t) | |
1583 | (safe (member fun completion--capf-safe-funs)) | |
1584 | (optimist (not (member fun completion--capf-misbehave-funs)))) | |
1585 | (let ((res (funcall fun))) | |
1586 | (cond | |
0ff8e1ba | 1587 | ((and (consp res) (not (functionp res))) |
3e2d70fd | 1588 | (unless (member fun completion--capf-safe-funs) |
0ff8e1ba SM |
1589 | (push fun completion--capf-safe-funs)) |
1590 | (and (eq 'no (plist-get (nthcdr 3 res) :exclusive)) | |
1591 | ;; FIXME: Here we'd need to decide whether there are | |
1592 | ;; valid completions against the current text. But this depends | |
1593 | ;; on the actual completion UI (e.g. with the default completion | |
1594 | ;; it depends on completion-style) ;-( | |
1595 | ;; We approximate this result by checking whether prefix | |
1596 | ;; completion might work, which means that non-prefix completion | |
1597 | ;; will not work (or not right) for completion functions that | |
1598 | ;; are non-exclusive. | |
1599 | (null (try-completion (buffer-substring-no-properties | |
1600 | (car res) (point)) | |
1601 | (nth 2 res) | |
1602 | (plist-get (nthcdr 3 res) :predicate))) | |
1603 | (setq res nil))) | |
3e2d70fd SM |
1604 | ((not (or (listp res) (functionp res))) |
1605 | (unless (member fun completion--capf-misbehave-funs) | |
1606 | (message | |
1607 | "Completion function %S uses a deprecated calling convention" fun) | |
1608 | (push fun completion--capf-misbehave-funs)))) | |
e240cc21 | 1609 | (if res (cons fun res))))) |
3e2d70fd | 1610 | |
67027b49 | 1611 | (defun completion-at-point () |
48111a85 | 1612 | "Perform completion on the text around point. |
67027b49 SM |
1613 | The completion method is determined by `completion-at-point-functions'." |
1614 | (interactive) | |
3e2d70fd SM |
1615 | (let ((res (run-hook-wrapped 'completion-at-point-functions |
1616 | #'completion--capf-wrapper 'all))) | |
e240cc21 SM |
1617 | (pcase res |
1618 | (`(,_ . ,(and (pred functionp) f)) (funcall f)) | |
1619 | (`(,hookfun . (,start ,end ,collection . ,plist)) | |
a2a25d24 | 1620 | (let* ((completion-extra-properties plist) |
e240cc21 SM |
1621 | (completion-in-region-mode-predicate |
1622 | (lambda () | |
1623 | ;; We're still in the same completion field. | |
d1bb6623 | 1624 | (eq (car-safe (funcall hookfun)) start)))) |
e240cc21 | 1625 | (completion-in-region start end collection |
d86d2721 | 1626 | (plist-get plist :predicate)))) |
e240cc21 SM |
1627 | ;; Maybe completion already happened and the function returned t. |
1628 | (_ (cdr res))))) | |
51ef56c4 | 1629 | |
3e2d70fd SM |
1630 | (defun completion-help-at-point () |
1631 | "Display the completions on the text around point. | |
1632 | The completion method is determined by `completion-at-point-functions'." | |
1633 | (interactive) | |
1634 | (let ((res (run-hook-wrapped 'completion-at-point-functions | |
1635 | ;; Ignore misbehaving functions. | |
1636 | #'completion--capf-wrapper 'optimist))) | |
e240cc21 SM |
1637 | (pcase res |
1638 | (`(,_ . ,(and (pred functionp) f)) | |
1639 | (message "Don't know how to show completions for %S" f)) | |
1640 | (`(,hookfun . (,start ,end ,collection . ,plist)) | |
1641 | (let* ((minibuffer-completion-table collection) | |
3e2d70fd | 1642 | (minibuffer-completion-predicate (plist-get plist :predicate)) |
a2a25d24 | 1643 | (completion-extra-properties plist) |
e240cc21 SM |
1644 | (completion-in-region-mode-predicate |
1645 | (lambda () | |
1646 | ;; We're still in the same completion field. | |
d1bb6623 | 1647 | (eq (car-safe (funcall hookfun)) start))) |
e240cc21 | 1648 | (ol (make-overlay start end nil nil t))) |
3e2d70fd SM |
1649 | ;; FIXME: We should somehow (ab)use completion-in-region-function or |
1650 | ;; introduce a corresponding hook (plus another for word-completion, | |
1651 | ;; and another for force-completion, maybe?). | |
1652 | (overlay-put ol 'field 'completion) | |
e240cc21 SM |
1653 | (completion-in-region-mode 1) |
1654 | (setq completion-in-region--data | |
1655 | (list (current-buffer) start end collection)) | |
3e2d70fd SM |
1656 | (unwind-protect |
1657 | (call-interactively 'minibuffer-completion-help) | |
1658 | (delete-overlay ol)))) | |
e240cc21 | 1659 | (`(,hookfun . ,_) |
3e2d70fd SM |
1660 | ;; The hook function already performed completion :-( |
1661 | ;; Not much we can do at this point. | |
e240cc21 | 1662 | (message "%s already performed completion!" hookfun) |
3e2d70fd | 1663 | nil) |
e240cc21 | 1664 | (_ (message "Nothing to complete at point"))))) |
3e2d70fd | 1665 | |
1d4adede SM |
1666 | ;;; Key bindings. |
1667 | ||
a38313e1 SM |
1668 | (let ((map minibuffer-local-map)) |
1669 | (define-key map "\C-g" 'abort-recursive-edit) | |
1670 | (define-key map "\r" 'exit-minibuffer) | |
1671 | (define-key map "\n" 'exit-minibuffer)) | |
1672 | ||
3349e122 SM |
1673 | (defvar minibuffer-local-completion-map |
1674 | (let ((map (make-sparse-keymap))) | |
1675 | (set-keymap-parent map minibuffer-local-map) | |
1676 | (define-key map "\t" 'minibuffer-complete) | |
1677 | ;; M-TAB is already abused for many other purposes, so we should find | |
1678 | ;; another binding for it. | |
1679 | ;; (define-key map "\e\t" 'minibuffer-force-complete) | |
1680 | (define-key map " " 'minibuffer-complete-word) | |
1681 | (define-key map "?" 'minibuffer-completion-help) | |
1682 | map) | |
1683 | "Local keymap for minibuffer input with completion.") | |
1684 | ||
1685 | (defvar minibuffer-local-must-match-map | |
1686 | (let ((map (make-sparse-keymap))) | |
1687 | (set-keymap-parent map minibuffer-local-completion-map) | |
1688 | (define-key map "\r" 'minibuffer-complete-and-exit) | |
1689 | (define-key map "\n" 'minibuffer-complete-and-exit) | |
1690 | map) | |
1691 | "Local keymap for minibuffer input with completion, for exact match.") | |
a38313e1 | 1692 | |
3349e122 SM |
1693 | (defvar minibuffer-local-filename-completion-map |
1694 | (let ((map (make-sparse-keymap))) | |
1695 | (define-key map " " nil) | |
1696 | map) | |
1697 | "Local keymap for minibuffer input with completion for filenames. | |
1698 | Gets combined either with `minibuffer-local-completion-map' or | |
1699 | with `minibuffer-local-must-match-map'.") | |
a38313e1 | 1700 | |
3349e122 SM |
1701 | (defvar minibuffer-local-filename-must-match-map (make-sparse-keymap)) |
1702 | (make-obsolete-variable 'minibuffer-local-filename-must-match-map nil "24.1") | |
1703 | (define-obsolete-variable-alias 'minibuffer-local-must-match-filename-map | |
1704 | 'minibuffer-local-filename-must-match-map "23.1") | |
a38313e1 SM |
1705 | |
1706 | (let ((map minibuffer-local-ns-map)) | |
1707 | (define-key map " " 'exit-minibuffer) | |
1708 | (define-key map "\t" 'exit-minibuffer) | |
1709 | (define-key map "?" 'self-insert-and-exit)) | |
1710 | ||
fd6fa53f SM |
1711 | (defvar minibuffer-inactive-mode-map |
1712 | (let ((map (make-keymap))) | |
1713 | (suppress-keymap map) | |
1714 | (define-key map "e" 'find-file-other-frame) | |
1715 | (define-key map "f" 'find-file-other-frame) | |
1716 | (define-key map "b" 'switch-to-buffer-other-frame) | |
1717 | (define-key map "i" 'info) | |
1718 | (define-key map "m" 'mail) | |
1719 | (define-key map "n" 'make-frame) | |
1720 | (define-key map [mouse-1] (lambda () (interactive) | |
1721 | (with-current-buffer "*Messages*" | |
1722 | (goto-char (point-max)) | |
1723 | (display-buffer (current-buffer))))) | |
1724 | ;; So the global down-mouse-1 binding doesn't clutter the execution of the | |
1725 | ;; above mouse-1 binding. | |
1726 | (define-key map [down-mouse-1] #'ignore) | |
1727 | map) | |
1728 | "Keymap for use in the minibuffer when it is not active. | |
1729 | The non-mouse bindings in this keymap can only be used in minibuffer-only | |
1730 | frames, since the minibuffer can normally not be selected when it is | |
1731 | not active.") | |
1732 | ||
1733 | (define-derived-mode minibuffer-inactive-mode nil "InactiveMinibuffer" | |
1734 | :abbrev-table nil ;abbrev.el is not loaded yet during dump. | |
1735 | ;; Note: this major mode is called from minibuf.c. | |
1736 | "Major mode to use in the minibuffer when it is not active. | |
1737 | This is only used when the minibuffer area has no active minibuffer.") | |
1738 | ||
a38313e1 SM |
1739 | ;;; Completion tables. |
1740 | ||
34b67b0f SM |
1741 | (defun minibuffer--double-dollars (str) |
1742 | (replace-regexp-in-string "\\$" "$$" str)) | |
1743 | ||
21622c6d SM |
1744 | (defun completion--make-envvar-table () |
1745 | (mapcar (lambda (enventry) | |
9f3618b5 | 1746 | (substring enventry 0 (string-match-p "=" enventry))) |
21622c6d SM |
1747 | process-environment)) |
1748 | ||
a38313e1 SM |
1749 | (defconst completion--embedded-envvar-re |
1750 | (concat "\\(?:^\\|[^$]\\(?:\\$\\$\\)*\\)" | |
1751 | "$\\([[:alnum:]_]*\\|{\\([^}]*\\)\\)\\'")) | |
1752 | ||
d032d5e7 | 1753 | (defun completion--embedded-envvar-table (string _pred action) |
c6432f1e SM |
1754 | "Completion table for envvars embedded in a string. |
1755 | The envvar syntax (and escaping) rules followed by this table are the | |
1756 | same as `substitute-in-file-name'." | |
1757 | ;; We ignore `pred', because the predicates passed to us via | |
1758 | ;; read-file-name-internal are not 100% correct and fail here: | |
1759 | ;; e.g. we get predicates like file-directory-p there, whereas the filename | |
1760 | ;; completed needs to be passed through substitute-in-file-name before it | |
1761 | ;; can be passed to file-directory-p. | |
528c56e2 SM |
1762 | (when (string-match completion--embedded-envvar-re string) |
1763 | (let* ((beg (or (match-beginning 2) (match-beginning 1))) | |
1764 | (table (completion--make-envvar-table)) | |
1765 | (prefix (substring string 0 beg))) | |
c6432f1e SM |
1766 | (cond |
1767 | ((eq action 'lambda) | |
1768 | ;; This table is expected to be used in conjunction with some | |
1769 | ;; other table that provides the "main" completion. Let the | |
1770 | ;; other table handle the test-completion case. | |
1771 | nil) | |
30a23501 SM |
1772 | ((or (eq (car-safe action) 'boundaries) (eq action 'metadata)) |
1773 | ;; Only return boundaries/metadata if there's something to complete, | |
03408648 SM |
1774 | ;; since otherwise when we're used in |
1775 | ;; completion-table-in-turn, we could return boundaries and | |
1776 | ;; let some subsequent table return a list of completions. | |
1777 | ;; FIXME: Maybe it should rather be fixed in | |
1778 | ;; completion-table-in-turn instead, but it's difficult to | |
1779 | ;; do it efficiently there. | |
c6432f1e | 1780 | (when (try-completion (substring string beg) table nil) |
03408648 SM |
1781 | ;; Compute the boundaries of the subfield to which this |
1782 | ;; completion applies. | |
30a23501 SM |
1783 | (if (eq action 'metadata) |
1784 | '(metadata (category . environment-variable)) | |
1785 | (let ((suffix (cdr action))) | |
1786 | (list* 'boundaries | |
1787 | (or (match-beginning 2) (match-beginning 1)) | |
1788 | (when (string-match "[^[:alnum:]_]" suffix) | |
1789 | (match-beginning 0))))))) | |
c6432f1e | 1790 | (t |
a38313e1 SM |
1791 | (if (eq (aref string (1- beg)) ?{) |
1792 | (setq table (apply-partially 'completion-table-with-terminator | |
1793 | "}" table))) | |
ab22be48 SM |
1794 | ;; Even if file-name completion is case-insensitive, we want |
1795 | ;; envvar completion to be case-sensitive. | |
1796 | (let ((completion-ignore-case nil)) | |
1797 | (completion-table-with-context | |
c6432f1e | 1798 | prefix table (substring string beg) nil action))))))) |
017c22fe | 1799 | |
528c56e2 SM |
1800 | (defun completion-file-name-table (string pred action) |
1801 | "Completion table for file names." | |
af7b6078 SM |
1802 | (condition-case nil |
1803 | (cond | |
1804 | ((eq action 'metadata) '(metadata (category . file))) | |
1805 | ((eq (car-safe action) 'boundaries) | |
1806 | (let ((start (length (file-name-directory string))) | |
1807 | (end (string-match-p "/" (cdr action)))) | |
1808 | (list* 'boundaries | |
1809 | ;; if `string' is "C:" in w32, (file-name-directory string) | |
1810 | ;; returns "C:/", so `start' is 3 rather than 2. | |
1811 | ;; Not quite sure what is The Right Fix, but clipping it | |
1812 | ;; back to 2 will work for this particular case. We'll | |
1813 | ;; see if we can come up with a better fix when we bump | |
1814 | ;; into more such problematic cases. | |
1815 | (min start (length string)) end))) | |
528c56e2 | 1816 | |
af7b6078 SM |
1817 | ((eq action 'lambda) |
1818 | (if (zerop (length string)) | |
1819 | nil ;Not sure why it's here, but it probably doesn't harm. | |
1820 | (funcall (or pred 'file-exists-p) string))) | |
017c22fe | 1821 | |
af7b6078 SM |
1822 | (t |
1823 | (let* ((name (file-name-nondirectory string)) | |
1824 | (specdir (file-name-directory string)) | |
1825 | (realdir (or specdir default-directory))) | |
1826 | ||
1827 | (cond | |
1828 | ((null action) | |
1829 | (let ((comp (file-name-completion name realdir pred))) | |
1830 | (if (stringp comp) | |
1831 | (concat specdir comp) | |
1832 | comp))) | |
1833 | ||
1834 | ((eq action t) | |
1835 | (let ((all (file-name-all-completions name realdir))) | |
1836 | ||
1837 | ;; Check the predicate, if necessary. | |
1838 | (unless (memq pred '(nil file-exists-p)) | |
1839 | (let ((comp ()) | |
1840 | (pred | |
1841 | (if (eq pred 'file-directory-p) | |
1842 | ;; Brute-force speed up for directory checking: | |
1843 | ;; Discard strings which don't end in a slash. | |
1844 | (lambda (s) | |
1845 | (let ((len (length s))) | |
1846 | (and (> len 0) (eq (aref s (1- len)) ?/)))) | |
1847 | ;; Must do it the hard (and slow) way. | |
1848 | pred))) | |
1849 | (let ((default-directory (expand-file-name realdir))) | |
1850 | (dolist (tem all) | |
1851 | (if (funcall pred tem) (push tem comp)))) | |
1852 | (setq all (nreverse comp)))) | |
1853 | ||
1854 | all)))))) | |
1855 | (file-error nil))) ;PCM often calls with invalid directories. | |
528c56e2 SM |
1856 | |
1857 | (defvar read-file-name-predicate nil | |
1858 | "Current predicate used by `read-file-name-internal'.") | |
1859 | (make-obsolete-variable 'read-file-name-predicate | |
1860 | "use the regular PRED argument" "23.2") | |
1861 | ||
1862 | (defun completion--file-name-table (string pred action) | |
1863 | "Internal subroutine for `read-file-name'. Do not call this. | |
1864 | This is a completion table for file names, like `completion-file-name-table' | |
1865 | except that it passes the file name through `substitute-in-file-name'." | |
1866 | (cond | |
1867 | ((eq (car-safe action) 'boundaries) | |
1868 | ;; For the boundaries, we can't really delegate to | |
5feec8ca SM |
1869 | ;; substitute-in-file-name+completion-file-name-table and then fix |
1870 | ;; them up (as we do for the other actions), because it would | |
1871 | ;; require us to track the relationship between `str' and | |
528c56e2 | 1872 | ;; `string', which is difficult. And in any case, if |
5feec8ca SM |
1873 | ;; substitute-in-file-name turns "fo-$TO-ba" into "fo-o/b-ba", |
1874 | ;; there's no way for us to return proper boundaries info, because | |
1875 | ;; the boundary is not (yet) in `string'. | |
1876 | ;; | |
1877 | ;; FIXME: Actually there is a way to return correct boundaries | |
1878 | ;; info, at the condition of modifying the all-completions | |
1879 | ;; return accordingly. But for now, let's not bother. | |
1880 | (completion-file-name-table string pred action)) | |
34b67b0f | 1881 | |
5feec8ca | 1882 | (t |
528c56e2 SM |
1883 | (let* ((default-directory |
1884 | (if (stringp pred) | |
1885 | ;; It used to be that `pred' was abused to pass `dir' | |
1886 | ;; as an argument. | |
1887 | (prog1 (file-name-as-directory (expand-file-name pred)) | |
1888 | (setq pred nil)) | |
1889 | default-directory)) | |
1890 | (str (condition-case nil | |
1891 | (substitute-in-file-name string) | |
1892 | (error string))) | |
1893 | (comp (completion-file-name-table | |
48111a85 CY |
1894 | str |
1895 | (with-no-warnings (or pred read-file-name-predicate)) | |
1896 | action))) | |
528c56e2 SM |
1897 | |
1898 | (cond | |
1899 | ((stringp comp) | |
1900 | ;; Requote the $s before returning the completion. | |
1901 | (minibuffer--double-dollars comp)) | |
1902 | ((and (null action) comp | |
1903 | ;; Requote the $s before checking for changes. | |
1904 | (setq str (minibuffer--double-dollars str)) | |
1905 | (not (string-equal string str))) | |
1906 | ;; If there's no real completion, but substitute-in-file-name | |
1907 | ;; changed the string, then return the new string. | |
1908 | str) | |
1909 | (t comp)))))) | |
34b67b0f | 1910 | |
21622c6d | 1911 | (defalias 'read-file-name-internal |
017c22fe | 1912 | (completion-table-in-turn 'completion--embedded-envvar-table |
88893215 | 1913 | 'completion--file-name-table) |
21622c6d | 1914 | "Internal subroutine for `read-file-name'. Do not call this.") |
34b67b0f | 1915 | |
b16ac1ec LL |
1916 | (defvar read-file-name-function 'read-file-name-default |
1917 | "The function called by `read-file-name' to do its work. | |
1918 | It should accept the same arguments as `read-file-name'.") | |
dbd50d4b | 1919 | |
dbd50d4b | 1920 | (defcustom read-file-name-completion-ignore-case |
9f6336e8 | 1921 | (if (memq system-type '(ms-dos windows-nt darwin cygwin)) |
dbd50d4b SM |
1922 | t nil) |
1923 | "Non-nil means when reading a file name completion ignores case." | |
1924 | :group 'minibuffer | |
1925 | :type 'boolean | |
1926 | :version "22.1") | |
1927 | ||
1928 | (defcustom insert-default-directory t | |
1929 | "Non-nil means when reading a filename start with default dir in minibuffer. | |
1930 | ||
1931 | When the initial minibuffer contents show a name of a file or a directory, | |
1932 | typing RETURN without editing the initial contents is equivalent to typing | |
1933 | the default file name. | |
1934 | ||
1935 | If this variable is non-nil, the minibuffer contents are always | |
1936 | initially non-empty, and typing RETURN without editing will fetch the | |
1937 | default name, if one is provided. Note however that this default name | |
1938 | is not necessarily the same as initial contents inserted in the minibuffer, | |
1939 | if the initial contents is just the default directory. | |
1940 | ||
1941 | If this variable is nil, the minibuffer often starts out empty. In | |
1942 | that case you may have to explicitly fetch the next history element to | |
1943 | request the default name; typing RETURN without editing will leave | |
1944 | the minibuffer empty. | |
1945 | ||
1946 | For some commands, exiting with an empty minibuffer has a special meaning, | |
1947 | such as making the current buffer visit no file in the case of | |
1948 | `set-visited-file-name'." | |
1949 | :group 'minibuffer | |
1950 | :type 'boolean) | |
1951 | ||
4e3870f5 GM |
1952 | ;; Not always defined, but only called if next-read-file-uses-dialog-p says so. |
1953 | (declare-function x-file-dialog "xfns.c" | |
1954 | (prompt dir &optional default-filename mustmatch only-dir-p)) | |
1955 | ||
b16ac1ec | 1956 | (defun read-file-name--defaults (&optional dir initial) |
7d371eac JL |
1957 | (let ((default |
1958 | (cond | |
1959 | ;; With non-nil `initial', use `dir' as the first default. | |
1960 | ;; Essentially, this mean reversing the normal order of the | |
1961 | ;; current directory name and the current file name, i.e. | |
1962 | ;; 1. with normal file reading: | |
1963 | ;; 1.1. initial input is the current directory | |
1964 | ;; 1.2. the first default is the current file name | |
1965 | ;; 2. with non-nil `initial' (e.g. for `find-alternate-file'): | |
1966 | ;; 2.2. initial input is the current file name | |
1967 | ;; 2.1. the first default is the current directory | |
1968 | (initial (abbreviate-file-name dir)) | |
1969 | ;; In file buffers, try to get the current file name | |
1970 | (buffer-file-name | |
1971 | (abbreviate-file-name buffer-file-name)))) | |
1972 | (file-name-at-point | |
1973 | (run-hook-with-args-until-success 'file-name-at-point-functions))) | |
1974 | (when file-name-at-point | |
1975 | (setq default (delete-dups | |
1976 | (delete "" (delq nil (list file-name-at-point default)))))) | |
1977 | ;; Append new defaults to the end of existing `minibuffer-default'. | |
1978 | (append | |
1979 | (if (listp minibuffer-default) minibuffer-default (list minibuffer-default)) | |
1980 | (if (listp default) default (list default))))) | |
1981 | ||
dbd50d4b SM |
1982 | (defun read-file-name (prompt &optional dir default-filename mustmatch initial predicate) |
1983 | "Read file name, prompting with PROMPT and completing in directory DIR. | |
1984 | Value is not expanded---you must call `expand-file-name' yourself. | |
1985 | Default name to DEFAULT-FILENAME if user exits the minibuffer with | |
1986 | the same non-empty string that was inserted by this function. | |
1987 | (If DEFAULT-FILENAME is omitted, the visited file name is used, | |
032c3399 JL |
1988 | except that if INITIAL is specified, that combined with DIR is used. |
1989 | If DEFAULT-FILENAME is a list of file names, the first file name is used.) | |
dbd50d4b SM |
1990 | If the user exits with an empty minibuffer, this function returns |
1991 | an empty string. (This can only happen if the user erased the | |
1992 | pre-inserted contents or if `insert-default-directory' is nil.) | |
846b6eba CY |
1993 | |
1994 | Fourth arg MUSTMATCH can take the following values: | |
1995 | - nil means that the user can exit with any input. | |
1996 | - t means that the user is not allowed to exit unless | |
1997 | the input is (or completes to) an existing file. | |
1998 | - `confirm' means that the user can exit with any input, but she needs | |
1999 | to confirm her choice if the input is not an existing file. | |
2000 | - `confirm-after-completion' means that the user can exit with any | |
2001 | input, but she needs to confirm her choice if she called | |
2002 | `minibuffer-complete' right before `minibuffer-complete-and-exit' | |
2003 | and the input is not an existing file. | |
2004 | - anything else behaves like t except that typing RET does not exit if it | |
2005 | does non-null completion. | |
2006 | ||
dbd50d4b | 2007 | Fifth arg INITIAL specifies text to start with. |
846b6eba | 2008 | |
dbd50d4b SM |
2009 | If optional sixth arg PREDICATE is non-nil, possible completions and |
2010 | the resulting file name must satisfy (funcall PREDICATE NAME). | |
2011 | DIR should be an absolute directory name. It defaults to the value of | |
2012 | `default-directory'. | |
2013 | ||
846b6eba CY |
2014 | If this command was invoked with the mouse, use a graphical file |
2015 | dialog if `use-dialog-box' is non-nil, and the window system or X | |
8368c14e | 2016 | toolkit in use provides a file dialog box, and DIR is not a |
2605051a GM |
2017 | remote file. For graphical file dialogs, any of the special values |
2018 | of MUSTMATCH `confirm' and `confirm-after-completion' are | |
2019 | treated as equivalent to nil. Some graphical file dialogs respect | |
2020 | a MUSTMATCH value of t, and some do not (or it only has a cosmetic | |
fba9b8b6 | 2021 | effect, and does not actually prevent the user from entering a |
2605051a | 2022 | non-existent file). |
dbd50d4b SM |
2023 | |
2024 | See also `read-file-name-completion-ignore-case' | |
2025 | and `read-file-name-function'." | |
2605051a GM |
2026 | ;; If x-gtk-use-old-file-dialog = t (xg_get_file_with_selection), |
2027 | ;; then MUSTMATCH is enforced. But with newer Gtk | |
2028 | ;; (xg_get_file_with_chooser), it only has a cosmetic effect. | |
2029 | ;; The user can still type a non-existent file name. | |
b16ac1ec LL |
2030 | (funcall (or read-file-name-function #'read-file-name-default) |
2031 | prompt dir default-filename mustmatch initial predicate)) | |
2032 | ||
620c53a6 SM |
2033 | ;; minibuffer-completing-file-name is a variable used internally in minibuf.c |
2034 | ;; to determine whether to use minibuffer-local-filename-completion-map or | |
2035 | ;; minibuffer-local-completion-map. It shouldn't be exported to Elisp. | |
2403c841 SM |
2036 | ;; FIXME: Actually, it is also used in rfn-eshadow.el we'd otherwise have to |
2037 | ;; use (eq minibuffer-completion-table #'read-file-name-internal), which is | |
2038 | ;; probably even worse. Maybe We should add some read-file-name-setup-hook | |
2039 | ;; instead, but for now, let's keep this non-obsolete. | |
2040 | ;;(make-obsolete-variable 'minibuffer-completing-file-name nil "24.1" 'get) | |
620c53a6 | 2041 | |
b16ac1ec LL |
2042 | (defun read-file-name-default (prompt &optional dir default-filename mustmatch initial predicate) |
2043 | "Default method for reading file names. | |
2044 | See `read-file-name' for the meaning of the arguments." | |
dbd50d4b SM |
2045 | (unless dir (setq dir default-directory)) |
2046 | (unless (file-name-absolute-p dir) (setq dir (expand-file-name dir))) | |
2047 | (unless default-filename | |
2048 | (setq default-filename (if initial (expand-file-name initial dir) | |
2049 | buffer-file-name))) | |
2050 | ;; If dir starts with user's homedir, change that to ~. | |
2051 | (setq dir (abbreviate-file-name dir)) | |
2052 | ;; Likewise for default-filename. | |
e8a5fe3e | 2053 | (if default-filename |
032c3399 JL |
2054 | (setq default-filename |
2055 | (if (consp default-filename) | |
2056 | (mapcar 'abbreviate-file-name default-filename) | |
2057 | (abbreviate-file-name default-filename)))) | |
dbd50d4b SM |
2058 | (let ((insdef (cond |
2059 | ((and insert-default-directory (stringp dir)) | |
2060 | (if initial | |
2061 | (cons (minibuffer--double-dollars (concat dir initial)) | |
2062 | (length (minibuffer--double-dollars dir))) | |
2063 | (minibuffer--double-dollars dir))) | |
2064 | (initial (cons (minibuffer--double-dollars initial) 0))))) | |
2065 | ||
03408648 SM |
2066 | (let ((completion-ignore-case read-file-name-completion-ignore-case) |
2067 | (minibuffer-completing-file-name t) | |
2068 | (pred (or predicate 'file-exists-p)) | |
2069 | (add-to-history nil)) | |
2070 | ||
2071 | (let* ((val | |
2072 | (if (or (not (next-read-file-uses-dialog-p)) | |
2073 | ;; Graphical file dialogs can't handle remote | |
2074 | ;; files (Bug#99). | |
2075 | (file-remote-p dir)) | |
2076 | ;; We used to pass `dir' to `read-file-name-internal' by | |
2077 | ;; abusing the `predicate' argument. It's better to | |
2078 | ;; just use `default-directory', but in order to avoid | |
2079 | ;; changing `default-directory' in the current buffer, | |
2080 | ;; we don't let-bind it. | |
2081 | (let ((dir (file-name-as-directory | |
2082 | (expand-file-name dir)))) | |
2083 | (minibuffer-with-setup-hook | |
2084 | (lambda () | |
2085 | (setq default-directory dir) | |
2086 | ;; When the first default in `minibuffer-default' | |
2087 | ;; duplicates initial input `insdef', | |
2088 | ;; reset `minibuffer-default' to nil. | |
2089 | (when (equal (or (car-safe insdef) insdef) | |
2090 | (or (car-safe minibuffer-default) | |
2091 | minibuffer-default)) | |
2092 | (setq minibuffer-default | |
2093 | (cdr-safe minibuffer-default))) | |
2094 | ;; On the first request on `M-n' fill | |
2095 | ;; `minibuffer-default' with a list of defaults | |
2096 | ;; relevant for file-name reading. | |
2097 | (set (make-local-variable 'minibuffer-default-add-function) | |
2098 | (lambda () | |
2099 | (with-current-buffer | |
2100 | (window-buffer (minibuffer-selected-window)) | |
b16ac1ec | 2101 | (read-file-name--defaults dir initial))))) |
03408648 SM |
2102 | (completing-read prompt 'read-file-name-internal |
2103 | pred mustmatch insdef | |
2104 | 'file-name-history default-filename))) | |
2105 | ;; If DEFAULT-FILENAME not supplied and DIR contains | |
2106 | ;; a file name, split it. | |
2107 | (let ((file (file-name-nondirectory dir)) | |
2108 | ;; When using a dialog, revert to nil and non-nil | |
2109 | ;; interpretation of mustmatch. confirm options | |
2110 | ;; need to be interpreted as nil, otherwise | |
2111 | ;; it is impossible to create new files using | |
2112 | ;; dialogs with the default settings. | |
2113 | (dialog-mustmatch | |
2114 | (not (memq mustmatch | |
2115 | '(nil confirm confirm-after-completion))))) | |
2116 | (when (and (not default-filename) | |
2117 | (not (zerop (length file)))) | |
2118 | (setq default-filename file) | |
2119 | (setq dir (file-name-directory dir))) | |
2120 | (when default-filename | |
2121 | (setq default-filename | |
2122 | (expand-file-name (if (consp default-filename) | |
2123 | (car default-filename) | |
2124 | default-filename) | |
2125 | dir))) | |
2126 | (setq add-to-history t) | |
2127 | (x-file-dialog prompt dir default-filename | |
2128 | dialog-mustmatch | |
2129 | (eq predicate 'file-directory-p))))) | |
2130 | ||
2131 | (replace-in-history (eq (car-safe file-name-history) val))) | |
2132 | ;; If completing-read returned the inserted default string itself | |
2133 | ;; (rather than a new string with the same contents), | |
2134 | ;; it has to mean that the user typed RET with the minibuffer empty. | |
2135 | ;; In that case, we really want to return "" | |
2136 | ;; so that commands such as set-visited-file-name can distinguish. | |
2137 | (when (consp default-filename) | |
2138 | (setq default-filename (car default-filename))) | |
2139 | (when (eq val default-filename) | |
2140 | ;; In this case, completing-read has not added an element | |
2141 | ;; to the history. Maybe we should. | |
2142 | (if (not replace-in-history) | |
2143 | (setq add-to-history t)) | |
2144 | (setq val "")) | |
2145 | (unless val (error "No file name specified")) | |
2146 | ||
2147 | (if (and default-filename | |
2148 | (string-equal val (if (consp insdef) (car insdef) insdef))) | |
2149 | (setq val default-filename)) | |
2150 | (setq val (substitute-in-file-name val)) | |
2151 | ||
2152 | (if replace-in-history | |
2153 | ;; Replace what Fcompleting_read added to the history | |
2154 | ;; with what we will actually return. As an exception, | |
2155 | ;; if that's the same as the second item in | |
2156 | ;; file-name-history, it's really a repeat (Bug#4657). | |
2157 | (let ((val1 (minibuffer--double-dollars val))) | |
2158 | (if history-delete-duplicates | |
2159 | (setcdr file-name-history | |
2160 | (delete val1 (cdr file-name-history)))) | |
2161 | (if (string= val1 (cadr file-name-history)) | |
2162 | (pop file-name-history) | |
2163 | (setcar file-name-history val1))) | |
2164 | (if add-to-history | |
2165 | ;; Add the value to the history--but not if it matches | |
2166 | ;; the last value already there. | |
dbd50d4b | 2167 | (let ((val1 (minibuffer--double-dollars val))) |
03408648 SM |
2168 | (unless (and (consp file-name-history) |
2169 | (equal (car file-name-history) val1)) | |
2170 | (setq file-name-history | |
2171 | (cons val1 | |
2172 | (if history-delete-duplicates | |
2173 | (delete val1 file-name-history) | |
2174 | file-name-history))))))) | |
b16ac1ec | 2175 | val)))) |
dbd50d4b | 2176 | |
8b04c0ae JL |
2177 | (defun internal-complete-buffer-except (&optional buffer) |
2178 | "Perform completion on all buffers excluding BUFFER. | |
e35b3063 | 2179 | BUFFER nil or omitted means use the current buffer. |
8b04c0ae | 2180 | Like `internal-complete-buffer', but removes BUFFER from the completion list." |
a647cb26 | 2181 | (let ((except (if (stringp buffer) buffer (buffer-name buffer)))) |
8b04c0ae JL |
2182 | (apply-partially 'completion-table-with-predicate |
2183 | 'internal-complete-buffer | |
2184 | (lambda (name) | |
2185 | (not (equal (if (consp name) (car name) name) except))) | |
2186 | nil))) | |
2187 | ||
eee6de73 | 2188 | ;;; Old-style completion, used in Emacs-21 and Emacs-22. |
19c04f39 | 2189 | |
d032d5e7 | 2190 | (defun completion-emacs21-try-completion (string table pred _point) |
19c04f39 SM |
2191 | (let ((completion (try-completion string table pred))) |
2192 | (if (stringp completion) | |
2193 | (cons completion (length completion)) | |
2194 | completion))) | |
2195 | ||
d032d5e7 | 2196 | (defun completion-emacs21-all-completions (string table pred _point) |
6138158d | 2197 | (completion-hilit-commonality |
eee6de73 | 2198 | (all-completions string table pred) |
125f7951 SM |
2199 | (length string) |
2200 | (car (completion-boundaries string table pred "")))) | |
19c04f39 | 2201 | |
19c04f39 SM |
2202 | (defun completion-emacs22-try-completion (string table pred point) |
2203 | (let ((suffix (substring string point)) | |
2204 | (completion (try-completion (substring string 0 point) table pred))) | |
2205 | (if (not (stringp completion)) | |
2206 | completion | |
2207 | ;; Merge a trailing / in completion with a / after point. | |
2208 | ;; We used to only do it for word completion, but it seems to make | |
2209 | ;; sense for all completions. | |
34200787 SM |
2210 | ;; Actually, claiming this feature was part of Emacs-22 completion |
2211 | ;; is pushing it a bit: it was only done in minibuffer-completion-word, | |
2212 | ;; which was (by default) not bound during file completion, where such | |
2213 | ;; slashes are most likely to occur. | |
2214 | (if (and (not (zerop (length completion))) | |
2215 | (eq ?/ (aref completion (1- (length completion)))) | |
19c04f39 SM |
2216 | (not (zerop (length suffix))) |
2217 | (eq ?/ (aref suffix 0))) | |
34200787 SM |
2218 | ;; This leaves point after the / . |
2219 | (setq suffix (substring suffix 1))) | |
19c04f39 SM |
2220 | (cons (concat completion suffix) (length completion))))) |
2221 | ||
2222 | (defun completion-emacs22-all-completions (string table pred point) | |
125f7951 SM |
2223 | (let ((beforepoint (substring string 0 point))) |
2224 | (completion-hilit-commonality | |
2225 | (all-completions beforepoint table pred) | |
2226 | point | |
2227 | (car (completion-boundaries beforepoint table pred ""))))) | |
19c04f39 | 2228 | |
eee6de73 SM |
2229 | ;;; Basic completion. |
2230 | ||
2231 | (defun completion--merge-suffix (completion point suffix) | |
2232 | "Merge end of COMPLETION with beginning of SUFFIX. | |
2233 | Simple generalization of the \"merge trailing /\" done in Emacs-22. | |
2234 | Return the new suffix." | |
2235 | (if (and (not (zerop (length suffix))) | |
2236 | (string-match "\\(.+\\)\n\\1" (concat completion "\n" suffix) | |
2237 | ;; Make sure we don't compress things to less | |
2238 | ;; than we started with. | |
2239 | point) | |
2240 | ;; Just make sure we didn't match some other \n. | |
2241 | (eq (match-end 1) (length completion))) | |
2242 | (substring suffix (- (match-end 1) (match-beginning 1))) | |
2243 | ;; Nothing to merge. | |
2244 | suffix)) | |
2245 | ||
00278747 SM |
2246 | (defun completion-basic--pattern (beforepoint afterpoint bounds) |
2247 | (delete | |
2248 | "" (list (substring beforepoint (car bounds)) | |
2249 | 'point | |
2250 | (substring afterpoint 0 (cdr bounds))))) | |
2251 | ||
34200787 | 2252 | (defun completion-basic-try-completion (string table pred point) |
a647cb26 SM |
2253 | (let* ((beforepoint (substring string 0 point)) |
2254 | (afterpoint (substring string point)) | |
2255 | (bounds (completion-boundaries beforepoint table pred afterpoint))) | |
86011bf2 SM |
2256 | (if (zerop (cdr bounds)) |
2257 | ;; `try-completion' may return a subtly different result | |
2258 | ;; than `all+merge', so try to use it whenever possible. | |
2259 | (let ((completion (try-completion beforepoint table pred))) | |
2260 | (if (not (stringp completion)) | |
2261 | completion | |
2262 | (cons | |
2263 | (concat completion | |
2264 | (completion--merge-suffix completion point afterpoint)) | |
2265 | (length completion)))) | |
a647cb26 SM |
2266 | (let* ((suffix (substring afterpoint (cdr bounds))) |
2267 | (prefix (substring beforepoint 0 (car bounds))) | |
2268 | (pattern (delete | |
2269 | "" (list (substring beforepoint (car bounds)) | |
2270 | 'point | |
2271 | (substring afterpoint 0 (cdr bounds))))) | |
2272 | (all (completion-pcm--all-completions prefix pattern table pred))) | |
86011bf2 SM |
2273 | (if minibuffer-completing-file-name |
2274 | (setq all (completion-pcm--filename-try-filter all))) | |
2275 | (completion-pcm--merge-try pattern all prefix suffix))))) | |
2276 | ||
2277 | (defun completion-basic-all-completions (string table pred point) | |
a647cb26 SM |
2278 | (let* ((beforepoint (substring string 0 point)) |
2279 | (afterpoint (substring string point)) | |
2280 | (bounds (completion-boundaries beforepoint table pred afterpoint)) | |
d032d5e7 | 2281 | ;; (suffix (substring afterpoint (cdr bounds))) |
a647cb26 SM |
2282 | (prefix (substring beforepoint 0 (car bounds))) |
2283 | (pattern (delete | |
2284 | "" (list (substring beforepoint (car bounds)) | |
2285 | 'point | |
2286 | (substring afterpoint 0 (cdr bounds))))) | |
2287 | (all (completion-pcm--all-completions prefix pattern table pred))) | |
125f7951 | 2288 | (completion-hilit-commonality all point (car bounds)))) |
19c04f39 | 2289 | |
34200787 SM |
2290 | ;;; Partial-completion-mode style completion. |
2291 | ||
890429cc SM |
2292 | (defvar completion-pcm--delim-wild-regex nil |
2293 | "Regular expression matching delimiters controlling the partial-completion. | |
2294 | Typically, this regular expression simply matches a delimiter, meaning | |
2295 | that completion can add something at (match-beginning 0), but if it has | |
2296 | a submatch 1, then completion can add something at (match-end 1). | |
2297 | This is used when the delimiter needs to be of size zero (e.g. the transition | |
2298 | from lowercase to uppercase characters).") | |
34200787 SM |
2299 | |
2300 | (defun completion-pcm--prepare-delim-re (delims) | |
2301 | (setq completion-pcm--delim-wild-regex (concat "[" delims "*]"))) | |
2302 | ||
a2a25d24 | 2303 | (defcustom completion-pcm-word-delimiters "-_./:| " |
34200787 SM |
2304 | "A string of characters treated as word delimiters for completion. |
2305 | Some arcane rules: | |
2306 | If `]' is in this string, it must come first. | |
2307 | If `^' is in this string, it must not come first. | |
2308 | If `-' is in this string, it must come first or right after `]'. | |
2309 | In other words, if S is this string, then `[S]' must be a valid Emacs regular | |
2310 | expression (not containing character ranges like `a-z')." | |
2311 | :set (lambda (symbol value) | |
2312 | (set-default symbol value) | |
2313 | ;; Refresh other vars. | |
2314 | (completion-pcm--prepare-delim-re value)) | |
2315 | :initialize 'custom-initialize-reset | |
26c548b0 | 2316 | :group 'minibuffer |
34200787 SM |
2317 | :type 'string) |
2318 | ||
79ccd68f SM |
2319 | (defcustom completion-pcm-complete-word-inserts-delimiters nil |
2320 | "Treat the SPC or - inserted by `minibuffer-complete-word' as delimiters. | |
2321 | Those chars are treated as delimiters iff this variable is non-nil. | |
2322 | I.e. if non-nil, M-x SPC will just insert a \"-\" in the minibuffer, whereas | |
2323 | if nil, it will list all possible commands in *Completions* because none of | |
2324 | the commands start with a \"-\" or a SPC." | |
2bed3f04 | 2325 | :version "24.1" |
79ccd68f SM |
2326 | :type 'boolean) |
2327 | ||
34200787 | 2328 | (defun completion-pcm--pattern-trivial-p (pattern) |
1bba1cfc SM |
2329 | (and (stringp (car pattern)) |
2330 | ;; It can be followed by `point' and "" and still be trivial. | |
2331 | (let ((trivial t)) | |
2332 | (dolist (elem (cdr pattern)) | |
2333 | (unless (member elem '(point "")) | |
2334 | (setq trivial nil))) | |
2335 | trivial))) | |
34200787 | 2336 | |
a38313e1 SM |
2337 | (defun completion-pcm--string->pattern (string &optional point) |
2338 | "Split STRING into a pattern. | |
34200787 | 2339 | A pattern is a list where each element is either a string |
934eacb9 | 2340 | or a symbol, see `completion-pcm--merge-completions'." |
a38313e1 SM |
2341 | (if (and point (< point (length string))) |
2342 | (let ((prefix (substring string 0 point)) | |
2343 | (suffix (substring string point))) | |
34200787 SM |
2344 | (append (completion-pcm--string->pattern prefix) |
2345 | '(point) | |
2346 | (completion-pcm--string->pattern suffix))) | |
3e2d70fd SM |
2347 | (let* ((pattern nil) |
2348 | (p 0) | |
2349 | (p0 p)) | |
26c548b0 | 2350 | |
890429cc SM |
2351 | (while (and (setq p (string-match completion-pcm--delim-wild-regex |
2352 | string p)) | |
79ccd68f SM |
2353 | (or completion-pcm-complete-word-inserts-delimiters |
2354 | ;; If the char was added by minibuffer-complete-word, | |
2355 | ;; then don't treat it as a delimiter, otherwise | |
2356 | ;; "M-x SPC" ends up inserting a "-" rather than listing | |
2357 | ;; all completions. | |
2358 | (not (get-text-property p 'completion-try-word string)))) | |
890429cc SM |
2359 | ;; Usually, completion-pcm--delim-wild-regex matches a delimiter, |
2360 | ;; meaning that something can be added *before* it, but it can also | |
2361 | ;; match a prefix and postfix, in which case something can be added | |
2362 | ;; in-between (e.g. match [[:lower:]][[:upper:]]). | |
2363 | ;; This is determined by the presence of a submatch-1 which delimits | |
2364 | ;; the prefix. | |
2365 | (if (match-end 1) (setq p (match-end 1))) | |
a38313e1 SM |
2366 | (push (substring string p0 p) pattern) |
2367 | (if (eq (aref string p) ?*) | |
34200787 SM |
2368 | (progn |
2369 | (push 'star pattern) | |
2370 | (setq p0 (1+ p))) | |
2371 | (push 'any pattern) | |
2372 | (setq p0 p)) | |
2373 | (incf p)) | |
2374 | ||
2375 | ;; An empty string might be erroneously added at the beginning. | |
2376 | ;; It should be avoided properly, but it's so easy to remove it here. | |
a38313e1 | 2377 | (delete "" (nreverse (cons (substring string p0) pattern)))))) |
34200787 SM |
2378 | |
2379 | (defun completion-pcm--pattern->regex (pattern &optional group) | |
a38313e1 | 2380 | (let ((re |
ab22be48 SM |
2381 | (concat "\\`" |
2382 | (mapconcat | |
2383 | (lambda (x) | |
79ccd68f SM |
2384 | (cond |
2385 | ((stringp x) (regexp-quote x)) | |
8a67c70e SM |
2386 | ((if (consp group) (memq x group) group) "\\(.*?\\)") |
2387 | (t ".*?"))) | |
ab22be48 | 2388 | pattern |
15c72e1d | 2389 | "")))) |
a38313e1 SM |
2390 | ;; Avoid pathological backtracking. |
2391 | (while (string-match "\\.\\*\\?\\(?:\\\\[()]\\)*\\(\\.\\*\\?\\)" re) | |
2392 | (setq re (replace-match "" t t re 1))) | |
2393 | re)) | |
34200787 | 2394 | |
a38313e1 | 2395 | (defun completion-pcm--all-completions (prefix pattern table pred) |
34200787 | 2396 | "Find all completions for PATTERN in TABLE obeying PRED. |
26c548b0 | 2397 | PATTERN is as returned by `completion-pcm--string->pattern'." |
125f7951 SM |
2398 | ;; (assert (= (car (completion-boundaries prefix table pred "")) |
2399 | ;; (length prefix))) | |
34200787 SM |
2400 | ;; Find an initial list of possible completions. |
2401 | (if (completion-pcm--pattern-trivial-p pattern) | |
2402 | ||
2403 | ;; Minibuffer contains no delimiters -- simple case! | |
125f7951 | 2404 | (all-completions (concat prefix (car pattern)) table pred) |
26c548b0 | 2405 | |
34200787 SM |
2406 | ;; Use all-completions to do an initial cull. This is a big win, |
2407 | ;; since all-completions is written in C! | |
2408 | (let* (;; Convert search pattern to a standard regular expression. | |
2409 | (regex (completion-pcm--pattern->regex pattern)) | |
15c72e1d SM |
2410 | (case-fold-search completion-ignore-case) |
2411 | (completion-regexp-list (cons regex completion-regexp-list)) | |
34200787 | 2412 | (compl (all-completions |
30a23501 SM |
2413 | (concat prefix |
2414 | (if (stringp (car pattern)) (car pattern) "")) | |
125f7951 | 2415 | table pred))) |
34200787 SM |
2416 | (if (not (functionp table)) |
2417 | ;; The internal functions already obeyed completion-regexp-list. | |
2418 | compl | |
15c72e1d | 2419 | (let ((poss ())) |
34200787 | 2420 | (dolist (c compl) |
9f3618b5 | 2421 | (when (string-match-p regex c) (push c poss))) |
34200787 SM |
2422 | poss))))) |
2423 | ||
7372b09c SM |
2424 | (defun completion-pcm--hilit-commonality (pattern completions) |
2425 | (when completions | |
2426 | (let* ((re (completion-pcm--pattern->regex pattern '(point))) | |
1bba1cfc | 2427 | (case-fold-search completion-ignore-case)) |
1bba1cfc SM |
2428 | (mapcar |
2429 | (lambda (str) | |
2430 | ;; Don't modify the string itself. | |
2431 | (setq str (copy-sequence str)) | |
2432 | (unless (string-match re str) | |
2433 | (error "Internal error: %s does not match %s" re str)) | |
2434 | (let ((pos (or (match-beginning 1) (match-end 0)))) | |
2435 | (put-text-property 0 pos | |
2436 | 'font-lock-face 'completions-common-part | |
2437 | str) | |
2438 | (if (> (length str) pos) | |
2439 | (put-text-property pos (1+ pos) | |
2440 | 'font-lock-face 'completions-first-difference | |
2441 | str))) | |
2442 | str) | |
2443 | completions)))) | |
7372b09c | 2444 | |
eee6de73 SM |
2445 | (defun completion-pcm--find-all-completions (string table pred point |
2446 | &optional filter) | |
2447 | "Find all completions for STRING at POINT in TABLE, satisfying PRED. | |
2448 | POINT is a position inside STRING. | |
2449 | FILTER is a function applied to the return value, that can be used, e.g. to | |
53964682 | 2450 | filter out additional entries (because TABLE might not obey PRED)." |
eee6de73 | 2451 | (unless filter (setq filter 'identity)) |
a647cb26 SM |
2452 | (let* ((beforepoint (substring string 0 point)) |
2453 | (afterpoint (substring string point)) | |
2454 | (bounds (completion-boundaries beforepoint table pred afterpoint)) | |
2455 | (prefix (substring beforepoint 0 (car bounds))) | |
2456 | (suffix (substring afterpoint (cdr bounds))) | |
2457 | firsterror) | |
f8381803 SM |
2458 | (setq string (substring string (car bounds) (+ point (cdr bounds)))) |
2459 | (let* ((relpoint (- point (car bounds))) | |
2460 | (pattern (completion-pcm--string->pattern string relpoint)) | |
a38313e1 | 2461 | (all (condition-case err |
eee6de73 SM |
2462 | (funcall filter |
2463 | (completion-pcm--all-completions | |
2464 | prefix pattern table pred)) | |
a38313e1 SM |
2465 | (error (unless firsterror (setq firsterror err)) nil)))) |
2466 | (when (and (null all) | |
2467 | (> (car bounds) 0) | |
2468 | (null (ignore-errors (try-completion prefix table pred)))) | |
2469 | ;; The prefix has no completions at all, so we should try and fix | |
2470 | ;; that first. | |
2471 | (let ((substring (substring prefix 0 -1))) | |
d032d5e7 | 2472 | (destructuring-bind (subpat suball subprefix _subsuffix) |
a38313e1 | 2473 | (completion-pcm--find-all-completions |
eee6de73 | 2474 | substring table pred (length substring) filter) |
a38313e1 SM |
2475 | (let ((sep (aref prefix (1- (length prefix)))) |
2476 | ;; Text that goes between the new submatches and the | |
2477 | ;; completion substring. | |
2478 | (between nil)) | |
2479 | ;; Eliminate submatches that don't end with the separator. | |
2480 | (dolist (submatch (prog1 suball (setq suball ()))) | |
2481 | (when (eq sep (aref submatch (1- (length submatch)))) | |
2482 | (push submatch suball))) | |
2483 | (when suball | |
2484 | ;; Update the boundaries and corresponding pattern. | |
2485 | ;; We assume that all submatches result in the same boundaries | |
2486 | ;; since we wouldn't know how to merge them otherwise anyway. | |
f8381803 SM |
2487 | ;; FIXME: COMPLETE REWRITE!!! |
2488 | (let* ((newbeforepoint | |
2489 | (concat subprefix (car suball) | |
2490 | (substring string 0 relpoint))) | |
2491 | (leftbound (+ (length subprefix) (length (car suball)))) | |
a38313e1 | 2492 | (newbounds (completion-boundaries |
f8381803 SM |
2493 | newbeforepoint table pred afterpoint))) |
2494 | (unless (or (and (eq (cdr bounds) (cdr newbounds)) | |
2495 | (eq (car newbounds) leftbound)) | |
a38313e1 SM |
2496 | ;; Refuse new boundaries if they step over |
2497 | ;; the submatch. | |
f8381803 | 2498 | (< (car newbounds) leftbound)) |
a38313e1 SM |
2499 | ;; The new completed prefix does change the boundaries |
2500 | ;; of the completed substring. | |
f8381803 SM |
2501 | (setq suffix (substring afterpoint (cdr newbounds))) |
2502 | (setq string | |
2503 | (concat (substring newbeforepoint (car newbounds)) | |
2504 | (substring afterpoint 0 (cdr newbounds)))) | |
2505 | (setq between (substring newbeforepoint leftbound | |
a38313e1 SM |
2506 | (car newbounds))) |
2507 | (setq pattern (completion-pcm--string->pattern | |
f8381803 SM |
2508 | string |
2509 | (- (length newbeforepoint) | |
2510 | (car newbounds))))) | |
a38313e1 | 2511 | (dolist (submatch suball) |
30a23501 SM |
2512 | (setq all (nconc |
2513 | (mapcar | |
2514 | (lambda (s) (concat submatch between s)) | |
2515 | (funcall filter | |
2516 | (completion-pcm--all-completions | |
2517 | (concat subprefix submatch between) | |
2518 | pattern table pred))) | |
2519 | all))) | |
c63028e1 SM |
2520 | ;; FIXME: This can come in handy for try-completion, |
2521 | ;; but isn't right for all-completions, since it lists | |
2522 | ;; invalid completions. | |
2523 | ;; (unless all | |
2524 | ;; ;; Even though we found expansions in the prefix, none | |
2525 | ;; ;; leads to a valid completion. | |
2526 | ;; ;; Let's keep the expansions, tho. | |
2527 | ;; (dolist (submatch suball) | |
2528 | ;; (push (concat submatch between newsubstring) all))) | |
2529 | )) | |
a38313e1 SM |
2530 | (setq pattern (append subpat (list 'any (string sep)) |
2531 | (if between (list between)) pattern)) | |
2532 | (setq prefix subprefix))))) | |
2533 | (if (and (null all) firsterror) | |
2534 | (signal (car firsterror) (cdr firsterror)) | |
2535 | (list pattern all prefix suffix))))) | |
2536 | ||
34200787 | 2537 | (defun completion-pcm-all-completions (string table pred point) |
d032d5e7 | 2538 | (destructuring-bind (pattern all &optional prefix _suffix) |
a38313e1 | 2539 | (completion-pcm--find-all-completions string table pred point) |
d4e88786 SM |
2540 | (when all |
2541 | (nconc (completion-pcm--hilit-commonality pattern all) | |
2542 | (length prefix))))) | |
34200787 | 2543 | |
1493963b SM |
2544 | (defun completion--sreverse (str) |
2545 | "Like `reverse' but for a string STR rather than a list." | |
2546 | (apply 'string (nreverse (mapcar 'identity str)))) | |
2547 | ||
2548 | (defun completion--common-suffix (strs) | |
2549 | "Return the common suffix of the strings STRS." | |
2550 | (completion--sreverse | |
2551 | (try-completion | |
2552 | "" | |
f3ee9200 | 2553 | (mapcar 'completion--sreverse strs)))) |
1493963b | 2554 | |
34200787 | 2555 | (defun completion-pcm--merge-completions (strs pattern) |
934eacb9 SM |
2556 | "Extract the commonality in STRS, with the help of PATTERN. |
2557 | PATTERN can contain strings and symbols chosen among `star', `any', `point', | |
2558 | and `prefix'. They all match anything (aka \".*\") but are merged differently: | |
2559 | `any' only grows from the left (when matching \"a1b\" and \"a2b\" it gets | |
2560 | completed to just \"a\"). | |
2561 | `prefix' only grows from the right (when matching \"a1b\" and \"a2b\" it gets | |
2562 | completed to just \"b\"). | |
2563 | `star' grows from both ends and is reified into a \"*\" (when matching \"a1b\" | |
2564 | and \"a2b\" it gets completed to \"a*b\"). | |
2565 | `point' is like `star' except that it gets reified as the position of point | |
2566 | instead of being reified as a \"*\" character. | |
2567 | The underlying idea is that we should return a string which still matches | |
2568 | the same set of elements." | |
681e0e7c SM |
2569 | ;; When completing while ignoring case, we want to try and avoid |
2570 | ;; completing "fo" to "foO" when completing against "FOO" (bug#4219). | |
2571 | ;; So we try and make sure that the string we return is all made up | |
2572 | ;; of text from the completions rather than part from the | |
2573 | ;; completions and part from the input. | |
2574 | ;; FIXME: This reduces the problems of inconsistent capitalization | |
2575 | ;; but it doesn't fully fix it: we may still end up completing | |
2576 | ;; "fo-ba" to "foo-BAR" or "FOO-bar" when completing against | |
2577 | ;; '("foo-barr" "FOO-BARD"). | |
34200787 SM |
2578 | (cond |
2579 | ((null (cdr strs)) (list (car strs))) | |
2580 | (t | |
2581 | (let ((re (completion-pcm--pattern->regex pattern 'group)) | |
2582 | (ccs ())) ;Chopped completions. | |
2583 | ||
2584 | ;; First chop each string into the parts corresponding to each | |
2585 | ;; non-constant element of `pattern', using regexp-matching. | |
2586 | (let ((case-fold-search completion-ignore-case)) | |
2587 | (dolist (str strs) | |
2588 | (unless (string-match re str) | |
2589 | (error "Internal error: %s doesn't match %s" str re)) | |
2590 | (let ((chopped ()) | |
681e0e7c SM |
2591 | (last 0) |
2592 | (i 1) | |
2593 | next) | |
2594 | (while (setq next (match-end i)) | |
2595 | (push (substring str last next) chopped) | |
2596 | (setq last next) | |
34200787 SM |
2597 | (setq i (1+ i))) |
2598 | ;; Add the text corresponding to the implicit trailing `any'. | |
681e0e7c | 2599 | (push (substring str last) chopped) |
34200787 SM |
2600 | (push (nreverse chopped) ccs)))) |
2601 | ||
2602 | ;; Then for each of those non-constant elements, extract the | |
2603 | ;; commonality between them. | |
681e0e7c SM |
2604 | (let ((res ()) |
2605 | (fixed "")) | |
2606 | ;; Make the implicit trailing `any' explicit. | |
34200787 SM |
2607 | (dolist (elem (append pattern '(any))) |
2608 | (if (stringp elem) | |
681e0e7c | 2609 | (setq fixed (concat fixed elem)) |
34200787 SM |
2610 | (let ((comps ())) |
2611 | (dolist (cc (prog1 ccs (setq ccs nil))) | |
2612 | (push (car cc) comps) | |
2613 | (push (cdr cc) ccs)) | |
681e0e7c SM |
2614 | ;; Might improve the likelihood to avoid choosing |
2615 | ;; different capitalizations in different parts. | |
2616 | ;; In practice, it doesn't seem to make any difference. | |
2617 | (setq ccs (nreverse ccs)) | |
2618 | (let* ((prefix (try-completion fixed comps)) | |
2619 | (unique (or (and (eq prefix t) (setq prefix fixed)) | |
34200787 | 2620 | (eq t (try-completion prefix comps))))) |
934eacb9 SM |
2621 | (unless (or (eq elem 'prefix) |
2622 | (equal prefix "")) | |
2623 | (push prefix res)) | |
34200787 SM |
2624 | ;; If there's only one completion, `elem' is not useful |
2625 | ;; any more: it can only match the empty string. | |
2626 | ;; FIXME: in some cases, it may be necessary to turn an | |
2627 | ;; `any' into a `star' because the surrounding context has | |
2628 | ;; changed such that string->pattern wouldn't add an `any' | |
2629 | ;; here any more. | |
1493963b SM |
2630 | (unless unique |
2631 | (push elem res) | |
79ccd68f | 2632 | (when (memq elem '(star point prefix)) |
1493963b | 2633 | ;; Extract common suffix additionally to common prefix. |
79ccd68f | 2634 | ;; Only do it for `point', `star', and `prefix' since for |
1493963b SM |
2635 | ;; `any' it could lead to a merged completion that |
2636 | ;; doesn't itself match the candidates. | |
2637 | (let ((suffix (completion--common-suffix comps))) | |
2638 | (assert (stringp suffix)) | |
2639 | (unless (equal suffix "") | |
2640 | (push suffix res))))) | |
681e0e7c | 2641 | (setq fixed ""))))) |
34200787 SM |
2642 | ;; We return it in reverse order. |
2643 | res))))) | |
2644 | ||
2645 | (defun completion-pcm--pattern->string (pattern) | |
2646 | (mapconcat (lambda (x) (cond | |
03408648 SM |
2647 | ((stringp x) x) |
2648 | ((eq x 'star) "*") | |
2649 | (t ""))) ;any, point, prefix. | |
34200787 SM |
2650 | pattern |
2651 | "")) | |
2652 | ||
eee6de73 SM |
2653 | ;; We want to provide the functionality of `try', but we use `all' |
2654 | ;; and then merge it. In most cases, this works perfectly, but | |
2655 | ;; if the completion table doesn't consider the same completions in | |
2656 | ;; `try' as in `all', then we have a problem. The most common such | |
2657 | ;; case is for filename completion where completion-ignored-extensions | |
2658 | ;; is only obeyed by the `try' code. We paper over the difference | |
2659 | ;; here. Note that it is not quite right either: if the completion | |
2660 | ;; table uses completion-table-in-turn, this filtering may take place | |
2661 | ;; too late to correctly fallback from the first to the | |
2662 | ;; second alternative. | |
2663 | (defun completion-pcm--filename-try-filter (all) | |
2664 | "Filter to adjust `all' file completion to the behavior of `try'." | |
03408648 | 2665 | (when all |
eee6de73 SM |
2666 | (let ((try ()) |
2667 | (re (concat "\\(?:\\`\\.\\.?/\\|" | |
2668 | (regexp-opt completion-ignored-extensions) | |
2669 | "\\)\\'"))) | |
2670 | (dolist (f all) | |
9f3618b5 | 2671 | (unless (string-match-p re f) (push f try))) |
eee6de73 | 2672 | (or try all)))) |
9f3618b5 | 2673 | |
eee6de73 SM |
2674 | |
2675 | (defun completion-pcm--merge-try (pattern all prefix suffix) | |
2676 | (cond | |
2677 | ((not (consp all)) all) | |
2678 | ((and (not (consp (cdr all))) ;Only one completion. | |
2679 | ;; Ignore completion-ignore-case here. | |
2680 | (equal (completion-pcm--pattern->string pattern) (car all))) | |
2681 | t) | |
2682 | (t | |
03408648 SM |
2683 | (let* ((mergedpat (completion-pcm--merge-completions all pattern)) |
2684 | ;; `mergedpat' is in reverse order. Place new point (by | |
2685 | ;; order of preference) either at the old point, or at | |
2686 | ;; the last place where there's something to choose, or | |
2687 | ;; at the very end. | |
2688 | (pointpat (or (memq 'point mergedpat) | |
2689 | (memq 'any mergedpat) | |
2690 | (memq 'star mergedpat) | |
2691 | ;; Not `prefix'. | |
2692 | mergedpat)) | |
2693 | ;; New pos from the start. | |
2694 | (newpos (length (completion-pcm--pattern->string pointpat))) | |
9858f6c3 | 2695 | ;; Do it afterwards because it changes `pointpat' by side effect. |
03408648 | 2696 | (merged (completion-pcm--pattern->string (nreverse mergedpat)))) |
eee6de73 SM |
2697 | |
2698 | (setq suffix (completion--merge-suffix merged newpos suffix)) | |
03408648 | 2699 | (cons (concat prefix merged suffix) (+ newpos (length prefix))))))) |
34200787 | 2700 | |
eee6de73 SM |
2701 | (defun completion-pcm-try-completion (string table pred point) |
2702 | (destructuring-bind (pattern all prefix suffix) | |
2703 | (completion-pcm--find-all-completions | |
2704 | string table pred point | |
2705 | (if minibuffer-completing-file-name | |
2706 | 'completion-pcm--filename-try-filter)) | |
2707 | (completion-pcm--merge-try pattern all prefix suffix))) | |
2708 | ||
00278747 SM |
2709 | ;;; Substring completion |
2710 | ;; Mostly derived from the code of `basic' completion. | |
2711 | ||
2712 | (defun completion-substring--all-completions (string table pred point) | |
2713 | (let* ((beforepoint (substring string 0 point)) | |
2714 | (afterpoint (substring string point)) | |
2715 | (bounds (completion-boundaries beforepoint table pred afterpoint)) | |
2716 | (suffix (substring afterpoint (cdr bounds))) | |
2717 | (prefix (substring beforepoint 0 (car bounds))) | |
2718 | (basic-pattern (completion-basic--pattern | |
2719 | beforepoint afterpoint bounds)) | |
2720 | (pattern (if (not (stringp (car basic-pattern))) | |
2721 | basic-pattern | |
79ccd68f | 2722 | (cons 'prefix basic-pattern))) |
00278747 SM |
2723 | (all (completion-pcm--all-completions prefix pattern table pred))) |
2724 | (list all pattern prefix suffix (car bounds)))) | |
2725 | ||
2726 | (defun completion-substring-try-completion (string table pred point) | |
d032d5e7 | 2727 | (destructuring-bind (all pattern prefix suffix _carbounds) |
00278747 SM |
2728 | (completion-substring--all-completions string table pred point) |
2729 | (if minibuffer-completing-file-name | |
2730 | (setq all (completion-pcm--filename-try-filter all))) | |
2731 | (completion-pcm--merge-try pattern all prefix suffix))) | |
2732 | ||
2733 | (defun completion-substring-all-completions (string table pred point) | |
d032d5e7 | 2734 | (destructuring-bind (all pattern prefix _suffix _carbounds) |
00278747 SM |
2735 | (completion-substring--all-completions string table pred point) |
2736 | (when all | |
2737 | (nconc (completion-pcm--hilit-commonality pattern all) | |
2738 | (length prefix))))) | |
2739 | ||
2740 | ;; Initials completion | |
fcb68f70 SM |
2741 | ;; Complete /ums to /usr/monnier/src or lch to list-command-history. |
2742 | ||
2743 | (defun completion-initials-expand (str table pred) | |
51b23c44 SM |
2744 | (let ((bounds (completion-boundaries str table pred ""))) |
2745 | (unless (or (zerop (length str)) | |
2746 | ;; Only check within the boundaries, since the | |
2747 | ;; boundary char (e.g. /) might be in delim-regexp. | |
2748 | (string-match completion-pcm--delim-wild-regex str | |
2749 | (car bounds))) | |
fcb68f70 SM |
2750 | (if (zerop (car bounds)) |
2751 | (mapconcat 'string str "-") | |
2752 | ;; If there's a boundary, it's trickier. The main use-case | |
2753 | ;; we consider here is file-name completion. We'd like | |
2754 | ;; to expand ~/eee to ~/e/e/e and /eee to /e/e/e. | |
2755 | ;; But at the same time, we don't want /usr/share/ae to expand | |
2756 | ;; to /usr/share/a/e just because we mistyped "ae" for "ar", | |
2757 | ;; so we probably don't want initials to touch anything that | |
2758 | ;; looks like /usr/share/foo. As a heuristic, we just check that | |
2759 | ;; the text before the boundary char is at most 1 char. | |
2760 | ;; This allows both ~/eee and /eee and not much more. | |
2761 | ;; FIXME: It sadly also disallows the use of ~/eee when that's | |
2762 | ;; embedded within something else (e.g. "(~/eee" in Info node | |
2763 | ;; completion or "ancestor:/eee" in bzr-revision completion). | |
2764 | (when (< (car bounds) 3) | |
2765 | (let ((sep (substring str (1- (car bounds)) (car bounds)))) | |
2766 | ;; FIXME: the above string-match checks the whole string, whereas | |
2767 | ;; we end up only caring about the after-boundary part. | |
2768 | (concat (substring str 0 (car bounds)) | |
2769 | (mapconcat 'string (substring str (car bounds)) sep)))))))) | |
2770 | ||
d032d5e7 | 2771 | (defun completion-initials-all-completions (string table pred _point) |
fcb68f70 SM |
2772 | (let ((newstr (completion-initials-expand string table pred))) |
2773 | (when newstr | |
2774 | (completion-pcm-all-completions newstr table pred (length newstr))))) | |
2775 | ||
d032d5e7 | 2776 | (defun completion-initials-try-completion (string table pred _point) |
fcb68f70 SM |
2777 | (let ((newstr (completion-initials-expand string table pred))) |
2778 | (when newstr | |
2779 | (completion-pcm-try-completion newstr table pred (length newstr))))) | |
4e323265 LL |
2780 | \f |
2781 | (defvar completing-read-function 'completing-read-default | |
2782 | "The function called by `completing-read' to do its work. | |
2783 | It should accept the same arguments as `completing-read'.") | |
2784 | ||
2785 | (defun completing-read-default (prompt collection &optional predicate | |
2786 | require-match initial-input | |
2787 | hist def inherit-input-method) | |
2788 | "Default method for reading from the minibuffer with completion. | |
2789 | See `completing-read' for the meaning of the arguments." | |
2790 | ||
2791 | (when (consp initial-input) | |
2792 | (setq initial-input | |
2793 | (cons (car initial-input) | |
2794 | ;; `completing-read' uses 0-based index while | |
2795 | ;; `read-from-minibuffer' uses 1-based index. | |
2796 | (1+ (cdr initial-input))))) | |
2797 | ||
2798 | (let* ((minibuffer-completion-table collection) | |
2799 | (minibuffer-completion-predicate predicate) | |
2800 | (minibuffer-completion-confirm (unless (eq require-match t) | |
2801 | require-match)) | |
3349e122 | 2802 | (base-keymap (if require-match |
4e323265 | 2803 | minibuffer-local-must-match-map |
3349e122 SM |
2804 | minibuffer-local-completion-map)) |
2805 | (keymap (if (memq minibuffer-completing-file-name '(nil lambda)) | |
2806 | base-keymap | |
2807 | ;; Layer minibuffer-local-filename-completion-map | |
2808 | ;; on top of the base map. | |
640c8776 SM |
2809 | (make-composed-keymap |
2810 | minibuffer-local-filename-completion-map | |
2811 | ;; Set base-keymap as the parent, so that nil bindings | |
2812 | ;; in minibuffer-local-filename-completion-map can | |
2813 | ;; override bindings in base-keymap. | |
2814 | base-keymap))) | |
4e323265 LL |
2815 | (result (read-from-minibuffer prompt initial-input keymap |
2816 | nil hist def inherit-input-method))) | |
2817 | (when (and (equal result "") def) | |
2818 | (setq result (if (consp def) (car def) def))) | |
2819 | result)) | |
7d371eac JL |
2820 | \f |
2821 | ;; Miscellaneous | |
2822 | ||
2823 | (defun minibuffer-insert-file-name-at-point () | |
2824 | "Get a file name at point in original buffer and insert it to minibuffer." | |
2825 | (interactive) | |
2826 | (let ((file-name-at-point | |
2827 | (with-current-buffer (window-buffer (minibuffer-selected-window)) | |
2828 | (run-hook-with-args-until-success 'file-name-at-point-functions)))) | |
2829 | (when file-name-at-point | |
2830 | (insert file-name-at-point)))) | |
34200787 | 2831 | |
32bae13c | 2832 | (provide 'minibuffer) |
dc6ee347 | 2833 | |
32bae13c | 2834 | ;;; minibuffer.el ends here |