Mercurial > emacs
annotate lisp/pcomplete.el @ 104894:7f459491fb93
* nsfont.m (ns_get_family): Don't force first letter to uppercase.
author | Adrian Robert <Adrian.B.Robert@gmail.com> |
---|---|
date | Wed, 09 Sep 2009 15:05:47 +0000 |
parents | a75fa842931b |
children | e044a3c6a7e6 |
rev | line source |
---|---|
38436
b174db545cfd
Some fixes to follow coding conventions.
Pavel Janík <Pavel@Janik.cz>
parents:
35588
diff
changeset
|
1 ;;; pcomplete.el --- programmable completion |
29876 | 2 |
64762
41bb365f41c4
Update years in copyright notice; nfc.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
64091
diff
changeset
|
3 ;; Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004 |
100908 | 4 ;; 2005, 2006, 2007, 2008, 2009 Free Software Foundation, Inc. |
29876 | 5 |
6 ;; Author: John Wiegley <johnw@gnu.org> | |
32502
de05ca05f4ff
(pcomplete) <defgroup>: Add :version.
Dave Love <fx@gnu.org>
parents:
32451
diff
changeset
|
7 ;; Keywords: processes abbrev |
29876 | 8 |
9 ;; This file is part of GNU Emacs. | |
10 | |
94678
ee5932bf781d
Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents:
93975
diff
changeset
|
11 ;; GNU Emacs is free software: you can redistribute it and/or modify |
29876 | 12 ;; it under the terms of the GNU General Public License as published by |
94678
ee5932bf781d
Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents:
93975
diff
changeset
|
13 ;; the Free Software Foundation, either version 3 of the License, or |
ee5932bf781d
Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents:
93975
diff
changeset
|
14 ;; (at your option) any later version. |
29876 | 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 | |
94678
ee5932bf781d
Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents:
93975
diff
changeset
|
22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. |
29876 | 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 ;; | |
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 | |
63 ;; `pcomplete-completions'. The value must be the list of possible | |
64 ;; completions for the final argument. | |
65 ;; | |
66 ;; @ To simplify completion function logic, the tag `pcompleted' may | |
67 ;; be thrown with a value of nil in order to abort the function. It | |
68 ;; means that there were no completions available. | |
69 ;; | |
70 ;; When a completion function is called, the variable `pcomplete-args' | |
71 ;; is in scope, and contains all of the arguments specified on the | |
72 ;; command line. The variable `pcomplete-last' is the index of the | |
73 ;; last argument in that list. | |
74 ;; | |
75 ;; The variable `pcomplete-index' is used by the completion code to | |
76 ;; know which argument the completion function is currently examining. | |
77 ;; It always begins at 1, meaning the first argument after the command | |
78 ;; name. | |
79 ;; | |
80 ;; To facilitate writing completion logic, a special macro, | |
81 ;; `pcomplete-here', has been provided which does several things: | |
82 ;; | |
83 ;; 1. It will throw `pcompleted' (with a value of nil) whenever | |
84 ;; `pcomplete-index' exceeds `pcomplete-last'. | |
85 ;; | |
86 ;; 2. It will increment `pcomplete-index' if the final argument has | |
87 ;; not been reached yet. | |
88 ;; | |
89 ;; 3. It will evaluate the form passed to it, and throw the result | |
90 ;; using the `pcomplete-completions' tag, if it is called when | |
91 ;; `pcomplete-index' is pointing to the final argument. | |
92 ;; | |
93 ;; Sometimes a completion function will want to vary the possible | |
94 ;; completions for an argument based on the previous one. To | |
95 ;; facilitate tests like this, the function `pcomplete-test' and | |
96 ;; `pcomplete-match' are provided. Called with one argument, they | |
97 ;; test the value of the previous command argument. Otherwise, a | |
98 ;; relative index may be given as an optional second argument, where 0 | |
99 ;; refers to the current argument, 1 the previous, 2 the one before | |
100 ;; that, etc. The symbols `first' and `last' specify absolute | |
101 ;; offsets. | |
102 ;; | |
103 ;; Here is an example which will only complete against directories for | |
104 ;; the second argument if the first argument is also a directory: | |
105 ;; | |
106 ;; (defun pcomplete/example () | |
107 ;; (pcomplete-here (pcomplete-entries)) | |
108 ;; (if (pcomplete-test 'file-directory-p) | |
109 ;; (pcomplete-here (pcomplete-dirs)) | |
110 ;; (pcomplete-here (pcomplete-entries)))) | |
111 ;; | |
112 ;; For generating completion lists based on directory contents, see | |
113 ;; the functions `pcomplete-entries', `pcomplete-dirs', | |
114 ;; `pcomplete-executables' and `pcomplete-all-entries'. | |
115 ;; | |
116 ;; Consult the documentation for `pcomplete-here' for information | |
117 ;; about its other arguments. | |
118 | |
119 ;;; Code: | |
120 | |
121 (provide 'pcomplete) | |
122 | |
123 (defgroup pcomplete nil | |
124 "Programmable completion." | |
32502
de05ca05f4ff
(pcomplete) <defgroup>: Add :version.
Dave Love <fx@gnu.org>
parents:
32451
diff
changeset
|
125 :version "21.1" |
29876 | 126 :group 'processes) |
127 | |
128 ;;; User Variables: | |
129 | |
130 (defcustom pcomplete-file-ignore nil | |
100171 | 131 "A regexp of filenames to be disregarded during file completion." |
35588 | 132 :type '(choice regexp (const :tag "None" nil)) |
29876 | 133 :group 'pcomplete) |
134 | |
135 (defcustom pcomplete-dir-ignore nil | |
100171 | 136 "A regexp of names to be disregarded during directory completion." |
35588 | 137 :type '(choice regexp (const :tag "None" nil)) |
29876 | 138 :group 'pcomplete) |
139 | |
49549
99be3a1e2589
Cygwin support patch.
Juanma Barranquero <lekktu@gmail.com>
parents:
49131
diff
changeset
|
140 (defcustom pcomplete-ignore-case (memq system-type '(ms-dos windows-nt cygwin)) |
100171 | 141 "If non-nil, ignore case when doing filename completion." |
29876 | 142 :type 'boolean |
143 :group 'pcomplete) | |
144 | |
145 (defcustom pcomplete-autolist nil | |
100171 | 146 "If non-nil, automatically list possibilities on partial completion. |
29876 | 147 This mirrors the optional behavior of tcsh." |
148 :type 'boolean | |
149 :group 'pcomplete) | |
150 | |
57745
d1fa1cbd6c4d
(pcomplete-entries): Don't use directory-sep-char.
Richard M. Stallman <rms@gnu.org>
parents:
57701
diff
changeset
|
151 (defcustom pcomplete-suffix-list (list ?/ ?:) |
100171 | 152 "A list of characters which constitute a proper suffix." |
29876 | 153 :type '(repeat character) |
154 :group 'pcomplete) | |
155 | |
156 (defcustom pcomplete-recexact nil | |
100171 | 157 "If non-nil, use shortest completion if characters cannot be added. |
29876 | 158 This mirrors the optional behavior of tcsh. |
159 | |
160 A non-nil value is useful if `pcomplete-autolist' is non-nil too." | |
161 :type 'boolean | |
162 :group 'pcomplete) | |
163 | |
164 (defcustom pcomplete-arg-quote-list nil | |
100171 | 165 "List of characters to quote when completing an argument." |
29876 | 166 :type '(choice (repeat character) |
167 (const :tag "Don't quote" nil)) | |
168 :group 'pcomplete) | |
169 | |
170 (defcustom pcomplete-quote-arg-hook nil | |
100171 | 171 "A hook which is run to quote a character within a filename. |
29876 | 172 Each function is passed both the filename to be quoted, and the index |
173 to be considered. If the function wishes to provide an alternate | |
174 quoted form, it need only return the replacement string. If no | |
175 function provides a replacement, quoting shall proceed as normal, | |
176 using a backslash to quote any character which is a member of | |
177 `pcomplete-arg-quote-list'." | |
178 :type 'hook | |
179 :group 'pcomplete) | |
180 | |
181 (defcustom pcomplete-man-function 'man | |
100171 | 182 "A function to that will be called to display a manual page. |
29876 | 183 It will be passed the name of the command to document." |
184 :type 'function | |
185 :group 'pcomplete) | |
186 | |
187 (defcustom pcomplete-compare-entry-function 'string-lessp | |
100171 | 188 "This function is used to order file entries for completion. |
29876 | 189 The behavior of most all shells is to sort alphabetically." |
190 :type '(radio (function-item string-lessp) | |
191 (function-item file-newer-than-file-p) | |
192 (function :tag "Other")) | |
193 :group 'pcomplete) | |
194 | |
195 (defcustom pcomplete-help nil | |
100171 | 196 "A string or function (or nil) used for context-sensitive help. |
29876 | 197 If a string, it should name an Info node that will be jumped to. |
198 If non-nil, it must a sexp that will be evaluated, and whose | |
199 result will be shown in the minibuffer. | |
200 If nil, the function `pcomplete-man-function' will be called with the | |
201 current command argument." | |
202 :type '(choice string sexp (const :tag "Use man page" nil)) | |
203 :group 'pcomplete) | |
204 | |
205 (defcustom pcomplete-expand-before-complete nil | |
100171 | 206 "If non-nil, expand the current argument before completing it. |
29876 | 207 This means that typing something such as '$HOME/bi' followed by |
208 \\[pcomplete-argument] will cause the variable reference to be | |
209 resolved first, and the resultant value that will be completed against | |
210 to be inserted in the buffer. Note that exactly what gets expanded | |
211 and how is entirely up to the behavior of the | |
212 `pcomplete-parse-arguments-function'." | |
213 :type 'boolean | |
214 :group 'pcomplete) | |
215 | |
216 (defcustom pcomplete-parse-arguments-function | |
217 'pcomplete-parse-buffer-arguments | |
100171 | 218 "A function to call to parse the current line's arguments. |
29876 | 219 It should be called with no parameters, and with point at the position |
220 of the argument that is to be completed. | |
221 | |
222 It must either return nil, or a cons cell of the form: | |
223 | |
224 ((ARG...) (BEG-POS...)) | |
225 | |
226 The two lists must be identical in length. The first gives the final | |
227 value of each command line argument (which need not match the textual | |
228 representation of that argument), and BEG-POS gives the beginning | |
229 position of each argument, as it is seen by the user. The establishes | |
230 a relationship between the fully resolved value of the argument, and | |
231 the textual representation of the argument." | |
232 :type 'function | |
233 :group 'pcomplete) | |
234 | |
235 (defcustom pcomplete-cycle-completions t | |
100171 | 236 "If non-nil, hitting the TAB key cycles through the completion list. |
29876 | 237 Typical Emacs behavior is to complete as much as possible, then pause |
238 waiting for further input. Then if TAB is hit again, show a list of | |
239 possible completions. When `pcomplete-cycle-completions' is non-nil, | |
240 it acts more like zsh or 4nt, showing the first maximal match first, | |
241 followed by any further matches on each subsequent pressing of the TAB | |
242 key. \\[pcomplete-list] is the key to press if the user wants to see | |
243 the list of possible completions." | |
244 :type 'boolean | |
245 :group 'pcomplete) | |
246 | |
247 (defcustom pcomplete-cycle-cutoff-length 5 | |
100171 | 248 "If the number of completions is greater than this, don't cycle. |
29876 | 249 This variable is a compromise between the traditional Emacs style of |
250 completion, and the \"cycling\" style. Basically, if there are more | |
251 than this number of completions possible, don't automatically pick the | |
252 first one and then expect the user to press TAB to cycle through them. | |
253 Typically, when there are a large number of completion possibilities, | |
254 the user wants to see them in a list buffer so that they can know what | |
255 options are available. But if the list is small, it means the user | |
256 has already entered enough input to disambiguate most of the | |
257 possibilities, and therefore they are probably most interested in | |
258 cycling through the candidates. Set this value to nil if you want | |
259 cycling to always be enabled." | |
260 :type '(choice integer (const :tag "Always cycle" nil)) | |
261 :group 'pcomplete) | |
262 | |
263 (defcustom pcomplete-restore-window-delay 1 | |
100171 | 264 "The number of seconds to wait before restoring completion windows. |
29876 | 265 Once the completion window has been displayed, if the user then goes |
266 on to type something else, that completion window will be removed from | |
267 the display (actually, the original window configuration before it was | |
268 displayed will be restored), after this many seconds of idle time. If | |
269 set to nil, completion windows will be left on second until the user | |
270 removes them manually. If set to 0, they will disappear immediately | |
271 after the user enters a key other than TAB." | |
272 :type '(choice integer (const :tag "Never restore" nil)) | |
273 :group 'pcomplete) | |
274 | |
275 (defcustom pcomplete-try-first-hook nil | |
100171 | 276 "A list of functions which are called before completing an argument. |
29876 | 277 This can be used, for example, for completing things which might apply |
278 to all arguments, such as variable names after a $." | |
279 :type 'hook | |
280 :group 'pcomplete) | |
281 | |
86234
860a7a8e779e
* progmodes/octave-mod.el (inferior-octave-send-list-and-digest):
Dan Nicolaescu <dann@ics.uci.edu>
parents:
86202
diff
changeset
|
282 (defsubst pcomplete-executables (&optional regexp) |
860a7a8e779e
* progmodes/octave-mod.el (inferior-octave-send-list-and-digest):
Dan Nicolaescu <dann@ics.uci.edu>
parents:
86202
diff
changeset
|
283 "Complete amongst a list of directories and executables." |
860a7a8e779e
* progmodes/octave-mod.el (inferior-octave-send-list-and-digest):
Dan Nicolaescu <dann@ics.uci.edu>
parents:
86202
diff
changeset
|
284 (pcomplete-entries regexp 'file-executable-p)) |
860a7a8e779e
* progmodes/octave-mod.el (inferior-octave-send-list-and-digest):
Dan Nicolaescu <dann@ics.uci.edu>
parents:
86202
diff
changeset
|
285 |
29876 | 286 (defcustom pcomplete-command-completion-function |
287 (function | |
288 (lambda () | |
289 (pcomplete-here (pcomplete-executables)))) | |
100171 | 290 "Function called for completing the initial command argument." |
29876 | 291 :type 'function |
292 :group 'pcomplete) | |
293 | |
294 (defcustom pcomplete-command-name-function 'pcomplete-command-name | |
100171 | 295 "Function called for determining the current command name." |
29876 | 296 :type 'function |
297 :group 'pcomplete) | |
298 | |
299 (defcustom pcomplete-default-completion-function | |
300 (function | |
301 (lambda () | |
302 (while (pcomplete-here (pcomplete-entries))))) | |
100171 | 303 "Function called when no completion rule can be found. |
29876 | 304 This function is used to generate completions for every argument." |
305 :type 'function | |
306 :group 'pcomplete) | |
307 | |
31241 | 308 (defcustom pcomplete-use-paring t |
100171 | 309 "If t, pare alternatives that have already been used. |
31241 | 310 If nil, you will always see the completion set of possible options, no |
311 matter which of those options have already been used in previous | |
312 command arguments." | |
313 :type 'boolean | |
314 :group 'pcomplete) | |
315 | |
49131
c814bafa1987
(pcomplete-termination-string): Added a variable for modifying the
John Wiegley <johnw@newartisans.com>
parents:
46818
diff
changeset
|
316 (defcustom pcomplete-termination-string " " |
100171 | 317 "A string that is inserted after any completion or expansion. |
49131
c814bafa1987
(pcomplete-termination-string): Added a variable for modifying the
John Wiegley <johnw@newartisans.com>
parents:
46818
diff
changeset
|
318 This is usually a space character, useful when completing lists of |
c814bafa1987
(pcomplete-termination-string): Added a variable for modifying the
John Wiegley <johnw@newartisans.com>
parents:
46818
diff
changeset
|
319 words separated by spaces. However, if your list uses a different |
c814bafa1987
(pcomplete-termination-string): Added a variable for modifying the
John Wiegley <johnw@newartisans.com>
parents:
46818
diff
changeset
|
320 separator character, or if the completion occurs in a word that is |
c814bafa1987
(pcomplete-termination-string): Added a variable for modifying the
John Wiegley <johnw@newartisans.com>
parents:
46818
diff
changeset
|
321 already terminated by a character, this variable should be locally |
c814bafa1987
(pcomplete-termination-string): Added a variable for modifying the
John Wiegley <johnw@newartisans.com>
parents:
46818
diff
changeset
|
322 modified to be an empty string, or the desired separation string." |
c814bafa1987
(pcomplete-termination-string): Added a variable for modifying the
John Wiegley <johnw@newartisans.com>
parents:
46818
diff
changeset
|
323 :type 'string |
c814bafa1987
(pcomplete-termination-string): Added a variable for modifying the
John Wiegley <johnw@newartisans.com>
parents:
46818
diff
changeset
|
324 :group 'pcomplete) |
c814bafa1987
(pcomplete-termination-string): Added a variable for modifying the
John Wiegley <johnw@newartisans.com>
parents:
46818
diff
changeset
|
325 |
29876 | 326 ;;; Internal Variables: |
327 | |
328 ;; for cycling completion support | |
329 (defvar pcomplete-current-completions nil) | |
330 (defvar pcomplete-last-completion-length) | |
331 (defvar pcomplete-last-completion-stub) | |
332 (defvar pcomplete-last-completion-raw) | |
333 (defvar pcomplete-last-window-config nil) | |
334 (defvar pcomplete-window-restore-timer nil) | |
335 | |
336 (make-variable-buffer-local 'pcomplete-current-completions) | |
337 (make-variable-buffer-local 'pcomplete-last-completion-length) | |
338 (make-variable-buffer-local 'pcomplete-last-completion-stub) | |
339 (make-variable-buffer-local 'pcomplete-last-completion-raw) | |
340 (make-variable-buffer-local 'pcomplete-last-window-config) | |
341 (make-variable-buffer-local 'pcomplete-window-restore-timer) | |
342 | |
343 ;; used for altering pcomplete's behavior. These global variables | |
344 ;; should always be nil. | |
345 (defvar pcomplete-show-help nil) | |
346 (defvar pcomplete-show-list nil) | |
347 (defvar pcomplete-expand-only-p nil) | |
348 | |
349 ;;; User Functions: | |
350 | |
351 ;;;###autoload | |
57701
28c08e3b5530
(pcomplete): Instead of interactive-p,
Richard M. Stallman <rms@gnu.org>
parents:
55205
diff
changeset
|
352 (defun pcomplete (&optional interactively) |
29876 | 353 "Support extensible programmable completion. |
354 To use this function, just bind the TAB key to it, or add it to your | |
355 completion functions list (it should occur fairly early in the list)." | |
57701
28c08e3b5530
(pcomplete): Instead of interactive-p,
Richard M. Stallman <rms@gnu.org>
parents:
55205
diff
changeset
|
356 (interactive "p") |
28c08e3b5530
(pcomplete): Instead of interactive-p,
Richard M. Stallman <rms@gnu.org>
parents:
55205
diff
changeset
|
357 (if (and interactively |
29876 | 358 pcomplete-cycle-completions |
359 pcomplete-current-completions | |
360 (memq last-command '(pcomplete | |
361 pcomplete-expand-and-complete | |
362 pcomplete-reverse))) | |
363 (progn | |
364 (delete-backward-char pcomplete-last-completion-length) | |
365 (if (eq this-command 'pcomplete-reverse) | |
366 (progn | |
367 (setq pcomplete-current-completions | |
368 (cons (car (last pcomplete-current-completions)) | |
369 pcomplete-current-completions)) | |
370 (setcdr (last pcomplete-current-completions 2) nil)) | |
371 (nconc pcomplete-current-completions | |
372 (list (car pcomplete-current-completions))) | |
373 (setq pcomplete-current-completions | |
374 (cdr pcomplete-current-completions))) | |
375 (pcomplete-insert-entry pcomplete-last-completion-stub | |
376 (car pcomplete-current-completions) | |
377 nil pcomplete-last-completion-raw)) | |
378 (setq pcomplete-current-completions nil | |
379 pcomplete-last-completion-raw nil) | |
380 (catch 'pcompleted | |
381 (let* ((pcomplete-stub) | |
382 pcomplete-seen pcomplete-norm-func | |
383 pcomplete-args pcomplete-last pcomplete-index | |
384 (pcomplete-autolist pcomplete-autolist) | |
385 (pcomplete-suffix-list pcomplete-suffix-list) | |
386 (completions (pcomplete-completions)) | |
387 (result (pcomplete-do-complete pcomplete-stub completions))) | |
388 (and result | |
389 (not (eq (car result) 'listed)) | |
390 (cdr result) | |
391 (pcomplete-insert-entry pcomplete-stub (cdr result) | |
392 (memq (car result) | |
393 '(sole shortest)) | |
394 pcomplete-last-completion-raw)))))) | |
395 | |
396 ;;;###autoload | |
397 (defun pcomplete-reverse () | |
398 "If cycling completion is in use, cycle backwards." | |
399 (interactive) | |
400 (call-interactively 'pcomplete)) | |
401 | |
402 ;;;###autoload | |
403 (defun pcomplete-expand-and-complete () | |
404 "Expand the textual value of the current argument. | |
405 This will modify the current buffer." | |
406 (interactive) | |
407 (let ((pcomplete-expand-before-complete t)) | |
408 (pcomplete))) | |
409 | |
410 ;;;###autoload | |
411 (defun pcomplete-continue () | |
412 "Complete without reference to any cycling completions." | |
413 (interactive) | |
414 (setq pcomplete-current-completions nil | |
415 pcomplete-last-completion-raw nil) | |
416 (call-interactively 'pcomplete)) | |
417 | |
418 ;;;###autoload | |
419 (defun pcomplete-expand () | |
420 "Expand the textual value of the current argument. | |
421 This will modify the current buffer." | |
422 (interactive) | |
423 (let ((pcomplete-expand-before-complete t) | |
424 (pcomplete-expand-only-p t)) | |
425 (pcomplete) | |
426 (when (and pcomplete-current-completions | |
427 (> (length pcomplete-current-completions) 0)) | |
428 (delete-backward-char pcomplete-last-completion-length) | |
429 (while pcomplete-current-completions | |
430 (unless (pcomplete-insert-entry | |
431 "" (car pcomplete-current-completions) t | |
432 pcomplete-last-completion-raw) | |
49131
c814bafa1987
(pcomplete-termination-string): Added a variable for modifying the
John Wiegley <johnw@newartisans.com>
parents:
46818
diff
changeset
|
433 (insert-and-inherit pcomplete-termination-string)) |
29876 | 434 (setq pcomplete-current-completions |
435 (cdr pcomplete-current-completions)))))) | |
436 | |
437 ;;;###autoload | |
438 (defun pcomplete-help () | |
439 "Display any help information relative to the current argument." | |
440 (interactive) | |
441 (let ((pcomplete-show-help t)) | |
442 (pcomplete))) | |
443 | |
444 ;;;###autoload | |
445 (defun pcomplete-list () | |
446 "Show the list of possible completions for the current argument." | |
447 (interactive) | |
448 (when (and pcomplete-cycle-completions | |
449 pcomplete-current-completions | |
450 (eq last-command 'pcomplete-argument)) | |
451 (delete-backward-char pcomplete-last-completion-length) | |
452 (setq pcomplete-current-completions nil | |
453 pcomplete-last-completion-raw nil)) | |
454 (let ((pcomplete-show-list t)) | |
455 (pcomplete))) | |
456 | |
457 ;;; Internal Functions: | |
458 | |
459 ;; argument handling | |
460 | |
461 ;; for the sake of the bye-compiler, when compiling other files that | |
462 ;; contain completion functions | |
463 (defvar pcomplete-args nil) | |
464 (defvar pcomplete-begins nil) | |
465 (defvar pcomplete-last nil) | |
466 (defvar pcomplete-index nil) | |
467 (defvar pcomplete-stub nil) | |
468 (defvar pcomplete-seen nil) | |
469 (defvar pcomplete-norm-func nil) | |
470 | |
471 (defun pcomplete-arg (&optional index offset) | |
472 "Return the textual content of the INDEXth argument. | |
473 INDEX is based from the current processing position. If INDEX is | |
474 positive, values returned are closer to the command argument; if | |
475 negative, they are closer to the last argument. If the INDEX is | |
476 outside of the argument list, nil is returned. The default value for | |
477 INDEX is 0, meaning the current argument being examined. | |
478 | |
479 The special indices `first' and `last' may be used to access those | |
480 parts of the list. | |
481 | |
482 The OFFSET argument is added to/taken away from the index that will be | |
483 used. This is really only useful with `first' and `last', for | |
484 accessing absolute argument positions." | |
485 (setq index | |
486 (if (eq index 'first) | |
487 0 | |
488 (if (eq index 'last) | |
489 pcomplete-last | |
490 (- pcomplete-index (or index 0))))) | |
491 (if offset | |
492 (setq index (+ index offset))) | |
493 (nth index pcomplete-args)) | |
494 | |
495 (defun pcomplete-begin (&optional index offset) | |
496 "Return the beginning position of the INDEXth argument. | |
497 See the documentation for `pcomplete-arg'." | |
498 (setq index | |
499 (if (eq index 'first) | |
500 0 | |
501 (if (eq index 'last) | |
502 pcomplete-last | |
503 (- pcomplete-index (or index 0))))) | |
504 (if offset | |
505 (setq index (+ index offset))) | |
506 (nth index pcomplete-begins)) | |
507 | |
508 (defsubst pcomplete-actual-arg (&optional index offset) | |
509 "Return the actual text representation of the last argument. | |
55105
7438df87d96a
(pcomplete-opt, pcomplete-actual-arg, pcomplete-match-string,
Juanma Barranquero <lekktu@gmail.com>
parents:
52401
diff
changeset
|
510 This is different from `pcomplete-arg', which returns the textual value |
29876 | 511 that the last argument evaluated to. This function returns what the |
512 user actually typed in." | |
513 (buffer-substring (pcomplete-begin index offset) (point))) | |
514 | |
515 (defsubst pcomplete-next-arg () | |
516 "Move the various pointers to the next argument." | |
517 (setq pcomplete-index (1+ pcomplete-index) | |
518 pcomplete-stub (pcomplete-arg)) | |
519 (if (> pcomplete-index pcomplete-last) | |
520 (progn | |
521 (message "No completions") | |
522 (throw 'pcompleted nil)))) | |
523 | |
524 (defun pcomplete-command-name () | |
525 "Return the command name of the first argument." | |
526 (file-name-nondirectory (pcomplete-arg 'first))) | |
527 | |
528 (defun pcomplete-match (regexp &optional index offset start) | |
529 "Like `string-match', but on the current completion argument." | |
530 (let ((arg (pcomplete-arg (or index 1) offset))) | |
531 (if arg | |
532 (string-match regexp arg start) | |
533 (throw 'pcompleted nil)))) | |
534 | |
535 (defun pcomplete-match-string (which &optional index offset) | |
55105
7438df87d96a
(pcomplete-opt, pcomplete-actual-arg, pcomplete-match-string,
Juanma Barranquero <lekktu@gmail.com>
parents:
52401
diff
changeset
|
536 "Like `match-string', but on the current completion argument." |
29876 | 537 (let ((arg (pcomplete-arg (or index 1) offset))) |
538 (if arg | |
539 (match-string which arg) | |
540 (throw 'pcompleted nil)))) | |
541 | |
542 (defalias 'pcomplete-match-beginning 'match-beginning) | |
543 (defalias 'pcomplete-match-end 'match-end) | |
544 | |
545 (defsubst pcomplete--test (pred arg) | |
546 "Perform a programmable completion predicate match." | |
547 (and pred | |
548 (cond ((eq pred t) t) | |
549 ((functionp pred) | |
550 (funcall pred arg)) | |
551 ((stringp pred) | |
552 (string-match (concat "^" pred "$") arg))) | |
553 pred)) | |
554 | |
555 (defun pcomplete-test (predicates &optional index offset) | |
556 "Predicates to test the current programmable argument with." | |
557 (let ((arg (pcomplete-arg (or index 1) offset))) | |
558 (unless (null predicates) | |
559 (if (not (listp predicates)) | |
560 (pcomplete--test predicates arg) | |
561 (let ((pred predicates) | |
562 found) | |
563 (while (and pred (not found)) | |
564 (setq found (pcomplete--test (car pred) arg) | |
565 pred (cdr pred))) | |
566 found))))) | |
567 | |
568 (defun pcomplete-parse-buffer-arguments () | |
569 "Parse whitespace separated arguments in the current region." | |
570 (let ((begin (point-min)) | |
571 (end (point-max)) | |
572 begins args) | |
573 (save-excursion | |
574 (goto-char begin) | |
575 (while (< (point) end) | |
576 (skip-chars-forward " \t\n") | |
577 (setq begins (cons (point) begins)) | |
578 (skip-chars-forward "^ \t\n") | |
579 (setq args (cons (buffer-substring-no-properties | |
580 (car begins) (point)) | |
581 args))) | |
582 (cons (reverse args) (reverse begins))))) | |
583 | |
584 ;;;###autoload | |
585 (defun pcomplete-comint-setup (completef-sym) | |
586 "Setup a comint buffer to use pcomplete. | |
587 COMPLETEF-SYM should be the symbol where the | |
55105
7438df87d96a
(pcomplete-opt, pcomplete-actual-arg, pcomplete-match-string,
Juanma Barranquero <lekktu@gmail.com>
parents:
52401
diff
changeset
|
588 dynamic-complete-functions are kept. For comint mode itself, |
7438df87d96a
(pcomplete-opt, pcomplete-actual-arg, pcomplete-match-string,
Juanma Barranquero <lekktu@gmail.com>
parents:
52401
diff
changeset
|
589 this is `comint-dynamic-complete-functions'." |
29876 | 590 (set (make-local-variable 'pcomplete-parse-arguments-function) |
591 'pcomplete-parse-comint-arguments) | |
592 (make-local-variable completef-sym) | |
103870
a75fa842931b
* pcomplete.el (pcomplete-comint-setup): Check for
Chong Yidong <cyd@stupidchicken.com>
parents:
100908
diff
changeset
|
593 (let* ((funs (symbol-value completef-sym)) |
a75fa842931b
* pcomplete.el (pcomplete-comint-setup): Check for
Chong Yidong <cyd@stupidchicken.com>
parents:
100908
diff
changeset
|
594 (elem (or (memq 'comint-dynamic-complete-filename funs) |
a75fa842931b
* pcomplete.el (pcomplete-comint-setup): Check for
Chong Yidong <cyd@stupidchicken.com>
parents:
100908
diff
changeset
|
595 (memq 'shell-dynamic-complete-filename funs)))) |
29876 | 596 (if elem |
597 (setcar elem 'pcomplete) | |
46769
8bb6a2e5d6bd
(pcomplete-comint-setup): Use `add-to-list', to prevent adding the
John Wiegley <johnw@newartisans.com>
parents:
46762
diff
changeset
|
598 (add-to-list completef-sym 'pcomplete)))) |
29876 | 599 |
600 ;;;###autoload | |
601 (defun pcomplete-shell-setup () | |
602 "Setup shell-mode to use pcomplete." | |
603 (pcomplete-comint-setup 'shell-dynamic-complete-functions)) | |
604 | |
86234
860a7a8e779e
* progmodes/octave-mod.el (inferior-octave-send-list-and-digest):
Dan Nicolaescu <dann@ics.uci.edu>
parents:
86202
diff
changeset
|
605 (declare-function comint-bol "comint" (&optional arg)) |
860a7a8e779e
* progmodes/octave-mod.el (inferior-octave-send-list-and-digest):
Dan Nicolaescu <dann@ics.uci.edu>
parents:
86202
diff
changeset
|
606 |
29876 | 607 (defun pcomplete-parse-comint-arguments () |
608 "Parse whitespace separated arguments in the current region." | |
609 (let ((begin (save-excursion (comint-bol nil) (point))) | |
610 (end (point)) | |
611 begins args) | |
612 (save-excursion | |
613 (goto-char begin) | |
614 (while (< (point) end) | |
615 (skip-chars-forward " \t\n") | |
616 (setq begins (cons (point) begins)) | |
617 (let ((skip t)) | |
618 (while skip | |
619 (skip-chars-forward "^ \t\n") | |
620 (if (eq (char-before) ?\\) | |
621 (skip-chars-forward " \t\n") | |
622 (setq skip nil)))) | |
623 (setq args (cons (buffer-substring-no-properties | |
624 (car begins) (point)) | |
625 args))) | |
626 (cons (reverse args) (reverse begins))))) | |
627 | |
628 (defun pcomplete-parse-arguments (&optional expand-p) | |
629 "Parse the command line arguments. Most completions need this info." | |
630 (let ((results (funcall pcomplete-parse-arguments-function))) | |
631 (when results | |
632 (setq pcomplete-args (or (car results) (list "")) | |
633 pcomplete-begins (or (cdr results) (list (point))) | |
634 pcomplete-last (1- (length pcomplete-args)) | |
635 pcomplete-index 0 | |
636 pcomplete-stub (pcomplete-arg 'last)) | |
637 (let ((begin (pcomplete-begin 'last))) | |
638 (if (and pcomplete-cycle-completions | |
639 (listp pcomplete-stub) | |
640 (not pcomplete-expand-only-p)) | |
641 (let* ((completions pcomplete-stub) | |
642 (common-stub (car completions)) | |
643 (c completions) | |
644 (len (length common-stub))) | |
645 (while (and c (> len 0)) | |
646 (while (and (> len 0) | |
647 (not (string= | |
648 (substring common-stub 0 len) | |
649 (substring (car c) 0 | |
650 (min (length (car c)) | |
651 len))))) | |
652 (setq len (1- len))) | |
653 (setq c (cdr c))) | |
654 (setq pcomplete-stub (substring common-stub 0 len) | |
655 pcomplete-autolist t) | |
656 (when (and begin (not pcomplete-show-list)) | |
657 (delete-region begin (point)) | |
658 (pcomplete-insert-entry "" pcomplete-stub)) | |
659 (throw 'pcomplete-completions completions)) | |
660 (when expand-p | |
661 (if (stringp pcomplete-stub) | |
662 (when begin | |
663 (delete-region begin (point)) | |
664 (insert-and-inherit pcomplete-stub)) | |
665 (if (and (listp pcomplete-stub) | |
666 pcomplete-expand-only-p) | |
667 ;; this is for the benefit of `pcomplete-expand' | |
668 (setq pcomplete-last-completion-length (- (point) begin) | |
669 pcomplete-current-completions pcomplete-stub) | |
670 (error "Cannot expand argument")))) | |
671 (if pcomplete-expand-only-p | |
672 (throw 'pcompleted t) | |
673 pcomplete-args)))))) | |
674 | |
675 (defun pcomplete-quote-argument (filename) | |
676 "Return FILENAME with magic characters quoted. | |
677 Magic characters are those in `pcomplete-arg-quote-list'." | |
678 (if (null pcomplete-arg-quote-list) | |
679 filename | |
680 (let ((len (length filename)) | |
681 (index 0) | |
682 (result "") | |
683 replacement char) | |
684 (while (< index len) | |
685 (setq replacement (run-hook-with-args-until-success | |
686 'pcomplete-quote-arg-hook filename index)) | |
687 (cond | |
688 (replacement | |
689 (setq result (concat result replacement))) | |
690 ((and (setq char (aref filename index)) | |
691 (memq char pcomplete-arg-quote-list)) | |
692 (setq result (concat result "\\" (char-to-string char)))) | |
693 (t | |
694 (setq result (concat result (char-to-string char))))) | |
695 (setq index (1+ index))) | |
696 result))) | |
697 | |
698 ;; file-system completion lists | |
699 | |
700 (defsubst pcomplete-dirs-or-entries (&optional regexp predicate) | |
701 "Return either directories, or qualified entries." | |
702 (append (let ((pcomplete-stub pcomplete-stub)) | |
31326 | 703 (pcomplete-entries |
704 regexp (or predicate | |
705 (function | |
706 (lambda (path) | |
707 (not (file-directory-p path))))))) | |
29876 | 708 (pcomplete-entries nil 'file-directory-p))) |
709 | |
710 (defun pcomplete-entries (&optional regexp predicate) | |
711 "Complete against a list of directory candidates. | |
712 If REGEXP is non-nil, it is a regular expression used to refine the | |
713 match (files not matching the REGEXP will be excluded). | |
714 If PREDICATE is non-nil, it will also be used to refine the match | |
715 \(files for which the PREDICATE returns nil will be excluded). | |
46762
85cd02534241
(pcomplete-entries): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
43827
diff
changeset
|
716 If no directory information can be extracted from the completed |
55105
7438df87d96a
(pcomplete-opt, pcomplete-actual-arg, pcomplete-match-string,
Juanma Barranquero <lekktu@gmail.com>
parents:
52401
diff
changeset
|
717 component, `default-directory' is used as the basis for completion." |
43827
074094fab9d6
(pcomplete-entries): Expand environment variables in filename.
Miles Bader <miles@gnu.org>
parents:
38436
diff
changeset
|
718 (let* ((name (substitute-env-vars pcomplete-stub)) |
81823
d3277da93598
(pcomplete-entries): Obey pcomplete-ignore-case.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
81389
diff
changeset
|
719 (completion-ignore-case pcomplete-ignore-case) |
29876 | 720 (default-directory (expand-file-name |
721 (or (file-name-directory name) | |
722 default-directory))) | |
723 above-cutoff) | |
724 (setq name (file-name-nondirectory name) | |
725 pcomplete-stub name) | |
726 (let ((completions | |
727 (file-name-all-completions name default-directory))) | |
728 (if regexp | |
729 (setq completions | |
730 (pcomplete-pare-list | |
731 completions nil | |
732 (function | |
733 (lambda (file) | |
734 (not (string-match regexp file))))))) | |
735 (if predicate | |
736 (setq completions | |
737 (pcomplete-pare-list | |
738 completions nil | |
739 (function | |
740 (lambda (file) | |
741 (not (funcall predicate file))))))) | |
742 (if (or pcomplete-file-ignore pcomplete-dir-ignore) | |
743 (setq completions | |
744 (pcomplete-pare-list | |
745 completions nil | |
746 (function | |
747 (lambda (file) | |
748 (if (eq (aref file (1- (length file))) | |
57745
d1fa1cbd6c4d
(pcomplete-entries): Don't use directory-sep-char.
Richard M. Stallman <rms@gnu.org>
parents:
57701
diff
changeset
|
749 ?/) |
29876 | 750 (and pcomplete-dir-ignore |
751 (string-match pcomplete-dir-ignore file)) | |
752 (and pcomplete-file-ignore | |
753 (string-match pcomplete-file-ignore file)))))))) | |
46818
fa3f7092b7c3
(pcomplete-entries): Don't set `above-cutoff' to a value unless
John Wiegley <johnw@newartisans.com>
parents:
46769
diff
changeset
|
754 (setq above-cutoff (and pcomplete-cycle-cutoff-length |
fa3f7092b7c3
(pcomplete-entries): Don't set `above-cutoff' to a value unless
John Wiegley <johnw@newartisans.com>
parents:
46769
diff
changeset
|
755 (> (length completions) |
fa3f7092b7c3
(pcomplete-entries): Don't set `above-cutoff' to a value unless
John Wiegley <johnw@newartisans.com>
parents:
46769
diff
changeset
|
756 pcomplete-cycle-cutoff-length))) |
29876 | 757 (sort completions |
758 (function | |
759 (lambda (l r) | |
760 ;; for the purposes of comparison, remove the | |
761 ;; trailing slash from directory names. | |
762 ;; Otherwise, "foo.old/" will come before "foo/", | |
763 ;; since . is earlier in the ASCII alphabet than | |
764 ;; / | |
765 (let ((left (if (eq (aref l (1- (length l))) | |
57745
d1fa1cbd6c4d
(pcomplete-entries): Don't use directory-sep-char.
Richard M. Stallman <rms@gnu.org>
parents:
57701
diff
changeset
|
766 ?/) |
29876 | 767 (substring l 0 (1- (length l))) |
768 l)) | |
769 (right (if (eq (aref r (1- (length r))) | |
57745
d1fa1cbd6c4d
(pcomplete-entries): Don't use directory-sep-char.
Richard M. Stallman <rms@gnu.org>
parents:
57701
diff
changeset
|
770 ?/) |
29876 | 771 (substring r 0 (1- (length r))) |
772 r))) | |
773 (if above-cutoff | |
774 (string-lessp left right) | |
775 (funcall pcomplete-compare-entry-function | |
776 left right))))))))) | |
777 | |
778 (defsubst pcomplete-all-entries (&optional regexp predicate) | |
779 "Like `pcomplete-entries', but doesn't ignore any entries." | |
780 (let (pcomplete-file-ignore | |
781 pcomplete-dir-ignore) | |
782 (pcomplete-entries regexp predicate))) | |
783 | |
784 (defsubst pcomplete-dirs (&optional regexp) | |
785 "Complete amongst a list of directories." | |
786 (pcomplete-entries regexp 'file-directory-p)) | |
787 | |
788 ;; generation of completion lists | |
789 | |
790 (defun pcomplete-find-completion-function (command) | |
791 "Find the completion function to call for the given COMMAND." | |
792 (let ((sym (intern-soft | |
793 (concat "pcomplete/" (symbol-name major-mode) "/" command)))) | |
794 (unless sym | |
795 (setq sym (intern-soft (concat "pcomplete/" command)))) | |
796 (and sym (fboundp sym) sym))) | |
797 | |
798 (defun pcomplete-completions () | |
799 "Return a list of completions for the current argument position." | |
800 (catch 'pcomplete-completions | |
801 (when (pcomplete-parse-arguments pcomplete-expand-before-complete) | |
802 (if (= pcomplete-index pcomplete-last) | |
803 (funcall pcomplete-command-completion-function) | |
804 (let ((sym (or (pcomplete-find-completion-function | |
805 (funcall pcomplete-command-name-function)) | |
806 pcomplete-default-completion-function))) | |
807 (ignore | |
808 (pcomplete-next-arg) | |
809 (funcall sym))))))) | |
810 | |
811 (defun pcomplete-opt (options &optional prefix no-ganging args-follow) | |
812 "Complete a set of OPTIONS, each beginning with PREFIX (?- by default). | |
813 PREFIX may be t, in which case no PREFIX character is necessary. | |
55105
7438df87d96a
(pcomplete-opt, pcomplete-actual-arg, pcomplete-match-string,
Juanma Barranquero <lekktu@gmail.com>
parents:
52401
diff
changeset
|
814 If NO-GANGING is non-nil, each option is separate (-xy is not allowed). |
7438df87d96a
(pcomplete-opt, pcomplete-actual-arg, pcomplete-match-string,
Juanma Barranquero <lekktu@gmail.com>
parents:
52401
diff
changeset
|
815 If ARGS-FOLLOW is non-nil, then options which take arguments may have |
7438df87d96a
(pcomplete-opt, pcomplete-actual-arg, pcomplete-match-string,
Juanma Barranquero <lekktu@gmail.com>
parents:
52401
diff
changeset
|
816 the argument appear after a ganged set of options. This is how tar |
7438df87d96a
(pcomplete-opt, pcomplete-actual-arg, pcomplete-match-string,
Juanma Barranquero <lekktu@gmail.com>
parents:
52401
diff
changeset
|
817 behaves, for example." |
29876 | 818 (if (and (= pcomplete-index pcomplete-last) |
819 (string= (pcomplete-arg) "-")) | |
820 (let ((len (length options)) | |
821 (index 0) | |
822 char choices) | |
823 (while (< index len) | |
824 (setq char (aref options index)) | |
825 (if (eq char ?\() | |
826 (let ((result (read-from-string options index))) | |
827 (setq index (cdr result))) | |
828 (unless (memq char '(?/ ?* ?? ?.)) | |
829 (setq choices (cons (char-to-string char) choices))) | |
830 (setq index (1+ index)))) | |
831 (throw 'pcomplete-completions | |
832 (mapcar | |
833 (function | |
834 (lambda (opt) | |
835 (concat "-" opt))) | |
836 (pcomplete-uniqify-list choices)))) | |
837 (let ((arg (pcomplete-arg))) | |
838 (when (and (> (length arg) 1) | |
839 (stringp arg) | |
840 (eq (aref arg 0) (or prefix ?-))) | |
841 (pcomplete-next-arg) | |
842 (let ((char (aref arg 1)) | |
843 (len (length options)) | |
844 (index 0) | |
845 opt-char arg-char result) | |
846 (while (< (1+ index) len) | |
847 (setq opt-char (aref options index) | |
848 arg-char (aref options (1+ index))) | |
849 (if (eq arg-char ?\() | |
850 (setq result | |
851 (read-from-string options (1+ index)) | |
852 index (cdr result) | |
853 result (car result)) | |
854 (setq result nil)) | |
855 (when (and (eq char opt-char) | |
856 (memq arg-char '(?\( ?/ ?* ?? ?.))) | |
857 (if (< pcomplete-index pcomplete-last) | |
858 (pcomplete-next-arg) | |
859 (throw 'pcomplete-completions | |
860 (cond ((eq arg-char ?/) (pcomplete-dirs)) | |
861 ((eq arg-char ?*) (pcomplete-executables)) | |
862 ((eq arg-char ??) nil) | |
863 ((eq arg-char ?.) (pcomplete-entries)) | |
864 ((eq arg-char ?\() (eval result)))))) | |
865 (setq index (1+ index)))))))) | |
866 | |
867 (defun pcomplete--here (&optional form stub paring form-only) | |
55105
7438df87d96a
(pcomplete-opt, pcomplete-actual-arg, pcomplete-match-string,
Juanma Barranquero <lekktu@gmail.com>
parents:
52401
diff
changeset
|
868 "Complete against the current argument, if at the end. |
29876 | 869 See the documentation for `pcomplete-here'." |
870 (if (< pcomplete-index pcomplete-last) | |
871 (progn | |
872 (if (eq paring 0) | |
873 (setq pcomplete-seen nil) | |
874 (unless (eq paring t) | |
875 (let ((arg (pcomplete-arg))) | |
876 (unless (not (stringp arg)) | |
877 (setq pcomplete-seen | |
878 (cons (if paring | |
879 (funcall paring arg) | |
880 (file-truename arg)) | |
881 pcomplete-seen)))))) | |
882 (pcomplete-next-arg) | |
883 t) | |
884 (when pcomplete-show-help | |
885 (pcomplete--help) | |
886 (throw 'pcompleted t)) | |
887 (if stub | |
888 (setq pcomplete-stub stub)) | |
889 (if (or (eq paring t) (eq paring 0)) | |
890 (setq pcomplete-seen nil) | |
891 (setq pcomplete-norm-func (or paring 'file-truename))) | |
892 (unless form-only | |
893 (run-hooks 'pcomplete-try-first-hook)) | |
894 (throw 'pcomplete-completions (eval form)))) | |
895 | |
896 (defmacro pcomplete-here (&optional form stub paring form-only) | |
55105
7438df87d96a
(pcomplete-opt, pcomplete-actual-arg, pcomplete-match-string,
Juanma Barranquero <lekktu@gmail.com>
parents:
52401
diff
changeset
|
897 "Complete against the current argument, if at the end. |
29876 | 898 If completion is to be done here, evaluate FORM to generate the list |
899 of strings which will be used for completion purposes. If STUB is a | |
900 string, use it as the completion stub instead of the default (which is | |
901 the entire text of the current argument). | |
902 | |
903 For an example of when you might want to use STUB: if the current | |
904 argument text is 'long-path-name/', you don't want the completions | |
905 list display to be cluttered by 'long-path-name/' appearing at the | |
906 beginning of every alternative. Not only does this make things less | |
907 intelligle, but it is also inefficient. Yet, if the completion list | |
908 does not begin with this string for every entry, the current argument | |
909 won't complete correctly. | |
910 | |
911 The solution is to specify a relative stub. It allows you to | |
912 substitute a different argument from the current argument, almost | |
913 always for the sake of efficiency. | |
914 | |
915 If PARING is nil, this argument will be pared against previous | |
916 arguments using the function `file-truename' to normalize them. | |
55105
7438df87d96a
(pcomplete-opt, pcomplete-actual-arg, pcomplete-match-string,
Juanma Barranquero <lekktu@gmail.com>
parents:
52401
diff
changeset
|
917 PARING may be a function, in which case that function is used for |
7438df87d96a
(pcomplete-opt, pcomplete-actual-arg, pcomplete-match-string,
Juanma Barranquero <lekktu@gmail.com>
parents:
52401
diff
changeset
|
918 normalization. If PARING is t, the argument dealt with by this |
7438df87d96a
(pcomplete-opt, pcomplete-actual-arg, pcomplete-match-string,
Juanma Barranquero <lekktu@gmail.com>
parents:
52401
diff
changeset
|
919 call will not participate in argument paring. If it is the |
7438df87d96a
(pcomplete-opt, pcomplete-actual-arg, pcomplete-match-string,
Juanma Barranquero <lekktu@gmail.com>
parents:
52401
diff
changeset
|
920 integer 0, all previous arguments that have been seen will be |
7438df87d96a
(pcomplete-opt, pcomplete-actual-arg, pcomplete-match-string,
Juanma Barranquero <lekktu@gmail.com>
parents:
52401
diff
changeset
|
921 cleared. |
29876 | 922 |
923 If FORM-ONLY is non-nil, only the result of FORM will be used to | |
924 generate the completions list. This means that the hook | |
925 `pcomplete-try-first-hook' will not be run." | |
926 `(pcomplete--here (quote ,form) ,stub ,paring ,form-only)) | |
927 | |
928 (defmacro pcomplete-here* (&optional form stub form-only) | |
929 "An alternate form which does not participate in argument paring." | |
930 `(pcomplete-here ,form ,stub t ,form-only)) | |
931 | |
932 ;; display support | |
933 | |
934 (defun pcomplete-restore-windows () | |
935 "If the only window change was due to Completions, restore things." | |
936 (if pcomplete-last-window-config | |
937 (let* ((cbuf (get-buffer "*Completions*")) | |
938 (cwin (and cbuf (get-buffer-window cbuf)))) | |
81389
4e4dec192190
(pcomplete-restore-windows): Remove redundant check.
Juanma Barranquero <lekktu@gmail.com>
parents:
77053
diff
changeset
|
939 (when (window-live-p cwin) |
29876 | 940 (bury-buffer cbuf) |
941 (set-window-configuration pcomplete-last-window-config)))) | |
942 (setq pcomplete-last-window-config nil | |
943 pcomplete-window-restore-timer nil)) | |
944 | |
945 ;; Abstractions so that the code below will work for both Emacs 20 and | |
946 ;; XEmacs 21 | |
947 | |
86202
794e428cd497
* eshell/esh-util.el (eshell-under-xemacs-p): Remove.
Dan Nicolaescu <dann@ics.uci.edu>
parents:
82140
diff
changeset
|
948 (defalias 'pcomplete-event-matches-key-specifier-p |
794e428cd497
* eshell/esh-util.el (eshell-under-xemacs-p): Remove.
Dan Nicolaescu <dann@ics.uci.edu>
parents:
82140
diff
changeset
|
949 (if (featurep 'xemacs) |
794e428cd497
* eshell/esh-util.el (eshell-under-xemacs-p): Remove.
Dan Nicolaescu <dann@ics.uci.edu>
parents:
82140
diff
changeset
|
950 'event-matches-key-specifier-p |
794e428cd497
* eshell/esh-util.el (eshell-under-xemacs-p): Remove.
Dan Nicolaescu <dann@ics.uci.edu>
parents:
82140
diff
changeset
|
951 'eq)) |
29876 | 952 |
77053
6231e179c4db
(pcomplete-read-event): One single definition, and not a defsubst.
Richard M. Stallman <rms@gnu.org>
parents:
77015
diff
changeset
|
953 (defun pcomplete-read-event (&optional prompt) |
6231e179c4db
(pcomplete-read-event): One single definition, and not a defsubst.
Richard M. Stallman <rms@gnu.org>
parents:
77015
diff
changeset
|
954 (if (fboundp 'read-event) |
6231e179c4db
(pcomplete-read-event): One single definition, and not a defsubst.
Richard M. Stallman <rms@gnu.org>
parents:
77015
diff
changeset
|
955 (read-event prompt) |
29876 | 956 (aref (read-key-sequence prompt) 0))) |
957 | |
958 (defun pcomplete-show-completions (completions) | |
959 "List in help buffer sorted COMPLETIONS. | |
960 Typing SPC flushes the help buffer." | |
961 (let* ((curbuf (current-buffer))) | |
962 (when pcomplete-window-restore-timer | |
963 (cancel-timer pcomplete-window-restore-timer) | |
964 (setq pcomplete-window-restore-timer nil)) | |
965 (unless pcomplete-last-window-config | |
966 (setq pcomplete-last-window-config (current-window-configuration))) | |
967 (with-output-to-temp-buffer "*Completions*" | |
968 (display-completion-list completions)) | |
969 (message "Hit space to flush") | |
970 (let (event) | |
971 (prog1 | |
972 (catch 'done | |
973 (while (with-current-buffer (get-buffer "*Completions*") | |
59667
308beae8def9
2005-01-21 Ren?yllingstad <listmailxemacs@kyllingstad.com>
John Wiegley <johnw@newartisans.com>
parents:
57745
diff
changeset
|
974 (setq event (pcomplete-read-event))) |
29876 | 975 (cond |
86202
794e428cd497
* eshell/esh-util.el (eshell-under-xemacs-p): Remove.
Dan Nicolaescu <dann@ics.uci.edu>
parents:
82140
diff
changeset
|
976 ((pcomplete-event-matches-key-specifier-p event ?\s) |
29876 | 977 (set-window-configuration pcomplete-last-window-config) |
978 (setq pcomplete-last-window-config nil) | |
979 (throw 'done nil)) | |
86202
794e428cd497
* eshell/esh-util.el (eshell-under-xemacs-p): Remove.
Dan Nicolaescu <dann@ics.uci.edu>
parents:
82140
diff
changeset
|
980 ((or (pcomplete-event-matches-key-specifier-p event 'tab) |
69756
3a72c4c8b7ae
(pcomplete-show-completions): Recognize TAB on text terminals.
Eli Zaretskii <eliz@gnu.org>
parents:
68651
diff
changeset
|
981 ;; Needed on a terminal |
86202
794e428cd497
* eshell/esh-util.el (eshell-under-xemacs-p): Remove.
Dan Nicolaescu <dann@ics.uci.edu>
parents:
82140
diff
changeset
|
982 (pcomplete-event-matches-key-specifier-p event 9)) |
76349
df0cc74b8778
(pcomplete-show-completions): Improve last change, so
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
76342
diff
changeset
|
983 (let ((win (or (get-buffer-window "*Completions*" 0) |
df0cc74b8778
(pcomplete-show-completions): Improve last change, so
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
76342
diff
changeset
|
984 (display-buffer "*Completions*" |
df0cc74b8778
(pcomplete-show-completions): Improve last change, so
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
76342
diff
changeset
|
985 'not-this-window)))) |
df0cc74b8778
(pcomplete-show-completions): Improve last change, so
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
76342
diff
changeset
|
986 (with-selected-window win |
df0cc74b8778
(pcomplete-show-completions): Improve last change, so
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
76342
diff
changeset
|
987 (if (pos-visible-in-window-p (point-max)) |
df0cc74b8778
(pcomplete-show-completions): Improve last change, so
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
76342
diff
changeset
|
988 (goto-char (point-min)) |
df0cc74b8778
(pcomplete-show-completions): Improve last change, so
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
76342
diff
changeset
|
989 (scroll-up)))) |
29876 | 990 (message "")) |
991 (t | |
992 (setq unread-command-events (list event)) | |
993 (throw 'done nil))))) | |
994 (if (and pcomplete-last-window-config | |
995 pcomplete-restore-window-delay) | |
996 (setq pcomplete-window-restore-timer | |
997 (run-with-timer pcomplete-restore-window-delay nil | |
998 'pcomplete-restore-windows))))))) | |
999 | |
1000 ;; insert completion at point | |
1001 | |
1002 (defun pcomplete-insert-entry (stub entry &optional addsuffix raw-p) | |
1003 "Insert a completion entry at point. | |
1004 Returns non-nil if a space was appended at the end." | |
1005 (let ((here (point))) | |
1006 (if (not pcomplete-ignore-case) | |
1007 (insert-and-inherit (if raw-p | |
1008 (substring entry (length stub)) | |
1009 (pcomplete-quote-argument | |
1010 (substring entry (length stub))))) | |
1011 ;; the stub is not quoted at this time, so to determine the | |
1012 ;; length of what should be in the buffer, we must quote it | |
1013 (delete-backward-char (length (pcomplete-quote-argument stub))) | |
1014 ;; if there is already a backslash present to handle the first | |
1015 ;; character, don't bother quoting it | |
1016 (when (eq (char-before) ?\\) | |
1017 (insert-and-inherit (substring entry 0 1)) | |
1018 (setq entry (substring entry 1))) | |
1019 (insert-and-inherit (if raw-p | |
1020 entry | |
1021 (pcomplete-quote-argument entry)))) | |
1022 (let (space-added) | |
1023 (when (and (not (memq (char-before) pcomplete-suffix-list)) | |
1024 addsuffix) | |
49131
c814bafa1987
(pcomplete-termination-string): Added a variable for modifying the
John Wiegley <johnw@newartisans.com>
parents:
46818
diff
changeset
|
1025 (insert-and-inherit pcomplete-termination-string) |
29876 | 1026 (setq space-added t)) |
1027 (setq pcomplete-last-completion-length (- (point) here) | |
1028 pcomplete-last-completion-stub stub) | |
1029 space-added))) | |
1030 | |
1031 ;; selection of completions | |
1032 | |
1033 (defun pcomplete-do-complete (stub completions) | |
1034 "Dynamically complete at point using STUB and COMPLETIONS. | |
1035 This is basically just a wrapper for `pcomplete-stub' which does some | |
1036 extra checking, and munging of the COMPLETIONS list." | |
1037 (unless (stringp stub) | |
1038 (message "Cannot complete argument") | |
1039 (throw 'pcompleted nil)) | |
1040 (if (null completions) | |
1041 (ignore | |
1042 (if (and stub (> (length stub) 0)) | |
1043 (message "No completions of %s" stub) | |
1044 (message "No completions"))) | |
1045 ;; pare it down, if applicable | |
31241 | 1046 (if (and pcomplete-use-paring pcomplete-seen) |
29876 | 1047 (let* ((arg (pcomplete-arg)) |
1048 (prefix | |
1049 (file-name-as-directory | |
1050 (funcall pcomplete-norm-func | |
1051 (substring arg 0 (- (length arg) | |
1052 (length pcomplete-stub))))))) | |
1053 (setq pcomplete-seen | |
1054 (mapcar 'directory-file-name pcomplete-seen)) | |
1055 (let ((p pcomplete-seen)) | |
1056 (while p | |
1057 (add-to-list 'pcomplete-seen | |
1058 (funcall pcomplete-norm-func (car p))) | |
1059 (setq p (cdr p)))) | |
1060 (setq completions | |
1061 (mapcar | |
1062 (function | |
1063 (lambda (elem) | |
1064 (file-relative-name elem prefix))) | |
1065 (pcomplete-pare-list | |
1066 (mapcar | |
1067 (function | |
1068 (lambda (elem) | |
1069 (expand-file-name elem prefix))) | |
1070 completions) | |
1071 pcomplete-seen | |
1072 (function | |
1073 (lambda (elem) | |
1074 (member (directory-file-name | |
1075 (funcall pcomplete-norm-func elem)) | |
1076 pcomplete-seen)))))))) | |
1077 ;; OK, we've got a list of completions. | |
1078 (if pcomplete-show-list | |
1079 (pcomplete-show-completions completions) | |
1080 (pcomplete-stub stub completions)))) | |
1081 | |
1082 (defun pcomplete-stub (stub candidates &optional cycle-p) | |
1083 "Dynamically complete STUB from CANDIDATES list. | |
1084 This function inserts completion characters at point by completing | |
1085 STUB from the strings in CANDIDATES. A completions listing may be | |
1086 shown in a help buffer if completion is ambiguous. | |
1087 | |
1088 Returns nil if no completion was inserted. | |
1089 Returns `sole' if completed with the only completion match. | |
1090 Returns `shortest' if completed with the shortest of the matches. | |
1091 Returns `partial' if completed as far as possible with the matches. | |
1092 Returns `listed' if a completion listing was shown. | |
1093 | |
1094 See also `pcomplete-filename'." | |
1095 (let* ((completion-ignore-case pcomplete-ignore-case) | |
1096 (candidates (mapcar 'list candidates)) | |
1097 (completions (all-completions stub candidates))) | |
1098 (let (result entry) | |
1099 (cond | |
1100 ((null completions) | |
1101 (if (and stub (> (length stub) 0)) | |
1102 (message "No completions of %s" stub) | |
1103 (message "No completions"))) | |
1104 ((= 1 (length completions)) | |
1105 (setq entry (car completions)) | |
1106 (if (string-equal entry stub) | |
1107 (message "Sole completion")) | |
1108 (setq result 'sole)) | |
1109 ((and pcomplete-cycle-completions | |
1110 (or cycle-p | |
1111 (not pcomplete-cycle-cutoff-length) | |
1112 (<= (length completions) | |
1113 pcomplete-cycle-cutoff-length))) | |
1114 (setq entry (car completions) | |
1115 pcomplete-current-completions completions)) | |
1116 (t ; There's no unique completion; use longest substring | |
1117 (setq entry (try-completion stub candidates)) | |
1118 (cond ((and pcomplete-recexact | |
1119 (string-equal stub entry) | |
1120 (member entry completions)) | |
1121 ;; It's not unique, but user wants shortest match. | |
1122 (message "Completed shortest") | |
1123 (setq result 'shortest)) | |
1124 ((or pcomplete-autolist | |
1125 (string-equal stub entry)) | |
1126 ;; It's not unique, list possible completions. | |
1127 (pcomplete-show-completions completions) | |
1128 (setq result 'listed)) | |
1129 (t | |
1130 (message "Partially completed") | |
1131 (setq result 'partial))))) | |
1132 (cons result entry)))) | |
1133 | |
1134 ;; context sensitive help | |
1135 | |
1136 (defun pcomplete--help () | |
1137 "Produce context-sensitive help for the current argument. | |
55105
7438df87d96a
(pcomplete-opt, pcomplete-actual-arg, pcomplete-match-string,
Juanma Barranquero <lekktu@gmail.com>
parents:
52401
diff
changeset
|
1138 If specific documentation can't be given, be generic." |
29876 | 1139 (if (and pcomplete-help |
1140 (or (and (stringp pcomplete-help) | |
1141 (fboundp 'Info-goto-node)) | |
1142 (listp pcomplete-help))) | |
1143 (if (listp pcomplete-help) | |
65582
4d1085b02d64
Message format spec fixes (1)
Deepak Goel <deego@gnufans.org>
parents:
64762
diff
changeset
|
1144 (message "%s" (eval pcomplete-help)) |
29876 | 1145 (save-window-excursion (info)) |
1146 (switch-to-buffer-other-window "*info*") | |
1147 (funcall (symbol-function 'Info-goto-node) pcomplete-help)) | |
1148 (if pcomplete-man-function | |
1149 (let ((cmd (funcall pcomplete-command-name-function))) | |
1150 (if (and cmd (> (length cmd) 0)) | |
1151 (funcall pcomplete-man-function cmd))) | |
1152 (message "No context-sensitive help available")))) | |
1153 | |
1154 ;; general utilities | |
1155 | |
1156 (defun pcomplete-pare-list (l r &optional pred) | |
1157 "Destructively remove from list L all elements matching any in list R. | |
1158 Test is done using `equal'. | |
1159 If PRED is non-nil, it is a function used for further removal. | |
1160 Returns the resultant list." | |
1161 (while (and l (or (and r (member (car l) r)) | |
1162 (and pred | |
1163 (funcall pred (car l))))) | |
1164 (setq l (cdr l))) | |
1165 (let ((m l)) | |
1166 (while m | |
1167 (while (and (cdr m) | |
1168 (or (and r (member (cadr m) r)) | |
1169 (and pred | |
1170 (funcall pred (cadr m))))) | |
1171 (setcdr m (cddr m))) | |
1172 (setq m (cdr m)))) | |
1173 l) | |
1174 | |
1175 (defun pcomplete-uniqify-list (l) | |
1176 "Sort and remove multiples in L." | |
1177 (setq l (sort l 'string-lessp)) | |
1178 (let ((m l)) | |
1179 (while m | |
1180 (while (and (cdr m) | |
1181 (string= (car m) | |
1182 (cadr m))) | |
1183 (setcdr m (cddr m))) | |
1184 (setq m (cdr m)))) | |
1185 l) | |
1186 | |
1187 (defun pcomplete-process-result (cmd &rest args) | |
1188 "Call CMD using `call-process' and return the simplest result." | |
1189 (with-temp-buffer | |
1190 (apply 'call-process cmd nil t nil args) | |
1191 (skip-chars-backward "\n") | |
1192 (buffer-substring (point-min) (point)))) | |
1193 | |
1194 ;; create a set of aliases which allow completion functions to be not | |
1195 ;; quite so verbose | |
1196 | |
1197 ;; jww (1999-10-20): are these a good idea? | |
1198 ; (defalias 'pc-here 'pcomplete-here) | |
1199 ; (defalias 'pc-test 'pcomplete-test) | |
1200 ; (defalias 'pc-opt 'pcomplete-opt) | |
1201 ; (defalias 'pc-match 'pcomplete-match) | |
1202 ; (defalias 'pc-match-string 'pcomplete-match-string) | |
1203 ; (defalias 'pc-match-beginning 'pcomplete-match-beginning) | |
1204 ; (defalias 'pc-match-end 'pcomplete-match-end) | |
1205 | |
93975
1e3a407766b9
Fix up comment convention on the arch-tag lines.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
87649
diff
changeset
|
1206 ;; arch-tag: ae32ef2d-dbed-4244-8b0f-cf5a2a3b07a4 |
29876 | 1207 ;;; pcomplete.el ends here |