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