| blob | 3230524e730f7f43d381677f37a4159f66042468 |
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 ;; Keywords: abbrev
7 ;; Version: 2.02
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
24 ;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
26 ;;; Commentary:
28 ;; Extended completion for the Emacs minibuffer.
29 ;;
30 ;; The basic idea is that the command name or other completable text is
31 ;; divided into words and each word is completed separately, so that
32 ;; "M-x p-b" expands to "M-x print-buffer". If the entry is ambiguous
33 ;; each word is completed as much as possible and then the cursor is
34 ;; left at the first position where typing another letter will resolve
35 ;; the ambiguity.
36 ;;
37 ;; Word separators for this purpose are hyphen, space, and period.
38 ;; These would most likely occur in command names, Info menu items,
39 ;; and file names, respectively. But all word separators are treated
40 ;; alike at all times.
41 ;;
42 ;; This completion package replaces the old-style completer's key
43 ;; bindings for TAB, SPC, RET, and `?'. The old completer is still
44 ;; available on the Meta versions of those keys. If you set
45 ;; PC-meta-flag to nil, the old completion keys will be left alone
46 ;; and the partial completer will use the Meta versions of the keys.
49 ;; Usage: Load this file. Now, during completable minibuffer entry,
50 ;;
51 ;; TAB means to do a partial completion;
52 ;; SPC means to do a partial complete-word;
53 ;; RET means to do a partial complete-and-exit;
54 ;; ? means to do a partial completion-help.
55 ;;
56 ;; If you set PC-meta-flag to nil, then TAB, SPC, RET, and ? perform
57 ;; original Emacs completions, and M-TAB etc. do partial completion.
58 ;; To do this, put the command,
59 ;;
60 ;; (setq PC-meta-flag nil)
61 ;;
62 ;; in your .emacs file. To load partial completion automatically, put
63 ;;
64 ;; (load "complete")
65 ;;
66 ;; in your .emacs file, too. Things will be faster if you byte-compile
67 ;; this file when you install it.
68 ;;
69 ;; As an extra feature, in cases where RET would not normally
70 ;; complete (such as `C-x b'), the M-RET key will always do a partial
71 ;; complete-and-exit. Thus `C-x b f.c RET' will select or create a
72 ;; buffer called "f.c", but `C-x b f.c M-RET' will select the existing
73 ;; buffer whose name matches that pattern (perhaps "filing.c").
74 ;; (PC-meta-flag does not affect this behavior; M-RET used to be
75 ;; undefined in this situation.)
76 ;;
77 ;; The regular M-TAB (lisp-complete-symbol) command also supports
78 ;; partial completion in this package.
80 ;; This package also contains a wildcard feature for C-x C-f (find-file).
81 ;; For example, `C-x C-f *.c RET' loads all .c files at once, exactly
82 ;; as if you had typed C-x C-f separately for each file. Completion
83 ;; is supported in connection with wildcards. Currently only the `*'
84 ;; wildcard character works.
86 ;; File name completion does not do partial completion of directories
87 ;; on the path, e.g., "/u/b/f" will not complete to "/usr/bin/foo",
88 ;; but you can put *'s in the path to accomplish this: "/u*/b*/f".
89 ;; Stars are required for performance reasons.
91 ;; In addition, this package includes a feature for accessing include
92 ;; files. For example, `C-x C-f <sys/time.h> RET' reads the file
93 ;; /usr/include/sys/time.h. The variable PC-include-file-path is a
94 ;; list of directories in which to search for include files. Completion
95 ;; is supported in include file names.
98 ;;; Code:
101 "*If nil, TAB does normal Emacs completion and M-TAB does Partial Completion.
106 "*A string of characters which are to be treated as word delimiters
107 by the Partial Completion system.
109 Some arcane rules: If `]' is in this string it must come first.
110 If `^' is in this string it must NOT come first. If `-' is in this
111 string, it must come first or right after `]'. In other words, if
112 S is this string, then `[S]' must be a legal Emacs regular expression
117 "*If t, first character of a string to be completed is always taken literally.
118 If nil, word delimiters are handled even if they appear as first character.
124 "*List of directories in which to look for include files.
162 ))
172 `beginning-of-defun', so this would produce a list of completions
173 just like when normal Emacs completions are ambiguous.
185 See `PC-complete' for details.
186 This can be bound to other keys, like `-' and `.', if you wish."
199 See `PC-complete' for details.
200 This is suitable for binding to other keys which should act just like SPC."
211 See `PC-complete' for details."
219 See `PC-complete' for details."
237 See `PC-complete' for details."
265 read-directory-name-internal)))
267 dirlength
271 basestr
272 regex
273 p offset
275 helpposs
278 ;; Check if buffer contents can already be considered complete
281 'complete
283 ;; Record how many characters at the beginning are not included
284 ;; in completion.
290 ;; Do substitutions in directory names
298 ;; Prepare various delimiter strings
305 ;; Look for wildcard expansions in directory name
309 files)
313 "*"
324 ambig t)
331 ;; Strip directory name if appropriate
340 ;; Convert search pattern to a standard regular expression
346 p offset)
350 PC-ndelims-regex
351 PC-delim-regex
358 PC-ndelims-regex
365 "[^/]*"
367 ;;(setq the-regex regex)
370 ;; Find an initial list of possible completions
373 str
376 ;; Minibuffer contains no hyphens -- simple case!
378 table
379 pred))
381 ;; Use all-completions to do an initial cull. This is a big win,
382 ;; since all-completions is written in C!
384 table
385 pred)))
392 ;; Now we have a list of possible completions
395 ;; No valid completions found
404 " [Ambiguous dir name]"
406 " [No completions]"
408 nil))
410 ;; More than one valid completion found
414 ;; Handle completion-ignored-extensions
419 ;; Build a regular expression representing the extensions list
424 'regexp-quote
426 completion-ignored-extensions)
430 ;; Check if there are any without an ignored extension
437 ;; If there are "good" names, use them
440 ;; Is the actual string one of the possible completions?
450 t
452 ;; If ambiguous, try for a partial completion
454 prefix
458 ;; Check if next few letters are the same in all cases
475 PC-delims-list))
487 ;; Use format to discard text properties.
496 PC-ndelims-regex)
498 ""
505 x
507 poss)))
521 ;; We changed it... would it be complete without the space?
523 table pred)
528 ;; We changed it... enough to be complete?
532 ;; If totally ambiguous, display a list of completions
539 ;; Record which part of the buffer we are completing
540 ;; so that choosing a completion from the list
541 ;; knows how much old text to replace.
544 nil)))))
546 ;; Only one possible completion
556 t)))))
570 res)))
581 new)))
586 "A Lisp version of `temp_minibuffer_message' from minibuf.c."
607 "Perform completion on Lisp symbol preceding point.
608 That symbol is compared against the symbols that exist
609 and any additional characters determined by what is there
610 are inserted.
611 If the symbol starts just after an open-parenthesis,
612 only symbols with function definitions are considered.
613 Otherwise, all symbols with function definitions, values
614 or properties are considered."
630 'fboundp
638 ;;; Wildcards in `C-x C-f' command. This is independent from the main
639 ;;; completion code, except for `PC-expand-many-files' which is called
640 ;;; when "*"'s are found in the path during filename completion. (The
641 ;;; above completion code always understands "*"'s, except in file paths,
642 ;;; without relying on the following code.)
659 ;; This modifies the "buf" variable inside find-file-noselect.
662 nil ; should do verify-visited-file-modtime stuff.
671 'identity
675 find-file-hooks)))
676 ;; This modifies the "error" variable inside find-file-noselect.
678 t)
679 nil))
692 nil
703 files))))
708 find-file-not-found-hooks)))
712 ;;; Facilities for loading C header files. This is independent from the
713 ;;; main completion code. See also the variable `PC-include-file-path'
714 ;;; at top of this file.
722 new-buf)
734 ;; Suggested by Frank Siebenlist:
744 punc ?\<
745 path load-path)
758 name))))
765 default-directory)))
771 ;; no need to verify last-modified time for this!
778 error nil
779 buf new-buf)
780 t)
781 nil))
787 pos)
792 path)))
794 ;;; This is adapted from lib-complete.el, by Mike Williams.
796 "Return all completions for FILE in any directory on SEARCH-PATH.
797 If optional third argument FULL is non-nil, returned pathnames should be
798 absolute rather than relative to some directory on the SEARCH-PATH."
802 search-path))
804 ;; It's an absolute file name, so don't need search-path
811 file-lists)
812 ;; Append subdirectory part to each element of search-path
816 search-path)
817 file ))
818 ;; Make list of completions in each directory on search-path
829 file-lists))))
831 ;; Compress out duplicates while building complete list (slloooow!)
834 compressed)
839 compressed))))
862 find-file-not-found-hooks)))
865 PC-old-read-file-name-internal
871 \f
874 ;;; End.