1 ;;; minibuffer.el --- Minibuffer completion functions
3 ;; Copyright (C) 2008, 2009 Free Software Foundation, Inc.
5 ;; Author: Stefan Monnier <monnier@iro.umontreal.ca>
7 ;; This file is part of GNU Emacs.
9 ;; GNU Emacs is free software: you can redistribute it and/or modify
10 ;; it under the terms of the GNU General Public License as published by
11 ;; the Free Software Foundation, either version 3 of the License, or
12 ;; (at your option) any later version.
14 ;; GNU Emacs is distributed in the hope that it will be useful,
15 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
16 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 ;; GNU General Public License for more details.
19 ;; You should have received a copy of the GNU General Public License
20 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
24 ;; Names with "--" are for functions and variables that are meant to be for
27 ;; Functional completion tables have an extended calling conventions:
28 ;; - The `action' can be (additionally to nil, t, and lambda) of the form
29 ;; (boundaries . SUFFIX) in which case it should return
30 ;; (boundaries START . END). See `completion-boundaries'.
31 ;; Any other return value should be ignored (so we ignore values returned
32 ;; from completion tables that don't know about this new `action' form).
33 ;; See `completion-boundaries'.
37 ;; - completion-all-sorted-completions list all the completions, whereas
38 ;; it should only lists the ones that `try-completion' would consider.
39 ;; E.g. it should honor completion-ignored-extensions.
40 ;; - choose-completion can't automatically figure out the boundaries
41 ;; corresponding to the displayed completions. `base-size' gives the left
42 ;; boundary, but not the righthand one. So we need to add
43 ;; completion-extra-size (and also completion-no-auto-exit).
47 ;; - make lisp-complete-symbol and sym-comp use it.
48 ;; - add support for ** to pcm.
49 ;; - Make read-file-name-predicate obsolete.
50 ;; - Add vc-file-name-completion-table to read-file-name-internal.
51 ;; - A feature like completing-help.el.
52 ;; - make lisp/complete.el obsolete.
53 ;; - Make the `hide-spaces' arg of all-completions obsolete?
57 (eval-when-compile (require 'cl
))
59 ;;; Completion table manipulation
61 ;; New completion-table operation.
62 (defun completion-boundaries (string table pred suffix
)
63 "Return the boundaries of the completions returned by TABLE for STRING.
64 STRING is the string on which completion will be performed.
65 SUFFIX is the string after point.
66 The result is of the form (START . END) where START is the position
67 in STRING of the beginning of the completion field and END is the position
68 in SUFFIX of the end of the completion field.
69 E.g. for simple completion tables, the result is always (0 . (length SUFFIX))
70 and for file names the result is the positions delimited by
71 the closest directory separators."
72 (let ((boundaries (if (functionp table
)
73 (funcall table string pred
(cons 'boundaries suffix
)))))
74 (if (not (eq (car-safe boundaries
) 'boundaries
))
75 (setq boundaries nil
))
76 (cons (or (cadr boundaries
) 0)
77 (or (cddr boundaries
) (length suffix
)))))
79 (defun completion--some (fun xs
)
80 "Apply FUN to each element of XS in turn.
81 Return the first non-nil returned value.
83 (let ((firsterror nil
)
85 (while (and (not res
) xs
)
87 (setq res
(funcall fun
(pop xs
)))
88 (error (unless firsterror
(setq firsterror err
)) nil
)))
90 (if firsterror
(signal (car firsterror
) (cdr firsterror
))))))
92 (defun complete-with-action (action table string pred
)
93 "Perform completion ACTION.
94 STRING is the string to complete.
95 TABLE is the completion table, which should not be a function.
96 PRED is a completion predicate.
97 ACTION can be one of nil, t or `lambda'."
99 ((functionp table
) (funcall table string pred action
))
100 ((eq (car-safe action
) 'boundaries
)
101 (cons 'boundaries
(completion-boundaries string table pred
(cdr action
))))
105 ((null action
) 'try-completion
)
106 ((eq action t
) 'all-completions
)
107 (t 'test-completion
))
108 string table pred
))))
110 (defun completion-table-dynamic (fun)
111 "Use function FUN as a dynamic completion table.
112 FUN is called with one argument, the string for which completion is required,
113 and it should return an alist containing all the intended possible completions.
114 This alist may be a full list of possible completions so that FUN can ignore
115 the value of its argument. If completion is performed in the minibuffer,
116 FUN will be called in the buffer from which the minibuffer was entered.
118 The result of the `completion-table-dynamic' form is a function
119 that can be used as the COLLECTION argument to `try-completion' and
120 `all-completions'. See Info node `(elisp)Programmed Completion'."
121 (lexical-let ((fun fun
))
122 (lambda (string pred action
)
123 (with-current-buffer (let ((win (minibuffer-selected-window)))
124 (if (window-live-p win
) (window-buffer win
)
126 (complete-with-action action
(funcall fun string
) string pred
)))))
128 (defmacro lazy-completion-table
(var fun
)
129 "Initialize variable VAR as a lazy completion table.
130 If the completion table VAR is used for the first time (e.g., by passing VAR
131 as an argument to `try-completion'), the function FUN is called with no
132 arguments. FUN must return the completion table that will be stored in VAR.
133 If completion is requested in the minibuffer, FUN will be called in the buffer
134 from which the minibuffer was entered. The return value of
135 `lazy-completion-table' must be used to initialize the value of VAR.
137 You should give VAR a non-nil `risky-local-variable' property."
138 (declare (debug (symbolp lambda-expr
)))
139 (let ((str (make-symbol "string")))
140 `(completion-table-dynamic
142 (when (functionp ,var
)
146 (defun completion-table-with-context (prefix table string pred action
)
147 ;; TODO: add `suffix' maybe?
148 ;; Notice that `pred' may not be a function in some abusive cases.
149 (when (functionp pred
)
151 (lexical-let ((pred pred
))
152 ;; Predicates are called differently depending on the nature of
153 ;; the completion table :-(
155 ((vectorp table
) ;Obarray.
156 (lambda (sym) (funcall pred
(concat prefix
(symbol-name sym
)))))
157 ((hash-table-p table
)
158 (lambda (s v
) (funcall pred
(concat prefix s
))))
160 (lambda (s) (funcall pred
(concat prefix s
))))
161 (t ;Lists and alists.
163 (funcall pred
(concat prefix
(if (consp s
) (car s
) s
)))))))))
164 (if (eq (car-safe action
) 'boundaries
)
165 (let* ((len (length prefix
))
166 (bound (completion-boundaries string table pred
(cdr action
))))
167 (list* 'boundaries
(+ (car bound
) len
) (cdr bound
)))
168 (let ((comp (complete-with-action action table string pred
)))
170 ;; In case of try-completion, add the prefix.
171 ((stringp comp
) (concat prefix comp
))
174 (defun completion-table-with-terminator (terminator table string pred action
)
177 (let ((comp (try-completion string table pred
)))
179 (concat string terminator
)
180 (if (and (stringp comp
)
181 (eq (try-completion comp table pred
) t
))
182 (concat comp terminator
)
185 ;; FIXME: We generally want the `try' and `all' behaviors to be
186 ;; consistent so pcm can merge the `all' output to get the `try' output,
187 ;; but that sometimes clashes with the need for `all' output to look
188 ;; good in *Completions*.
189 ;; (mapcar (lambda (s) (concat s terminator))
190 ;; (all-completions string table pred))))
191 (all-completions string table pred
))
192 ;; completion-table-with-terminator is always used for
193 ;; "sub-completions" so it's only called if the terminator is missing,
194 ;; in which case `test-completion' should return nil.
195 ((eq action
'lambda
) nil
)))
197 (defun completion-table-with-predicate (table pred1 strict string pred2 action
)
198 "Make a completion table equivalent to TABLE but filtered through PRED1.
199 PRED1 is a function of one argument which returns non-nil if and only if the
200 argument is an element of TABLE which should be considered for completion.
201 STRING, PRED2, and ACTION are the usual arguments to completion tables,
202 as described in `try-completion', `all-completions', and `test-completion'.
203 If STRICT is t, the predicate always applies; if nil it only applies if
204 it does not reduce the set of possible completions to nothing.
205 Note: TABLE needs to be a proper completion table which obeys predicates."
207 ((and (not strict
) (eq action
'lambda
))
208 ;; Ignore pred1 since it doesn't really have to apply anyway.
209 (test-completion string table pred2
))
211 (or (complete-with-action action table string
212 (if (null pred2
) pred1
213 (lexical-let ((pred1 pred2
) (pred2 pred2
))
215 ;; Call `pred1' first, so that `pred2'
216 ;; really can't tell that `x' is in table.
217 (if (funcall pred1 x
) (funcall pred2 x
))))))
218 ;; If completion failed and we're not applying pred1 strictly, try
219 ;; again without pred1.
221 (complete-with-action action table string pred2
))))))
223 (defun completion-table-in-turn (&rest tables
)
224 "Create a completion table that tries each table in TABLES in turn."
225 (lexical-let ((tables tables
))
226 (lambda (string pred action
)
227 (completion--some (lambda (table)
228 (complete-with-action action table string pred
))
231 ;; (defmacro complete-in-turn (a b) `(completion-table-in-turn ,a ,b))
232 ;; (defmacro dynamic-completion-table (fun) `(completion-table-dynamic ,fun))
233 (define-obsolete-function-alias
234 'complete-in-turn
'completion-table-in-turn
"23.1")
235 (define-obsolete-function-alias
236 'dynamic-completion-table
'completion-table-dynamic
"23.1")
238 ;;; Minibuffer completion
240 (defgroup minibuffer nil
241 "Controlling the behavior of the minibuffer."
242 :link
'(custom-manual "(emacs)Minibuffer")
245 (defun minibuffer-message (message &rest args
)
246 "Temporarily display MESSAGE at the end of the minibuffer.
247 The text is displayed for `minibuffer-message-timeout' seconds,
248 or until the next input event arrives, whichever comes first.
249 Enclose MESSAGE in [...] if this is not yet the case.
250 If ARGS are provided, then pass MESSAGE through `format'."
251 ;; Clear out any old echo-area message to make way for our new thing.
253 (setq message
(if (and (null args
) (string-match-p "\\` *\\[.+\\]\\'" message
))
254 ;; Make sure we can put-text-property.
255 (copy-sequence message
)
256 (concat " [" message
"]")))
257 (when args
(setq message
(apply 'format message args
)))
258 (let ((ol (make-overlay (point-max) (point-max) nil t t
))
259 ;; A quit during sit-for normally only interrupts the sit-for,
260 ;; but since minibuffer-message is used at the end of a command,
261 ;; at a time when the command has virtually finished already, a C-g
262 ;; should really cause an abort-recursive-edit instead (i.e. as if
263 ;; the C-g had been typed at top-level). Binding inhibit-quit here
264 ;; is an attempt to get that behavior.
268 (unless (zerop (length message
))
269 ;; The current C cursor code doesn't know to use the overlay's
270 ;; marker's stickiness to figure out whether to place the cursor
271 ;; before or after the string, so let's spoon-feed it the pos.
272 (put-text-property 0 1 'cursor t message
))
273 (overlay-put ol
'after-string message
)
274 (sit-for (or minibuffer-message-timeout
1000000)))
275 (delete-overlay ol
))))
277 (defun minibuffer-completion-contents ()
278 "Return the user input in a minibuffer before point as a string.
279 That is what completion commands operate on."
280 (buffer-substring (field-beginning) (point)))
282 (defun delete-minibuffer-contents ()
283 "Delete all user input in a minibuffer.
284 If the current buffer is not a minibuffer, erase its entire contents."
285 ;; We used to do `delete-field' here, but when file name shadowing
286 ;; is on, the field doesn't cover the entire minibuffer contents.
287 (delete-region (minibuffer-prompt-end) (point-max)))
289 (defcustom completion-auto-help t
290 "Non-nil means automatically provide help for invalid completion input.
291 If the value is t the *Completion* buffer is displayed whenever completion
292 is requested but cannot be done.
293 If the value is `lazy', the *Completions* buffer is only displayed after
294 the second failed attempt to complete."
295 :type
'(choice (const nil
) (const t
) (const lazy
))
298 (defvar completion-styles-alist
299 '((basic completion-basic-try-completion completion-basic-all-completions
)
300 (emacs22 completion-emacs22-try-completion completion-emacs22-all-completions
)
301 (emacs21 completion-emacs21-try-completion completion-emacs21-all-completions
)
303 completion-pcm-try-completion completion-pcm-all-completions
))
304 "List of available completion styles.
305 Each element has the form (NAME TRY-COMPLETION ALL-COMPLETIONS)
306 where NAME is the name that should be used in `completion-styles',
307 TRY-COMPLETION is the function that does the completion, and
308 ALL-COMPLETIONS is the function that lists the completions.")
310 (defcustom completion-styles
'(basic partial-completion
)
311 "List of completion styles to use."
312 :type
`(repeat (choice ,@(mapcar (lambda (x) (list 'const
(car x
)))
313 completion-styles-alist
)))
317 (defun completion-try-completion (string table pred point
)
318 "Try to complete STRING using completion table TABLE.
319 Only the elements of table that satisfy predicate PRED are considered.
320 POINT is the position of point within STRING.
321 The return value can be either nil to indicate that there is no completion,
322 t to indicate that STRING is the only possible completion,
323 or a pair (STRING . NEWPOINT) of the completed result string together with
324 a new position for point."
325 ;; The property `completion-styles' indicates that this functional
326 ;; completion-table claims to take care of completion styles itself.
327 ;; [I.e. It will most likely call us back at some point. ]
328 (if (and (symbolp table
) (get table
'completion-styles
))
329 ;; Extended semantics for functional completion-tables:
330 ;; They accept a 4th argument `point' and when called with action=nil
331 ;; and this 4th argument (a position inside `string'), they should
332 ;; return instead of a string a pair (STRING . NEWPOINT).
333 (funcall table string pred nil point
)
334 (completion--some (lambda (style)
335 (funcall (nth 1 (assq style completion-styles-alist
))
336 string table pred point
))
339 (defun completion-all-completions (string table pred point
)
340 "List the possible completions of STRING in completion table TABLE.
341 Only the elements of table that satisfy predicate PRED are considered.
342 POINT is the position of point within STRING.
343 The return value is a list of completions and may contain the base-size
345 ;; The property `completion-styles' indicates that this functional
346 ;; completion-table claims to take care of completion styles itself.
347 ;; [I.e. It will most likely call us back at some point. ]
348 (if (and (symbolp table
) (get table
'completion-styles
))
349 ;; Extended semantics for functional completion-tables:
350 ;; They accept a 4th argument `point' and when called with action=t
351 ;; and this 4th argument (a position inside `string'), they may
352 ;; return BASE-SIZE in the last `cdr'.
353 (funcall table string pred t point
)
354 (completion--some (lambda (style)
355 (funcall (nth 2 (assq style completion-styles-alist
))
356 string table pred point
))
359 (defun minibuffer--bitset (modified completions exact
)
360 (logior (if modified
4 0)
364 (defun completion--do-completion (&optional try-completion-function
)
365 "Do the completion and return a summary of what happened.
366 M = completion was performed, the text was Modified.
367 C = there were available Completions.
368 E = after completion we now have an Exact match.
371 000 0 no possible completion
372 001 1 was already an exact and unique completion
373 010 2 no completion happened
374 011 3 was already an exact completion
377 110 6 some completion happened
378 111 7 completed to an exact completion"
379 (let* ((beg (field-beginning))
381 (string (buffer-substring beg end
))
382 (comp (funcall (or try-completion-function
383 'completion-try-completion
)
385 minibuffer-completion-table
386 minibuffer-completion-predicate
390 (ding) (minibuffer-message "No match") (minibuffer--bitset nil nil nil
))
391 ((eq t comp
) (minibuffer--bitset nil nil t
)) ;Exact and unique match.
393 ;; `completed' should be t if some completion was done, which doesn't
394 ;; include simply changing the case of the entered string. However,
395 ;; for appearance, the string is rewritten if the case changes.
396 (let* ((comp-pos (cdr comp
))
397 (completion (car comp
))
398 (completed (not (eq t
(compare-strings completion nil nil
400 (unchanged (eq t
(compare-strings completion nil nil
401 string nil nil nil
))))
404 ;; Insert in minibuffer the chars we got.
407 (delete-region beg end
))
409 (goto-char (+ beg comp-pos
))
411 (if (not (or unchanged completed
))
412 ;; The case of the string changed, but that's all. We're not sure
413 ;; whether this is a unique completion or not, so try again using
414 ;; the real case (this shouldn't recurse again, because the next
415 ;; time try-completion will return either t or the exact string).
416 (completion--do-completion try-completion-function
)
418 ;; It did find a match. Do we match some possibility exactly now?
419 (let ((exact (test-completion completion
420 minibuffer-completion-table
421 minibuffer-completion-predicate
)))
423 ;; Show the completion table, if requested.
426 (if (case completion-auto-help
427 (lazy (eq this-command last-command
))
428 (t completion-auto-help
))
429 (minibuffer-completion-help)
430 (minibuffer-message "Next char not unique")))
431 ;; If the last exact completion and this one were the same,
432 ;; it means we've already given a "Complete but not unique"
433 ;; message and the user's hit TAB again, so now we give him help.
434 ((eq this-command last-command
)
435 (if completion-auto-help
(minibuffer-completion-help)))))
437 (minibuffer--bitset completed t exact
))))))))
439 (defun minibuffer-complete ()
440 "Complete the minibuffer contents as far as possible.
441 Return nil if there is no valid completion, else t.
442 If no characters can be completed, display a list of possible completions.
443 If you repeat this command after it displayed such a list,
444 scroll the window of possible completions."
446 ;; If the previous command was not this,
447 ;; mark the completion buffer obsolete.
448 (unless (eq this-command last-command
)
449 (setq minibuffer-scroll-window nil
))
451 (let ((window minibuffer-scroll-window
))
452 ;; If there's a fresh completion window with a live buffer,
453 ;; and this command is repeated, scroll that window.
454 (if (window-live-p window
)
455 (with-current-buffer (window-buffer window
)
456 (if (pos-visible-in-window-p (point-max) window
)
457 ;; If end is in view, scroll up to the beginning.
458 (set-window-start window
(point-min) nil
)
459 ;; Else scroll down one screen.
460 (scroll-other-window))
463 (case (completion--do-completion)
465 (#b001
(goto-char (field-end))
466 (minibuffer-message "Sole completion")
468 (#b011
(goto-char (field-end))
469 (minibuffer-message "Complete, but not unique")
473 (defvar completion-all-sorted-completions nil
)
474 (make-variable-buffer-local 'completion-all-sorted-completions
)
476 (defun completion--flush-all-sorted-completions (&rest ignore
)
477 (setq completion-all-sorted-completions nil
))
479 (defun completion-all-sorted-completions ()
480 (or completion-all-sorted-completions
481 (let* ((start (field-beginning))
483 (all (completion-all-completions (buffer-substring start end
)
484 minibuffer-completion-table
485 minibuffer-completion-predicate
488 (base-size (or (cdr last
) 0)))
491 ;; Prefer shorter completions.
492 (setq all
(sort all
(lambda (c1 c2
) (< (length c1
) (length c2
)))))
493 ;; Prefer recently used completions.
494 (let ((hist (symbol-value minibuffer-history-variable
)))
495 (setq all
(sort all
(lambda (c1 c2
)
496 (> (length (member c1 hist
))
497 (length (member c2 hist
)))))))
498 ;; Cache the result. This is not just for speed, but also so that
499 ;; repeated calls to minibuffer-force-complete can cycle through
500 ;; all possibilities.
501 (add-hook 'after-change-functions
502 'completion--flush-all-sorted-completions nil t
)
503 (setq completion-all-sorted-completions
504 (nconc all base-size
))))))
506 (defun minibuffer-force-complete ()
507 "Complete the minibuffer to an exact match.
508 Repeated uses step through the possible completions."
510 ;; FIXME: Need to deal with the extra-size issue here as well.
511 (let* ((start (field-beginning))
513 (all (completion-all-sorted-completions)))
514 (if (not (consp all
))
515 (minibuffer-message (if all
"No more completions" "No completions"))
518 (delete-region (+ start
(cdr (last all
))) end
)
519 ;; If completing file names, (car all) may be a directory, so we'd now
520 ;; have a new set of possible completions and might want to reset
521 ;; completion-all-sorted-completions to nil, but we prefer not to,
522 ;; so that repeated calls minibuffer-force-complete still cycle
523 ;; through the previous possible completions.
524 (setq completion-all-sorted-completions
(cdr all
)))))
526 (defvar minibuffer-confirm-exit-commands
527 '(minibuffer-complete minibuffer-complete-word PC-complete PC-complete-word
)
528 "A list of commands which cause an immediately following
529 `minibuffer-complete-and-exit' to ask for extra confirmation.")
531 (defun minibuffer-complete-and-exit ()
532 "Exit if the minibuffer contains a valid completion.
533 Otherwise, try to complete the minibuffer contents. If
534 completion leads to a valid completion, a repetition of this
537 If `minibuffer-completion-confirm' is `confirm', do not try to
538 complete; instead, ask for confirmation and accept any input if
540 If `minibuffer-completion-confirm' is `confirm-after-completion',
541 do not try to complete; instead, ask for confirmation if the
542 preceding minibuffer command was `minibuffer-complete', and
543 accept the input otherwise."
545 (let ((beg (field-beginning))
548 ;; Allow user to specify null string
549 ((= beg end
) (exit-minibuffer))
550 ((test-completion (buffer-substring beg end
)
551 minibuffer-completion-table
552 minibuffer-completion-predicate
)
553 (when completion-ignore-case
554 ;; Fixup case of the field, if necessary.
555 (let* ((string (buffer-substring beg end
))
556 (compl (try-completion
558 minibuffer-completion-table
559 minibuffer-completion-predicate
)))
560 (when (and (stringp compl
)
561 ;; If it weren't for this piece of paranoia, I'd replace
562 ;; the whole thing with a call to do-completion.
563 ;; This is important, e.g. when the current minibuffer's
564 ;; content is a directory which only contains a single
565 ;; file, so `try-completion' actually completes to
567 (= (length string
) (length compl
)))
570 (delete-region beg end
))))
573 ((eq minibuffer-completion-confirm
'confirm
)
574 ;; The user is permitted to exit with an input that's rejected
575 ;; by test-completion, after confirming her choice.
576 (if (eq last-command this-command
)
578 (minibuffer-message "Confirm")
581 ((eq minibuffer-completion-confirm
'confirm-after-completion
)
582 ;; Similar to the above, but only if trying to exit immediately
583 ;; after typing TAB (this catches most minibuffer typos).
584 (if (memq last-command minibuffer-confirm-exit-commands
)
585 (progn (minibuffer-message "Confirm")
590 ;; Call do-completion, but ignore errors.
591 (case (condition-case nil
592 (completion--do-completion)
594 ((#b001
#b011
) (exit-minibuffer))
595 (#b111
(if (not minibuffer-completion-confirm
)
597 (minibuffer-message "Confirm")
601 (defun completion--try-word-completion (string table predicate point
)
602 (let ((comp (completion-try-completion string table predicate point
)))
603 (if (not (consp comp
))
606 ;; If completion finds next char not unique,
607 ;; consider adding a space or a hyphen.
608 (when (= (length string
) (length (car comp
)))
609 (let ((exts '(" " "-"))
610 (before (substring string
0 point
))
611 (after (substring string point
))
612 ;; Disable partial-completion for this.
614 (or (remove 'partial-completion completion-styles
)
617 (while (and exts
(not (consp tem
)))
618 (setq tem
(completion-try-completion
619 (concat before
(pop exts
) after
)
620 table predicate
(1+ point
))))
621 (if (consp tem
) (setq comp tem
))))
623 ;; Completing a single word is actually more difficult than completing
624 ;; as much as possible, because we first have to find the "current
625 ;; position" in `completion' in order to find the end of the word
626 ;; we're completing. Normally, `string' is a prefix of `completion',
627 ;; which makes it trivial to find the position, but with fancier
628 ;; completion (plus env-var expansion, ...) `completion' might not
629 ;; look anything like `string' at all.
630 (let* ((comppoint (cdr comp
))
631 (completion (car comp
))
632 (before (substring string
0 point
))
633 (combined (concat before
"\n" completion
)))
634 ;; Find in completion the longest text that was right before point.
635 (when (string-match "\\(.+\\)\n.*?\\1" combined
)
636 (let* ((prefix (match-string 1 before
))
637 ;; We used non-greedy match to make `rem' as long as possible.
638 (rem (substring combined
(match-end 0)))
639 ;; Find in the remainder of completion the longest text
640 ;; that was right after point.
641 (after (substring string point
))
642 (suffix (if (string-match "\\`\\(.+\\).*\n.*\\1"
643 (concat after
"\n" rem
))
644 (match-string 1 after
))))
645 ;; The general idea is to try and guess what text was inserted
646 ;; at point by the completion. Problem is: if we guess wrong,
647 ;; we may end up treating as "added by completion" text that was
648 ;; actually painfully typed by the user. So if we then cut
649 ;; after the first word, we may throw away things the
650 ;; user wrote. So let's try to be as conservative as possible:
651 ;; only cut after the first word, if we're reasonably sure that
652 ;; our guess is correct.
653 ;; Note: a quick survey on emacs-devel seemed to indicate that
654 ;; nobody actually cares about the "word-at-a-time" feature of
655 ;; minibuffer-complete-word, whose real raison-d'être is that it
656 ;; tries to add "-" or " ". One more reason to only cut after
657 ;; the first word, if we're really sure we're right.
658 (when (and (or suffix
(zerop (length after
)))
659 (string-match (concat
660 ;; Make submatch 1 as small as possible
661 ;; to reduce the risk of cutting
663 ".*" (regexp-quote prefix
) "\\(.*?\\)"
664 (if suffix
(regexp-quote suffix
) "\\'"))
666 ;; The new point in `completion' should also be just
667 ;; before the suffix, otherwise something more complex
668 ;; is going on, and we're not sure where we are.
669 (eq (match-end 1) comppoint
)
670 ;; (match-beginning 1)..comppoint is now the stretch
671 ;; of text in `completion' that was completed at point.
672 (string-match "\\W" completion
(match-beginning 1))
673 ;; Is there really something to cut?
674 (> comppoint
(match-end 0)))
675 ;; Cut after the first word.
676 (let ((cutpos (match-end 0)))
677 (setq completion
(concat (substring completion
0 cutpos
)
678 (substring completion comppoint
)))
679 (setq comppoint cutpos
)))))
681 (cons completion comppoint
)))))
684 (defun minibuffer-complete-word ()
685 "Complete the minibuffer contents at most a single word.
686 After one word is completed as much as possible, a space or hyphen
687 is added, provided that matches some possible completion.
688 Return nil if there is no valid completion, else t."
690 (case (completion--do-completion 'completion--try-word-completion
)
692 (#b001
(goto-char (field-end))
693 (minibuffer-message "Sole completion")
695 (#b011
(goto-char (field-end))
696 (minibuffer-message "Complete, but not unique")
700 (defun completion--insert-strings (strings)
701 "Insert a list of STRINGS into the current buffer.
702 Uses columns to keep the listing readable but compact.
703 It also eliminates runs of equal strings."
704 (when (consp strings
)
705 (let* ((length (apply 'max
708 (+ (string-width (car s
))
709 (string-width (cadr s
)))
712 (window (get-buffer-window (current-buffer) 0))
713 (wwidth (if window
(1- (window-width window
)) 79))
715 ;; At least 2 columns; at least 2 spaces between columns.
716 (max 2 (/ wwidth
(+ 2 length
)))
717 ;; Don't allocate more columns than we can fill.
718 ;; Windows can't show less than 3 lines anyway.
719 (max 1 (/ (length strings
) 2))))
720 (colwidth (/ wwidth columns
))
723 ;; The insertion should be "sensible" no matter what choices were made
724 ;; for the parameters above.
725 (dolist (str strings
)
726 (unless (equal laststring str
) ; Remove (consecutive) duplicates.
727 (setq laststring str
)
728 (let ((length (if (consp str
)
729 (+ (string-width (car str
))
730 (string-width (cadr str
)))
731 (string-width str
))))
733 (if (< wwidth
(+ (max colwidth length
) column
))
734 ;; No space for `str' at point, move to next line.
735 (progn (insert "\n") (setq column
0))
737 ;; Leave the space unpropertized so that in the case we're
738 ;; already past the goal column, there is still
739 ;; a space displayed.
740 (set-text-properties (- (point) 1) (point)
741 ;; We can't just set tab-width, because
742 ;; completion-setup-function will kill all
743 ;; local variables :-(
744 `(display (space :align-to
,column
)))
746 (if (not (consp str
))
747 (put-text-property (point) (progn (insert str
) (point))
748 'mouse-face
'highlight
)
749 (put-text-property (point) (progn (insert (car str
)) (point))
750 'mouse-face
'highlight
)
751 (put-text-property (point) (progn (insert (cadr str
)) (point))
753 ;; Next column to align to.
754 (setq column
(+ column
755 ;; Round up to a whole number of columns.
756 (* colwidth
(ceiling length colwidth
))))))))))
758 (defvar completion-common-substring nil
)
759 (make-obsolete-variable 'completion-common-substring nil
"23.1")
761 (defvar completion-setup-hook nil
762 "Normal hook run at the end of setting up a completion list buffer.
763 When this hook is run, the current buffer is the one in which the
764 command to display the completion list buffer was run.
765 The completion list buffer is available as the value of `standard-output'.
766 See also `display-completion-list'.")
768 (defface completions-first-difference
769 '((t (:inherit bold
)))
770 "Face put on the first uncommon character in completions in *Completions* buffer."
773 (defface completions-common-part
774 '((t (:inherit default
)))
775 "Face put on the common prefix substring in completions in *Completions* buffer.
776 The idea of `completions-common-part' is that you can use it to
777 make the common parts less visible than normal, so that the rest
778 of the differing parts is, by contrast, slightly highlighted."
781 (defun completion-hilit-commonality (completions prefix-len base-size
)
783 (let ((com-str-len (- prefix-len
(or base-size
0))))
788 ;; Don't modify the string itself, but a copy, since the
789 ;; the string may be read-only or used for other purposes.
790 ;; Furthermore, since `completions' may come from
791 ;; display-completion-list, `elem' may be a list.
793 (car (setq elem
(cons (copy-sequence (car elem
))
795 (setq elem
(copy-sequence elem
)))))
797 ;; If completion-boundaries returns incorrect
798 ;; values, all-completions may return strings
799 ;; that don't contain the prefix.
800 (min com-str-len
(length str
))
801 'font-lock-face
'completions-common-part
803 (if (> (length str
) com-str-len
)
804 (put-text-property com-str-len
(1+ com-str-len
)
805 'font-lock-face
'completions-first-difference
811 (defun display-completion-list (completions &optional common-substring
)
812 "Display the list of completions, COMPLETIONS, using `standard-output'.
813 Each element may be just a symbol or string
814 or may be a list of two strings to be printed as if concatenated.
815 If it is a list of two strings, the first is the actual completion
816 alternative, the second serves as annotation.
817 `standard-output' must be a buffer.
818 The actual completion alternatives, as inserted, are given `mouse-face'
819 properties of `highlight'.
820 At the end, this runs the normal hook `completion-setup-hook'.
821 It can find the completion buffer in `standard-output'.
823 The obsolete optional arg COMMON-SUBSTRING, if non-nil, should be a string
824 specifying a common substring for adding the faces
825 `completions-first-difference' and `completions-common-part' to
826 the completions buffer."
828 (setq completions
(completion-hilit-commonality
829 completions
(length common-substring
)
830 ;; We don't know the base-size.
832 (if (not (bufferp standard-output
))
833 ;; This *never* (ever) happens, so there's no point trying to be clever.
835 (let ((standard-output (current-buffer))
836 (completion-setup-hook nil
))
837 (display-completion-list completions common-substring
))
838 (princ (buffer-string)))
840 (let ((mainbuf (current-buffer)))
841 (with-current-buffer standard-output
842 (goto-char (point-max))
843 (if (null completions
)
844 (insert "There are no possible completions of what you have typed.")
845 (insert "Possible completions are:\n")
846 (let ((last (last completions
)))
847 ;; Set base-size from the tail of the list.
848 (set (make-local-variable 'completion-base-size
)
850 (and (minibufferp mainbuf
) 0)))
851 (setcdr last nil
)) ; Make completions a properly nil-terminated list.
852 (completion--insert-strings completions
)))))
854 ;; The hilit used to be applied via completion-setup-hook, so there
855 ;; may still be some code that uses completion-common-substring.
857 (let ((completion-common-substring common-substring
))
858 (run-hooks 'completion-setup-hook
)))
861 (defun minibuffer-completion-help ()
862 "Display a list of possible completions of the current minibuffer contents."
864 (message "Making completion list...")
865 (let* ((string (field-string))
866 (completions (completion-all-completions
868 minibuffer-completion-table
869 minibuffer-completion-predicate
870 (- (point) (field-beginning)))))
873 (or (consp (cdr completions
))
874 (not (equal (car completions
) string
))))
875 (with-output-to-temp-buffer "*Completions*"
876 (let* ((last (last completions
))
877 (base-size (cdr last
)))
878 ;; Remove the base-size tail because `sort' requires a properly
879 ;; nil-terminated list.
880 (when last
(setcdr last nil
))
881 (display-completion-list (nconc (sort completions
'string-lessp
)
884 ;; If there are no completions, or if the current input is already the
885 ;; only possible completion, then hide (previous&stale) completions.
886 (let ((window (and (get-buffer "*Completions*")
887 (get-buffer-window "*Completions*" 0))))
888 (when (and (window-live-p window
) (window-dedicated-p window
))
890 (delete-window window
)
891 (error (iconify-frame (window-frame window
))))))
894 (if completions
"Sole completion" "No completions")))
897 (defun exit-minibuffer ()
898 "Terminate this minibuffer argument."
900 ;; If the command that uses this has made modifications in the minibuffer,
901 ;; we don't want them to cause deactivation of the mark in the original
903 ;; A better solution would be to make deactivate-mark buffer-local
904 ;; (or to turn it into a list of buffers, ...), but in the mean time,
905 ;; this should do the trick in most cases.
906 (setq deactivate-mark nil
)
909 (defun self-insert-and-exit ()
910 "Terminate minibuffer input."
912 (if (characterp last-command-event
)
913 (call-interactively 'self-insert-command
)
919 (define-obsolete-variable-alias 'minibuffer-local-must-match-filename-map
920 'minibuffer-local-filename-must-match-map
"23.1")
922 (let ((map minibuffer-local-map
))
923 (define-key map
"\C-g" 'abort-recursive-edit
)
924 (define-key map
"\r" 'exit-minibuffer
)
925 (define-key map
"\n" 'exit-minibuffer
))
927 (let ((map minibuffer-local-completion-map
))
928 (define-key map
"\t" 'minibuffer-complete
)
929 ;; M-TAB is already abused for many other purposes, so we should find
930 ;; another binding for it.
931 ;; (define-key map "\e\t" 'minibuffer-force-complete)
932 (define-key map
" " 'minibuffer-complete-word
)
933 (define-key map
"?" 'minibuffer-completion-help
))
935 (let ((map minibuffer-local-must-match-map
))
936 (define-key map
"\r" 'minibuffer-complete-and-exit
)
937 (define-key map
"\n" 'minibuffer-complete-and-exit
))
939 (let ((map minibuffer-local-filename-completion-map
))
940 (define-key map
" " nil
))
941 (let ((map minibuffer-local-filename-must-match-map
))
942 (define-key map
" " nil
))
944 (let ((map minibuffer-local-ns-map
))
945 (define-key map
" " 'exit-minibuffer
)
946 (define-key map
"\t" 'exit-minibuffer
)
947 (define-key map
"?" 'self-insert-and-exit
))
949 ;;; Completion tables.
951 (defun minibuffer--double-dollars (str)
952 (replace-regexp-in-string "\\$" "$$" str
))
954 (defun completion--make-envvar-table ()
955 (mapcar (lambda (enventry)
956 (substring enventry
0 (string-match-p "=" enventry
)))
957 process-environment
))
959 (defconst completion--embedded-envvar-re
960 (concat "\\(?:^\\|[^$]\\(?:\\$\\$\\)*\\)"
961 "$\\([[:alnum:]_]*\\|{\\([^}]*\\)\\)\\'"))
963 (defun completion--embedded-envvar-table (string pred action
)
964 (if (eq (car-safe action
) 'boundaries
)
965 ;; Compute the boundaries of the subfield to which this
966 ;; completion applies.
967 (let ((suffix (cdr action
)))
968 (if (string-match completion--embedded-envvar-re string
)
970 (or (match-beginning 2) (match-beginning 1))
971 (when (string-match "[^[:alnum:]_]" suffix
)
972 (match-beginning 0)))))
973 (when (string-match completion--embedded-envvar-re string
)
974 (let* ((beg (or (match-beginning 2) (match-beginning 1)))
975 (table (completion--make-envvar-table))
976 (prefix (substring string
0 beg
)))
977 (if (eq (aref string
(1- beg
)) ?
{)
978 (setq table
(apply-partially 'completion-table-with-terminator
980 (completion-table-with-context
981 prefix table
(substring string beg
) pred action
)))))
983 (defun completion--file-name-table (string pred action
)
984 "Internal subroutine for `read-file-name'. Do not call this."
986 ((and (zerop (length string
)) (eq 'lambda action
))
988 ((eq (car-safe action
) 'boundaries
)
989 ;; FIXME: Actually, this is not always right in the presence of
990 ;; envvars, but there's not much we can do, I think.
991 (let ((start (length (file-name-directory string
)))
992 (end (string-match-p "/" (cdr action
))))
993 (list* 'boundaries start end
)))
996 (let* ((dir (if (stringp pred
)
997 ;; It used to be that `pred' was abused to pass `dir'
999 (prog1 (expand-file-name pred
) (setq pred nil
))
1001 (str (condition-case nil
1002 (substitute-in-file-name string
)
1004 (name (file-name-nondirectory str
))
1005 (specdir (file-name-directory str
))
1006 (realdir (if specdir
(expand-file-name specdir dir
)
1007 (file-name-as-directory dir
))))
1011 (let ((comp (file-name-completion name realdir
1012 read-file-name-predicate
)))
1014 ;; Requote the $s before returning the completion.
1015 (minibuffer--double-dollars (concat specdir comp
))
1016 ;; Requote the $s before checking for changes.
1017 (setq str
(minibuffer--double-dollars str
))
1018 (if (string-equal string str
)
1020 ;; If there's no real completion, but substitute-in-file-name
1021 ;; changed the string, then return the new string.
1025 (let ((all (file-name-all-completions name realdir
)))
1027 ;; Check the predicate, if necessary.
1028 (unless (memq read-file-name-predicate
'(nil file-exists-p
))
1031 (if (eq read-file-name-predicate
'file-directory-p
)
1032 ;; Brute-force speed up for directory checking:
1033 ;; Discard strings which don't end in a slash.
1035 (let ((len (length s
)))
1036 (and (> len
0) (eq (aref s
(1- len
)) ?
/))))
1037 ;; Must do it the hard (and slow) way.
1038 read-file-name-predicate
)))
1039 (let ((default-directory realdir
))
1041 (if (funcall pred tem
) (push tem comp
))))
1042 (setq all
(nreverse comp
))))
1047 ;; Only other case actually used is ACTION = lambda.
1048 (let ((default-directory dir
))
1049 (funcall (or read-file-name-predicate
'file-exists-p
) str
))))))))
1051 (defalias 'read-file-name-internal
1052 (completion-table-in-turn 'completion--embedded-envvar-table
1053 'completion--file-name-table
)
1054 "Internal subroutine for `read-file-name'. Do not call this.")
1056 (defvar read-file-name-function nil
1057 "If this is non-nil, `read-file-name' does its work by calling this function.")
1059 (defvar read-file-name-predicate nil
1060 "Current predicate used by `read-file-name-internal'.")
1062 (defcustom read-file-name-completion-ignore-case
1063 (if (memq system-type
'(ms-dos windows-nt darwin cygwin
))
1065 "Non-nil means when reading a file name completion ignores case."
1070 (defcustom insert-default-directory t
1071 "Non-nil means when reading a filename start with default dir in minibuffer.
1073 When the initial minibuffer contents show a name of a file or a directory,
1074 typing RETURN without editing the initial contents is equivalent to typing
1075 the default file name.
1077 If this variable is non-nil, the minibuffer contents are always
1078 initially non-empty, and typing RETURN without editing will fetch the
1079 default name, if one is provided. Note however that this default name
1080 is not necessarily the same as initial contents inserted in the minibuffer,
1081 if the initial contents is just the default directory.
1083 If this variable is nil, the minibuffer often starts out empty. In
1084 that case you may have to explicitly fetch the next history element to
1085 request the default name; typing RETURN without editing will leave
1086 the minibuffer empty.
1088 For some commands, exiting with an empty minibuffer has a special meaning,
1089 such as making the current buffer visit no file in the case of
1090 `set-visited-file-name'."
1094 ;; Not always defined, but only called if next-read-file-uses-dialog-p says so.
1095 (declare-function x-file-dialog
"xfns.c"
1096 (prompt dir
&optional default-filename mustmatch only-dir-p
))
1098 (defun read-file-name (prompt &optional dir default-filename mustmatch initial predicate
)
1099 "Read file name, prompting with PROMPT and completing in directory DIR.
1100 Value is not expanded---you must call `expand-file-name' yourself.
1101 Default name to DEFAULT-FILENAME if user exits the minibuffer with
1102 the same non-empty string that was inserted by this function.
1103 (If DEFAULT-FILENAME is omitted, the visited file name is used,
1104 except that if INITIAL is specified, that combined with DIR is used.)
1105 If the user exits with an empty minibuffer, this function returns
1106 an empty string. (This can only happen if the user erased the
1107 pre-inserted contents or if `insert-default-directory' is nil.)
1108 Fourth arg MUSTMATCH non-nil means require existing file's name.
1109 Non-nil and non-t means also require confirmation after completion.
1110 Fifth arg INITIAL specifies text to start with.
1111 If optional sixth arg PREDICATE is non-nil, possible completions and
1112 the resulting file name must satisfy (funcall PREDICATE NAME).
1113 DIR should be an absolute directory name. It defaults to the value of
1114 `default-directory'.
1116 If this command was invoked with the mouse, use a file dialog box if
1117 `use-dialog-box' is non-nil, and the window system or X toolkit in use
1118 provides a file dialog box.
1120 See also `read-file-name-completion-ignore-case'
1121 and `read-file-name-function'."
1122 (unless dir
(setq dir default-directory
))
1123 (unless (file-name-absolute-p dir
) (setq dir
(expand-file-name dir
)))
1124 (unless default-filename
1125 (setq default-filename
(if initial
(expand-file-name initial dir
)
1127 ;; If dir starts with user's homedir, change that to ~.
1128 (setq dir
(abbreviate-file-name dir
))
1129 ;; Likewise for default-filename.
1130 (if default-filename
1131 (setq default-filename
(abbreviate-file-name default-filename
)))
1133 ((and insert-default-directory
(stringp dir
))
1135 (cons (minibuffer--double-dollars (concat dir initial
))
1136 (length (minibuffer--double-dollars dir
)))
1137 (minibuffer--double-dollars dir
)))
1138 (initial (cons (minibuffer--double-dollars initial
) 0)))))
1140 (if read-file-name-function
1141 (funcall read-file-name-function
1142 prompt dir default-filename mustmatch initial predicate
)
1143 (let ((completion-ignore-case read-file-name-completion-ignore-case
)
1144 (minibuffer-completing-file-name t
)
1145 (read-file-name-predicate (or predicate
'file-exists-p
))
1146 (add-to-history nil
))
1149 (if (not (next-read-file-uses-dialog-p))
1150 ;; We used to pass `dir' to `read-file-name-internal' by
1151 ;; abusing the `predicate' argument. It's better to
1152 ;; just use `default-directory', but in order to avoid
1153 ;; changing `default-directory' in the current buffer,
1154 ;; we don't let-bind it.
1155 (lexical-let ((dir (file-name-as-directory
1156 (expand-file-name dir
))))
1157 (minibuffer-with-setup-hook
1158 (lambda () (setq default-directory dir
))
1159 (completing-read prompt
'read-file-name-internal
1160 nil mustmatch insdef
'file-name-history
1162 ;; If DIR contains a file name, split it.
1163 (let ((file (file-name-nondirectory dir
)))
1164 (when (and default-filename
(not (zerop (length file
))))
1165 (setq default-filename file
)
1166 (setq dir
(file-name-directory dir
)))
1167 (if default-filename
1168 (setq default-filename
1169 (expand-file-name default-filename dir
)))
1170 (setq add-to-history t
)
1171 (x-file-dialog prompt dir default-filename mustmatch
1172 (eq predicate
'file-directory-p
)))))
1174 (replace-in-history (eq (car-safe file-name-history
) val
)))
1175 ;; If completing-read returned the inserted default string itself
1176 ;; (rather than a new string with the same contents),
1177 ;; it has to mean that the user typed RET with the minibuffer empty.
1178 ;; In that case, we really want to return ""
1179 ;; so that commands such as set-visited-file-name can distinguish.
1180 (when (eq val default-filename
)
1181 ;; In this case, completing-read has not added an element
1182 ;; to the history. Maybe we should.
1183 (if (not replace-in-history
)
1184 (setq add-to-history t
))
1186 (unless val
(error "No file name specified"))
1188 (if (and default-filename
1189 (string-equal val
(if (consp insdef
) (car insdef
) insdef
)))
1190 (setq val default-filename
))
1191 (setq val
(substitute-in-file-name val
))
1193 (if replace-in-history
1194 ;; Replace what Fcompleting_read added to the history
1195 ;; with what we will actually return.
1196 (let ((val1 (minibuffer--double-dollars val
)))
1197 (if history-delete-duplicates
1198 (setcdr file-name-history
1199 (delete val1
(cdr file-name-history
))))
1200 (setcar file-name-history val1
))
1202 ;; Add the value to the history--but not if it matches
1203 ;; the last value already there.
1204 (let ((val1 (minibuffer--double-dollars val
)))
1205 (unless (and (consp file-name-history
)
1206 (equal (car file-name-history
) val1
))
1207 (setq file-name-history
1209 (if history-delete-duplicates
1210 (delete val1 file-name-history
)
1211 file-name-history
)))))))
1214 (defun internal-complete-buffer-except (&optional buffer
)
1215 "Perform completion on all buffers excluding BUFFER.
1216 BUFFER nil or omitted means use the current buffer.
1217 Like `internal-complete-buffer', but removes BUFFER from the completion list."
1218 (lexical-let ((except (if (stringp buffer
) buffer
(buffer-name buffer
))))
1219 (apply-partially 'completion-table-with-predicate
1220 'internal-complete-buffer
1222 (not (equal (if (consp name
) (car name
) name
) except
)))
1225 ;;; Old-style completion, used in Emacs-21 and Emacs-22.
1227 (defun completion-emacs21-try-completion (string table pred point
)
1228 (let ((completion (try-completion string table pred
)))
1229 (if (stringp completion
)
1230 (cons completion
(length completion
))
1233 (defun completion-emacs21-all-completions (string table pred point
)
1234 (completion-hilit-commonality
1235 (all-completions string table pred
)
1237 (car (completion-boundaries string table pred
""))))
1239 (defun completion-emacs22-try-completion (string table pred point
)
1240 (let ((suffix (substring string point
))
1241 (completion (try-completion (substring string
0 point
) table pred
)))
1242 (if (not (stringp completion
))
1244 ;; Merge a trailing / in completion with a / after point.
1245 ;; We used to only do it for word completion, but it seems to make
1246 ;; sense for all completions.
1247 ;; Actually, claiming this feature was part of Emacs-22 completion
1248 ;; is pushing it a bit: it was only done in minibuffer-completion-word,
1249 ;; which was (by default) not bound during file completion, where such
1250 ;; slashes are most likely to occur.
1251 (if (and (not (zerop (length completion
)))
1252 (eq ?
/ (aref completion
(1- (length completion
))))
1253 (not (zerop (length suffix
)))
1254 (eq ?
/ (aref suffix
0)))
1255 ;; This leaves point after the / .
1256 (setq suffix
(substring suffix
1)))
1257 (cons (concat completion suffix
) (length completion
)))))
1259 (defun completion-emacs22-all-completions (string table pred point
)
1260 (let ((beforepoint (substring string
0 point
)))
1261 (completion-hilit-commonality
1262 (all-completions beforepoint table pred
)
1264 (car (completion-boundaries beforepoint table pred
"")))))
1266 ;;; Basic completion.
1268 (defun completion--merge-suffix (completion point suffix
)
1269 "Merge end of COMPLETION with beginning of SUFFIX.
1270 Simple generalization of the \"merge trailing /\" done in Emacs-22.
1271 Return the new suffix."
1272 (if (and (not (zerop (length suffix
)))
1273 (string-match "\\(.+\\)\n\\1" (concat completion
"\n" suffix
)
1274 ;; Make sure we don't compress things to less
1275 ;; than we started with.
1277 ;; Just make sure we didn't match some other \n.
1278 (eq (match-end 1) (length completion
)))
1279 (substring suffix
(- (match-end 1) (match-beginning 1)))
1280 ;; Nothing to merge.
1283 (defun completion-basic-try-completion (string table pred point
)
1284 (let* ((beforepoint (substring string
0 point
))
1285 (afterpoint (substring string point
))
1286 (bounds (completion-boundaries beforepoint table pred afterpoint
)))
1287 (if (zerop (cdr bounds
))
1288 ;; `try-completion' may return a subtly different result
1289 ;; than `all+merge', so try to use it whenever possible.
1290 (let ((completion (try-completion beforepoint table pred
)))
1291 (if (not (stringp completion
))
1295 (completion--merge-suffix completion point afterpoint
))
1296 (length completion
))))
1297 (let* ((suffix (substring afterpoint
(cdr bounds
)))
1298 (prefix (substring beforepoint
0 (car bounds
)))
1300 "" (list (substring beforepoint
(car bounds
))
1302 (substring afterpoint
0 (cdr bounds
)))))
1303 (all (completion-pcm--all-completions prefix pattern table pred
)))
1304 (if minibuffer-completing-file-name
1305 (setq all
(completion-pcm--filename-try-filter all
)))
1306 (completion-pcm--merge-try pattern all prefix suffix
)))))
1308 (defun completion-basic-all-completions (string table pred point
)
1309 (let* ((beforepoint (substring string
0 point
))
1310 (afterpoint (substring string point
))
1311 (bounds (completion-boundaries beforepoint table pred afterpoint
))
1312 (suffix (substring afterpoint
(cdr bounds
)))
1313 (prefix (substring beforepoint
0 (car bounds
)))
1315 "" (list (substring beforepoint
(car bounds
))
1317 (substring afterpoint
0 (cdr bounds
)))))
1318 (all (completion-pcm--all-completions prefix pattern table pred
)))
1319 (completion-hilit-commonality all point
(car bounds
))))
1321 ;;; Partial-completion-mode style completion.
1323 (defvar completion-pcm--delim-wild-regex nil
)
1325 (defun completion-pcm--prepare-delim-re (delims)
1326 (setq completion-pcm--delim-wild-regex
(concat "[" delims
"*]")))
1328 (defcustom completion-pcm-word-delimiters
"-_. "
1329 "A string of characters treated as word delimiters for completion.
1331 If `]' is in this string, it must come first.
1332 If `^' is in this string, it must not come first.
1333 If `-' is in this string, it must come first or right after `]'.
1334 In other words, if S is this string, then `[S]' must be a valid Emacs regular
1335 expression (not containing character ranges like `a-z')."
1336 :set
(lambda (symbol value
)
1337 (set-default symbol value
)
1338 ;; Refresh other vars.
1339 (completion-pcm--prepare-delim-re value
))
1340 :initialize
'custom-initialize-reset
1344 (defun completion-pcm--pattern-trivial-p (pattern)
1345 (and (stringp (car pattern
))
1346 ;; It can be followed by `point' and "" and still be trivial.
1348 (dolist (elem (cdr pattern
))
1349 (unless (member elem
'(point ""))
1350 (setq trivial nil
)))
1353 (defun completion-pcm--string->pattern
(string &optional point
)
1354 "Split STRING into a pattern.
1355 A pattern is a list where each element is either a string
1356 or a symbol chosen among `any', `star', `point'."
1357 (if (and point
(< point
(length string
)))
1358 (let ((prefix (substring string
0 point
))
1359 (suffix (substring string point
)))
1360 (append (completion-pcm--string->pattern prefix
)
1362 (completion-pcm--string->pattern suffix
)))
1367 (while (setq p
(string-match-p completion-pcm--delim-wild-regex string p
))
1368 (push (substring string p0 p
) pattern
)
1369 (if (eq (aref string p
) ?
*)
1371 (push 'star pattern
)
1377 ;; An empty string might be erroneously added at the beginning.
1378 ;; It should be avoided properly, but it's so easy to remove it here.
1379 (delete "" (nreverse (cons (substring string p0
) pattern
))))))
1381 (defun completion-pcm--pattern->regex
(pattern &optional group
)
1388 (if (if (consp group
) (memq x group
) group
)
1390 (t (regexp-quote x
))))
1393 ;; Avoid pathological backtracking.
1394 (while (string-match "\\.\\*\\?\\(?:\\\\[()]\\)*\\(\\.\\*\\?\\)" re
)
1395 (setq re
(replace-match "" t t re
1)))
1398 (defun completion-pcm--all-completions (prefix pattern table pred
)
1399 "Find all completions for PATTERN in TABLE obeying PRED.
1400 PATTERN is as returned by `completion-pcm--string->pattern'."
1401 ;; (assert (= (car (completion-boundaries prefix table pred ""))
1402 ;; (length prefix)))
1403 ;; Find an initial list of possible completions.
1404 (if (completion-pcm--pattern-trivial-p pattern
)
1406 ;; Minibuffer contains no delimiters -- simple case!
1407 (all-completions (concat prefix
(car pattern
)) table pred
)
1409 ;; Use all-completions to do an initial cull. This is a big win,
1410 ;; since all-completions is written in C!
1411 (let* (;; Convert search pattern to a standard regular expression.
1412 (regex (completion-pcm--pattern->regex pattern
))
1413 (case-fold-search completion-ignore-case
)
1414 (completion-regexp-list (cons regex completion-regexp-list
))
1415 (compl (all-completions
1416 (concat prefix
(if (stringp (car pattern
)) (car pattern
) ""))
1418 (if (not (functionp table
))
1419 ;; The internal functions already obeyed completion-regexp-list.
1423 (when (string-match-p regex c
) (push c poss
)))
1426 (defun completion-pcm--hilit-commonality (pattern completions
)
1428 (let* ((re (completion-pcm--pattern->regex pattern
'(point)))
1429 (case-fold-search completion-ignore-case
))
1430 ;; Remove base-size during mapcar, and add it back later.
1433 ;; Don't modify the string itself.
1434 (setq str
(copy-sequence str
))
1435 (unless (string-match re str
)
1436 (error "Internal error: %s does not match %s" re str
))
1437 (let ((pos (or (match-beginning 1) (match-end 0))))
1438 (put-text-property 0 pos
1439 'font-lock-face
'completions-common-part
1441 (if (> (length str
) pos
)
1442 (put-text-property pos
(1+ pos
)
1443 'font-lock-face
'completions-first-difference
1448 (defun completion-pcm--find-all-completions (string table pred point
1450 "Find all completions for STRING at POINT in TABLE, satisfying PRED.
1451 POINT is a position inside STRING.
1452 FILTER is a function applied to the return value, that can be used, e.g. to
1453 filter out additional entries (because TABLE migth not obey PRED)."
1454 (unless filter
(setq filter
'identity
))
1455 (let* ((beforepoint (substring string
0 point
))
1456 (afterpoint (substring string point
))
1457 (bounds (completion-boundaries beforepoint table pred afterpoint
))
1458 (prefix (substring beforepoint
0 (car bounds
)))
1459 (suffix (substring afterpoint
(cdr bounds
)))
1461 (setq string
(substring string
(car bounds
) (+ point
(cdr bounds
))))
1462 (let* ((relpoint (- point
(car bounds
)))
1463 (pattern (completion-pcm--string->pattern string relpoint
))
1464 (all (condition-case err
1466 (completion-pcm--all-completions
1467 prefix pattern table pred
))
1468 (error (unless firsterror
(setq firsterror err
)) nil
))))
1469 (when (and (null all
)
1471 (null (ignore-errors (try-completion prefix table pred
))))
1472 ;; The prefix has no completions at all, so we should try and fix
1474 (let ((substring (substring prefix
0 -
1)))
1475 (destructuring-bind (subpat suball subprefix subsuffix
)
1476 (completion-pcm--find-all-completions
1477 substring table pred
(length substring
) filter
)
1478 (let ((sep (aref prefix
(1- (length prefix
))))
1479 ;; Text that goes between the new submatches and the
1480 ;; completion substring.
1482 ;; Eliminate submatches that don't end with the separator.
1483 (dolist (submatch (prog1 suball
(setq suball
())))
1484 (when (eq sep
(aref submatch
(1- (length submatch
))))
1485 (push submatch suball
)))
1487 ;; Update the boundaries and corresponding pattern.
1488 ;; We assume that all submatches result in the same boundaries
1489 ;; since we wouldn't know how to merge them otherwise anyway.
1490 ;; FIXME: COMPLETE REWRITE!!!
1491 (let* ((newbeforepoint
1492 (concat subprefix
(car suball
)
1493 (substring string
0 relpoint
)))
1494 (leftbound (+ (length subprefix
) (length (car suball
))))
1495 (newbounds (completion-boundaries
1496 newbeforepoint table pred afterpoint
)))
1497 (unless (or (and (eq (cdr bounds
) (cdr newbounds
))
1498 (eq (car newbounds
) leftbound
))
1499 ;; Refuse new boundaries if they step over
1501 (< (car newbounds
) leftbound
))
1502 ;; The new completed prefix does change the boundaries
1503 ;; of the completed substring.
1504 (setq suffix
(substring afterpoint
(cdr newbounds
)))
1506 (concat (substring newbeforepoint
(car newbounds
))
1507 (substring afterpoint
0 (cdr newbounds
))))
1508 (setq between
(substring newbeforepoint leftbound
1510 (setq pattern
(completion-pcm--string->pattern
1512 (- (length newbeforepoint
)
1514 (dolist (submatch suball
)
1515 (setq all
(nconc (mapcar
1516 (lambda (s) (concat submatch between s
))
1518 (completion-pcm--all-completions
1519 (concat subprefix submatch between
)
1520 pattern table pred
)))
1522 ;; FIXME: This can come in handy for try-completion,
1523 ;; but isn't right for all-completions, since it lists
1524 ;; invalid completions.
1526 ;; ;; Even though we found expansions in the prefix, none
1527 ;; ;; leads to a valid completion.
1528 ;; ;; Let's keep the expansions, tho.
1529 ;; (dolist (submatch suball)
1530 ;; (push (concat submatch between newsubstring) all)))
1532 (setq pattern
(append subpat
(list 'any
(string sep
))
1533 (if between
(list between
)) pattern
))
1534 (setq prefix subprefix
)))))
1535 (if (and (null all
) firsterror
)
1536 (signal (car firsterror
) (cdr firsterror
))
1537 (list pattern all prefix suffix
)))))
1539 (defun completion-pcm-all-completions (string table pred point
)
1540 (destructuring-bind (pattern all
&optional prefix suffix
)
1541 (completion-pcm--find-all-completions string table pred point
)
1543 (nconc (completion-pcm--hilit-commonality pattern all
)
1546 (defun completion-pcm--merge-completions (strs pattern
)
1547 "Extract the commonality in STRS, with the help of PATTERN."
1549 ((null (cdr strs
)) (list (car strs
)))
1551 (let ((re (completion-pcm--pattern->regex pattern
'group
))
1552 (ccs ())) ;Chopped completions.
1554 ;; First chop each string into the parts corresponding to each
1555 ;; non-constant element of `pattern', using regexp-matching.
1556 (let ((case-fold-search completion-ignore-case
))
1558 (unless (string-match re str
)
1559 (error "Internal error: %s doesn't match %s" str re
))
1562 (while (match-beginning i
)
1563 (push (match-string i str
) chopped
)
1565 ;; Add the text corresponding to the implicit trailing `any'.
1566 (push (substring str
(match-end 0)) chopped
)
1567 (push (nreverse chopped
) ccs
))))
1569 ;; Then for each of those non-constant elements, extract the
1570 ;; commonality between them.
1572 ;; Make the implicit `any' explicit. We could make it explicit
1573 ;; everywhere, but it would slow down regexp-matching a little bit.
1574 (dolist (elem (append pattern
'(any)))
1578 (dolist (cc (prog1 ccs
(setq ccs nil
)))
1579 (push (car cc
) comps
)
1580 (push (cdr cc
) ccs
))
1581 (let* ((prefix (try-completion "" comps
))
1582 (unique (or (and (eq prefix t
) (setq prefix
""))
1583 (eq t
(try-completion prefix comps
)))))
1584 (unless (equal prefix
"") (push prefix res
))
1585 ;; If there's only one completion, `elem' is not useful
1586 ;; any more: it can only match the empty string.
1587 ;; FIXME: in some cases, it may be necessary to turn an
1588 ;; `any' into a `star' because the surrounding context has
1589 ;; changed such that string->pattern wouldn't add an `any'
1591 (unless unique
(push elem res
))))))
1592 ;; We return it in reverse order.
1595 (defun completion-pcm--pattern->string
(pattern)
1596 (mapconcat (lambda (x) (cond
1600 ((eq x
'point
) "")))
1604 ;; We want to provide the functionality of `try', but we use `all'
1605 ;; and then merge it. In most cases, this works perfectly, but
1606 ;; if the completion table doesn't consider the same completions in
1607 ;; `try' as in `all', then we have a problem. The most common such
1608 ;; case is for filename completion where completion-ignored-extensions
1609 ;; is only obeyed by the `try' code. We paper over the difference
1610 ;; here. Note that it is not quite right either: if the completion
1611 ;; table uses completion-table-in-turn, this filtering may take place
1612 ;; too late to correctly fallback from the first to the
1613 ;; second alternative.
1614 (defun completion-pcm--filename-try-filter (all)
1615 "Filter to adjust `all' file completion to the behavior of `try'."
1618 (re (concat "\\(?:\\`\\.\\.?/\\|"
1619 (regexp-opt completion-ignored-extensions
)
1622 (unless (string-match-p re f
) (push f try
)))
1626 (defun completion-pcm--merge-try (pattern all prefix suffix
)
1628 ((not (consp all
)) all
)
1629 ((and (not (consp (cdr all
))) ;Only one completion.
1630 ;; Ignore completion-ignore-case here.
1631 (equal (completion-pcm--pattern->string pattern
) (car all
)))
1634 (let* ((mergedpat (completion-pcm--merge-completions all pattern
))
1635 ;; `mergedpat' is in reverse order. Place new point (by
1636 ;; order of preference) either at the old point, or at
1637 ;; the last place where there's something to choose, or
1639 (pointpat (or (memq 'point mergedpat
) (memq 'any mergedpat
)
1641 ;; New pos from the start.
1642 (newpos (length (completion-pcm--pattern->string pointpat
)))
1643 ;; Do it afterwards because it changes `pointpat' by sideeffect.
1644 (merged (completion-pcm--pattern->string
(nreverse mergedpat
))))
1646 (setq suffix
(completion--merge-suffix merged newpos suffix
))
1647 (cons (concat prefix merged suffix
) (+ newpos
(length prefix
)))))))
1649 (defun completion-pcm-try-completion (string table pred point
)
1650 (destructuring-bind (pattern all prefix suffix
)
1651 (completion-pcm--find-all-completions
1652 string table pred point
1653 (if minibuffer-completing-file-name
1654 'completion-pcm--filename-try-filter
))
1655 (completion-pcm--merge-try pattern all prefix suffix
)))
1658 (provide 'minibuffer
)
1660 ;; arch-tag: ef8a0a15-1080-4790-a754-04017c02f08f
1661 ;;; minibuffer.el ends here