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