minibuffer.el 79.7 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
;;   Any other return value should be ignored (so we ignore values returned
;;   from completion tables that don't know about this new `action' form).

;;; Bugs:

36 37 38
;; - 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.
39 40 41
;; - 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
42
;;   completion-extra-size.
43

44 45
;;; Todo:

46 47 48 49 50 51 52 53 54 55 56 57 58
;; - make partial-complete-mode obsolete:
;;   - make M-x lch TAB expand to list-command-history.
;;     (not sure how/where it's implemented in complete.el)
;;   - (?) <foo.h> style completion for file names.

;; - case-sensitivity is currently confuses two issues:
;;   - whether or not a particular completion table should be case-sensitive
;;     (i.e. whether strings that different only by case are semantically
;;     equivalent)
;;   - whether the user wants completion to pay attention to case.
;;   e.g. we may want to make it possible for the user to say "first try
;;   completion case-sensitively, and if that fails, try to ignore case".

59
;; - make lisp-complete-symbol and sym-comp use it.
60
;; - add support for ** to pcm.
61
;; - Make read-file-name-predicate obsolete.
62 63
;; - Add vc-file-name-completion-table to read-file-name-internal.
;; - A feature like completing-help.el.
64
;; - make lisp/complete.el obsolete.
65
;; - Make the `hide-spaces' arg of all-completions obsolete?
66 67 68 69 70

;;; Code:

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

71 72
;;; Completion table manipulation

73
;; New completion-table operation.
74 75
(defun completion-boundaries (string table pred suffix)
  "Return the boundaries of the completions returned by TABLE for STRING.
76
STRING is the string on which completion will be performed.
77 78 79 80 81 82
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
83 84
the closest directory separators."
  (let ((boundaries (if (functionp table)
85
                        (funcall table string pred (cons 'boundaries suffix)))))
86 87 88
    (if (not (eq (car-safe boundaries) 'boundaries))
        (setq boundaries nil))
    (cons (or (cadr boundaries) 0)
89
          (or (cddr boundaries) (length suffix)))))
90

91 92 93 94
(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'."
95 96
  (let ((firsterror nil)
        res)
97
    (while (and (not res) xs)
98 99 100 101 102
      (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))))))
103

104 105 106 107 108 109
(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'."
110 111 112 113 114 115 116 117 118 119 120
  (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))))
121 122 123 124

(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,
125 126 127 128
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.
129

130
The result of the `completion-table-dynamic' form is a function
131
that can be used as the COLLECTION argument to `try-completion' and
132
`all-completions'.  See Info node `(elisp)Programmed Completion'."
133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149
  (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."
150
  (declare (debug (symbolp lambda-expr)))
151 152 153 154 155 156 157 158
  (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)
159
  ;; TODO: add `suffix' maybe?
160
  ;; Notice that `pred' may not be a function in some abusive cases.
161 162 163 164 165 166 167 168 169 170 171 172 173 174 175
  (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)))))))))
176 177
  (if (eq (car-safe action) 'boundaries)
      (let* ((len (length prefix))
178 179
             (bound (completion-boundaries string table pred (cdr action))))
        (list* 'boundaries (+ (car bound) len) (cdr bound)))
180 181 182 183 184
    (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)))))
185 186

(defun completion-table-with-terminator (terminator table string pred action)
187 188 189
  (cond
   ((eq action nil)
    (let ((comp (try-completion string table pred)))
190 191 192
      (if (eq comp t)
          (concat string terminator)
        (if (and (stringp comp)
193
                 (eq (try-completion comp table pred) t))
194
            (concat comp terminator)
195
          comp))))
196 197 198 199 200
   ((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*.
201 202
    ;; (mapcar (lambda (s) (concat s terminator))
    ;;         (all-completions string table pred))))
203
    (all-completions string table pred))
204 205 206 207 208 209 210
   ;; 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.
211
PRED1 is a function of one argument which returns non-nil if and only if the
212 213 214
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'.
215 216
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.
217 218 219 220
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.
221
    (test-completion string table pred2))
222 223 224 225 226 227 228 229 230 231 232 233
   (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))))))
234

235 236 237
(defun completion-table-in-turn (&rest tables)
  "Create a completion table that tries each table in TABLES in turn."
  (lexical-let ((tables tables))
238
    (lambda (string pred action)
239 240 241 242
      (completion--some (lambda (table)
                          (complete-with-action action table string pred))
                        tables))))

243 244
;; (defmacro complete-in-turn (a b) `(completion-table-in-turn ,a ,b))
;; (defmacro dynamic-completion-table (fun) `(completion-table-dynamic ,fun))
245 246
(define-obsolete-function-alias
  'complete-in-turn 'completion-table-in-turn "23.1")
247 248
(define-obsolete-function-alias
  'dynamic-completion-table 'completion-table-dynamic "23.1")
249 250 251

;;; Minibuffer completion

252 253 254 255 256
(defgroup minibuffer nil
  "Controlling the behavior of the minibuffer."
  :link '(custom-manual "(emacs)Minibuffer")
  :group 'environment)

257 258 259 260 261 262
(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'."
263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294
  (if (not (minibufferp (current-buffer)))
      (progn
        (if args
            (apply 'message message args)
          (message "%s" message))
        (prog1 (sit-for (or minibuffer-message-timeout 1000000))
          (message nil)))
    ;; Clear out any old echo-area message to make way for our new thing.
    (message nil)
    (setq message (if (and (null args) (string-match-p "\\` *\\[.+\\]\\'" message))
                      ;; Make sure we can put-text-property.
                      (copy-sequence message)
                    (concat " [" message "]")))
    (when args (setq message (apply 'format message args)))
    (let ((ol (make-overlay (point-max) (point-max) nil t t))
          ;; 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.
          (inhibit-quit t))
      (unwind-protect
          (progn
            (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))
            (overlay-put ol 'after-string message)
            (sit-for (or minibuffer-message-timeout 1000000)))
        (delete-overlay ol)))))
295 296 297 298 299 300 301 302 303

(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."
304 305 306
  ;; 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)))
307

308 309 310 311 312 313
(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."
314
  :type '(choice (const nil) (const t) (const lazy))
315 316
  :group 'minibuffer)

317
(defvar completion-styles-alist
318 319 320
  '((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)
321 322
    (partial-completion
     completion-pcm-try-completion completion-pcm-all-completions))
323 324
  "List of available completion styles.
Each element has the form (NAME TRY-COMPLETION ALL-COMPLETIONS)
325
where NAME is the name that should be used in `completion-styles',
326 327 328
TRY-COMPLETION is the function that does the completion, and
ALL-COMPLETIONS is the function that lists the completions.")

329
(defcustom completion-styles '(basic partial-completion emacs22)
330 331
  "List of completion styles to use.
The available styles are listed in `completion-styles-alist'."
332 333 334 335 336
  :type `(repeat (choice ,@(mapcar (lambda (x) (list 'const (car x)))
                                   completion-styles-alist)))
  :group 'minibuffer
  :version "23.1")

337 338 339 340 341 342 343 344
(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."
345 346 347 348
  ;; 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))
349 350 351 352 353
      ;; 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)
354
    (completion--some (lambda (style)
355
                        (funcall (nth 1 (assq style completion-styles-alist))
356
                                 string table pred point))
357 358
                      completion-styles)))

359 360 361 362
(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.
363
The return value is a list of completions and may contain the base-size
364
in the last `cdr'."
365 366
  ;; FIXME: We need to additionally return completion-extra-size (similar
  ;; to completion-base-size but for the text after point).
367 368 369 370 371 372 373 374 375 376 377 378 379
  ;; 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)))
380

381 382 383 384 385
(defun minibuffer--bitset (modified completions exact)
  (logior (if modified    4 0)
          (if completions 2 0)
          (if exact       1 0)))

386
(defun completion--do-completion (&optional try-completion-function)
387
  "Do the completion and return a summary of what happened.
388 389 390 391 392 393 394 395 396 397 398 399 400 401
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))
402
         (end (field-end))
403
         (string (buffer-substring beg end))
404 405 406 407 408 409
         (comp (funcall (or try-completion-function
			    'completion-try-completion)
			string
			minibuffer-completion-table
			minibuffer-completion-predicate
			(- (point) beg))))
410
    (cond
411
     ((null comp)
412
      (minibuffer-hide-completions)
413
      (ding) (minibuffer-message "No match") (minibuffer--bitset nil nil nil))
414
     ((eq t comp)
415
      (minibuffer-hide-completions)
416 417
      (goto-char (field-end))
      (minibuffer--bitset nil nil t)) ;Exact and unique match.
418 419 420 421
     (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.
422 423 424 425
      (let* ((comp-pos (cdr comp))
	     (completion (car comp))
	     (completed (not (eq t (compare-strings completion nil nil
						    string nil nil t))))
426 427
	     (unchanged (eq t (compare-strings completion nil nil
					       string nil nil nil))))
428
        (unless unchanged
429 430

          ;; Insert in minibuffer the chars we got.
431 432
          (goto-char end)
          (insert completion)
433 434 435
          (delete-region beg end))
	;; Move point.
	(goto-char (+ beg comp-pos))
436

437 438 439 440 441
        (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).
442
           (completion--do-completion try-completion-function)
443 444

          ;; It did find a match.  Do we match some possibility exactly now?
445
          (let ((exact (test-completion completion
446 447
					minibuffer-completion-table
					minibuffer-completion-predicate)))
448 449 450 451 452
            (if completed
                ;; We could also decide to refresh the completions,
                ;; if they're displayed (and assuming there are
                ;; completions left).
                (minibuffer-hide-completions)
453 454 455 456 457 458 459 460
              ;; 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")))
461 462 463
               ;; If the last exact completion and this one were the same, it
               ;; means we've already given a "Next char not unique" message
               ;; and the user's hit TAB again, so now we give him help.
464 465 466 467
               ((eq this-command last-command)
                (if completion-auto-help (minibuffer-completion-help)))))

            (minibuffer--bitset completed t exact))))))))
468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492

(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)

493
      (case (completion--do-completion)
494
        (#b000 nil)
495
        (#b001 (minibuffer-message "Sole completion")
496
               t)
497
        (#b011 (minibuffer-message "Complete, but not unique")
498 499
               t)
        (t     t)))))
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 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553
(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)))))

554
(defvar minibuffer-confirm-exit-commands
555
  '(minibuffer-complete minibuffer-complete-word PC-complete PC-complete-word)
556 557 558
  "A list of commands which cause an immediately following
`minibuffer-complete-and-exit' to ask for extra confirmation.")

559
(defun minibuffer-complete-and-exit ()
560 561 562 563 564 565 566 567 568 569
  "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
570 571 572
 preceding minibuffer command was a member of
 `minibuffer-confirm-exit-commands', and accept the input
 otherwise."
573
  (interactive)
574 575 576 577 578 579 580 581 582 583
  (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.
584
        (let* ((string (buffer-substring beg end))
585 586 587 588 589 590 591
               (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.
592 593 594 595
                     ;; 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.
596
                     (= (length string) (length compl)))
597 598
            (goto-char end)
            (insert compl)
599 600
            (delete-region beg end))))
      (exit-minibuffer))
601

602
     ((eq minibuffer-completion-confirm 'confirm)
603
      ;; The user is permitted to exit with an input that's rejected
604
      ;; by test-completion, after confirming her choice.
605 606 607 608
      (if (eq last-command this-command)
          (exit-minibuffer)
        (minibuffer-message "Confirm")
        nil))
609

610 611 612
     ((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).
613
      (if (memq last-command minibuffer-confirm-exit-commands)
614 615 616 617
	  (progn (minibuffer-message "Confirm")
		 nil)
	(exit-minibuffer)))

618 619 620 621 622
     (t
      ;; Call do-completion, but ignore errors.
      (case (condition-case nil
                (completion--do-completion)
              (error 1))
623 624 625 626 627
        ((#b001 #b011) (exit-minibuffer))
        (#b111 (if (not minibuffer-completion-confirm)
                   (exit-minibuffer)
                 (minibuffer-message "Confirm")
                 nil))
628 629
        (t nil))))))

630 631 632 633
(defun completion--try-word-completion (string table predicate point)
  (let ((comp (completion-try-completion string table predicate point)))
    (if (not (consp comp))
        comp
634

635 636
      ;; If completion finds next char not unique,
      ;; consider adding a space or a hyphen.
637
      (when (= (length string) (length (car comp)))
638 639 640 641 642 643 644 645 646
        ;; Mark the added char with the `completion-word' property, so it
        ;; can be handled specially by completion styles such as
        ;; partial-completion.
        ;; We used to remove `partial-completion' from completion-styles
        ;; instead, but it was too blunt, leading to situations where SPC
        ;; was the only insertable char at point but minibuffer-complete-word
        ;; refused inserting it.
        (let ((exts (mapcar (lambda (str) (propertize str 'completion-try-word t))
                            '(" " "-")))
647 648 649 650
              (before (substring string 0 point))
              (after (substring string point))
	      tem)
	  (while (and exts (not (consp tem)))
651
            (setq tem (completion-try-completion
652 653 654
		       (concat before (pop exts) after)
		       table predicate (1+ point))))
	  (if (consp tem) (setq comp tem))))
655

656 657 658 659 660 661 662
      ;; 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.
663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714
      (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)))))
715 716 717 718 719 720 721 722


(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)
723
  (case (completion--do-completion 'completion--try-word-completion)
724
    (#b000 nil)
725
    (#b001 (minibuffer-message "Sole completion")
726
           t)
727
    (#b011 (minibuffer-message "Complete, but not unique")
728 729
           t)
    (t     t)))
730

731 732 733
(defface completions-annotations '((t :inherit italic))
  "Face to use for annotations in the *Completions* buffer.")

734
(defun completion--insert-strings (strings)
735 736 737 738 739 740 741
  "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)
742 743 744
					(+ (string-width (car s))
                                           (string-width (cadr s)))
				      (string-width s)))
745 746 747 748 749 750 751 752 753 754 755 756 757 758 759
				  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)
760
	(unless (equal laststring str) ; Remove (consecutive) duplicates.
761
	  (setq laststring str)
762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784
          (let ((length (if (consp str)
                            (+ (string-width (car str))
                               (string-width (cadr str)))
                          (string-width str))))
            (unless (bolp)
              (if (< wwidth (+ (max colwidth length) column))
                  ;; No space for `str' at point, move to next line.
                  (progn (insert "\n") (setq column 0))
                (insert " \t")
                ;; 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 :-(
                                     `(display (space :align-to ,column)))
                nil))
            (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)
785 786 787
              (add-text-properties (point) (progn (insert (cadr str)) (point))
                                   '(mouse-face nil
                                     face completions-annotations)))
788 789 790 791
            ;; Next column to align to.
            (setq column (+ column
                            ;; Round up to a whole number of columns.
                            (* colwidth (ceiling length colwidth))))))))))
792

793 794
(defvar completion-common-substring nil)
(make-obsolete-variable 'completion-common-substring nil "23.1")
795

796 797 798 799 800
(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'.
801 802 803 804 805 806 807 808 809 810 811 812 813 814 815
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)

816
(defun completion-hilit-commonality (completions prefix-len base-size)
817
  (when completions
818
    (let ((com-str-len (- prefix-len (or base-size 0))))
819 820
      (nconc
       (mapcar
821 822 823 824 825 826 827 828 829 830
        (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)))))
831 832 833 834 835
            (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))
836 837 838 839 840 841 842
                               '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)
843 844
        completions)
       base-size))))
845

846
(defun display-completion-list (completions &optional common-substring)
847 848 849 850 851 852 853 854 855 856
  "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'.
857

858
The obsolete optional arg COMMON-SUBSTRING, if non-nil, should be a string
859 860
specifying a common substring for adding the faces
`completions-first-difference' and `completions-common-part' to
861
the completions buffer."
862 863
  (if common-substring
      (setq completions (completion-hilit-commonality
864 865 866
                         completions (length common-substring)
                         ;; We don't know the base-size.
                         nil)))
867 868 869 870 871
  (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))
872
	  (display-completion-list completions common-substring))
873 874
	(princ (buffer-string)))

875 876 877 878 879 880 881 882 883 884 885 886 887
    (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)))))
888

889 890
  ;; The hilit used to be applied via completion-setup-hook, so there
  ;; may still be some code that uses completion-common-substring.
891 892 893
  (with-no-warnings
    (let ((completion-common-substring common-substring))
      (run-hooks 'completion-setup-hook)))
894 895
  nil)

896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912
(defvar completion-annotate-function
  nil
  ;; Note: there's a lot of scope as for when to add annotations and
  ;; what annotations to add.  E.g. completing-help.el allowed adding
  ;; the first line of docstrings to M-x completion.  But there's
  ;; a tension, since such annotations, while useful at times, can
  ;; actually drown the useful information.
  ;; So completion-annotate-function should be used parsimoniously, or
  ;; else only used upon a user's request (e.g. we could add a command
  ;; to completion-list-mode to add annotations to the current
  ;; completions).
  "Function to add annotations in the *Completions* buffer.
The function takes a completion and should either return nil, or a string that
will be displayed next to the completion.  The function can access the
completion table and predicates via `minibuffer-completion-table' and related
variables.")

913 914 915 916 917
(defun minibuffer-completion-help ()
  "Display a list of possible completions of the current minibuffer contents."
  (interactive)
  (message "Making completion list...")
  (let* ((string (field-string))
918
         (completions (completion-all-completions
919 920
                       string
                       minibuffer-completion-table
921 922
                       minibuffer-completion-predicate
                       (- (point) (field-beginning)))))
923 924
    (message nil)
    (if (and completions
925 926
             (or (consp (cdr completions))
                 (not (equal (car completions) string))))
927
        (with-output-to-temp-buffer "*Completions*"
928 929 930 931 932
          (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))
933 934 935 936 937 938 939 940 941
            (setq completions (sort completions 'string-lessp))
            (when completion-annotate-function
              (setq completions
                    (mapcar (lambda (s)
                              (let ((ann
                                     (funcall completion-annotate-function s)))
                                (if ann (list s ann) s)))
                            completions)))
            (display-completion-list (nconc completions base-size))))
942 943 944 945 946 947 948 949 950 951 952 953 954 955

      ;; 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))

956 957 958 959 960 961 962
(defun minibuffer-hide-completions ()
  "Get rid of an out-of-date *Completions* buffer."
  ;; FIXME: We could/should use minibuffer-scroll-window here, but it
  ;; can also point to the minibuffer-parent-window, so it's a bit tricky.
  (let ((win (get-buffer-window "*Completions*" 0)))
    (if win (with-selected-window win (bury-buffer)))))

963 964 965 966 967 968 969 970 971
(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.
972
  (setq deactivate-mark nil)
973 974 975 976 977
  (throw 'exit nil))

(defun self-insert-and-exit ()
  "Terminate minibuffer input."
  (interactive)
978
  (if (characterp last-command-event)
979 980 981 982
      (call-interactively 'self-insert-command)
    (ding))
  (exit-minibuffer))

983 984
;;; Key bindings.

985 986 987
(define-obsolete-variable-alias 'minibuffer-local-must-match-filename-map
  'minibuffer-local-filename-must-match-map "23.1")

988 989 990 991 992 993 994
(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)
995 996 997
  ;; 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)
998 999 1000 1001 1002 1003 1004 1005 1006
  (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))
1007
(let ((map minibuffer-local-filename-must-match-map))
1008 1009 1010 1011 1012 1013 1014 1015 1016
  (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.

1017 1018 1019
(defun minibuffer--double-dollars (str)
  (replace-regexp-in-string "\\$" "$$" str))

1020 1021
(defun completion--make-envvar-table ()
  (mapcar (lambda (enventry)
1022
            (substring enventry 0 (string-match-p "=" enventry)))
1023 1024
          process-environment))

1025 1026 1027 1028
(defconst completion--embedded-envvar-re
  (concat "\\(?:^\\|[^$]\\(?:\\$\\$\\)*\\)"
          "$\\([[:alnum:]_]*\\|{\\([^}]*\\)\\)\\'"))

1029
(defun completion--embedded-envvar-table (string pred action)
1030 1031 1032
  (if (eq (car-safe action) 'boundaries)
      ;; Compute the boundaries of the subfield to which this
      ;; completion applies.
1033 1034 1035 1036
      (let ((suffix (cdr action)))
        (if (string-match completion--embedded-envvar-re string)
            (list* 'boundaries
                   (or (match-beginning 2) (match-beginning 1))
1037
                   (when (string-match "[^[:alnum:]_]" suffix)
1038
                     (match-beginning 0)))))
1039 1040 1041 1042 1043 1044 1045
    (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)))
1046 1047 1048 1049 1050
        ;; Even if file-name completion is case-insensitive, we want
        ;; envvar completion to be case-sensitive.
        (let ((completion-ignore-case nil))
          (completion-table-with-context
           prefix table (substring string beg) pred action))))))
1051

1052
(defun completion--file-name-table (string pred action)
1053
  "Internal subroutine for `read-file-name'.  Do not call this."
1054 1055 1056 1057 1058 1059
  (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.
1060
    (let ((start (length (file-name-directory string)))
1061
          (end (string-match-p "/" (cdr action))))
1062
      (list* 'boundaries start end)))
1063

1064
   (t
1065 1066 1067 1068 1069 1070
    (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
1071 1072
                    (substitute-in-file-name string)
                  (error string)))
1073 1074 1075 1076
           (name (file-name-nondirectory str))
           (specdir (file-name-directory str))
           (realdir (if specdir (expand-file-name specdir dir)
                      (file-name-as-directory dir))))
1077

1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091
      (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))))
1092

1093
       ((eq action t)
1094
        (let ((all (file-name-all-completions name realdir)))
1095 1096 1097

          ;; Check the predicate, if necessary.
          (unless (memq read-file-name-predicate '(nil file-exists-p))
1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110
            (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))))
1111 1112
              (setq all (nreverse comp))))

1113
          all))
1114 1115 1116 1117

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

1120
(defalias 'read-file-name-internal
1121
  (completion-table-in-turn 'completion--embedded-envvar-table
1122
                            'completion--file-name-table)
1123
  "Internal subroutine for `read-file-name'.  Do not call this.")
1124

1125 1126 1127 1128 1129 1130 1131
(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
1132
  (if (memq system-type '(ms-dos windows-nt darwin cygwin))
1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162
      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)

1163 1164 1165 1166
;; 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))

1167 1168 1169 1170 1171 1172 1173 1174 1175 1176
(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.)
Chong Yidong's avatar
Chong Yidong committed
1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190

Fourth arg MUSTMATCH can take the following values:
- nil means that the user can exit with any input.
- t means that the user is not allowed to exit unless
  the input is (or completes to) an existing file.
- `confirm' means that the user can exit with any input, but she needs
  to confirm her choice if the input is not an existing file.
- `confirm-after-completion' means that the user can exit with any
  input, but she needs to confirm her choice if she called
  `minibuffer-complete' right before `minibuffer-complete-and-exit'
  and the input is not an existing file.
- anything else behaves like t except that typing RET does not exit if it
  does non-null completion.

1191
Fifth arg INITIAL specifies text to start with.
Chong Yidong's avatar
Chong Yidong committed
1192

1193 1194 1195 1196 1197
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'.

Chong Yidong's avatar
Chong Yidong committed
1198 1199 1200
If this command was invoked with the mouse, use a graphical file
dialog if `use-dialog-box' is non-nil, and the window system or X
toolkit in use provides a file dialog box.  For graphical file
1201 1202
dialogs, any the special values of MUSTMATCH; `confirm' and
`confirm-after-completion' are treated as equivalent to nil.
1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213

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.
1214 1215
  (if default-filename
      (setq default-filename (abbreviate-file-name default-filename)))
1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226
  (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)
1227
      (let ((completion-ignore-case read-file-name-completion-ignore-case)
1228 1229 1230 1231 1232 1233
            (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))
1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245
                    ;; 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)))
1246 1247
                  ;; If DEFAULT-FILENAME not supplied and DIR contains
                  ;; a file name, split it.
1248 1249 1250 1251 1252 1253 1254 1255 1256 1257
                  (let ((file (file-name-nondirectory dir))
			;; When using a dialog, revert to nil and non-nil
			;; interpretation of mustmatch. confirm options
			;; need to be interpreted as nil, otherwise
			;; it is impossible to create new files using
			;; dialogs with the default settings.
			(dialog-mustmatch
			 (and (not (eq mustmatch 'confirm))
			      (not (eq mustmatch 'confirm-after-completion))
			      mustmatch)))
1258 1259
                    (when (and (not default-filename)
			       (not (zerop (length file))))
1260 1261 1262 1263 1264 1265
                      (setq default-filename file)
                      (setq dir (file-name-directory dir)))
                    (if default-filename
                        (setq default-filename
                              (expand-file-name default-filename dir)))
                    (setq add-to-history t)
1266 1267
                    (x-file-dialog prompt dir default-filename
				   dialog-mustmatch
1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309
                                   (eq predicate 'file-directory-p)))))

               (replace-in-history (eq (car-safe file-name-history) val)))
          ;; If completing-read returned the inserted default string itself
          ;; (rather than a new string with the same contents),
          ;; it has to mean that the user typed RET with the minibuffer empty.
          ;; In that case, we really want to return ""
          ;; so that commands such as set-visited-file-name can distinguish.
          (when (eq val default-filename)
            ;; In this case, completing-read has not added an element
            ;; to the history.  Maybe we should.
            (if (not replace-in-history)
                (setq add-to-history t))
            (setq val ""))
          (unless val (error "No file name specified"))