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

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 62
;; - extend `boundaries' to provide various other meta-data about the
;;   output of `all-completions':
63 64
;;   - preferred sorting order when displayed in *Completions*.
;;   - annotations/text-properties to add when displayed in *Completions*.
65 66 67 68 69 70 71 72 73 74 75 76 77 78 79
;;   - 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.
;;   - completion hook to run when the completion is
;;     selected/inserted (maybe this should be provided some other
;;     way, e.g. as text-property, so `try-completion can also return it?)
;;     both for when it's inserted via TAB or via choose-completion.
;;   - 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.
80 81 82
;;   - 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.
83 84

;; - make partial-completion-mode obsolete:
85
;;   - (?) <foo.h> style completion for file names.
86 87 88 89 90 91 92 93 94 95 96
;;     This can't be done identically just by tweaking completion,
;;     because partial-completion-mode's behavior is to expand <string.h>
;;     to /usr/include/string.h only when exiting the minibuffer, at which
;;     point the completion code is actually not involved normally.
;;     Partial-completion-mode does it via a find-file-not-found-function.
;;   - special code for C-x C-f <> to visit the file ref'd at point
;;     via (require 'foo) or #include "foo".  ffap seems like a better
;;     place for this feature (supplemented with major-mode-provided
;;     functions to find the file ref'd at point).

;; - case-sensitivity currently confuses two issues:
97
;;   - whether or not a particular completion table should be case-sensitive
98
;;     (i.e. whether strings that differ only by case are semantically
99 100 101 102 103
;;     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".

104
;; - add support for ** to pcm.
105 106
;; - Add vc-file-name-completion-table to read-file-name-internal.
;; - A feature like completing-help.el.
107 108 109 110 111

;;; Code:

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

112 113
;;; Completion table manipulation

114
;; New completion-table operation.
115 116
(defun completion-boundaries (string table pred suffix)
  "Return the boundaries of the completions returned by TABLE for STRING.
117
STRING is the string on which completion will be performed.
118 119 120 121 122 123
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
124 125
the closest directory separators."
  (let ((boundaries (if (functionp table)
126
                        (funcall table string pred (cons 'boundaries suffix)))))
127 128 129
    (if (not (eq (car-safe boundaries) 'boundaries))
        (setq boundaries nil))
    (cons (or (cadr boundaries) 0)
130
          (or (cddr boundaries) (length suffix)))))
131

132 133 134 135
(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'."
136 137
  (lexical-let ((firsterror nil)
		res)
138
    (while (and (not res) xs)
139 140 141 142 143
      (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))))))
144

145 146 147 148 149 150
(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'."
151 152 153 154 155 156 157 158 159 160 161
  (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))))
162 163 164 165

(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,
166 167 168 169
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.
170

171
The result of the `completion-table-dynamic' form is a function
172
that can be used as the COLLECTION argument to `try-completion' and
173
`all-completions'.  See Info node `(elisp)Programmed Completion'."
174 175
  (lexical-let ((fun fun))
    (lambda (string pred action)
176 177 178 179 180 181 182 183
      (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))))))
184 185 186 187 188 189 190 191 192 193 194

(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."
195
  (declare (debug (symbolp lambda-expr)))
196 197 198 199 200 201 202
  (let ((str (make-symbol "string")))
    `(completion-table-dynamic
      (lambda (,str)
        (when (functionp ,var)
          (setq ,var (,fun)))
        ,var))))

203 204 205 206
(defun completion-table-case-fold (table string pred action)
  (let ((completion-ignore-case t))
    (complete-with-action action table string pred)))

207
(defun completion-table-with-context (prefix table string pred action)
208
  ;; TODO: add `suffix' maybe?
209
  ;; Notice that `pred' may not be a function in some abusive cases.
210 211 212 213 214 215 216 217 218 219 220 221 222 223 224
  (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)))))))))
225 226
  (if (eq (car-safe action) 'boundaries)
      (let* ((len (length prefix))
227 228
             (bound (completion-boundaries string table pred (cdr action))))
        (list* 'boundaries (+ (car bound) len) (cdr bound)))
229 230 231 232 233
    (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)))))
234 235

(defun completion-table-with-terminator (terminator table string pred action)
236 237 238 239 240
  "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
241 242 243 244 245 246
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
from others (e.g. escaped)."
247 248 249 250
  ;; 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.
251
  (cond
252 253 254
   ((eq (car-safe action) 'boundaries)
    (let* ((suffix (cdr action))
           (bounds (completion-boundaries string table pred suffix))
255 256 257
           (terminator-regexp (if (consp terminator)
                                  (cdr terminator) (regexp-quote terminator)))
           (max (string-match terminator-regexp suffix)))
258 259
      (list* 'boundaries (car bounds)
             (min (cdr bounds) (or max (length suffix))))))
260 261
   ((eq action nil)
    (let ((comp (try-completion string table pred)))
262
      (if (consp terminator) (setq terminator (car terminator)))
263 264 265
      (if (eq comp t)
          (concat string terminator)
        (if (and (stringp comp)
266 267 268 269 270
                 ;; FIXME: Try to avoid this second call, especially since
                 ;; 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).
                 ;; completion-boundaries might help.
271
                 (eq (try-completion comp table pred) t))
272
            (concat comp terminator)
273
          comp))))
274 275 276 277 278
   ((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*.
279 280
    ;; (mapcar (lambda (s) (concat s terminator))
    ;;         (all-completions string table pred))))
281
    (all-completions string table pred))
282 283 284 285 286 287 288
   ;; 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.
289
PRED1 is a function of one argument which returns non-nil if and only if the
290 291 292
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'.
293 294
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.
295 296 297 298
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.
299
    (test-completion string table pred2))
300 301 302 303 304 305 306 307 308 309 310 311
   (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))))))
312

313 314
(defun completion-table-in-turn (&rest tables)
  "Create a completion table that tries each table in TABLES in turn."
315 316
  ;; FIXME: the boundaries may come from TABLE1 even when the completion list
  ;; is returned by TABLE2 (because TABLE1 returned an empty list).
317
  (lexical-let ((tables tables))
318
    (lambda (string pred action)
319 320 321 322
      (completion--some (lambda (table)
                          (complete-with-action action table string pred))
                        tables))))

323 324
;; (defmacro complete-in-turn (a b) `(completion-table-in-turn ,a ,b))
;; (defmacro dynamic-completion-table (fun) `(completion-table-dynamic ,fun))
325 326
(define-obsolete-function-alias
  'complete-in-turn 'completion-table-in-turn "23.1")
327 328
(define-obsolete-function-alias
  'dynamic-completion-table 'completion-table-dynamic "23.1")
329 330 331

;;; Minibuffer completion

332 333 334 335 336
(defgroup minibuffer nil
  "Controlling the behavior of the minibuffer."
  :link '(custom-manual "(emacs)Minibuffer")
  :group 'environment)

337 338 339 340 341 342
(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'."
343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374
  (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)))))
375 376 377 378 379 380 381 382 383

(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."
384 385 386
  ;; 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)))
387

388 389 390 391 392 393
(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."
394
  :type '(choice (const nil) (const t) (const lazy))
395 396
  :group 'minibuffer)

397
(defconst completion-styles-alist
398 399
  '((emacs21
     completion-emacs21-try-completion completion-emacs21-all-completions
400 401 402 403
     "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*\".")
404 405
    (emacs22
     completion-emacs22-try-completion completion-emacs22-all-completions
406 407 408 409
     "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.")
410 411
    (basic
     completion-basic-try-completion completion-basic-all-completions
412 413 414 415
     "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*\".")
416
    (partial-completion
417 418
     completion-pcm-try-completion completion-pcm-all-completions
     "Completion of multiple words, each one taken as a prefix.
419 420 421 422 423 424 425
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.")
426 427 428 429 430 431
    (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*\".")
432 433 434 435 436
    (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."))
437
  "List of available completion styles.
438
Each element has the form (NAME TRY-COMPLETION ALL-COMPLETIONS DOC):
439
where NAME is the name that should be used in `completion-styles',
440 441 442 443 444
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.")
445

446 447 448 449 450 451 452 453 454 455 456 457 458
(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)
459 460
  "List of completion styles to use.
The available styles are listed in `completion-styles-alist'."
461 462 463 464 465
  :type `(repeat (choice ,@(mapcar (lambda (x) (list 'const (car x)))
                                   completion-styles-alist)))
  :group 'minibuffer
  :version "23.1")

466 467 468 469 470 471 472 473
(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."
474 475 476 477
  (completion--some (lambda (style)
                      (funcall (nth 1 (assq style completion-styles-alist))
                               string table pred point))
                    completion-styles))
478

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

492 493 494 495 496
(defun minibuffer--bitset (modified completions exact)
  (logior (if modified    4 0)
          (if completions 2 0)
          (if exact       1 0)))

497 498 499
(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."
500
  ;; Maybe this should be in subr.el.
501 502 503
  ;; 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.
504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522
  (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))
523 524 525 526 527
      (setq newtext (substring newtext 0 (- suffix-len))))
    (goto-char beg)
    (insert newtext)
    (delete-region (point) (+ (point) (- end beg)))
    (forward-char suffix-len)))
528

529 530 531 532 533 534 535 536 537 538 539 540
(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")))

541 542 543 544
(defvar completion-all-sorted-completions nil)
(make-variable-buffer-local 'completion-all-sorted-completions)
(defvar completion-cycling nil)

545 546 547
(defvar completion-fail-discreetly nil
  "If non-nil, stay quiet when there  is no match.")

548
(defun completion--do-completion (&optional try-completion-function)
549
  "Do the completion and return a summary of what happened.
550 551 552 553 554 555 556 557 558 559 560 561 562
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"
563 564 565 566 567 568 569 570 571 572
  (lexical-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))))
573
    (cond
574
     ((null comp)
575
      (minibuffer-hide-completions)
576 577 578
      (unless completion-fail-discreetly
        (ding) (minibuffer-message "No match"))
      (minibuffer--bitset nil nil nil))
579
     ((eq t comp)
580
      (minibuffer-hide-completions)
581
      (goto-char (field-end))
582
      (minibuffer--bitset nil nil t))   ;Exact and unique match.
583 584 585 586
     (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.
587 588 589 590 591 592 593
      (lexical-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))))
594
        (if unchanged
595
	    (goto-char end)
596 597 598 599
          ;; 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)))
600

601
        (if (not (or unchanged completed))
602 603 604 605 606
            ;; 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).
            (completion--do-completion try-completion-function)
607 608

          ;; It did find a match.  Do we match some possibility exactly now?
609
          (let ((exact (test-completion completion
610
					minibuffer-completion-table
611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628
					minibuffer-completion-predicate))
                (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))))
629
            (completion--flush-all-sorted-completions)
630
            (cond
631 632
             ((and (consp (cdr comps)) ;; There's something to cycle.
                   (not (ignore-errors
633 634
                          ;; This signal an (intended) error if comps is too
                          ;; short or if completion-cycle-threshold is t.
635
                          (consp (nthcdr completion-cycle-threshold comps)))))
636 637 638 639 640 641
              ;; 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
642 643 644
              ;; We could also decide to refresh the completions,
              ;; if they're displayed (and assuming there are
              ;; completions left).
645
              (minibuffer-hide-completions))
646 647 648 649 650 651 652 653 654 655 656
             ;; Show the completion table, if requested.
             ((not exact)
              (if (case completion-auto-help
                    (lazy (eq this-command last-command))
                    (t completion-auto-help))
                  (minibuffer-completion-help)
                (minibuffer-message "Next char not unique")))
             ;; If the last exact completion and this one were the same, it
             ;; means we've already given a "Next char not unique" message
             ;; and the user's hit TAB again, so now we give him help.
             ((eq this-command last-command)
657
              (if completion-auto-help (minibuffer-completion-help))))
658 659

            (minibuffer--bitset completed t exact))))))))
660 661 662 663 664 665 666 667 668 669 670

(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)
671
    (completion--flush-all-sorted-completions)
672 673
    (setq minibuffer-scroll-window nil))

674
  (cond
675 676
    ;; If there's a fresh completion window with a live buffer,
    ;; and this command is repeated, scroll that window.
677 678
   ((window-live-p minibuffer-scroll-window)
    (let ((window minibuffer-scroll-window))
679 680 681 682 683 684
        (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))
685 686
        nil)))
   ;; If we're cycling, keep on cycling.
687
   ((and completion-cycling completion-all-sorted-completions)
688 689 690
    (minibuffer-force-complete)
    t)
   (t (case (completion--do-completion)
691
        (#b000 nil)
692
        (#b001 (minibuffer-message "Sole completion")
693
               t)
694
        (#b011 (minibuffer-message "Complete, but not unique")
695 696
               t)
        (t     t)))))
697

698
(defun completion--flush-all-sorted-completions (&rest ignore)
699 700
  (remove-hook 'after-change-functions
               'completion--flush-all-sorted-completions t)
701
  (setq completion-cycling nil)
702 703 704 705 706 707 708 709 710 711 712 713 714 715 716
  (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.
717 718 719 720 721 722 723 724 725
          (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))))))))
726
          ;; Prefer recently used completions.
727 728
          ;; FIXME: Additional sorting ideas:
          ;; - for M-x, prefer commands that have no key binding.
729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745
          (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.
746 747
  ;; FIXME: ~/src/emacs/t<M-TAB>/lisp/minibuffer.el completes to
  ;; ~/src/emacs/trunk/ and throws away lisp/minibuffer.el.
748 749 750 751 752
  (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"))
753
      (setq completion-cycling t)
754 755 756 757 758 759 760 761
      (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.
762 763 764
      (let ((last (last all)))
        (setcdr last (cons (car all) (cdr last)))
        (setq completion-all-sorted-completions (cdr all))))))
765

766
(defvar minibuffer-confirm-exit-commands
767
  '(minibuffer-complete minibuffer-complete-word PC-complete PC-complete-word)
768 769 770
  "A list of commands which cause an immediately following
`minibuffer-complete-and-exit' to ask for extra confirmation.")

771
(defun minibuffer-complete-and-exit ()
772 773 774 775 776 777 778 779 780 781
  "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
782 783 784
 preceding minibuffer command was a member of
 `minibuffer-confirm-exit-commands', and accept the input
 otherwise."
785
  (interactive)
786 787
  (lexical-let ((beg (field-beginning))
		(end (field-end)))
788 789 790 791 792 793
    (cond
     ;; Allow user to specify null string
     ((= beg end) (exit-minibuffer))
     ((test-completion (buffer-substring beg end)
                       minibuffer-completion-table
                       minibuffer-completion-predicate)
794 795 796 797 798 799
      ;; 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.
800 801
      (when completion-ignore-case
        ;; Fixup case of the field, if necessary.
802
        (let* ((string (buffer-substring beg end))
803 804 805 806
               (compl (try-completion
                       string
                       minibuffer-completion-table
                       minibuffer-completion-predicate)))
807
          (when (and (stringp compl) (not (equal string compl))
808 809
                     ;; If it weren't for this piece of paranoia, I'd replace
                     ;; the whole thing with a call to do-completion.
810 811 812 813
                     ;; 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.
814
                     (= (length string) (length compl)))
815 816
            (goto-char end)
            (insert compl)
817 818
            (delete-region beg end))))
      (exit-minibuffer))
819

820
     ((memq minibuffer-completion-confirm '(confirm confirm-after-completion))
821
      ;; The user is permitted to exit with an input that's rejected
822
      ;; by test-completion, after confirming her choice.
823 824 825 826 827 828
      (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))))
829 830 831
          (exit-minibuffer)
        (minibuffer-message "Confirm")
        nil))
832

833 834 835 836 837
     (t
      ;; Call do-completion, but ignore errors.
      (case (condition-case nil
                (completion--do-completion)
              (error 1))
838 839 840 841 842
        ((#b001 #b011) (exit-minibuffer))
        (#b111 (if (not minibuffer-completion-confirm)
                   (exit-minibuffer)
                 (minibuffer-message "Confirm")
                 nil))
843 844
        (t nil))))))

845 846 847 848
(defun completion--try-word-completion (string table predicate point)
  (let ((comp (completion-try-completion string table predicate point)))
    (if (not (consp comp))
        comp
849

850 851
      ;; If completion finds next char not unique,
      ;; consider adding a space or a hyphen.
852
      (when (= (length string) (length (car comp)))
853 854 855 856 857 858 859 860 861
        ;; 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))
                            '(" " "-")))
862 863 864 865
              (before (substring string 0 point))
              (after (substring string point))
	      tem)
	  (while (and exts (not (consp tem)))
866
            (setq tem (completion-try-completion
867 868 869
		       (concat before (pop exts) after)
		       table predicate (1+ point))))
	  (if (consp tem) (setq comp tem))))
870

871 872 873 874 875 876 877
      ;; 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.
878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 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
      (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)))))
930 931 932 933 934 935 936 937


(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)
938
  (case (completion--do-completion 'completion--try-word-completion)
939
    (#b000 nil)
940
    (#b001 (minibuffer-message "Sole completion")
941
           t)
942
    (#b011 (minibuffer-message "Complete, but not unique")
943 944
           t)
    (t     t)))
945

946 947 948
(defface completions-annotations '((t :inherit italic))
  "Face to use for annotations in the *Completions* buffer.")

949
(defcustom completions-format 'horizontal
950 951 952
  "Define the appearance and sorting of completions.
If the value is `vertical', display completions sorted vertically
in columns in the *Completions* buffer.
953
If the value is `horizontal', display completions sorted
954
horizontally in alphabetical order, rather than down the screen."
955
  :type '(choice (const horizontal) (const vertical))
956 957 958
  :group 'minibuffer
  :version "23.2")

959
(defun completion--insert-strings (strings)
960 961 962 963 964 965 966
  "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)
967 968 969
					(+ (string-width (car s))
                                           (string-width (cadr s)))
				      (string-width s)))
970 971 972 973 974 975 976 977 978 979 980
				  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)
981 982
	   (rows (/ (length strings) columns))
	   (row 0)
983 984 985 986
	   (laststring nil))
      ;; The insertion should be "sensible" no matter what choices were made
      ;; for the parameters above.
      (dolist (str strings)
987
	(unless (equal laststring str) ; Remove (consecutive) duplicates.
988
	  (setq laststring str)
989 990 991 992
          (let ((length (if (consp str)
                            (+ (string-width (car str))
                               (string-width (cadr str)))
                          (string-width str))))
993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020
            (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
1021 1022
				       ;; completion-setup-function will kill
				       ;; all local variables :-(
1023 1024
				       `(display (space :align-to ,column)))
		  nil))))
1025 1026 1027 1028 1029
            (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)
1030 1031
              (add-text-properties (point) (progn (insert (cadr str)) (point))
                                   '(mouse-face nil
1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045
						face completions-annotations)))
	    (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))))))))))))
1046

1047 1048
(defvar completion-common-substring nil)
(make-obsolete-variable 'completion-common-substring nil "23.1")
1049

1050 1051 1052 1053 1054
(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'.
1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069
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)

1070
(defun completion-hilit-commonality (completions prefix-len base-size)
1071
  (when completions
1072
    (let ((com-str-len (- prefix-len (or base-size 0))))
1073 1074
      (nconc
       (mapcar
1075 1076 1077 1078 1079 1080 1081 1082 1083 1084
        (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)))))
1085 1086 1087 1088 1089
            (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))
1090 1091 1092 1093 1094 1095 1096
                               '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)
1097 1098
        completions)
       base-size))))
1099

1100
(defun display-completion-list (completions &optional common-substring)
1101 1102 1103