| blob | fa559e91395c223ddaadc5254daf2d30698e15f8 |
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 free software; you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation; either version 2, or (at your option)
14 ;; any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs; see the file COPYING. If not, write to
23 ;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
25 ;;; Commentary:
27 ;; Extended completion for the Emacs minibuffer.
28 ;;
29 ;; The basic idea is that the command name or other completable text is
30 ;; divided into words and each word is completed separately, so that
31 ;; "M-x p-b" expands to "M-x print-buffer". If the entry is ambiguous
32 ;; each word is completed as much as possible and then the cursor is
33 ;; left at the first position where typing another letter will resolve
34 ;; the ambiguity.
35 ;;
36 ;; Word separators for this purpose are hyphen, space, and period.
37 ;; These would most likely occur in command names, Info menu items,
38 ;; and file names, respectively. But all word separators are treated
39 ;; alike at all times.
40 ;;
41 ;; This completion package replaces the old-style completer's key
42 ;; bindings for TAB, SPC, RET, and `?'. The old completer is still
43 ;; available on the Meta versions of those keys. If you set
44 ;; PC-meta-flag to nil, the old completion keys will be left alone
45 ;; and the partial completer will use the Meta versions of the keys.
48 ;; Usage: Load this file. Now, during completable minibuffer entry,
49 ;;
50 ;; TAB means to do a partial completion;
51 ;; SPC means to do a partial complete-word;
52 ;; RET means to do a partial complete-and-exit;
53 ;; ? means to do a partial completion-help.
54 ;;
55 ;; If you set PC-meta-flag to nil, then TAB, SPC, RET, and ? perform
56 ;; original Emacs completions, and M-TAB etc. do partial completion.
57 ;; To do this, put the command,
58 ;;
59 ;; (setq PC-meta-flag nil)
60 ;;
61 ;; in your .emacs file. To load partial completion automatically, put
62 ;;
63 ;; (load "complete")
64 ;;
65 ;; in your .emacs file, too. Things will be faster if you byte-compile
66 ;; this file when you install it.
67 ;;
68 ;; As an extra feature, in cases where RET would not normally
69 ;; complete (such as `C-x b'), the M-RET key will always do a partial
70 ;; complete-and-exit. Thus `C-x b f.c RET' will select or create a
71 ;; buffer called "f.c", but `C-x b f.c M-RET' will select the existing
72 ;; buffer whose name matches that pattern (perhaps "filing.c").
73 ;; (PC-meta-flag does not affect this behavior; M-RET used to be
74 ;; undefined in this situation.)
75 ;;
76 ;; The regular M-TAB (lisp-complete-symbol) command also supports
77 ;; partial completion in this package.
79 ;; This package also contains a wildcard feature for C-x C-f (find-file).
80 ;; For example, `C-x C-f *.c RET' loads all .c files at once, exactly
81 ;; as if you had typed C-x C-f separately for each file. Completion
82 ;; is supported in connection with wildcards. Currently only the `*'
83 ;; wildcard character works.
85 ;; File name completion does not do partial completion of directories
86 ;; on the path, e.g., "/u/b/f" will not complete to "/usr/bin/foo",
87 ;; but you can put *'s in the path to accomplish this: "/u*/b*/f".
88 ;; Stars are required for performance reasons.
90 ;; In addition, this package includes a feature for accessing include
91 ;; files. For example, `C-x C-f <sys/time.h> RET' reads the file
92 ;; /usr/include/sys/time.h. The variable PC-include-file-path is a
93 ;; list of directories in which to search for include files. Completion
94 ;; is supported in include file names.
97 ;;; Code:
100 "*If nil, TAB does normal Emacs completion and M-TAB does Partial Completion.
105 "*A string of characters which are to be treated as word delimiters
106 by the Partial Completion system.
108 Some arcane rules: If `]' is in this string it must come first.
109 If `^' is in this string it must NOT come first. If `-' is in this
110 string, it must come first or right after `]'. In other words, if
111 S is this string, then `[S]' must be a legal Emacs regular expression
116 "*If t, first character of a string to be completed is always taken literally.
117 If nil, word delimiters are handled even if they appear as first character.
123 "*List of directories in which to look for include files.
161 ))
171 `beginning-of-defun', so this would produce a list of completions
172 just like when normal Emacs completions are ambiguous.
184 See `PC-complete' for details.
185 This can be bound to other keys, like `-' and `.', if you wish."
198 See `PC-complete' for details.
199 This is suitable for binding to other keys which should act just like SPC."
210 See `PC-complete' for details."
218 See `PC-complete' for details."
236 See `PC-complete' for details."
264 read-directory-name-internal)))
266 dirlength
270 basestr
271 regex
272 p offset
274 helpposs
277 ;; Check if buffer contents can already be considered complete
280 'complete
282 ;; Record how many characters at the beginning are not included
283 ;; in completion.
289 ;; Do substitutions in directory names
297 ;; Prepare various delimiter strings
304 ;; Look for wildcard expansions in directory name
308 files)
312 "*"
323 ambig t)
330 ;; Strip directory name if appropriate
339 ;; Convert search pattern to a standard regular expression
345 p offset)
349 PC-ndelims-regex
350 PC-delim-regex
357 PC-ndelims-regex
364 "[^/]*"
366 ;;(setq the-regex regex)
369 ;; Find an initial list of possible completions
372 str
375 ;; Minibuffer contains no hyphens -- simple case!
377 table
378 pred))
380 ;; Use all-completions to do an initial cull. This is a big win,
381 ;; since all-completions is written in C!
383 table
384 pred)))
391 ;; Now we have a list of possible completions
394 ;; No valid completions found
403 " [Ambiguous dir name]"
405 " [No completions]"
407 nil))
409 ;; More than one valid completion found
413 ;; Handle completion-ignored-extensions
418 ;; Build a regular expression representing the extensions list
423 'regexp-quote
425 completion-ignored-extensions)
429 ;; Check if there are any without an ignored extension
436 ;; If there are "good" names, use them
439 ;; Is the actual string one of the possible completions?
449 t
451 ;; If ambiguous, try for a partial completion
453 prefix
457 ;; Check if next few letters are the same in all cases
474 PC-delims-list))
486 ;; Use format to discard text properties.
495 PC-ndelims-regex)
497 ""
504 x
506 poss)))
520 ;; We changed it... would it be complete without the space?
522 table pred)
527 ;; We changed it... enough to be complete?
531 ;; If totally ambiguous, display a list of completions
538 ;; Record which part of the buffer we are completing
539 ;; so that choosing a completion from the list
540 ;; knows how much old text to replace.
543 nil)))))
545 ;; Only one possible completion
555 t)))))
569 res)))
580 new)))
585 "A Lisp version of `temp_minibuffer_message' from minibuf.c."
606 "Perform completion on Lisp symbol preceding point.
607 That symbol is compared against the symbols that exist
608 and any additional characters determined by what is there
609 are inserted.
610 If the symbol starts just after an open-parenthesis,
611 only symbols with function definitions are considered.
612 Otherwise, all symbols with function definitions, values
613 or properties are considered."
629 'fboundp
637 ;;; Wildcards in `C-x C-f' command. This is independent from the main
638 ;;; completion code, except for `PC-expand-many-files' which is called
639 ;;; when "*"'s are found in the path during filename completion. (The
640 ;;; above completion code always understands "*"'s, except in file paths,
641 ;;; without relying on the following code.)
658 ;; This modifies the "buf" variable inside find-file-noselect.
661 nil ; should do verify-visited-file-modtime stuff.
670 'identity
674 find-file-hooks)))
675 ;; This modifies the "error" variable inside find-file-noselect.
677 t)
678 nil))
691 nil
702 files))))
707 find-file-not-found-hooks)))
711 ;;; Facilities for loading C header files. This is independent from the
712 ;;; main completion code. See also the variable `PC-include-file-path'
713 ;;; at top of this file.
721 new-buf)
733 ;; Suggested by Frank Siebenlist:
743 punc ?\<
744 path load-path)
757 name))))
764 default-directory)))
770 ;; no need to verify last-modified time for this!
777 error nil
778 buf new-buf)
779 t)
780 nil))
786 pos)
791 path)))
793 ;;; This is adapted from lib-complete.el, by Mike Williams.
795 "Return all completions for FILE in any directory on SEARCH-PATH.
796 If optional third argument FULL is non-nil, returned pathnames should be
797 absolute rather than relative to some directory on the SEARCH-PATH."
801 search-path))
803 ;; It's an absolute file name, so don't need search-path
810 file-lists)
811 ;; Append subdirectory part to each element of search-path
815 search-path)
816 file ))
817 ;; Make list of completions in each directory on search-path
828 file-lists))))
830 ;; Compress out duplicates while building complete list (slloooow!)
833 compressed)
838 compressed))))
861 find-file-not-found-hooks)))
864 PC-old-read-file-name-internal
870 \f
873 ;;; End.