(gud-basic-call): Don't only save the buffer but the excursion as well.
[emacs.git] / lisp / pcomplete.el
blob387aa106a43ab47f1680b9c09beaf706f10f934e
1 ;;; pcomplete.el --- programmable completion
3 ;; Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004
4 ;; 2005, 2006, 2007, 2008, 2009 Free Software Foundation, Inc.
6 ;; Author: John Wiegley <johnw@gnu.org>
7 ;; Keywords: processes abbrev
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation, either version 3 of the License, or
14 ;; (at your option) any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
24 ;;; Commentary:
26 ;; This module provides a programmable completion facility using
27 ;; "completion functions". Each completion function is responsible
28 ;; for producing a list of possible completions relevant to the current
29 ;; argument position.
31 ;; To use pcomplete with shell-mode, for example, you will need the
32 ;; following in your .emacs file:
34 ;; (add-hook 'shell-mode-hook 'pcomplete-shell-setup)
36 ;; Most of the code below simply provides support mechanisms for
37 ;; writing completion functions. Completion functions themselves are
38 ;; very easy to write. They have few requirements beyond those of
39 ;; regular Lisp functions.
41 ;; Consider the following example, which will complete against
42 ;; filenames for the first two arguments, and directories for all
43 ;; remaining arguments:
45 ;; (defun pcomplete/my-command ()
46 ;; (pcomplete-here (pcomplete-entries))
47 ;; (pcomplete-here (pcomplete-entries))
48 ;; (while (pcomplete-here (pcomplete-dirs))))
50 ;; Here are the requirements for completion functions:
52 ;; @ They must be called "pcomplete/MAJOR-MODE/NAME", or
53 ;; "pcomplete/NAME". This is how they are looked up, using the NAME
54 ;; specified in the command argument (the argument in first
55 ;; position).
57 ;; @ They must be callable with no arguments.
59 ;; @ Their return value is ignored. If they actually return normally,
60 ;; it means no completions were available.
62 ;; @ In order to provide completions, they must throw the tag
63 ;; `pcomplete-completions'. The value must be a completion table
64 ;; (i.e. a table that can be passed to try-completion and friends)
65 ;; for the final argument.
67 ;; @ To simplify completion function logic, the tag `pcompleted' may
68 ;; be thrown with a value of nil in order to abort the function. It
69 ;; means that there were no completions available.
71 ;; When a completion function is called, the variable `pcomplete-args'
72 ;; is in scope, and contains all of the arguments specified on the
73 ;; command line. The variable `pcomplete-last' is the index of the
74 ;; last argument in that list.
76 ;; The variable `pcomplete-index' is used by the completion code to
77 ;; know which argument the completion function is currently examining.
78 ;; It always begins at 1, meaning the first argument after the command
79 ;; name.
81 ;; To facilitate writing completion logic, a special macro,
82 ;; `pcomplete-here', has been provided which does several things:
84 ;; 1. It will throw `pcompleted' (with a value of nil) whenever
85 ;; `pcomplete-index' exceeds `pcomplete-last'.
87 ;; 2. It will increment `pcomplete-index' if the final argument has
88 ;; not been reached yet.
90 ;; 3. It will evaluate the form passed to it, and throw the result
91 ;; using the `pcomplete-completions' tag, if it is called when
92 ;; `pcomplete-index' is pointing to the final argument.
94 ;; Sometimes a completion function will want to vary the possible
95 ;; completions for an argument based on the previous one. To
96 ;; facilitate tests like this, the function `pcomplete-test' and
97 ;; `pcomplete-match' are provided. Called with one argument, they
98 ;; test the value of the previous command argument. Otherwise, a
99 ;; relative index may be given as an optional second argument, where 0
100 ;; refers to the current argument, 1 the previous, 2 the one before
101 ;; that, etc. The symbols `first' and `last' specify absolute
102 ;; offsets.
104 ;; Here is an example which will only complete against directories for
105 ;; the second argument if the first argument is also a directory:
107 ;; (defun pcomplete/example ()
108 ;; (pcomplete-here (pcomplete-entries))
109 ;; (if (pcomplete-test 'file-directory-p)
110 ;; (pcomplete-here (pcomplete-dirs))
111 ;; (pcomplete-here (pcomplete-entries))))
113 ;; For generating completion lists based on directory contents, see
114 ;; the functions `pcomplete-entries', `pcomplete-dirs',
115 ;; `pcomplete-executables' and `pcomplete-all-entries'.
117 ;; Consult the documentation for `pcomplete-here' for information
118 ;; about its other arguments.
120 ;;; Code:
122 (eval-when-compile (require 'cl))
124 (defgroup pcomplete nil
125 "Programmable completion."
126 :version "21.1"
127 :group 'processes)
129 ;;; User Variables:
131 (defcustom pcomplete-file-ignore nil
132 "A regexp of filenames to be disregarded during file completion."
133 :type '(choice regexp (const :tag "None" nil))
134 :group 'pcomplete)
136 (defcustom pcomplete-dir-ignore nil
137 "A regexp of names to be disregarded during directory completion."
138 :type '(choice regexp (const :tag "None" nil))
139 :group 'pcomplete)
141 (defcustom pcomplete-ignore-case (memq system-type '(ms-dos windows-nt cygwin))
142 ;; FIXME: the doc mentions file-name completion, but the code
143 ;; seems to apply it to all completions.
144 "If non-nil, ignore case when doing filename completion."
145 :type 'boolean
146 :group 'pcomplete)
148 (defcustom pcomplete-autolist nil
149 "If non-nil, automatically list possibilities on partial completion.
150 This mirrors the optional behavior of tcsh."
151 :type 'boolean
152 :group 'pcomplete)
154 (defcustom pcomplete-suffix-list (list ?/ ?:)
155 "A list of characters which constitute a proper suffix."
156 :type '(repeat character)
157 :group 'pcomplete)
159 (defcustom pcomplete-recexact nil
160 "If non-nil, use shortest completion if characters cannot be added.
161 This mirrors the optional behavior of tcsh.
163 A non-nil value is useful if `pcomplete-autolist' is non-nil too."
164 :type 'boolean
165 :group 'pcomplete)
167 (defcustom pcomplete-arg-quote-list nil
168 "List of characters to quote when completing an argument."
169 :type '(choice (repeat character)
170 (const :tag "Don't quote" nil))
171 :group 'pcomplete)
173 (defcustom pcomplete-quote-arg-hook nil
174 "A hook which is run to quote a character within a filename.
175 Each function is passed both the filename to be quoted, and the index
176 to be considered. If the function wishes to provide an alternate
177 quoted form, it need only return the replacement string. If no
178 function provides a replacement, quoting shall proceed as normal,
179 using a backslash to quote any character which is a member of
180 `pcomplete-arg-quote-list'."
181 :type 'hook
182 :group 'pcomplete)
184 (defcustom pcomplete-man-function 'man
185 "A function to that will be called to display a manual page.
186 It will be passed the name of the command to document."
187 :type 'function
188 :group 'pcomplete)
190 (defcustom pcomplete-compare-entry-function 'string-lessp
191 "This function is used to order file entries for completion.
192 The behavior of most all shells is to sort alphabetically."
193 :type '(radio (function-item string-lessp)
194 (function-item file-newer-than-file-p)
195 (function :tag "Other"))
196 :group 'pcomplete)
198 (defcustom pcomplete-help nil
199 "A string or function (or nil) used for context-sensitive help.
200 If a string, it should name an Info node that will be jumped to.
201 If non-nil, it must a sexp that will be evaluated, and whose
202 result will be shown in the minibuffer.
203 If nil, the function `pcomplete-man-function' will be called with the
204 current command argument."
205 :type '(choice string sexp (const :tag "Use man page" nil))
206 :group 'pcomplete)
208 (defcustom pcomplete-expand-before-complete nil
209 "If non-nil, expand the current argument before completing it.
210 This means that typing something such as '$HOME/bi' followed by
211 \\[pcomplete-argument] will cause the variable reference to be
212 resolved first, and the resultant value that will be completed against
213 to be inserted in the buffer. Note that exactly what gets expanded
214 and how is entirely up to the behavior of the
215 `pcomplete-parse-arguments-function'."
216 :type 'boolean
217 :group 'pcomplete)
219 (defcustom pcomplete-parse-arguments-function
220 'pcomplete-parse-buffer-arguments
221 "A function to call to parse the current line's arguments.
222 It should be called with no parameters, and with point at the position
223 of the argument that is to be completed.
225 It must either return nil, or a cons cell of the form:
227 ((ARG...) (BEG-POS...))
229 The two lists must be identical in length. The first gives the final
230 value of each command line argument (which need not match the textual
231 representation of that argument), and BEG-POS gives the beginning
232 position of each argument, as it is seen by the user. The establishes
233 a relationship between the fully resolved value of the argument, and
234 the textual representation of the argument."
235 :type 'function
236 :group 'pcomplete)
238 (defcustom pcomplete-cycle-completions t
239 "If non-nil, hitting the TAB key cycles through the completion list.
240 Typical Emacs behavior is to complete as much as possible, then pause
241 waiting for further input. Then if TAB is hit again, show a list of
242 possible completions. When `pcomplete-cycle-completions' is non-nil,
243 it acts more like zsh or 4nt, showing the first maximal match first,
244 followed by any further matches on each subsequent pressing of the TAB
245 key. \\[pcomplete-list] is the key to press if the user wants to see
246 the list of possible completions."
247 :type 'boolean
248 :group 'pcomplete)
250 (defcustom pcomplete-cycle-cutoff-length 5
251 "If the number of completions is greater than this, don't cycle.
252 This variable is a compromise between the traditional Emacs style of
253 completion, and the \"cycling\" style. Basically, if there are more
254 than this number of completions possible, don't automatically pick the
255 first one and then expect the user to press TAB to cycle through them.
256 Typically, when there are a large number of completion possibilities,
257 the user wants to see them in a list buffer so that they can know what
258 options are available. But if the list is small, it means the user
259 has already entered enough input to disambiguate most of the
260 possibilities, and therefore they are probably most interested in
261 cycling through the candidates. Set this value to nil if you want
262 cycling to always be enabled."
263 :type '(choice integer (const :tag "Always cycle" nil))
264 :group 'pcomplete)
266 (defcustom pcomplete-restore-window-delay 1
267 "The number of seconds to wait before restoring completion windows.
268 Once the completion window has been displayed, if the user then goes
269 on to type something else, that completion window will be removed from
270 the display (actually, the original window configuration before it was
271 displayed will be restored), after this many seconds of idle time. If
272 set to nil, completion windows will be left on second until the user
273 removes them manually. If set to 0, they will disappear immediately
274 after the user enters a key other than TAB."
275 :type '(choice integer (const :tag "Never restore" nil))
276 :group 'pcomplete)
278 (defcustom pcomplete-try-first-hook nil
279 "A list of functions which are called before completing an argument.
280 This can be used, for example, for completing things which might apply
281 to all arguments, such as variable names after a $."
282 :type 'hook
283 :group 'pcomplete)
285 (defsubst pcomplete-executables (&optional regexp)
286 "Complete amongst a list of directories and executables."
287 (pcomplete-entries regexp 'file-executable-p))
289 (defcustom pcomplete-command-completion-function
290 (function
291 (lambda ()
292 (pcomplete-here (pcomplete-executables))))
293 "Function called for completing the initial command argument."
294 :type 'function
295 :group 'pcomplete)
297 (defcustom pcomplete-command-name-function 'pcomplete-command-name
298 "Function called for determining the current command name."
299 :type 'function
300 :group 'pcomplete)
302 (defcustom pcomplete-default-completion-function
303 (function
304 (lambda ()
305 (while (pcomplete-here (pcomplete-entries)))))
306 "Function called when no completion rule can be found.
307 This function is used to generate completions for every argument."
308 :type 'function
309 :group 'pcomplete)
311 (defcustom pcomplete-use-paring t
312 "If t, pare alternatives that have already been used.
313 If nil, you will always see the completion set of possible options, no
314 matter which of those options have already been used in previous
315 command arguments."
316 :type 'boolean
317 :group 'pcomplete)
319 (defcustom pcomplete-termination-string " "
320 "A string that is inserted after any completion or expansion.
321 This is usually a space character, useful when completing lists of
322 words separated by spaces. However, if your list uses a different
323 separator character, or if the completion occurs in a word that is
324 already terminated by a character, this variable should be locally
325 modified to be an empty string, or the desired separation string."
326 :type 'string
327 :group 'pcomplete)
329 ;;; Internal Variables:
331 ;; for cycling completion support
332 (defvar pcomplete-current-completions nil)
333 (defvar pcomplete-last-completion-length)
334 (defvar pcomplete-last-completion-stub)
335 (defvar pcomplete-last-completion-raw)
336 (defvar pcomplete-last-window-config nil)
337 (defvar pcomplete-window-restore-timer nil)
339 (make-variable-buffer-local 'pcomplete-current-completions)
340 (make-variable-buffer-local 'pcomplete-last-completion-length)
341 (make-variable-buffer-local 'pcomplete-last-completion-stub)
342 (make-variable-buffer-local 'pcomplete-last-completion-raw)
343 (make-variable-buffer-local 'pcomplete-last-window-config)
344 (make-variable-buffer-local 'pcomplete-window-restore-timer)
346 ;; used for altering pcomplete's behavior. These global variables
347 ;; should always be nil.
348 (defvar pcomplete-show-help nil)
349 (defvar pcomplete-show-list nil)
350 (defvar pcomplete-expand-only-p nil)
352 ;;; User Functions:
354 ;;; Alternative front-end using the standard completion facilities.
356 ;; The way pcomplete-parse-arguments, pcomplete-stub, and
357 ;; pcomplete-quote-argument work only works because of some deep
358 ;; hypothesis about the way the completion work. Basically, it makes
359 ;; it pretty much impossible to have completion other than
360 ;; prefix-completion.
362 ;; pcomplete--common-quoted-suffix and pcomplete--table-subvert try to
363 ;; work around this difficulty with heuristics, but it's
364 ;; really a hack.
366 (defvar pcomplete-unquote-argument-function nil)
368 (defun pcomplete-unquote-argument (s)
369 (cond
370 (pcomplete-unquote-argument-function
371 (funcall pcomplete-unquote-argument-function s))
372 ((null pcomplete-arg-quote-list) s)
374 (replace-regexp-in-string "\\\\\\(.\\)" "\\1" s t))))
376 (defun pcomplete--common-suffix (s1 s2)
377 (assert (not (or (string-match "\n" s1) (string-match "\n" s2))))
378 ;; Since S2 is expected to be the "unquoted/expanded" version of S1,
379 ;; there shouldn't be any case difference, even if the completion is
380 ;; case-insensitive.
381 (let ((case-fold-search nil)) ;; pcomplete-ignore-case
382 (string-match ".*?\\(.*\\)\n.*\\1\\'" (concat s1 "\n" s2))
383 (- (match-end 1) (match-beginning 1))))
385 (defun pcomplete--common-quoted-suffix (s1 s2)
386 "Find the common suffix between S1 and S2 where S1 is the expanded S2.
387 S1 is expected to be the unquoted and expanded version of S1.
388 Returns (PS1 . PS2), i.e. the shortest prefixes of S1 and S2, such that
389 S1 = (concat PS1 SS1) and S2 = (concat PS2 SS2) and
390 SS1 = (unquote SS2)."
391 (let* ((cs (pcomplete--common-suffix s1 s2))
392 (ss1 (substring s1 (- (length s1) cs)))
393 (qss1 (pcomplete-quote-argument ss1))
395 (if (and (not (equal ss1 qss1))
396 (setq qc (pcomplete-quote-argument (substring ss1 0 1)))
397 (eq t (compare-strings s2 (- (length s2) cs (length qc) -1)
398 (- (length s2) cs -1)
399 qc nil nil)))
400 ;; The difference found is just that one char is quoted in S2
401 ;; but not in S1, keep looking before this difference.
402 (pcomplete--common-quoted-suffix
403 (substring s1 0 (- (length s1) cs))
404 (substring s2 0 (- (length s2) cs (length qc) -1)))
405 (cons (substring s1 0 (- (length s1) cs))
406 (substring s2 0 (- (length s2) cs))))))
408 (defun pcomplete--table-subvert (table s1 s2 string pred action)
409 "Completion table that replaces the prefix S1 with S2 in STRING.
410 When TABLE, S1 and S2 are provided by `apply-partially', the result
411 is a completion table which completes strings of the form (concat S1 S)
412 in the same way as TABLE completes strings of the form (concat S2 S)."
413 (let* ((str (if (eq t (compare-strings string 0 (length s1) s1 nil nil
414 completion-ignore-case))
415 (concat s2 (pcomplete-unquote-argument
416 (substring string (length s1))))))
417 (res (if str (complete-with-action action table str pred))))
418 (when res
419 (cond
420 ((and (eq (car-safe action) 'boundaries))
421 (let ((beg (or (and (eq (car-safe res) 'boundaries) (cadr res)) 0)))
422 (list* 'boundaries
423 (max (length s1)
424 ;; FIXME: Adjust because of quoting/unquoting.
425 (+ beg (- (length s1) (length s2))))
426 (and (eq (car-safe res) 'boundaries) (cddr res)))))
427 ((stringp res)
428 (if (eq t (compare-strings res 0 (length s2) s2 nil nil
429 completion-ignore-case))
430 (concat s1 (pcomplete-quote-argument
431 (substring res (length s2))))))
432 ((eq action t)
433 (let ((bounds (completion-boundaries str table pred "")))
434 (if (>= (car bounds) (length s2))
436 (let ((re (concat "\\`"
437 (regexp-quote (substring s2 (car bounds))))))
438 (delq nil
439 (mapcar (lambda (c)
440 (if (string-match re c)
441 (substring c (match-end 0))))
442 res))))))))))
444 ;; I don't think such commands are usable before first setting up buffer-local
445 ;; variables to parse args, so there's no point autoloading it.
446 ;; ;;;###autoload
447 (defun pcomplete-std-complete ()
448 "Provide standard completion using pcomplete's completion tables.
449 Same as `pcomplete' but using the standard completion UI."
450 (interactive)
451 ;; FIXME: it only completes the text before point, whereas the
452 ;; standard UI may also consider text after point.
453 (catch 'pcompleted
454 (let* ((pcomplete-stub)
455 pcomplete-seen pcomplete-norm-func
456 pcomplete-args pcomplete-last pcomplete-index
457 (pcomplete-autolist pcomplete-autolist)
458 (pcomplete-suffix-list pcomplete-suffix-list)
459 ;; Apparently the vars above are global vars modified by
460 ;; side-effects, whereas pcomplete-completions is the core
461 ;; function that finds the chunk of text to complete
462 ;; (returned indirectly in pcomplete-stub) and the set of
463 ;; possible completions.
464 (completions (pcomplete-completions))
465 ;; Usually there's some close connection between pcomplete-stub
466 ;; and the text before point. But depending on what
467 ;; pcomplete-parse-arguments-function does, that connection
468 ;; might not be that close. E.g. in eshell,
469 ;; pcomplete-parse-arguments-function expands envvars.
471 ;; Since we use minibuffer-complete, which doesn't know
472 ;; pcomplete-stub and works from the buffer's text instead,
473 ;; we need to trick minibuffer-complete, into using
474 ;; pcomplete-stub without its knowledge. To that end, we
475 ;; use pcomplete--table-subvert to construct a completion
476 ;; table which expects strings using a prefix from the
477 ;; buffer's text but internally uses the corresponding
478 ;; prefix from pcomplete-stub.
479 (beg (max (- (point) (length pcomplete-stub))
480 (pcomplete-begin)))
481 (buftext (buffer-substring beg (point)))
482 (table
483 (if (not (equal pcomplete-stub buftext))
484 ;; This isn't always strictly right (e.g. if
485 ;; FOO="toto/$FOO", then completion of /$FOO/bar may
486 ;; result in something incorrect), but given the lack of
487 ;; any other info, it's about as good as it gets, and in
488 ;; practice it should work just fine (fingers crossed).
489 (let ((prefixes (pcomplete--common-quoted-suffix
490 pcomplete-stub buftext)))
491 (apply-partially
492 'pcomplete--table-subvert
493 completions
494 (cdr prefixes) (car prefixes)))
495 (lexical-let ((completions completions))
496 (lambda (string pred action)
497 (let ((res (complete-with-action
498 action completions string pred)))
499 (if (stringp res)
500 (pcomplete-quote-argument res)
501 res))))))
502 (pred
503 ;; pare it down, if applicable
504 (when (and pcomplete-use-paring pcomplete-seen)
505 (setq pcomplete-seen
506 (mapcar (lambda (f)
507 (funcall pcomplete-norm-func
508 (directory-file-name f)))
509 pcomplete-seen))
510 (lambda (f)
511 (not (member
512 (funcall pcomplete-norm-func
513 (directory-file-name f))
514 pcomplete-seen))))))
516 (completion-in-region
517 beg (point)
518 ;; Add a space at the end of completion. Use a terminator-regexp
519 ;; that never matches since the terminator cannot appear
520 ;; within the completion field anyway.
521 (if (zerop (length pcomplete-termination-string))
522 table
523 (apply-partially 'completion-table-with-terminator
524 (cons pcomplete-termination-string
525 "\\`a\\`")
526 table))
527 pred))))
529 ;;; Pcomplete's native UI.
531 ;;;###autoload
532 (defun pcomplete (&optional interactively)
533 "Support extensible programmable completion.
534 To use this function, just bind the TAB key to it, or add it to your
535 completion functions list (it should occur fairly early in the list)."
536 (interactive "p")
537 (if (and interactively
538 pcomplete-cycle-completions
539 pcomplete-current-completions
540 (memq last-command '(pcomplete
541 pcomplete-expand-and-complete
542 pcomplete-reverse)))
543 (progn
544 (delete-backward-char pcomplete-last-completion-length)
545 (if (eq this-command 'pcomplete-reverse)
546 (progn
547 (push (car (last pcomplete-current-completions))
548 pcomplete-current-completions)
549 (setcdr (last pcomplete-current-completions 2) nil))
550 (nconc pcomplete-current-completions
551 (list (car pcomplete-current-completions)))
552 (setq pcomplete-current-completions
553 (cdr pcomplete-current-completions)))
554 (pcomplete-insert-entry pcomplete-last-completion-stub
555 (car pcomplete-current-completions)
556 nil pcomplete-last-completion-raw))
557 (setq pcomplete-current-completions nil
558 pcomplete-last-completion-raw nil)
559 (catch 'pcompleted
560 (let* ((pcomplete-stub)
561 pcomplete-seen pcomplete-norm-func
562 pcomplete-args pcomplete-last pcomplete-index
563 (pcomplete-autolist pcomplete-autolist)
564 (pcomplete-suffix-list pcomplete-suffix-list)
565 (completions (pcomplete-completions))
566 (result (pcomplete-do-complete pcomplete-stub completions)))
567 (and result
568 (not (eq (car result) 'listed))
569 (cdr result)
570 (pcomplete-insert-entry pcomplete-stub (cdr result)
571 (memq (car result)
572 '(sole shortest))
573 pcomplete-last-completion-raw))))))
575 ;;;###autoload
576 (defun pcomplete-reverse ()
577 "If cycling completion is in use, cycle backwards."
578 (interactive)
579 (call-interactively 'pcomplete))
581 ;;;###autoload
582 (defun pcomplete-expand-and-complete ()
583 "Expand the textual value of the current argument.
584 This will modify the current buffer."
585 (interactive)
586 (let ((pcomplete-expand-before-complete t))
587 (pcomplete)))
589 ;;;###autoload
590 (defun pcomplete-continue ()
591 "Complete without reference to any cycling completions."
592 (interactive)
593 (setq pcomplete-current-completions nil
594 pcomplete-last-completion-raw nil)
595 (call-interactively 'pcomplete))
597 ;;;###autoload
598 (defun pcomplete-expand ()
599 "Expand the textual value of the current argument.
600 This will modify the current buffer."
601 (interactive)
602 (let ((pcomplete-expand-before-complete t)
603 (pcomplete-expand-only-p t))
604 (pcomplete)
605 (when (and pcomplete-current-completions
606 (> (length pcomplete-current-completions) 0)) ;??
607 (delete-backward-char pcomplete-last-completion-length)
608 (while pcomplete-current-completions
609 (unless (pcomplete-insert-entry
610 "" (car pcomplete-current-completions) t
611 pcomplete-last-completion-raw)
612 (insert-and-inherit pcomplete-termination-string))
613 (setq pcomplete-current-completions
614 (cdr pcomplete-current-completions))))))
616 ;;;###autoload
617 (defun pcomplete-help ()
618 "Display any help information relative to the current argument."
619 (interactive)
620 (let ((pcomplete-show-help t))
621 (pcomplete)))
623 ;;;###autoload
624 (defun pcomplete-list ()
625 "Show the list of possible completions for the current argument."
626 (interactive)
627 (when (and pcomplete-cycle-completions
628 pcomplete-current-completions
629 (eq last-command 'pcomplete-argument))
630 (delete-backward-char pcomplete-last-completion-length)
631 (setq pcomplete-current-completions nil
632 pcomplete-last-completion-raw nil))
633 (let ((pcomplete-show-list t))
634 (pcomplete)))
636 ;;; Internal Functions:
638 ;; argument handling
640 ;; for the sake of the bye-compiler, when compiling other files that
641 ;; contain completion functions
642 (defvar pcomplete-args nil)
643 (defvar pcomplete-begins nil)
644 (defvar pcomplete-last nil)
645 (defvar pcomplete-index nil)
646 (defvar pcomplete-stub nil)
647 (defvar pcomplete-seen nil)
648 (defvar pcomplete-norm-func nil)
650 (defun pcomplete-arg (&optional index offset)
651 "Return the textual content of the INDEXth argument.
652 INDEX is based from the current processing position. If INDEX is
653 positive, values returned are closer to the command argument; if
654 negative, they are closer to the last argument. If the INDEX is
655 outside of the argument list, nil is returned. The default value for
656 INDEX is 0, meaning the current argument being examined.
658 The special indices `first' and `last' may be used to access those
659 parts of the list.
661 The OFFSET argument is added to/taken away from the index that will be
662 used. This is really only useful with `first' and `last', for
663 accessing absolute argument positions."
664 (setq index
665 (if (eq index 'first)
667 (if (eq index 'last)
668 pcomplete-last
669 (- pcomplete-index (or index 0)))))
670 (if offset
671 (setq index (+ index offset)))
672 (nth index pcomplete-args))
674 (defun pcomplete-begin (&optional index offset)
675 "Return the beginning position of the INDEXth argument.
676 See the documentation for `pcomplete-arg'."
677 (setq index
678 (if (eq index 'first)
680 (if (eq index 'last)
681 pcomplete-last
682 (- pcomplete-index (or index 0)))))
683 (if offset
684 (setq index (+ index offset)))
685 (nth index pcomplete-begins))
687 (defsubst pcomplete-actual-arg (&optional index offset)
688 "Return the actual text representation of the last argument.
689 This is different from `pcomplete-arg', which returns the textual value
690 that the last argument evaluated to. This function returns what the
691 user actually typed in."
692 (buffer-substring (pcomplete-begin index offset) (point)))
694 (defsubst pcomplete-next-arg ()
695 "Move the various pointers to the next argument."
696 (setq pcomplete-index (1+ pcomplete-index)
697 pcomplete-stub (pcomplete-arg))
698 (if (> pcomplete-index pcomplete-last)
699 (progn
700 (message "No completions")
701 (throw 'pcompleted nil))))
703 (defun pcomplete-command-name ()
704 "Return the command name of the first argument."
705 (file-name-nondirectory (pcomplete-arg 'first)))
707 (defun pcomplete-match (regexp &optional index offset start)
708 "Like `string-match', but on the current completion argument."
709 (let ((arg (pcomplete-arg (or index 1) offset)))
710 (if arg
711 (string-match regexp arg start)
712 (throw 'pcompleted nil))))
714 (defun pcomplete-match-string (which &optional index offset)
715 "Like `match-string', but on the current completion argument."
716 (let ((arg (pcomplete-arg (or index 1) offset)))
717 (if arg
718 (match-string which arg)
719 (throw 'pcompleted nil))))
721 (defalias 'pcomplete-match-beginning 'match-beginning)
722 (defalias 'pcomplete-match-end 'match-end)
724 (defsubst pcomplete--test (pred arg)
725 "Perform a programmable completion predicate match."
726 (and pred
727 (cond ((eq pred t) t)
728 ((functionp pred)
729 (funcall pred arg))
730 ((stringp pred)
731 (string-match (concat "^" pred "$") arg)))
732 pred))
734 (defun pcomplete-test (predicates &optional index offset)
735 "Predicates to test the current programmable argument with."
736 (let ((arg (pcomplete-arg (or index 1) offset)))
737 (unless (null predicates)
738 (if (not (listp predicates))
739 (pcomplete--test predicates arg)
740 (let ((pred predicates)
741 found)
742 (while (and pred (not found))
743 (setq found (pcomplete--test (car pred) arg)
744 pred (cdr pred)))
745 found)))))
747 (defun pcomplete-parse-buffer-arguments ()
748 "Parse whitespace separated arguments in the current region."
749 (let ((begin (point-min))
750 (end (point-max))
751 begins args)
752 (save-excursion
753 (goto-char begin)
754 (while (< (point) end)
755 (skip-chars-forward " \t\n")
756 (push (point) begins)
757 (skip-chars-forward "^ \t\n")
758 (push (buffer-substring-no-properties
759 (car begins) (point))
760 args))
761 (cons (nreverse args) (nreverse begins)))))
763 ;;;###autoload
764 (defun pcomplete-comint-setup (completef-sym)
765 "Setup a comint buffer to use pcomplete.
766 COMPLETEF-SYM should be the symbol where the
767 dynamic-complete-functions are kept. For comint mode itself,
768 this is `comint-dynamic-complete-functions'."
769 (set (make-local-variable 'pcomplete-parse-arguments-function)
770 'pcomplete-parse-comint-arguments)
771 (set (make-local-variable completef-sym)
772 (copy-sequence (symbol-value completef-sym)))
773 (let* ((funs (symbol-value completef-sym))
774 (elem (or (memq 'shell-dynamic-complete-filename funs)
775 (memq 'comint-dynamic-complete-filename funs))))
776 (if elem
777 (setcar elem 'pcomplete)
778 (add-to-list completef-sym 'pcomplete))))
780 ;;;###autoload
781 (defun pcomplete-shell-setup ()
782 "Setup `shell-mode' to use pcomplete."
783 ;; FIXME: insufficient
784 (pcomplete-comint-setup 'comint-dynamic-complete-functions))
786 (declare-function comint-bol "comint" (&optional arg))
788 (defun pcomplete-parse-comint-arguments ()
789 "Parse whitespace separated arguments in the current region."
790 (let ((begin (save-excursion (comint-bol nil) (point)))
791 (end (point))
792 begins args)
793 (save-excursion
794 (goto-char begin)
795 (while (< (point) end)
796 (skip-chars-forward " \t\n")
797 (push (point) begins)
798 (let ((skip t))
799 (while skip
800 (skip-chars-forward "^ \t\n")
801 (if (eq (char-before) ?\\)
802 (skip-chars-forward " \t\n")
803 (setq skip nil))))
804 (push (buffer-substring-no-properties (car begins) (point))
805 args))
806 (cons (nreverse args) (nreverse begins)))))
808 (defun pcomplete-parse-arguments (&optional expand-p)
809 "Parse the command line arguments. Most completions need this info."
810 (let ((results (funcall pcomplete-parse-arguments-function)))
811 (when results
812 (setq pcomplete-args (or (car results) (list ""))
813 pcomplete-begins (or (cdr results) (list (point)))
814 pcomplete-last (1- (length pcomplete-args))
815 pcomplete-index 0
816 pcomplete-stub (pcomplete-arg 'last))
817 (let ((begin (pcomplete-begin 'last)))
818 (if (and pcomplete-cycle-completions
819 (listp pcomplete-stub) ;??
820 (not pcomplete-expand-only-p))
821 (let* ((completions pcomplete-stub) ;??
822 (common-stub (car completions))
823 (c completions)
824 (len (length common-stub)))
825 (while (and c (> len 0))
826 (while (and (> len 0)
827 (not (string=
828 (substring common-stub 0 len)
829 (substring (car c) 0
830 (min (length (car c))
831 len)))))
832 (setq len (1- len)))
833 (setq c (cdr c)))
834 (setq pcomplete-stub (substring common-stub 0 len)
835 pcomplete-autolist t)
836 (when (and begin (not pcomplete-show-list))
837 (delete-region begin (point))
838 (pcomplete-insert-entry "" pcomplete-stub))
839 (throw 'pcomplete-completions completions))
840 (when expand-p
841 (if (stringp pcomplete-stub)
842 (when begin
843 (delete-region begin (point))
844 (insert-and-inherit pcomplete-stub))
845 (if (and (listp pcomplete-stub)
846 pcomplete-expand-only-p)
847 ;; this is for the benefit of `pcomplete-expand'
848 (setq pcomplete-last-completion-length (- (point) begin)
849 pcomplete-current-completions pcomplete-stub)
850 (error "Cannot expand argument"))))
851 (if pcomplete-expand-only-p
852 (throw 'pcompleted t)
853 pcomplete-args))))))
855 (defun pcomplete-quote-argument (filename)
856 "Return FILENAME with magic characters quoted.
857 Magic characters are those in `pcomplete-arg-quote-list'."
858 (if (null pcomplete-arg-quote-list)
859 filename
860 (let ((index 0))
861 (mapconcat (lambda (c)
862 (prog1
863 (or (run-hook-with-args-until-success
864 'pcomplete-quote-arg-hook filename index)
865 (when (memq c pcomplete-arg-quote-list)
866 (string "\\" c))
867 (char-to-string c))
868 (setq index (1+ index))))
869 filename
870 ""))))
872 ;; file-system completion lists
874 (defsubst pcomplete-dirs-or-entries (&optional regexp predicate)
875 "Return either directories, or qualified entries."
876 ;; FIXME: pcomplete-entries doesn't return a list any more.
877 (pcomplete-entries
879 (lexical-let ((re regexp)
880 (pred predicate))
881 (lambda (f)
882 (or (file-directory-p f)
883 (and (if (not re) t (string-match re f))
884 (if (not pred) t (funcall pred f))))))))
886 (defun pcomplete-entries (&optional regexp predicate)
887 "Complete against a list of directory candidates.
888 If REGEXP is non-nil, it is a regular expression used to refine the
889 match (files not matching the REGEXP will be excluded).
890 If PREDICATE is non-nil, it will also be used to refine the match
891 \(files for which the PREDICATE returns nil will be excluded).
892 If no directory information can be extracted from the completed
893 component, `default-directory' is used as the basis for completion."
894 ;; FIXME: obey pcomplete-file-ignore and pcomplete-dir-ignore.
895 ;; FIXME: obey pcomplete-compare-entry-function (tho only if there
896 ;; are less than pcomplete-cycle-cutoff-length completions).
897 ;; FIXME: expand envvars? shouldn't this be done globally instead?
898 (let* ((reg-pred (when regexp
899 (lexical-let ((re regexp))
900 (lambda (f)
901 ;; (let ((name (file-name-nondirectory f)))
902 ;; (if (zerop (length name))
903 ;; (setq name (file-name-as-directory
904 ;; (file-name-nondirectory
905 ;; (directory-file-name f)))))
906 ;; (string-match re name))
907 (string-match re f)))))
908 (pred (cond
909 ((null predicate) reg-pred)
910 ((null reg-pred) predicate)
911 (t (lexical-let ((predicate predicate)
912 (reg-pred reg-pred))
913 (lambda (f)
914 (and (funcall predicate f)
915 (funcall reg-pred f)))))))
916 (fun
917 (lexical-let ((pred pred)
918 (dir default-directory))
919 (lambda (s p a)
920 ;; Remember the default-directory that was active when we built
921 ;; the completion table.
922 (let ((default-directory dir)
923 ;; The old code used only file-name-all-completions
924 ;; which ignores completion-ignored-extensions.
925 (completion-ignored-extensions nil))
926 (completion-table-with-predicate
927 'completion-file-name-table pred 'strict s p a)))))
928 ;; Indirect through a symbol rather than returning a lambda
929 ;; expression, so as to help catch bugs where the caller
930 ;; might treat the lambda expression as a list of completions.
931 (sym (make-symbol "pcomplete-read-file-name-internal")))
932 (fset sym fun)
933 sym))
935 (defsubst pcomplete-all-entries (&optional regexp predicate)
936 "Like `pcomplete-entries', but doesn't ignore any entries."
937 (let (pcomplete-file-ignore
938 pcomplete-dir-ignore)
939 (pcomplete-entries regexp predicate)))
941 (defsubst pcomplete-dirs (&optional regexp)
942 "Complete amongst a list of directories."
943 (pcomplete-entries regexp 'file-directory-p))
945 ;; generation of completion lists
947 (defun pcomplete-find-completion-function (command)
948 "Find the completion function to call for the given COMMAND."
949 (let ((sym (intern-soft
950 (concat "pcomplete/" (symbol-name major-mode) "/" command))))
951 (unless sym
952 (setq sym (intern-soft (concat "pcomplete/" command))))
953 (and sym (fboundp sym) sym)))
955 (defun pcomplete-completions ()
956 "Return a list of completions for the current argument position."
957 (catch 'pcomplete-completions
958 (when (pcomplete-parse-arguments pcomplete-expand-before-complete)
959 (if (= pcomplete-index pcomplete-last)
960 (funcall pcomplete-command-completion-function)
961 (let ((sym (or (pcomplete-find-completion-function
962 (funcall pcomplete-command-name-function))
963 pcomplete-default-completion-function)))
964 (ignore
965 (pcomplete-next-arg)
966 (funcall sym)))))))
968 (defun pcomplete-opt (options &optional prefix no-ganging args-follow)
969 "Complete a set of OPTIONS, each beginning with PREFIX (?- by default).
970 PREFIX may be t, in which case no PREFIX character is necessary.
971 If NO-GANGING is non-nil, each option is separate (-xy is not allowed).
972 If ARGS-FOLLOW is non-nil, then options which take arguments may have
973 the argument appear after a ganged set of options. This is how tar
974 behaves, for example."
975 (if (and (= pcomplete-index pcomplete-last)
976 (string= (pcomplete-arg) "-"))
977 (let ((len (length options))
978 (index 0)
979 char choices)
980 (while (< index len)
981 (setq char (aref options index))
982 (if (eq char ?\()
983 (let ((result (read-from-string options index)))
984 (setq index (cdr result)))
985 (unless (memq char '(?/ ?* ?? ?.))
986 (push (char-to-string char) choices))
987 (setq index (1+ index))))
988 (throw 'pcomplete-completions
989 (mapcar
990 (function
991 (lambda (opt)
992 (concat "-" opt)))
993 (pcomplete-uniqify-list choices))))
994 (let ((arg (pcomplete-arg)))
995 (when (and (> (length arg) 1)
996 (stringp arg)
997 (eq (aref arg 0) (or prefix ?-)))
998 (pcomplete-next-arg)
999 (let ((char (aref arg 1))
1000 (len (length options))
1001 (index 0)
1002 opt-char arg-char result)
1003 (while (< (1+ index) len)
1004 (setq opt-char (aref options index)
1005 arg-char (aref options (1+ index)))
1006 (if (eq arg-char ?\()
1007 (setq result
1008 (read-from-string options (1+ index))
1009 index (cdr result)
1010 result (car result))
1011 (setq result nil))
1012 (when (and (eq char opt-char)
1013 (memq arg-char '(?\( ?/ ?* ?? ?.)))
1014 (if (< pcomplete-index pcomplete-last)
1015 (pcomplete-next-arg)
1016 (throw 'pcomplete-completions
1017 (cond ((eq arg-char ?/) (pcomplete-dirs))
1018 ((eq arg-char ?*) (pcomplete-executables))
1019 ((eq arg-char ??) nil)
1020 ((eq arg-char ?.) (pcomplete-entries))
1021 ((eq arg-char ?\() (eval result))))))
1022 (setq index (1+ index))))))))
1024 (defun pcomplete--here (&optional form stub paring form-only)
1025 "Complete against the current argument, if at the end.
1026 See the documentation for `pcomplete-here'."
1027 (if (< pcomplete-index pcomplete-last)
1028 (progn
1029 (if (eq paring 0)
1030 (setq pcomplete-seen nil)
1031 (unless (eq paring t)
1032 (let ((arg (pcomplete-arg)))
1033 (when (stringp arg)
1034 (push (if paring
1035 (funcall paring arg)
1036 (file-truename arg))
1037 pcomplete-seen)))))
1038 (pcomplete-next-arg)
1040 (when pcomplete-show-help
1041 (pcomplete--help)
1042 (throw 'pcompleted t))
1043 (if stub
1044 (setq pcomplete-stub stub))
1045 (if (or (eq paring t) (eq paring 0))
1046 (setq pcomplete-seen nil)
1047 (setq pcomplete-norm-func (or paring 'file-truename)))
1048 (unless form-only
1049 (run-hooks 'pcomplete-try-first-hook))
1050 (throw 'pcomplete-completions
1051 (if (functionp form)
1052 (funcall form)
1053 ;; Old calling convention, might still be used by files
1054 ;; byte-compiled with the older code.
1055 (eval form)))))
1057 (defmacro pcomplete-here (&optional form stub paring form-only)
1058 "Complete against the current argument, if at the end.
1059 If completion is to be done here, evaluate FORM to generate the completion
1060 table which will be used for completion purposes. If STUB is a
1061 string, use it as the completion stub instead of the default (which is
1062 the entire text of the current argument).
1064 For an example of when you might want to use STUB: if the current
1065 argument text is 'long-path-name/', you don't want the completions
1066 list display to be cluttered by 'long-path-name/' appearing at the
1067 beginning of every alternative. Not only does this make things less
1068 intelligible, but it is also inefficient. Yet, if the completion list
1069 does not begin with this string for every entry, the current argument
1070 won't complete correctly.
1072 The solution is to specify a relative stub. It allows you to
1073 substitute a different argument from the current argument, almost
1074 always for the sake of efficiency.
1076 If PARING is nil, this argument will be pared against previous
1077 arguments using the function `file-truename' to normalize them.
1078 PARING may be a function, in which case that function is used for
1079 normalization. If PARING is t, the argument dealt with by this
1080 call will not participate in argument paring. If it is the
1081 integer 0, all previous arguments that have been seen will be
1082 cleared.
1084 If FORM-ONLY is non-nil, only the result of FORM will be used to
1085 generate the completions list. This means that the hook
1086 `pcomplete-try-first-hook' will not be run."
1087 (declare (debug t))
1088 `(pcomplete--here (lambda () ,form) ,stub ,paring ,form-only))
1091 (defmacro pcomplete-here* (&optional form stub form-only)
1092 "An alternate form which does not participate in argument paring."
1093 (declare (debug t))
1094 `(pcomplete-here (lambda () ,form) ,stub t ,form-only))
1096 ;; display support
1098 (defun pcomplete-restore-windows ()
1099 "If the only window change was due to Completions, restore things."
1100 (if pcomplete-last-window-config
1101 (let* ((cbuf (get-buffer "*Completions*"))
1102 (cwin (and cbuf (get-buffer-window cbuf))))
1103 (when (window-live-p cwin)
1104 (bury-buffer cbuf)
1105 (set-window-configuration pcomplete-last-window-config))))
1106 (setq pcomplete-last-window-config nil
1107 pcomplete-window-restore-timer nil))
1109 ;; Abstractions so that the code below will work for both Emacs 20 and
1110 ;; XEmacs 21
1112 (defalias 'pcomplete-event-matches-key-specifier-p
1113 (if (featurep 'xemacs)
1114 'event-matches-key-specifier-p
1115 'eq))
1117 (defun pcomplete-read-event (&optional prompt)
1118 (if (fboundp 'read-event)
1119 (read-event prompt)
1120 (aref (read-key-sequence prompt) 0)))
1122 (defun pcomplete-show-completions (completions)
1123 "List in help buffer sorted COMPLETIONS.
1124 Typing SPC flushes the help buffer."
1125 (when pcomplete-window-restore-timer
1126 (cancel-timer pcomplete-window-restore-timer)
1127 (setq pcomplete-window-restore-timer nil))
1128 (unless pcomplete-last-window-config
1129 (setq pcomplete-last-window-config (current-window-configuration)))
1130 (with-output-to-temp-buffer "*Completions*"
1131 (display-completion-list completions))
1132 (message "Hit space to flush")
1133 (let (event)
1134 (prog1
1135 (catch 'done
1136 (while (with-current-buffer (get-buffer "*Completions*")
1137 (setq event (pcomplete-read-event)))
1138 (cond
1139 ((pcomplete-event-matches-key-specifier-p event ?\s)
1140 (set-window-configuration pcomplete-last-window-config)
1141 (setq pcomplete-last-window-config nil)
1142 (throw 'done nil))
1143 ((or (pcomplete-event-matches-key-specifier-p event 'tab)
1144 ;; Needed on a terminal
1145 (pcomplete-event-matches-key-specifier-p event 9))
1146 (let ((win (or (get-buffer-window "*Completions*" 0)
1147 (display-buffer "*Completions*"
1148 'not-this-window))))
1149 (with-selected-window win
1150 (if (pos-visible-in-window-p (point-max))
1151 (goto-char (point-min))
1152 (scroll-up))))
1153 (message ""))
1155 (setq unread-command-events (list event))
1156 (throw 'done nil)))))
1157 (if (and pcomplete-last-window-config
1158 pcomplete-restore-window-delay)
1159 (setq pcomplete-window-restore-timer
1160 (run-with-timer pcomplete-restore-window-delay nil
1161 'pcomplete-restore-windows))))))
1163 ;; insert completion at point
1165 (defun pcomplete-insert-entry (stub entry &optional addsuffix raw-p)
1166 "Insert a completion entry at point.
1167 Returns non-nil if a space was appended at the end."
1168 (let ((here (point)))
1169 (if (not pcomplete-ignore-case)
1170 (insert-and-inherit (if raw-p
1171 (substring entry (length stub))
1172 (pcomplete-quote-argument
1173 (substring entry (length stub)))))
1174 ;; the stub is not quoted at this time, so to determine the
1175 ;; length of what should be in the buffer, we must quote it
1176 ;; FIXME: Here we presume that quoting `stub' gives us the exact
1177 ;; text in the buffer before point, which is not guaranteed;
1178 ;; e.g. it is not the case in eshell when completing ${FOO}tm[TAB].
1179 (delete-backward-char (length (pcomplete-quote-argument stub)))
1180 ;; if there is already a backslash present to handle the first
1181 ;; character, don't bother quoting it
1182 (when (eq (char-before) ?\\)
1183 (insert-and-inherit (substring entry 0 1))
1184 (setq entry (substring entry 1)))
1185 (insert-and-inherit (if raw-p
1186 entry
1187 (pcomplete-quote-argument entry))))
1188 (let (space-added)
1189 (when (and (not (memq (char-before) pcomplete-suffix-list))
1190 addsuffix)
1191 (insert-and-inherit pcomplete-termination-string)
1192 (setq space-added t))
1193 (setq pcomplete-last-completion-length (- (point) here)
1194 pcomplete-last-completion-stub stub)
1195 space-added)))
1197 ;; selection of completions
1199 (defun pcomplete-do-complete (stub completions)
1200 "Dynamically complete at point using STUB and COMPLETIONS.
1201 This is basically just a wrapper for `pcomplete-stub' which does some
1202 extra checking, and munging of the COMPLETIONS list."
1203 (unless (stringp stub)
1204 (message "Cannot complete argument")
1205 (throw 'pcompleted nil))
1206 (if (null completions)
1207 (ignore
1208 (if (and stub (> (length stub) 0))
1209 (message "No completions of %s" stub)
1210 (message "No completions")))
1211 ;; pare it down, if applicable
1212 (when (and pcomplete-use-paring pcomplete-seen)
1213 (setq pcomplete-seen
1214 (mapcar 'directory-file-name pcomplete-seen))
1215 (dolist (p pcomplete-seen)
1216 (add-to-list 'pcomplete-seen
1217 (funcall pcomplete-norm-func p)))
1218 (setq completions
1219 (apply-partially 'completion-table-with-predicate
1220 completions
1221 (lambda (f)
1222 (not (member
1223 (funcall pcomplete-norm-func
1224 (directory-file-name f))
1225 pcomplete-seen)))
1226 'strict)))
1227 ;; OK, we've got a list of completions.
1228 (if pcomplete-show-list
1229 ;; FIXME: pay attention to boundaries.
1230 (pcomplete-show-completions (all-completions stub completions))
1231 (pcomplete-stub stub completions))))
1233 (defun pcomplete-stub (stub candidates &optional cycle-p)
1234 "Dynamically complete STUB from CANDIDATES list.
1235 This function inserts completion characters at point by completing
1236 STUB from the strings in CANDIDATES. A completions listing may be
1237 shown in a help buffer if completion is ambiguous.
1239 Returns nil if no completion was inserted.
1240 Returns `sole' if completed with the only completion match.
1241 Returns `shortest' if completed with the shortest of the matches.
1242 Returns `partial' if completed as far as possible with the matches.
1243 Returns `listed' if a completion listing was shown.
1245 See also `pcomplete-filename'."
1246 (let* ((completion-ignore-case pcomplete-ignore-case)
1247 (completions (all-completions stub candidates))
1248 (entry (try-completion stub candidates))
1249 result)
1250 (cond
1251 ((null entry)
1252 (if (and stub (> (length stub) 0))
1253 (message "No completions of %s" stub)
1254 (message "No completions")))
1255 ((eq entry t)
1256 (setq entry stub)
1257 (message "Sole completion")
1258 (setq result 'sole))
1259 ((= 1 (length completions))
1260 (setq result 'sole))
1261 ((and pcomplete-cycle-completions
1262 (or cycle-p
1263 (not pcomplete-cycle-cutoff-length)
1264 (<= (length completions)
1265 pcomplete-cycle-cutoff-length)))
1266 (let ((bound (car (completion-boundaries stub candidates nil ""))))
1267 (unless (zerop bound)
1268 (setq completions (mapcar (lambda (c) (concat (substring stub 0 bound) c))
1269 completions)))
1270 (setq entry (car completions)
1271 pcomplete-current-completions completions)))
1272 ((and pcomplete-recexact
1273 (string-equal stub entry)
1274 (member entry completions))
1275 ;; It's not unique, but user wants shortest match.
1276 (message "Completed shortest")
1277 (setq result 'shortest))
1278 ((or pcomplete-autolist
1279 (string-equal stub entry))
1280 ;; It's not unique, list possible completions.
1281 ;; FIXME: pay attention to boundaries.
1282 (pcomplete-show-completions completions)
1283 (setq result 'listed))
1285 (message "Partially completed")
1286 (setq result 'partial)))
1287 (cons result entry)))
1289 ;; context sensitive help
1291 (defun pcomplete--help ()
1292 "Produce context-sensitive help for the current argument.
1293 If specific documentation can't be given, be generic."
1294 (if (and pcomplete-help
1295 (or (and (stringp pcomplete-help)
1296 (fboundp 'Info-goto-node))
1297 (listp pcomplete-help)))
1298 (if (listp pcomplete-help)
1299 (message "%s" (eval pcomplete-help))
1300 (save-window-excursion (info))
1301 (switch-to-buffer-other-window "*info*")
1302 (funcall (symbol-function 'Info-goto-node) pcomplete-help))
1303 (if pcomplete-man-function
1304 (let ((cmd (funcall pcomplete-command-name-function)))
1305 (if (and cmd (> (length cmd) 0))
1306 (funcall pcomplete-man-function cmd)))
1307 (message "No context-sensitive help available"))))
1309 ;; general utilities
1311 (defun pcomplete-pare-list (l r &optional pred)
1312 "Destructively remove from list L all elements matching any in list R.
1313 Test is done using `equal'.
1314 If PRED is non-nil, it is a function used for further removal.
1315 Returns the resultant list."
1316 (while (and l (or (and r (member (car l) r))
1317 (and pred
1318 (funcall pred (car l)))))
1319 (setq l (cdr l)))
1320 (let ((m l))
1321 (while m
1322 (while (and (cdr m)
1323 (or (and r (member (cadr m) r))
1324 (and pred
1325 (funcall pred (cadr m)))))
1326 (setcdr m (cddr m)))
1327 (setq m (cdr m))))
1330 (defun pcomplete-uniqify-list (l)
1331 "Sort and remove multiples in L."
1332 (setq l (sort l 'string-lessp))
1333 (let ((m l))
1334 (while m
1335 (while (and (cdr m)
1336 (string= (car m)
1337 (cadr m)))
1338 (setcdr m (cddr m)))
1339 (setq m (cdr m))))
1342 (defun pcomplete-process-result (cmd &rest args)
1343 "Call CMD using `call-process' and return the simplest result."
1344 (with-temp-buffer
1345 (apply 'call-process cmd nil t nil args)
1346 (skip-chars-backward "\n")
1347 (buffer-substring (point-min) (point))))
1349 ;; create a set of aliases which allow completion functions to be not
1350 ;; quite so verbose
1352 ;;; jww (1999-10-20): are these a good idea?
1353 ;; (defalias 'pc-here 'pcomplete-here)
1354 ;; (defalias 'pc-test 'pcomplete-test)
1355 ;; (defalias 'pc-opt 'pcomplete-opt)
1356 ;; (defalias 'pc-match 'pcomplete-match)
1357 ;; (defalias 'pc-match-string 'pcomplete-match-string)
1358 ;; (defalias 'pc-match-beginning 'pcomplete-match-beginning)
1359 ;; (defalias 'pc-match-end 'pcomplete-match-end)
1361 (provide 'pcomplete)
1363 ;; arch-tag: ae32ef2d-dbed-4244-8b0f-cf5a2a3b07a4
1364 ;;; pcomplete.el ends here