minibuffer.el 118 KB
Newer Older
1
;;; minibuffer.el --- Minibuffer completion functions -*- lexical-binding: t -*-
2

3
;; Copyright (C) 2008-2011  Free Software Foundation, Inc.
4 5

;; Author: Stefan Monnier <monnier@iro.umontreal.ca>
6
;; Package: emacs
7 8 9

;; This file is part of GNU Emacs.

10
;; GNU Emacs is free software: you can redistribute it and/or modify
11 12 13 14
;; 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.

15
;; GNU Emacs is distributed in the hope that it will be useful,
16 17 18 19 20
;; 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
21
;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
22 23 24

;;; Commentary:

25 26 27 28 29
;; 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
30 31
;;   (boundaries . SUFFIX) in which case it should return
;;   (boundaries START . END).  See `completion-boundaries'.
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).

;;; 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
;; - choose-completion can't automatically figure out the boundaries
41 42 43
;;   corresponding to the displayed completions because we only
;;   provide the start info but not the end info in
;;   completion-base-position.
44
;; - quoting is problematic.  E.g. the double-dollar quoting used in
45
;;   substitute-in-file-name (and hence read-file-name-internal) bumps
46
;;   into various bugs:
47 48 49
;; - choose-completion doesn't know how to quote the text it inserts.
;;   E.g. it fails to double the dollars in file-name completion, or
;;   to backslash-escape spaces and other chars in comint completion.
50 51 52 53 54
;;   - when completing ~/tmp/fo$$o, the highligting in *Completions*
;;     is off by one position.
;;   - all code like PCM which relies on all-completions to match
;;     its argument gets confused because all-completions returns unquoted
;;     texts (as desired for *Completions* output).
55 56 57
;; - C-x C-f ~/*/sr ? should not list "~/./src".
;; - minibuffer-force-complete completes ~/src/emacs/t<!>/lisp/minibuffer.el
;;   to ~/src/emacs/trunk/ and throws away lisp/minibuffer.el.
58

59 60
;;; Todo:

61
;; - for M-x, cycle-sort commands that have no key binding first.
62 63
;; - Make things like icomplete-mode or lightning-completion work with
;;   completion-in-region-mode.
64 65
;; - extend `boundaries' to provide various other meta-data about the
;;   output of `all-completions':
66 67
;;   - preferred sorting order when displayed in *Completions*.
;;   - annotations/text-properties to add when displayed in *Completions*.
68 69 70 71 72 73 74 75 76 77 78
;;   - quoting/unquoting (so we can complete files names with envvars
;;     and backslashes, and all-completion can list names without
;;     quoting backslashes and dollars).
;;   - indicate how to turn all-completion's output into
;;     try-completion's output: e.g. completion-ignored-extensions.
;;     maybe that could be merged with the "quote" operation above.
;;   - indicate that `all-completions' doesn't do prefix-completion
;;     but just returns some list that relates in some other way to
;;     the provided string (as is the case in filecache.el), in which
;;     case partial-completion (for example) doesn't make any sense
;;     and neither does the completions-first-difference highlight.
79 80 81
;;   - indicate how to display the completions in *Completions* (turn
;;     \n into something else, add special boundaries between
;;     completions).  E.g. when completing from the kill-ring.
82

83
;; - case-sensitivity currently confuses two issues:
84
;;   - whether or not a particular completion table should be case-sensitive
85
;;     (i.e. whether strings that differ only by case are semantically
86 87 88 89 90
;;     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".

91
;; - add support for ** to pcm.
92 93
;; - Add vc-file-name-completion-table to read-file-name-internal.
;; - A feature like completing-help.el.
94 95 96 97 98

;;; Code:

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

99 100
;;; Completion table manipulation

101
;; New completion-table operation.
102 103
(defun completion-boundaries (string table pred suffix)
  "Return the boundaries of the completions returned by TABLE for STRING.
104
STRING is the string on which completion will be performed.
105 106 107 108 109 110
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
111 112
the closest directory separators."
  (let ((boundaries (if (functionp table)
113
                        (funcall table string pred (cons 'boundaries suffix)))))
114 115 116
    (if (not (eq (car-safe boundaries) 'boundaries))
        (setq boundaries nil))
    (cons (or (cadr boundaries) 0)
117
          (or (cddr boundaries) (length suffix)))))
118

119 120 121 122
(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'."
123 124
  (let ((firsterror nil)
        res)
125
    (while (and (not res) xs)
126 127 128 129 130
      (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))))))
131

132 133 134 135 136 137
(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'."
138 139 140 141 142 143 144 145 146 147 148
  (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))))
149 150 151 152

(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,
153 154 155 156
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.
157

158
The result of the `completion-table-dynamic' form is a function
159
that can be used as the COLLECTION argument to `try-completion' and
160
`all-completions'.  See Info node `(elisp)Programmed Completion'."
161
  (lambda (string pred action)
162 163 164 165 166 167 168 169
    (if (eq (car-safe action) 'boundaries)
        ;; `fun' is not supposed to return another function but a plain old
        ;; completion table, whose boundaries are always trivial.
        nil
      (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)))))
170 171 172 173 174 175 176 177 178 179 180

(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."
181
  (declare (debug (symbolp lambda-expr)))
182 183 184 185 186 187 188
  (let ((str (make-symbol "string")))
    `(completion-table-dynamic
      (lambda (,str)
        (when (functionp ,var)
          (setq ,var (,fun)))
        ,var))))

189 190 191 192
(defun completion-table-case-fold (table string pred action)
  (let ((completion-ignore-case t))
    (complete-with-action action table string pred)))

193
(defun completion-table-with-context (prefix table string pred action)
194
  ;; TODO: add `suffix' maybe?
195
  ;; Notice that `pred' may not be a function in some abusive cases.
196 197
  (when (functionp pred)
    (setq pred
198 199 200 201 202 203
          ;; 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)
204
            (lambda (s _v) (funcall pred (concat prefix s))))
205 206 207 208 209
           ((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))))))))
210 211
  (if (eq (car-safe action) 'boundaries)
      (let* ((len (length prefix))
212 213
             (bound (completion-boundaries string table pred (cdr action))))
        (list* 'boundaries (+ (car bound) len) (cdr bound)))
214 215 216 217 218
    (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)))))
219 220

(defun completion-table-with-terminator (terminator table string pred action)
221 222 223 224 225
  "Construct a completion table like TABLE but with an extra TERMINATOR.
This is meant to be called in a curried way by first passing TERMINATOR
and TABLE only (via `apply-partially').
TABLE is a completion table, and TERMINATOR is a string appended to TABLE's
completion if it is complete.  TERMINATOR is also used to determine the
226 227 228 229 230
completion suffix's boundary.
TERMINATOR can also be a cons cell (TERMINATOR . TERMINATOR-REGEXP)
in which case TERMINATOR-REGEXP is a regular expression whose submatch
number 1 should match TERMINATOR.  This is used when there is a need to
distinguish occurrences of the TERMINATOR strings which are really terminators
231 232 233
from others (e.g. escaped).  In this form, the car of TERMINATOR can also be,
instead of a string, a function that takes the completion and returns the
\"terminated\" string."
234 235 236 237
  ;; FIXME: This implementation is not right since it only adds the terminator
  ;; in try-completion, so any completion-style that builds the completion via
  ;; all-completions won't get the terminator, and selecting an entry in
  ;; *Completions* won't get the terminator added either.
238
  (cond
239 240 241
   ((eq (car-safe action) 'boundaries)
    (let* ((suffix (cdr action))
           (bounds (completion-boundaries string table pred suffix))
242 243
           (terminator-regexp (if (consp terminator)
                                  (cdr terminator) (regexp-quote terminator)))
244 245
           (max (and terminator-regexp
                     (string-match terminator-regexp suffix))))
246 247
      (list* 'boundaries (car bounds)
             (min (cdr bounds) (or max (length suffix))))))
248 249
   ((eq action nil)
    (let ((comp (try-completion string table pred)))
250
      (if (consp terminator) (setq terminator (car terminator)))
251
      (if (eq comp t)
252 253 254 255 256
          (if (functionp terminator)
              (funcall terminator string)
            (concat string terminator))
        (if (and (stringp comp) (not (zerop (length comp)))
                 ;; Try to avoid the second call to try-completion, since
257 258 259
                 ;; it may be very inefficient (because `comp' made us
                 ;; jump to a new boundary, so we complete in that
                 ;; boundary with an empty start string).
260 261
                 (let ((newbounds (completion-boundaries comp table pred "")))
                   (< (car newbounds) (length comp)))
262
                 (eq (try-completion comp table pred) t))
263 264 265
            (if (functionp terminator)
                (funcall terminator comp)
              (concat comp terminator))
266
          comp))))
267 268 269 270 271
   ((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*.
272 273
    ;; (mapcar (lambda (s) (concat s terminator))
    ;;         (all-completions string table pred))))
274
    (all-completions string table pred))
275 276 277 278 279 280 281
   ;; 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.
282
PRED1 is a function of one argument which returns non-nil if and only if the
283 284 285
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'.
286 287
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.
288 289 290 291
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.
292
    (test-completion string table pred2))
293 294 295
   (t
    (or (complete-with-action action table string
                              (if (null pred2) pred1
296 297 298 299
                                (lambda (x)
                                  ;; Call `pred1' first, so that `pred2'
                                  ;; really can't tell that `x' is in table.
                                  (if (funcall pred1 x) (funcall pred2 x)))))
300 301 302 303
        ;; If completion failed and we're not applying pred1 strictly, try
        ;; again without pred1.
        (and (not strict)
             (complete-with-action action table string pred2))))))
304

305 306
(defun completion-table-in-turn (&rest tables)
  "Create a completion table that tries each table in TABLES in turn."
307 308
  ;; FIXME: the boundaries may come from TABLE1 even when the completion list
  ;; is returned by TABLE2 (because TABLE1 returned an empty list).
309 310 311 312
  (lambda (string pred action)
    (completion--some (lambda (table)
                        (complete-with-action action table string pred))
                      tables)))
313

314 315
;; (defmacro complete-in-turn (a b) `(completion-table-in-turn ,a ,b))
;; (defmacro dynamic-completion-table (fun) `(completion-table-dynamic ,fun))
316 317
(define-obsolete-function-alias
  'complete-in-turn 'completion-table-in-turn "23.1")
318 319
(define-obsolete-function-alias
  'dynamic-completion-table 'completion-table-dynamic "23.1")
320 321 322

;;; Minibuffer completion

323 324 325 326 327
(defgroup minibuffer nil
  "Controlling the behavior of the minibuffer."
  :link '(custom-manual "(emacs)Minibuffer")
  :group 'environment)

328 329 330 331 332 333
(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'."
334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365
  (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)))))
366 367 368 369 370 371 372 373 374

(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."
375 376 377
  ;; 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)))
378

379 380 381
(defvar completion-show-inline-help t
  "If non-nil, print helpful inline messages during completion.")

382 383 384 385 386 387
(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."
388
  :type '(choice (const nil) (const t) (const lazy))
389 390
  :group 'minibuffer)

391
(defconst completion-styles-alist
392 393
  '((emacs21
     completion-emacs21-try-completion completion-emacs21-all-completions
394 395 396 397
     "Simple prefix-based completion.
I.e. when completing \"foo_bar\" (where _ is the position of point),
it will consider all completions candidates matching the glob
pattern \"foobar*\".")
398 399
    (emacs22
     completion-emacs22-try-completion completion-emacs22-all-completions
400 401 402 403
     "Prefix completion that only operates on the text before point.
I.e. when completing \"foo_bar\" (where _ is the position of point),
it will consider all completions candidates matching the glob
pattern \"foo*\" and will add back \"bar\" to the end of it.")
404 405
    (basic
     completion-basic-try-completion completion-basic-all-completions
406 407 408 409
     "Completion of the prefix before point and the suffix after point.
I.e. when completing \"foo_bar\" (where _ is the position of point),
it will consider all completions candidates matching the glob
pattern \"foo*bar*\".")
410
    (partial-completion
411 412
     completion-pcm-try-completion completion-pcm-all-completions
     "Completion of multiple words, each one taken as a prefix.
413 414 415 416 417 418 419
I.e. when completing \"l-co_h\" (where _ is the position of point),
it will consider all completions candidates matching the glob
pattern \"l*-co*h*\".
Furthermore, for completions that are done step by step in subfields,
the method is applied to all the preceding fields that do not yet match.
E.g. C-x C-f /u/mo/s TAB could complete to /usr/monnier/src.
Additionally the user can use the char \"*\" as a glob pattern.")
420 421 422 423 424 425
    (substring
     completion-substring-try-completion completion-substring-all-completions
     "Completion of the string taken as a substring.
I.e. when completing \"foo_bar\" (where _ is the position of point),
it will consider all completions candidates matching the glob
pattern \"*foo*bar*\".")
426 427 428 429 430
    (initials
     completion-initials-try-completion completion-initials-all-completions
     "Completion of acronyms and initialisms.
E.g. can complete M-x lch to list-command-history
and C-x C-f ~/sew to ~/src/emacs/work."))
431
  "List of available completion styles.
432
Each element has the form (NAME TRY-COMPLETION ALL-COMPLETIONS DOC):
433
where NAME is the name that should be used in `completion-styles',
434 435 436 437 438
TRY-COMPLETION is the function that does the completion (it should
follow the same calling convention as `completion-try-completion'),
ALL-COMPLETIONS is the function that lists the completions (it should
follow the calling convention of `completion-all-completions'),
and DOC describes the way this style of completion works.")
439

440 441 442 443 444 445 446 447 448 449 450 451 452
(defcustom completion-styles
  ;; First, use `basic' because prefix completion has been the standard
  ;; for "ever" and works well in most cases, so using it first
  ;; ensures that we obey previous behavior in most cases.
  '(basic
    ;; Then use `partial-completion' because it has proven to
    ;; be a very convenient extension.
    partial-completion
    ;; Finally use `emacs22' so as to maintain (in many/most cases)
    ;; the previous behavior that when completing "foobar" with point
    ;; between "foo" and "bar" the completion try to complete "foo"
    ;; and simply add "bar" to the end of the result.
    emacs22)
453 454
  "List of completion styles to use.
The available styles are listed in `completion-styles-alist'."
455 456 457 458 459
  :type `(repeat (choice ,@(mapcar (lambda (x) (list 'const (car x)))
                                   completion-styles-alist)))
  :group 'minibuffer
  :version "23.1")

460 461 462 463 464 465 466 467
(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."
468 469 470 471
  (completion--some (lambda (style)
                      (funcall (nth 1 (assq style completion-styles-alist))
                               string table pred point))
                    completion-styles))
472

473 474 475 476
(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.
477
The return value is a list of completions and may contain the base-size
478
in the last `cdr'."
479 480
  ;; FIXME: We need to additionally return the info needed for the
  ;; second part of completion-base-position.
481 482 483 484
  (completion--some (lambda (style)
                      (funcall (nth 2 (assq style completion-styles-alist))
                               string table pred point))
                    completion-styles))
485

486 487 488 489 490
(defun minibuffer--bitset (modified completions exact)
  (logior (if modified    4 0)
          (if completions 2 0)
          (if exact       1 0)))

491 492 493
(defun completion--replace (beg end newtext)
  "Replace the buffer text between BEG and END with NEWTEXT.
Moves point to the end of the new text."
494
  ;; Maybe this should be in subr.el.
495 496 497
  ;; You'd think this is trivial to do, but details matter if you want
  ;; to keep markers "at the right place" and be robust in the face of
  ;; after-change-functions that may themselves modify the buffer.
498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516
  (let ((prefix-len 0))
    ;; Don't touch markers in the shared prefix (if any).
    (while (and (< prefix-len (length newtext))
                (< (+ beg prefix-len) end)
                (eq (char-after (+ beg prefix-len))
                    (aref newtext prefix-len)))
      (setq prefix-len (1+ prefix-len)))
    (unless (zerop prefix-len)
      (setq beg (+ beg prefix-len))
      (setq newtext (substring newtext prefix-len))))
  (let ((suffix-len 0))
    ;; Don't touch markers in the shared suffix (if any).
    (while (and (< suffix-len (length newtext))
                (< beg (- end suffix-len))
                (eq (char-before (- end suffix-len))
                    (aref newtext (- (length newtext) suffix-len 1))))
      (setq suffix-len (1+ suffix-len)))
    (unless (zerop suffix-len)
      (setq end (- end suffix-len))
517 518 519 520 521
      (setq newtext (substring newtext 0 (- suffix-len))))
    (goto-char beg)
    (insert newtext)
    (delete-region (point) (+ (point) (- end beg)))
    (forward-char suffix-len)))
522

523 524 525 526 527 528 529 530 531 532 533 534
(defcustom completion-cycle-threshold nil
  "Number of completion candidates below which cycling is used.
Depending on this setting `minibuffer-complete' may use cycling,
like `minibuffer-force-complete'.
If nil, cycling is never used.
If t, cycling is always used.
If an integer, cycling is used as soon as there are fewer completion
candidates than this number."
  :type '(choice (const :tag "No cycling" nil)
          (const :tag "Always cycle" t)
          (integer :tag "Threshold")))

535 536 537 538
(defvar completion-all-sorted-completions nil)
(make-variable-buffer-local 'completion-all-sorted-completions)
(defvar completion-cycling nil)

539 540 541
(defvar completion-fail-discreetly nil
  "If non-nil, stay quiet when there  is no match.")

542 543 544 545
(defun completion--message (msg)
  (if completion-show-inline-help
      (minibuffer-message msg)))

546 547
(defun completion--do-completion (&optional try-completion-function
                                            expect-exact)
548
  "Do the completion and return a summary of what happened.
549 550 551 552 553 554 555 556 557 558 559 560
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
561 562 563 564 565
 111  7 completed to an exact completion

TRY-COMPLETION-FUNCTION is a function to use in place of `try-completion'.
EXPECT-EXACT, if non-nil, means that there is no need to tell the user
when the buffer's text is already an exact match."
566 567 568 569 570 571 572 573 574
  (let* ((beg (field-beginning))
         (end (field-end))
         (string (buffer-substring beg end))
         (comp (funcall (or try-completion-function
                            'completion-try-completion)
                        string
                        minibuffer-completion-table
                        minibuffer-completion-predicate
                        (- (point) beg))))
575
    (cond
576
     ((null comp)
577
      (minibuffer-hide-completions)
578
      (unless completion-fail-discreetly
579
	(ding)
580
	(completion--message "No match"))
581
      (minibuffer--bitset nil nil nil))
582
     ((eq t comp)
583
      (minibuffer-hide-completions)
584 585 586
      (goto-char end)
      (completion--done string 'finished
                        (unless expect-exact "Sole completion"))
587
      (minibuffer--bitset nil nil t))   ;Exact and unique match.
588 589 590 591
     (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.
592 593 594 595 596 597
      (let* ((comp-pos (cdr comp))
             (completion (car comp))
             (completed (not (eq t (compare-strings completion nil nil
                                                    string nil nil t))))
             (unchanged (eq t (compare-strings completion nil nil
                                               string nil nil nil))))
598
        (if unchanged
599
	    (goto-char end)
600 601 602 603
          ;; Insert in minibuffer the chars we got.
          (completion--replace beg end completion))
	;; Move point to its completion-mandated destination.
	(forward-char (- comp-pos (length completion)))
604

605
        (if (not (or unchanged completed))
606 607 608 609
            ;; 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).
610
            (completion--do-completion try-completion-function expect-exact)
611 612

          ;; It did find a match.  Do we match some possibility exactly now?
613
          (let ((exact (test-completion completion
614 615
                                        minibuffer-completion-table
                                        minibuffer-completion-predicate))
616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632
                (comps
                 ;; Check to see if we want to do cycling.  We do it
                 ;; here, after having performed the normal completion,
                 ;; so as to take advantage of the difference between
                 ;; try-completion and all-completions, for things
                 ;; like completion-ignored-extensions.
                 (when (and completion-cycle-threshold
                            ;; Check that the completion didn't make
                            ;; us jump to a different boundary.
                            (or (not completed)
                                (< (car (completion-boundaries
                                         (substring completion 0 comp-pos)
                                         minibuffer-completion-table
                                         minibuffer-completion-predicate
                                         ""))
                                   comp-pos)))
                   (completion-all-sorted-completions))))
633
            (completion--flush-all-sorted-completions)
634
            (cond
635 636
             ((and (consp (cdr comps)) ;; There's something to cycle.
                   (not (ignore-errors
637 638
                          ;; This signal an (intended) error if comps is too
                          ;; short or if completion-cycle-threshold is t.
639
                          (consp (nthcdr completion-cycle-threshold comps)))))
640 641 642 643 644 645
              ;; Fewer than completion-cycle-threshold remaining
              ;; completions: let's cycle.
              (setq completed t exact t)
              (setq completion-all-sorted-completions comps)
              (minibuffer-force-complete))
             (completed
646 647 648
              ;; We could also decide to refresh the completions,
              ;; if they're displayed (and assuming there are
              ;; completions left).
649 650 651 652 653 654 655
              (minibuffer-hide-completions)
              (if exact
                  ;; If completion did not put point at end of field,
                  ;; it's a sign that completion is not finished.
                  (completion--done completion
                                    (if (< comp-pos (length completion))
                                        'exact 'unknown))))
656 657
             ;; Show the completion table, if requested.
             ((not exact)
658 659 660
	      (if (case completion-auto-help
                    (lazy (eq this-command last-command))
                    (t completion-auto-help))
661
                  (minibuffer-completion-help)
662
                (completion--message "Next char not unique")))
663
             ;; If the last exact completion and this one were the same, it
664
             ;; means we've already given a "Complete, but not unique" message
665
             ;; and the user's hit TAB again, so now we give him help.
666 667 668 669 670 671
             (t
              (if (and (eq this-command last-command) completion-auto-help)
                  (minibuffer-completion-help))
              (completion--done completion 'exact
                                (unless expect-exact
                                  "Complete, but not unique"))))
672 673

            (minibuffer--bitset completed t exact))))))))
674 675 676 677 678 679 680 681 682 683 684

(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)
685
    (completion--flush-all-sorted-completions)
686 687
    (setq minibuffer-scroll-window nil))

688
  (cond
689 690
   ;; If there's a fresh completion window with a live buffer,
   ;; and this command is repeated, scroll that window.
691 692
   ((window-live-p minibuffer-scroll-window)
    (let ((window minibuffer-scroll-window))
693 694 695 696 697 698
      (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))
699 700
        nil)))
   ;; If we're cycling, keep on cycling.
701
   ((and completion-cycling completion-all-sorted-completions)
702 703 704
    (minibuffer-force-complete)
    t)
   (t (case (completion--do-completion)
705 706
        (#b000 nil)
        (t     t)))))
707

708
(defun completion--flush-all-sorted-completions (&rest _ignore)
709 710
  (remove-hook 'after-change-functions
               'completion--flush-all-sorted-completions t)
711
  (setq completion-cycling nil)
712 713 714 715 716 717 718 719 720 721 722 723 724 725 726
  (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.
727 728 729 730 731 732 733 734 735
          (setq all (sort all (lambda (c1 c2)
                                (let ((s1 (get-text-property
                                           0 :completion-cycle-penalty c1))
                                      (s2 (get-text-property
                                           0 :completion-cycle-penalty c2)))
                                  (if (eq s1 s2)
                                      (< (length c1) (length c2))
                                    (< (or s1 (length c1))
                                       (or s2 (length c2))))))))
736
          ;; Prefer recently used completions.
737 738
          ;; FIXME: Additional sorting ideas:
          ;; - for M-x, prefer commands that have no key binding.
739 740 741 742 743
          (when (minibufferp)
            (let ((hist (symbol-value minibuffer-history-variable)))
              (setq all (sort all (lambda (c1 c2)
                                    (> (length (member c1 hist))
                                       (length (member c2 hist))))))))
744 745 746 747 748 749 750 751 752 753 754 755 756
          ;; 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.
757 758
  ;; FIXME: ~/src/emacs/t<M-TAB>/lisp/minibuffer.el completes to
  ;; ~/src/emacs/trunk/ and throws away lisp/minibuffer.el.
759 760
  (let* ((start (field-beginning))
         (end (field-end))
761 762 763 764
         (all (completion-all-sorted-completions))
         (base (+ start (or (cdr (last all)) 0))))
    (cond
     ((not (consp all))
765
        (completion--message
766 767 768 769 770 771 772
       (if all "No more completions" "No completions")))
     ((not (consp (cdr all)))
      (let ((mod (equal (car all) (buffer-substring-no-properties base end))))
        (if mod (completion--replace base end (car all)))
        (completion--done (buffer-substring-no-properties start (point))
                          'finished (unless mod "Sole completion"))))
     (t
773
      (setq completion-cycling t)
774 775
      (completion--replace base end (car all))
      (completion--done (buffer-substring-no-properties start (point)) 'sole)
776 777 778 779 780
      ;; 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.
781 782
      (let ((last (last all)))
        (setcdr last (cons (car all) (cdr last)))
783
        (setq completion-all-sorted-completions (cdr all)))))))
784

785
(defvar minibuffer-confirm-exit-commands
786
  '(minibuffer-complete minibuffer-complete-word PC-complete PC-complete-word)
787 788 789
  "A list of commands which cause an immediately following
`minibuffer-complete-and-exit' to ask for extra confirmation.")

790
(defun minibuffer-complete-and-exit ()
791 792 793 794 795 796 797 798 799 800
  "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
801 802 803
 preceding minibuffer command was a member of
 `minibuffer-confirm-exit-commands', and accept the input
 otherwise."
804
  (interactive)
805 806
  (let ((beg (field-beginning))
        (end (field-end)))
807 808 809 810 811 812
    (cond
     ;; Allow user to specify null string
     ((= beg end) (exit-minibuffer))
     ((test-completion (buffer-substring beg end)
                       minibuffer-completion-table
                       minibuffer-completion-predicate)
813 814 815 816 817 818
      ;; FIXME: completion-ignore-case has various slightly
      ;; incompatible meanings.  E.g. it can reflect whether the user
      ;; wants completion to pay attention to case, or whether the
      ;; string will be used in a context where case is significant.
      ;; E.g. usually try-completion should obey the first, whereas
      ;; test-completion should obey the second.
819 820
      (when completion-ignore-case
        ;; Fixup case of the field, if necessary.
821
        (let* ((string (buffer-substring beg end))
822 823 824 825
               (compl (try-completion
                       string
                       minibuffer-completion-table
                       minibuffer-completion-predicate)))
826
          (when (and (stringp compl) (not (equal string compl))
827 828
                     ;; If it weren't for this piece of paranoia, I'd replace
                     ;; the whole thing with a call to do-completion.
829 830 831 832
                     ;; 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.
833
                     (= (length string) (length compl)))
834 835
            (goto-char end)
            (insert compl)
836 837
            (delete-region beg end))))
      (exit-minibuffer))
838

839
     ((memq minibuffer-completion-confirm '(confirm confirm-after-completion))
840
      ;; The user is permitted to exit with an input that's rejected
841
      ;; by test-completion, after confirming her choice.
842 843 844 845 846 847
      (if (or (eq last-command this-command)
              ;; For `confirm-after-completion' we only ask for confirmation
              ;; if trying to exit immediately after typing TAB (this
              ;; catches most minibuffer typos).
              (and (eq minibuffer-completion-confirm 'confirm-after-completion)
                   (not (memq last-command minibuffer-confirm-exit-commands))))
848 849 850
          (exit-minibuffer)
        (minibuffer-message "Confirm")
        nil))
851

852 853 854
     (t
      ;; Call do-completion, but ignore errors.
      (case (condition-case nil
855
                (completion--do-completion nil 'expect-exact)
856
              (error 1))
857 858 859 860 861
        ((#b001 #b011) (exit-minibuffer))
        (#b111 (if (not minibuffer-completion-confirm)
                   (exit-minibuffer)
                 (minibuffer-message "Confirm")
                 nil))
862 863
        (t nil))))))

864 865 866 867
(defun completion--try-word-completion (string table predicate point)
  (let ((comp (completion-try-completion string table predicate point)))
    (if (not (consp comp))
        comp
868

869 870
      ;; If completion finds next char not unique,
      ;; consider adding a space or a hyphen.
871
      (when (= (length string) (length (car comp)))
872 873 874 875 876 877 878 879 880
        ;; 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))
                            '(" " "-")))
881 882 883 884
              (before (substring string 0 point))
              (after (substring string point))
	      tem)
	  (while (and exts (not (consp tem)))
885
            (setq tem (completion-try-completion
886 887 888
		       (concat before (pop exts) after)
		       table predicate (1+ point))))
	  (if (consp tem) (setq comp tem))))
889

890 891 892 893 894 895 896
      ;; 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.
897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948
      (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)))))
949 950 951 952 953 954 955 956


(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)
957
  (case (completion--do-completion 'completion--try-word-completion)
958 959
    (#b000 nil)
    (t     t)))
960

961 962 963
(defface completions-annotations '((t :inherit italic))
  "Face to use for annotations in the *Completions* buffer.")

964
(defcustom completions-format 'horizontal
965 966 967
  "Define the appearance and sorting of completions.
If the value is `vertical', display completions sorted vertically
in columns in the *Completions* buffer.
968
If the value is `horizontal', display completions sorted
969
horizontally in alphabetical order, rather than down the screen."
970
  :type '(choice (const horizontal) (const vertical))
971 972 973
  :group 'minibuffer
  :version "23.2")

974
(defun completion--insert-strings (strings)
975 976 977 978 979 980 981
  "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)
982 983 984
					(+ (string-width (car s))
                                           (string-width (cadr s)))
				      (string-width s)))
985 986 987 988 989 990 991 992 993 994 995
				  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)
996 997
	   (rows (/ (length strings) columns))
	   (row 0)
998 999 1000 1001
	   (laststring nil))
      ;; The insertion should be "sensible" no matter what choices were made
      ;; for the parameters above.
      (dolist (str strings)
1002
	(unless (equal laststring str) ; Remove (consecutive) duplicates.
1003
	  (setq laststring str)
1004 1005 1006 1007
          (let ((length (if (consp str)
                            (+ (string-width (car str))
                               (string-width (cadr str)))
                          (string-width str))))
1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035
            (cond
	     ((eq completions-format 'vertical)
	      ;; Vertical format
	      (when (> row rows)
		(forward-line (- -1 rows))
		(setq row 0 column (+ column colwidth)))
	      (when (> column 0)
		(end-of-line)
		(while (> (current-column) column)
		  (if (eobp)
		      (insert "\n")
		    (forward-line 1)
		    (end-of-line)))
		(insert " \t")
		(set-text-properties (- (point) 1) (point)
				     `(display (space :align-to ,column)))))
	     (t
	      ;; Horizontal format
	      (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
1036 1037
				       ;; completion-setup-function will kill
				       ;; all local variables :-(
1038 1039
				       `(display (space :align-to ,column)))
		  nil))))
1040 1041 1042 1043 1044
            (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)
1045 1046
              (add-text-properties (point) (progn (insert (cadr str)) (point))
                                   '(mouse-face nil
1047
                                     face completions-annotations)))
1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060
	    (cond
	     ((eq completions-format 'vertical)
	      ;; Vertical format
	      (if (> column 0)
		  (forward-line)
		(insert "\n"))
	      (setq row (1+ row)))
	     (t
	      ;; Horizontal format
	      ;; Next column to align to.
	      (setq column (+ column
			      ;; Round up to a whole number of columns.
			      (* colwidth (ceiling length colwidth))))))))))))
1061

1062 1063
(defvar completion-common-substring nil)
(make-obsolete-variable 'completion-common-substring nil "23.1")