| blob | bbba4fd129e0212122d6cbae5920f3010b727c58 |
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 the
24 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
25 ;; Boston, MA 02111-1307, 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: 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.
181 ;; If the previous command was not this one,
182 ;; never scroll, always retry completion.
186 ;; If there's a fresh completion window with a live buffer,
187 ;; and this command is repeated, scroll that window.
200 See `PC-complete' for details.
201 This can be bound to other keys, like `-' and `.', if you wish."
214 See `PC-complete' for details.
215 This is suitable for binding to other keys which should act just like SPC."
226 See `PC-complete' for details."
234 See `PC-complete' for details."
252 See `PC-complete' for details."
279 "A function testing whether a minibuffer completion now will work filename-style.
280 The function takes no arguments, and typically looks at the value
290 dirlength
294 basestr
295 regex
296 p offset
298 helpposs
301 ;; Check if buffer contents can already be considered complete
304 'complete
306 ;; Record how many characters at the beginning are not included
307 ;; in completion.
313 ;; Do substitutions in directory names
321 ;; Prepare various delimiter strings
328 ;; Look for wildcard expansions in directory name
332 files)
336 "*"
347 ambig t)
354 ;; Strip directory name if appropriate
363 ;; Convert search pattern to a standard regular expression
369 p offset)
373 PC-ndelims-regex
374 PC-delim-regex
381 PC-ndelims-regex
388 "[^/]*"
390 ;;(setq the-regex regex)
393 ;; Find an initial list of possible completions
396 str
399 ;; Minibuffer contains no hyphens -- simple case!
401 table
402 pred))
404 ;; Use all-completions to do an initial cull. This is a big win,
405 ;; since all-completions is written in C!
407 table
408 pred)))
415 ;; Now we have a list of possible completions
418 ;; No valid completions found
427 " [Ambiguous dir name]"
429 " [No completions]"
431 nil))
433 ;; More than one valid completion found
437 ;; Handle completion-ignored-extensions
442 ;; Build a regular expression representing the extensions list
447 'regexp-quote
449 completion-ignored-extensions)
453 ;; Check if there are any without an ignored extension
460 ;; If there are "good" names, use them
463 ;; Is the actual string one of the possible completions?
473 t
475 ;; If ambiguous, try for a partial completion
477 prefix
481 ;; Check if next few letters are the same in all cases
498 PC-delims-list))
510 ;; Use format to discard text properties.
519 PC-ndelims-regex)
521 ""
528 x
530 poss)))
544 ;; We changed it... would it be complete without the space?
546 table pred)
551 ;; We changed it... enough to be complete?
555 ;; If totally ambiguous, display a list of completions
562 ;; Record which part of the buffer we are completing
563 ;; so that choosing a completion from the list
564 ;; knows how much old text to replace.
567 nil)))))
569 ;; Only one possible completion
579 t)))))
593 res)))
604 new)))
609 "A Lisp version of `temp_minibuffer_message' from minibuf.c."
630 "Perform completion on Lisp symbol preceding point.
631 That symbol is compared against the symbols that exist
632 and any additional characters determined by what is there
633 are inserted.
634 If the symbol starts just after an open-parenthesis,
635 only symbols with function definitions are considered.
636 Otherwise, all symbols with function definitions, values
637 or properties are considered."
653 'fboundp
661 ;;; Wildcards in `C-x C-f' command. This is independent from the main
662 ;;; completion code, except for `PC-expand-many-files' which is called
663 ;;; when "*"'s are found in the path during filename completion. (The
664 ;;; above completion code always understands "*"'s, except in file paths,
665 ;;; without relying on the following code.)
682 ;; This modifies the "buf" variable inside find-file-noselect.
685 nil ; should do verify-visited-file-modtime stuff.
694 'identity
698 find-file-hooks)))
699 ;; This modifies the "error" variable inside find-file-noselect.
701 t)
702 nil))
715 nil
726 files))))
731 find-file-not-found-hooks)))
735 ;;; Facilities for loading C header files. This is independent from the
736 ;;; main completion code. See also the variable `PC-include-file-path'
737 ;;; at top of this file.
745 new-buf)
757 ;; Suggested by Frank Siebenlist:
767 punc ?\<
768 path load-path)
781 name))))
788 default-directory)))
794 ;; no need to verify last-modified time for this!
801 error nil
802 buf new-buf)
803 t)
804 nil))
810 pos)
815 path)))
817 ;;; This is adapted from lib-complete.el, by Mike Williams.
819 "Return all completions for FILE in any directory on SEARCH-PATH.
820 If optional third argument FULL is non-nil, returned pathnames should be
821 absolute rather than relative to some directory on the SEARCH-PATH."
825 search-path))
827 ;; It's an absolute file name, so don't need search-path
834 file-lists)
835 ;; Append subdirectory part to each element of search-path
839 search-path)
840 file ))
841 ;; Make list of completions in each directory on search-path
852 file-lists))))
854 ;; Compress out duplicates while building complete list (slloooow!)
857 compressed)
862 compressed))))
885 find-file-not-found-hooks)))
888 PC-old-read-file-name-internal
894 \f
897 ;;; End.