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