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