1 ;;; pcomplete.el --- programmable completion -*- lexical-binding: t -*-
3 ;; Copyright (C) 1999-2011 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/>.
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
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
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
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
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.
121 (eval-when-compile (require 'cl
))
124 (defgroup pcomplete nil
125 "Programmable completion."
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
))
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
))
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."
148 (defcustom pcomplete-autolist nil
149 "If non-nil, automatically list possibilities on partial completion.
150 This mirrors the optional behavior of tcsh."
154 (defcustom pcomplete-suffix-list
(list ?
/ ?
:)
155 "A list of characters which constitute a proper suffix."
156 :type
'(repeat character
)
158 (make-obsolete-variable 'pcomplete-suffix-list nil
"24.1")
160 (defcustom pcomplete-recexact nil
161 "If non-nil, use shortest completion if characters cannot be added.
162 This mirrors the optional behavior of tcsh.
164 A non-nil value is useful if `pcomplete-autolist' is non-nil too."
168 (defcustom pcomplete-arg-quote-list nil
169 "List of characters to quote when completing an argument."
170 :type
'(choice (repeat character
)
171 (const :tag
"Don't quote" nil
))
174 (defcustom pcomplete-quote-arg-hook nil
175 "A hook which is run to quote a character within a filename.
176 Each function is passed both the filename to be quoted, and the index
177 to be considered. If the function wishes to provide an alternate
178 quoted form, it need only return the replacement string. If no
179 function provides a replacement, quoting shall proceed as normal,
180 using a backslash to quote any character which is a member of
181 `pcomplete-arg-quote-list'."
185 (defcustom pcomplete-man-function
'man
186 "A function to that will be called to display a manual page.
187 It will be passed the name of the command to document."
191 (defcustom pcomplete-compare-entry-function
'string-lessp
192 "This function is used to order file entries for completion.
193 The behavior of most all shells is to sort alphabetically."
194 :type
'(radio (function-item string-lessp
)
195 (function-item file-newer-than-file-p
)
196 (function :tag
"Other"))
199 (defcustom pcomplete-help nil
200 "A string or function (or nil) used for context-sensitive help.
201 If a string, it should name an Info node that will be jumped to.
202 If non-nil, it must a sexp that will be evaluated, and whose
203 result will be shown in the minibuffer.
204 If nil, the function `pcomplete-man-function' will be called with the
205 current command argument."
206 :type
'(choice string sexp
(const :tag
"Use man page" nil
))
209 (defcustom pcomplete-expand-before-complete nil
210 "If non-nil, expand the current argument before completing it.
211 This means that typing something such as '$HOME/bi' followed by
212 \\[pcomplete-argument] will cause the variable reference to be
213 resolved first, and the resultant value that will be completed against
214 to be inserted in the buffer. Note that exactly what gets expanded
215 and how is entirely up to the behavior of the
216 `pcomplete-parse-arguments-function'."
220 (defcustom pcomplete-parse-arguments-function
221 'pcomplete-parse-buffer-arguments
222 "A function to call to parse the current line's arguments.
223 It should be called with no parameters, and with point at the position
224 of the argument that is to be completed.
226 It must either return nil, or a cons cell of the form:
228 ((ARG...) (BEG-POS...))
230 The two lists must be identical in length. The first gives the final
231 value of each command line argument (which need not match the textual
232 representation of that argument), and BEG-POS gives the beginning
233 position of each argument, as it is seen by the user. The establishes
234 a relationship between the fully resolved value of the argument, and
235 the textual representation of the argument."
239 (defcustom pcomplete-cycle-completions t
240 "If non-nil, hitting the TAB key cycles through the completion list.
241 Typical Emacs behavior is to complete as much as possible, then pause
242 waiting for further input. Then if TAB is hit again, show a list of
243 possible completions. When `pcomplete-cycle-completions' is non-nil,
244 it acts more like zsh or 4nt, showing the first maximal match first,
245 followed by any further matches on each subsequent pressing of the TAB
246 key. \\[pcomplete-list] is the key to press if the user wants to see
247 the list of possible completions."
251 (defcustom pcomplete-cycle-cutoff-length
5
252 "If the number of completions is greater than this, don't cycle.
253 This variable is a compromise between the traditional Emacs style of
254 completion, and the \"cycling\" style. Basically, if there are more
255 than this number of completions possible, don't automatically pick the
256 first one and then expect the user to press TAB to cycle through them.
257 Typically, when there are a large number of completion possibilities,
258 the user wants to see them in a list buffer so that they can know what
259 options are available. But if the list is small, it means the user
260 has already entered enough input to disambiguate most of the
261 possibilities, and therefore they are probably most interested in
262 cycling through the candidates. Set this value to nil if you want
263 cycling to always be enabled."
264 :type
'(choice integer
(const :tag
"Always cycle" nil
))
267 (defcustom pcomplete-restore-window-delay
1
268 "The number of seconds to wait before restoring completion windows.
269 Once the completion window has been displayed, if the user then goes
270 on to type something else, that completion window will be removed from
271 the display (actually, the original window configuration before it was
272 displayed will be restored), after this many seconds of idle time. If
273 set to nil, completion windows will be left on second until the user
274 removes them manually. If set to 0, they will disappear immediately
275 after the user enters a key other than TAB."
276 :type
'(choice integer
(const :tag
"Never restore" nil
))
279 (defcustom pcomplete-try-first-hook nil
280 "A list of functions which are called before completing an argument.
281 This can be used, for example, for completing things which might apply
282 to all arguments, such as variable names after a $."
286 (defsubst pcomplete-executables
(&optional regexp
)
287 "Complete amongst a list of directories and executables."
288 (pcomplete-entries regexp
'file-executable-p
))
290 (defcustom pcomplete-command-completion-function
293 (pcomplete-here (pcomplete-executables))))
294 "Function called for completing the initial command argument."
298 (defcustom pcomplete-command-name-function
'pcomplete-command-name
299 "Function called for determining the current command name."
303 (defcustom pcomplete-default-completion-function
306 (while (pcomplete-here (pcomplete-entries)))))
307 "Function called when no completion rule can be found.
308 This function is used to generate completions for every argument."
312 (defcustom pcomplete-use-paring t
313 "If t, pare alternatives that have already been used.
314 If nil, you will always see the completion set of possible options, no
315 matter which of those options have already been used in previous
320 (defcustom pcomplete-termination-string
" "
321 "A string that is inserted after any completion or expansion.
322 This is usually a space character, useful when completing lists of
323 words separated by spaces. However, if your list uses a different
324 separator character, or if the completion occurs in a word that is
325 already terminated by a character, this variable should be locally
326 modified to be an empty string, or the desired separation string."
330 ;;; Internal Variables:
332 ;; for cycling completion support
333 (defvar pcomplete-current-completions nil
)
334 (defvar pcomplete-last-completion-length
)
335 (defvar pcomplete-last-completion-stub
)
336 (defvar pcomplete-last-completion-raw
)
337 (defvar pcomplete-last-window-config nil
)
338 (defvar pcomplete-window-restore-timer nil
)
340 (make-variable-buffer-local 'pcomplete-current-completions
)
341 (make-variable-buffer-local 'pcomplete-last-completion-length
)
342 (make-variable-buffer-local 'pcomplete-last-completion-stub
)
343 (make-variable-buffer-local 'pcomplete-last-completion-raw
)
344 (make-variable-buffer-local 'pcomplete-last-window-config
)
345 (make-variable-buffer-local 'pcomplete-window-restore-timer
)
347 ;; used for altering pcomplete's behavior. These global variables
348 ;; should always be nil.
349 (defvar pcomplete-show-help nil
)
350 (defvar pcomplete-show-list nil
)
351 (defvar pcomplete-expand-only-p nil
)
353 ;; for the sake of the bye-compiler, when compiling other files that
354 ;; contain completion functions
355 (defvar pcomplete-args nil
)
356 (defvar pcomplete-begins nil
)
357 (defvar pcomplete-last nil
)
358 (defvar pcomplete-index nil
)
359 (defvar pcomplete-stub nil
)
360 (defvar pcomplete-seen nil
)
361 (defvar pcomplete-norm-func nil
)
365 ;;; Alternative front-end using the standard completion facilities.
367 ;; The way pcomplete-parse-arguments, pcomplete-stub, and
368 ;; pcomplete-quote-argument work only works because of some deep
369 ;; hypothesis about the way the completion work. Basically, it makes
370 ;; it pretty much impossible to have completion other than
371 ;; prefix-completion.
373 ;; pcomplete--common-quoted-suffix and pcomplete--table-subvert try to
374 ;; work around this difficulty with heuristics, but it's
377 (defvar pcomplete-unquote-argument-function nil
)
379 (defun pcomplete-unquote-argument (s)
381 (pcomplete-unquote-argument-function
382 (funcall pcomplete-unquote-argument-function s
))
383 ((null pcomplete-arg-quote-list
) s
)
385 (replace-regexp-in-string "\\\\\\(.\\)" "\\1" s t
))))
387 (defun pcomplete--common-quoted-suffix (s1 s2
)
388 ;; FIXME: Copied in comint.el.
389 "Find the common suffix between S1 and S2 where S1 is the expanded S2.
390 S1 is expected to be the unquoted and expanded version of S1.
391 Returns (PS1 . PS2), i.e. the shortest prefixes of S1 and S2, such that
392 S1 = (concat PS1 SS1) and S2 = (concat PS2 SS2) and
393 SS1 = (unquote SS2)."
394 (let* ((cs (comint--common-suffix s1 s2
))
395 (ss1 (substring s1
(- (length s1
) cs
)))
396 (qss1 (pcomplete-quote-argument ss1
))
398 (if (and (not (equal ss1 qss1
))
399 (setq qc
(pcomplete-quote-argument (substring ss1
0 1)))
400 (eq t
(compare-strings s2
(- (length s2
) cs
(length qc
) -
1)
401 (- (length s2
) cs -
1)
403 ;; The difference found is just that one char is quoted in S2
404 ;; but not in S1, keep looking before this difference.
405 (pcomplete--common-quoted-suffix
406 (substring s1
0 (- (length s1
) cs
))
407 (substring s2
0 (- (length s2
) cs
(length qc
) -
1)))
408 (cons (substring s1
0 (- (length s1
) cs
))
409 (substring s2
0 (- (length s2
) cs
))))))
411 (defun pcomplete--table-subvert (table s1 s2 string pred action
)
412 ;; FIXME: Copied in comint.el.
413 "Completion table that replaces the prefix S1 with S2 in STRING.
414 When TABLE, S1 and S2 are provided by `apply-partially', the result
415 is a completion table which completes strings of the form (concat S1 S)
416 in the same way as TABLE completes strings of the form (concat S2 S)."
417 (let* ((str (if (eq t
(compare-strings string
0 (length s1
) s1 nil nil
418 completion-ignore-case
))
419 (concat s2
(pcomplete-unquote-argument
420 (substring string
(length s1
))))))
421 (res (if str
(complete-with-action action table str pred
))))
424 ((and (eq (car-safe action
) 'boundaries
))
425 (let ((beg (or (and (eq (car-safe res
) 'boundaries
) (cadr res
)) 0)))
428 ;; FIXME: Adjust because of quoting/unquoting.
429 (+ beg
(- (length s1
) (length s2
))))
430 (and (eq (car-safe res
) 'boundaries
) (cddr res
)))))
432 (if (eq t
(compare-strings res
0 (length s2
) s2 nil nil
433 completion-ignore-case
))
434 (concat s1
(pcomplete-quote-argument
435 (substring res
(length s2
))))))
437 (let ((bounds (completion-boundaries str table pred
"")))
438 (if (>= (car bounds
) (length s2
))
440 (let ((re (concat "\\`"
441 (regexp-quote (substring s2
(car bounds
))))))
444 (if (string-match re c
)
445 (substring c
(match-end 0))))
447 ;; E.g. action=nil and it's the only completion.
450 ;; I don't think such commands are usable before first setting up buffer-local
451 ;; variables to parse args, so there's no point autoloading it.
453 (defun pcomplete-completions-at-point ()
454 "Provide standard completion using pcomplete's completion tables.
455 Same as `pcomplete' but using the standard completion UI."
456 ;; FIXME: it only completes the text before point, whereas the
457 ;; standard UI may also consider text after point.
458 ;; FIXME: the `pcomplete' UI may be used internally during
459 ;; pcomplete-completions and then throw to `pcompleted', thus
460 ;; imposing the pcomplete UI over the standard UI.
462 (let* ((pcomplete-stub)
463 pcomplete-seen pcomplete-norm-func
464 pcomplete-args pcomplete-last pcomplete-index
465 (pcomplete-autolist pcomplete-autolist
)
466 (pcomplete-suffix-list pcomplete-suffix-list
)
467 ;; Apparently the vars above are global vars modified by
468 ;; side-effects, whereas pcomplete-completions is the core
469 ;; function that finds the chunk of text to complete
470 ;; (returned indirectly in pcomplete-stub) and the set of
471 ;; possible completions.
472 (completions (pcomplete-completions))
473 ;; Usually there's some close connection between pcomplete-stub
474 ;; and the text before point. But depending on what
475 ;; pcomplete-parse-arguments-function does, that connection
476 ;; might not be that close. E.g. in eshell,
477 ;; pcomplete-parse-arguments-function expands envvars.
479 ;; Since we use minibuffer-complete, which doesn't know
480 ;; pcomplete-stub and works from the buffer's text instead,
481 ;; we need to trick minibuffer-complete, into using
482 ;; pcomplete-stub without its knowledge. To that end, we
483 ;; use pcomplete--table-subvert to construct a completion
484 ;; table which expects strings using a prefix from the
485 ;; buffer's text but internally uses the corresponding
486 ;; prefix from pcomplete-stub.
487 (beg (max (- (point) (length pcomplete-stub
))
489 (buftext (buffer-substring beg
(point))))
493 ((not (equal pcomplete-stub buftext
))
494 ;; This isn't always strictly right (e.g. if
495 ;; FOO="toto/$FOO", then completion of /$FOO/bar may
496 ;; result in something incorrect), but given the lack of
497 ;; any other info, it's about as good as it gets, and in
498 ;; practice it should work just fine (fingers crossed).
499 (let ((prefixes (pcomplete--common-quoted-suffix
500 pcomplete-stub buftext
)))
501 (apply-partially #'pcomplete--table-subvert
503 (cdr prefixes
) (car prefixes
))))
505 (lambda (string pred action
)
506 (let ((res (complete-with-action
507 action completions string pred
)))
509 (pcomplete-quote-argument res
)
512 ;; Pare it down, if applicable.
513 (when (and pcomplete-use-paring pcomplete-seen
)
514 ;; Capture the dynbound values for later use.
515 (let ((norm-func pcomplete-norm-func
)
518 (funcall pcomplete-norm-func
519 (directory-file-name f
)))
523 (funcall norm-func
(directory-file-name f
))
525 (when pcomplete-ignore-case
527 (apply-partially #'completion-table-case-fold table
)))
528 (list beg
(point) table
531 (unless (zerop (length pcomplete-termination-string
))
532 (lambda (_s finished
)
533 (when (memq finished
'(sole finished
))
535 (regexp-quote pcomplete-termination-string
))
536 (goto-char (match-end 0))
537 (insert pcomplete-termination-string
)))))))))))
539 ;; I don't think such commands are usable before first setting up buffer-local
540 ;; variables to parse args, so there's no point autoloading it.
542 (defun pcomplete-std-complete ()
543 (let ((data (pcomplete-completions-at-point)))
544 (completion-in-region (nth 0 data
) (nth 1 data
) (nth 2 data
)
545 (plist-get :predicate
(nthcdr 3 data
)))))
547 ;;; Pcomplete's native UI.
550 (defun pcomplete (&optional interactively
)
551 "Support extensible programmable completion.
552 To use this function, just bind the TAB key to it, or add it to your
553 completion functions list (it should occur fairly early in the list)."
555 (if (and interactively
556 pcomplete-cycle-completions
557 pcomplete-current-completions
558 (memq last-command
'(pcomplete
559 pcomplete-expand-and-complete
562 (delete-char (- pcomplete-last-completion-length
))
563 (if (eq this-command
'pcomplete-reverse
)
565 (push (car (last pcomplete-current-completions
))
566 pcomplete-current-completions
)
567 (setcdr (last pcomplete-current-completions
2) nil
))
568 (nconc pcomplete-current-completions
569 (list (car pcomplete-current-completions
)))
570 (setq pcomplete-current-completions
571 (cdr pcomplete-current-completions
)))
572 (pcomplete-insert-entry pcomplete-last-completion-stub
573 (car pcomplete-current-completions
)
574 nil pcomplete-last-completion-raw
))
575 (setq pcomplete-current-completions nil
576 pcomplete-last-completion-raw nil
)
578 (let* ((pcomplete-stub)
579 pcomplete-seen pcomplete-norm-func
580 pcomplete-args pcomplete-last pcomplete-index
581 (pcomplete-autolist pcomplete-autolist
)
582 (pcomplete-suffix-list pcomplete-suffix-list
)
583 (completions (pcomplete-completions))
584 (result (pcomplete-do-complete pcomplete-stub completions
)))
586 (not (eq (car result
) 'listed
))
588 (pcomplete-insert-entry pcomplete-stub
(cdr result
)
591 pcomplete-last-completion-raw
))))))
594 (defun pcomplete-reverse ()
595 "If cycling completion is in use, cycle backwards."
597 (call-interactively 'pcomplete
))
600 (defun pcomplete-expand-and-complete ()
601 "Expand the textual value of the current argument.
602 This will modify the current buffer."
604 (let ((pcomplete-expand-before-complete t
))
608 (defun pcomplete-continue ()
609 "Complete without reference to any cycling completions."
611 (setq pcomplete-current-completions nil
612 pcomplete-last-completion-raw nil
)
613 (call-interactively 'pcomplete
))
616 (defun pcomplete-expand ()
617 "Expand the textual value of the current argument.
618 This will modify the current buffer."
620 (let ((pcomplete-expand-before-complete t
)
621 (pcomplete-expand-only-p t
))
623 (when (and pcomplete-current-completions
624 (> (length pcomplete-current-completions
) 0)) ;??
625 (delete-char (- pcomplete-last-completion-length
))
626 (while pcomplete-current-completions
627 (unless (pcomplete-insert-entry
628 "" (car pcomplete-current-completions
) t
629 pcomplete-last-completion-raw
)
630 (insert-and-inherit pcomplete-termination-string
))
631 (setq pcomplete-current-completions
632 (cdr pcomplete-current-completions
))))))
635 (defun pcomplete-help ()
636 "Display any help information relative to the current argument."
638 (let ((pcomplete-show-help t
))
642 (defun pcomplete-list ()
643 "Show the list of possible completions for the current argument."
645 (when (and pcomplete-cycle-completions
646 pcomplete-current-completions
647 (eq last-command
'pcomplete-argument
))
648 (delete-char (- pcomplete-last-completion-length
))
649 (setq pcomplete-current-completions nil
650 pcomplete-last-completion-raw nil
))
651 (let ((pcomplete-show-list t
))
654 ;;; Internal Functions:
657 (defun pcomplete-arg (&optional index offset
)
658 "Return the textual content of the INDEXth argument.
659 INDEX is based from the current processing position. If INDEX is
660 positive, values returned are closer to the command argument; if
661 negative, they are closer to the last argument. If the INDEX is
662 outside of the argument list, nil is returned. The default value for
663 INDEX is 0, meaning the current argument being examined.
665 The special indices `first' and `last' may be used to access those
668 The OFFSET argument is added to/taken away from the index that will be
669 used. This is really only useful with `first' and `last', for
670 accessing absolute argument positions."
672 (if (eq index
'first
)
676 (- pcomplete-index
(or index
0)))))
678 (setq index
(+ index offset
)))
679 (nth index pcomplete-args
))
681 (defun pcomplete-begin (&optional index offset
)
682 "Return the beginning position of the INDEXth argument.
683 See the documentation for `pcomplete-arg'."
685 (if (eq index
'first
)
689 (- pcomplete-index
(or index
0)))))
691 (setq index
(+ index offset
)))
692 (nth index pcomplete-begins
))
694 (defsubst pcomplete-actual-arg
(&optional index offset
)
695 "Return the actual text representation of the last argument.
696 This is different from `pcomplete-arg', which returns the textual value
697 that the last argument evaluated to. This function returns what the
698 user actually typed in."
699 (buffer-substring (pcomplete-begin index offset
) (point)))
701 (defsubst pcomplete-next-arg
()
702 "Move the various pointers to the next argument."
703 (setq pcomplete-index
(1+ pcomplete-index
)
704 pcomplete-stub
(pcomplete-arg))
705 (if (> pcomplete-index pcomplete-last
)
707 (message "No completions")
708 (throw 'pcompleted nil
))))
710 (defun pcomplete-command-name ()
711 "Return the command name of the first argument."
712 (file-name-nondirectory (pcomplete-arg 'first
)))
714 (defun pcomplete-match (regexp &optional index offset start
)
715 "Like `string-match', but on the current completion argument."
716 (let ((arg (pcomplete-arg (or index
1) offset
)))
718 (string-match regexp arg start
)
719 (throw 'pcompleted nil
))))
721 (defun pcomplete-match-string (which &optional index offset
)
722 "Like `match-string', but on the current completion argument."
723 (let ((arg (pcomplete-arg (or index
1) offset
)))
725 (match-string which arg
)
726 (throw 'pcompleted nil
))))
728 (defalias 'pcomplete-match-beginning
'match-beginning
)
729 (defalias 'pcomplete-match-end
'match-end
)
731 (defsubst pcomplete--test
(pred arg
)
732 "Perform a programmable completion predicate match."
734 (cond ((eq pred t
) t
)
738 (string-match (concat "^" pred
"$") arg
)))
741 (defun pcomplete-test (predicates &optional index offset
)
742 "Predicates to test the current programmable argument with."
743 (let ((arg (pcomplete-arg (or index
1) offset
)))
744 (unless (null predicates
)
745 (if (not (listp predicates
))
746 (pcomplete--test predicates arg
)
747 (let ((pred predicates
)
749 (while (and pred
(not found
))
750 (setq found
(pcomplete--test (car pred
) arg
)
754 (defun pcomplete-parse-buffer-arguments ()
755 "Parse whitespace separated arguments in the current region."
756 (let ((begin (point-min))
761 (while (< (point) end
)
762 (skip-chars-forward " \t\n")
763 (push (point) begins
)
764 (skip-chars-forward "^ \t\n")
765 (push (buffer-substring-no-properties
766 (car begins
) (point))
768 (cons (nreverse args
) (nreverse begins
)))))
771 (defun pcomplete-comint-setup (completef-sym)
772 "Setup a comint buffer to use pcomplete.
773 COMPLETEF-SYM should be the symbol where the
774 dynamic-complete-functions are kept. For comint mode itself,
775 this is `comint-dynamic-complete-functions'."
776 (set (make-local-variable 'pcomplete-parse-arguments-function
)
777 'pcomplete-parse-comint-arguments
)
778 (add-hook 'completion-at-point-functions
779 'pcomplete-completions-at-point nil
'local
)
780 (set (make-local-variable completef-sym
)
781 (copy-sequence (symbol-value completef-sym
)))
782 (let* ((funs (symbol-value completef-sym
))
783 (elem (or (memq 'comint-filename-completion funs
)
784 (memq 'shell-filename-completion funs
)
785 (memq 'shell-dynamic-complete-filename funs
)
786 (memq 'comint-dynamic-complete-filename funs
))))
788 (setcar elem
'pcomplete
)
789 (add-to-list completef-sym
'pcomplete
))))
792 (defun pcomplete-shell-setup ()
793 "Setup `shell-mode' to use pcomplete."
794 ;; FIXME: insufficient
795 (pcomplete-comint-setup 'comint-dynamic-complete-functions
))
797 (declare-function comint-bol
"comint" (&optional arg
))
799 (defun pcomplete-parse-comint-arguments ()
800 "Parse whitespace separated arguments in the current region."
801 (let ((begin (save-excursion (comint-bol nil
) (point)))
806 (while (< (point) end
)
807 (skip-chars-forward " \t\n")
808 (push (point) begins
)
811 (skip-chars-forward "^ \t\n\\")
812 (when (eq (char-after) ?
\\)
817 (push (buffer-substring-no-properties (car begins
) (point))
819 (cons (nreverse args
) (nreverse begins
)))))
820 (make-obsolete 'pcomplete-parse-comint-arguments
821 'comint-parse-pcomplete-arguments
"24.1")
823 (defun pcomplete-parse-arguments (&optional expand-p
)
824 "Parse the command line arguments. Most completions need this info."
825 (let ((results (funcall pcomplete-parse-arguments-function
)))
827 (setq pcomplete-args
(or (car results
) (list ""))
828 pcomplete-begins
(or (cdr results
) (list (point)))
829 pcomplete-last
(1- (length pcomplete-args
))
831 pcomplete-stub
(pcomplete-arg 'last
))
832 (let ((begin (pcomplete-begin 'last
)))
833 (if (and pcomplete-cycle-completions
834 (listp pcomplete-stub
) ;??
835 (not pcomplete-expand-only-p
))
836 (let* ((completions pcomplete-stub
) ;??
837 (common-stub (car completions
))
839 (len (length common-stub
)))
840 (while (and c
(> len
0))
841 (while (and (> len
0)
843 (substring common-stub
0 len
)
845 (min (length (car c
))
849 (setq pcomplete-stub
(substring common-stub
0 len
)
850 pcomplete-autolist t
)
851 (when (and begin
(not pcomplete-show-list
))
852 (delete-region begin
(point))
853 (pcomplete-insert-entry "" pcomplete-stub
))
854 (throw 'pcomplete-completions completions
))
856 (if (stringp pcomplete-stub
)
858 (delete-region begin
(point))
859 (insert-and-inherit pcomplete-stub
))
860 (if (and (listp pcomplete-stub
)
861 pcomplete-expand-only-p
)
862 ;; this is for the benefit of `pcomplete-expand'
863 (setq pcomplete-last-completion-length
(- (point) begin
)
864 pcomplete-current-completions pcomplete-stub
)
865 (error "Cannot expand argument"))))
866 (if pcomplete-expand-only-p
867 (throw 'pcompleted t
)
870 (defun pcomplete-quote-argument (filename)
871 "Return FILENAME with magic characters quoted.
872 Magic characters are those in `pcomplete-arg-quote-list'."
873 (if (null pcomplete-arg-quote-list
)
876 (mapconcat (lambda (c)
878 (or (run-hook-with-args-until-success
879 'pcomplete-quote-arg-hook filename index
)
880 (when (memq c pcomplete-arg-quote-list
)
883 (setq index
(1+ index
))))
887 ;; file-system completion lists
889 (defsubst pcomplete-dirs-or-entries
(&optional regexp predicate
)
890 "Return either directories, or qualified entries."
894 (or (file-directory-p f
)
895 (and (or (null regexp
) (string-match regexp f
))
896 (or (null predicate
) (funcall predicate f
)))))))
898 (defun pcomplete--entries (&optional regexp predicate
)
899 "Like `pcomplete-entries' but without env-var handling."
901 (when (or pcomplete-file-ignore pcomplete-dir-ignore
)
902 ;; Capture the dynbound value for later use.
903 (let ((file-ignore pcomplete-file-ignore
)
904 (dir-ignore pcomplete-dir-ignore
))
907 (if (eq (aref file
(1- (length file
))) ?
/)
908 (and dir-ignore
(string-match dir-ignore file
))
909 (and file-ignore
(string-match file-ignore file
))))))))
910 (reg-pred (if regexp
(lambda (file) (string-match regexp file
))))
912 ((null (or ign-pred reg-pred
)) predicate
)
913 ((null (or ign-pred predicate
)) reg-pred
)
914 ((null (or reg-pred predicate
)) ign-pred
)
916 (and (or (null reg-pred
) (funcall reg-pred f
))
917 (or (null ign-pred
) (funcall ign-pred f
))
918 (or (null predicate
) (funcall predicate f
))))))))
920 (if (and (eq a
'metadata
) pcomplete-compare-entry-function
)
921 `(metadata (cycle-sort-function
923 (sort comps pcomplete-compare-entry-function
)))
924 ,@(cdr (completion-file-name-table s p a
)))
925 (let ((completion-ignored-extensions nil
))
926 (completion-table-with-predicate
927 #'comint-completion-file-name-table pred
'strict s p a
))))))
929 (defconst pcomplete--env-regexp
930 "\\(?:\\`\\|[^\\]\\)\\(?:\\\\\\\\\\)*\\(\\$\\(?:{\\([^}]+\\)}\\|\\(?2:[[:alnum:]_]+\\)\\)\\)")
932 (defun pcomplete-entries (&optional regexp predicate
)
933 "Complete against a list of directory candidates.
934 If REGEXP is non-nil, it is a regular expression used to refine the
935 match (files not matching the REGEXP will be excluded).
936 If PREDICATE is non-nil, it will also be used to refine the match
937 \(files for which the PREDICATE returns nil will be excluded).
938 If no directory information can be extracted from the completed
939 component, `default-directory' is used as the basis for completion."
940 ;; FIXME: The old code did env-var expansion here, so we reproduce this
941 ;; behavior for now, but really env-var handling should be performed globally
942 ;; rather than here since it also applies to non-file arguments.
943 (let ((table (pcomplete--entries regexp predicate
)))
944 (lambda (string pred action
)
946 (orig-length (length string
)))
947 ;; Perform env-var expansion.
948 (while (string-match pcomplete--env-regexp string
)
949 (push (substring string
0 (match-beginning 1)) strings
)
950 (push (getenv (match-string 2 string
)) strings
)
951 (setq string
(substring string
(match-end 1))))
952 (if (not (and strings
954 (eq (car-safe action
) 'boundaries
))))
956 (mapconcat 'identity
(nreverse (cons string strings
)) "")))
957 ;; FIXME: We could also try to return unexpanded envvars.
958 (complete-with-action action table newstring pred
))
959 (let* ((envpos (apply #'+ (mapcar #' length strings
)))
961 (mapconcat 'identity
(nreverse (cons string strings
)) ""))
962 (bounds (completion-boundaries newstring table pred
963 (or (cdr-safe action
) ""))))
964 (if (>= (car bounds
) envpos
)
965 ;; The env-var is "out of bounds".
967 (complete-with-action action table newstring pred
)
969 (+ (car bounds
) (- orig-length
(length newstring
)))
971 ;; The env-var is in the file bounds.
973 (let ((comps (complete-with-action
974 action table newstring pred
))
975 (len (- envpos
(car bounds
))))
976 ;; Strip the part of each completion that's actually
977 ;; coming from the env-var.
978 (mapcar (lambda (s) (substring s len
)) comps
))
980 (+ envpos
(- orig-length
(length newstring
)))
981 (cdr bounds
))))))))))
983 (defsubst pcomplete-all-entries
(&optional regexp predicate
)
984 "Like `pcomplete-entries', but doesn't ignore any entries."
985 (let (pcomplete-file-ignore
986 pcomplete-dir-ignore
)
987 (pcomplete-entries regexp predicate
)))
989 (defsubst pcomplete-dirs
(&optional regexp
)
990 "Complete amongst a list of directories."
991 (pcomplete-entries regexp
'file-directory-p
))
993 ;; generation of completion lists
995 (defun pcomplete-find-completion-function (command)
996 "Find the completion function to call for the given COMMAND."
997 (let ((sym (intern-soft
998 (concat "pcomplete/" (symbol-name major-mode
) "/" command
))))
1000 (setq sym
(intern-soft (concat "pcomplete/" command
))))
1001 (and sym
(fboundp sym
) sym
)))
1003 (defun pcomplete-completions ()
1004 "Return a list of completions for the current argument position."
1005 (catch 'pcomplete-completions
1006 (when (pcomplete-parse-arguments pcomplete-expand-before-complete
)
1007 (if (= pcomplete-index pcomplete-last
)
1008 (funcall pcomplete-command-completion-function
)
1009 (let ((sym (or (pcomplete-find-completion-function
1010 (funcall pcomplete-command-name-function
))
1011 pcomplete-default-completion-function
)))
1013 (pcomplete-next-arg)
1016 (defun pcomplete-opt (options &optional prefix _no-ganging _args-follow
)
1017 "Complete a set of OPTIONS, each beginning with PREFIX (?- by default).
1018 PREFIX may be t, in which case no PREFIX character is necessary.
1019 If NO-GANGING is non-nil, each option is separate (-xy is not allowed).
1020 If ARGS-FOLLOW is non-nil, then options which take arguments may have
1021 the argument appear after a ganged set of options. This is how tar
1022 behaves, for example.
1023 Arguments NO-GANGING and ARGS-FOLLOW are currently ignored."
1024 (if (and (= pcomplete-index pcomplete-last
)
1025 (string= (pcomplete-arg) "-"))
1026 (let ((len (length options
))
1029 (while (< index len
)
1030 (setq char
(aref options index
))
1032 (let ((result (read-from-string options index
)))
1033 (setq index
(cdr result
)))
1034 (unless (memq char
'(?
/ ?
* ?? ?.
))
1035 (push (char-to-string char
) choices
))
1036 (setq index
(1+ index
))))
1037 (throw 'pcomplete-completions
1042 (pcomplete-uniqify-list choices
))))
1043 (let ((arg (pcomplete-arg)))
1044 (when (and (> (length arg
) 1)
1046 (eq (aref arg
0) (or prefix ?-
)))
1047 (pcomplete-next-arg)
1048 (let ((char (aref arg
1))
1049 (len (length options
))
1051 opt-char arg-char result
)
1052 (while (< (1+ index
) len
)
1053 (setq opt-char
(aref options index
)
1054 arg-char
(aref options
(1+ index
)))
1055 (if (eq arg-char ?\
()
1057 (read-from-string options
(1+ index
))
1059 result
(car result
))
1061 (when (and (eq char opt-char
)
1062 (memq arg-char
'(?\
( ?
/ ?
* ?? ?.
)))
1063 (if (< pcomplete-index pcomplete-last
)
1064 (pcomplete-next-arg)
1065 (throw 'pcomplete-completions
1066 (cond ((eq arg-char ?
/) (pcomplete-dirs))
1067 ((eq arg-char ?
*) (pcomplete-executables))
1068 ((eq arg-char ??
) nil
)
1069 ((eq arg-char ?.
) (pcomplete-entries))
1070 ((eq arg-char ?\
() (eval result
))))))
1071 (setq index
(1+ index
))))))))
1073 (defun pcomplete--here (&optional form stub paring form-only
)
1074 "Complete against the current argument, if at the end.
1075 See the documentation for `pcomplete-here'."
1076 (if (< pcomplete-index pcomplete-last
)
1079 (setq pcomplete-seen nil
)
1080 (unless (eq paring t
)
1081 (let ((arg (pcomplete-arg)))
1084 (funcall paring arg
)
1085 (file-truename arg
))
1087 (pcomplete-next-arg)
1089 (when pcomplete-show-help
1091 (throw 'pcompleted t
))
1093 (setq pcomplete-stub stub
))
1094 (if (or (eq paring t
) (eq paring
0))
1095 (setq pcomplete-seen nil
)
1096 (setq pcomplete-norm-func
(or paring
'file-truename
)))
1098 (run-hooks 'pcomplete-try-first-hook
))
1099 (throw 'pcomplete-completions
1100 (if (functionp form
)
1102 ;; Old calling convention, might still be used by files
1103 ;; byte-compiled with the older code.
1106 (defmacro pcomplete-here
(&optional form stub paring form-only
)
1107 "Complete against the current argument, if at the end.
1108 If completion is to be done here, evaluate FORM to generate the completion
1109 table which will be used for completion purposes. If STUB is a
1110 string, use it as the completion stub instead of the default (which is
1111 the entire text of the current argument).
1113 For an example of when you might want to use STUB: if the current
1114 argument text is 'long-path-name/', you don't want the completions
1115 list display to be cluttered by 'long-path-name/' appearing at the
1116 beginning of every alternative. Not only does this make things less
1117 intelligible, but it is also inefficient. Yet, if the completion list
1118 does not begin with this string for every entry, the current argument
1119 won't complete correctly.
1121 The solution is to specify a relative stub. It allows you to
1122 substitute a different argument from the current argument, almost
1123 always for the sake of efficiency.
1125 If PARING is nil, this argument will be pared against previous
1126 arguments using the function `file-truename' to normalize them.
1127 PARING may be a function, in which case that function is used for
1128 normalization. If PARING is t, the argument dealt with by this
1129 call will not participate in argument paring. If it is the
1130 integer 0, all previous arguments that have been seen will be
1133 If FORM-ONLY is non-nil, only the result of FORM will be used to
1134 generate the completions list. This means that the hook
1135 `pcomplete-try-first-hook' will not be run."
1137 `(pcomplete--here (lambda () ,form
) ,stub
,paring
,form-only
))
1140 (defmacro pcomplete-here
* (&optional form stub form-only
)
1141 "An alternate form which does not participate in argument paring."
1143 `(pcomplete-here ,form
,stub t
,form-only
))
1147 (defun pcomplete-restore-windows ()
1148 "If the only window change was due to Completions, restore things."
1149 (if pcomplete-last-window-config
1150 (let* ((cbuf (get-buffer "*Completions*"))
1151 (cwin (and cbuf
(get-buffer-window cbuf
))))
1152 (when (window-live-p cwin
)
1154 (set-window-configuration pcomplete-last-window-config
))))
1155 (setq pcomplete-last-window-config nil
1156 pcomplete-window-restore-timer nil
))
1158 ;; Abstractions so that the code below will work for both Emacs 20 and
1161 (defalias 'pcomplete-event-matches-key-specifier-p
1162 (if (featurep 'xemacs
)
1163 'event-matches-key-specifier-p
1166 (defun pcomplete-read-event (&optional prompt
)
1167 (if (fboundp 'read-event
)
1169 (aref (read-key-sequence prompt
) 0)))
1171 (defun pcomplete-show-completions (completions)
1172 "List in help buffer sorted COMPLETIONS.
1173 Typing SPC flushes the help buffer."
1174 (when pcomplete-window-restore-timer
1175 (cancel-timer pcomplete-window-restore-timer
)
1176 (setq pcomplete-window-restore-timer nil
))
1177 (unless pcomplete-last-window-config
1178 (setq pcomplete-last-window-config
(current-window-configuration)))
1179 (with-output-to-temp-buffer "*Completions*"
1180 (display-completion-list completions
))
1181 (message "Hit space to flush")
1185 (while (with-current-buffer (get-buffer "*Completions*")
1186 (setq event
(pcomplete-read-event)))
1188 ((pcomplete-event-matches-key-specifier-p event ?\s
)
1189 (set-window-configuration pcomplete-last-window-config
)
1190 (setq pcomplete-last-window-config nil
)
1192 ((or (pcomplete-event-matches-key-specifier-p event
'tab
)
1193 ;; Needed on a terminal
1194 (pcomplete-event-matches-key-specifier-p event
9))
1195 (let ((win (or (get-buffer-window "*Completions*" 0)
1196 (display-buffer "*Completions*"
1197 'not-this-window
))))
1198 (with-selected-window win
1199 (if (pos-visible-in-window-p (point-max))
1200 (goto-char (point-min))
1204 (setq unread-command-events
(list event
))
1205 (throw 'done nil
)))))
1206 (if (and pcomplete-last-window-config
1207 pcomplete-restore-window-delay
)
1208 (setq pcomplete-window-restore-timer
1209 (run-with-timer pcomplete-restore-window-delay nil
1210 'pcomplete-restore-windows
))))))
1212 ;; insert completion at point
1214 (defun pcomplete-insert-entry (stub entry
&optional addsuffix raw-p
)
1215 "Insert a completion entry at point.
1216 Returns non-nil if a space was appended at the end."
1217 (let ((here (point)))
1218 (if (not pcomplete-ignore-case
)
1219 (insert-and-inherit (if raw-p
1220 (substring entry
(length stub
))
1221 (pcomplete-quote-argument
1222 (substring entry
(length stub
)))))
1223 ;; the stub is not quoted at this time, so to determine the
1224 ;; length of what should be in the buffer, we must quote it
1225 ;; FIXME: Here we presume that quoting `stub' gives us the exact
1226 ;; text in the buffer before point, which is not guaranteed;
1227 ;; e.g. it is not the case in eshell when completing ${FOO}tm[TAB].
1228 (delete-char (- (length (pcomplete-quote-argument stub
))))
1229 ;; if there is already a backslash present to handle the first
1230 ;; character, don't bother quoting it
1231 (when (eq (char-before) ?
\\)
1232 (insert-and-inherit (substring entry
0 1))
1233 (setq entry
(substring entry
1)))
1234 (insert-and-inherit (if raw-p
1236 (pcomplete-quote-argument entry
))))
1238 (when (and (not (memq (char-before) pcomplete-suffix-list
))
1240 (insert-and-inherit pcomplete-termination-string
)
1241 (setq space-added t
))
1242 (setq pcomplete-last-completion-length
(- (point) here
)
1243 pcomplete-last-completion-stub stub
)
1246 ;; selection of completions
1248 (defun pcomplete-do-complete (stub completions
)
1249 "Dynamically complete at point using STUB and COMPLETIONS.
1250 This is basically just a wrapper for `pcomplete-stub' which does some
1251 extra checking, and munging of the COMPLETIONS list."
1252 (unless (stringp stub
)
1253 (message "Cannot complete argument")
1254 (throw 'pcompleted nil
))
1255 (if (null completions
)
1257 (if (and stub
(> (length stub
) 0))
1258 (message "No completions of %s" stub
)
1259 (message "No completions")))
1260 ;; pare it down, if applicable
1261 (when (and pcomplete-use-paring pcomplete-seen
)
1262 (setq pcomplete-seen
1263 (mapcar 'directory-file-name pcomplete-seen
))
1264 (dolist (p pcomplete-seen
)
1265 (add-to-list 'pcomplete-seen
1266 (funcall pcomplete-norm-func p
)))
1268 (apply-partially 'completion-table-with-predicate
1270 (when pcomplete-seen
1273 (funcall pcomplete-norm-func
1274 (directory-file-name f
))
1277 ;; OK, we've got a list of completions.
1278 (if pcomplete-show-list
1279 ;; FIXME: pay attention to boundaries.
1280 (pcomplete-show-completions (all-completions stub completions
))
1281 (pcomplete-stub stub completions
))))
1283 (defun pcomplete-stub (stub candidates
&optional cycle-p
)
1284 "Dynamically complete STUB from CANDIDATES list.
1285 This function inserts completion characters at point by completing
1286 STUB from the strings in CANDIDATES. A completions listing may be
1287 shown in a help buffer if completion is ambiguous.
1289 Returns nil if no completion was inserted.
1290 Returns `sole' if completed with the only completion match.
1291 Returns `shortest' if completed with the shortest of the matches.
1292 Returns `partial' if completed as far as possible with the matches.
1293 Returns `listed' if a completion listing was shown.
1295 See also `pcomplete-filename'."
1296 (let* ((completion-ignore-case pcomplete-ignore-case
)
1297 (completions (all-completions stub candidates
))
1298 (entry (try-completion stub candidates
))
1302 (if (and stub
(> (length stub
) 0))
1303 (message "No completions of %s" stub
)
1304 (message "No completions")))
1307 (message "Sole completion")
1308 (setq result
'sole
))
1309 ((= 1 (length completions
))
1310 (setq result
'sole
))
1311 ((and pcomplete-cycle-completions
1313 (not pcomplete-cycle-cutoff-length
)
1314 (<= (length completions
)
1315 pcomplete-cycle-cutoff-length
)))
1316 (let ((bound (car (completion-boundaries stub candidates nil
""))))
1317 (unless (zerop bound
)
1318 (setq completions
(mapcar (lambda (c) (concat (substring stub
0 bound
) c
))
1320 (setq entry
(car completions
)
1321 pcomplete-current-completions completions
)))
1322 ((and pcomplete-recexact
1323 (string-equal stub entry
)
1324 (member entry completions
))
1325 ;; It's not unique, but user wants shortest match.
1326 (message "Completed shortest")
1327 (setq result
'shortest
))
1328 ((or pcomplete-autolist
1329 (string-equal stub entry
))
1330 ;; It's not unique, list possible completions.
1331 ;; FIXME: pay attention to boundaries.
1332 (pcomplete-show-completions completions
)
1333 (setq result
'listed
))
1335 (message "Partially completed")
1336 (setq result
'partial
)))
1337 (cons result entry
)))
1339 ;; context sensitive help
1341 (defun pcomplete--help ()
1342 "Produce context-sensitive help for the current argument.
1343 If specific documentation can't be given, be generic."
1344 (if (and pcomplete-help
1345 (or (and (stringp pcomplete-help
)
1346 (fboundp 'Info-goto-node
))
1347 (listp pcomplete-help
)))
1348 (if (listp pcomplete-help
)
1349 (message "%s" (eval pcomplete-help
))
1350 (save-window-excursion (info))
1351 (switch-to-buffer-other-window "*info*")
1352 (funcall (symbol-function 'Info-goto-node
) pcomplete-help
))
1353 (if pcomplete-man-function
1354 (let ((cmd (funcall pcomplete-command-name-function
)))
1355 (if (and cmd
(> (length cmd
) 0))
1356 (funcall pcomplete-man-function cmd
)))
1357 (message "No context-sensitive help available"))))
1359 ;; general utilities
1361 (defun pcomplete-uniqify-list (l)
1362 "Sort and remove multiples in L."
1363 (setq l
(sort l
'string-lessp
))
1369 (setcdr m
(cddr m
)))
1373 (defun pcomplete-process-result (cmd &rest args
)
1374 "Call CMD using `call-process' and return the simplest result."
1376 (apply 'call-process cmd nil t nil args
)
1377 (skip-chars-backward "\n")
1378 (buffer-substring (point-min) (point))))
1380 ;; create a set of aliases which allow completion functions to be not
1383 ;;; jww (1999-10-20): are these a good idea?
1384 ;; (defalias 'pc-here 'pcomplete-here)
1385 ;; (defalias 'pc-test 'pcomplete-test)
1386 ;; (defalias 'pc-opt 'pcomplete-opt)
1387 ;; (defalias 'pc-match 'pcomplete-match)
1388 ;; (defalias 'pc-match-string 'pcomplete-match-string)
1389 ;; (defalias 'pc-match-beginning 'pcomplete-match-beginning)
1390 ;; (defalias 'pc-match-end 'pcomplete-match-end)
1392 (provide 'pcomplete
)
1394 ;;; pcomplete.el ends here