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