minibuffer.el 73.3 KB
Newer Older
1 2
;;; minibuffer.el --- Minibuffer completion functions

Glenn Morris's avatar
Glenn Morris committed
3
;; Copyright (C) 2008, 2009  Free Software Foundation, Inc.
4 5 6 7 8

;; Author: Stefan Monnier <monnier@iro.umontreal.ca>

;; This file is part of GNU Emacs.

9
;; GNU Emacs is free software: you can redistribute it and/or modify
10 11 12 13
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.

14
;; GNU Emacs is distributed in the hope that it will be useful,
15 16 17 18 19
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; 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/>.
21 22 23

;;; Commentary:

24 25 26 27 28
;; Names with "--" are for functions and variables that are meant to be for
;; internal use only.

;; Functional completion tables have an extended calling conventions:
;; - The `action' can be (additionally to nil, t, and lambda) of the form
29 30
;;   (boundaries . SUFFIX) in which case it should return
;;   (boundaries START . END).  See `completion-boundaries'.
31 32 33 34 35 36
;;   Any other return value should be ignored (so we ignore values returned
;;   from completion tables that don't know about this new `action' form).
;;   See `completion-boundaries'.

;;; Bugs:

37 38 39
;; - completion-all-sorted-completions list all the completions, whereas
;;   it should only lists the ones that `try-completion' would consider.
;;   E.g.  it should honor completion-ignored-extensions.
40 41 42 43
;; - choose-completion can't automatically figure out the boundaries
;;   corresponding to the displayed completions.  `base-size' gives the left
;;   boundary, but not the righthand one.  So we need to add
;;   completion-extra-size (and also completion-no-auto-exit).
44

45 46
;;; Todo:

47
;; - make lisp-complete-symbol and sym-comp use it.
48
;; - add support for ** to pcm.
49
;; - Make read-file-name-predicate obsolete.
50 51
;; - Add vc-file-name-completion-table to read-file-name-internal.
;; - A feature like completing-help.el.
52
;; - make lisp/complete.el obsolete.
53
;; - Make the `hide-spaces' arg of all-completions obsolete?
54 55 56 57 58

;;; Code:

(eval-when-compile (require 'cl))

59 60
;;; Completion table manipulation

61
;; New completion-table operation.
62 63
(defun completion-boundaries (string table pred suffix)
  "Return the boundaries of the completions returned by TABLE for STRING.
64
STRING is the string on which completion will be performed.
65 66 67 68 69 70
SUFFIX is the string after point.
The result is of the form (START . END) where START is the position
in STRING of the beginning of the completion field and END is the position
in SUFFIX of the end of the completion field.
E.g. for simple completion tables, the result is always (0 . (length SUFFIX))
and for file names the result is the positions delimited by
71 72
the closest directory separators."
  (let ((boundaries (if (functionp table)
73
                        (funcall table string pred (cons 'boundaries suffix)))))
74 75 76
    (if (not (eq (car-safe boundaries) 'boundaries))
        (setq boundaries nil))
    (cons (or (cadr boundaries) 0)
77
          (or (cddr boundaries) (length suffix)))))
78

79 80 81 82
(defun completion--some (fun xs)
  "Apply FUN to each element of XS in turn.
Return the first non-nil returned value.
Like CL's `some'."
83 84
  (let ((firsterror nil)
        res)
85
    (while (and (not res) xs)
86 87 88 89 90
      (condition-case err
          (setq res (funcall fun (pop xs)))
        (error (unless firsterror (setq firsterror err)) nil)))
    (or res
        (if firsterror (signal (car firsterror) (cdr firsterror))))))
91

92 93 94 95 96 97
(defun complete-with-action (action table string pred)
  "Perform completion ACTION.
STRING is the string to complete.
TABLE is the completion table, which should not be a function.
PRED is a completion predicate.
ACTION can be one of nil, t or `lambda'."
98 99 100 101 102 103 104 105 106 107 108
  (cond
   ((functionp table) (funcall table string pred action))
   ((eq (car-safe action) 'boundaries)
    (cons 'boundaries (completion-boundaries string table pred (cdr action))))
   (t
    (funcall
     (cond
      ((null action) 'try-completion)
      ((eq action t) 'all-completions)
      (t 'test-completion))
     string table pred))))
109 110 111 112

(defun completion-table-dynamic (fun)
  "Use function FUN as a dynamic completion table.
FUN is called with one argument, the string for which completion is required,
113 114 115 116
and it should return an alist containing all the intended possible completions.
This alist may be a full list of possible completions so that FUN can ignore
the value of its argument.  If completion is performed in the minibuffer,
FUN will be called in the buffer from which the minibuffer was entered.
117

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 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137
  (lexical-let ((fun fun))
    (lambda (string pred action)
      (with-current-buffer (let ((win (minibuffer-selected-window)))
                             (if (window-live-p win) (window-buffer win)
                               (current-buffer)))
        (complete-with-action action (funcall fun string) string pred)))))

(defmacro lazy-completion-table (var fun)
  "Initialize variable VAR as a lazy completion table.
If the completion table VAR is used for the first time (e.g., by passing VAR
as an argument to `try-completion'), the function FUN is called with no
arguments.  FUN must return the completion table that will be stored in VAR.
If completion is requested in the minibuffer, FUN will be called in the buffer
from which the minibuffer was entered.  The return value of
`lazy-completion-table' must be used to initialize the value of VAR.

You should give VAR a non-nil `risky-local-variable' property."
138
  (declare (debug (symbolp lambda-expr)))
139 140 141 142 143 144 145 146
  (let ((str (make-symbol "string")))
    `(completion-table-dynamic
      (lambda (,str)
        (when (functionp ,var)
          (setq ,var (,fun)))
        ,var))))

(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 150 151 152 153 154 155 156 157 158 159 160 161 162 163
  (when (functionp pred)
    (setq pred
          (lexical-let ((pred pred))
            ;; Predicates are called differently depending on the nature of
            ;; the completion table :-(
            (cond
             ((vectorp table)           ;Obarray.
              (lambda (sym) (funcall pred (concat prefix (symbol-name sym)))))
             ((hash-table-p table)
              (lambda (s v) (funcall pred (concat prefix s))))
             ((functionp table)
              (lambda (s) (funcall pred (concat prefix s))))
             (t                         ;Lists and alists.
              (lambda (s)
                (funcall pred (concat prefix (if (consp s) (car s) s)))))))))
164 165
  (if (eq (car-safe action) 'boundaries)
      (let* ((len (length prefix))
166 167
             (bound (completion-boundaries string table pred (cdr action))))
        (list* 'boundaries (+ (car bound) len) (cdr bound)))
168 169 170 171 172
    (let ((comp (complete-with-action action table string pred)))
      (cond
       ;; In case of try-completion, add the prefix.
       ((stringp comp) (concat prefix comp))
       (t comp)))))
173 174

(defun completion-table-with-terminator (terminator table string pred action)
175 176 177
  (cond
   ((eq action nil)
    (let ((comp (try-completion string table pred)))
178 179 180
      (if (eq comp t)
          (concat string terminator)
        (if (and (stringp comp)
181
                 (eq (try-completion comp table pred) t))
182
            (concat comp terminator)
183
          comp))))
184 185 186 187 188
   ((eq action t)
    ;; FIXME: We generally want the `try' and `all' behaviors to be
    ;; consistent so pcm can merge the `all' output to get the `try' output,
    ;; but that sometimes clashes with the need for `all' output to look
    ;; good in *Completions*.
189 190
    ;; (mapcar (lambda (s) (concat s terminator))
    ;;         (all-completions string table pred))))
191
    (all-completions string table pred))
192 193 194 195 196 197 198
   ;; completion-table-with-terminator is always used for
   ;; "sub-completions" so it's only called if the terminator is missing,
   ;; in which case `test-completion' should return nil.
   ((eq action 'lambda) nil)))

(defun completion-table-with-predicate (table pred1 strict string pred2 action)
  "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 201 202
argument is an element of TABLE which should be considered for completion.
STRING, PRED2, and ACTION are the usual arguments to completion tables,
as described in `try-completion', `all-completions', and `test-completion'.
203 204
If STRICT is t, the predicate always applies; if nil it only applies if
it does not reduce the set of possible completions to nothing.
205 206 207 208
Note: TABLE needs to be a proper completion table which obeys predicates."
  (cond
   ((and (not strict) (eq action 'lambda))
    ;; Ignore pred1 since it doesn't really have to apply anyway.
209
    (test-completion string table pred2))
210 211 212 213 214 215 216 217 218 219 220 221
   (t
    (or (complete-with-action action table string
                              (if (null pred2) pred1
                                (lexical-let ((pred1 pred2) (pred2 pred2))
                                  (lambda (x)
                                    ;; Call `pred1' first, so that `pred2'
                                    ;; really can't tell that `x' is in table.
                                    (if (funcall pred1 x) (funcall pred2 x))))))
        ;; If completion failed and we're not applying pred1 strictly, try
        ;; again without pred1.
        (and (not strict)
             (complete-with-action action table string pred2))))))
222

223 224 225
(defun completion-table-in-turn (&rest tables)
  "Create a completion table that tries each table in TABLES in turn."
  (lexical-let ((tables tables))
226
    (lambda (string pred action)
227 228 229 230
      (completion--some (lambda (table)
                          (complete-with-action action table string pred))
                        tables))))

231 232
;; (defmacro complete-in-turn (a b) `(completion-table-in-turn ,a ,b))
;; (defmacro dynamic-completion-table (fun) `(completion-table-dynamic ,fun))
233 234
(define-obsolete-function-alias
  'complete-in-turn 'completion-table-in-turn "23.1")
235 236
(define-obsolete-function-alias
  'dynamic-completion-table 'completion-table-dynamic "23.1")
237 238 239

;;; Minibuffer completion

240 241 242 243 244
(defgroup minibuffer nil
  "Controlling the behavior of the minibuffer."
  :link '(custom-manual "(emacs)Minibuffer")
  :group 'environment)

245 246 247 248 249 250 251 252
(defun minibuffer-message (message &rest args)
  "Temporarily display MESSAGE at the end of the minibuffer.
The text is displayed for `minibuffer-message-timeout' seconds,
or until the next input event arrives, whichever comes first.
Enclose MESSAGE in [...] if this is not yet the case.
If ARGS are provided, then pass MESSAGE through `format'."
  ;; Clear out any old echo-area message to make way for our new thing.
  (message nil)
253 254 255 256
  (setq message (if (and (null args) (string-match "\\[.+\\]" message))
                    ;; Make sure we can put-text-property.
                    (copy-sequence message)
                  (concat " [" message "]")))
257
  (when args (setq message (apply 'format message args)))
258
  (let ((ol (make-overlay (point-max) (point-max) nil t t))
259 260 261 262 263 264
	;; A quit during sit-for normally only interrupts the sit-for,
        ;; but since minibuffer-message is used at the end of a command,
        ;; at a time when the command has virtually finished already, a C-g
        ;; should really cause an abort-recursive-edit instead (i.e. as if
        ;; the C-g had been typed at top-level).  Binding inhibit-quit here
        ;; is an attempt to get that behavior.
265
	(inhibit-quit t))
266 267
    (unwind-protect
        (progn
268 269 270 271 272
          (unless (zerop (length message))
            ;; The current C cursor code doesn't know to use the overlay's
            ;; marker's stickiness to figure out whether to place the cursor
            ;; before or after the string, so let's spoon-feed it the pos.
            (put-text-property 0 1 'cursor t message))
273 274 275 276 277 278 279 280 281 282 283 284
          (overlay-put ol 'after-string message)
          (sit-for (or minibuffer-message-timeout 1000000)))
      (delete-overlay ol))))

(defun minibuffer-completion-contents ()
  "Return the user input in a minibuffer before point as a string.
That is what completion commands operate on."
  (buffer-substring (field-beginning) (point)))

(defun delete-minibuffer-contents ()
  "Delete all user input in a minibuffer.
If the current buffer is not a minibuffer, erase its entire contents."
285 286 287
  ;; We used to do `delete-field' here, but when file name shadowing
  ;; is on, the field doesn't cover the entire minibuffer contents.
  (delete-region (minibuffer-prompt-end) (point-max)))
288

289 290 291 292 293 294
(defcustom completion-auto-help t
  "Non-nil means automatically provide help for invalid completion input.
If the value is t the *Completion* buffer is displayed whenever completion
is requested but cannot be done.
If the value is `lazy', the *Completions* buffer is only displayed after
the second failed attempt to complete."
295
  :type '(choice (const nil) (const t) (const lazy))
296 297
  :group 'minibuffer)

298
(defvar completion-styles-alist
299 300 301
  '((basic completion-basic-try-completion completion-basic-all-completions)
    (emacs22 completion-emacs22-try-completion completion-emacs22-all-completions)
    (emacs21 completion-emacs21-try-completion completion-emacs21-all-completions)
302 303
    (partial-completion
     completion-pcm-try-completion completion-pcm-all-completions))
304 305
  "List of available completion styles.
Each element has the form (NAME TRY-COMPLETION ALL-COMPLETIONS)
306
where NAME is the name that should be used in `completion-styles',
307 308 309
TRY-COMPLETION is the function that does the completion, and
ALL-COMPLETIONS is the function that lists the completions.")

310
(defcustom completion-styles '(basic partial-completion)
311 312 313 314 315 316
  "List of completion styles to use."
  :type `(repeat (choice ,@(mapcar (lambda (x) (list 'const (car x)))
                                   completion-styles-alist)))
  :group 'minibuffer
  :version "23.1")

317 318 319 320 321 322 323 324
(defun completion-try-completion (string table pred point)
  "Try to complete STRING using completion table TABLE.
Only the elements of table that satisfy predicate PRED are considered.
POINT is the position of point within STRING.
The return value can be either nil to indicate that there is no completion,
t to indicate that STRING is the only possible completion,
or a pair (STRING . NEWPOINT) of the completed result string together with
a new position for point."
325 326 327 328
  ;; The property `completion-styles' indicates that this functional
  ;; completion-table claims to take care of completion styles itself.
  ;; [I.e. It will most likely call us back at some point. ]
  (if (and (symbolp table) (get table 'completion-styles))
329 330 331 332 333
      ;; Extended semantics for functional completion-tables:
      ;; They accept a 4th argument `point' and when called with action=nil
      ;; and this 4th argument (a position inside `string'), they should
      ;; return instead of a string a pair (STRING . NEWPOINT).
      (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))
337 338
                      completion-styles)))

339 340 341 342
(defun completion-all-completions (string table pred point)
  "List the possible completions of STRING in completion table TABLE.
Only the elements of table that satisfy predicate PRED are considered.
POINT is the position of point within STRING.
343
The return value is a list of completions and may contain the base-size
344
in the last `cdr'."
345 346 347 348 349 350 351 352 353 354 355 356 357
  ;; The property `completion-styles' indicates that this functional
  ;; completion-table claims to take care of completion styles itself.
  ;; [I.e. It will most likely call us back at some point. ]
  (if (and (symbolp table) (get table 'completion-styles))
      ;; Extended semantics for functional completion-tables:
      ;; They accept a 4th argument `point' and when called with action=t
      ;; and this 4th argument (a position inside `string'), they may
      ;; return BASE-SIZE in the last `cdr'.
      (funcall table string pred t point)
    (completion--some (lambda (style)
                        (funcall (nth 2 (assq style completion-styles-alist))
                                 string table pred point))
                      completion-styles)))
358

359 360 361 362 363
(defun minibuffer--bitset (modified completions exact)
  (logior (if modified    4 0)
          (if completions 2 0)
          (if exact       1 0)))

364
(defun completion--do-completion (&optional try-completion-function)
365
  "Do the completion and return a summary of what happened.
366 367 368 369 370 371 372 373 374 375 376 377 378 379
M = completion was performed, the text was Modified.
C = there were available Completions.
E = after completion we now have an Exact match.

 MCE
 000  0 no possible completion
 001  1 was already an exact and unique completion
 010  2 no completion happened
 011  3 was already an exact completion
 100  4 ??? impossible
 101  5 ??? impossible
 110  6 some completion happened
 111  7 completed to an exact completion"
  (let* ((beg (field-beginning))
380
         (end (field-end))
381
         (string (buffer-substring beg end))
382 383 384 385 386 387
         (comp (funcall (or try-completion-function
			    'completion-try-completion)
			string
			minibuffer-completion-table
			minibuffer-completion-predicate
			(- (point) beg))))
388
    (cond
389
     ((null comp)
390
      (ding) (minibuffer-message "No match") (minibuffer--bitset nil nil nil))
391
     ((eq t comp) (minibuffer--bitset nil nil t)) ;Exact and unique match.
392 393 394 395
     (t
      ;; `completed' should be t if some completion was done, which doesn't
      ;; include simply changing the case of the entered string.  However,
      ;; for appearance, the string is rewritten if the case changes.
396 397 398 399
      (let* ((comp-pos (cdr comp))
	     (completion (car comp))
	     (completed (not (eq t (compare-strings completion nil nil
						    string nil nil t))))
400 401
	     (unchanged (eq t (compare-strings completion nil nil
					       string nil nil nil))))
402
        (unless unchanged
403 404

          ;; Insert in minibuffer the chars we got.
405 406
          (goto-char end)
          (insert completion)
407 408 409
          (delete-region beg end))
	;; Move point.
	(goto-char (+ beg comp-pos))
410

411 412 413 414 415
        (if (not (or unchanged completed))
	   ;; The case of the string changed, but that's all.  We're not sure
	   ;; whether this is a unique completion or not, so try again using
	   ;; the real case (this shouldn't recurse again, because the next
	   ;; time try-completion will return either t or the exact string).
416
           (completion--do-completion try-completion-function)
417 418

          ;; It did find a match.  Do we match some possibility exactly now?
419
          (let ((exact (test-completion completion
420 421
					minibuffer-completion-table
					minibuffer-completion-predicate)))
422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437
            (unless completed
              ;; Show the completion table, if requested.
              (cond
               ((not exact)
                (if (case completion-auto-help
                      (lazy (eq this-command last-command))
                      (t completion-auto-help))
                    (minibuffer-completion-help)
                  (minibuffer-message "Next char not unique")))
               ;; If the last exact completion and this one were the same,
               ;; it means we've already given a "Complete but not unique"
               ;; message and the user's hit TAB again, so now we give him help.
               ((eq this-command last-command)
                (if completion-auto-help (minibuffer-completion-help)))))

            (minibuffer--bitset completed t exact))))))))
438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462

(defun minibuffer-complete ()
  "Complete the minibuffer contents as far as possible.
Return nil if there is no valid completion, else t.
If no characters can be completed, display a list of possible completions.
If you repeat this command after it displayed such a list,
scroll the window of possible completions."
  (interactive)
  ;; If the previous command was not this,
  ;; mark the completion buffer obsolete.
  (unless (eq this-command last-command)
    (setq minibuffer-scroll-window nil))

  (let ((window minibuffer-scroll-window))
    ;; If there's a fresh completion window with a live buffer,
    ;; and this command is repeated, scroll that window.
    (if (window-live-p window)
        (with-current-buffer (window-buffer window)
          (if (pos-visible-in-window-p (point-max) window)
	      ;; If end is in view, scroll up to the beginning.
	      (set-window-start window (point-min) nil)
	    ;; Else scroll down one screen.
	    (scroll-other-window))
	  nil)

463
      (case (completion--do-completion)
464 465 466 467 468 469 470 471
        (#b000 nil)
        (#b001 (goto-char (field-end))
               (minibuffer-message "Sole completion")
               t)
        (#b011 (goto-char (field-end))
               (minibuffer-message "Complete, but not unique")
               t)
        (t     t)))))
472

473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525
(defvar completion-all-sorted-completions nil)
(make-variable-buffer-local 'completion-all-sorted-completions)

(defun completion--flush-all-sorted-completions (&rest ignore)
  (setq completion-all-sorted-completions nil))

(defun completion-all-sorted-completions ()
  (or completion-all-sorted-completions
      (let* ((start (field-beginning))
             (end (field-end))
             (all (completion-all-completions (buffer-substring start end)
                                              minibuffer-completion-table
                                              minibuffer-completion-predicate
                                              (- (point) start)))
             (last (last all))
             (base-size (or (cdr last) 0)))
        (when last
          (setcdr last nil)
          ;; Prefer shorter completions.
          (setq all (sort all (lambda (c1 c2) (< (length c1) (length c2)))))
          ;; Prefer recently used completions.
          (let ((hist (symbol-value minibuffer-history-variable)))
            (setq all (sort all (lambda (c1 c2)
                                  (> (length (member c1 hist))
                                     (length (member c2 hist)))))))
          ;; Cache the result.  This is not just for speed, but also so that
          ;; repeated calls to minibuffer-force-complete can cycle through
          ;; all possibilities.
          (add-hook 'after-change-functions
                    'completion--flush-all-sorted-completions nil t)
          (setq completion-all-sorted-completions
                (nconc all base-size))))))

(defun minibuffer-force-complete ()
  "Complete the minibuffer to an exact match.
Repeated uses step through the possible completions."
  (interactive)
  ;; FIXME: Need to deal with the extra-size issue here as well.
  (let* ((start (field-beginning))
         (end (field-end))
         (all (completion-all-sorted-completions)))
    (if (not (consp all))
        (minibuffer-message (if all "No more completions" "No completions"))
      (goto-char end)
      (insert (car all))
      (delete-region (+ start (cdr (last all))) end)
      ;; If completing file names, (car all) may be a directory, so we'd now
      ;; have a new set of possible completions and might want to reset
      ;; completion-all-sorted-completions to nil, but we prefer not to,
      ;; so that repeated calls minibuffer-force-complete still cycle
      ;; through the previous possible completions.
      (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 529 530
  "A list of commands which cause an immediately following
`minibuffer-complete-and-exit' to ask for extra confirmation.")

531
(defun minibuffer-complete-and-exit ()
532 533 534 535 536 537 538 539 540 541 542 543
  "Exit if the minibuffer contains a valid completion.
Otherwise, try to complete the minibuffer contents.  If
completion leads to a valid completion, a repetition of this
command will exit.

If `minibuffer-completion-confirm' is `confirm', do not try to
 complete; instead, ask for confirmation and accept any input if
 confirmed.
If `minibuffer-completion-confirm' is `confirm-after-completion',
 do not try to complete; instead, ask for confirmation if the
 preceding minibuffer command was `minibuffer-complete', and
 accept the input otherwise."
544
  (interactive)
545 546 547 548 549 550 551 552 553 554
  (let ((beg (field-beginning))
        (end (field-end)))
    (cond
     ;; Allow user to specify null string
     ((= beg end) (exit-minibuffer))
     ((test-completion (buffer-substring beg end)
                       minibuffer-completion-table
                       minibuffer-completion-predicate)
      (when completion-ignore-case
        ;; Fixup case of the field, if necessary.
555
        (let* ((string (buffer-substring beg end))
556 557 558 559 560 561 562
               (compl (try-completion
                       string
                       minibuffer-completion-table
                       minibuffer-completion-predicate)))
          (when (and (stringp compl)
                     ;; If it weren't for this piece of paranoia, I'd replace
                     ;; the whole thing with a call to do-completion.
563 564 565 566
                     ;; This is important, e.g. when the current minibuffer's
                     ;; content is a directory which only contains a single
                     ;; file, so `try-completion' actually completes to
                     ;; that file.
567
                     (= (length string) (length compl)))
568 569
            (goto-char end)
            (insert compl)
570 571
            (delete-region beg end))))
      (exit-minibuffer))
572

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 577 578 579
      (if (eq last-command this-command)
          (exit-minibuffer)
        (minibuffer-message "Confirm")
        nil))
580

581 582 583
     ((eq minibuffer-completion-confirm 'confirm-after-completion)
      ;; Similar to the above, but only if trying to exit immediately
      ;; after typing TAB (this catches most minibuffer typos).
584
      (if (memq last-command minibuffer-confirm-exit-commands)
585 586 587 588
	  (progn (minibuffer-message "Confirm")
		 nil)
	(exit-minibuffer)))

589 590 591 592 593
     (t
      ;; Call do-completion, but ignore errors.
      (case (condition-case nil
                (completion--do-completion)
              (error 1))
594 595 596 597 598
        ((#b001 #b011) (exit-minibuffer))
        (#b111 (if (not minibuffer-completion-confirm)
                   (exit-minibuffer)
                 (minibuffer-message "Confirm")
                 nil))
599 600
        (t nil))))))

601 602 603 604
(defun completion--try-word-completion (string table predicate point)
  (let ((comp (completion-try-completion string table predicate point)))
    (if (not (consp comp))
        comp
605

606 607
      ;; If completion finds next char not unique,
      ;; consider adding a space or a hyphen.
608
      (when (= (length string) (length (car comp)))
609
        (let ((exts '(" " "-"))
610 611
              (before (substring string 0 point))
              (after (substring string point))
612 613
	      ;; Disable partial-completion for this.
	      (completion-styles
614 615
	       (or (remove 'partial-completion completion-styles)
		   completion-styles))
616 617
	      tem)
	  (while (and exts (not (consp tem)))
618
            (setq tem (completion-try-completion
619 620 621
		       (concat before (pop exts) after)
		       table predicate (1+ point))))
	  (if (consp tem) (setq comp tem))))
622

623 624 625 626 627 628 629
      ;; Completing a single word is actually more difficult than completing
      ;; as much as possible, because we first have to find the "current
      ;; position" in `completion' in order to find the end of the word
      ;; we're completing.  Normally, `string' is a prefix of `completion',
      ;; which makes it trivial to find the position, but with fancier
      ;; completion (plus env-var expansion, ...) `completion' might not
      ;; look anything like `string' at all.
630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681
      (let* ((comppoint (cdr comp))
	     (completion (car comp))
	     (before (substring string 0 point))
	     (combined (concat before "\n" completion)))
        ;; Find in completion the longest text that was right before point.
        (when (string-match "\\(.+\\)\n.*?\\1" combined)
          (let* ((prefix (match-string 1 before))
                 ;; We used non-greedy match to make `rem' as long as possible.
                 (rem (substring combined (match-end 0)))
                 ;; Find in the remainder of completion the longest text
                 ;; that was right after point.
                 (after (substring string point))
                 (suffix (if (string-match "\\`\\(.+\\).*\n.*\\1"
                                           (concat after "\n" rem))
                             (match-string 1 after))))
            ;; The general idea is to try and guess what text was inserted
            ;; at point by the completion.  Problem is: if we guess wrong,
            ;; we may end up treating as "added by completion" text that was
            ;; actually painfully typed by the user.  So if we then cut
            ;; after the first word, we may throw away things the
            ;; user wrote.  So let's try to be as conservative as possible:
            ;; only cut after the first word, if we're reasonably sure that
            ;; our guess is correct.
            ;; Note: a quick survey on emacs-devel seemed to indicate that
            ;; nobody actually cares about the "word-at-a-time" feature of
            ;; minibuffer-complete-word, whose real raison-d'être is that it
            ;; tries to add "-" or " ".  One more reason to only cut after
            ;; the first word, if we're really sure we're right.
            (when (and (or suffix (zerop (length after)))
                       (string-match (concat
                                      ;; Make submatch 1 as small as possible
                                      ;; to reduce the risk of cutting
                                      ;; valuable text.
                                      ".*" (regexp-quote prefix) "\\(.*?\\)"
                                      (if suffix (regexp-quote suffix) "\\'"))
                                     completion)
                       ;; The new point in `completion' should also be just
                       ;; before the suffix, otherwise something more complex
                       ;; is going on, and we're not sure where we are.
                       (eq (match-end 1) comppoint)
                       ;; (match-beginning 1)..comppoint is now the stretch
                       ;; of text in `completion' that was completed at point.
		       (string-match "\\W" completion (match-beginning 1))
		       ;; Is there really something to cut?
		       (> comppoint (match-end 0)))
              ;; Cut after the first word.
              (let ((cutpos (match-end 0)))
                (setq completion (concat (substring completion 0 cutpos)
                                         (substring completion comppoint)))
                (setq comppoint cutpos)))))

	(cons completion comppoint)))))
682 683 684 685 686 687 688 689


(defun minibuffer-complete-word ()
  "Complete the minibuffer contents at most a single word.
After one word is completed as much as possible, a space or hyphen
is added, provided that matches some possible completion.
Return nil if there is no valid completion, else t."
  (interactive)
690
  (case (completion--do-completion 'completion--try-word-completion)
691 692 693 694 695 696 697 698
    (#b000 nil)
    (#b001 (goto-char (field-end))
           (minibuffer-message "Sole completion")
           t)
    (#b011 (goto-char (field-end))
           (minibuffer-message "Complete, but not unique")
           t)
    (t     t)))
699

700
(defun completion--insert-strings (strings)
701 702 703 704 705 706 707
  "Insert a list of STRINGS into the current buffer.
Uses columns to keep the listing readable but compact.
It also eliminates runs of equal strings."
  (when (consp strings)
    (let* ((length (apply 'max
			  (mapcar (lambda (s)
				    (if (consp s)
708 709 710
					(+ (string-width (car s))
                                           (string-width (cadr s)))
				      (string-width s)))
711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737
				  strings)))
	   (window (get-buffer-window (current-buffer) 0))
	   (wwidth (if window (1- (window-width window)) 79))
	   (columns (min
		     ;; At least 2 columns; at least 2 spaces between columns.
		     (max 2 (/ wwidth (+ 2 length)))
		     ;; Don't allocate more columns than we can fill.
		     ;; Windows can't show less than 3 lines anyway.
		     (max 1 (/ (length strings) 2))))
	   (colwidth (/ wwidth columns))
           (column 0)
	   (laststring nil))
      ;; The insertion should be "sensible" no matter what choices were made
      ;; for the parameters above.
      (dolist (str strings)
	(unless (equal laststring str)  ; Remove (consecutive) duplicates.
	  (setq laststring str)
	  (unless (bolp)
            (insert " \t")
            (setq column (+ column colwidth))
            ;; Leave the space unpropertized so that in the case we're
            ;; already past the goal column, there is still
            ;; a space displayed.
            (set-text-properties (- (point) 1) (point)
                                 ;; We can't just set tab-width, because
                                 ;; completion-setup-function will kill all
                                 ;; local variables :-(
738 739 740 741 742 743 744 745
                                 `(display (space :align-to ,column)))
	    (when (< wwidth (+ (max colwidth
				    (if (consp str)
					(+ (string-width (car str))
					   (string-width (cadr str)))
				      (string-width str)))
			       column))
	      (delete-char -2) (insert "\n") (setq column 0)))
746 747 748 749 750 751 752 753
	  (if (not (consp str))
	      (put-text-property (point) (progn (insert str) (point))
				 'mouse-face 'highlight)
	    (put-text-property (point) (progn (insert (car str)) (point))
			       'mouse-face 'highlight)
	    (put-text-property (point) (progn (insert (cadr str)) (point))
                               'mouse-face nil)))))))

754 755
(defvar completion-common-substring nil)
(make-obsolete-variable 'completion-common-substring nil "23.1")
756

757 758 759 760 761
(defvar completion-setup-hook nil
  "Normal hook run at the end of setting up a completion list buffer.
When this hook is run, the current buffer is the one in which the
command to display the completion list buffer was run.
The completion list buffer is available as the value of `standard-output'.
762 763 764 765 766 767 768 769 770 771 772 773 774 775 776
See also `display-completion-list'.")

(defface completions-first-difference
  '((t (:inherit bold)))
  "Face put on the first uncommon character in completions in *Completions* buffer."
  :group 'completion)

(defface completions-common-part
  '((t (:inherit default)))
  "Face put on the common prefix substring in completions in *Completions* buffer.
The idea of `completions-common-part' is that you can use it to
make the common parts less visible than normal, so that the rest
of the differing parts is, by contrast, slightly highlighted."
  :group 'completion)

777
(defun completion-hilit-commonality (completions prefix-len base-size)
778
  (when completions
779
    (let ((com-str-len (- prefix-len (or base-size 0))))
780 781
      (nconc
       (mapcar
782 783 784 785 786 787 788 789 790 791
        (lambda (elem)
          (let ((str
                 ;; Don't modify the string itself, but a copy, since the
                 ;; the string may be read-only or used for other purposes.
                 ;; Furthermore, since `completions' may come from
                 ;; display-completion-list, `elem' may be a list.
                 (if (consp elem)
                     (car (setq elem (cons (copy-sequence (car elem))
                                           (cdr elem))))
                   (setq elem (copy-sequence elem)))))
792 793 794 795 796
            (put-text-property 0
			       ;; If completion-boundaries returns incorrect
			       ;; values, all-completions may return strings
			       ;; that don't contain the prefix.
			       (min com-str-len (length str))
797 798 799 800 801 802 803
                               'font-lock-face 'completions-common-part
                               str)
            (if (> (length str) com-str-len)
                (put-text-property com-str-len (1+ com-str-len)
                                   'font-lock-face 'completions-first-difference
                                   str)))
          elem)
804 805
        completions)
       base-size))))
806

807
(defun display-completion-list (completions &optional common-substring)
808 809 810 811 812 813 814 815 816 817
  "Display the list of completions, COMPLETIONS, using `standard-output'.
Each element may be just a symbol or string
or may be a list of two strings to be printed as if concatenated.
If it is a list of two strings, the first is the actual completion
alternative, the second serves as annotation.
`standard-output' must be a buffer.
The actual completion alternatives, as inserted, are given `mouse-face'
properties of `highlight'.
At the end, this runs the normal hook `completion-setup-hook'.
It can find the completion buffer in `standard-output'.
818

819
The obsolete optional arg COMMON-SUBSTRING, if non-nil, should be a string
820 821
specifying a common substring for adding the faces
`completions-first-difference' and `completions-common-part' to
822
the completions buffer."
823 824
  (if common-substring
      (setq completions (completion-hilit-commonality
825 826 827
                         completions (length common-substring)
                         ;; We don't know the base-size.
                         nil)))
828 829 830 831 832
  (if (not (bufferp standard-output))
      ;; This *never* (ever) happens, so there's no point trying to be clever.
      (with-temp-buffer
	(let ((standard-output (current-buffer))
	      (completion-setup-hook nil))
833
	  (display-completion-list completions common-substring))
834 835
	(princ (buffer-string)))

836 837 838 839 840 841 842 843 844 845 846 847 848
    (let ((mainbuf (current-buffer)))
      (with-current-buffer standard-output
	(goto-char (point-max))
	(if (null completions)
	    (insert "There are no possible completions of what you have typed.")
	  (insert "Possible completions are:\n")
	  (let ((last (last completions)))
	    ;; Set base-size from the tail of the list.
	    (set (make-local-variable 'completion-base-size)
		 (or (cdr last)
		     (and (minibufferp mainbuf) 0)))
	    (setcdr last nil)) ; Make completions a properly nil-terminated list.
	  (completion--insert-strings completions)))))
849

850 851
  ;; The hilit used to be applied via completion-setup-hook, so there
  ;; may still be some code that uses completion-common-substring.
852 853 854
  (with-no-warnings
    (let ((completion-common-substring common-substring))
      (run-hooks 'completion-setup-hook)))
855 856 857 858 859 860 861
  nil)

(defun minibuffer-completion-help ()
  "Display a list of possible completions of the current minibuffer contents."
  (interactive)
  (message "Making completion list...")
  (let* ((string (field-string))
862
         (completions (completion-all-completions
863 864
                       string
                       minibuffer-completion-table
865 866
                       minibuffer-completion-predicate
                       (- (point) (field-beginning)))))
867 868
    (message nil)
    (if (and completions
869 870
             (or (consp (cdr completions))
                 (not (equal (car completions) string))))
871
        (with-output-to-temp-buffer "*Completions*"
872 873 874 875 876 877 878
          (let* ((last (last completions))
                 (base-size (cdr last)))
            ;; Remove the base-size tail because `sort' requires a properly
            ;; nil-terminated list.
            (when last (setcdr last nil))
            (display-completion-list (nconc (sort completions 'string-lessp)
                                            base-size))))
879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901

      ;; If there are no completions, or if the current input is already the
      ;; only possible completion, then hide (previous&stale) completions.
      (let ((window (and (get-buffer "*Completions*")
                         (get-buffer-window "*Completions*" 0))))
        (when (and (window-live-p window) (window-dedicated-p window))
          (condition-case ()
              (delete-window window)
            (error (iconify-frame (window-frame window))))))
      (ding)
      (minibuffer-message
       (if completions "Sole completion" "No completions")))
    nil))

(defun exit-minibuffer ()
  "Terminate this minibuffer argument."
  (interactive)
  ;; If the command that uses this has made modifications in the minibuffer,
  ;; we don't want them to cause deactivation of the mark in the original
  ;; buffer.
  ;; A better solution would be to make deactivate-mark buffer-local
  ;; (or to turn it into a list of buffers, ...), but in the mean time,
  ;; this should do the trick in most cases.
902
  (setq deactivate-mark nil)
903 904 905 906 907
  (throw 'exit nil))

(defun self-insert-and-exit ()
  "Terminate minibuffer input."
  (interactive)
908
  (if (characterp last-command-event)
909 910 911 912
      (call-interactively 'self-insert-command)
    (ding))
  (exit-minibuffer))

913 914
;;; Key bindings.

915 916 917
(define-obsolete-variable-alias 'minibuffer-local-must-match-filename-map
  'minibuffer-local-filename-must-match-map "23.1")

918 919 920 921 922 923 924
(let ((map minibuffer-local-map))
  (define-key map "\C-g" 'abort-recursive-edit)
  (define-key map "\r" 'exit-minibuffer)
  (define-key map "\n" 'exit-minibuffer))

(let ((map minibuffer-local-completion-map))
  (define-key map "\t" 'minibuffer-complete)
925 926 927
  ;; M-TAB is already abused for many other purposes, so we should find
  ;; another binding for it.
  ;; (define-key map "\e\t" 'minibuffer-force-complete)
928 929 930 931 932 933 934 935 936
  (define-key map " " 'minibuffer-complete-word)
  (define-key map "?" 'minibuffer-completion-help))

(let ((map minibuffer-local-must-match-map))
  (define-key map "\r" 'minibuffer-complete-and-exit)
  (define-key map "\n" 'minibuffer-complete-and-exit))

(let ((map minibuffer-local-filename-completion-map))
  (define-key map " " nil))
937
(let ((map minibuffer-local-filename-must-match-map))
938 939 940 941 942 943 944 945 946
  (define-key map " " nil))

(let ((map minibuffer-local-ns-map))
  (define-key map " " 'exit-minibuffer)
  (define-key map "\t" 'exit-minibuffer)
  (define-key map "?" 'self-insert-and-exit))

;;; Completion tables.

947 948 949
(defun minibuffer--double-dollars (str)
  (replace-regexp-in-string "\\$" "$$" str))

950 951 952 953 954
(defun completion--make-envvar-table ()
  (mapcar (lambda (enventry)
            (substring enventry 0 (string-match "=" enventry)))
          process-environment))

955 956 957 958
(defconst completion--embedded-envvar-re
  (concat "\\(?:^\\|[^$]\\(?:\\$\\$\\)*\\)"
          "$\\([[:alnum:]_]*\\|{\\([^}]*\\)\\)\\'"))

959
(defun completion--embedded-envvar-table (string pred action)
960 961 962
  (if (eq (car-safe action) 'boundaries)
      ;; Compute the boundaries of the subfield to which this
      ;; completion applies.
963 964 965 966
      (let ((suffix (cdr action)))
        (if (string-match completion--embedded-envvar-re string)
            (list* 'boundaries
                   (or (match-beginning 2) (match-beginning 1))
967
                   (when (string-match "[^[:alnum:]_]" suffix)
968
                     (match-beginning 0)))))
969 970 971 972 973 974 975 976 977
    (when (string-match completion--embedded-envvar-re string)
      (let* ((beg (or (match-beginning 2) (match-beginning 1)))
             (table (completion--make-envvar-table))
             (prefix (substring string 0 beg)))
        (if (eq (aref string (1- beg)) ?{)
            (setq table (apply-partially 'completion-table-with-terminator
                                         "}" table)))
        (completion-table-with-context
         prefix table (substring string beg) pred action)))))
978

979
(defun completion--file-name-table (string pred action)
980
  "Internal subroutine for `read-file-name'.  Do not call this."
981 982 983 984 985 986
  (cond
   ((and (zerop (length string)) (eq 'lambda action))
    nil)                                ; FIXME: why?
   ((eq (car-safe action) 'boundaries)
    ;; FIXME: Actually, this is not always right in the presence of
    ;; envvars, but there's not much we can do, I think.
987 988
    (let ((start (length (file-name-directory string)))
          (end (string-match "/" (cdr action))))
989
      (list* 'boundaries start end)))
990

991
   (t
992 993 994 995 996 997
    (let* ((dir (if (stringp pred)
                    ;; It used to be that `pred' was abused to pass `dir'
                    ;; as an argument.
                    (prog1 (expand-file-name pred) (setq pred nil))
                  default-directory))
           (str (condition-case nil
998 999
                    (substitute-in-file-name string)
                  (error string)))
1000 1001 1002 1003
           (name (file-name-nondirectory str))
           (specdir (file-name-directory str))
           (realdir (if specdir (expand-file-name specdir dir)
                      (file-name-as-directory dir))))
1004

1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018
      (cond
       ((null action)
        (let ((comp (file-name-completion name realdir
                                          read-file-name-predicate)))
          (if (stringp comp)
              ;; Requote the $s before returning the completion.
              (minibuffer--double-dollars (concat specdir comp))
            ;; Requote the $s before checking for changes.
            (setq str (minibuffer--double-dollars str))
            (if (string-equal string str)
                comp
              ;; If there's no real completion, but substitute-in-file-name
              ;; changed the string, then return the new string.
              str))))
1019

1020
       ((eq action t)
1021
        (let ((all (file-name-all-completions name realdir)))
1022 1023 1024

          ;; Check the predicate, if necessary.
          (unless (memq read-file-name-predicate '(nil file-exists-p))
1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037
            (let ((comp ())
                  (pred
                   (if (eq read-file-name-predicate 'file-directory-p)
                       ;; Brute-force speed up for directory checking:
                       ;; Discard strings which don't end in a slash.
                       (lambda (s)
                         (let ((len (length s)))
                           (and (> len 0) (eq (aref s (1- len)) ?/))))
                     ;; Must do it the hard (and slow) way.
                     read-file-name-predicate)))
              (let ((default-directory realdir))
                (dolist (tem all)
                  (if (funcall pred tem) (push tem comp))))
1038 1039
              (setq all (nreverse comp))))

1040
          all))
1041 1042 1043 1044

       (t
        ;; Only other case actually used is ACTION = lambda.
        (let ((default-directory dir))
1045
          (funcall (or read-file-name-predicate 'file-exists-p) str))))))))
1046

1047
(defalias 'read-file-name-internal
1048
  (completion-table-in-turn 'completion--embedded-envvar-table
1049
                            'completion--file-name-table)
1050
  "Internal subroutine for `read-file-name'.  Do not call this.")
1051

1052 1053 1054 1055 1056 1057 1058
(defvar read-file-name-function nil
  "If this is non-nil, `read-file-name' does its work by calling this function.")

(defvar read-file-name-predicate nil
  "Current predicate used by `read-file-name-internal'.")

(defcustom read-file-name-completion-ignore-case
1059
  (if (memq system-type '(ms-dos windows-nt darwin cygwin))
1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089
      t nil)
  "Non-nil means when reading a file name completion ignores case."
  :group 'minibuffer
  :type 'boolean
  :version "22.1")

(defcustom insert-default-directory t
  "Non-nil means when reading a filename start with default dir in minibuffer.

When the initial minibuffer contents show a name of a file or a directory,
typing RETURN without editing the initial contents is equivalent to typing
the default file name.

If this variable is non-nil, the minibuffer contents are always
initially non-empty, and typing RETURN without editing will fetch the
default name, if one is provided.  Note however that this default name
is not necessarily the same as initial contents inserted in the minibuffer,
if the initial contents is just the default directory.

If this variable is nil, the minibuffer often starts out empty.  In
that case you may have to explicitly fetch the next history element to
request the default name; typing RETURN without editing will leave
the minibuffer empty.

For some commands, exiting with an empty minibuffer has a special meaning,
such as making the current buffer visit no file in the case of
`set-visited-file-name'."
  :group 'minibuffer
  :type 'boolean)

1090 1091 1092 1093
;; Not always defined, but only called if next-read-file-uses-dialog-p says so.
(declare-function x-file-dialog "xfns.c"
                  (prompt dir &optional default-filename mustmatch only-dir-p))

1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125
(defun read-file-name (prompt &optional dir default-filename mustmatch initial predicate)
  "Read file name, prompting with PROMPT and completing in directory DIR.
Value is not expanded---you must call `expand-file-name' yourself.
Default name to DEFAULT-FILENAME if user exits the minibuffer with
the same non-empty string that was inserted by this function.
 (If DEFAULT-FILENAME is omitted, the visited file name is used,
  except that if INITIAL is specified, that combined with DIR is used.)
If the user exits with an empty minibuffer, this function returns
an empty string.  (This can only happen if the user erased the
pre-inserted contents or if `insert-default-directory' is nil.)
Fourth arg MUSTMATCH non-nil means require existing file's name.
 Non-nil and non-t means also require confirmation after completion.
Fifth arg INITIAL specifies text to start with.
If optional sixth arg PREDICATE is non-nil, possible completions and
the resulting file name must satisfy (funcall PREDICATE NAME).
DIR should be an absolute directory name.  It defaults to the value of
`default-directory'.

If this command was invoked with the mouse, use a file dialog box if
`use-dialog-box' is non-nil, and the window system or X toolkit in use
provides a file dialog box.

See also `read-file-name-completion-ignore-case'
and `read-file-name-function'."
  (unless dir (setq dir default-directory))
  (unless (file-name-absolute-p dir) (setq dir (expand-file-name dir)))
  (unless default-filename
    (setq default-filename (if initial (expand-file-name initial dir)
                             buffer-file-name)))
  ;; If dir starts with user's homedir, change that to ~.
  (setq dir (abbreviate-file-name dir))
  ;; Likewise for default-filename.
1126 1127
  (if default-filename
      (setq default-filename (abbreviate-file-name default-filename)))
1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138
  (let ((insdef (cond
                 ((and insert-default-directory (stringp dir))
                  (if initial
                      (cons (minibuffer--double-dollars (concat dir initial))
                            (length (minibuffer--double-dollars dir)))
                    (minibuffer--double-dollars dir)))
                 (initial (cons (minibuffer--double-dollars initial) 0)))))

    (if read-file-name-function
        (funcall read-file-name-function
                 prompt dir default-filename mustmatch initial predicate)
1139
      (let ((completion-ignore-case read-file-name-completion-ignore-case)
1140 1141 1142 1143 1144 1145
            (minibuffer-completing-file-name t)
            (read-file-name-predicate (or predicate 'file-exists-p))
            (add-to-history nil))

        (let* ((val
                (if (not (next-read-file-uses-dialog-p))
1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157
                    ;; We used to pass `dir' to `read-file-name-internal' by
                    ;; abusing the `predicate' argument.  It's better to
                    ;; just use `default-directory', but in order to avoid
                    ;; changing `default-directory' in the current buffer,
                    ;; we don't let-bind it.
                    (lexical-let ((dir (file-name-as-directory
                                        (expand-file-name dir))))
                      (minibuffer-with-setup-hook
                          (lambda () (setq default-directory dir))
                        (completing-read prompt 'read-file-name-internal
                                         nil mustmatch insdef 'file-name-history
                                         default-filename)))