Commit | Line | Data |
---|---|---|
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 |
150 | This 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 |
161 | This mirrors the optional behavior of tcsh. |
162 | ||
163 | A 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 |
175 | Each function is passed both the filename to be quoted, and the index |
176 | to be considered. If the function wishes to provide an alternate | |
177 | quoted form, it need only return the replacement string. If no | |
178 | function provides a replacement, quoting shall proceed as normal, | |
179 | using a backslash to quote any character which is a member of | |
180 | `pcomplete-arg-quote-list'." | |
181 | :type 'hook | |
182 | :group 'pcomplete) | |
183 | ||
184 | (defcustom pcomplete-man-function 'man | |
9201cc28 | 185 | "A function to that will be called to display a manual page. |
affbf647 GM |
186 | It 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 |
192 | The behavior of most all shells is to sort alphabetically." |
193 | :type '(radio (function-item string-lessp) | |
194 | (function-item file-newer-than-file-p) | |
195 | (function :tag "Other")) | |
196 | :group 'pcomplete) | |
197 | ||
198 | (defcustom pcomplete-help nil | |
9201cc28 | 199 | "A string or function (or nil) used for context-sensitive help. |
affbf647 GM |
200 | If a string, it should name an Info node that will be jumped to. |
201 | If non-nil, it must a sexp that will be evaluated, and whose | |
202 | result will be shown in the minibuffer. | |
203 | If nil, the function `pcomplete-man-function' will be called with the | |
204 | current command argument." | |
205 | :type '(choice string sexp (const :tag "Use man page" nil)) | |
206 | :group 'pcomplete) | |
207 | ||
208 | (defcustom pcomplete-expand-before-complete nil | |
9201cc28 | 209 | "If non-nil, expand the current argument before completing it. |
affbf647 GM |
210 | This means that typing something such as '$HOME/bi' followed by |
211 | \\[pcomplete-argument] will cause the variable reference to be | |
212 | resolved first, and the resultant value that will be completed against | |
213 | to be inserted in the buffer. Note that exactly what gets expanded | |
214 | and how is entirely up to the behavior of the | |
215 | `pcomplete-parse-arguments-function'." | |
216 | :type 'boolean | |
217 | :group 'pcomplete) | |
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 |
222 | It should be called with no parameters, and with point at the position |
223 | of the argument that is to be completed. | |
224 | ||
225 | It must either return nil, or a cons cell of the form: | |
226 | ||
227 | ((ARG...) (BEG-POS...)) | |
228 | ||
229 | The two lists must be identical in length. The first gives the final | |
230 | value of each command line argument (which need not match the textual | |
231 | representation of that argument), and BEG-POS gives the beginning | |
232 | position of each argument, as it is seen by the user. The establishes | |
233 | a relationship between the fully resolved value of the argument, and | |
234 | the textual representation of the argument." | |
235 | :type 'function | |
236 | :group 'pcomplete) | |
237 | ||
238 | (defcustom pcomplete-cycle-completions t | |
9201cc28 | 239 | "If non-nil, hitting the TAB key cycles through the completion list. |
affbf647 GM |
240 | Typical Emacs behavior is to complete as much as possible, then pause |
241 | waiting for further input. Then if TAB is hit again, show a list of | |
242 | possible completions. When `pcomplete-cycle-completions' is non-nil, | |
243 | it acts more like zsh or 4nt, showing the first maximal match first, | |
244 | followed by any further matches on each subsequent pressing of the TAB | |
245 | key. \\[pcomplete-list] is the key to press if the user wants to see | |
246 | the list of possible completions." | |
247 | :type 'boolean | |
248 | :group 'pcomplete) | |
249 | ||
250 | (defcustom pcomplete-cycle-cutoff-length 5 | |
9201cc28 | 251 | "If the number of completions is greater than this, don't cycle. |
affbf647 GM |
252 | This variable is a compromise between the traditional Emacs style of |
253 | completion, and the \"cycling\" style. Basically, if there are more | |
254 | than this number of completions possible, don't automatically pick the | |
255 | first one and then expect the user to press TAB to cycle through them. | |
256 | Typically, when there are a large number of completion possibilities, | |
257 | the user wants to see them in a list buffer so that they can know what | |
258 | options are available. But if the list is small, it means the user | |
259 | has already entered enough input to disambiguate most of the | |
260 | possibilities, and therefore they are probably most interested in | |
261 | cycling through the candidates. Set this value to nil if you want | |
262 | cycling to always be enabled." | |
263 | :type '(choice integer (const :tag "Always cycle" nil)) | |
264 | :group 'pcomplete) | |
265 | ||
266 | (defcustom pcomplete-restore-window-delay 1 | |
9201cc28 | 267 | "The number of seconds to wait before restoring completion windows. |
affbf647 GM |
268 | Once the completion window has been displayed, if the user then goes |
269 | on to type something else, that completion window will be removed from | |
270 | the display (actually, the original window configuration before it was | |
271 | displayed will be restored), after this many seconds of idle time. If | |
272 | set to nil, completion windows will be left on second until the user | |
273 | removes them manually. If set to 0, they will disappear immediately | |
274 | after the user enters a key other than TAB." | |
275 | :type '(choice integer (const :tag "Never restore" nil)) | |
276 | :group 'pcomplete) | |
277 | ||
278 | (defcustom pcomplete-try-first-hook nil | |
9201cc28 | 279 | "A list of functions which are called before completing an argument. |
affbf647 GM |
280 | This can be used, for example, for completing things which might apply |
281 | to all arguments, such as variable names after a $." | |
282 | :type 'hook | |
283 | :group 'pcomplete) | |
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 |
307 | This 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 |
313 | If nil, you will always see the completion set of possible options, no |
314 | matter which of those options have already been used in previous | |
315 | command arguments." | |
316 | :type 'boolean | |
317 | :group 'pcomplete) | |
318 | ||
150158c4 | 319 | (defcustom pcomplete-termination-string " " |
9201cc28 | 320 | "A string that is inserted after any completion or expansion. |
150158c4 JW |
321 | This is usually a space character, useful when completing lists of |
322 | words separated by spaces. However, if your list uses a different | |
323 | separator character, or if the completion occurs in a word that is | |
324 | already terminated by a character, this variable should be locally | |
325 | modified to be an empty string, or the desired separation string." | |
326 | :type 'string | |
327 | :group 'pcomplete) | |
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. | |
387 | S1 is expected to be the unquoted and expanded version of S1. | |
388 | Returns (PS1 . PS2), i.e. the shortest prefixes of S1 and S2, such that | |
389 | S1 = (concat PS1 SS1) and S2 = (concat PS2 SS2) and | |
390 | SS1 = (unquote SS2)." | |
391 | (let* ((cs (pcomplete--common-suffix s1 s2)) | |
392 | (ss1 (substring s1 (- (length s1) cs))) | |
393 | (qss1 (pcomplete-quote-argument ss1)) | |
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. |
410 | When TABLE, S1 and S2 are provided by `apply-partially', the result | |
411 | is a completion table which completes strings of the form (concat S1 S) | |
412 | in the same way as TABLE completes strings of the form (concat S2 S)." | |
413 | (let* ((str (if (eq t (compare-strings string 0 (length s1) s1 nil nil | |
414 | completion-ignore-case)) | |
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. | |
449 | Same as `pcomplete' but using the standard completion UI." | |
450 | (interactive) | |
0667de21 SM |
451 | ;; FIXME: it only completes the text before point, whereas the |
452 | ;; standard UI may also consider text after point. | |
3b067af1 SM |
453 | (catch 'pcompleted |
454 | (let* ((pcomplete-stub) | |
455 | pcomplete-seen pcomplete-norm-func | |
456 | pcomplete-args pcomplete-last pcomplete-index | |
457 | (pcomplete-autolist pcomplete-autolist) | |
458 | (pcomplete-suffix-list pcomplete-suffix-list) | |
459 | ;; Apparently the vars above are global vars modified by | |
460 | ;; side-effects, whereas pcomplete-completions is the core | |
461 | ;; function that finds the chunk of text to complete | |
462 | ;; (returned indirectly in pcomplete-stub) and the set of | |
463 | ;; possible completions. | |
464 | (completions (pcomplete-completions)) | |
48feed59 SM |
465 | ;; Usually there's some close connection between pcomplete-stub |
466 | ;; and the text before point. But depending on what | |
467 | ;; pcomplete-parse-arguments-function does, that connection | |
468 | ;; might not be that close. E.g. in eshell, | |
469 | ;; pcomplete-parse-arguments-function expands envvars. | |
470 | ;; | |
471 | ;; Since we use minibuffer-complete, which doesn't know | |
472 | ;; pcomplete-stub and works from the buffer's text instead, | |
473 | ;; we need to trick minibuffer-complete, into using | |
474 | ;; pcomplete-stub without its knowledge. To that end, we | |
2d085307 | 475 | ;; use pcomplete--table-subvert to construct a completion |
48feed59 SM |
476 | ;; table which expects strings using a prefix from the |
477 | ;; buffer's text but internally uses the corresponding | |
478 | ;; prefix from pcomplete-stub. | |
479 | (beg (max (- (point) (length pcomplete-stub)) | |
2d085307 | 480 | (pcomplete-begin))) |
48feed59 | 481 | (buftext (buffer-substring beg (point))) |
2d085307 SM |
482 | (table |
483 | (if (not (equal pcomplete-stub buftext)) | |
484 | ;; This isn't always strictly right (e.g. if | |
485 | ;; FOO="toto/$FOO", then completion of /$FOO/bar may | |
486 | ;; result in something incorrect), but given the lack of | |
487 | ;; any other info, it's about as good as it gets, and in | |
488 | ;; practice it should work just fine (fingers crossed). | |
489 | (let ((prefixes (pcomplete--common-quoted-suffix | |
490 | pcomplete-stub buftext))) | |
491 | (apply-partially | |
492 | 'pcomplete--table-subvert | |
493 | completions | |
494 | (cdr prefixes) (car prefixes))) | |
495 | (lexical-let ((completions completions)) | |
496 | (lambda (string pred action) | |
497 | (let ((res (complete-with-action | |
498 | action completions string pred))) | |
499 | (if (stringp res) | |
500 | (pcomplete-quote-argument res) | |
0667de21 SM |
501 | res)))))) |
502 | (pred | |
503 | ;; pare it down, if applicable | |
504 | (when (and pcomplete-use-paring pcomplete-seen) | |
505 | (setq pcomplete-seen | |
506 | (mapcar (lambda (f) | |
507 | (funcall pcomplete-norm-func | |
508 | (directory-file-name f))) | |
509 | pcomplete-seen)) | |
510 | (lambda (f) | |
511 | (not (member | |
512 | (funcall pcomplete-norm-func | |
513 | (directory-file-name f)) | |
514 | pcomplete-seen)))))) | |
2d085307 | 515 | |
48feed59 SM |
516 | (let ((ol (make-overlay beg (point) nil nil t)) |
517 | (minibuffer-completion-table | |
518 | ;; Add a space at the end of completion. Use a terminator-regexp | |
519 | ;; that never matches since the terminator cannot appear | |
520 | ;; within the completion field anyway. | |
521 | (if (zerop (length pcomplete-termination-string)) | |
2d085307 | 522 | table |
48feed59 SM |
523 | (apply-partially 'completion-table-with-terminator |
524 | (cons pcomplete-termination-string | |
525 | "\\`a\\`") | |
2d085307 | 526 | table))) |
0667de21 | 527 | (minibuffer-completion-predicate pred)) |
48feed59 SM |
528 | (overlay-put ol 'field 'pcomplete) |
529 | (unwind-protect | |
530 | (call-interactively 'minibuffer-complete) | |
531 | (delete-overlay ol)))))) | |
3b067af1 | 532 | |
2d085307 SM |
533 | ;;; Pcomplete's native UI. |
534 | ||
535 | ;;;###autoload | |
536 | (defun pcomplete (&optional interactively) | |
537 | "Support extensible programmable completion. | |
538 | To use this function, just bind the TAB key to it, or add it to your | |
539 | completion functions list (it should occur fairly early in the list)." | |
540 | (interactive "p") | |
541 | (if (and interactively | |
542 | pcomplete-cycle-completions | |
543 | pcomplete-current-completions | |
544 | (memq last-command '(pcomplete | |
545 | pcomplete-expand-and-complete | |
546 | pcomplete-reverse))) | |
547 | (progn | |
548 | (delete-backward-char pcomplete-last-completion-length) | |
549 | (if (eq this-command 'pcomplete-reverse) | |
550 | (progn | |
0667de21 SM |
551 | (push (car (last pcomplete-current-completions)) |
552 | pcomplete-current-completions) | |
2d085307 SM |
553 | (setcdr (last pcomplete-current-completions 2) nil)) |
554 | (nconc pcomplete-current-completions | |
555 | (list (car pcomplete-current-completions))) | |
556 | (setq pcomplete-current-completions | |
557 | (cdr pcomplete-current-completions))) | |
558 | (pcomplete-insert-entry pcomplete-last-completion-stub | |
559 | (car pcomplete-current-completions) | |
560 | nil pcomplete-last-completion-raw)) | |
561 | (setq pcomplete-current-completions nil | |
562 | pcomplete-last-completion-raw nil) | |
563 | (catch 'pcompleted | |
564 | (let* ((pcomplete-stub) | |
565 | pcomplete-seen pcomplete-norm-func | |
566 | pcomplete-args pcomplete-last pcomplete-index | |
567 | (pcomplete-autolist pcomplete-autolist) | |
568 | (pcomplete-suffix-list pcomplete-suffix-list) | |
569 | (completions (pcomplete-completions)) | |
570 | (result (pcomplete-do-complete pcomplete-stub completions))) | |
571 | (and result | |
572 | (not (eq (car result) 'listed)) | |
573 | (cdr result) | |
574 | (pcomplete-insert-entry pcomplete-stub (cdr result) | |
575 | (memq (car result) | |
576 | '(sole shortest)) | |
577 | pcomplete-last-completion-raw)))))) | |
578 | ||
affbf647 GM |
579 | ;;;###autoload |
580 | (defun pcomplete-reverse () | |
581 | "If cycling completion is in use, cycle backwards." | |
582 | (interactive) | |
583 | (call-interactively 'pcomplete)) | |
584 | ||
585 | ;;;###autoload | |
586 | (defun pcomplete-expand-and-complete () | |
587 | "Expand the textual value of the current argument. | |
588 | This will modify the current buffer." | |
589 | (interactive) | |
590 | (let ((pcomplete-expand-before-complete t)) | |
591 | (pcomplete))) | |
592 | ||
593 | ;;;###autoload | |
594 | (defun pcomplete-continue () | |
595 | "Complete without reference to any cycling completions." | |
596 | (interactive) | |
597 | (setq pcomplete-current-completions nil | |
598 | pcomplete-last-completion-raw nil) | |
599 | (call-interactively 'pcomplete)) | |
600 | ||
601 | ;;;###autoload | |
602 | (defun pcomplete-expand () | |
603 | "Expand the textual value of the current argument. | |
604 | This will modify the current buffer." | |
605 | (interactive) | |
606 | (let ((pcomplete-expand-before-complete t) | |
607 | (pcomplete-expand-only-p t)) | |
608 | (pcomplete) | |
609 | (when (and pcomplete-current-completions | |
3b067af1 | 610 | (> (length pcomplete-current-completions) 0)) ;?? |
affbf647 GM |
611 | (delete-backward-char pcomplete-last-completion-length) |
612 | (while pcomplete-current-completions | |
613 | (unless (pcomplete-insert-entry | |
614 | "" (car pcomplete-current-completions) t | |
3b067af1 | 615 | pcomplete-last-completion-raw) |
150158c4 | 616 | (insert-and-inherit pcomplete-termination-string)) |
affbf647 GM |
617 | (setq pcomplete-current-completions |
618 | (cdr pcomplete-current-completions)))))) | |
619 | ||
620 | ;;;###autoload | |
621 | (defun pcomplete-help () | |
622 | "Display any help information relative to the current argument." | |
623 | (interactive) | |
624 | (let ((pcomplete-show-help t)) | |
625 | (pcomplete))) | |
626 | ||
627 | ;;;###autoload | |
628 | (defun pcomplete-list () | |
629 | "Show the list of possible completions for the current argument." | |
630 | (interactive) | |
631 | (when (and pcomplete-cycle-completions | |
632 | pcomplete-current-completions | |
633 | (eq last-command 'pcomplete-argument)) | |
634 | (delete-backward-char pcomplete-last-completion-length) | |
635 | (setq pcomplete-current-completions nil | |
636 | pcomplete-last-completion-raw nil)) | |
637 | (let ((pcomplete-show-list t)) | |
638 | (pcomplete))) | |
639 | ||
640 | ;;; Internal Functions: | |
641 | ||
642 | ;; argument handling | |
643 | ||
644 | ;; for the sake of the bye-compiler, when compiling other files that | |
645 | ;; contain completion functions | |
646 | (defvar pcomplete-args nil) | |
647 | (defvar pcomplete-begins nil) | |
648 | (defvar pcomplete-last nil) | |
649 | (defvar pcomplete-index nil) | |
650 | (defvar pcomplete-stub nil) | |
651 | (defvar pcomplete-seen nil) | |
652 | (defvar pcomplete-norm-func nil) | |
653 | ||
654 | (defun pcomplete-arg (&optional index offset) | |
655 | "Return the textual content of the INDEXth argument. | |
656 | INDEX is based from the current processing position. If INDEX is | |
657 | positive, values returned are closer to the command argument; if | |
658 | negative, they are closer to the last argument. If the INDEX is | |
659 | outside of the argument list, nil is returned. The default value for | |
660 | INDEX is 0, meaning the current argument being examined. | |
661 | ||
662 | The special indices `first' and `last' may be used to access those | |
663 | parts of the list. | |
664 | ||
665 | The OFFSET argument is added to/taken away from the index that will be | |
666 | used. This is really only useful with `first' and `last', for | |
667 | accessing absolute argument positions." | |
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-args)) | |
677 | ||
678 | (defun pcomplete-begin (&optional index offset) | |
679 | "Return the beginning position of the INDEXth argument. | |
680 | See the documentation for `pcomplete-arg'." | |
681 | (setq index | |
682 | (if (eq index 'first) | |
683 | 0 | |
684 | (if (eq index 'last) | |
685 | pcomplete-last | |
686 | (- pcomplete-index (or index 0))))) | |
687 | (if offset | |
688 | (setq index (+ index offset))) | |
689 | (nth index pcomplete-begins)) | |
690 | ||
691 | (defsubst pcomplete-actual-arg (&optional index offset) | |
692 | "Return the actual text representation of the last argument. | |
21a2e05d | 693 | This is different from `pcomplete-arg', which returns the textual value |
affbf647 GM |
694 | that the last argument evaluated to. This function returns what the |
695 | user actually typed in." | |
696 | (buffer-substring (pcomplete-begin index offset) (point))) | |
697 | ||
698 | (defsubst pcomplete-next-arg () | |
699 | "Move the various pointers to the next argument." | |
700 | (setq pcomplete-index (1+ pcomplete-index) | |
701 | pcomplete-stub (pcomplete-arg)) | |
702 | (if (> pcomplete-index pcomplete-last) | |
703 | (progn | |
704 | (message "No completions") | |
705 | (throw 'pcompleted nil)))) | |
706 | ||
707 | (defun pcomplete-command-name () | |
708 | "Return the command name of the first argument." | |
709 | (file-name-nondirectory (pcomplete-arg 'first))) | |
710 | ||
711 | (defun pcomplete-match (regexp &optional index offset start) | |
712 | "Like `string-match', but on the current completion argument." | |
713 | (let ((arg (pcomplete-arg (or index 1) offset))) | |
714 | (if arg | |
715 | (string-match regexp arg start) | |
716 | (throw 'pcompleted nil)))) | |
717 | ||
718 | (defun pcomplete-match-string (which &optional index offset) | |
21a2e05d | 719 | "Like `match-string', but on the current completion argument." |
affbf647 GM |
720 | (let ((arg (pcomplete-arg (or index 1) offset))) |
721 | (if arg | |
722 | (match-string which arg) | |
723 | (throw 'pcompleted nil)))) | |
724 | ||
725 | (defalias 'pcomplete-match-beginning 'match-beginning) | |
726 | (defalias 'pcomplete-match-end 'match-end) | |
727 | ||
728 | (defsubst pcomplete--test (pred arg) | |
729 | "Perform a programmable completion predicate match." | |
730 | (and pred | |
731 | (cond ((eq pred t) t) | |
732 | ((functionp pred) | |
733 | (funcall pred arg)) | |
734 | ((stringp pred) | |
735 | (string-match (concat "^" pred "$") arg))) | |
736 | pred)) | |
737 | ||
738 | (defun pcomplete-test (predicates &optional index offset) | |
739 | "Predicates to test the current programmable argument with." | |
740 | (let ((arg (pcomplete-arg (or index 1) offset))) | |
741 | (unless (null predicates) | |
742 | (if (not (listp predicates)) | |
743 | (pcomplete--test predicates arg) | |
744 | (let ((pred predicates) | |
745 | found) | |
746 | (while (and pred (not found)) | |
747 | (setq found (pcomplete--test (car pred) arg) | |
748 | pred (cdr pred))) | |
749 | found))))) | |
750 | ||
751 | (defun pcomplete-parse-buffer-arguments () | |
752 | "Parse whitespace separated arguments in the current region." | |
753 | (let ((begin (point-min)) | |
754 | (end (point-max)) | |
755 | begins args) | |
756 | (save-excursion | |
757 | (goto-char begin) | |
758 | (while (< (point) end) | |
759 | (skip-chars-forward " \t\n") | |
0667de21 | 760 | (push (point) begins) |
affbf647 | 761 | (skip-chars-forward "^ \t\n") |
0667de21 SM |
762 | (push (buffer-substring-no-properties |
763 | (car begins) (point)) | |
764 | args)) | |
765 | (cons (nreverse args) (nreverse begins))))) | |
affbf647 GM |
766 | |
767 | ;;;###autoload | |
768 | (defun pcomplete-comint-setup (completef-sym) | |
769 | "Setup a comint buffer to use pcomplete. | |
770 | COMPLETEF-SYM should be the symbol where the | |
21a2e05d JB |
771 | dynamic-complete-functions are kept. For comint mode itself, |
772 | this is `comint-dynamic-complete-functions'." | |
affbf647 GM |
773 | (set (make-local-variable 'pcomplete-parse-arguments-function) |
774 | 'pcomplete-parse-comint-arguments) | |
48feed59 SM |
775 | (set (make-local-variable completef-sym) |
776 | (copy-sequence (symbol-value completef-sym))) | |
208384c5 CY |
777 | (let* ((funs (symbol-value completef-sym)) |
778 | (elem (or (memq 'comint-dynamic-complete-filename funs) | |
779 | (memq 'shell-dynamic-complete-filename funs)))) | |
affbf647 GM |
780 | (if elem |
781 | (setcar elem 'pcomplete) | |
22eb1d41 | 782 | (add-to-list completef-sym 'pcomplete)))) |
affbf647 GM |
783 | |
784 | ;;;###autoload | |
785 | (defun pcomplete-shell-setup () | |
3b067af1 | 786 | "Setup `shell-mode' to use pcomplete." |
2d085307 | 787 | ;; FIXME: insufficient |
48feed59 | 788 | (pcomplete-comint-setup 'comint-dynamic-complete-functions)) |
affbf647 | 789 | |
004a00f4 DN |
790 | (declare-function comint-bol "comint" (&optional arg)) |
791 | ||
affbf647 GM |
792 | (defun pcomplete-parse-comint-arguments () |
793 | "Parse whitespace separated arguments in the current region." | |
794 | (let ((begin (save-excursion (comint-bol nil) (point))) | |
795 | (end (point)) | |
796 | begins args) | |
797 | (save-excursion | |
798 | (goto-char begin) | |
799 | (while (< (point) end) | |
800 | (skip-chars-forward " \t\n") | |
48feed59 | 801 | (push (point) begins) |
affbf647 GM |
802 | (let ((skip t)) |
803 | (while skip | |
804 | (skip-chars-forward "^ \t\n") | |
805 | (if (eq (char-before) ?\\) | |
806 | (skip-chars-forward " \t\n") | |
807 | (setq skip nil)))) | |
48feed59 SM |
808 | (push (buffer-substring-no-properties (car begins) (point)) |
809 | args)) | |
810 | (cons (nreverse args) (nreverse begins))))) | |
affbf647 GM |
811 | |
812 | (defun pcomplete-parse-arguments (&optional expand-p) | |
813 | "Parse the command line arguments. Most completions need this info." | |
814 | (let ((results (funcall pcomplete-parse-arguments-function))) | |
815 | (when results | |
816 | (setq pcomplete-args (or (car results) (list "")) | |
817 | pcomplete-begins (or (cdr results) (list (point))) | |
818 | pcomplete-last (1- (length pcomplete-args)) | |
819 | pcomplete-index 0 | |
820 | pcomplete-stub (pcomplete-arg 'last)) | |
821 | (let ((begin (pcomplete-begin 'last))) | |
822 | (if (and pcomplete-cycle-completions | |
48feed59 | 823 | (listp pcomplete-stub) ;?? |
affbf647 | 824 | (not pcomplete-expand-only-p)) |
48feed59 | 825 | (let* ((completions pcomplete-stub) ;?? |
affbf647 GM |
826 | (common-stub (car completions)) |
827 | (c completions) | |
828 | (len (length common-stub))) | |
829 | (while (and c (> len 0)) | |
830 | (while (and (> len 0) | |
831 | (not (string= | |
832 | (substring common-stub 0 len) | |
833 | (substring (car c) 0 | |
834 | (min (length (car c)) | |
835 | len))))) | |
836 | (setq len (1- len))) | |
837 | (setq c (cdr c))) | |
838 | (setq pcomplete-stub (substring common-stub 0 len) | |
839 | pcomplete-autolist t) | |
840 | (when (and begin (not pcomplete-show-list)) | |
841 | (delete-region begin (point)) | |
842 | (pcomplete-insert-entry "" pcomplete-stub)) | |
843 | (throw 'pcomplete-completions completions)) | |
844 | (when expand-p | |
845 | (if (stringp pcomplete-stub) | |
846 | (when begin | |
847 | (delete-region begin (point)) | |
848 | (insert-and-inherit pcomplete-stub)) | |
849 | (if (and (listp pcomplete-stub) | |
850 | pcomplete-expand-only-p) | |
851 | ;; this is for the benefit of `pcomplete-expand' | |
852 | (setq pcomplete-last-completion-length (- (point) begin) | |
853 | pcomplete-current-completions pcomplete-stub) | |
854 | (error "Cannot expand argument")))) | |
855 | (if pcomplete-expand-only-p | |
856 | (throw 'pcompleted t) | |
857 | pcomplete-args)))))) | |
858 | ||
859 | (defun pcomplete-quote-argument (filename) | |
860 | "Return FILENAME with magic characters quoted. | |
861 | Magic characters are those in `pcomplete-arg-quote-list'." | |
862 | (if (null pcomplete-arg-quote-list) | |
863 | filename | |
2d085307 SM |
864 | (let ((index 0)) |
865 | (mapconcat (lambda (c) | |
866 | (prog1 | |
867 | (or (run-hook-with-args-until-success | |
868 | 'pcomplete-quote-arg-hook filename index) | |
869 | (when (memq c pcomplete-arg-quote-list) | |
870 | (string "\\" c)) | |
871 | (char-to-string c)) | |
872 | (setq index (1+ index)))) | |
873 | filename | |
874 | "")))) | |
affbf647 GM |
875 | |
876 | ;; file-system completion lists | |
877 | ||
878 | (defsubst pcomplete-dirs-or-entries (&optional regexp predicate) | |
879 | "Return either directories, or qualified entries." | |
3b067af1 SM |
880 | ;; FIXME: pcomplete-entries doesn't return a list any more. |
881 | (pcomplete-entries | |
882 | nil | |
883 | (lexical-let ((re regexp) | |
884 | (pred predicate)) | |
885 | (lambda (f) | |
886 | (or (file-directory-p f) | |
887 | (and (if (not re) t (string-match re f)) | |
888 | (if (not pred) t (funcall pred f)))))))) | |
affbf647 GM |
889 | |
890 | (defun pcomplete-entries (&optional regexp predicate) | |
891 | "Complete against a list of directory candidates. | |
affbf647 GM |
892 | If REGEXP is non-nil, it is a regular expression used to refine the |
893 | match (files not matching the REGEXP will be excluded). | |
894 | If PREDICATE is non-nil, it will also be used to refine the match | |
895 | \(files for which the PREDICATE returns nil will be excluded). | |
430190ba | 896 | If no directory information can be extracted from the completed |
21a2e05d | 897 | component, `default-directory' is used as the basis for completion." |
2d085307 SM |
898 | ;; FIXME: obey pcomplete-file-ignore and pcomplete-dir-ignore. |
899 | ;; FIXME: obey pcomplete-compare-entry-function (tho only if there | |
900 | ;; are less than pcomplete-cycle-cutoff-length completions). | |
901 | ;; FIXME: expand envvars? shouldn't this be done globally instead? | |
902 | (let* ((reg-pred (when regexp | |
903 | (lexical-let ((re regexp)) | |
904 | (lambda (f) | |
905 | ;; (let ((name (file-name-nondirectory f))) | |
906 | ;; (if (zerop (length name)) | |
907 | ;; (setq name (file-name-as-directory | |
908 | ;; (file-name-nondirectory | |
909 | ;; (directory-file-name f))))) | |
910 | ;; (string-match re name)) | |
911 | (string-match re f))))) | |
912 | (pred (cond | |
913 | ((null predicate) reg-pred) | |
914 | ((null reg-pred) predicate) | |
915 | (t (lexical-let ((predicate predicate) | |
916 | (reg-pred reg-pred)) | |
917 | (lambda (f) | |
918 | (and (funcall predicate f) | |
919 | (funcall reg-pred f))))))) | |
920 | (fun | |
921 | (lexical-let ((pred pred) | |
922 | (dir default-directory)) | |
923 | (lambda (s p a) | |
924 | ;; Remember the default-directory that was active when we built | |
925 | ;; the completion table. | |
926 | (let ((default-directory dir) | |
927 | ;; The old code used only file-name-all-completions | |
928 | ;; which ignores completion-ignored-extensions. | |
929 | (completion-ignored-extensions nil)) | |
930 | (completion-table-with-predicate | |
931 | 'completion-file-name-table pred 'strict s p a))))) | |
932 | ;; Indirect through a symbol rather than returning a lambda | |
933 | ;; expression, so as to help catch bugs where the caller | |
934 | ;; might treat the lambda expression as a list of completions. | |
935 | (sym (make-symbol "pcomplete-read-file-name-internal"))) | |
936 | (fset sym fun) | |
937 | sym)) | |
affbf647 GM |
938 | |
939 | (defsubst pcomplete-all-entries (&optional regexp predicate) | |
940 | "Like `pcomplete-entries', but doesn't ignore any entries." | |
941 | (let (pcomplete-file-ignore | |
942 | pcomplete-dir-ignore) | |
943 | (pcomplete-entries regexp predicate))) | |
944 | ||
945 | (defsubst pcomplete-dirs (&optional regexp) | |
946 | "Complete amongst a list of directories." | |
947 | (pcomplete-entries regexp 'file-directory-p)) | |
948 | ||
affbf647 GM |
949 | ;; generation of completion lists |
950 | ||
951 | (defun pcomplete-find-completion-function (command) | |
952 | "Find the completion function to call for the given COMMAND." | |
953 | (let ((sym (intern-soft | |
954 | (concat "pcomplete/" (symbol-name major-mode) "/" command)))) | |
955 | (unless sym | |
956 | (setq sym (intern-soft (concat "pcomplete/" command)))) | |
957 | (and sym (fboundp sym) sym))) | |
958 | ||
959 | (defun pcomplete-completions () | |
960 | "Return a list of completions for the current argument position." | |
961 | (catch 'pcomplete-completions | |
962 | (when (pcomplete-parse-arguments pcomplete-expand-before-complete) | |
963 | (if (= pcomplete-index pcomplete-last) | |
964 | (funcall pcomplete-command-completion-function) | |
965 | (let ((sym (or (pcomplete-find-completion-function | |
966 | (funcall pcomplete-command-name-function)) | |
967 | pcomplete-default-completion-function))) | |
968 | (ignore | |
969 | (pcomplete-next-arg) | |
970 | (funcall sym))))))) | |
971 | ||
972 | (defun pcomplete-opt (options &optional prefix no-ganging args-follow) | |
973 | "Complete a set of OPTIONS, each beginning with PREFIX (?- by default). | |
974 | PREFIX may be t, in which case no PREFIX character is necessary. | |
21a2e05d JB |
975 | If NO-GANGING is non-nil, each option is separate (-xy is not allowed). |
976 | If ARGS-FOLLOW is non-nil, then options which take arguments may have | |
977 | the argument appear after a ganged set of options. This is how tar | |
978 | behaves, for example." | |
affbf647 GM |
979 | (if (and (= pcomplete-index pcomplete-last) |
980 | (string= (pcomplete-arg) "-")) | |
981 | (let ((len (length options)) | |
982 | (index 0) | |
983 | char choices) | |
984 | (while (< index len) | |
985 | (setq char (aref options index)) | |
986 | (if (eq char ?\() | |
987 | (let ((result (read-from-string options index))) | |
988 | (setq index (cdr result))) | |
989 | (unless (memq char '(?/ ?* ?? ?.)) | |
0667de21 | 990 | (push (char-to-string char) choices)) |
affbf647 GM |
991 | (setq index (1+ index)))) |
992 | (throw 'pcomplete-completions | |
993 | (mapcar | |
994 | (function | |
995 | (lambda (opt) | |
996 | (concat "-" opt))) | |
997 | (pcomplete-uniqify-list choices)))) | |
998 | (let ((arg (pcomplete-arg))) | |
999 | (when (and (> (length arg) 1) | |
1000 | (stringp arg) | |
1001 | (eq (aref arg 0) (or prefix ?-))) | |
1002 | (pcomplete-next-arg) | |
1003 | (let ((char (aref arg 1)) | |
1004 | (len (length options)) | |
1005 | (index 0) | |
1006 | opt-char arg-char result) | |
1007 | (while (< (1+ index) len) | |
1008 | (setq opt-char (aref options index) | |
1009 | arg-char (aref options (1+ index))) | |
1010 | (if (eq arg-char ?\() | |
1011 | (setq result | |
1012 | (read-from-string options (1+ index)) | |
1013 | index (cdr result) | |
1014 | result (car result)) | |
1015 | (setq result nil)) | |
1016 | (when (and (eq char opt-char) | |
1017 | (memq arg-char '(?\( ?/ ?* ?? ?.))) | |
1018 | (if (< pcomplete-index pcomplete-last) | |
1019 | (pcomplete-next-arg) | |
1020 | (throw 'pcomplete-completions | |
1021 | (cond ((eq arg-char ?/) (pcomplete-dirs)) | |
1022 | ((eq arg-char ?*) (pcomplete-executables)) | |
1023 | ((eq arg-char ??) nil) | |
1024 | ((eq arg-char ?.) (pcomplete-entries)) | |
1025 | ((eq arg-char ?\() (eval result)))))) | |
1026 | (setq index (1+ index)))))))) | |
1027 | ||
1028 | (defun pcomplete--here (&optional form stub paring form-only) | |
21a2e05d | 1029 | "Complete against the current argument, if at the end. |
affbf647 GM |
1030 | See the documentation for `pcomplete-here'." |
1031 | (if (< pcomplete-index pcomplete-last) | |
1032 | (progn | |
1033 | (if (eq paring 0) | |
1034 | (setq pcomplete-seen nil) | |
1035 | (unless (eq paring t) | |
1036 | (let ((arg (pcomplete-arg))) | |
3b067af1 | 1037 | (when (stringp arg) |
0667de21 SM |
1038 | (push (if paring |
1039 | (funcall paring arg) | |
1040 | (file-truename arg)) | |
1041 | pcomplete-seen))))) | |
affbf647 GM |
1042 | (pcomplete-next-arg) |
1043 | t) | |
1044 | (when pcomplete-show-help | |
1045 | (pcomplete--help) | |
1046 | (throw 'pcompleted t)) | |
1047 | (if stub | |
1048 | (setq pcomplete-stub stub)) | |
1049 | (if (or (eq paring t) (eq paring 0)) | |
1050 | (setq pcomplete-seen nil) | |
1051 | (setq pcomplete-norm-func (or paring 'file-truename))) | |
1052 | (unless form-only | |
1053 | (run-hooks 'pcomplete-try-first-hook)) | |
3b067af1 SM |
1054 | (throw 'pcomplete-completions |
1055 | (if (functionp form) | |
1056 | (funcall form) | |
1057 | ;; Old calling convention, might still be used by files | |
1058 | ;; byte-compiled with the older code. | |
1059 | (eval form))))) | |
affbf647 GM |
1060 | |
1061 | (defmacro pcomplete-here (&optional form stub paring form-only) | |
21a2e05d | 1062 | "Complete against the current argument, if at the end. |
3b067af1 SM |
1063 | If completion is to be done here, evaluate FORM to generate the completion |
1064 | table which will be used for completion purposes. If STUB is a | |
affbf647 GM |
1065 | string, use it as the completion stub instead of the default (which is |
1066 | the entire text of the current argument). | |
1067 | ||
1068 | For an example of when you might want to use STUB: if the current | |
1069 | argument text is 'long-path-name/', you don't want the completions | |
1070 | list display to be cluttered by 'long-path-name/' appearing at the | |
1071 | beginning of every alternative. Not only does this make things less | |
3b067af1 | 1072 | intelligible, but it is also inefficient. Yet, if the completion list |
affbf647 GM |
1073 | does not begin with this string for every entry, the current argument |
1074 | won't complete correctly. | |
1075 | ||
1076 | The solution is to specify a relative stub. It allows you to | |
1077 | substitute a different argument from the current argument, almost | |
1078 | always for the sake of efficiency. | |
1079 | ||
1080 | If PARING is nil, this argument will be pared against previous | |
1081 | arguments using the function `file-truename' to normalize them. | |
21a2e05d JB |
1082 | PARING may be a function, in which case that function is used for |
1083 | normalization. If PARING is t, the argument dealt with by this | |
1084 | call will not participate in argument paring. If it is the | |
1085 | integer 0, all previous arguments that have been seen will be | |
1086 | cleared. | |
affbf647 GM |
1087 | |
1088 | If FORM-ONLY is non-nil, only the result of FORM will be used to | |
1089 | generate the completions list. This means that the hook | |
1090 | `pcomplete-try-first-hook' will not be run." | |
3b067af1 SM |
1091 | (declare (debug t)) |
1092 | `(pcomplete--here (lambda () ,form) ,stub ,paring ,form-only)) | |
1093 | ||
affbf647 GM |
1094 | |
1095 | (defmacro pcomplete-here* (&optional form stub form-only) | |
1096 | "An alternate form which does not participate in argument paring." | |
3b067af1 SM |
1097 | (declare (debug t)) |
1098 | `(pcomplete-here (lambda () ,form) ,stub t ,form-only)) | |
affbf647 GM |
1099 | |
1100 | ;; display support | |
1101 | ||
1102 | (defun pcomplete-restore-windows () | |
1103 | "If the only window change was due to Completions, restore things." | |
1104 | (if pcomplete-last-window-config | |
1105 | (let* ((cbuf (get-buffer "*Completions*")) | |
1106 | (cwin (and cbuf (get-buffer-window cbuf)))) | |
ccb13f4d | 1107 | (when (window-live-p cwin) |
affbf647 GM |
1108 | (bury-buffer cbuf) |
1109 | (set-window-configuration pcomplete-last-window-config)))) | |
1110 | (setq pcomplete-last-window-config nil | |
1111 | pcomplete-window-restore-timer nil)) | |
1112 | ||
1113 | ;; Abstractions so that the code below will work for both Emacs 20 and | |
1114 | ;; XEmacs 21 | |
1115 | ||
a3269bc4 DN |
1116 | (defalias 'pcomplete-event-matches-key-specifier-p |
1117 | (if (featurep 'xemacs) | |
1118 | 'event-matches-key-specifier-p | |
1119 | 'eq)) | |
affbf647 | 1120 | |
2d8e5088 RS |
1121 | (defun pcomplete-read-event (&optional prompt) |
1122 | (if (fboundp 'read-event) | |
1123 | (read-event prompt) | |
affbf647 GM |
1124 | (aref (read-key-sequence prompt) 0))) |
1125 | ||
affbf647 GM |
1126 | (defun pcomplete-show-completions (completions) |
1127 | "List in help buffer sorted COMPLETIONS. | |
1128 | Typing SPC flushes the help buffer." | |
3b067af1 SM |
1129 | (when pcomplete-window-restore-timer |
1130 | (cancel-timer pcomplete-window-restore-timer) | |
1131 | (setq pcomplete-window-restore-timer nil)) | |
1132 | (unless pcomplete-last-window-config | |
1133 | (setq pcomplete-last-window-config (current-window-configuration))) | |
1134 | (with-output-to-temp-buffer "*Completions*" | |
1135 | (display-completion-list completions)) | |
1136 | (message "Hit space to flush") | |
1137 | (let (event) | |
1138 | (prog1 | |
1139 | (catch 'done | |
1140 | (while (with-current-buffer (get-buffer "*Completions*") | |
1141 | (setq event (pcomplete-read-event))) | |
1142 | (cond | |
1143 | ((pcomplete-event-matches-key-specifier-p event ?\s) | |
1144 | (set-window-configuration pcomplete-last-window-config) | |
1145 | (setq pcomplete-last-window-config nil) | |
1146 | (throw 'done nil)) | |
1147 | ((or (pcomplete-event-matches-key-specifier-p event 'tab) | |
1148 | ;; Needed on a terminal | |
1149 | (pcomplete-event-matches-key-specifier-p event 9)) | |
1150 | (let ((win (or (get-buffer-window "*Completions*" 0) | |
1151 | (display-buffer "*Completions*" | |
1152 | 'not-this-window)))) | |
1153 | (with-selected-window win | |
1154 | (if (pos-visible-in-window-p (point-max)) | |
1155 | (goto-char (point-min)) | |
1156 | (scroll-up)))) | |
1157 | (message "")) | |
1158 | (t | |
1159 | (setq unread-command-events (list event)) | |
1160 | (throw 'done nil))))) | |
1161 | (if (and pcomplete-last-window-config | |
1162 | pcomplete-restore-window-delay) | |
1163 | (setq pcomplete-window-restore-timer | |
1164 | (run-with-timer pcomplete-restore-window-delay nil | |
1165 | 'pcomplete-restore-windows)))))) | |
affbf647 GM |
1166 | |
1167 | ;; insert completion at point | |
1168 | ||
1169 | (defun pcomplete-insert-entry (stub entry &optional addsuffix raw-p) | |
1170 | "Insert a completion entry at point. | |
1171 | Returns non-nil if a space was appended at the end." | |
1172 | (let ((here (point))) | |
1173 | (if (not pcomplete-ignore-case) | |
1174 | (insert-and-inherit (if raw-p | |
1175 | (substring entry (length stub)) | |
1176 | (pcomplete-quote-argument | |
1177 | (substring entry (length stub))))) | |
1178 | ;; the stub is not quoted at this time, so to determine the | |
1179 | ;; length of what should be in the buffer, we must quote it | |
48feed59 SM |
1180 | ;; FIXME: Here we presume that quoting `stub' gives us the exact |
1181 | ;; text in the buffer before point, which is not guaranteed; | |
1182 | ;; e.g. it is not the case in eshell when completing ${FOO}tm[TAB]. | |
affbf647 GM |
1183 | (delete-backward-char (length (pcomplete-quote-argument stub))) |
1184 | ;; if there is already a backslash present to handle the first | |
1185 | ;; character, don't bother quoting it | |
1186 | (when (eq (char-before) ?\\) | |
1187 | (insert-and-inherit (substring entry 0 1)) | |
1188 | (setq entry (substring entry 1))) | |
1189 | (insert-and-inherit (if raw-p | |
1190 | entry | |
1191 | (pcomplete-quote-argument entry)))) | |
1192 | (let (space-added) | |
1193 | (when (and (not (memq (char-before) pcomplete-suffix-list)) | |
1194 | addsuffix) | |
150158c4 | 1195 | (insert-and-inherit pcomplete-termination-string) |
affbf647 GM |
1196 | (setq space-added t)) |
1197 | (setq pcomplete-last-completion-length (- (point) here) | |
1198 | pcomplete-last-completion-stub stub) | |
1199 | space-added))) | |
1200 | ||
1201 | ;; selection of completions | |
1202 | ||
1203 | (defun pcomplete-do-complete (stub completions) | |
1204 | "Dynamically complete at point using STUB and COMPLETIONS. | |
1205 | This is basically just a wrapper for `pcomplete-stub' which does some | |
1206 | extra checking, and munging of the COMPLETIONS list." | |
1207 | (unless (stringp stub) | |
1208 | (message "Cannot complete argument") | |
1209 | (throw 'pcompleted nil)) | |
1210 | (if (null completions) | |
1211 | (ignore | |
1212 | (if (and stub (> (length stub) 0)) | |
1213 | (message "No completions of %s" stub) | |
1214 | (message "No completions"))) | |
1215 | ;; pare it down, if applicable | |
3b067af1 SM |
1216 | (when (and pcomplete-use-paring pcomplete-seen) |
1217 | (setq pcomplete-seen | |
1218 | (mapcar 'directory-file-name pcomplete-seen)) | |
1219 | (dolist (p pcomplete-seen) | |
1220 | (add-to-list 'pcomplete-seen | |
1221 | (funcall pcomplete-norm-func p))) | |
1222 | (setq completions | |
1223 | (apply-partially 'completion-table-with-predicate | |
1224 | completions | |
1225 | (lambda (f) | |
1226 | (not (member | |
1227 | (funcall pcomplete-norm-func | |
1228 | (directory-file-name f)) | |
1229 | pcomplete-seen))) | |
1230 | 'strict))) | |
affbf647 GM |
1231 | ;; OK, we've got a list of completions. |
1232 | (if pcomplete-show-list | |
3b067af1 SM |
1233 | ;; FIXME: pay attention to boundaries. |
1234 | (pcomplete-show-completions (all-completions stub completions)) | |
affbf647 GM |
1235 | (pcomplete-stub stub completions)))) |
1236 | ||
1237 | (defun pcomplete-stub (stub candidates &optional cycle-p) | |
1238 | "Dynamically complete STUB from CANDIDATES list. | |
1239 | This function inserts completion characters at point by completing | |
1240 | STUB from the strings in CANDIDATES. A completions listing may be | |
1241 | shown in a help buffer if completion is ambiguous. | |
1242 | ||
1243 | Returns nil if no completion was inserted. | |
1244 | Returns `sole' if completed with the only completion match. | |
1245 | Returns `shortest' if completed with the shortest of the matches. | |
1246 | Returns `partial' if completed as far as possible with the matches. | |
1247 | Returns `listed' if a completion listing was shown. | |
1248 | ||
1249 | See also `pcomplete-filename'." | |
1250 | (let* ((completion-ignore-case pcomplete-ignore-case) | |
3b067af1 SM |
1251 | (completions (all-completions stub candidates)) |
1252 | (entry (try-completion stub candidates)) | |
1253 | result) | |
1254 | (cond | |
1255 | ((null entry) | |
1256 | (if (and stub (> (length stub) 0)) | |
1257 | (message "No completions of %s" stub) | |
1258 | (message "No completions"))) | |
1259 | ((eq entry t) | |
1260 | (setq entry stub) | |
1261 | (message "Sole completion") | |
1262 | (setq result 'sole)) | |
1263 | ((= 1 (length completions)) | |
1264 | (setq result 'sole)) | |
1265 | ((and pcomplete-cycle-completions | |
1266 | (or cycle-p | |
1267 | (not pcomplete-cycle-cutoff-length) | |
1268 | (<= (length completions) | |
1269 | pcomplete-cycle-cutoff-length))) | |
1270 | (let ((bound (car (completion-boundaries stub candidates nil "")))) | |
1271 | (unless (zerop bound) | |
1272 | (setq completions (mapcar (lambda (c) (concat (substring stub 0 bound) c)) | |
1273 | completions))) | |
1274 | (setq entry (car completions) | |
1275 | pcomplete-current-completions completions))) | |
1276 | ((and pcomplete-recexact | |
1277 | (string-equal stub entry) | |
1278 | (member entry completions)) | |
1279 | ;; It's not unique, but user wants shortest match. | |
1280 | (message "Completed shortest") | |
1281 | (setq result 'shortest)) | |
1282 | ((or pcomplete-autolist | |
1283 | (string-equal stub entry)) | |
1284 | ;; It's not unique, list possible completions. | |
1285 | ;; FIXME: pay attention to boundaries. | |
1286 | (pcomplete-show-completions completions) | |
1287 | (setq result 'listed)) | |
1288 | (t | |
1289 | (message "Partially completed") | |
1290 | (setq result 'partial))) | |
1291 | (cons result entry))) | |
affbf647 GM |
1292 | |
1293 | ;; context sensitive help | |
1294 | ||
1295 | (defun pcomplete--help () | |
1296 | "Produce context-sensitive help for the current argument. | |
21a2e05d | 1297 | If specific documentation can't be given, be generic." |
affbf647 GM |
1298 | (if (and pcomplete-help |
1299 | (or (and (stringp pcomplete-help) | |
1300 | (fboundp 'Info-goto-node)) | |
1301 | (listp pcomplete-help))) | |
1302 | (if (listp pcomplete-help) | |
8a26c165 | 1303 | (message "%s" (eval pcomplete-help)) |
affbf647 GM |
1304 | (save-window-excursion (info)) |
1305 | (switch-to-buffer-other-window "*info*") | |
1306 | (funcall (symbol-function 'Info-goto-node) pcomplete-help)) | |
1307 | (if pcomplete-man-function | |
1308 | (let ((cmd (funcall pcomplete-command-name-function))) | |
1309 | (if (and cmd (> (length cmd) 0)) | |
1310 | (funcall pcomplete-man-function cmd))) | |
1311 | (message "No context-sensitive help available")))) | |
1312 | ||
1313 | ;; general utilities | |
1314 | ||
affbf647 GM |
1315 | (defun pcomplete-pare-list (l r &optional pred) |
1316 | "Destructively remove from list L all elements matching any in list R. | |
1317 | Test is done using `equal'. | |
1318 | If PRED is non-nil, it is a function used for further removal. | |
1319 | Returns the resultant list." | |
1320 | (while (and l (or (and r (member (car l) r)) | |
1321 | (and pred | |
1322 | (funcall pred (car l))))) | |
1323 | (setq l (cdr l))) | |
1324 | (let ((m l)) | |
1325 | (while m | |
1326 | (while (and (cdr m) | |
1327 | (or (and r (member (cadr m) r)) | |
1328 | (and pred | |
1329 | (funcall pred (cadr m))))) | |
1330 | (setcdr m (cddr m))) | |
1331 | (setq m (cdr m)))) | |
1332 | l) | |
1333 | ||
1334 | (defun pcomplete-uniqify-list (l) | |
1335 | "Sort and remove multiples in L." | |
1336 | (setq l (sort l 'string-lessp)) | |
1337 | (let ((m l)) | |
1338 | (while m | |
1339 | (while (and (cdr m) | |
1340 | (string= (car m) | |
1341 | (cadr m))) | |
1342 | (setcdr m (cddr m))) | |
1343 | (setq m (cdr m)))) | |
1344 | l) | |
1345 | ||
1346 | (defun pcomplete-process-result (cmd &rest args) | |
1347 | "Call CMD using `call-process' and return the simplest result." | |
1348 | (with-temp-buffer | |
1349 | (apply 'call-process cmd nil t nil args) | |
1350 | (skip-chars-backward "\n") | |
1351 | (buffer-substring (point-min) (point)))) | |
1352 | ||
1353 | ;; create a set of aliases which allow completion functions to be not | |
1354 | ;; quite so verbose | |
1355 | ||
3b067af1 SM |
1356 | ;;; jww (1999-10-20): are these a good idea? |
1357 | ;; (defalias 'pc-here 'pcomplete-here) | |
1358 | ;; (defalias 'pc-test 'pcomplete-test) | |
1359 | ;; (defalias 'pc-opt 'pcomplete-opt) | |
1360 | ;; (defalias 'pc-match 'pcomplete-match) | |
1361 | ;; (defalias 'pc-match-string 'pcomplete-match-string) | |
1362 | ;; (defalias 'pc-match-beginning 'pcomplete-match-beginning) | |
1363 | ;; (defalias 'pc-match-end 'pcomplete-match-end) | |
1364 | ||
1365 | (provide 'pcomplete) | |
affbf647 | 1366 | |
cbee283d | 1367 | ;; arch-tag: ae32ef2d-dbed-4244-8b0f-cf5a2a3b07a4 |
affbf647 | 1368 | ;;; pcomplete.el ends here |