* lisp/net/tramp.el (tramp-default-method): scp is the default method.
[bpt/emacs.git] / lisp / complete.el
CommitLineData
b035a678 1;;; complete.el --- partial completion mechanism plus other goodies
b545bfe6 2
0d30b337 3;; Copyright (C) 1990, 1991, 1992, 1993, 1999, 2000, 2002, 2003, 2004,
aaef169d 4;; 2005, 2006 Free Software Foundation, Inc.
b545bfe6
JB
5
6;; Author: Dave Gillespie <daveg@synaptics.com>
f5f727f8 7;; Keywords: abbrev convenience
b545bfe6
JB
8;; Special thanks to Hallvard Furuseth for his many ideas and contributions.
9
10;; This file is part of GNU Emacs.
11
59243403
RS
12;; GNU Emacs is free software; you can redistribute it and/or modify
13;; it under the terms of the GNU General Public License as published by
14;; the Free Software Foundation; either version 2, or (at your option)
15;; any later version.
16
b545bfe6 17;; GNU Emacs is distributed in the hope that it will be useful,
59243403
RS
18;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20;; GNU General Public License for more details.
b545bfe6 21
59243403 22;; You should have received a copy of the GNU General Public License
b578f267 23;; along with GNU Emacs; see the file COPYING. If not, write to the
086add15
LK
24;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
25;; Boston, MA 02110-1301, USA.
b545bfe6 26
07b3798c 27;;; Commentary:
b545bfe6
JB
28
29;; Extended completion for the Emacs minibuffer.
30;;
31;; The basic idea is that the command name or other completable text is
32;; divided into words and each word is completed separately, so that
33;; "M-x p-b" expands to "M-x print-buffer". If the entry is ambiguous
34;; each word is completed as much as possible and then the cursor is
35;; left at the first position where typing another letter will resolve
36;; the ambiguity.
37;;
38;; Word separators for this purpose are hyphen, space, and period.
39;; These would most likely occur in command names, Info menu items,
40;; and file names, respectively. But all word separators are treated
41;; alike at all times.
42;;
43;; This completion package replaces the old-style completer's key
44;; bindings for TAB, SPC, RET, and `?'. The old completer is still
45;; available on the Meta versions of those keys. If you set
46;; PC-meta-flag to nil, the old completion keys will be left alone
47;; and the partial completer will use the Meta versions of the keys.
48
49
7117761b 50;; Usage: M-x partial-completion-mode. During completable minibuffer entry,
b545bfe6
JB
51;;
52;; TAB means to do a partial completion;
53;; SPC means to do a partial complete-word;
54;; RET means to do a partial complete-and-exit;
55;; ? means to do a partial completion-help.
56;;
57;; If you set PC-meta-flag to nil, then TAB, SPC, RET, and ? perform
58;; original Emacs completions, and M-TAB etc. do partial completion.
59;; To do this, put the command,
60;;
61;; (setq PC-meta-flag nil)
62;;
63;; in your .emacs file. To load partial completion automatically, put
64;;
7117761b 65;; (partial-completion-mode t)
b545bfe6
JB
66;;
67;; in your .emacs file, too. Things will be faster if you byte-compile
68;; this file when you install it.
69;;
70;; As an extra feature, in cases where RET would not normally
71;; complete (such as `C-x b'), the M-RET key will always do a partial
72;; complete-and-exit. Thus `C-x b f.c RET' will select or create a
73;; buffer called "f.c", but `C-x b f.c M-RET' will select the existing
74;; buffer whose name matches that pattern (perhaps "filing.c").
75;; (PC-meta-flag does not affect this behavior; M-RET used to be
76;; undefined in this situation.)
77;;
78;; The regular M-TAB (lisp-complete-symbol) command also supports
79;; partial completion in this package.
80
b545bfe6
JB
81;; In addition, this package includes a feature for accessing include
82;; files. For example, `C-x C-f <sys/time.h> RET' reads the file
83;; /usr/include/sys/time.h. The variable PC-include-file-path is a
84;; list of directories in which to search for include files. Completion
85;; is supported in include file names.
86
87
07b3798c 88;;; Code:
b545bfe6 89
92677e25
SM
90(defgroup partial-completion nil
91 "Partial Completion of items."
92 :prefix "pc-"
f5f727f8
DN
93 :group 'minibuffer
94 :group 'convenience)
92677e25 95
92677e25 96(defcustom PC-first-char 'find-file
95983b95 97 "Control how the first character of a string is to be interpreted.
92677e25
SM
98If nil, the first character of a string is not taken literally if it is a word
99delimiter, so that \".e\" matches \"*.e*\".
100If t, the first character of a string is always taken literally even if it is a
101word delimiter, so that \".e\" matches \".e*\".
102If non-nil and non-t, the first character is taken literally only for file name
103completion."
104 :type '(choice (const :tag "delimiter" nil)
105 (const :tag "literal" t)
45200424 106 (other :tag "find-file" find-file))
92677e25
SM
107 :group 'partial-completion)
108
109(defcustom PC-meta-flag t
95983b95 110 "If non-nil, TAB means PC completion and M-TAB means normal completion.
92677e25
SM
111Otherwise, TAB means normal completion and M-TAB means Partial Completion."
112 :type 'boolean
113 :group 'partial-completion)
114
115(defcustom PC-word-delimiters "-_. "
95983b95 116 "A string of characters treated as word delimiters for completion.
92677e25
SM
117Some arcane rules:
118If `]' is in this string, it must come first.
119If `^' is in this string, it must not come first.
120If `-' is in this string, it must come first or right after `]'.
932fb767 121In other words, if S is this string, then `[S]' must be a valid Emacs regular
92677e25
SM
122expression (not containing character ranges like `a-z')."
123 :type 'string
124 :group 'partial-completion)
125
126(defcustom PC-include-file-path '("/usr/include" "/usr/local/include")
95983b95 127 "A list of directories in which to look for include files.
92677e25
SM
128If nil, means use the colon-separated path in the variable $INCPATH instead."
129 :type '(repeat directory)
130 :group 'partial-completion)
131
92677e25 132(defcustom PC-disable-includes nil
95983b95 133 "If non-nil, include-file support in \\[find-file] is disabled."
92677e25
SM
134 :type 'boolean
135 :group 'partial-completion)
b545bfe6
JB
136
137(defvar PC-default-bindings t
92677e25 138 "If non-nil, default partial completion key bindings are suppressed.")
356b1352
GM
139
140(defvar PC-env-vars-alist nil
141 "A list of the environment variable names and values.")
142
92677e25 143\f
92677e25
SM
144(defun PC-bindings (bind)
145 (let ((completion-map minibuffer-local-completion-map)
146 (must-match-map minibuffer-local-must-match-map))
147 (cond ((not bind)
148 ;; These bindings are the default bindings. It would be better to
149 ;; restore the previous bindings.
150 (define-key completion-map "\t" 'minibuffer-complete)
151 (define-key completion-map " " 'minibuffer-complete-word)
152 (define-key completion-map "?" 'minibuffer-completion-help)
153
154 (define-key must-match-map "\t" 'minibuffer-complete)
155 (define-key must-match-map " " 'minibuffer-complete-word)
156 (define-key must-match-map "\r" 'minibuffer-complete-and-exit)
157 (define-key must-match-map "\n" 'minibuffer-complete-and-exit)
158 (define-key must-match-map "?" 'minibuffer-completion-help)
159
160 (define-key global-map "\e\t" 'complete-symbol))
161 (PC-default-bindings
162 (define-key completion-map "\t" 'PC-complete)
163 (define-key completion-map " " 'PC-complete-word)
164 (define-key completion-map "?" 'PC-completion-help)
165
166 (define-key completion-map "\e\t" 'PC-complete)
167 (define-key completion-map "\e " 'PC-complete-word)
168 (define-key completion-map "\e\r" 'PC-force-complete-and-exit)
169 (define-key completion-map "\e\n" 'PC-force-complete-and-exit)
170 (define-key completion-map "\e?" 'PC-completion-help)
171
172 (define-key must-match-map "\t" 'PC-complete)
173 (define-key must-match-map " " 'PC-complete-word)
174 (define-key must-match-map "\r" 'PC-complete-and-exit)
175 (define-key must-match-map "\n" 'PC-complete-and-exit)
176 (define-key must-match-map "?" 'PC-completion-help)
177
178 (define-key must-match-map "\e\t" 'PC-complete)
179 (define-key must-match-map "\e " 'PC-complete-word)
180 (define-key must-match-map "\e\r" 'PC-complete-and-exit)
181 (define-key must-match-map "\e\n" 'PC-complete-and-exit)
182 (define-key must-match-map "\e?" 'PC-completion-help)
183
184 (define-key global-map "\e\t" 'PC-lisp-complete-symbol)))))
185
cc7e4da0
SM
186;;;###autoload
187(define-minor-mode partial-completion-mode
188 "Toggle Partial Completion mode.
189With prefix ARG, turn Partial Completion mode on if ARG is positive.
190
191When Partial Completion mode is enabled, TAB (or M-TAB if `PC-meta-flag' is
192nil) is enhanced so that if some string is divided into words and each word is
193delimited by a character in `PC-word-delimiters', partial words are completed
194as much as possible and `*' characters are treated likewise in file names.
195
196For example, M-x p-c-m expands to M-x partial-completion-mode since no other
197command begins with that sequence of characters, and
198\\[find-file] f_b.c TAB might complete to foo_bar.c if that file existed and no
08fd202a 199other file in that directory begins with that sequence of characters.
cc7e4da0 200
2ad432ab 201Unless `PC-disable-includes' is non-nil, the `<...>' sequence is interpreted
cc7e4da0 202specially in \\[find-file]. For example,
2ad432ab 203\\[find-file] <sys/time.h> RET finds the file `/usr/include/sys/time.h'.
10156852
EZ
204See also the variable `PC-include-file-path'.
205
206Partial Completion mode extends the meaning of `completion-auto-help' (which
6c76000b
RS
207see), so that if it is neither nil nor t, Emacs shows the `*Completions*'
208buffer only on the second attempt to complete. That is, if TAB finds nothing
209to complete, the first TAB just says \"Next char not unique\" and the
fddf97f6 210second TAB brings up the `*Completions*' buffer."
00089cad 211 :global t :group 'partial-completion
cc7e4da0
SM
212 ;; Deal with key bindings...
213 (PC-bindings partial-completion-mode)
214 ;; Deal with include file feature...
215 (cond ((not partial-completion-mode)
f679907b 216 (remove-hook 'find-file-not-found-functions 'PC-look-for-include-file))
cc7e4da0 217 ((not PC-disable-includes)
f679907b 218 (add-hook 'find-file-not-found-functions 'PC-look-for-include-file)))
cc7e4da0 219 ;; ... with some underhand redefining.
8d85a565
SM
220 (cond ((not partial-completion-mode)
221 (ad-disable-advice 'read-file-name-internal 'around 'PC-include-file)
222 (ad-activate 'read-file-name-internal))
223 ((not PC-disable-includes)
224 (ad-enable-advice 'read-file-name-internal 'around 'PC-include-file)
225 (ad-activate 'read-file-name-internal)))
226 ;; Adjust the completion selection in *Completion* buffers to the way
227 ;; we work. The default minibuffer completion code only completes the
228 ;; text before point and leaves the text after point alone (new in
229 ;; Emacs-22). In contrast we use the whole text and we even sometimes
230 ;; move point to a place before EOB, to indicate the first position where
231 ;; there's a difference, so when the user uses choose-completion, we have
232 ;; to trick choose-completion into replacing the whole minibuffer text
233 ;; rather than only the text before point. --Stef
234 (funcall
235 (if partial-completion-mode 'add-hook 'remove-hook)
236 'choose-completion-string-functions
d46104ae
JL
237 (lambda (choice buffer mini-p base-size)
238 (if mini-p (goto-char (point-max)))
239 nil))
8d85a565
SM
240 ;; Build the env-completion and mapping table.
241 (when (and partial-completion-mode (null PC-env-vars-alist))
242 (setq PC-env-vars-alist
243 (mapcar (lambda (string)
244 (let ((d (string-match "=" string)))
245 (cons (concat "$" (substring string 0 d))
246 (and d (substring string (1+ d))))))
247 process-environment))))
cc7e4da0 248
92677e25 249\f
b545bfe6
JB
250(defun PC-complete ()
251 "Like minibuffer-complete, but allows \"b--di\"-style abbreviations.
252For example, \"M-x b--di\" would match `byte-recompile-directory', or any
253name which consists of three or more words, the first beginning with \"b\"
254and the third beginning with \"di\".
255
256The pattern \"b--d\" is ambiguous for `byte-recompile-directory' and
257`beginning-of-defun', so this would produce a list of completions
258just like when normal Emacs completions are ambiguous.
259
260Word-delimiters for the purposes of Partial Completion are \"-\", \"_\",
261\".\", and SPC."
262 (interactive)
263 (if (PC-was-meta-key)
264 (minibuffer-complete)
95c0d3a7
RS
265 ;; If the previous command was not this one,
266 ;; never scroll, always retry completion.
267 (or (eq last-command this-command)
268 (setq minibuffer-scroll-window nil))
269 (let ((window minibuffer-scroll-window))
270 ;; If there's a fresh completion window with a live buffer,
271 ;; and this command is repeated, scroll that window.
272 (if (and window (window-buffer window)
273 (buffer-name (window-buffer window)))
f679907b 274 (with-current-buffer (window-buffer window)
95c0d3a7
RS
275 (if (pos-visible-in-window-p (point-max) window)
276 (set-window-start window (point-min) nil)
277 (scroll-other-window)))
278 (PC-do-completion nil)))))
b545bfe6
JB
279
280
281(defun PC-complete-word ()
282 "Like `minibuffer-complete-word', but allows \"b--di\"-style abbreviations.
283See `PC-complete' for details.
284This can be bound to other keys, like `-' and `.', if you wish."
285 (interactive)
286 (if (eq (PC-was-meta-key) PC-meta-flag)
287 (if (eq last-command-char ? )
288 (minibuffer-complete-word)
289 (self-insert-command 1))
290 (self-insert-command 1)
291 (if (eobp)
292 (PC-do-completion 'word))))
293
294
295(defun PC-complete-space ()
296 "Like `minibuffer-complete-word', but allows \"b--di\"-style abbreviations.
297See `PC-complete' for details.
298This is suitable for binding to other keys which should act just like SPC."
299 (interactive)
300 (if (eq (PC-was-meta-key) PC-meta-flag)
301 (minibuffer-complete-word)
302 (insert " ")
303 (if (eobp)
304 (PC-do-completion 'word))))
305
306
307(defun PC-complete-and-exit ()
308 "Like `minibuffer-complete-and-exit', but allows \"b--di\"-style abbreviations.
309See `PC-complete' for details."
310 (interactive)
311 (if (eq (PC-was-meta-key) PC-meta-flag)
312 (minibuffer-complete-and-exit)
313 (PC-do-complete-and-exit)))
314
315(defun PC-force-complete-and-exit ()
316 "Like `minibuffer-complete-and-exit', but allows \"b--di\"-style abbreviations.
317See `PC-complete' for details."
318 (interactive)
319 (let ((minibuffer-completion-confirm nil))
320 (PC-do-complete-and-exit)))
321
322(defun PC-do-complete-and-exit ()
d7a0208b 323 (if (= (point-max) (minibuffer-prompt-end)) ; Duplicate the "bug" that Info-menu relies on...
b545bfe6
JB
324 (exit-minibuffer)
325 (let ((flag (PC-do-completion 'exit)))
326 (and flag
327 (if (or (eq flag 'complete)
328 (not minibuffer-completion-confirm))
329 (exit-minibuffer)
80f14e53 330 (PC-temp-minibuffer-message " [Confirm]"))))))
b545bfe6
JB
331
332
333(defun PC-completion-help ()
334 "Like `minibuffer-completion-help', but allows \"b--di\"-style abbreviations.
335See `PC-complete' for details."
336 (interactive)
337 (if (eq (PC-was-meta-key) PC-meta-flag)
338 (minibuffer-completion-help)
339 (PC-do-completion 'help)))
340
341(defun PC-was-meta-key ()
342 (or (/= (length (this-command-keys)) 1)
343 (let ((key (aref (this-command-keys) 0)))
344 (if (integerp key)
345 (>= key 128)
346 (not (null (memq 'meta (event-modifiers key))))))))
347
348
349(defvar PC-ignored-extensions 'empty-cache)
350(defvar PC-delims 'empty-cache)
351(defvar PC-ignored-regexp nil)
352(defvar PC-word-failed-flag nil)
353(defvar PC-delim-regex nil)
354(defvar PC-ndelims-regex nil)
355(defvar PC-delims-list nil)
356
249f7eeb 357(defvar PC-completion-as-file-name-predicate
f679907b
SM
358 (lambda () minibuffer-completing-file-name)
359 "A function testing whether a minibuffer completion now will work filename-style.
249f7eeb
RS
360The function takes no arguments, and typically looks at the value
361of `minibuffer-completion-table' and the minibuffer contents.")
3985c790 362
08fd202a
EZ
363;; Returns the sequence of non-delimiter characters that follow regexp in string.
364(defun PC-chunk-after (string regexp)
365 (if (not (string-match regexp string))
366 (let ((message (format "String %s didn't match regexp %s" string regexp)))
367 (message message)
368 (error message)))
369 (let ((result (substring string (match-end 0))))
370 ;; result may contain multiple chunks
371 (if (string-match PC-delim-regex result)
372 (setq result (substring result 0 (match-beginning 0))))
373 result))
374
375(defun test-completion-ignore-case (str table pred)
376 "Like `test-completion', but ignores case when possible."
377 ;; Binding completion-ignore-case to nil ensures, for compatibility with
378 ;; standard completion, that the return value is exactly one of the
379 ;; possibilities. Do this binding only if pred is nil, out of paranoia;
380 ;; perhaps it is safe even if pred is non-nil.
381 (if pred
382 (test-completion str table pred)
383 (let ((completion-ignore-case nil))
384 (test-completion str table pred))))
385
b545bfe6 386(defun PC-do-completion (&optional mode beg end)
f08d8594 387 (or beg (setq beg (minibuffer-prompt-end)))
b545bfe6
JB
388 (or end (setq end (point-max)))
389 (let* ((table minibuffer-completion-table)
390 (pred minibuffer-completion-predicate)
249f7eeb 391 (filename (funcall PC-completion-as-file-name-predicate))
08fd202a 392 (dirname nil) ; non-nil only if a filename is being completed
356b1352 393 (dirlength 0)
b545bfe6
JB
394 (str (buffer-substring beg end))
395 (incname (and filename (string-match "<\\([^\"<>]*\\)>?$" str)))
396 (ambig nil)
35731e3b 397 basestr origstr
356b1352 398 env-on
b545bfe6
JB
399 regex
400 p offset
401 (poss nil)
402 helpposs
403 (case-fold-search completion-ignore-case))
404
405 ;; Check if buffer contents can already be considered complete
406 (if (and (eq mode 'exit)
08fd202a 407 (test-completion-ignore-case str table pred))
b545bfe6
JB
408 'complete
409
410 ;; Do substitutions in directory names
411 (and filename
356b1352
GM
412 (setq basestr (or (file-name-directory str) ""))
413 (setq dirlength (length basestr))
414 ;; Do substitutions in directory names
415 (setq p (substitute-in-file-name basestr))
416 (not (string-equal basestr p))
417 (setq str (concat p (file-name-nondirectory str)))
418 (progn
b545bfe6 419 (delete-region beg end)
356b1352
GM
420 (insert str)
421 (setq end (+ beg (length str)))))
8e28519a 422
b545bfe6
JB
423 ;; Prepare various delimiter strings
424 (or (equal PC-word-delimiters PC-delims)
425 (setq PC-delims PC-word-delimiters
426 PC-delim-regex (concat "[" PC-delims "]")
427 PC-ndelims-regex (concat "[^" PC-delims "]*")
428 PC-delims-list (append PC-delims nil)))
429
c2801b50 430 ;; Add wildcards if necessary
8e28519a
NF
431 (and filename
432 (let ((dir (file-name-directory str))
93f4fe7a
SM
433 (file (file-name-nondirectory str))
434 ;; The base dir for file-completion is passed in `predicate'.
435 (default-directory (expand-file-name pred)))
8e28519a
NF
436 (while (and (stringp dir) (not (file-directory-p dir)))
437 (setq dir (directory-file-name dir))
438 (setq file (concat (replace-regexp-in-string
439 PC-delim-regex "*\\&"
440 (file-name-nondirectory dir))
441 "*/" file))
442 (setq dir (file-name-directory dir)))
35731e3b 443 (setq origstr str str (concat dir file))))
8e28519a 444
b545bfe6
JB
445 ;; Look for wildcard expansions in directory name
446 (and filename
447 (string-match "\\*.*/" str)
448 (let ((pat str)
93f4fe7a
SM
449 ;; The base dir for file-completion is passed in `predicate'.
450 (default-directory (expand-file-name pred))
b545bfe6
JB
451 files)
452 (setq p (1+ (string-match "/[^/]*\\'" pat)))
453 (while (setq p (string-match PC-delim-regex pat p))
454 (setq pat (concat (substring pat 0 p)
455 "*"
456 (substring pat p))
457 p (+ p 2)))
458 (setq files (PC-expand-many-files (concat pat "*")))
459 (if files
460 (let ((dir (file-name-directory (car files)))
461 (p files))
462 (while (and (setq p (cdr p))
463 (equal dir (file-name-directory (car p)))))
464 (if p
465 (setq filename nil table nil pred nil
466 ambig t)
467 (delete-region beg end)
468 (setq str (concat dir (file-name-nondirectory str)))
469 (insert str)
470 (setq end (+ beg (length str)))))
35731e3b
SM
471 (if origstr
472 ;; If the wildcards were introduced by us, it's possible
473 ;; that read-file-name-internal (especially our
474 ;; PC-include-file advice) can still find matches for the
475 ;; original string even if we couldn't, so remove the
476 ;; added wildcards.
477 (setq str origstr)
478 (setq filename nil table nil pred nil)))))
b545bfe6
JB
479
480 ;; Strip directory name if appropriate
481 (if filename
482 (if incname
483 (setq basestr (substring str incname)
484 dirname (substring str 0 incname))
485 (setq basestr (file-name-nondirectory str)
b38d1cc7
EZ
486 dirname (file-name-directory str))
487 ;; Make sure str is consistent with its directory and basename
488 ;; parts. This is important on DOZe'NT systems when str only
489 ;; includes a drive letter, like in "d:".
490 (setq str (concat dirname basestr)))
b545bfe6
JB
491 (setq basestr str))
492
493 ;; Convert search pattern to a standard regular expression
494 (setq regex (regexp-quote basestr)
495 offset (if (and (> (length regex) 0)
496 (not (eq (aref basestr 0) ?\*))
497 (or (eq PC-first-char t)
498 (and PC-first-char filename))) 1 0)
499 p offset)
500 (while (setq p (string-match PC-delim-regex regex p))
501 (if (eq (aref regex p) ? )
502 (setq regex (concat (substring regex 0 p)
503 PC-ndelims-regex
504 PC-delim-regex
505 (substring regex (1+ p)))
506 p (+ p (length PC-ndelims-regex) (length PC-delim-regex)))
507 (let ((bump (if (memq (aref regex p)
508 '(?$ ?^ ?\. ?* ?+ ?? ?[ ?] ?\\))
509 -1 0)))
510 (setq regex (concat (substring regex 0 (+ p bump))
511 PC-ndelims-regex
512 (substring regex (+ p bump)))
513 p (+ p (length PC-ndelims-regex) 1)))))
514 (setq p 0)
515 (if filename
516 (while (setq p (string-match "\\\\\\*" regex p))
517 (setq regex (concat (substring regex 0 p)
518 "[^/]*"
519 (substring regex (+ p 2))))))
520 ;;(setq the-regex regex)
521 (setq regex (concat "\\`" regex))
522
356b1352
GM
523 (and (> (length basestr) 0)
524 (= (aref basestr 0) ?$)
525 (setq env-on t
526 table PC-env-vars-alist
527 pred nil))
528
b545bfe6
JB
529 ;; Find an initial list of possible completions
530 (if (not (setq p (string-match (concat PC-delim-regex
531 (if filename "\\|\\*" ""))
532 str
533 (+ (length dirname) offset))))
534
535 ;; Minibuffer contains no hyphens -- simple case!
356b1352
GM
536 (setq poss (all-completions (if env-on
537 basestr str)
b545bfe6
JB
538 table
539 pred))
540
541 ;; Use all-completions to do an initial cull. This is a big win,
542 ;; since all-completions is written in C!
356b1352
GM
543 (let ((compl (all-completions (if env-on
544 (file-name-nondirectory (substring str 0 p))
545 (substring str 0 p))
4a63ceb8
SM
546 table
547 pred)))
b545bfe6
JB
548 (setq p compl)
549 (while p
550 (and (string-match regex (car p))
fc21ed03
KH
551 (progn
552 (set-text-properties 0 (length (car p)) '() (car p))
553 (setq poss (cons (car p) poss))))
b545bfe6
JB
554 (setq p (cdr p)))))
555
4a63ceb8
SM
556 ;; Handle completion-ignored-extensions
557 (and filename
558 (not (eq mode 'help))
559 (let ((p2 poss))
560
561 ;; Build a regular expression representing the extensions list
562 (or (equal completion-ignored-extensions PC-ignored-extensions)
563 (setq PC-ignored-regexp
564 (concat "\\("
565 (mapconcat
566 'regexp-quote
567 (setq PC-ignored-extensions
568 completion-ignored-extensions)
569 "\\|")
570 "\\)\\'")))
571
572 ;; Check if there are any without an ignored extension.
573 ;; Also ignore `.' and `..'.
574 (setq p nil)
575 (while p2
576 (or (string-match PC-ignored-regexp (car p2))
577 (string-match "\\(\\`\\|/\\)[.][.]?/?\\'" (car p2))
578 (setq p (cons (car p2) p)))
579 (setq p2 (cdr p2)))
580
581 ;; If there are "good" names, use them
582 (and p (setq poss p))))
583
b545bfe6
JB
584 ;; Now we have a list of possible completions
585 (cond
586
587 ;; No valid completions found
588 ((null poss)
589 (if (and (eq mode 'word)
590 (not PC-word-failed-flag))
591 (let ((PC-word-failed-flag t))
592 (delete-backward-char 1)
593 (PC-do-completion 'word))
594 (beep)
595 (PC-temp-minibuffer-message (if ambig
80f14e53 596 " [Ambiguous dir name]"
b545bfe6 597 (if (eq mode 'help)
80f14e53
RS
598 " [No completions]"
599 " [No match]")))
b545bfe6
JB
600 nil))
601
602 ;; More than one valid completion found
603 ((or (cdr (setq helpposs poss))
604 (memq mode '(help word)))
605
b545bfe6
JB
606 ;; Is the actual string one of the possible completions?
607 (setq p (and (not (eq mode 'help)) poss))
608 (while (and p
fc21ed03 609 (not (string-equal (car p) basestr)))
b545bfe6 610 (setq p (cdr p)))
80f14e53
RS
611 (and p (null mode)
612 (PC-temp-minibuffer-message " [Complete, but not unique]"))
613 (if (and p
614 (not (and (null mode)
615 (eq this-command last-command))))
616 t
b545bfe6
JB
617
618 ;; If ambiguous, try for a partial completion
619 (let ((improved nil)
620 prefix
621 (pt nil)
622 (skip "\\`"))
623
624 ;; Check if next few letters are the same in all cases
625 (if (and (not (eq mode 'help))
4a63ceb8
SM
626 (setq prefix (try-completion (PC-chunk-after basestr skip)
627 poss)))
b545bfe6 628 (let ((first t) i)
08fd202a
EZ
629 ;; Retain capitalization of user input even if
630 ;; completion-ignore-case is set.
b545bfe6
JB
631 (if (eq mode 'word)
632 (setq prefix (PC-chop-word prefix basestr)))
633 (goto-char (+ beg (length dirname)))
634 (while (and (progn
08fd202a 635 (setq i 0) ; index into prefix string
b545bfe6
JB
636 (while (< i (length prefix))
637 (if (and (< (point) end)
08fd202a
EZ
638 (eq (downcase (aref prefix i))
639 (downcase (following-char))))
640 ;; same char (modulo case); no action
b545bfe6
JB
641 (forward-char 1)
642 (if (and (< (point) end)
08fd202a 643 (and (looking-at " ")
b545bfe6 644 (memq (aref prefix i)
08fd202a
EZ
645 PC-delims-list)))
646 ;; replace " " by the actual delimiter
b545bfe6
JB
647 (progn
648 (delete-char 1)
08fd202a
EZ
649 (insert (substring prefix i (1+ i))))
650 ;; insert a new character
651 (progn
b545bfe6
JB
652 (and filename (looking-at "\\*")
653 (progn
654 (delete-char 1)
655 (setq end (1- end))))
08fd202a 656 (setq improved t)
fc21ed03 657 (insert (substring prefix i (1+ i)))
08fd202a 658 (setq end (1+ end)))))
b545bfe6 659 (setq i (1+ i)))
fddf97f6 660 (or pt (setq pt (point)))
b545bfe6
JB
661 (looking-at PC-delim-regex))
662 (setq skip (concat skip
663 (regexp-quote prefix)
664 PC-ndelims-regex)
665 prefix (try-completion
08fd202a
EZ
666 (PC-chunk-after
667 ;; not basestr, because that does
668 ;; not reflect insertions
669 (buffer-substring
670 (+ beg (length dirname)) end)
671 skip)
b545bfe6 672 (mapcar
4a63ceb8
SM
673 (lambda (x)
674 (when (string-match skip x)
675 (substring x (match-end 0))))
b545bfe6
JB
676 poss)))
677 (or (> i 0) (> (length prefix) 0))
678 (or (not (eq mode 'word))
679 (and first (> (length prefix) 0)
680 (setq first nil
681 prefix (substring prefix 0 1))))))
682 (goto-char (if (eq mode 'word) end
683 (or pt beg)))))
684
685 (if (and (eq mode 'word)
686 (not PC-word-failed-flag))
687
688 (if improved
689
690 ;; We changed it... would it be complete without the space?
1b368e31 691 (if (test-completion (buffer-substring 1 (1- end))
b545bfe6
JB
692 table pred)
693 (delete-region (1- end) end)))
694
695 (if improved
696
697 ;; We changed it... enough to be complete?
698 (and (eq mode 'exit)
08fd202a 699 (test-completion-ignore-case (field-string) table pred))
b545bfe6
JB
700
701 ;; If totally ambiguous, display a list of completions
cc7e4da0
SM
702 (if (or (eq completion-auto-help t)
703 (and completion-auto-help
704 (eq last-command this-command))
b545bfe6 705 (eq mode 'help))
67698633 706 (with-output-to-temp-buffer "*Completions*"
78b19c2c 707 (display-completion-list (sort helpposs 'string-lessp))
f679907b 708 (with-current-buffer standard-output
78b19c2c
RS
709 ;; Record which part of the buffer we are completing
710 ;; so that choosing a completion from the list
711 ;; knows how much old text to replace.
712 (setq completion-base-size dirlength)))
80f14e53 713 (PC-temp-minibuffer-message " [Next char not unique]"))
b545bfe6
JB
714 nil)))))
715
716 ;; Only one possible completion
717 (t
356b1352
GM
718 (if (and (equal basestr (car poss))
719 (not (and env-on filename)))
b545bfe6 720 (if (null mode)
80f14e53 721 (PC-temp-minibuffer-message " [Sole completion]"))
b545bfe6 722 (delete-region beg end)
e5fd2822
RS
723 (insert (format "%s"
724 (if filename
725 (substitute-in-file-name (concat dirname (car poss)))
726 (car poss)))))
b545bfe6
JB
727 t)))))
728
b545bfe6
JB
729(defun PC-chop-word (new old)
730 (let ((i -1)
731 (j -1))
732 (while (and (setq i (string-match PC-delim-regex old (1+ i)))
733 (setq j (string-match PC-delim-regex new (1+ j)))))
734 (if (and j
735 (or (not PC-word-failed-flag)
736 (setq j (string-match PC-delim-regex new (1+ j)))))
737 (substring new 0 (1+ j))
738 new)))
739
740(defvar PC-not-minibuffer nil)
741
92677e25 742(defun PC-temp-minibuffer-message (message)
b545bfe6 743 "A Lisp version of `temp_minibuffer_message' from minibuf.c."
92677e25
SM
744 (cond (PC-not-minibuffer
745 (message message)
746 (sit-for 2)
747 (message ""))
748 ((fboundp 'temp-minibuffer-message)
749 (temp-minibuffer-message message))
750 (t
751 (let ((point-max (point-max)))
752 (save-excursion
753 (goto-char point-max)
754 (insert message))
755 (let ((inhibit-quit t))
756 (sit-for 2)
757 (delete-region point-max (point-max))
758 (when quit-flag
759 (setq quit-flag nil
760 unread-command-events '(7))))))))
b545bfe6
JB
761
762
763(defun PC-lisp-complete-symbol ()
764 "Perform completion on Lisp symbol preceding point.
765That symbol is compared against the symbols that exist
766and any additional characters determined by what is there
767are inserted.
768If the symbol starts just after an open-parenthesis,
769only symbols with function definitions are considered.
770Otherwise, all symbols with function definitions, values
771or properties are considered."
772 (interactive)
773 (let* ((end (point))
f679907b
SM
774 (beg (save-excursion
775 (with-syntax-table lisp-mode-syntax-table
776 (backward-sexp 1)
777 (while (= (char-syntax (following-char)) ?\')
778 (forward-char 1))
779 (point))))
b545bfe6
JB
780 (minibuffer-completion-table obarray)
781 (minibuffer-completion-predicate
782 (if (eq (char-after (1- beg)) ?\()
783 'fboundp
784 (function (lambda (sym)
785 (or (boundp sym) (fboundp sym)
786 (symbol-plist sym))))))
787 (PC-not-minibuffer t))
788 (PC-do-completion nil beg end)))
789
356b1352
GM
790(defun PC-complete-as-file-name ()
791 "Perform completion on file names preceding point.
792 Environment vars are converted to their values."
793 (interactive)
794 (let* ((end (point))
795 (beg (if (re-search-backward "[^\\][ \t\n\"\`\'][^ \t\n\"\`\']"
796 (point-min) t)
797 (+ (point) 2)
798 (point-min)))
799 (minibuffer-completion-table 'read-file-name-internal)
800 (minibuffer-completion-predicate "")
801 (PC-not-minibuffer t))
802 (goto-char end)
803 (PC-do-completion nil beg end)))
804
f679907b
SM
805;; Use the shell to do globbing.
806;; This could now use file-expand-wildcards instead.
b545bfe6
JB
807
808(defun PC-expand-many-files (name)
f679907b 809 (with-current-buffer (generate-new-buffer " *Glob Output*")
b545bfe6 810 (erase-buffer)
424f4c9c
SM
811 (when (and (file-name-absolute-p name)
812 (not (file-directory-p default-directory)))
813 ;; If the current working directory doesn't exist `shell-command'
814 ;; signals an error. So if the file names we're looking for don't
815 ;; depend on the working directory, switch to a valid directory first.
816 (setq default-directory "/"))
b545bfe6
JB
817 (shell-command (concat "echo " name) t)
818 (goto-char (point-min))
95983b95
SM
819 ;; CSH-style shells were known to output "No match", whereas
820 ;; SH-style shells tend to simply output `name' when no match is found.
821 (if (looking-at (concat ".*No match\\|\\(^\\| \\)\\("
822 (regexp-quote name)
823 "\\|"
824 (regexp-quote (expand-file-name name))
825 "\\)\\( \\|$\\)"))
b545bfe6
JB
826 nil
827 (insert "(\"")
828 (while (search-forward " " nil t)
829 (delete-backward-char 1)
830 (insert "\" \""))
831 (goto-char (point-max))
832 (delete-backward-char 1)
833 (insert "\")")
834 (goto-char (point-min))
68a8818d 835 (let ((files (read (current-buffer))) (p nil))
b545bfe6 836 (kill-buffer (current-buffer))
68a8818d
KH
837 (or (equal completion-ignored-extensions PC-ignored-extensions)
838 (setq PC-ignored-regexp
839 (concat "\\("
840 (mapconcat
841 'regexp-quote
842 (setq PC-ignored-extensions
843 completion-ignored-extensions)
844 "\\|")
845 "\\)\\'")))
846 (setq p nil)
847 (while files
95983b95
SM
848 ;; This whole process of going through to shell, to echo, and
849 ;; finally parsing the output is a hack. It breaks as soon as
850 ;; there are spaces in the file names or when the no-match
851 ;; message changes. To make up for it, we check that what we read
852 ;; indeed exists, so we may miss some files, but we at least won't
853 ;; list non-existent ones.
854 (or (not (file-exists-p (car files)))
855 (string-match PC-ignored-regexp (car files))
68a8818d
KH
856 (setq p (cons (car files) p)))
857 (setq files (cdr files)))
858 p))))
b545bfe6 859
f679907b
SM
860;; Facilities for loading C header files. This is independent from the
861;; main completion code. See also the variable `PC-include-file-path'
862;; at top of this file.
b545bfe6
JB
863
864(defun PC-look-for-include-file ()
865 (if (string-match "[\"<]\\([^\"<>]*\\)[\">]?$" (buffer-file-name))
866 (let ((name (substring (buffer-file-name)
867 (match-beginning 1) (match-end 1)))
868 (punc (aref (buffer-file-name) (match-beginning 0)))
869 (path nil)
870 new-buf)
871 (kill-buffer (current-buffer))
872 (if (equal name "")
f679907b 873 (with-current-buffer (car (buffer-list))
b545bfe6
JB
874 (save-excursion
875 (beginning-of-line)
876 (if (looking-at
877 "[ \t]*#[ \t]*include[ \t]+[<\"]\\(.+\\)[>\"][ \t]*[\n/]")
878 (setq name (buffer-substring (match-beginning 1)
879 (match-end 1))
880 punc (char-after (1- (match-beginning 1))))
881 ;; Suggested by Frank Siebenlist:
882 (if (or (looking-at
883 "[ \t]*([ \t]*load[ \t]+\"\\([^\"]+\\)\"")
884 (looking-at
885 "[ \t]*([ \t]*load-library[ \t]+\"\\([^\"]+\\)\"")
886 (looking-at
887 "[ \t]*([ \t]*require[ \t]+'\\([^\t )]+\\)[\t )]"))
888 (progn
889 (setq name (buffer-substring (match-beginning 1)
890 (match-end 1))
891 punc ?\<
892 path load-path)
893 (if (string-match "\\.elc$" name)
894 (setq name (substring name 0 -1))
895 (or (string-match "\\.el$" name)
896 (setq name (concat name ".el")))))
897 (error "Not on an #include line"))))))
5f34457e 898 (or (string-match "\\.[[:alnum:]]+$" name)
b545bfe6
JB
899 (setq name (concat name ".h")))
900 (if (eq punc ?\<)
901 (let ((path (or path (PC-include-file-path))))
902 (while (and path
903 (not (file-exists-p
904 (concat (file-name-as-directory (car path))
905 name))))
906 (setq path (cdr path)))
907 (if path
908 (setq name (concat (file-name-as-directory (car path)) name))
909 (error "No such include file: <%s>" name)))
f679907b 910 (let ((dir (with-current-buffer (car (buffer-list))
b545bfe6
JB
911 default-directory)))
912 (if (file-exists-p (concat dir name))
913 (setq name (concat dir name))
5b0f8cbc 914 (error "No such include file: `%s'" name))))
b545bfe6
JB
915 (setq new-buf (get-file-buffer name))
916 (if new-buf
917 ;; no need to verify last-modified time for this!
918 (set-buffer new-buf)
f679907b 919 (set-buffer (create-file-buffer name))
b545bfe6
JB
920 (erase-buffer)
921 (insert-file-contents name t))
5b0f8cbc
KH
922 ;; Returning non-nil with the new buffer current
923 ;; is sufficient to tell find-file to use it.
b545bfe6
JB
924 t)
925 nil))
926
927(defun PC-include-file-path ()
928 (or PC-include-file-path
929 (let ((env (getenv "INCPATH"))
930 (path nil)
931 pos)
932 (or env (error "No include file path specified"))
933 (while (setq pos (string-match ":[^:]+$" env))
934 (setq path (cons (substring env (1+ pos)) path)
935 env (substring env 0 pos)))
936 path)))
937
f679907b 938;; This is adapted from lib-complete.el, by Mike Williams.
b545bfe6
JB
939(defun PC-include-file-all-completions (file search-path &optional full)
940 "Return all completions for FILE in any directory on SEARCH-PATH.
8e28519a 941If optional third argument FULL is non-nil, returned pathnames should be
b545bfe6
JB
942absolute rather than relative to some directory on the SEARCH-PATH."
943 (setq search-path
cc7e4da0
SM
944 (mapcar (lambda (dir)
945 (if dir (file-name-as-directory dir) default-directory))
b545bfe6
JB
946 search-path))
947 (if (file-name-absolute-p file)
948 ;; It's an absolute file name, so don't need search-path
949 (progn
950 (setq file (expand-file-name file))
8e28519a 951 (file-name-all-completions
b545bfe6
JB
952 (file-name-nondirectory file) (file-name-directory file)))
953 (let ((subdir (file-name-directory file))
954 (ndfile (file-name-nondirectory file))
955 file-lists)
956 ;; Append subdirectory part to each element of search-path
957 (if subdir
958 (setq search-path
cc7e4da0 959 (mapcar (lambda (dir) (concat dir subdir))
b545bfe6
JB
960 search-path)
961 file ))
962 ;; Make list of completions in each directory on search-path
963 (while search-path
964 (let* ((dir (car search-path))
965 (subdir (if full dir subdir)))
966 (if (file-directory-p dir)
967 (progn
968 (setq file-lists
8e28519a 969 (cons
cc7e4da0 970 (mapcar (lambda (file) (concat subdir file))
8e28519a 971 (file-name-all-completions ndfile
b545bfe6
JB
972 (car search-path)))
973 file-lists))))
974 (setq search-path (cdr search-path))))
975 ;; Compress out duplicates while building complete list (slloooow!)
976 (let ((sorted (sort (apply 'nconc file-lists)
cc7e4da0 977 (lambda (x y) (not (string-lessp x y)))))
b545bfe6
JB
978 compressed)
979 (while sorted
980 (if (equal (car sorted) (car compressed)) nil
981 (setq compressed (cons (car sorted) compressed)))
982 (setq sorted (cdr sorted)))
983 compressed))))
984
8d85a565
SM
985(defadvice read-file-name-internal (around PC-include-file disable)
986 (if (string-match "<\\([^\"<>]*\\)>?\\'" (ad-get-arg 0))
987 (let* ((string (ad-get-arg 0))
988 (action (ad-get-arg 2))
08fd202a 989 (name (substring string (match-beginning 1) (match-end 1)))
b545bfe6
JB
990 (str2 (substring string (match-beginning 0)))
991 (completion-table
08fd202a 992 (mapcar (lambda (x) (format "<%s>" x))
b545bfe6
JB
993 (PC-include-file-all-completions
994 name (PC-include-file-path)))))
8d85a565
SM
995 (setq ad-return-value
996 (cond
997 ((not completion-table) nil)
998 ((eq action 'lambda) (test-completion str2 completion-table nil))
999 ((eq action nil) (try-completion str2 completion-table nil))
1000 ((eq action t) (all-completions str2 completion-table nil)))))
1001 ad-do-it))
b545bfe6 1002\f
92677e25 1003
b545bfe6
JB
1004(provide 'complete)
1005
a7ad0079 1006;; arch-tag: fc7e2768-ff44-4e22-b579-4d825b968458
e8af40ee 1007;;; complete.el ends here