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