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