| blob | ce5094d1aef73e9608974aa041b5e937b4871065 |
1 ;;; complete.el --- partial completion mechanism plus other goodies
3 ;; Copyright (C) 1990, 1991, 1992, 1993, 1999, 2000, 2001, 2002, 2003,
4 ;; 2004, 2005, 2006, 2007 Free Software Foundation, Inc.
6 ;; Author: Dave Gillespie <daveg@synaptics.com>
7 ;; Keywords: abbrev convenience
8 ;; Special thanks to Hallvard Furuseth for his many ideas and contributions.
10 ;; This file is part of GNU Emacs.
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.
17 ;; GNU Emacs is distributed in the hope that it will be useful,
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.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs; see the file COPYING. If not, write to the
24 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
25 ;; Boston, MA 02110-1301, USA.
27 ;;; Commentary:
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.
50 ;; Usage: M-x partial-completion-mode. During completable minibuffer entry,
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 ;;
65 ;; (partial-completion-mode t)
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.
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.
88 ;;; Code:
91 "Partial Completion of items."
97 "Control how the first character of a string is to be interpreted.
98 If nil, the first character of a string is not taken literally if it is a word
100 If t, the first character of a string is always taken literally even if it is a
102 If non-nil and non-t, the first character is taken literally only for file name
103 completion."
110 "If non-nil, TAB means PC completion and M-TAB means normal completion.
111 Otherwise, TAB means normal completion and M-TAB means Partial Completion."
116 "A string of characters treated as word delimiters for completion.
117 Some arcane rules:
118 If `]' is in this string, it must come first.
119 If `^' is in this string, it must not come first.
120 If `-' is in this string, it must come first or right after `]'.
121 In other words, if S is this string, then `[S]' must be a valid Emacs regular
122 expression (not containing character ranges like `a-z')."
127 "A list of directories in which to look for include files.
128 If nil, means use the colon-separated path in the variable $INCPATH instead."
143 \f
148 ;; These bindings are the default bindings. It would be better to
149 ;; restore the previous bindings.
190 ;;;###autoload
192 "Toggle Partial Completion mode.
193 With prefix ARG, turn Partial Completion mode on if ARG is positive.
195 When Partial Completion mode is enabled, TAB (or M-TAB if `PC-meta-flag' is
196 nil) is enhanced so that if some string is divided into words and each word is
197 delimited by a character in `PC-word-delimiters', partial words are completed
198 as much as possible and `*' characters are treated likewise in file names.
200 For example, M-x p-c-m expands to M-x partial-completion-mode since no other
201 command begins with that sequence of characters, and
203 other file in that directory begins with that sequence of characters.
205 Unless `PC-disable-includes' is non-nil, the `<...>' sequence is interpreted
208 See also the variable `PC-include-file-path'.
210 Partial Completion mode extends the meaning of `completion-auto-help' (which
211 see), so that if it is neither nil nor t, Emacs shows the `*Completions*'
212 buffer only on the second attempt to complete. That is, if TAB finds nothing
214 second TAB brings up the `*Completions*' buffer."
216 ;; Deal with key bindings...
218 ;; Deal with include file feature...
223 ;; ... with some underhand redefining.
230 ;; Adjust the completion selection in *Completion* buffers to the way
231 ;; we work. The default minibuffer completion code only completes the
232 ;; text before point and leaves the text after point alone (new in
233 ;; Emacs-22). In contrast we use the whole text and we even sometimes
234 ;; move point to a place before EOB, to indicate the first position where
235 ;; there's a difference, so when the user uses choose-completion, we have
236 ;; to trick choose-completion into replacing the whole minibuffer text
237 ;; rather than only the text before point. --Stef
240 'choose-completion-string-functions
243 nil))
244 ;; Build the env-completion and mapping table.
251 process-environment))))
253 \f
261 `beginning-of-defun', so this would produce a list of completions
262 just like when normal Emacs completions are ambiguous.
269 ;; If the previous command was not this one,
270 ;; never scroll, always retry completion.
274 ;; If there's a fresh completion window with a live buffer,
275 ;; and this command is repeated, scroll that window.
287 See `PC-complete' for details.
288 This can be bound to other keys, like `-' and `.', if you wish."
301 See `PC-complete' for details.
302 This is suitable for binding to other keys which should act just like SPC."
313 See `PC-complete' for details."
321 See `PC-complete' for details."
339 See `PC-complete' for details."
363 "A function testing whether a minibuffer completion now will work filename-style.
364 The function takes no arguments, and typically looks at the value
367 ;; Returns the sequence of non-delimiter characters that follow regexp in string.
374 ;; result may contain multiple chunks
377 result))
380 "Like `test-completion', but ignores case when possible."
381 ;; Binding completion-ignore-case to nil ensures, for compatibility with
382 ;; standard completion, that the return value is exactly one of the
383 ;; possibilities. Do this binding only if pred is nil, out of paranoia;
384 ;; perhaps it is safe even if pred is non-nil.
390 ;; The following function is an attempt to work around two problems:
392 ;; (1) When complete.el was written, (try-completion "" '(("") (""))) used to
393 ;; return the value "". With a change from 2002-07-07 it returns t which caused
394 ;; `PC-lisp-complete-symbol' to fail with a "Wrong type argument: sequencep, t"
395 ;; error. `PC-try-completion' returns STRING in this case.
397 ;; (2) (try-completion "" '((""))) returned t before the above-mentioned change.
398 ;; Since `PC-chop-word' operates on the return value of `try-completion' this
399 ;; case might have provoked a similar error as in (1). `PC-try-completion'
400 ;; returns "" instead. I don't know whether this is a real problem though.
402 ;; Since `PC-try-completion' is not a guaranteed to fix these bugs reliably, you
403 ;; should try to look at the following discussions when you encounter problems:
404 ;; - emacs-pretest-bug ("Partial Completion" starting 2007-02-23),
405 ;; - emacs-devel ("[address-of-OP: Partial completion]" starting 2007-02-24),
406 ;; - emacs-devel ("[address-of-OP: EVAL and mouse selection in *Completions*]"
407 ;; starting 2007-03-05).
409 "Like `try-completion' but return STRING instead of t."
420 ;; The following used to be "(dirlength 0)" which caused the erasure of
421 ;; the entire buffer text before `point' when inserting a completion
422 ;; into a buffer.
423 dirlength
427 basestr origstr
428 env-on
429 regex
430 p offset
432 helpposs
435 ;; Check if buffer contents can already be considered complete
439 ;; If completion-ignore-case is non-nil, insert the
440 ;; completion string since that may have a different case.
447 ;; Do substitutions in directory names
451 ;; Do substitutions in directory names
460 ;; Prepare various delimiter strings
467 ;; Add wildcards if necessary
471 ;; The base dir for file-completion is passed in `predicate'.
482 ;; Look for wildcard expansions in directory name
486 ;; The base dir for file-completion is passed in `predicate'.
488 files)
492 "*"
503 ambig t)
509 ;; If the wildcards were introduced by us, it's possible
510 ;; that read-file-name-internal (especially our
511 ;; PC-include-file advice) can still find matches for the
512 ;; original string even if we couldn't, so remove the
513 ;; added wildcards.
517 ;; Strip directory name if appropriate
524 ;; Make sure str is consistent with its directory and basename
525 ;; parts. This is important on DOZe'NT systems when str only
526 ;; includes a drive letter, like in "d:".
530 ;; Convert search pattern to a standard regular expression
536 p offset)
540 PC-ndelims-regex
541 PC-delim-regex
548 PC-ndelims-regex
555 "[^/]*"
557 ;;(setq the-regex regex)
563 table PC-env-vars-alist
564 pred nil))
566 ;; Find an initial list of possible completions
569 str
572 ;; Minibuffer contains no hyphens -- simple case!
574 basestr str)
575 table
576 pred))
578 ;; Use all-completions to do an initial cull. This is a big win,
579 ;; since all-completions is written in C!
583 table
584 pred)))
593 ;; If table had duplicates, they can be here.
596 ;; Handle completion-ignored-extensions
601 ;; Build a regular expression representing the extensions list
606 'regexp-quote
608 completion-ignored-extensions)
612 ;; Check if there are any without an ignored extension.
613 ;; Also ignore `.' and `..'.
621 ;; If there are "good" names, use them
624 ;; Now we have a list of possible completions
627 ;; No valid completions found
636 " [Ambiguous dir name]"
638 " [No completions]"
640 nil))
642 ;; More than one valid completion found
646 ;; Is the actual string one of the possible completions?
656 t
658 ;; If ambiguous, try for a partial completion
660 prefix
664 ;; Check if next few letters are the same in all cases
669 ;; Retain capitalization of user input even if
670 ;; completion-ignore-case is set.
680 ;; same char (modulo case); no action
685 PC-delims-list)))
686 ;; replace " " by the actual delimiter
690 ;; insert a new character
704 PC-ndelims-regex)
707 ;; not basestr, because that does
708 ;; not reflect insertions
711 skip)
716 poss)))
730 ;; We changed it... would it be complete without the space?
732 table pred)
737 ;; We changed it... enough to be complete?
741 ;; If totally ambiguous, display a list of completions
749 ;; Record which part of the buffer we are completing
750 ;; so that choosing a completion from the list
751 ;; knows how much old text to replace.
754 nil)))))
756 ;; Only one possible completion
767 t)))))
778 new)))
783 "A Lisp version of `temp_minibuffer_message' from minibuf.c."
804 "Perform completion on Lisp symbol preceding point.
805 That symbol is compared against the symbols that exist
806 and any additional characters determined by what is there
807 are inserted.
808 If the symbol starts just after an open-parenthesis,
809 only symbols with function definitions are considered.
810 Otherwise, all symbols with function definitions, values
811 or properties are considered."
823 'fboundp
831 "Perform completion on file names preceding point.
832 Environment vars are converted to their values."
845 ;; Use the shell to do globbing.
846 ;; This could now use file-expand-wildcards instead.
853 ;; If the current working directory doesn't exist `shell-command'
854 ;; signals an error. So if the file names we're looking for don't
855 ;; depend on the working directory, switch to a valid directory first.
859 ;; CSH-style shells were known to output "No match", whereas
860 ;; SH-style shells tend to simply output `name' when no match is found.
866 nil
881 'regexp-quote
883 completion-ignored-extensions)
888 ;; This whole process of going through to shell, to echo, and
889 ;; finally parsing the output is a hack. It breaks as soon as
890 ;; there are spaces in the file names or when the no-match
891 ;; message changes. To make up for it, we check that what we read
892 ;; indeed exists, so we may miss some files, but we at least won't
893 ;; list non-existent ones.
898 p))))
900 ;; Facilities for loading C header files. This is independent from the
901 ;; main completion code. See also the variable `PC-include-file-path'
902 ;; at top of this file.
910 new-buf)
921 ;; Suggested by Frank Siebenlist:
931 punc ?\<
932 path load-path)
945 name))))
951 default-directory)))
957 ;; no need to verify last-modified time for this!
962 ;; Returning non-nil with the new buffer current
963 ;; is sufficient to tell find-file to use it.
964 t)
965 nil))
971 pos)
976 path)))
978 ;; This is adapted from lib-complete.el, by Mike Williams.
980 "Return all completions for FILE in any directory on SEARCH-PATH.
981 If optional third argument FULL is non-nil, returned pathnames should be
982 absolute rather than relative to some directory on the SEARCH-PATH."
986 search-path))
988 ;; It's an absolute file name, so don't need search-path
995 file-lists)
996 ;; Append subdirectory part to each element of search-path
1000 search-path)
1001 file ))
1002 ;; Make list of completions in each directory on search-path
1013 file-lists))))
1015 ;; Compress out duplicates while building complete list (slloooow!)
1018 compressed)
1023 compressed))))
1041 ad-do-it))
1042 \f
1046 ;; arch-tag: fc7e2768-ff44-4e22-b579-4d825b968458
1047 ;;; complete.el ends here