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>
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/>.
25 ;; Names with "--" are for functions and variables that are meant to be for
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).
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.
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
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.
84 (eval-when-compile (require 'cl-lib
))
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
)
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.
139 (let ((firsterror nil
)
141 (while (and (not res
) xs
)
143 (setq res
(funcall fun
(pop xs
)))
144 (error (unless firsterror
(setq firsterror err
)) nil
)))
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'."
155 ((functionp table
) (funcall table string pred action
))
156 ((eq (car-safe action
) 'boundaries
) nil
)
157 ((eq action
'metadata
) nil
)
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
)
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
201 (when (functionp ,var
)
202 (setq ,var
(funcall #',fun
)))
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
))))
225 ((eq (car-safe action
) 'boundaries
)
226 (let ((beg (or (and (eq (car-safe res
) 'boundaries
) (cadr res
)) 0)))
229 (+ beg
(- (length s1
) (length s2
))))
230 .
,(and (eq (car-safe res
) 'boundaries
) (cddr 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
)))))
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
))))))
243 (if (string-match re c
)
244 (substring c
(match-end 0))))
246 ;; E.g. action=nil and it's the only completion.
249 (defun completion-table-with-context (prefix table string pred action
)
250 ;; TODO: add `suffix' maybe?
252 (if (not (functionp pred
))
253 ;; Notice that `pred' may not be a function in some abusive cases.
255 ;; Predicates are called differently depending on the nature of
256 ;; the completion table :-(
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
))))
263 (lambda (s) (funcall pred
(concat prefix s
))))
264 (t ;Lists and alists.
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 `(boundaries ,(+ (car bound
) len
) .
,(cdr bound
)))
271 (let ((comp (complete-with-action action table string pred
)))
273 ;; In case of try-completion, add the prefix.
274 ((stringp comp
) (concat prefix 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.
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 `(boundaries ,(car bounds
)
304 .
,(min (cdr bounds
) (or max
(length suffix
))))))
306 (let ((comp (try-completion string table pred
)))
307 (if (consp terminator
) (setq terminator
(car terminator
)))
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
))
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."
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
))
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
))
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
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
)
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 (_ (cl-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
)))
421 `(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
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.
455 ((ustring (funcall unquote string
))
456 (completions (all-completions ustring table pred
))
457 (boundary (car (completion-boundaries ustring table pred
"")))
460 string ustring completions boundary unquote requote
))
461 (last (last completions
)))
462 (when (consp last
) (setcdr last nil
))
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 (cl-assert (string-prefix-p uprefix ustring
))
470 (list ustring table
(length uprefix
)
471 (lambda (unquoted-result op
)
474 (if (not (stringp (car-safe unquoted-result
)))
478 (car unquoted-result
) (cdr unquoted-result
)
481 (let* ((last (last unquoted-result
))
482 (base (or (cdr last
) 0)))
485 (completion--twq-all string ustring
487 unquote requote
))))))))))))
489 (defun completion--twq-try (string ustring completion point
491 ;; Basically two cases: either the new result is
492 ;; - commonprefix1 <point> morecommonprefix <qpos> suffix
493 ;; - commonprefix <qpos> newprefix <point> suffix
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
))
505 ((> point
(length prefix
)) (+ qpos
(length qstr1
)))
506 (t (car (funcall requote point string
))))))
507 ;; Make sure `requote' worked.
508 (if (equal (funcall unquote qstring
) completion
)
509 (cons qstring qpoint
)
510 ;; If requote failed (e.g. because sifn-requote did not handle
511 ;; Tramp's "/foo:/bar//baz -> /foo:/baz" truncation), then at least
512 ;; try requote properly.
513 (let ((qstr (funcall qfun completion
)))
514 (cons qstr
(length qstr
))))))
516 (defun completion--string-equal-p (s1 s2
)
517 (eq t
(compare-strings s1 nil nil s2 nil nil
'ignore-case
)))
519 (defun completion--twq-all (string ustring completions boundary
524 (let ((completion-regexp-list nil
))
525 (try-completion "" (cons (substring ustring boundary
)
527 (`(,qfullpos .
,qfun
)
528 (funcall requote
(+ boundary
(length prefix
)) string
))
529 (qfullprefix (substring string
0 qfullpos
))
530 (_ (cl-assert (completion--string-equal-p
531 (funcall unquote qfullprefix
)
532 (concat (substring ustring
0 boundary
) prefix
))
534 (qboundary (car (funcall requote boundary string
)))
535 (_ (cl-assert (<= qboundary qfullpos
)))
536 ;; FIXME: this split/quote/concat business messes up the carefully
537 ;; placed completions-common-part and completions-first-difference
538 ;; faces. We could try within the mapcar loop to search for the
539 ;; boundaries of those faces, pass them to `requote' to find their
540 ;; equivalent positions in the quoted output and re-add the faces:
541 ;; this might actually lead to correct results but would be
543 ;; The better solution is to not quote the *Completions* display,
544 ;; which nicely circumvents the problem. The solution I used here
545 ;; instead is to hope that `qfun' preserves the text-properties and
546 ;; presume that the `first-difference' is not within the `prefix';
547 ;; this presumption is not always true, but at least in practice it is
548 ;; true in most cases.
549 (qprefix (propertize (substring qfullprefix qboundary
)
550 'face
'completions-common-part
)))
552 ;; Here we choose to quote all elements returned, but a better option
553 ;; would be to return unquoted elements together with a function to
554 ;; requote them, so that *Completions* can show nicer unquoted values
555 ;; which only get quoted when needed by choose-completion.
557 (mapcar (lambda (completion)
558 (cl-assert (string-prefix-p prefix completion
'ignore-case
) t
)
559 (let* ((new (substring completion
(length prefix
)))
560 (qnew (funcall qfun new
))
561 (qcompletion (concat qprefix qnew
)))
563 (completion--string-equal-p
565 (concat (substring string
0 qboundary
)
567 (concat (substring ustring
0 boundary
)
574 ;; (defmacro complete-in-turn (a b) `(completion-table-in-turn ,a ,b))
575 ;; (defmacro dynamic-completion-table (fun) `(completion-table-dynamic ,fun))
576 (define-obsolete-function-alias
577 'complete-in-turn
'completion-table-in-turn
"23.1")
578 (define-obsolete-function-alias
579 'dynamic-completion-table
'completion-table-dynamic
"23.1")
581 ;;; Minibuffer completion
583 (defgroup minibuffer nil
584 "Controlling the behavior of the minibuffer."
585 :link
'(custom-manual "(emacs)Minibuffer")
588 (defun minibuffer-message (message &rest args
)
589 "Temporarily display MESSAGE at the end of the minibuffer.
590 The text is displayed for `minibuffer-message-timeout' seconds,
591 or until the next input event arrives, whichever comes first.
592 Enclose MESSAGE in [...] if this is not yet the case.
593 If ARGS are provided, then pass MESSAGE through `format'."
594 (if (not (minibufferp (current-buffer)))
597 (apply 'message message args
)
598 (message "%s" message
))
599 (prog1 (sit-for (or minibuffer-message-timeout
1000000))
601 ;; Clear out any old echo-area message to make way for our new thing.
603 (setq message
(if (and (null args
) (string-match-p "\\` *\\[.+\\]\\'" message
))
604 ;; Make sure we can put-text-property.
605 (copy-sequence message
)
606 (concat " [" message
"]")))
607 (when args
(setq message
(apply 'format message args
)))
608 (let ((ol (make-overlay (point-max) (point-max) nil t t
))
609 ;; A quit during sit-for normally only interrupts the sit-for,
610 ;; but since minibuffer-message is used at the end of a command,
611 ;; at a time when the command has virtually finished already, a C-g
612 ;; should really cause an abort-recursive-edit instead (i.e. as if
613 ;; the C-g had been typed at top-level). Binding inhibit-quit here
614 ;; is an attempt to get that behavior.
618 (unless (zerop (length message
))
619 ;; The current C cursor code doesn't know to use the overlay's
620 ;; marker's stickiness to figure out whether to place the cursor
621 ;; before or after the string, so let's spoon-feed it the pos.
622 (put-text-property 0 1 'cursor t message
))
623 (overlay-put ol
'after-string message
)
624 (sit-for (or minibuffer-message-timeout
1000000)))
625 (delete-overlay ol
)))))
627 (defun minibuffer-completion-contents ()
628 "Return the user input in a minibuffer before point as a string.
629 That is what completion commands operate on."
630 (buffer-substring (field-beginning) (point)))
632 (defun delete-minibuffer-contents ()
633 "Delete all user input in a minibuffer.
634 If the current buffer is not a minibuffer, erase its entire contents."
635 ;; We used to do `delete-field' here, but when file name shadowing
636 ;; is on, the field doesn't cover the entire minibuffer contents.
637 (delete-region (minibuffer-prompt-end) (point-max)))
639 (defvar completion-show-inline-help t
640 "If non-nil, print helpful inline messages during completion.")
642 (defcustom completion-auto-help t
643 "Non-nil means automatically provide help for invalid completion input.
644 If the value is t the *Completion* buffer is displayed whenever completion
645 is requested but cannot be done.
646 If the value is `lazy', the *Completions* buffer is only displayed after
647 the second failed attempt to complete."
648 :type
'(choice (const nil
) (const t
) (const lazy
))
651 (defconst completion-styles-alist
653 completion-emacs21-try-completion completion-emacs21-all-completions
654 "Simple prefix-based completion.
655 I.e. when completing \"foo_bar\" (where _ is the position of point),
656 it will consider all completions candidates matching the glob
657 pattern \"foobar*\".")
659 completion-emacs22-try-completion completion-emacs22-all-completions
660 "Prefix completion that only operates on the text before point.
661 I.e. when completing \"foo_bar\" (where _ is the position of point),
662 it will consider all completions candidates matching the glob
663 pattern \"foo*\" and will add back \"bar\" to the end of it.")
665 completion-basic-try-completion completion-basic-all-completions
666 "Completion of the prefix before point and the suffix after point.
667 I.e. when completing \"foo_bar\" (where _ is the position of point),
668 it will consider all completions candidates matching the glob
669 pattern \"foo*bar*\".")
671 completion-pcm-try-completion completion-pcm-all-completions
672 "Completion of multiple words, each one taken as a prefix.
673 I.e. when completing \"l-co_h\" (where _ is the position of point),
674 it will consider all completions candidates matching the glob
675 pattern \"l*-co*h*\".
676 Furthermore, for completions that are done step by step in subfields,
677 the method is applied to all the preceding fields that do not yet match.
678 E.g. C-x C-f /u/mo/s TAB could complete to /usr/monnier/src.
679 Additionally the user can use the char \"*\" as a glob pattern.")
681 completion-substring-try-completion completion-substring-all-completions
682 "Completion of the string taken as a substring.
683 I.e. when completing \"foo_bar\" (where _ is the position of point),
684 it will consider all completions candidates matching the glob
685 pattern \"*foo*bar*\".")
687 completion-initials-try-completion completion-initials-all-completions
688 "Completion of acronyms and initialisms.
689 E.g. can complete M-x lch to list-command-history
690 and C-x C-f ~/sew to ~/src/emacs/work."))
691 "List of available completion styles.
692 Each element has the form (NAME TRY-COMPLETION ALL-COMPLETIONS DOC):
693 where NAME is the name that should be used in `completion-styles',
694 TRY-COMPLETION is the function that does the completion (it should
695 follow the same calling convention as `completion-try-completion'),
696 ALL-COMPLETIONS is the function that lists the completions (it should
697 follow the calling convention of `completion-all-completions'),
698 and DOC describes the way this style of completion works.")
700 (defconst completion--styles-type
701 `(repeat :tag
"insert a new menu to add more styles"
702 (choice ,@(mapcar (lambda (x) (list 'const
(car x
)))
703 completion-styles-alist
))))
704 (defconst completion--cycling-threshold-type
705 '(choice (const :tag
"No cycling" nil
)
706 (const :tag
"Always cycle" t
)
707 (integer :tag
"Threshold")))
709 (defcustom completion-styles
710 ;; First, use `basic' because prefix completion has been the standard
711 ;; for "ever" and works well in most cases, so using it first
712 ;; ensures that we obey previous behavior in most cases.
714 ;; Then use `partial-completion' because it has proven to
715 ;; be a very convenient extension.
717 ;; Finally use `emacs22' so as to maintain (in many/most cases)
718 ;; the previous behavior that when completing "foobar" with point
719 ;; between "foo" and "bar" the completion try to complete "foo"
720 ;; and simply add "bar" to the end of the result.
722 "List of completion styles to use.
723 The available styles are listed in `completion-styles-alist'.
725 Note that `completion-category-overrides' may override these
726 styles for specific categories, such as files, buffers, etc."
727 :type completion--styles-type
731 (defcustom completion-category-overrides
732 '((buffer (styles .
(basic substring
))))
733 "List of `completion-styles' overrides for specific categories.
734 Each override has the shape (CATEGORY . ALIST) where ALIST is
735 an association list that can specify properties such as:
736 - `styles': the list of `completion-styles' to use for that category.
737 - `cycle': the `completion-cycle-threshold' to use for that category.
738 Categories are symbols such as `buffer' and `file', used when
739 completing buffer and file names, respectively."
741 :type
`(alist :key-type
(choice :tag
"Category"
747 (set :tag
"Properties to override"
748 (cons :tag
"Completion Styles"
749 (const :tag
"Select a style from the menu;" styles
)
750 ,completion--styles-type
)
751 (cons :tag
"Completion Cycling"
752 (const :tag
"Select one value from the menu." cycle
)
753 ,completion--cycling-threshold-type
))))
755 (defun completion--styles (metadata)
756 (let* ((cat (completion-metadata-get metadata
'category
))
757 (over (assq 'styles
(cdr (assq cat completion-category-overrides
)))))
759 (delete-dups (append (cdr over
) (copy-sequence completion-styles
)))
762 (defun completion--nth-completion (n string table pred point metadata
)
763 "Call the Nth method of completion styles."
766 (completion-metadata (substring string
0 point
) table pred
)))
767 ;; We provide special support for quoting/unquoting here because it cannot
768 ;; reliably be done within the normal completion-table routines: Completion
769 ;; styles such as `substring' or `partial-completion' need to match the
770 ;; output of all-completions with the user's input, and since most/all
771 ;; quoting mechanisms allow several equivalent quoted forms, the
772 ;; completion-style can't do this matching (e.g. `substring' doesn't know
773 ;; that "\a\b\e" is a valid (quoted) substring of "label").
774 ;; The quote/unquote function needs to come from the completion table (rather
775 ;; than from completion-extra-properties) because it may apply only to some
776 ;; part of the string (e.g. substitute-in-file-name).
778 (when (completion-metadata-get metadata
'completion--unquote-requote
)
779 (let ((new (funcall table string point
'completion--unquote
)))
780 (setq string
(pop new
))
781 (setq table
(pop new
))
782 (setq point
(pop new
))
785 (completion--some (lambda (style)
786 (funcall (nth n
(assq style
787 completion-styles-alist
))
788 string table pred point
))
789 (completion--styles metadata
))))
791 (funcall requote result n
)
794 (defun completion-try-completion (string table pred point
&optional metadata
)
795 "Try to complete STRING using completion table TABLE.
796 Only the elements of table that satisfy predicate PRED are considered.
797 POINT is the position of point within STRING.
798 The return value can be either nil to indicate that there is no completion,
799 t to indicate that STRING is the only possible completion,
800 or a pair (NEWSTRING . NEWPOINT) of the completed result string together with
801 a new position for point."
802 (completion--nth-completion 1 string table pred point metadata
))
804 (defun completion-all-completions (string table pred point
&optional metadata
)
805 "List the possible completions of STRING in completion table TABLE.
806 Only the elements of table that satisfy predicate PRED are considered.
807 POINT is the position of point within STRING.
808 The return value is a list of completions and may contain the base-size
810 ;; FIXME: We need to additionally return the info needed for the
811 ;; second part of completion-base-position.
812 (completion--nth-completion 2 string table pred point metadata
))
814 (defun minibuffer--bitset (modified completions exact
)
815 (logior (if modified
4 0)
819 (defun completion--replace (beg end newtext
)
820 "Replace the buffer text between BEG and END with NEWTEXT.
821 Moves point to the end of the new text."
822 ;; The properties on `newtext' include things like
823 ;; completions-first-difference, which we don't want to include
825 (set-text-properties 0 (length newtext
) nil newtext
)
826 ;; Maybe this should be in subr.el.
827 ;; You'd think this is trivial to do, but details matter if you want
828 ;; to keep markers "at the right place" and be robust in the face of
829 ;; after-change-functions that may themselves modify the buffer.
830 (let ((prefix-len 0))
831 ;; Don't touch markers in the shared prefix (if any).
832 (while (and (< prefix-len
(length newtext
))
833 (< (+ beg prefix-len
) end
)
834 (eq (char-after (+ beg prefix-len
))
835 (aref newtext prefix-len
)))
836 (setq prefix-len
(1+ prefix-len
)))
837 (unless (zerop prefix-len
)
838 (setq beg
(+ beg prefix-len
))
839 (setq newtext
(substring newtext prefix-len
))))
840 (let ((suffix-len 0))
841 ;; Don't touch markers in the shared suffix (if any).
842 (while (and (< suffix-len
(length newtext
))
843 (< beg
(- end suffix-len
))
844 (eq (char-before (- end suffix-len
))
845 (aref newtext
(- (length newtext
) suffix-len
1))))
846 (setq suffix-len
(1+ suffix-len
)))
847 (unless (zerop suffix-len
)
848 (setq end
(- end suffix-len
))
849 (setq newtext
(substring newtext
0 (- suffix-len
))))
851 (insert-and-inherit newtext
)
852 (delete-region (point) (+ (point) (- end beg
)))
853 (forward-char suffix-len
)))
855 (defcustom completion-cycle-threshold nil
856 "Number of completion candidates below which cycling is used.
857 Depending on this setting `minibuffer-complete' may use cycling,
858 like `minibuffer-force-complete'.
859 If nil, cycling is never used.
860 If t, cycling is always used.
861 If an integer, cycling is used as soon as there are fewer completion
862 candidates than this number."
864 :type completion--cycling-threshold-type
)
866 (defun completion--cycle-threshold (metadata)
867 (let* ((cat (completion-metadata-get metadata
'category
))
868 (over (assq 'cycle
(cdr (assq cat completion-category-overrides
)))))
869 (if over
(cdr over
) completion-cycle-threshold
)))
871 (defvar completion-all-sorted-completions nil
)
872 (make-variable-buffer-local 'completion-all-sorted-completions
)
873 (defvar completion-cycling nil
)
875 (defvar completion-fail-discreetly nil
876 "If non-nil, stay quiet when there is no match.")
878 (defun completion--message (msg)
879 (if completion-show-inline-help
880 (minibuffer-message msg
)))
882 (defun completion--do-completion (&optional try-completion-function
884 "Do the completion and return a summary of what happened.
885 M = completion was performed, the text was Modified.
886 C = there were available Completions.
887 E = after completion we now have an Exact match.
890 000 0 no possible completion
891 001 1 was already an exact and unique completion
892 010 2 no completion happened
893 011 3 was already an exact completion
896 110 6 some completion happened
897 111 7 completed to an exact completion
899 TRY-COMPLETION-FUNCTION is a function to use in place of `try-completion'.
900 EXPECT-EXACT, if non-nil, means that there is no need to tell the user
901 when the buffer's text is already an exact match."
902 (let* ((beg (field-beginning))
904 (string (buffer-substring beg end
))
905 (md (completion--field-metadata beg
))
906 (comp (funcall (or try-completion-function
907 'completion-try-completion
)
909 minibuffer-completion-table
910 minibuffer-completion-predicate
915 (minibuffer-hide-completions)
916 (unless completion-fail-discreetly
918 (completion--message "No match"))
919 (minibuffer--bitset nil nil nil
))
921 (minibuffer-hide-completions)
923 (completion--done string
'finished
924 (unless expect-exact
"Sole completion"))
925 (minibuffer--bitset nil nil t
)) ;Exact and unique match.
927 ;; `completed' should be t if some completion was done, which doesn't
928 ;; include simply changing the case of the entered string. However,
929 ;; for appearance, the string is rewritten if the case changes.
930 (let* ((comp-pos (cdr comp
))
931 (completion (car comp
))
932 (completed (not (eq t
(compare-strings completion nil nil
934 (unchanged (eq t
(compare-strings completion nil nil
935 string nil nil nil
))))
938 ;; Insert in minibuffer the chars we got.
939 (completion--replace beg end completion
))
940 ;; Move point to its completion-mandated destination.
941 (forward-char (- comp-pos
(length completion
)))
943 (if (not (or unchanged completed
))
944 ;; The case of the string changed, but that's all. We're not sure
945 ;; whether this is a unique completion or not, so try again using
946 ;; the real case (this shouldn't recurse again, because the next
947 ;; time try-completion will return either t or the exact string).
948 (completion--do-completion try-completion-function expect-exact
)
950 ;; It did find a match. Do we match some possibility exactly now?
951 (let* ((exact (test-completion completion
952 minibuffer-completion-table
953 minibuffer-completion-predicate
))
954 (threshold (completion--cycle-threshold md
))
956 ;; Check to see if we want to do cycling. We do it
957 ;; here, after having performed the normal completion,
958 ;; so as to take advantage of the difference between
959 ;; try-completion and all-completions, for things
960 ;; like completion-ignored-extensions.
962 ;; Check that the completion didn't make
963 ;; us jump to a different boundary.
965 (< (car (completion-boundaries
966 (substring completion
0 comp-pos
)
967 minibuffer-completion-table
968 minibuffer-completion-predicate
971 (completion-all-sorted-completions))))
972 (completion--flush-all-sorted-completions)
974 ((and (consp (cdr comps
)) ;; There's something to cycle.
976 ;; This signal an (intended) error if comps is too
977 ;; short or if completion-cycle-threshold is t.
978 (consp (nthcdr threshold comps
)))))
979 ;; Fewer than completion-cycle-threshold remaining
980 ;; completions: let's cycle.
981 (setq completed t exact t
)
982 (completion--cache-all-sorted-completions comps
)
983 (minibuffer-force-complete))
985 ;; We could also decide to refresh the completions,
986 ;; if they're displayed (and assuming there are
987 ;; completions left).
988 (minibuffer-hide-completions)
990 ;; If completion did not put point at end of field,
991 ;; it's a sign that completion is not finished.
992 (completion--done completion
993 (if (< comp-pos
(length completion
))
995 ;; Show the completion table, if requested.
997 (if (pcase completion-auto-help
998 (`lazy
(eq this-command last-command
))
999 (_ completion-auto-help
))
1000 (minibuffer-completion-help)
1001 (completion--message "Next char not unique")))
1002 ;; If the last exact completion and this one were the same, it
1003 ;; means we've already given a "Complete, but not unique" message
1004 ;; and the user's hit TAB again, so now we give him help.
1006 (if (and (eq this-command last-command
) completion-auto-help
)
1007 (minibuffer-completion-help))
1008 (completion--done completion
'exact
1009 (unless expect-exact
1010 "Complete, but not unique"))))
1012 (minibuffer--bitset completed t exact
))))))))
1014 (defun minibuffer-complete ()
1015 "Complete the minibuffer contents as far as possible.
1016 Return nil if there is no valid completion, else t.
1017 If no characters can be completed, display a list of possible completions.
1018 If you repeat this command after it displayed such a list,
1019 scroll the window of possible completions."
1021 ;; If the previous command was not this,
1022 ;; mark the completion buffer obsolete.
1023 (setq this-command
'completion-at-point
)
1024 (unless (eq 'completion-at-point last-command
)
1025 (completion--flush-all-sorted-completions)
1026 (setq minibuffer-scroll-window nil
))
1029 ;; If there's a fresh completion window with a live buffer,
1030 ;; and this command is repeated, scroll that window.
1031 ((window-live-p minibuffer-scroll-window
)
1032 (let ((window minibuffer-scroll-window
))
1033 (with-current-buffer (window-buffer window
)
1034 (if (pos-visible-in-window-p (point-max) window
)
1035 ;; If end is in view, scroll up to the beginning.
1036 (set-window-start window
(point-min) nil
)
1037 ;; Else scroll down one screen.
1038 (scroll-other-window))
1040 ;; If we're cycling, keep on cycling.
1041 ((and completion-cycling completion-all-sorted-completions
)
1042 (minibuffer-force-complete)
1044 (t (pcase (completion--do-completion)
1048 (defun completion--cache-all-sorted-completions (comps)
1049 (add-hook 'after-change-functions
1050 'completion--flush-all-sorted-completions nil t
)
1051 (setq completion-all-sorted-completions comps
))
1053 (defun completion--flush-all-sorted-completions (&rest _ignore
)
1054 (remove-hook 'after-change-functions
1055 'completion--flush-all-sorted-completions t
)
1056 (setq completion-cycling nil
)
1057 (setq completion-all-sorted-completions nil
))
1059 (defun completion--metadata (string base md-at-point table pred
)
1060 ;; Like completion-metadata, but for the specific case of getting the
1061 ;; metadata at `base', which tends to trigger pathological behavior for old
1062 ;; completion tables which don't understand `metadata'.
1063 (let ((bounds (completion-boundaries string table pred
"")))
1064 (if (eq (car bounds
) base
) md-at-point
1065 (completion-metadata (substring string
0 base
) table pred
))))
1067 (defun completion-all-sorted-completions ()
1068 (or completion-all-sorted-completions
1069 (let* ((start (field-beginning))
1071 (string (buffer-substring start end
))
1072 (md (completion--field-metadata start
))
1073 (all (completion-all-completions
1075 minibuffer-completion-table
1076 minibuffer-completion-predicate
1080 (base-size (or (cdr last
) 0))
1081 (all-md (completion--metadata (buffer-substring-no-properties
1084 minibuffer-completion-table
1085 minibuffer-completion-predicate
))
1086 (sort-fun (completion-metadata-get all-md
'cycle-sort-function
)))
1089 (setq all
(if sort-fun
(funcall sort-fun all
)
1090 ;; Prefer shorter completions, by default.
1091 (sort all
(lambda (c1 c2
) (< (length c1
) (length c2
))))))
1092 ;; Prefer recently used completions.
1094 (let ((hist (symbol-value minibuffer-history-variable
)))
1095 (setq all
(sort all
(lambda (c1 c2
)
1096 (> (length (member c1 hist
))
1097 (length (member c2 hist
))))))))
1098 ;; Cache the result. This is not just for speed, but also so that
1099 ;; repeated calls to minibuffer-force-complete can cycle through
1100 ;; all possibilities.
1101 (completion--cache-all-sorted-completions (nconc all base-size
))))))
1103 (defun minibuffer-force-complete ()
1104 "Complete the minibuffer to an exact match.
1105 Repeated uses step through the possible completions."
1107 ;; FIXME: Need to deal with the extra-size issue here as well.
1108 ;; FIXME: ~/src/emacs/t<M-TAB>/lisp/minibuffer.el completes to
1109 ;; ~/src/emacs/trunk/ and throws away lisp/minibuffer.el.
1110 (let* ((start (field-beginning))
1112 ;; (md (completion--field-metadata start))
1113 (all (completion-all-sorted-completions))
1114 (base (+ start
(or (cdr (last all
)) 0))))
1117 (completion--message
1118 (if all
"No more completions" "No completions")))
1119 ((not (consp (cdr all
)))
1120 (let ((mod (equal (car all
) (buffer-substring-no-properties base end
))))
1121 (if mod
(completion--replace base end
(car all
)))
1122 (completion--done (buffer-substring-no-properties start
(point))
1123 'finished
(unless mod
"Sole completion"))))
1125 (completion--replace base end
(car all
))
1126 (completion--done (buffer-substring-no-properties start
(point)) 'sole
)
1127 ;; Set cycling after modifying the buffer since the flush hook resets it.
1128 (setq completion-cycling t
)
1129 ;; If completing file names, (car all) may be a directory, so we'd now
1130 ;; have a new set of possible completions and might want to reset
1131 ;; completion-all-sorted-completions to nil, but we prefer not to,
1132 ;; so that repeated calls minibuffer-force-complete still cycle
1133 ;; through the previous possible completions.
1134 (let ((last (last all
)))
1135 (setcdr last
(cons (car all
) (cdr last
)))
1136 (completion--cache-all-sorted-completions (cdr all
)))))))
1138 (defvar minibuffer-confirm-exit-commands
1139 '(completion-at-point minibuffer-complete
1140 minibuffer-complete-word PC-complete PC-complete-word
)
1141 "A list of commands which cause an immediately following
1142 `minibuffer-complete-and-exit' to ask for extra confirmation.")
1144 (defun minibuffer-complete-and-exit ()
1145 "Exit if the minibuffer contains a valid completion.
1146 Otherwise, try to complete the minibuffer contents. If
1147 completion leads to a valid completion, a repetition of this
1150 If `minibuffer-completion-confirm' is `confirm', do not try to
1151 complete; instead, ask for confirmation and accept any input if
1153 If `minibuffer-completion-confirm' is `confirm-after-completion',
1154 do not try to complete; instead, ask for confirmation if the
1155 preceding minibuffer command was a member of
1156 `minibuffer-confirm-exit-commands', and accept the input
1159 (let ((beg (field-beginning))
1162 ;; Allow user to specify null string
1163 ((= beg end
) (exit-minibuffer))
1164 ((test-completion (buffer-substring beg end
)
1165 minibuffer-completion-table
1166 minibuffer-completion-predicate
)
1167 ;; FIXME: completion-ignore-case has various slightly
1168 ;; incompatible meanings. E.g. it can reflect whether the user
1169 ;; wants completion to pay attention to case, or whether the
1170 ;; string will be used in a context where case is significant.
1171 ;; E.g. usually try-completion should obey the first, whereas
1172 ;; test-completion should obey the second.
1173 (when completion-ignore-case
1174 ;; Fixup case of the field, if necessary.
1175 (let* ((string (buffer-substring beg end
))
1176 (compl (try-completion
1178 minibuffer-completion-table
1179 minibuffer-completion-predicate
)))
1180 (when (and (stringp compl
) (not (equal string compl
))
1181 ;; If it weren't for this piece of paranoia, I'd replace
1182 ;; the whole thing with a call to do-completion.
1183 ;; This is important, e.g. when the current minibuffer's
1184 ;; content is a directory which only contains a single
1185 ;; file, so `try-completion' actually completes to
1187 (= (length string
) (length compl
)))
1188 (completion--replace beg end compl
))))
1191 ((memq minibuffer-completion-confirm
'(confirm confirm-after-completion
))
1192 ;; The user is permitted to exit with an input that's rejected
1193 ;; by test-completion, after confirming her choice.
1194 (if (or (eq last-command this-command
)
1195 ;; For `confirm-after-completion' we only ask for confirmation
1196 ;; if trying to exit immediately after typing TAB (this
1197 ;; catches most minibuffer typos).
1198 (and (eq minibuffer-completion-confirm
'confirm-after-completion
)
1199 (not (memq last-command minibuffer-confirm-exit-commands
))))
1201 (minibuffer-message "Confirm")
1205 ;; Call do-completion, but ignore errors.
1206 (pcase (condition-case nil
1207 (completion--do-completion nil
'expect-exact
)
1209 ((or #b001
#b011
) (exit-minibuffer))
1210 (#b111
(if (not minibuffer-completion-confirm
)
1212 (minibuffer-message "Confirm")
1216 (defun completion--try-word-completion (string table predicate point md
)
1217 (let ((comp (completion-try-completion string table predicate point md
)))
1218 (if (not (consp comp
))
1221 ;; If completion finds next char not unique,
1222 ;; consider adding a space or a hyphen.
1223 (when (= (length string
) (length (car comp
)))
1224 ;; Mark the added char with the `completion-word' property, so it
1225 ;; can be handled specially by completion styles such as
1226 ;; partial-completion.
1227 ;; We used to remove `partial-completion' from completion-styles
1228 ;; instead, but it was too blunt, leading to situations where SPC
1229 ;; was the only insertable char at point but minibuffer-complete-word
1230 ;; refused inserting it.
1231 (let ((exts (mapcar (lambda (str) (propertize str
'completion-try-word t
))
1233 (before (substring string
0 point
))
1234 (after (substring string point
))
1236 (while (and exts
(not (consp tem
)))
1237 (setq tem
(completion-try-completion
1238 (concat before
(pop exts
) after
)
1239 table predicate
(1+ point
) md
)))
1240 (if (consp tem
) (setq comp tem
))))
1242 ;; Completing a single word is actually more difficult than completing
1243 ;; as much as possible, because we first have to find the "current
1244 ;; position" in `completion' in order to find the end of the word
1245 ;; we're completing. Normally, `string' is a prefix of `completion',
1246 ;; which makes it trivial to find the position, but with fancier
1247 ;; completion (plus env-var expansion, ...) `completion' might not
1248 ;; look anything like `string' at all.
1249 (let* ((comppoint (cdr comp
))
1250 (completion (car comp
))
1251 (before (substring string
0 point
))
1252 (combined (concat before
"\n" completion
)))
1253 ;; Find in completion the longest text that was right before point.
1254 (when (string-match "\\(.+\\)\n.*?\\1" combined
)
1255 (let* ((prefix (match-string 1 before
))
1256 ;; We used non-greedy match to make `rem' as long as possible.
1257 (rem (substring combined
(match-end 0)))
1258 ;; Find in the remainder of completion the longest text
1259 ;; that was right after point.
1260 (after (substring string point
))
1261 (suffix (if (string-match "\\`\\(.+\\).*\n.*\\1"
1262 (concat after
"\n" rem
))
1263 (match-string 1 after
))))
1264 ;; The general idea is to try and guess what text was inserted
1265 ;; at point by the completion. Problem is: if we guess wrong,
1266 ;; we may end up treating as "added by completion" text that was
1267 ;; actually painfully typed by the user. So if we then cut
1268 ;; after the first word, we may throw away things the
1269 ;; user wrote. So let's try to be as conservative as possible:
1270 ;; only cut after the first word, if we're reasonably sure that
1271 ;; our guess is correct.
1272 ;; Note: a quick survey on emacs-devel seemed to indicate that
1273 ;; nobody actually cares about the "word-at-a-time" feature of
1274 ;; minibuffer-complete-word, whose real raison-d'être is that it
1275 ;; tries to add "-" or " ". One more reason to only cut after
1276 ;; the first word, if we're really sure we're right.
1277 (when (and (or suffix
(zerop (length after
)))
1278 (string-match (concat
1279 ;; Make submatch 1 as small as possible
1280 ;; to reduce the risk of cutting
1282 ".*" (regexp-quote prefix
) "\\(.*?\\)"
1283 (if suffix
(regexp-quote suffix
) "\\'"))
1285 ;; The new point in `completion' should also be just
1286 ;; before the suffix, otherwise something more complex
1287 ;; is going on, and we're not sure where we are.
1288 (eq (match-end 1) comppoint
)
1289 ;; (match-beginning 1)..comppoint is now the stretch
1290 ;; of text in `completion' that was completed at point.
1291 (string-match "\\W" completion
(match-beginning 1))
1292 ;; Is there really something to cut?
1293 (> comppoint
(match-end 0)))
1294 ;; Cut after the first word.
1295 (let ((cutpos (match-end 0)))
1296 (setq completion
(concat (substring completion
0 cutpos
)
1297 (substring completion comppoint
)))
1298 (setq comppoint cutpos
)))))
1300 (cons completion comppoint
)))))
1303 (defun minibuffer-complete-word ()
1304 "Complete the minibuffer contents at most a single word.
1305 After one word is completed as much as possible, a space or hyphen
1306 is added, provided that matches some possible completion.
1307 Return nil if there is no valid completion, else t."
1309 (pcase (completion--do-completion 'completion--try-word-completion
)
1313 (defface completions-annotations
'((t :inherit italic
))
1314 "Face to use for annotations in the *Completions* buffer.")
1316 (defcustom completions-format
'horizontal
1317 "Define the appearance and sorting of completions.
1318 If the value is `vertical', display completions sorted vertically
1319 in columns in the *Completions* buffer.
1320 If the value is `horizontal', display completions sorted
1321 horizontally in alphabetical order, rather than down the screen."
1322 :type
'(choice (const horizontal
) (const vertical
))
1326 (defun completion--insert-strings (strings)
1327 "Insert a list of STRINGS into the current buffer.
1328 Uses columns to keep the listing readable but compact.
1329 It also eliminates runs of equal strings."
1330 (when (consp strings
)
1331 (let* ((length (apply 'max
1334 (+ (string-width (car s
))
1335 (string-width (cadr s
)))
1338 (window (get-buffer-window (current-buffer) 0))
1339 (wwidth (if window
(1- (window-width window
)) 79))
1341 ;; At least 2 columns; at least 2 spaces between columns.
1342 (max 2 (/ wwidth
(+ 2 length
)))
1343 ;; Don't allocate more columns than we can fill.
1344 ;; Windows can't show less than 3 lines anyway.
1345 (max 1 (/ (length strings
) 2))))
1346 (colwidth (/ wwidth columns
))
1348 (rows (/ (length strings
) columns
))
1352 ;; The insertion should be "sensible" no matter what choices were made
1353 ;; for the parameters above.
1354 (dolist (str strings
)
1355 (unless (equal laststring str
) ; Remove (consecutive) duplicates.
1356 (setq laststring str
)
1357 ;; FIXME: `string-width' doesn't pay attention to
1358 ;; `display' properties.
1359 (let ((length (if (consp str
)
1360 (+ (string-width (car str
))
1361 (string-width (cadr str
)))
1362 (string-width str
))))
1364 ((eq completions-format
'vertical
)
1367 (forward-line (- -
1 rows
))
1368 (setq row
0 column
(+ column colwidth
)))
1371 (while (> (current-column) column
)
1377 (set-text-properties (1- (point)) (point)
1378 `(display (space :align-to
,column
)))))
1380 ;; Horizontal format
1382 (if (< wwidth
(+ (max colwidth length
) column
))
1383 ;; No space for `str' at point, move to next line.
1384 (progn (insert "\n") (setq column
0))
1386 ;; Leave the space unpropertized so that in the case we're
1387 ;; already past the goal column, there is still
1388 ;; a space displayed.
1389 (set-text-properties (1- (point)) (point)
1390 ;; We can't just set tab-width, because
1391 ;; completion-setup-function will kill
1392 ;; all local variables :-(
1393 `(display (space :align-to
,column
)))
1396 (if (not (consp str
))
1397 (put-text-property (point) (progn (insert str
) (point))
1398 'mouse-face
'highlight
)
1399 (put-text-property (point) (progn (insert (car str
)) (point))
1400 'mouse-face
'highlight
)
1401 (add-text-properties (point) (progn (insert (cadr str
)) (point))
1403 face completions-annotations
)))
1405 ((eq completions-format
'vertical
)
1410 (setq row
(1+ row
)))
1412 ;; Horizontal format
1413 ;; Next column to align to.
1414 (setq column
(+ column
1415 ;; Round up to a whole number of columns.
1416 (* colwidth
(ceiling length colwidth
))))))))))))
1418 (defvar completion-common-substring nil
)
1419 (make-obsolete-variable 'completion-common-substring nil
"23.1")
1421 (defvar completion-setup-hook nil
1422 "Normal hook run at the end of setting up a completion list buffer.
1423 When this hook is run, the current buffer is the one in which the
1424 command to display the completion list buffer was run.
1425 The completion list buffer is available as the value of `standard-output'.
1426 See also `display-completion-list'.")
1428 (defface completions-first-difference
1429 '((t (:inherit bold
)))
1430 "Face put on the first uncommon character in completions in *Completions* buffer."
1433 (defface completions-common-part
1434 '((t (:inherit default
)))
1435 "Face put on the common prefix substring in completions in *Completions* buffer.
1436 The idea of `completions-common-part' is that you can use it to
1437 make the common parts less visible than normal, so that the rest
1438 of the differing parts is, by contrast, slightly highlighted."
1441 (defun completion-hilit-commonality (completions prefix-len base-size
)
1443 (let ((com-str-len (- prefix-len
(or base-size
0))))
1448 ;; Don't modify the string itself, but a copy, since the
1449 ;; the string may be read-only or used for other purposes.
1450 ;; Furthermore, since `completions' may come from
1451 ;; display-completion-list, `elem' may be a list.
1453 (car (setq elem
(cons (copy-sequence (car elem
))
1455 (setq elem
(copy-sequence elem
)))))
1456 (put-text-property 0
1457 ;; If completion-boundaries returns incorrect
1458 ;; values, all-completions may return strings
1459 ;; that don't contain the prefix.
1460 (min com-str-len
(length str
))
1461 'font-lock-face
'completions-common-part
1463 (if (> (length str
) com-str-len
)
1464 (put-text-property com-str-len
(1+ com-str-len
)
1465 'font-lock-face
'completions-first-difference
1471 (defun display-completion-list (completions &optional common-substring
)
1472 "Display the list of completions, COMPLETIONS, using `standard-output'.
1473 Each element may be just a symbol or string
1474 or may be a list of two strings to be printed as if concatenated.
1475 If it is a list of two strings, the first is the actual completion
1476 alternative, the second serves as annotation.
1477 `standard-output' must be a buffer.
1478 The actual completion alternatives, as inserted, are given `mouse-face'
1479 properties of `highlight'.
1480 At the end, this runs the normal hook `completion-setup-hook'.
1481 It can find the completion buffer in `standard-output'.
1483 The obsolete optional arg COMMON-SUBSTRING, if non-nil, should be a string
1484 specifying a common substring for adding the faces
1485 `completions-first-difference' and `completions-common-part' to
1486 the completions buffer."
1487 (if common-substring
1488 (setq completions
(completion-hilit-commonality
1489 completions
(length common-substring
)
1490 ;; We don't know the base-size.
1492 (if (not (bufferp standard-output
))
1493 ;; This *never* (ever) happens, so there's no point trying to be clever.
1495 (let ((standard-output (current-buffer))
1496 (completion-setup-hook nil
))
1497 (display-completion-list completions common-substring
))
1498 (princ (buffer-string)))
1500 (with-current-buffer standard-output
1501 (goto-char (point-max))
1502 (if (null completions
)
1503 (insert "There are no possible completions of what you have typed.")
1504 (insert "Possible completions are:\n")
1505 (completion--insert-strings completions
))))
1507 ;; The hilit used to be applied via completion-setup-hook, so there
1508 ;; may still be some code that uses completion-common-substring.
1510 (let ((completion-common-substring common-substring
))
1511 (run-hooks 'completion-setup-hook
)))
1514 (defvar completion-extra-properties nil
1515 "Property list of extra properties of the current completion job.
1518 `:annotation-function': Function to annotate the completions buffer.
1519 The function must accept one argument, a completion string,
1520 and return either nil or a string which is to be displayed
1521 next to the completion (but which is not part of the
1522 completion). The function can access the completion data via
1523 `minibuffer-completion-table' and related variables.
1525 `:exit-function': Function to run after completion is performed.
1527 The function must accept two arguments, STRING and STATUS.
1528 STRING is the text to which the field was completed, and
1529 STATUS indicates what kind of operation happened:
1530 `finished' - text is now complete
1531 `sole' - text cannot be further completed but
1532 completion is not finished
1533 `exact' - text is a valid completion but may be further
1536 (defvar completion-annotate-function
1538 ;; Note: there's a lot of scope as for when to add annotations and
1539 ;; what annotations to add. E.g. completing-help.el allowed adding
1540 ;; the first line of docstrings to M-x completion. But there's
1541 ;; a tension, since such annotations, while useful at times, can
1542 ;; actually drown the useful information.
1543 ;; So completion-annotate-function should be used parsimoniously, or
1544 ;; else only used upon a user's request (e.g. we could add a command
1545 ;; to completion-list-mode to add annotations to the current
1547 "Function to add annotations in the *Completions* buffer.
1548 The function takes a completion and should either return nil, or a string that
1549 will be displayed next to the completion. The function can access the
1550 completion table and predicates via `minibuffer-completion-table' and related
1552 (make-obsolete-variable 'completion-annotate-function
1553 'completion-extra-properties
"24.1")
1555 (defun completion--done (string &optional finished message
)
1556 (let* ((exit-fun (plist-get completion-extra-properties
:exit-function
))
1557 (pre-msg (and exit-fun
(current-message))))
1558 (cl-assert (memq finished
'(exact sole finished unknown
)))
1559 ;; FIXME: exit-fun should receive `finished' as a parameter.
1561 (when (eq finished
'unknown
)
1563 (if (eq (try-completion string
1564 minibuffer-completion-table
1565 minibuffer-completion-predicate
)
1568 (funcall exit-fun string finished
))
1570 ;; Don't output any message if the exit-fun already did so.
1571 (equal pre-msg
(and exit-fun
(current-message))))
1572 (completion--message message
))))
1574 (defun minibuffer-completion-help ()
1575 "Display a list of possible completions of the current minibuffer contents."
1577 (message "Making completion list...")
1578 (let* ((start (field-beginning))
1580 (string (field-string))
1581 (md (completion--field-metadata start
))
1582 (completions (completion-all-completions
1584 minibuffer-completion-table
1585 minibuffer-completion-predicate
1586 (- (point) (field-beginning))
1589 (if (or (null completions
)
1590 (and (not (consp (cdr completions
)))
1591 (equal (car completions
) string
)))
1593 ;; If there are no completions, or if the current input is already
1594 ;; the sole completion, then hide (previous&stale) completions.
1595 (minibuffer-hide-completions)
1598 (if completions
"Sole completion" "No completions")))
1600 (let* ((last (last completions
))
1601 (base-size (cdr last
))
1602 (prefix (unless (zerop base-size
) (substring string
0 base-size
)))
1603 (all-md (completion--metadata (buffer-substring-no-properties
1606 minibuffer-completion-table
1607 minibuffer-completion-predicate
))
1608 (afun (or (completion-metadata-get all-md
'annotation-function
)
1609 (plist-get completion-extra-properties
1610 :annotation-function
)
1611 completion-annotate-function
))
1612 ;; If the *Completions* buffer is shown in a new
1613 ;; window, mark it as softly-dedicated, so bury-buffer in
1614 ;; minibuffer-hide-completions will know whether to
1615 ;; delete the window or not.
1616 (display-buffer-mark-dedicated 'soft
))
1617 (with-output-to-temp-buffer "*Completions*"
1618 ;; Remove the base-size tail because `sort' requires a properly
1619 ;; nil-terminated list.
1620 (when last
(setcdr last nil
))
1622 ;; FIXME: This function is for the output of all-completions,
1623 ;; not completion-all-completions. Often it's the same, but
1625 (let ((sort-fun (completion-metadata-get
1626 all-md
'display-sort-function
)))
1628 (funcall sort-fun completions
)
1629 (sort completions
'string-lessp
))))
1633 (let ((ann (funcall afun s
)))
1634 (if ann
(list s ann
) s
)))
1637 (with-current-buffer standard-output
1638 (set (make-local-variable 'completion-base-position
)
1639 (list (+ start base-size
)
1640 ;; FIXME: We should pay attention to completion
1641 ;; boundaries here, but currently
1642 ;; completion-all-completions does not give us the
1643 ;; necessary information.
1645 (set (make-local-variable 'completion-list-insert-choice-function
)
1646 (let ((ctable minibuffer-completion-table
)
1647 (cpred minibuffer-completion-predicate
)
1648 (cprops completion-extra-properties
))
1649 (lambda (start end choice
)
1650 (unless (or (zerop (length prefix
))
1652 (buffer-substring-no-properties
1654 (- start
(length prefix
)))
1656 (message "*Completions* out of date"))
1657 ;; FIXME: Use `md' to do quoting&terminator here.
1658 (completion--replace start end choice
)
1659 (let* ((minibuffer-completion-table ctable
)
1660 (minibuffer-completion-predicate cpred
)
1661 (completion-extra-properties cprops
)
1662 (result (concat prefix choice
))
1663 (bounds (completion-boundaries
1664 result ctable cpred
"")))
1665 ;; If the completion introduces a new field, then
1666 ;; completion is not finished.
1667 (completion--done result
1668 (if (eq (car bounds
) (length result
))
1669 'exact
'finished
)))))))
1671 (display-completion-list completions
))))
1674 (defun minibuffer-hide-completions ()
1675 "Get rid of an out-of-date *Completions* buffer."
1676 ;; FIXME: We could/should use minibuffer-scroll-window here, but it
1677 ;; can also point to the minibuffer-parent-window, so it's a bit tricky.
1678 (let ((win (get-buffer-window "*Completions*" 0)))
1679 (if win
(with-selected-window win
(bury-buffer)))))
1681 (defun exit-minibuffer ()
1682 "Terminate this minibuffer argument."
1684 ;; If the command that uses this has made modifications in the minibuffer,
1685 ;; we don't want them to cause deactivation of the mark in the original
1687 ;; A better solution would be to make deactivate-mark buffer-local
1688 ;; (or to turn it into a list of buffers, ...), but in the mean time,
1689 ;; this should do the trick in most cases.
1690 (setq deactivate-mark nil
)
1693 (defun self-insert-and-exit ()
1694 "Terminate minibuffer input."
1696 (if (characterp last-command-event
)
1697 (call-interactively 'self-insert-command
)
1701 (defvar completion-in-region-functions nil
1702 "Wrapper hook around `completion-in-region'.
1703 The functions on this special hook are called with 5 arguments:
1704 NEXT-FUN START END COLLECTION PREDICATE.
1705 NEXT-FUN is a function of four arguments (START END COLLECTION PREDICATE)
1706 that performs the default operation. The other four arguments are like
1707 the ones passed to `completion-in-region'. The functions on this hook
1708 are expected to perform completion on START..END using COLLECTION
1709 and PREDICATE, either by calling NEXT-FUN or by doing it themselves.")
1711 (defvar completion-in-region--data nil
)
1713 (defvar completion-in-region-mode-predicate nil
1714 "Predicate to tell `completion-in-region-mode' when to exit.
1715 It is called with no argument and should return nil when
1716 `completion-in-region-mode' should exit (and hence pop down
1717 the *Completions* buffer).")
1719 (defvar completion-in-region-mode--predicate nil
1720 "Copy of the value of `completion-in-region-mode-predicate'.
1721 This holds the value `completion-in-region-mode-predicate' had when
1722 we entered `completion-in-region-mode'.")
1724 (defun completion-in-region (start end collection
&optional predicate
)
1725 "Complete the text between START and END using COLLECTION.
1726 Return nil if there is no valid completion, else t.
1727 Point needs to be somewhere between START and END.
1728 PREDICATE (a function called with no arguments) says when to
1730 (cl-assert (<= start
(point)) (<= (point) end
))
1732 ;; FIXME: Maybe we should use this hook to provide a "display
1733 ;; completions" operation as well.
1734 completion-in-region-functions
(start end collection predicate
)
1735 (let ((minibuffer-completion-table collection
)
1736 (minibuffer-completion-predicate predicate
)
1737 (ol (make-overlay start end nil nil t
)))
1738 (overlay-put ol
'field
'completion
)
1739 ;; HACK: if the text we are completing is already in a field, we
1740 ;; want the completion field to take priority (e.g. Bug#6830).
1741 (overlay-put ol
'priority
100)
1742 (when completion-in-region-mode-predicate
1743 (completion-in-region-mode 1)
1744 (setq completion-in-region--data
1745 (list (current-buffer) start end collection
)))
1747 (call-interactively 'minibuffer-complete
)
1748 (delete-overlay ol
)))))
1750 (defvar completion-in-region-mode-map
1751 (let ((map (make-sparse-keymap)))
1752 ;; FIXME: Only works if completion-in-region-mode was activated via
1753 ;; completion-at-point called directly.
1754 (define-key map
"\M-?" 'completion-help-at-point
)
1755 (define-key map
"\t" 'completion-at-point
)
1757 "Keymap activated during `completion-in-region'.")
1759 ;; It is difficult to know when to exit completion-in-region-mode (i.e. hide
1760 ;; the *Completions*).
1761 ;; - lisp-mode: never.
1762 ;; - comint: only do it if you hit SPC at the right time.
1763 ;; - pcomplete: pop it down on SPC or after some time-delay.
1764 ;; - semantic: use a post-command-hook check similar to this one.
1765 (defun completion-in-region--postch ()
1766 (or unread-command-events
;Don't pop down the completions in the middle of
1767 ;mouse-drag-region/mouse-set-point.
1768 (and completion-in-region--data
1769 (and (eq (car completion-in-region--data
)
1771 (>= (point) (nth 1 completion-in-region--data
))
1774 (goto-char (nth 2 completion-in-region--data
))
1775 (line-end-position)))
1776 (funcall completion-in-region-mode--predicate
)))
1777 (completion-in-region-mode -
1)))
1779 ;; (defalias 'completion-in-region--prech 'completion-in-region--postch)
1781 (define-minor-mode completion-in-region-mode
1782 "Transient minor mode used during `completion-in-region'.
1783 With a prefix argument ARG, enable the modemode if ARG is
1784 positive, and disable it otherwise. If called from Lisp, enable
1785 the mode if ARG is omitted or nil."
1787 (setq completion-in-region--data nil
)
1788 ;; (remove-hook 'pre-command-hook #'completion-in-region--prech)
1789 (remove-hook 'post-command-hook
#'completion-in-region--postch
)
1790 (setq minor-mode-overriding-map-alist
1791 (delq (assq 'completion-in-region-mode minor-mode-overriding-map-alist
)
1792 minor-mode-overriding-map-alist
))
1793 (if (null completion-in-region-mode
)
1794 (unless (equal "*Completions*" (buffer-name (window-buffer)))
1795 (minibuffer-hide-completions))
1796 ;; (add-hook 'pre-command-hook #'completion-in-region--prech)
1797 (cl-assert completion-in-region-mode-predicate
)
1798 (setq completion-in-region-mode--predicate
1799 completion-in-region-mode-predicate
)
1800 (add-hook 'post-command-hook
#'completion-in-region--postch
)
1801 (push `(completion-in-region-mode .
,completion-in-region-mode-map
)
1802 minor-mode-overriding-map-alist
)))
1804 ;; Define-minor-mode added our keymap to minor-mode-map-alist, but we want it
1805 ;; on minor-mode-overriding-map-alist instead.
1806 (setq minor-mode-map-alist
1807 (delq (assq 'completion-in-region-mode minor-mode-map-alist
)
1808 minor-mode-map-alist
))
1810 (defvar completion-at-point-functions
'(tags-completion-at-point-function)
1811 "Special hook to find the completion table for the thing at point.
1812 Each function on this hook is called in turns without any argument and should
1813 return either nil to mean that it is not applicable at point,
1814 or a function of no argument to perform completion (discouraged),
1815 or a list of the form (START END COLLECTION . PROPS) where
1816 START and END delimit the entity to complete and should include point,
1817 COLLECTION is the completion table to use to complete it, and
1818 PROPS is a property list for additional information.
1819 Currently supported properties are all the properties that can appear in
1820 `completion-extra-properties' plus:
1821 `:predicate' a predicate that completion candidates need to satisfy.
1822 `:exclusive' If `no', means that if the completion table fails to
1823 match the text at point, then instead of reporting a completion
1824 failure, the completion should try the next completion function.
1825 As is the case with most hooks, the functions are responsible to preserve
1826 things like point and current buffer.")
1828 (defvar completion--capf-misbehave-funs nil
1829 "List of functions found on `completion-at-point-functions' that misbehave.
1830 These are functions that neither return completion data nor a completion
1831 function but instead perform completion right away.")
1832 (defvar completion--capf-safe-funs nil
1833 "List of well-behaved functions found on `completion-at-point-functions'.
1834 These are functions which return proper completion data rather than
1835 a completion function or god knows what else.")
1837 (defun completion--capf-wrapper (fun which
)
1838 ;; FIXME: The safe/misbehave handling assumes that a given function will
1839 ;; always return the same kind of data, but this breaks down with functions
1840 ;; like comint-completion-at-point or mh-letter-completion-at-point, which
1841 ;; could be sometimes safe and sometimes misbehaving (and sometimes neither).
1844 (`safe
(member fun completion--capf-safe-funs
))
1845 (`optimist
(not (member fun completion--capf-misbehave-funs
))))
1846 (let ((res (funcall fun
)))
1848 ((and (consp res
) (not (functionp res
)))
1849 (unless (member fun completion--capf-safe-funs
)
1850 (push fun completion--capf-safe-funs
))
1851 (and (eq 'no
(plist-get (nthcdr 3 res
) :exclusive
))
1852 ;; FIXME: Here we'd need to decide whether there are
1853 ;; valid completions against the current text. But this depends
1854 ;; on the actual completion UI (e.g. with the default completion
1855 ;; it depends on completion-style) ;-(
1856 ;; We approximate this result by checking whether prefix
1857 ;; completion might work, which means that non-prefix completion
1858 ;; will not work (or not right) for completion functions that
1859 ;; are non-exclusive.
1860 (null (try-completion (buffer-substring-no-properties
1863 (plist-get (nthcdr 3 res
) :predicate
)))
1865 ((not (or (listp res
) (functionp res
)))
1866 (unless (member fun completion--capf-misbehave-funs
)
1868 "Completion function %S uses a deprecated calling convention" fun
)
1869 (push fun completion--capf-misbehave-funs
))))
1870 (if res
(cons fun res
)))))
1872 (defun completion-at-point ()
1873 "Perform completion on the text around point.
1874 The completion method is determined by `completion-at-point-functions'."
1876 (let ((res (run-hook-wrapped 'completion-at-point-functions
1877 #'completion--capf-wrapper
'all
)))
1879 (`(,_ .
,(and (pred functionp
) f
)) (funcall f
))
1880 (`(,hookfun .
(,start
,end
,collection .
,plist
))
1881 (let* ((completion-extra-properties plist
)
1882 (completion-in-region-mode-predicate
1884 ;; We're still in the same completion field.
1885 (eq (car-safe (funcall hookfun
)) start
))))
1886 (completion-in-region start end collection
1887 (plist-get plist
:predicate
))))
1888 ;; Maybe completion already happened and the function returned t.
1891 (defun completion-help-at-point ()
1892 "Display the completions on the text around point.
1893 The completion method is determined by `completion-at-point-functions'."
1895 (let ((res (run-hook-wrapped 'completion-at-point-functions
1896 ;; Ignore misbehaving functions.
1897 #'completion--capf-wrapper
'optimist
)))
1899 (`(,_ .
,(and (pred functionp
) f
))
1900 (message "Don't know how to show completions for %S" f
))
1901 (`(,hookfun .
(,start
,end
,collection .
,plist
))
1902 (let* ((minibuffer-completion-table collection
)
1903 (minibuffer-completion-predicate (plist-get plist
:predicate
))
1904 (completion-extra-properties plist
)
1905 (completion-in-region-mode-predicate
1907 ;; We're still in the same completion field.
1908 (eq (car-safe (funcall hookfun
)) start
)))
1909 (ol (make-overlay start end nil nil t
)))
1910 ;; FIXME: We should somehow (ab)use completion-in-region-function or
1911 ;; introduce a corresponding hook (plus another for word-completion,
1912 ;; and another for force-completion, maybe?).
1913 (overlay-put ol
'field
'completion
)
1914 (overlay-put ol
'priority
100)
1915 (completion-in-region-mode 1)
1916 (setq completion-in-region--data
1917 (list (current-buffer) start end collection
))
1919 (call-interactively 'minibuffer-completion-help
)
1920 (delete-overlay ol
))))
1922 ;; The hook function already performed completion :-(
1923 ;; Not much we can do at this point.
1924 (message "%s already performed completion!" hookfun
)
1926 (_ (message "Nothing to complete at point")))))
1930 (let ((map minibuffer-local-map
))
1931 (define-key map
"\C-g" 'abort-recursive-edit
)
1932 (define-key map
"\r" 'exit-minibuffer
)
1933 (define-key map
"\n" 'exit-minibuffer
))
1935 (defvar minibuffer-local-completion-map
1936 (let ((map (make-sparse-keymap)))
1937 (set-keymap-parent map minibuffer-local-map
)
1938 (define-key map
"\t" 'minibuffer-complete
)
1939 ;; M-TAB is already abused for many other purposes, so we should find
1940 ;; another binding for it.
1941 ;; (define-key map "\e\t" 'minibuffer-force-complete)
1942 (define-key map
" " 'minibuffer-complete-word
)
1943 (define-key map
"?" 'minibuffer-completion-help
)
1945 "Local keymap for minibuffer input with completion.")
1947 (defvar minibuffer-local-must-match-map
1948 (let ((map (make-sparse-keymap)))
1949 (set-keymap-parent map minibuffer-local-completion-map
)
1950 (define-key map
"\r" 'minibuffer-complete-and-exit
)
1951 (define-key map
"\n" 'minibuffer-complete-and-exit
)
1953 "Local keymap for minibuffer input with completion, for exact match.")
1955 (defvar minibuffer-local-filename-completion-map
1956 (let ((map (make-sparse-keymap)))
1957 (define-key map
" " nil
)
1959 "Local keymap for minibuffer input with completion for filenames.
1960 Gets combined either with `minibuffer-local-completion-map' or
1961 with `minibuffer-local-must-match-map'.")
1963 (define-obsolete-variable-alias 'minibuffer-local-must-match-filename-map
1964 'minibuffer-local-filename-must-match-map
"23.1")
1965 (defvar minibuffer-local-filename-must-match-map
(make-sparse-keymap))
1966 (make-obsolete-variable 'minibuffer-local-filename-must-match-map nil
"24.1")
1968 (let ((map minibuffer-local-ns-map
))
1969 (define-key map
" " 'exit-minibuffer
)
1970 (define-key map
"\t" 'exit-minibuffer
)
1971 (define-key map
"?" 'self-insert-and-exit
))
1973 (defvar minibuffer-inactive-mode-map
1974 (let ((map (make-keymap)))
1975 (suppress-keymap map
)
1976 (define-key map
"e" 'find-file-other-frame
)
1977 (define-key map
"f" 'find-file-other-frame
)
1978 (define-key map
"b" 'switch-to-buffer-other-frame
)
1979 (define-key map
"i" 'info
)
1980 (define-key map
"m" 'mail
)
1981 (define-key map
"n" 'make-frame
)
1982 (define-key map
[mouse-1
] (lambda () (interactive)
1983 (with-current-buffer "*Messages*"
1984 (goto-char (point-max))
1985 (display-buffer (current-buffer)))))
1986 ;; So the global down-mouse-1 binding doesn't clutter the execution of the
1987 ;; above mouse-1 binding.
1988 (define-key map
[down-mouse-1
] #'ignore
)
1990 "Keymap for use in the minibuffer when it is not active.
1991 The non-mouse bindings in this keymap can only be used in minibuffer-only
1992 frames, since the minibuffer can normally not be selected when it is
1995 (define-derived-mode minibuffer-inactive-mode nil
"InactiveMinibuffer"
1996 :abbrev-table nil
;abbrev.el is not loaded yet during dump.
1997 ;; Note: this major mode is called from minibuf.c.
1998 "Major mode to use in the minibuffer when it is not active.
1999 This is only used when the minibuffer area has no active minibuffer.")
2001 ;;; Completion tables.
2003 (defun minibuffer--double-dollars (str)
2004 ;; Reuse the actual "$" from the string to preserve any text-property it
2005 ;; might have, such as `face'.
2006 (replace-regexp-in-string "\\$" (lambda (dollar) (concat dollar dollar
))
2009 (defun completion--make-envvar-table ()
2010 (mapcar (lambda (enventry)
2011 (substring enventry
0 (string-match-p "=" enventry
)))
2012 process-environment
))
2014 (defconst completion--embedded-envvar-re
2015 (concat "\\(?:^\\|[^$]\\(?:\\$\\$\\)*\\)"
2016 "$\\([[:alnum:]_]*\\|{\\([^}]*\\)\\)\\'"))
2018 (defun completion--embedded-envvar-table (string _pred action
)
2019 "Completion table for envvars embedded in a string.
2020 The envvar syntax (and escaping) rules followed by this table are the
2021 same as `substitute-in-file-name'."
2022 ;; We ignore `pred', because the predicates passed to us via
2023 ;; read-file-name-internal are not 100% correct and fail here:
2024 ;; e.g. we get predicates like file-directory-p there, whereas the filename
2025 ;; completed needs to be passed through substitute-in-file-name before it
2026 ;; can be passed to file-directory-p.
2027 (when (string-match completion--embedded-envvar-re string
)
2028 (let* ((beg (or (match-beginning 2) (match-beginning 1)))
2029 (table (completion--make-envvar-table))
2030 (prefix (substring string
0 beg
)))
2032 ((eq action
'lambda
)
2033 ;; This table is expected to be used in conjunction with some
2034 ;; other table that provides the "main" completion. Let the
2035 ;; other table handle the test-completion case.
2037 ((or (eq (car-safe action
) 'boundaries
) (eq action
'metadata
))
2038 ;; Only return boundaries/metadata if there's something to complete,
2039 ;; since otherwise when we're used in
2040 ;; completion-table-in-turn, we could return boundaries and
2041 ;; let some subsequent table return a list of completions.
2042 ;; FIXME: Maybe it should rather be fixed in
2043 ;; completion-table-in-turn instead, but it's difficult to
2044 ;; do it efficiently there.
2045 (when (try-completion (substring string beg
) table nil
)
2046 ;; Compute the boundaries of the subfield to which this
2047 ;; completion applies.
2048 (if (eq action
'metadata
)
2049 '(metadata (category . environment-variable
))
2050 (let ((suffix (cdr action
)))
2052 ,(or (match-beginning 2) (match-beginning 1))
2053 .
,(when (string-match "[^[:alnum:]_]" suffix
)
2054 (match-beginning 0)))))))
2056 (if (eq (aref string
(1- beg
)) ?
{)
2057 (setq table
(apply-partially 'completion-table-with-terminator
2059 ;; Even if file-name completion is case-insensitive, we want
2060 ;; envvar completion to be case-sensitive.
2061 (let ((completion-ignore-case nil
))
2062 (completion-table-with-context
2063 prefix table
(substring string beg
) nil action
)))))))
2065 (defun completion-file-name-table (string pred action
)
2066 "Completion table for file names."
2069 ((eq action
'metadata
) '(metadata (category . file
)))
2070 ((string-match-p "\\`~[^/\\]*\\'" string
)
2071 (completion-table-with-context "~"
2072 (mapcar (lambda (u) (concat u
"/"))
2074 (substring string
1)
2076 ((eq (car-safe action
) 'boundaries
)
2077 (let ((start (length (file-name-directory string
)))
2078 (end (string-match-p "/" (cdr action
))))
2080 ;; if `string' is "C:" in w32, (file-name-directory string)
2081 ;; returns "C:/", so `start' is 3 rather than 2.
2082 ;; Not quite sure what is The Right Fix, but clipping it
2083 ;; back to 2 will work for this particular case. We'll
2084 ;; see if we can come up with a better fix when we bump
2085 ;; into more such problematic cases.
2086 ,(min start
(length string
)) .
,end
)))
2088 ((eq action
'lambda
)
2089 (if (zerop (length string
))
2090 nil
;Not sure why it's here, but it probably doesn't harm.
2091 (funcall (or pred
'file-exists-p
) string
)))
2094 (let* ((name (file-name-nondirectory string
))
2095 (specdir (file-name-directory string
))
2096 (realdir (or specdir default-directory
)))
2100 (let ((comp (file-name-completion name realdir pred
)))
2102 (concat specdir comp
)
2106 (let ((all (file-name-all-completions name realdir
)))
2108 ;; Check the predicate, if necessary.
2109 (unless (memq pred
'(nil file-exists-p
))
2112 (if (eq pred
'file-directory-p
)
2113 ;; Brute-force speed up for directory checking:
2114 ;; Discard strings which don't end in a slash.
2116 (let ((len (length s
)))
2117 (and (> len
0) (eq (aref s
(1- len
)) ?
/))))
2118 ;; Must do it the hard (and slow) way.
2120 (let ((default-directory (expand-file-name realdir
)))
2122 (if (funcall pred tem
) (push tem comp
))))
2123 (setq all
(nreverse comp
))))
2126 (file-error nil
))) ;PCM often calls with invalid directories.
2128 (defvar read-file-name-predicate nil
2129 "Current predicate used by `read-file-name-internal'.")
2130 (make-obsolete-variable 'read-file-name-predicate
2131 "use the regular PRED argument" "23.2")
2133 (defun completion--sifn-requote (upos qstr
)
2134 ;; We're looking for `qupos' such that:
2135 ;; (equal (substring (substitute-in-file-name qstr) 0 upos)
2136 ;; (substitute-in-file-name (substring qstr 0 qupos)))
2137 ;; Big problem here: we have to reverse engineer substitute-in-file-name to
2138 ;; find the position corresponding to UPOS in QSTR, but
2139 ;; substitute-in-file-name can do anything, depending on file-name-handlers.
2140 ;; Kind of like in rfn-eshadow-update-overlay, only worse.
2141 ;; FIXME: example of thing we do not handle: Tramp's makes
2142 ;; (substitute-in-file-name "/foo:~/bar//baz") -> "/scpc:foo:/baz".
2143 ;; FIXME: One way to try and handle "all" cases is to require
2144 ;; substitute-in-file-name to preserve text-properties, so we could
2145 ;; apply text-properties to the input string and then look for them in
2146 ;; the output to understand what comes from where.
2148 ;; Handle substitute-in-file-name's truncation behavior.
2150 (while (and (string-match "[\\/][~/\\]" qstr qpos
)
2151 ;; Hopefully our regexp covers all truncation cases.
2152 ;; Also let's make sure sifn indeed truncates here.
2154 (setq tpos
(1+ (match-beginning 0)))
2155 (equal (substitute-in-file-name qstr
)
2156 (substitute-in-file-name (substring qstr tpos
)))))
2158 ;; `upos' is relative to the position corresponding to `qpos' in
2159 ;; (substitute-in-file-name qstr), so as qpos moves forward, upos
2161 (while (and (> upos
0)
2162 (string-match "\\$\\(\\$\\|\\([[:alnum:]_]+\\|{[^}]*}\\)\\)?"
2165 ((>= (- (match-beginning 0) qpos
) upos
) ; UPOS is before current match.
2166 (setq qpos
(+ qpos upos
))
2168 ((not (match-end 1)) ;A sole $: probably an error.
2169 (setq upos
(- upos
(- (match-end 0) qpos
)))
2170 (setq qpos
(match-end 0)))
2172 (setq upos
(- upos
(- (match-beginning 0) qpos
)))
2173 (setq qpos
(match-end 0))
2174 (setq upos
(- upos
(length (substitute-in-file-name
2175 (match-string 0 qstr
))))))))
2176 ;; If `upos' is negative, it's because it's within the expansion of an
2177 ;; envvar, i.e. there is no exactly matching qpos, so we just use the next
2178 ;; available qpos right after the envvar.
2179 (cons (if (>= upos
0) (+ qpos upos
) qpos
)
2180 #'minibuffer--double-dollars
)))
2182 (defalias 'completion--file-name-table
2183 (completion-table-with-quoting #'completion-file-name-table
2184 #'substitute-in-file-name
2185 #'completion--sifn-requote
)
2186 "Internal subroutine for `read-file-name'. Do not call this.
2187 This is a completion table for file names, like `completion-file-name-table'
2188 except that it passes the file name through `substitute-in-file-name'.")
2190 (defalias 'read-file-name-internal
2191 (completion-table-in-turn #'completion--embedded-envvar-table
2192 #'completion--file-name-table
)
2193 "Internal subroutine for `read-file-name'. Do not call this.")
2195 (defvar read-file-name-function
'read-file-name-default
2196 "The function called by `read-file-name' to do its work.
2197 It should accept the same arguments as `read-file-name'.")
2199 (defcustom read-file-name-completion-ignore-case
2200 (if (memq system-type
'(ms-dos windows-nt darwin cygwin
))
2202 "Non-nil means when reading a file name completion ignores case."
2207 (defcustom insert-default-directory t
2208 "Non-nil means when reading a filename start with default dir in minibuffer.
2210 When the initial minibuffer contents show a name of a file or a directory,
2211 typing RETURN without editing the initial contents is equivalent to typing
2212 the default file name.
2214 If this variable is non-nil, the minibuffer contents are always
2215 initially non-empty, and typing RETURN without editing will fetch the
2216 default name, if one is provided. Note however that this default name
2217 is not necessarily the same as initial contents inserted in the minibuffer,
2218 if the initial contents is just the default directory.
2220 If this variable is nil, the minibuffer often starts out empty. In
2221 that case you may have to explicitly fetch the next history element to
2222 request the default name; typing RETURN without editing will leave
2223 the minibuffer empty.
2225 For some commands, exiting with an empty minibuffer has a special meaning,
2226 such as making the current buffer visit no file in the case of
2227 `set-visited-file-name'."
2231 ;; Not always defined, but only called if next-read-file-uses-dialog-p says so.
2232 (declare-function x-file-dialog
"xfns.c"
2233 (prompt dir
&optional default-filename mustmatch only-dir-p
))
2235 (defun read-file-name--defaults (&optional dir initial
)
2238 ;; With non-nil `initial', use `dir' as the first default.
2239 ;; Essentially, this mean reversing the normal order of the
2240 ;; current directory name and the current file name, i.e.
2241 ;; 1. with normal file reading:
2242 ;; 1.1. initial input is the current directory
2243 ;; 1.2. the first default is the current file name
2244 ;; 2. with non-nil `initial' (e.g. for `find-alternate-file'):
2245 ;; 2.2. initial input is the current file name
2246 ;; 2.1. the first default is the current directory
2247 (initial (abbreviate-file-name dir
))
2248 ;; In file buffers, try to get the current file name
2250 (abbreviate-file-name buffer-file-name
))))
2252 (run-hook-with-args-until-success 'file-name-at-point-functions
)))
2253 (when file-name-at-point
2254 (setq default
(delete-dups
2255 (delete "" (delq nil
(list file-name-at-point default
))))))
2256 ;; Append new defaults to the end of existing `minibuffer-default'.
2258 (if (listp minibuffer-default
) minibuffer-default
(list minibuffer-default
))
2259 (if (listp default
) default
(list default
)))))
2261 (defun read-file-name (prompt &optional dir default-filename mustmatch initial predicate
)
2262 "Read file name, prompting with PROMPT and completing in directory DIR.
2263 Value is not expanded---you must call `expand-file-name' yourself.
2265 DIR is the directory to use for completing relative file names.
2266 It should be an absolute directory name, or nil (which means the
2267 current buffer's value of `default-directory').
2269 DEFAULT-FILENAME specifies the default file name to return if the
2270 user exits the minibuffer with the same non-empty string inserted
2271 by this function. If DEFAULT-FILENAME is a string, that serves
2272 as the default. If DEFAULT-FILENAME is a list of strings, the
2273 first string is the default. If DEFAULT-FILENAME is omitted or
2274 nil, then if INITIAL is non-nil, the default is DIR combined with
2275 INITIAL; otherwise, if the current buffer is visiting a file,
2276 that file serves as the default; otherwise, the default is simply
2277 the string inserted into the minibuffer.
2279 If the user exits with an empty minibuffer, return an empty
2280 string. (This happens only if the user erases the pre-inserted
2281 contents, or if `insert-default-directory' is nil.)
2283 Fourth arg MUSTMATCH can take the following values:
2284 - nil means that the user can exit with any input.
2285 - t means that the user is not allowed to exit unless
2286 the input is (or completes to) an existing file.
2287 - `confirm' means that the user can exit with any input, but she needs
2288 to confirm her choice if the input is not an existing file.
2289 - `confirm-after-completion' means that the user can exit with any
2290 input, but she needs to confirm her choice if she called
2291 `minibuffer-complete' right before `minibuffer-complete-and-exit'
2292 and the input is not an existing file.
2293 - anything else behaves like t except that typing RET does not exit if it
2294 does non-null completion.
2296 Fifth arg INITIAL specifies text to start with.
2298 Sixth arg PREDICATE, if non-nil, should be a function of one
2299 argument; then a file name is considered an acceptable completion
2300 alternative only if PREDICATE returns non-nil with the file name
2303 If this command was invoked with the mouse, use a graphical file
2304 dialog if `use-dialog-box' is non-nil, and the window system or X
2305 toolkit in use provides a file dialog box, and DIR is not a
2306 remote file. For graphical file dialogs, any of the special values
2307 of MUSTMATCH `confirm' and `confirm-after-completion' are
2308 treated as equivalent to nil. Some graphical file dialogs respect
2309 a MUSTMATCH value of t, and some do not (or it only has a cosmetic
2310 effect, and does not actually prevent the user from entering a
2313 See also `read-file-name-completion-ignore-case'
2314 and `read-file-name-function'."
2315 ;; If x-gtk-use-old-file-dialog = t (xg_get_file_with_selection),
2316 ;; then MUSTMATCH is enforced. But with newer Gtk
2317 ;; (xg_get_file_with_chooser), it only has a cosmetic effect.
2318 ;; The user can still type a non-existent file name.
2319 (funcall (or read-file-name-function
#'read-file-name-default
)
2320 prompt dir default-filename mustmatch initial predicate
))
2322 (defvar minibuffer-local-filename-syntax
2323 (let ((table (make-syntax-table))
2324 (punctuation (car (string-to-syntax "."))))
2325 ;; Convert all punctuation entries to symbol.
2326 (map-char-table (lambda (c syntax
)
2327 (when (eq (car syntax
) punctuation
)
2328 (modify-syntax-entry c
"_" table
)))
2332 (modify-syntax-entry c
"." table
))
2335 "Syntax table to be used in minibuffer for reading file name.")
2337 ;; minibuffer-completing-file-name is a variable used internally in minibuf.c
2338 ;; to determine whether to use minibuffer-local-filename-completion-map or
2339 ;; minibuffer-local-completion-map. It shouldn't be exported to Elisp.
2340 ;; FIXME: Actually, it is also used in rfn-eshadow.el we'd otherwise have to
2341 ;; use (eq minibuffer-completion-table #'read-file-name-internal), which is
2342 ;; probably even worse. Maybe We should add some read-file-name-setup-hook
2343 ;; instead, but for now, let's keep this non-obsolete.
2344 ;;(make-obsolete-variable 'minibuffer-completing-file-name nil "future" 'get)
2346 (defun read-file-name-default (prompt &optional dir default-filename mustmatch initial predicate
)
2347 "Default method for reading file names.
2348 See `read-file-name' for the meaning of the arguments."
2349 (unless dir
(setq dir default-directory
))
2350 (unless (file-name-absolute-p dir
) (setq dir
(expand-file-name dir
)))
2351 (unless default-filename
2352 (setq default-filename
(if initial
(expand-file-name initial dir
)
2354 ;; If dir starts with user's homedir, change that to ~.
2355 (setq dir
(abbreviate-file-name dir
))
2356 ;; Likewise for default-filename.
2357 (if default-filename
2358 (setq default-filename
2359 (if (consp default-filename
)
2360 (mapcar 'abbreviate-file-name default-filename
)
2361 (abbreviate-file-name default-filename
))))
2363 ((and insert-default-directory
(stringp dir
))
2365 (cons (minibuffer--double-dollars (concat dir initial
))
2366 (length (minibuffer--double-dollars dir
)))
2367 (minibuffer--double-dollars dir
)))
2368 (initial (cons (minibuffer--double-dollars initial
) 0)))))
2370 (let ((completion-ignore-case read-file-name-completion-ignore-case
)
2371 (minibuffer-completing-file-name t
)
2372 (pred (or predicate
'file-exists-p
))
2373 (add-to-history nil
))
2376 (if (or (not (next-read-file-uses-dialog-p))
2377 ;; Graphical file dialogs can't handle remote
2379 (file-remote-p dir
))
2380 ;; We used to pass `dir' to `read-file-name-internal' by
2381 ;; abusing the `predicate' argument. It's better to
2382 ;; just use `default-directory', but in order to avoid
2383 ;; changing `default-directory' in the current buffer,
2384 ;; we don't let-bind it.
2385 (let ((dir (file-name-as-directory
2386 (expand-file-name dir
))))
2387 (minibuffer-with-setup-hook
2389 (setq default-directory dir
)
2390 ;; When the first default in `minibuffer-default'
2391 ;; duplicates initial input `insdef',
2392 ;; reset `minibuffer-default' to nil.
2393 (when (equal (or (car-safe insdef
) insdef
)
2394 (or (car-safe minibuffer-default
)
2395 minibuffer-default
))
2396 (setq minibuffer-default
2397 (cdr-safe minibuffer-default
)))
2398 ;; On the first request on `M-n' fill
2399 ;; `minibuffer-default' with a list of defaults
2400 ;; relevant for file-name reading.
2401 (set (make-local-variable 'minibuffer-default-add-function
)
2403 (with-current-buffer
2404 (window-buffer (minibuffer-selected-window))
2405 (read-file-name--defaults dir initial
))))
2406 (set-syntax-table minibuffer-local-filename-syntax
))
2407 (completing-read prompt
'read-file-name-internal
2408 pred mustmatch insdef
2409 'file-name-history default-filename
)))
2410 ;; If DEFAULT-FILENAME not supplied and DIR contains
2411 ;; a file name, split it.
2412 (let ((file (file-name-nondirectory dir
))
2413 ;; When using a dialog, revert to nil and non-nil
2414 ;; interpretation of mustmatch. confirm options
2415 ;; need to be interpreted as nil, otherwise
2416 ;; it is impossible to create new files using
2417 ;; dialogs with the default settings.
2419 (not (memq mustmatch
2420 '(nil confirm confirm-after-completion
)))))
2421 (when (and (not default-filename
)
2422 (not (zerop (length file
))))
2423 (setq default-filename file
)
2424 (setq dir
(file-name-directory dir
)))
2425 (when default-filename
2426 (setq default-filename
2427 (expand-file-name (if (consp default-filename
)
2428 (car default-filename
)
2431 (setq add-to-history t
)
2432 (x-file-dialog prompt dir default-filename
2434 (eq predicate
'file-directory-p
)))))
2436 (replace-in-history (eq (car-safe file-name-history
) val
)))
2437 ;; If completing-read returned the inserted default string itself
2438 ;; (rather than a new string with the same contents),
2439 ;; it has to mean that the user typed RET with the minibuffer empty.
2440 ;; In that case, we really want to return ""
2441 ;; so that commands such as set-visited-file-name can distinguish.
2442 (when (consp default-filename
)
2443 (setq default-filename
(car default-filename
)))
2444 (when (eq val default-filename
)
2445 ;; In this case, completing-read has not added an element
2446 ;; to the history. Maybe we should.
2447 (if (not replace-in-history
)
2448 (setq add-to-history t
))
2450 (unless val
(error "No file name specified"))
2452 (if (and default-filename
2453 (string-equal val
(if (consp insdef
) (car insdef
) insdef
)))
2454 (setq val default-filename
))
2455 (setq val
(substitute-in-file-name val
))
2457 (if replace-in-history
2458 ;; Replace what Fcompleting_read added to the history
2459 ;; with what we will actually return. As an exception,
2460 ;; if that's the same as the second item in
2461 ;; file-name-history, it's really a repeat (Bug#4657).
2462 (let ((val1 (minibuffer--double-dollars val
)))
2463 (if history-delete-duplicates
2464 (setcdr file-name-history
2465 (delete val1
(cdr file-name-history
))))
2466 (if (string= val1
(cadr file-name-history
))
2467 (pop file-name-history
)
2468 (setcar file-name-history val1
)))
2470 ;; Add the value to the history--but not if it matches
2471 ;; the last value already there.
2472 (let ((val1 (minibuffer--double-dollars val
)))
2473 (unless (and (consp file-name-history
)
2474 (equal (car file-name-history
) val1
))
2475 (setq file-name-history
2477 (if history-delete-duplicates
2478 (delete val1 file-name-history
)
2479 file-name-history
)))))))
2482 (defun internal-complete-buffer-except (&optional buffer
)
2483 "Perform completion on all buffers excluding BUFFER.
2484 BUFFER nil or omitted means use the current buffer.
2485 Like `internal-complete-buffer', but removes BUFFER from the completion list."
2486 (let ((except (if (stringp buffer
) buffer
(buffer-name buffer
))))
2487 (apply-partially 'completion-table-with-predicate
2488 'internal-complete-buffer
2490 (not (equal (if (consp name
) (car name
) name
) except
)))
2493 ;;; Old-style completion, used in Emacs-21 and Emacs-22.
2495 (defun completion-emacs21-try-completion (string table pred _point
)
2496 (let ((completion (try-completion string table pred
)))
2497 (if (stringp completion
)
2498 (cons completion
(length completion
))
2501 (defun completion-emacs21-all-completions (string table pred _point
)
2502 (completion-hilit-commonality
2503 (all-completions string table pred
)
2505 (car (completion-boundaries string table pred
""))))
2507 (defun completion-emacs22-try-completion (string table pred point
)
2508 (let ((suffix (substring string point
))
2509 (completion (try-completion (substring string
0 point
) table pred
)))
2510 (if (not (stringp completion
))
2512 ;; Merge a trailing / in completion with a / after point.
2513 ;; We used to only do it for word completion, but it seems to make
2514 ;; sense for all completions.
2515 ;; Actually, claiming this feature was part of Emacs-22 completion
2516 ;; is pushing it a bit: it was only done in minibuffer-completion-word,
2517 ;; which was (by default) not bound during file completion, where such
2518 ;; slashes are most likely to occur.
2519 (if (and (not (zerop (length completion
)))
2520 (eq ?
/ (aref completion
(1- (length completion
))))
2521 (not (zerop (length suffix
)))
2522 (eq ?
/ (aref suffix
0)))
2523 ;; This leaves point after the / .
2524 (setq suffix
(substring suffix
1)))
2525 (cons (concat completion suffix
) (length completion
)))))
2527 (defun completion-emacs22-all-completions (string table pred point
)
2528 (let ((beforepoint (substring string
0 point
)))
2529 (completion-hilit-commonality
2530 (all-completions beforepoint table pred
)
2532 (car (completion-boundaries beforepoint table pred
"")))))
2534 ;;; Basic completion.
2536 (defun completion--merge-suffix (completion point suffix
)
2537 "Merge end of COMPLETION with beginning of SUFFIX.
2538 Simple generalization of the \"merge trailing /\" done in Emacs-22.
2539 Return the new suffix."
2540 (if (and (not (zerop (length suffix
)))
2541 (string-match "\\(.+\\)\n\\1" (concat completion
"\n" suffix
)
2542 ;; Make sure we don't compress things to less
2543 ;; than we started with.
2545 ;; Just make sure we didn't match some other \n.
2546 (eq (match-end 1) (length completion
)))
2547 (substring suffix
(- (match-end 1) (match-beginning 1)))
2548 ;; Nothing to merge.
2551 (defun completion-basic--pattern (beforepoint afterpoint bounds
)
2553 "" (list (substring beforepoint
(car bounds
))
2555 (substring afterpoint
0 (cdr bounds
)))))
2557 (defun completion-basic-try-completion (string table pred point
)
2558 (let* ((beforepoint (substring string
0 point
))
2559 (afterpoint (substring string point
))
2560 (bounds (completion-boundaries beforepoint table pred afterpoint
)))
2561 (if (zerop (cdr bounds
))
2562 ;; `try-completion' may return a subtly different result
2563 ;; than `all+merge', so try to use it whenever possible.
2564 (let ((completion (try-completion beforepoint table pred
)))
2565 (if (not (stringp completion
))
2569 (completion--merge-suffix completion point afterpoint
))
2570 (length completion
))))
2571 (let* ((suffix (substring afterpoint
(cdr bounds
)))
2572 (prefix (substring beforepoint
0 (car bounds
)))
2574 "" (list (substring beforepoint
(car bounds
))
2576 (substring afterpoint
0 (cdr bounds
)))))
2577 (all (completion-pcm--all-completions prefix pattern table pred
)))
2578 (if minibuffer-completing-file-name
2579 (setq all
(completion-pcm--filename-try-filter all
)))
2580 (completion-pcm--merge-try pattern all prefix suffix
)))))
2582 (defun completion-basic-all-completions (string table pred point
)
2583 (let* ((beforepoint (substring string
0 point
))
2584 (afterpoint (substring string point
))
2585 (bounds (completion-boundaries beforepoint table pred afterpoint
))
2586 ;; (suffix (substring afterpoint (cdr bounds)))
2587 (prefix (substring beforepoint
0 (car bounds
)))
2589 "" (list (substring beforepoint
(car bounds
))
2591 (substring afterpoint
0 (cdr bounds
)))))
2592 (all (completion-pcm--all-completions prefix pattern table pred
)))
2593 (completion-hilit-commonality all point
(car bounds
))))
2595 ;;; Partial-completion-mode style completion.
2597 (defvar completion-pcm--delim-wild-regex nil
2598 "Regular expression matching delimiters controlling the partial-completion.
2599 Typically, this regular expression simply matches a delimiter, meaning
2600 that completion can add something at (match-beginning 0), but if it has
2601 a submatch 1, then completion can add something at (match-end 1).
2602 This is used when the delimiter needs to be of size zero (e.g. the transition
2603 from lowercase to uppercase characters).")
2605 (defun completion-pcm--prepare-delim-re (delims)
2606 (setq completion-pcm--delim-wild-regex
(concat "[" delims
"*]")))
2608 (defcustom completion-pcm-word-delimiters
"-_./:| "
2609 "A string of characters treated as word delimiters for completion.
2611 If `]' is in this string, it must come first.
2612 If `^' is in this string, it must not come first.
2613 If `-' is in this string, it must come first or right after `]'.
2614 In other words, if S is this string, then `[S]' must be a valid Emacs regular
2615 expression (not containing character ranges like `a-z')."
2616 :set
(lambda (symbol value
)
2617 (set-default symbol value
)
2618 ;; Refresh other vars.
2619 (completion-pcm--prepare-delim-re value
))
2620 :initialize
'custom-initialize-reset
2624 (defcustom completion-pcm-complete-word-inserts-delimiters nil
2625 "Treat the SPC or - inserted by `minibuffer-complete-word' as delimiters.
2626 Those chars are treated as delimiters iff this variable is non-nil.
2627 I.e. if non-nil, M-x SPC will just insert a \"-\" in the minibuffer, whereas
2628 if nil, it will list all possible commands in *Completions* because none of
2629 the commands start with a \"-\" or a SPC."
2633 (defun completion-pcm--pattern-trivial-p (pattern)
2634 (and (stringp (car pattern
))
2635 ;; It can be followed by `point' and "" and still be trivial.
2637 (dolist (elem (cdr pattern
))
2638 (unless (member elem
'(point ""))
2639 (setq trivial nil
)))
2642 (defun completion-pcm--string->pattern
(string &optional point
)
2643 "Split STRING into a pattern.
2644 A pattern is a list where each element is either a string
2645 or a symbol, see `completion-pcm--merge-completions'."
2646 (if (and point
(< point
(length string
)))
2647 (let ((prefix (substring string
0 point
))
2648 (suffix (substring string point
)))
2649 (append (completion-pcm--string->pattern prefix
)
2651 (completion-pcm--string->pattern suffix
)))
2652 (let* ((pattern nil
)
2656 (while (and (setq p
(string-match completion-pcm--delim-wild-regex
2658 (or completion-pcm-complete-word-inserts-delimiters
2659 ;; If the char was added by minibuffer-complete-word,
2660 ;; then don't treat it as a delimiter, otherwise
2661 ;; "M-x SPC" ends up inserting a "-" rather than listing
2663 (not (get-text-property p
'completion-try-word string
))))
2664 ;; Usually, completion-pcm--delim-wild-regex matches a delimiter,
2665 ;; meaning that something can be added *before* it, but it can also
2666 ;; match a prefix and postfix, in which case something can be added
2667 ;; in-between (e.g. match [[:lower:]][[:upper:]]).
2668 ;; This is determined by the presence of a submatch-1 which delimits
2670 (if (match-end 1) (setq p
(match-end 1)))
2671 (push (substring string p0 p
) pattern
)
2672 (if (eq (aref string p
) ?
*)
2674 (push 'star pattern
)
2680 ;; An empty string might be erroneously added at the beginning.
2681 ;; It should be avoided properly, but it's so easy to remove it here.
2682 (delete "" (nreverse (cons (substring string p0
) pattern
))))))
2684 (defun completion-pcm--pattern->regex
(pattern &optional group
)
2690 ((stringp x
) (regexp-quote x
))
2691 ((if (consp group
) (memq x group
) group
) "\\(.*?\\)")
2695 ;; Avoid pathological backtracking.
2696 (while (string-match "\\.\\*\\?\\(?:\\\\[()]\\)*\\(\\.\\*\\?\\)" re
)
2697 (setq re
(replace-match "" t t re
1)))
2700 (defun completion-pcm--all-completions (prefix pattern table pred
)
2701 "Find all completions for PATTERN in TABLE obeying PRED.
2702 PATTERN is as returned by `completion-pcm--string->pattern'."
2703 ;; (cl-assert (= (car (completion-boundaries prefix table pred ""))
2704 ;; (length prefix)))
2705 ;; Find an initial list of possible completions.
2706 (if (completion-pcm--pattern-trivial-p pattern
)
2708 ;; Minibuffer contains no delimiters -- simple case!
2709 (all-completions (concat prefix
(car pattern
)) table pred
)
2711 ;; Use all-completions to do an initial cull. This is a big win,
2712 ;; since all-completions is written in C!
2713 (let* (;; Convert search pattern to a standard regular expression.
2714 (regex (completion-pcm--pattern->regex pattern
))
2715 (case-fold-search completion-ignore-case
)
2716 (completion-regexp-list (cons regex completion-regexp-list
))
2717 (compl (all-completions
2719 (if (stringp (car pattern
)) (car pattern
) ""))
2721 (if (not (functionp table
))
2722 ;; The internal functions already obeyed completion-regexp-list.
2726 (when (string-match-p regex c
) (push c poss
)))
2729 (defun completion-pcm--hilit-commonality (pattern completions
)
2731 (let* ((re (completion-pcm--pattern->regex pattern
'(point)))
2732 (case-fold-search completion-ignore-case
))
2735 ;; Don't modify the string itself.
2736 (setq str
(copy-sequence str
))
2737 (unless (string-match re str
)
2738 (error "Internal error: %s does not match %s" re str
))
2739 (let ((pos (or (match-beginning 1) (match-end 0))))
2740 (put-text-property 0 pos
2741 'font-lock-face
'completions-common-part
2743 (if (> (length str
) pos
)
2744 (put-text-property pos
(1+ pos
)
2745 'font-lock-face
'completions-first-difference
2750 (defun completion-pcm--find-all-completions (string table pred point
2752 "Find all completions for STRING at POINT in TABLE, satisfying PRED.
2753 POINT is a position inside STRING.
2754 FILTER is a function applied to the return value, that can be used, e.g. to
2755 filter out additional entries (because TABLE might not obey PRED)."
2756 (unless filter
(setq filter
'identity
))
2757 (let* ((beforepoint (substring string
0 point
))
2758 (afterpoint (substring string point
))
2759 (bounds (completion-boundaries beforepoint table pred afterpoint
))
2760 (prefix (substring beforepoint
0 (car bounds
)))
2761 (suffix (substring afterpoint
(cdr bounds
)))
2763 (setq string
(substring string
(car bounds
) (+ point
(cdr bounds
))))
2764 (let* ((relpoint (- point
(car bounds
)))
2765 (pattern (completion-pcm--string->pattern string relpoint
))
2766 (all (condition-case err
2768 (completion-pcm--all-completions
2769 prefix pattern table pred
))
2770 (error (unless firsterror
(setq firsterror err
)) nil
))))
2771 (when (and (null all
)
2773 (null (ignore-errors (try-completion prefix table pred
))))
2774 ;; The prefix has no completions at all, so we should try and fix
2776 (let ((substring (substring prefix
0 -
1)))
2777 (pcase-let ((`(,subpat
,suball
,subprefix
,_subsuffix
)
2778 (completion-pcm--find-all-completions
2779 substring table pred
(length substring
) filter
)))
2780 (let ((sep (aref prefix
(1- (length prefix
))))
2781 ;; Text that goes between the new submatches and the
2782 ;; completion substring.
2784 ;; Eliminate submatches that don't end with the separator.
2785 (dolist (submatch (prog1 suball
(setq suball
())))
2786 (when (eq sep
(aref submatch
(1- (length submatch
))))
2787 (push submatch suball
)))
2789 ;; Update the boundaries and corresponding pattern.
2790 ;; We assume that all submatches result in the same boundaries
2791 ;; since we wouldn't know how to merge them otherwise anyway.
2792 ;; FIXME: COMPLETE REWRITE!!!
2793 (let* ((newbeforepoint
2794 (concat subprefix
(car suball
)
2795 (substring string
0 relpoint
)))
2796 (leftbound (+ (length subprefix
) (length (car suball
))))
2797 (newbounds (completion-boundaries
2798 newbeforepoint table pred afterpoint
)))
2799 (unless (or (and (eq (cdr bounds
) (cdr newbounds
))
2800 (eq (car newbounds
) leftbound
))
2801 ;; Refuse new boundaries if they step over
2803 (< (car newbounds
) leftbound
))
2804 ;; The new completed prefix does change the boundaries
2805 ;; of the completed substring.
2806 (setq suffix
(substring afterpoint
(cdr newbounds
)))
2808 (concat (substring newbeforepoint
(car newbounds
))
2809 (substring afterpoint
0 (cdr newbounds
))))
2810 (setq between
(substring newbeforepoint leftbound
2812 (setq pattern
(completion-pcm--string->pattern
2814 (- (length newbeforepoint
)
2816 (dolist (submatch suball
)
2819 (lambda (s) (concat submatch between s
))
2821 (completion-pcm--all-completions
2822 (concat subprefix submatch between
)
2823 pattern table pred
)))
2825 ;; FIXME: This can come in handy for try-completion,
2826 ;; but isn't right for all-completions, since it lists
2827 ;; invalid completions.
2829 ;; ;; Even though we found expansions in the prefix, none
2830 ;; ;; leads to a valid completion.
2831 ;; ;; Let's keep the expansions, tho.
2832 ;; (dolist (submatch suball)
2833 ;; (push (concat submatch between newsubstring) all)))
2835 (setq pattern
(append subpat
(list 'any
(string sep
))
2836 (if between
(list between
)) pattern
))
2837 (setq prefix subprefix
)))))
2838 (if (and (null all
) firsterror
)
2839 (signal (car firsterror
) (cdr firsterror
))
2840 (list pattern all prefix suffix
)))))
2842 (defun completion-pcm-all-completions (string table pred point
)
2843 (pcase-let ((`(,pattern
,all
,prefix
,_suffix
)
2844 (completion-pcm--find-all-completions string table pred point
)))
2846 (nconc (completion-pcm--hilit-commonality pattern all
)
2849 (defun completion--sreverse (str)
2850 "Like `reverse' but for a string STR rather than a list."
2851 (apply #'string
(nreverse (mapcar 'identity str
))))
2853 (defun completion--common-suffix (strs)
2854 "Return the common suffix of the strings STRS."
2855 (completion--sreverse
2858 (mapcar #'completion--sreverse strs
))))
2860 (defun completion-pcm--merge-completions (strs pattern
)
2861 "Extract the commonality in STRS, with the help of PATTERN.
2862 PATTERN can contain strings and symbols chosen among `star', `any', `point',
2863 and `prefix'. They all match anything (aka \".*\") but are merged differently:
2864 `any' only grows from the left (when matching \"a1b\" and \"a2b\" it gets
2865 completed to just \"a\").
2866 `prefix' only grows from the right (when matching \"a1b\" and \"a2b\" it gets
2867 completed to just \"b\").
2868 `star' grows from both ends and is reified into a \"*\" (when matching \"a1b\"
2869 and \"a2b\" it gets completed to \"a*b\").
2870 `point' is like `star' except that it gets reified as the position of point
2871 instead of being reified as a \"*\" character.
2872 The underlying idea is that we should return a string which still matches
2873 the same set of elements."
2874 ;; When completing while ignoring case, we want to try and avoid
2875 ;; completing "fo" to "foO" when completing against "FOO" (bug#4219).
2876 ;; So we try and make sure that the string we return is all made up
2877 ;; of text from the completions rather than part from the
2878 ;; completions and part from the input.
2879 ;; FIXME: This reduces the problems of inconsistent capitalization
2880 ;; but it doesn't fully fix it: we may still end up completing
2881 ;; "fo-ba" to "foo-BAR" or "FOO-bar" when completing against
2882 ;; '("foo-barr" "FOO-BARD").
2884 ((null (cdr strs
)) (list (car strs
)))
2886 (let ((re (completion-pcm--pattern->regex pattern
'group
))
2887 (ccs ())) ;Chopped completions.
2889 ;; First chop each string into the parts corresponding to each
2890 ;; non-constant element of `pattern', using regexp-matching.
2891 (let ((case-fold-search completion-ignore-case
))
2893 (unless (string-match re str
)
2894 (error "Internal error: %s doesn't match %s" str re
))
2899 (while (setq next
(match-end i
))
2900 (push (substring str last next
) chopped
)
2903 ;; Add the text corresponding to the implicit trailing `any'.
2904 (push (substring str last
) chopped
)
2905 (push (nreverse chopped
) ccs
))))
2907 ;; Then for each of those non-constant elements, extract the
2908 ;; commonality between them.
2911 ;; Make the implicit trailing `any' explicit.
2912 (dolist (elem (append pattern
'(any)))
2914 (setq fixed
(concat fixed elem
))
2916 (dolist (cc (prog1 ccs
(setq ccs nil
)))
2917 (push (car cc
) comps
)
2918 (push (cdr cc
) ccs
))
2919 ;; Might improve the likelihood to avoid choosing
2920 ;; different capitalizations in different parts.
2921 ;; In practice, it doesn't seem to make any difference.
2922 (setq ccs
(nreverse ccs
))
2923 (let* ((prefix (try-completion fixed comps
))
2924 (unique (or (and (eq prefix t
) (setq prefix fixed
))
2925 (eq t
(try-completion prefix comps
)))))
2926 (unless (or (eq elem
'prefix
)
2929 ;; If there's only one completion, `elem' is not useful
2930 ;; any more: it can only match the empty string.
2931 ;; FIXME: in some cases, it may be necessary to turn an
2932 ;; `any' into a `star' because the surrounding context has
2933 ;; changed such that string->pattern wouldn't add an `any'
2937 (when (memq elem
'(star point prefix
))
2938 ;; Extract common suffix additionally to common prefix.
2939 ;; Only do it for `point', `star', and `prefix' since for
2940 ;; `any' it could lead to a merged completion that
2941 ;; doesn't itself match the candidates.
2942 (let ((suffix (completion--common-suffix comps
)))
2943 (cl-assert (stringp suffix
))
2944 (unless (equal suffix
"")
2945 (push suffix res
)))))
2947 ;; We return it in reverse order.
2950 (defun completion-pcm--pattern->string
(pattern)
2951 (mapconcat (lambda (x) (cond
2954 (t ""))) ;any, point, prefix.
2958 ;; We want to provide the functionality of `try', but we use `all'
2959 ;; and then merge it. In most cases, this works perfectly, but
2960 ;; if the completion table doesn't consider the same completions in
2961 ;; `try' as in `all', then we have a problem. The most common such
2962 ;; case is for filename completion where completion-ignored-extensions
2963 ;; is only obeyed by the `try' code. We paper over the difference
2964 ;; here. Note that it is not quite right either: if the completion
2965 ;; table uses completion-table-in-turn, this filtering may take place
2966 ;; too late to correctly fallback from the first to the
2967 ;; second alternative.
2968 (defun completion-pcm--filename-try-filter (all)
2969 "Filter to adjust `all' file completion to the behavior of `try'."
2972 (re (concat "\\(?:\\`\\.\\.?/\\|"
2973 (regexp-opt completion-ignored-extensions
)
2976 (unless (string-match-p re f
) (push f try
)))
2980 (defun completion-pcm--merge-try (pattern all prefix suffix
)
2982 ((not (consp all
)) all
)
2983 ((and (not (consp (cdr all
))) ;Only one completion.
2984 ;; Ignore completion-ignore-case here.
2985 (equal (completion-pcm--pattern->string pattern
) (car all
)))
2988 (let* ((mergedpat (completion-pcm--merge-completions all pattern
))
2989 ;; `mergedpat' is in reverse order. Place new point (by
2990 ;; order of preference) either at the old point, or at
2991 ;; the last place where there's something to choose, or
2993 (pointpat (or (memq 'point mergedpat
)
2994 (memq 'any mergedpat
)
2995 (memq 'star mergedpat
)
2998 ;; New pos from the start.
2999 (newpos (length (completion-pcm--pattern->string pointpat
)))
3000 ;; Do it afterwards because it changes `pointpat' by side effect.
3001 (merged (completion-pcm--pattern->string
(nreverse mergedpat
))))
3003 (setq suffix
(completion--merge-suffix merged newpos suffix
))
3004 (cons (concat prefix merged suffix
) (+ newpos
(length prefix
)))))))
3006 (defun completion-pcm-try-completion (string table pred point
)
3007 (pcase-let ((`(,pattern
,all
,prefix
,suffix
)
3008 (completion-pcm--find-all-completions
3009 string table pred point
3010 (if minibuffer-completing-file-name
3011 'completion-pcm--filename-try-filter
))))
3012 (completion-pcm--merge-try pattern all prefix suffix
)))
3014 ;;; Substring completion
3015 ;; Mostly derived from the code of `basic' completion.
3017 (defun completion-substring--all-completions (string table pred point
)
3018 (let* ((beforepoint (substring string
0 point
))
3019 (afterpoint (substring string point
))
3020 (bounds (completion-boundaries beforepoint table pred afterpoint
))
3021 (suffix (substring afterpoint
(cdr bounds
)))
3022 (prefix (substring beforepoint
0 (car bounds
)))
3023 (basic-pattern (completion-basic--pattern
3024 beforepoint afterpoint bounds
))
3025 (pattern (if (not (stringp (car basic-pattern
)))
3027 (cons 'prefix basic-pattern
)))
3028 (all (completion-pcm--all-completions prefix pattern table pred
)))
3029 (list all pattern prefix suffix
(car bounds
))))
3031 (defun completion-substring-try-completion (string table pred point
)
3032 (pcase-let ((`(,all
,pattern
,prefix
,suffix
,_carbounds
)
3033 (completion-substring--all-completions
3034 string table pred point
)))
3035 (if minibuffer-completing-file-name
3036 (setq all
(completion-pcm--filename-try-filter all
)))
3037 (completion-pcm--merge-try pattern all prefix suffix
)))
3039 (defun completion-substring-all-completions (string table pred point
)
3040 (pcase-let ((`(,all
,pattern
,prefix
,_suffix
,_carbounds
)
3041 (completion-substring--all-completions
3042 string table pred point
)))
3044 (nconc (completion-pcm--hilit-commonality pattern all
)
3047 ;; Initials completion
3048 ;; Complete /ums to /usr/monnier/src or lch to list-command-history.
3050 (defun completion-initials-expand (str table pred
)
3051 (let ((bounds (completion-boundaries str table pred
"")))
3052 (unless (or (zerop (length str
))
3053 ;; Only check within the boundaries, since the
3054 ;; boundary char (e.g. /) might be in delim-regexp.
3055 (string-match completion-pcm--delim-wild-regex str
3057 (if (zerop (car bounds
))
3058 (mapconcat 'string str
"-")
3059 ;; If there's a boundary, it's trickier. The main use-case
3060 ;; we consider here is file-name completion. We'd like
3061 ;; to expand ~/eee to ~/e/e/e and /eee to /e/e/e.
3062 ;; But at the same time, we don't want /usr/share/ae to expand
3063 ;; to /usr/share/a/e just because we mistyped "ae" for "ar",
3064 ;; so we probably don't want initials to touch anything that
3065 ;; looks like /usr/share/foo. As a heuristic, we just check that
3066 ;; the text before the boundary char is at most 1 char.
3067 ;; This allows both ~/eee and /eee and not much more.
3068 ;; FIXME: It sadly also disallows the use of ~/eee when that's
3069 ;; embedded within something else (e.g. "(~/eee" in Info node
3070 ;; completion or "ancestor:/eee" in bzr-revision completion).
3071 (when (< (car bounds
) 3)
3072 (let ((sep (substring str
(1- (car bounds
)) (car bounds
))))
3073 ;; FIXME: the above string-match checks the whole string, whereas
3074 ;; we end up only caring about the after-boundary part.
3075 (concat (substring str
0 (car bounds
))
3076 (mapconcat 'string
(substring str
(car bounds
)) sep
))))))))
3078 (defun completion-initials-all-completions (string table pred _point
)
3079 (let ((newstr (completion-initials-expand string table pred
)))
3081 (completion-pcm-all-completions newstr table pred
(length newstr
)))))
3083 (defun completion-initials-try-completion (string table pred _point
)
3084 (let ((newstr (completion-initials-expand string table pred
)))
3086 (completion-pcm-try-completion newstr table pred
(length newstr
)))))
3088 (defvar completing-read-function
'completing-read-default
3089 "The function called by `completing-read' to do its work.
3090 It should accept the same arguments as `completing-read'.")
3092 (defun completing-read-default (prompt collection
&optional predicate
3093 require-match initial-input
3094 hist def inherit-input-method
)
3095 "Default method for reading from the minibuffer with completion.
3096 See `completing-read' for the meaning of the arguments."
3098 (when (consp initial-input
)
3100 (cons (car initial-input
)
3101 ;; `completing-read' uses 0-based index while
3102 ;; `read-from-minibuffer' uses 1-based index.
3103 (1+ (cdr initial-input
)))))
3105 (let* ((minibuffer-completion-table collection
)
3106 (minibuffer-completion-predicate predicate
)
3107 (minibuffer-completion-confirm (unless (eq require-match t
)
3109 (base-keymap (if require-match
3110 minibuffer-local-must-match-map
3111 minibuffer-local-completion-map
))
3112 (keymap (if (memq minibuffer-completing-file-name
'(nil lambda
))
3114 ;; Layer minibuffer-local-filename-completion-map
3115 ;; on top of the base map.
3116 (make-composed-keymap
3117 minibuffer-local-filename-completion-map
3118 ;; Set base-keymap as the parent, so that nil bindings
3119 ;; in minibuffer-local-filename-completion-map can
3120 ;; override bindings in base-keymap.
3122 (result (read-from-minibuffer prompt initial-input keymap
3123 nil hist def inherit-input-method
)))
3124 (when (and (equal result
"") def
)
3125 (setq result
(if (consp def
) (car def
) def
)))
3130 (defun minibuffer-insert-file-name-at-point ()
3131 "Get a file name at point in original buffer and insert it to minibuffer."
3133 (let ((file-name-at-point
3134 (with-current-buffer (window-buffer (minibuffer-selected-window))
3135 (run-hook-with-args-until-success 'file-name-at-point-functions
))))
3136 (when file-name-at-point
3137 (insert file-name-at-point
))))
3139 (provide 'minibuffer
)
3141 ;;; minibuffer.el ends here