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

3
;; Copyright (C) 2008-2013 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
;; Names with "--" are for functions and variables that are meant to be for
;; internal use only.

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

;;; Bugs:

41
;; - completion-all-sorted-completions lists all the completions, whereas
42 43
;;   it should only lists the ones that `try-completion' would consider.
;;   E.g.  it should honor completion-ignored-extensions.
44
;; - choose-completion can't automatically figure out the boundaries
45 46 47 48 49 50
;;   corresponding to the displayed completions because we only
;;   provide the start info but not the end info in
;;   completion-base-position.
;; - 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.
51

52 53
;;; Todo:

54 55 56
;; - Make *Completions* readable even if some of the completion
;;   entries have LF chars or spaces in them (including at
;;   beginning/end) or are very long.
57
;; - for M-x, cycle-sort commands that have no key binding first.
58 59
;; - Make things like icomplete-mode or lightning-completion work with
;;   completion-in-region-mode.
60
;; - extend `metadata':
61 62
;;   - indicate how to turn all-completion's output into
;;     try-completion's output: e.g. completion-ignored-extensions.
63
;;     maybe that could be merged with the "quote" operation.
64 65 66 67 68
;;   - 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.
69 70 71
;;   - 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.
72

73
;; - case-sensitivity currently confuses two issues:
74
;;   - whether or not a particular completion table should be case-sensitive
75
;;     (i.e. whether strings that differ only by case are semantically
76 77 78 79
;;     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".
80 81 82
;;   Maybe the trick is that we should distinguish completion-ignore-case in
;;   try/all-completions (obey user's preference) from its use in
;;   test-completion (obey the underlying object's semantics).
83

84
;; - add support for ** to pcm.
85 86
;; - Add vc-file-name-completion-table to read-file-name-internal.
;; - A feature like completing-help.el.
87 88 89

;;; Code:

Stefan Monnier's avatar
Stefan Monnier committed
90
(eval-when-compile (require 'cl-lib))
91

92 93
;;; Completion table manipulation

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

113 114 115 116 117 118 119 120 121 122 123 124
(defun completion-metadata (string table pred)
  "Return the metadata of elements to complete at the end of STRING.
This metadata is an alist.  Currently understood keys are:
- `category': the kind of objects returned by `all-completions'.
   Used by `completion-category-overrides'.
- `annotation-function': function to add annotations in *Completions*.
   Takes one argument (STRING), which is a possible completion and
   returns a string to append to STRING.
- `display-sort-function': function to sort entries in *Completions*.
   Takes one argument (COMPLETIONS) and should return a new list
   of completions.  Can operate destructively.
- `cycle-sort-function': function to sort entries when cycling.
125 126
   Works like `display-sort-function'.
The metadata of a completion table should be constant between two boundaries."
127 128 129
  (let ((metadata (if (functionp table)
                      (funcall table string pred 'metadata))))
    (if (eq (car-safe metadata) 'metadata)
130 131
        metadata
      '(metadata))))
132 133 134 135 136 137 138 139 140

(defun completion--field-metadata (field-start)
  (completion-metadata (buffer-substring-no-properties field-start (point))
                       minibuffer-completion-table
                       minibuffer-completion-predicate))

(defun completion-metadata-get (metadata prop)
  (cdr (assq prop metadata)))

141 142 143 144
(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'."
145 146
  (let ((firsterror nil)
        res)
147
    (while (and (not res) xs)
148
      (condition-case-unless-debug err
149 150 151 152
          (setq res (funcall fun (pop xs)))
        (error (unless firsterror (setq firsterror err)) nil)))
    (or res
        (if firsterror (signal (car firsterror) (cdr firsterror))))))
153

154 155 156
(defun complete-with-action (action table string pred)
  "Perform completion ACTION.
STRING is the string to complete.
157
TABLE is the completion table.
158 159
PRED is a completion predicate.
ACTION can be one of nil, t or `lambda'."
160 161
  (cond
   ((functionp table) (funcall table string pred action))
162 163
   ((eq (car-safe action) 'boundaries) nil)
   ((eq action 'metadata) nil)
164 165 166 167 168 169 170
   (t
    (funcall
     (cond
      ((null action) 'try-completion)
      ((eq action t) 'all-completions)
      (t 'test-completion))
     string table pred))))
171 172 173 174

(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,
175 176 177 178
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.
179

180
The result of the `completion-table-dynamic' form is a function
181
that can be used as the COLLECTION argument to `try-completion' and
182
`all-completions'.  See Info node `(elisp)Programmed Completion'."
183
  (lambda (string pred action)
184
    (if (or (eq (car-safe action) 'boundaries) (eq action 'metadata))
185 186 187 188 189 190 191
        ;; `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)))))
192

193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210
(defun completion-table-with-cache (fun &optional ignore-case)
  "Create dynamic completion table from FUN, with cache.
This wraps `completion-table-dynamic', but saves the last
argument-result pair from FUN, so that several lookups with the
same argument (or with an argument that starts with the first one)
only need to call FUN once.  Most useful when FUN performs a relatively
slow operation, such as calling an external process (see Bug#11906).
When IGNORE-CASE is non-nil, FUN is expected to be case-insensitive."
  (let* (last-arg last-result
         (new-fun
          (lambda (arg)
            (if (and last-arg (string-prefix-p last-arg arg ignore-case))
                last-result
              (prog1
                  (setq last-result (funcall fun arg))
                (setq last-arg arg))))))
    (completion-table-dynamic new-fun)))

211 212 213 214 215 216 217 218 219 220
(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."
221
  (declare (debug (symbolp lambda-expr)))
222 223 224 225
  (let ((str (make-symbol "string")))
    `(completion-table-dynamic
      (lambda (,str)
        (when (functionp ,var)
Stefan Monnier's avatar
Stefan Monnier committed
226
          (setq ,var (funcall #',fun)))
227 228
        ,var))))

229 230 231 232 233 234 235
(defun completion-table-case-fold (table &optional dont-fold)
  "Return new completion TABLE that is case insensitive.
If DONT-FOLD is non-nil, return a completion table that is
case sensitive instead."
  (lambda (string pred action)
    (let ((completion-ignore-case (not dont-fold)))
      (complete-with-action action table string pred))))
236

237
(defun completion-table-subvert (table s1 s2)
238
  "Return a completion table from TABLE with S1 replaced by S2.
239
The result is a completion table which completes strings of the
240 241
form (concat S1 S) in the same way as TABLE completes strings of
the form (concat S2 S)."
242 243 244 245 246 247 248 249 250
  (lambda (string pred action)
    (let* ((str (if (eq t (compare-strings string 0 (length s1) s1 nil nil
                                           completion-ignore-case))
                    (concat s2 (substring string (length s1)))))
           (res (if str (complete-with-action action table str pred))))
      (when res
        (cond
         ((eq (car-safe action) 'boundaries)
          (let ((beg (or (and (eq (car-safe res) 'boundaries) (cadr res)) 0)))
Stefan Monnier's avatar
Stefan Monnier committed
251 252 253 254
            `(boundaries
              ,(max (length s1)
                    (+ beg (- (length s1) (length s2))))
              . ,(and (eq (car-safe res) 'boundaries) (cddr res)))))
255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272
         ((stringp res)
          (if (eq t (compare-strings res 0 (length s2) s2 nil nil
                                     completion-ignore-case))
              (concat s1 (substring res (length s2)))))
         ((eq action t)
          (let ((bounds (completion-boundaries str table pred "")))
            (if (>= (car bounds) (length s2))
                res
              (let ((re (concat "\\`"
                                (regexp-quote (substring s2 (car bounds))))))
                (delq nil
                      (mapcar (lambda (c)
                                (if (string-match re c)
                                    (substring c (match-end 0))))
                              res))))))
         ;; E.g. action=nil and it's the only completion.
         (res))))))

273
(defun completion-table-with-context (prefix table string pred action)
274
  ;; TODO: add `suffix' maybe?
275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293
  (let ((pred
         (if (not (functionp pred))
             ;; Notice that `pred' may not be a function in some abusive cases.
             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)))))))))
    (if (eq (car-safe action) 'boundaries)
        (let* ((len (length prefix))
               (bound (completion-boundaries string table pred (cdr action))))
Stefan Monnier's avatar
Stefan Monnier committed
294
          `(boundaries ,(+ (car bound) len) . ,(cdr bound)))
295 296 297 298 299
      (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))))))
300 301

(defun completion-table-with-terminator (terminator table string pred action)
302 303 304 305 306
  "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
307 308 309 310 311
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
312 313 314
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."
315 316 317 318
  ;; 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.
319
  (cond
320 321 322
   ((eq (car-safe action) 'boundaries)
    (let* ((suffix (cdr action))
           (bounds (completion-boundaries string table pred suffix))
323 324
           (terminator-regexp (if (consp terminator)
                                  (cdr terminator) (regexp-quote terminator)))
325 326
           (max (and terminator-regexp
                     (string-match terminator-regexp suffix))))
Stefan Monnier's avatar
Stefan Monnier committed
327 328
      `(boundaries ,(car bounds)
                   . ,(min (cdr bounds) (or max (length suffix))))))
329 330
   ((eq action nil)
    (let ((comp (try-completion string table pred)))
331
      (if (consp terminator) (setq terminator (car terminator)))
332
      (if (eq comp t)
333 334 335 336 337
          (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
338 339 340
                 ;; 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).
341 342
                 (let ((newbounds (completion-boundaries comp table pred "")))
                   (< (car newbounds) (length comp)))
343
                 (eq (try-completion comp table pred) t))
344 345 346
            (if (functionp terminator)
                (funcall terminator comp)
              (concat comp terminator))
347
          comp))))
348 349 350 351 352
   ;; 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)
   (t
353 354 355 356
    ;; 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*.
357 358
    ;; (mapcar (lambda (s) (concat s terminator))
    ;;         (all-completions string table pred))))
359
    (complete-with-action action table string pred))))
360 361 362

(defun completion-table-with-predicate (table pred1 strict string pred2 action)
  "Make a completion table equivalent to TABLE but filtered through PRED1.
363
PRED1 is a function of one argument which returns non-nil if and only if the
364 365 366
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'.
367 368
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.
369 370 371 372
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.
373
    (test-completion string table pred2))
374 375
   (t
    (or (complete-with-action action table string
376 377
                              (if (not (and pred1 pred2))
                                  (or pred1 pred2)
378 379 380
                                (lambda (x)
                                  ;; Call `pred1' first, so that `pred2'
                                  ;; really can't tell that `x' is in table.
381
                                  (and (funcall pred1 x) (funcall pred2 x)))))
382 383
        ;; If completion failed and we're not applying pred1 strictly, try
        ;; again without pred1.
384
        (and (not strict) pred1 pred2
385
             (complete-with-action action table string pred2))))))
386

387 388
(defun completion-table-in-turn (&rest tables)
  "Create a completion table that tries each table in TABLES in turn."
389 390
  ;; FIXME: the boundaries may come from TABLE1 even when the completion list
  ;; is returned by TABLE2 (because TABLE1 returned an empty list).
391 392 393 394
  (lambda (string pred action)
    (completion--some (lambda (table)
                        (complete-with-action action table string pred))
                      tables)))
395

396 397 398 399 400 401 402 403 404
(defun completion-table-with-quoting (table unquote requote)
  ;; A difficult part of completion-with-quoting is to map positions in the
  ;; quoted string to equivalent positions in the unquoted string and
  ;; vice-versa.  There is no efficient and reliable algorithm that works for
  ;; arbitrary quote and unquote functions.
  ;; So to map from quoted positions to unquoted positions, we simply assume
  ;; that `concat' and `unquote' commute (which tends to be the case).
  ;; And we ask `requote' to do the work of mapping from unquoted positions
  ;; back to quoted positions.
405 406
  ;; FIXME: For some forms of "quoting" such as the truncation behavior of
  ;; substitute-in-file-name, it would be desirable not to requote completely.
407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436
  "Return a new completion table operating on quoted text.
TABLE operates on the unquoted text.
UNQUOTE is a function that takes a string and returns a new unquoted string.
REQUOTE is a function of 2 args (UPOS QSTR) where
  QSTR is a string entered by the user (and hence indicating
  the user's preferred form of quoting); and
  UPOS is a position within the unquoted form of QSTR.
REQUOTE should return a pair (QPOS . QFUN) such that QPOS is the
position corresponding to UPOS but in QSTR, and QFUN is a function
of one argument (a string) which returns that argument appropriately quoted
for use at QPOS."
  ;; FIXME: One problem with the current setup is that `qfun' doesn't know if
  ;; its argument is "the end of the completion", so if the quoting used double
  ;; quotes (for example), we end up completing "fo" to "foobar and throwing
  ;; away the closing double quote.
  (lambda (string pred action)
    (cond
     ((eq action 'metadata)
      (append (completion-metadata string table pred)
              '((completion--unquote-requote . t))))

     ((eq action 'lambda) ;;test-completion
      (let ((ustring (funcall unquote string)))
        (test-completion ustring table pred)))

     ((eq (car-safe action) 'boundaries)
      (let* ((ustring (funcall unquote string))
             (qsuffix (cdr action))
             (ufull (if (zerop (length qsuffix)) ustring
                      (funcall unquote (concat string qsuffix))))
Stefan Monnier's avatar
Stefan Monnier committed
437
             (_ (cl-assert (string-prefix-p ustring ufull)))
438 439 440 441 442 443 444 445 446
             (usuffix (substring ufull (length ustring)))
             (boundaries (completion-boundaries ustring table pred usuffix))
             (qlboundary (car (funcall requote (car boundaries) string)))
             (qrboundary (if (zerop (cdr boundaries)) 0 ;Common case.
                           (let* ((urfullboundary
                                   (+ (cdr boundaries) (length ustring))))
                             (- (car (funcall requote urfullboundary
                                              (concat string qsuffix)))
                                (length string))))))
Stefan Monnier's avatar
Stefan Monnier committed
447
        `(boundaries ,qlboundary . ,qrboundary)))
448

449 450 451 452 453 454 455
     ;; In "normal" use a c-t-with-quoting completion table should never be
     ;; called with action in (t nil) because `completion--unquote' should have
     ;; been called before and would have returned a different completion table
     ;; to apply to the unquoted text.  But there's still a lot of code around
     ;; that likes to use all/try-completions directly, so we do our best to
     ;; handle those calls as well as we can.

456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482
     ((eq action nil) ;;try-completion
      (let* ((ustring (funcall unquote string))
             (completion (try-completion ustring table pred)))
        ;; Most forms of quoting allow several ways to quote the same string.
        ;; So here we could simply requote `completion' in a kind of
        ;; "canonical" quoted form without paying attention to the way
        ;; `string' was quoted.  But since we have to solve the more complex
        ;; problems of "pay attention to the original quoting" for
        ;; all-completions, we may as well use it here, since it provides
        ;; a nicer behavior.
        (if (not (stringp completion)) completion
          (car (completion--twq-try
                string ustring completion 0 unquote requote)))))

     ((eq action t) ;;all-completions
      ;; When all-completions is used for completion-try/all-completions
      ;; (e.g. for `pcm' style), we can't do the job properly here because
      ;; the caller will match our output against some pattern derived from
      ;; the user's (quoted) input, and we don't have access to that
      ;; pattern, so we can't know how to requote our output so that it
      ;; matches the quoting used in the pattern.  It is to fix this
      ;; fundamental problem that we have to introduce the new
      ;; unquote-requote method so that completion-try/all-completions can
      ;; pass the unquoted string to the style functions.
      (pcase-let*
          ((ustring (funcall unquote string))
           (completions (all-completions ustring table pred))
483 484 485 486 487 488 489
           (boundary (car (completion-boundaries ustring table pred "")))
           (completions
            (completion--twq-all
             string ustring completions boundary unquote requote))
           (last (last completions)))
        (when (consp last) (setcdr last nil))
        completions))
490

491 492 493 494
     ((eq action 'completion--unquote)
      (let ((ustring (funcall unquote string))
            (uprefix (funcall unquote (substring string 0 pred))))
        ;; We presume (more or less) that `concat' and `unquote' commute.
Stefan Monnier's avatar
Stefan Monnier committed
495
        (cl-assert (string-prefix-p uprefix ustring))
496 497 498
        (list ustring table (length uprefix)
              (lambda (unquoted-result op)
                (pcase op
Stefan Monnier's avatar
Stefan Monnier committed
499
                  (1 ;;try
500 501 502 503 504 505
                   (if (not (stringp (car-safe unquoted-result)))
                       unquoted-result
                     (completion--twq-try
                      string ustring
                      (car unquoted-result) (cdr unquoted-result)
                      unquote requote)))
Stefan Monnier's avatar
Stefan Monnier committed
506
                  (2 ;;all
507 508 509 510 511 512 513 514 515 516
                   (let* ((last (last unquoted-result))
                          (base (or (cdr last) 0)))
                     (when last
                       (setcdr last nil)
                       (completion--twq-all string ustring
                                            unquoted-result base
                                            unquote requote))))))))))))

(defun completion--twq-try (string ustring completion point
                                   unquote requote)
517
  ;; Basically two cases: either the new result is
518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533
  ;; - commonprefix1 <point> morecommonprefix <qpos> suffix
  ;; - commonprefix <qpos> newprefix <point> suffix
  (pcase-let*
      ((prefix (fill-common-string-prefix ustring completion))
       (suffix (substring completion (max point (length prefix))))
       (`(,qpos . ,qfun) (funcall requote (length prefix) string))
       (qstr1 (if (> point (length prefix))
                  (funcall qfun (substring completion (length prefix) point))))
       (qsuffix (funcall qfun suffix))
       (qstring (concat (substring string 0 qpos) qstr1 qsuffix))
       (qpoint
        (cond
         ((zerop point) 0)
         ((> point (length prefix)) (+ qpos (length qstr1)))
         (t (car (funcall requote point string))))))
    ;; Make sure `requote' worked.
534 535 536 537 538 539 540
    (if (equal (funcall unquote qstring) completion)
	(cons qstring qpoint)
      ;; If requote failed (e.g. because sifn-requote did not handle
      ;; Tramp's "/foo:/bar//baz -> /foo:/baz" truncation), then at least
      ;; try requote properly.
      (let ((qstr (funcall qfun completion)))
	(cons qstr (length qstr))))))
541

542 543 544
(defun completion--string-equal-p (s1 s2)
  (eq t (compare-strings s1 nil nil s2 nil nil 'ignore-case)))

545
(defun completion--twq-all (string ustring completions boundary
546
                                   _unquote requote)
547 548 549 550 551 552 553 554 555
  (when completions
    (pcase-let*
        ((prefix
          (let ((completion-regexp-list nil))
            (try-completion "" (cons (substring ustring boundary)
                                     completions))))
         (`(,qfullpos . ,qfun)
          (funcall requote (+ boundary (length prefix)) string))
         (qfullprefix (substring string 0 qfullpos))
556 557 558 559 560 561
	 ;; FIXME: This assertion can be wrong, e.g. in Cygwin, where
	 ;; (unquote "c:\bin") => "/usr/bin" but (unquote "c:\") => "/".
         ;;(cl-assert (completion--string-equal-p
         ;;            (funcall unquote qfullprefix)
         ;;            (concat (substring ustring 0 boundary) prefix))
         ;;           t))
562
         (qboundary (car (funcall requote boundary string)))
Stefan Monnier's avatar
Stefan Monnier committed
563
         (_ (cl-assert (<= qboundary qfullpos)))
564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585
         ;; FIXME: this split/quote/concat business messes up the carefully
         ;; placed completions-common-part and completions-first-difference
         ;; faces.  We could try within the mapcar loop to search for the
         ;; boundaries of those faces, pass them to `requote' to find their
         ;; equivalent positions in the quoted output and re-add the faces:
         ;; this might actually lead to correct results but would be
         ;; pretty expensive.
         ;; The better solution is to not quote the *Completions* display,
         ;; which nicely circumvents the problem.  The solution I used here
         ;; instead is to hope that `qfun' preserves the text-properties and
         ;; presume that the `first-difference' is not within the `prefix';
         ;; this presumption is not always true, but at least in practice it is
         ;; true in most cases.
         (qprefix (propertize (substring qfullprefix qboundary)
                              'face 'completions-common-part)))

      ;; Here we choose to quote all elements returned, but a better option
      ;; would be to return unquoted elements together with a function to
      ;; requote them, so that *Completions* can show nicer unquoted values
      ;; which only get quoted when needed by choose-completion.
      (nconc
       (mapcar (lambda (completion)
Stefan Monnier's avatar
Stefan Monnier committed
586
                 (cl-assert (string-prefix-p prefix completion 'ignore-case) t)
587 588
                 (let* ((new (substring completion (length prefix)))
                        (qnew (funcall qfun new))
589 590 591 592 593 594 595 596 597 598 599
 			(qprefix
                         (if (not completion-ignore-case)
                             qprefix
                           ;; Make qprefix inherit the case from `completion'.
                           (let* ((rest (substring completion
                                                   0 (length prefix)))
                                  (qrest (funcall qfun rest)))
                             (if (completion--string-equal-p qprefix qrest)
                                 (propertize qrest 'face
                                             'completions-common-part)
                               qprefix))))
600
                        (qcompletion (concat qprefix qnew)))
601 602 603 604 605 606 607 608 609 610
		   ;; FIXME: Similarly here, Cygwin's mapping trips this
		   ;; assertion.
                   ;;(cl-assert
                   ;; (completion--string-equal-p
		   ;;  (funcall unquote
		   ;;           (concat (substring string 0 qboundary)
		   ;;                   qcompletion))
		   ;;  (concat (substring ustring 0 boundary)
		   ;;          completion))
		   ;; t)
611 612 613 614
                   qcompletion))
               completions)
       qboundary))))

615 616
;; (defmacro complete-in-turn (a b) `(completion-table-in-turn ,a ,b))
;; (defmacro dynamic-completion-table (fun) `(completion-table-dynamic ,fun))
617 618
(define-obsolete-function-alias
  'complete-in-turn 'completion-table-in-turn "23.1")
619 620
(define-obsolete-function-alias
  'dynamic-completion-table 'completion-table-dynamic "23.1")
621 622 623

;;; Minibuffer completion

624 625 626 627 628
(defgroup minibuffer nil
  "Controlling the behavior of the minibuffer."
  :link '(custom-manual "(emacs)Minibuffer")
  :group 'environment)

629 630 631 632 633 634
(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'."
635 636 637 638 639 640 641 642 643
  (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)
644 645
    (setq message (if (and (null args)
                           (string-match-p "\\` *\\[.+\\]\\'" message))
646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667
                      ;; 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)))))
668 669 670

(defun minibuffer-completion-contents ()
  "Return the user input in a minibuffer before point as a string.
671 672
In Emacs-22, that was what completion commands operated on."
  (declare (obsolete nil "24.4"))
673
  (buffer-substring (minibuffer-prompt-end) (point)))
674 675 676 677

(defun delete-minibuffer-contents ()
  "Delete all user input in a minibuffer.
If the current buffer is not a minibuffer, erase its entire contents."
678
  (interactive)
679 680 681
  ;; 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)))
682

683 684 685
(defvar completion-show-inline-help t
  "If non-nil, print helpful inline messages during completion.")

686 687 688 689 690 691
(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."
692
  :type '(choice (const nil) (const t) (const lazy)))
693

694
(defconst completion-styles-alist
695 696
  '((emacs21
     completion-emacs21-try-completion completion-emacs21-all-completions
697 698 699 700
     "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*\".")
701 702
    (emacs22
     completion-emacs22-try-completion completion-emacs22-all-completions
703 704 705 706
     "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.")
707 708
    (basic
     completion-basic-try-completion completion-basic-all-completions
709 710 711 712
     "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*\".")
713
    (partial-completion
714 715
     completion-pcm-try-completion completion-pcm-all-completions
     "Completion of multiple words, each one taken as a prefix.
716 717 718 719 720 721 722
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.")
723 724 725 726 727 728
    (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*\".")
729 730 731 732 733
    (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."))
734
  "List of available completion styles.
735
Each element has the form (NAME TRY-COMPLETION ALL-COMPLETIONS DOC):
736
where NAME is the name that should be used in `completion-styles',
737 738 739 740 741
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.")
742

743 744 745 746 747 748 749 750 751
(defconst completion--styles-type
  `(repeat :tag "insert a new menu to add more styles"
           (choice ,@(mapcar (lambda (x) (list 'const (car x)))
                             completion-styles-alist))))
(defconst completion--cycling-threshold-type
  '(choice (const :tag "No cycling" nil)
           (const :tag "Always cycle" t)
           (integer :tag "Threshold")))

752 753 754 755 756 757 758 759 760 761 762 763 764
(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)
765
  "List of completion styles to use.
766 767 768 769
The available styles are listed in `completion-styles-alist'.

Note that `completion-category-overrides' may override these
styles for specific categories, such as files, buffers, etc."
770
  :type completion--styles-type
771 772
  :version "23.1")

773 774
(defcustom completion-category-overrides
  '((buffer (styles . (basic substring))))
775
  "List of `completion-styles' overrides for specific categories.
776 777 778
Each override has the shape (CATEGORY . ALIST) where ALIST is
an association list that can specify properties such as:
- `styles': the list of `completion-styles' to use for that category.
Glenn Morris's avatar
Glenn Morris committed
779 780 781
- `cycle': the `completion-cycle-threshold' to use for that category.
Categories are symbols such as `buffer' and `file', used when
completing buffer and file names, respectively."
782
  :version "24.1"
783 784
  :type `(alist :key-type (choice :tag "Category"
				  (const buffer)
785
                                  (const file)
786
                                  (const unicode-name)
787
				  (const bookmark)
788 789
                                  symbol)
          :value-type
790 791 792
          (set :tag "Properties to override"
	   (cons :tag "Completion Styles"
		 (const :tag "Select a style from the menu;" styles)
793
		 ,completion--styles-type)
794 795
           (cons :tag "Completion Cycling"
		 (const :tag "Select one value from the menu." cycle)
796
                 ,completion--cycling-threshold-type))))
797 798 799 800 801 802 803 804

(defun completion--styles (metadata)
  (let* ((cat (completion-metadata-get metadata 'category))
         (over (assq 'styles (cdr (assq cat completion-category-overrides)))))
    (if over
        (delete-dups (append (cdr over) (copy-sequence completion-styles)))
       completion-styles)))

805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836
(defun completion--nth-completion (n string table pred point metadata)
  "Call the Nth method of completion styles."
  (unless metadata
    (setq metadata
          (completion-metadata (substring string 0 point) table pred)))
  ;; We provide special support for quoting/unquoting here because it cannot
  ;; reliably be done within the normal completion-table routines: Completion
  ;; styles such as `substring' or `partial-completion' need to match the
  ;; output of all-completions with the user's input, and since most/all
  ;; quoting mechanisms allow several equivalent quoted forms, the
  ;; completion-style can't do this matching (e.g. `substring' doesn't know
  ;; that "\a\b\e" is a valid (quoted) substring of "label").
  ;; The quote/unquote function needs to come from the completion table (rather
  ;; than from completion-extra-properties) because it may apply only to some
  ;; part of the string (e.g. substitute-in-file-name).
  (let ((requote
         (when (completion-metadata-get metadata 'completion--unquote-requote)
           (let ((new (funcall table string point 'completion--unquote)))
             (setq string (pop new))
             (setq table (pop new))
             (setq point (pop new))
             (pop new))))
       (result
        (completion--some (lambda (style)
                            (funcall (nth n (assq style
                                                  completion-styles-alist))
                                     string table pred point))
                          (completion--styles metadata))))
    (if requote
        (funcall requote result n)
      result)))

837
(defun completion-try-completion (string table pred point &optional metadata)
838 839 840 841 842
  "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,
843
or a pair (NEWSTRING . NEWPOINT) of the completed result string together with
844
a new position for point."
845
  (completion--nth-completion 1 string table pred point metadata))
846

847
(defun completion-all-completions (string table pred point &optional metadata)
848 849 850
  "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.
851
The return value is a list of completions and may contain the base-size
852
in the last `cdr'."
853 854
  ;; FIXME: We need to additionally return the info needed for the
  ;; second part of completion-base-position.
855
  (completion--nth-completion 2 string table pred point metadata))
856

857 858 859 860 861
(defun minibuffer--bitset (modified completions exact)
  (logior (if modified    4 0)
          (if completions 2 0)
          (if exact       1 0)))

862 863 864
(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."
865 866 867 868
  ;; The properties on `newtext' include things like
  ;; completions-first-difference, which we don't want to include
  ;; upon insertion.
  (set-text-properties 0 (length newtext) nil newtext)
869
  ;; Maybe this should be in subr.el.
870 871 872
  ;; 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.
873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891
  (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))
892 893
      (setq newtext (substring newtext 0 (- suffix-len))))
    (goto-char beg)
894 895 896
    (let ((length (- end beg)))         ;Read `end' before we insert the text.
      (insert-and-inherit newtext)
      (delete-region (point) (+ (point) length)))
897
    (forward-char suffix-len)))
898

899 900
(defcustom completion-cycle-threshold nil
  "Number of completion candidates below which cycling is used.
901
Depending on this setting `completion-in-region' may use cycling,
902 903 904
like `minibuffer-force-complete'.
If nil, cycling is never used.
If t, cycling is always used.
905 906
If an integer, cycling is used so long as there are not more
completion candidates than this number."
907
  :version "24.1"
908
  :type completion--cycling-threshold-type)
909

910 911 912 913 914
(defun completion--cycle-threshold (metadata)
  (let* ((cat (completion-metadata-get metadata 'category))
         (over (assq 'cycle (cdr (assq cat completion-category-overrides)))))
    (if over (cdr over) completion-cycle-threshold)))

915
(defvar-local completion-all-sorted-completions nil)
916
(defvar-local completion--all-sorted-completions-location nil)
917 918
(defvar completion-cycling nil)

919 920 921
(defvar completion-fail-discreetly nil
  "If non-nil, stay quiet when there  is no match.")

922 923 924 925
(defun completion--message (msg)
  (if completion-show-inline-help
      (minibuffer-message msg)))

926 927
(defun completion--do-completion (beg end &optional
                                      try-completion-function expect-exact)
928
  "Do the completion and return a summary of what happened.
929 930 931 932 933 934 935 936 937 938 939 940
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
941 942 943 944 945
 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."
946
  (let* ((string (buffer-substring beg end))
947
         (md (completion--field-metadata beg))
948 949 950 951 952
         (comp (funcall (or try-completion-function
                            'completion-try-completion)
                        string
                        minibuffer-completion-table
                        minibuffer-completion-predicate
953 954
                        (- (point) beg)
                        md)))
955
    (cond
956
     ((null comp)
957
      (minibuffer-hide-completions)
958
      (unless completion-fail-discreetly
959
	(ding)
960
	(completion--message "No match"))
961
      (minibuffer--bitset nil nil nil))
962
     ((eq t comp)
963
      (minibuffer-hide-completions)
964 965 966
      (goto-char end)
      (completion--done string 'finished
                        (unless expect-exact "Sole completion"))
967
      (minibuffer--bitset nil nil t))   ;Exact and unique match.
968 969 970 971
     (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.
972 973 974 975 976 977
      (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))))
978
        (if unchanged
979
	    (goto-char end)
980
          ;; Insert in minibuffer the chars we got.
981 982
          (completion--replace beg end completion)
          (setq end (+ beg (length completion))))
983 984
	;; Move point to its completion-mandated destination.
	(forward-char (- comp-pos (length completion)))
985

986
        (if (not (or unchanged completed))
987 988 989 990
            ;; 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).
991 992
            (completion--do-completion beg end
                                       try-completion-function expect-exact)
993 994

          ;; It did find a match.  Do we match some possibility exactly now?
995
          (let* ((exact (test-completion completion
996 997
                                         minibuffer-completion-table
                                         minibuffer-completion-predicate))
998
                 (threshold (completion--cycle-threshold md))
999 1000 1001 1002 1003 1004
                 (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.
1005
                  (when (and threshold
1006 1007 1008 1009 1010 1011 1012
                             ;; 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
1013 1014
                                         ""))
                                   comp-pos)))
1015
                   (completion-all-sorted-completions beg end))))
1016
            (completion--flush-all-sorted-completions)
1017
            (cond
1018 1019
             ((and (consp (cdr comps)) ;; There's something to cycle.
                   (not (ignore-errors
1020 1021
                          ;; This signal an (intended) error if comps is too
                          ;; short or if completion-cycle-threshold is t.
1022
                          (consp (nthcdr threshold comps)))))
1023
              ;; Not more than completion-cycle-threshold remaining
1024 1025
              ;; completions: let's cycle.
              (setq completed t exact t)
1026 1027
              (completion--cache-all-sorted-completions beg end comps)
              (minibuffer-force-complete beg end))
1028
             (completed
1029 1030 1031
              ;; We could also decide to refresh the completions,
              ;; if they're displayed (and assuming there are
              ;; completions left).
1032 1033 1034 1035 1036