| blob | 222a0cfba61f540e2694d95520cf02c929ebd2c3 |
1 ;; complete.el -- partial completion mechanism plus other goodies.
3 ;; Copyright (C) 1990, 1991, 1992, 1993 Free Software Foundation, Inc.
5 ;; Author: Dave Gillespie <daveg@synaptics.com>
6 ;; Version: 2.02
7 ;; Special thanks to Hallvard Furuseth for his many ideas and contributions.
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is distributed in the hope that it will be useful,
12 ;; but WITHOUT ANY WARRANTY. No author or distributor
13 ;; accepts responsibility to anyone for the consequences of using it
14 ;; or for whether it serves any particular purpose or works at all,
15 ;; unless he says so in writing. Refer to the GNU Emacs General Public
16 ;; License for full details.
18 ;; Everyone is granted permission to copy, modify and redistribute
19 ;; GNU Emacs, but only under the conditions described in the
20 ;; GNU Emacs General Public License. A copy of this license is
21 ;; supposed to have been given to you along with GNU Emacs so you
22 ;; can know your rights and responsibilities. It should be in a
23 ;; file named COPYING. Among other things, the copyright notice
24 ;; and this notice must be preserved on all copies.
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: Load this file. Now, 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 ;; (load "complete")
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 ;; This package also contains a wildcard feature for C-x C-f (find-file).
82 ;; For example, `C-x C-f *.c RET' loads all .c files at once, exactly
83 ;; as if you had typed C-x C-f separately for each file. Completion
84 ;; is supported in connection with wildcards. Currently only the `*'
85 ;; wildcard character works.
87 ;; File name completion does not do partial completion of directories
88 ;; on the path, e.g., "/u/b/f" will not complete to "/usr/bin/foo",
89 ;; but you can put *'s in the path to accomplish this: "/u*/b*/f".
90 ;; Stars are required for performance reasons.
92 ;; In addition, this package includes a feature for accessing include
93 ;; files. For example, `C-x C-f <sys/time.h> RET' reads the file
94 ;; /usr/include/sys/time.h. The variable PC-include-file-path is a
95 ;; list of directories in which to search for include files. Completion
96 ;; is supported in include file names.
99 ;; Code:
102 "*If nil, TAB does normal Emacs completion and M-TAB does Partial Completion.
107 "*A string of characters which are to be treated as word delimiters
108 by the Partial Completion system.
110 Some arcane rules: If `]' is in this string it must come first.
111 If `^' is in this string it must NOT come first. If `-' is in this
112 string, it must come first or right after `]'. In other words, if
113 S is this string, then `[S]' must be a legal Emacs regular expression
118 "*If t, first character of a string to be completed is always taken literally.
119 If nil, word delimiters are handled even if they appear as first character.
125 "*List of directories in which to look for include files.
163 ))
173 `beginning-of-defun', so this would produce a list of completions
174 just like when normal Emacs completions are ambiguous.
186 See `PC-complete' for details.
187 This can be bound to other keys, like `-' and `.', if you wish."
200 See `PC-complete' for details.
201 This is suitable for binding to other keys which should act just like SPC."
212 See `PC-complete' for details."
220 See `PC-complete' for details."
238 See `PC-complete' for details."
266 read-directory-name-internal)))
271 basestr
272 regex
273 p offset
275 helpposs
278 ;; Check if buffer contents can already be considered complete
281 'complete
283 ;; Do substitutions in directory names
291 ;; Prepare various delimiter strings
298 ;; Look for wildcard expansions in directory name
302 files)
306 "*"
317 ambig t)
324 ;; Strip directory name if appropriate
333 ;; Convert search pattern to a standard regular expression
339 p offset)
343 PC-ndelims-regex
344 PC-delim-regex
351 PC-ndelims-regex
358 "[^/]*"
360 ;;(setq the-regex regex)
363 ;; Find an initial list of possible completions
366 str
369 ;; Minibuffer contains no hyphens -- simple case!
371 table
372 pred))
374 ;; Use all-completions to do an initial cull. This is a big win,
375 ;; since all-completions is written in C!
377 table
378 pred)))
385 ;; Now we have a list of possible completions
388 ;; No valid completions found
397 " (Ambiguous dir name)"
399 " (No completions)"
401 nil))
403 ;; More than one valid completion found
407 ;; Handle completion-ignored-extensions
412 ;; Build a regular expression representing the extensions list
417 'regexp-quote
419 completion-ignored-extensions)
423 ;; Check if there are any without an ignored extension
430 ;; If there are "good" names, use them
433 ;; Is the actual string one of the possible completions?
443 t)
445 ;; If ambiguous, try for a partial completion
447 prefix
451 ;; Check if next few letters are the same in all cases
468 PC-delims-list))
488 PC-ndelims-regex)
490 ""
497 x
499 poss)))
513 ;; We changed it... would it be complete without the space?
515 table pred)
520 ;; We changed it... enough to be complete?
524 ;; If totally ambiguous, display a list of completions
530 nil)))))
532 ;; Only one possible completion
541 t)))))
555 res)))
566 new)))
571 "A Lisp version of `temp_minibuffer_message' from minibuf.c."
592 "Perform completion on Lisp symbol preceding point.
593 That symbol is compared against the symbols that exist
594 and any additional characters determined by what is there
595 are inserted.
596 If the symbol starts just after an open-parenthesis,
597 only symbols with function definitions are considered.
598 Otherwise, all symbols with function definitions, values
599 or properties are considered."
615 'fboundp
623 ;;; Wildcards in `C-x C-f' command. This is independent from the main
624 ;;; completion code, except for `PC-expand-many-files' which is called
625 ;;; when "*"'s are found in the path during filename completion. (The
626 ;;; above completion code always understands "*"'s, except in file paths,
627 ;;; without relying on the following code.)
644 ;; This modifies the "buf" variable inside find-file-noselect.
647 nil ; should do verify-visited-file-modtime stuff.
656 'identity
660 find-file-hooks)))
661 ;; This modifies the "error" variable inside find-file-noselect.
663 t)
664 nil))
677 nil
688 files))))
693 find-file-not-found-hooks)))
697 ;;; Facilities for loading C header files. This is independent from the
698 ;;; main completion code. See also the variable `PC-include-file-path'
699 ;;; at top of this file.
707 new-buf)
719 ;; Suggested by Frank Siebenlist:
729 punc ?\<
730 path load-path)
743 name))))
750 default-directory)))
756 ;; no need to verify last-modified time for this!
763 error nil
764 buf new-buf)
765 t)
766 nil))
772 pos)
777 path)))
779 ;;; This is adapted from lib-complete.el, by Mike Williams.
781 "Return all completions for FILE in any directory on SEARCH-PATH.
782 If optional third argument FULL is non-nil, returned pathnames should be
783 absolute rather than relative to some directory on the SEARCH-PATH."
787 search-path))
789 ;; It's an absolute file name, so don't need search-path
796 file-lists)
797 ;; Append subdirectory part to each element of search-path
801 search-path)
802 file ))
803 ;; Make list of completions in each directory on search-path
814 file-lists))))
816 ;; Compress out duplicates while building complete list (slloooow!)
819 compressed)
824 compressed))))
847 find-file-not-found-hooks)))
850 PC-old-read-file-name-internal
856 \f
859 ;;; End.