1 ;;; completion.el --- dynamic word-completion code
3 ;; Copyright (C) 1990, 1993, 1995, 1997, 2001, 2002, 2003, 2004,
4 ;; 2005, 2006, 2007 Free Software Foundation, Inc.
7 ;; Keywords: abbrev convenience
8 ;; Author: Jim Salem <alem@bbnplanet.com> of Thinking Machines Inc.
9 ;; (ideas suggested by Brewster Kahle)
11 ;; This file is part of GNU Emacs.
13 ;; GNU Emacs is free software; you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation; either version 3, or (at your option)
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs; see the file COPYING. If not, write to the
25 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
26 ;; Boston, MA 02110-1301, USA.
30 ;; What to put in .emacs
31 ;;-----------------------
32 ;; (dynamic-completion-mode)
34 ;;---------------------------------------------------------------------------
35 ;; Documentation [Slightly out of date]
36 ;;---------------------------------------------------------------------------
37 ;; (also check the documentation string of the functions)
42 ;; After you type a few characters, pressing the "complete" key inserts
43 ;; the rest of the word you are likely to type.
45 ;; This watches all the words that you type and remembers them. When
46 ;; typing a new word, pressing "complete" (meta-return) "completes" the
47 ;; word by inserting the most recently used word that begins with the
48 ;; same characters. If you press meta-return repeatedly, it cycles
49 ;; through all the words it knows about.
51 ;; If you like the completion then just continue typing, it is as if you
52 ;; entered the text by hand. If you want the inserted extra characters
53 ;; to go away, type control-w or delete. More options are described below.
55 ;; The guesses are made in the order of the most recently "used". Typing
56 ;; in a word and then typing a separator character (such as a space) "uses"
57 ;; the word. So does moving a cursor over the word. If no words are found,
58 ;; it uses an extended version of the dabbrev style completion.
60 ;; You automatically save the completions you use to a file between
63 ;; Completion enables programmers to enter longer, more descriptive
64 ;; variable names while typing fewer keystrokes than they normally would.
68 ;;---------------------
70 ;; A "word" is any string containing characters with either word or symbol
71 ;; syntax. [E.G. Any alphanumeric string with hyphens, underscores, etc.]
72 ;; Unless you change the constants, you must type at least three characters
73 ;; for the word to be recognized. Only words longer than 6 characters are
76 ;; When you load this file, completion will be on. I suggest you use the
77 ;; compiled version (because it is noticeably faster).
79 ;; M-x completion-mode toggles whether or not new words are added to the
80 ;; database by changing the value of enable-completion.
82 ;; SAVING/LOADING COMPLETIONS
83 ;; Completions are automatically saved from one session to another
84 ;; (unless save-completions-flag or enable-completion is nil).
85 ;; Activating this minor-mode (calling completion-initialize) loads
86 ;; a completions database for a saved completions file
87 ;; (default: ~/.completions). When you exit, Emacs saves a copy of the
88 ;; completions that you often use. When you next start, Emacs loads in
89 ;; the saved completion file.
91 ;; The number of completions saved depends loosely on
92 ;; *saved-completions-decay-factor*. Completions that have never been
93 ;; inserted via "complete" are not saved. You are encouraged to experiment
94 ;; with different functions (see compute-completion-min-num-uses).
96 ;; Some completions are permanent and are always saved out. These
97 ;; completions have their num-uses slot set to T. Use
98 ;; add-permanent-completion to do this
100 ;; Completions are saved only if enable-completion is T. The number of old
101 ;; versions kept of the saved completions file is controlled by
102 ;; completions-file-versions-kept.
104 ;; COMPLETE KEY OPTIONS
105 ;; The complete function takes a numeric arguments.
106 ;; control-u :: leave the point at the beginning of the completion rather
108 ;; a number :: rotate through the possible completions by that amount
109 ;; `-' :: same as -1 (insert previous completion)
111 ;; HOW THE DATABASE IS MAINTAINED
114 ;; UPDATING THE DATABASE MANUALLY
115 ;; m-x kill-completion
116 ;; kills the completion at point.
117 ;; m-x add-completion
118 ;; m-x add-permanent-completion
120 ;; UPDATING THE DATABASE FROM A SOURCE CODE FILE
121 ;; m-x add-completions-from-buffer
122 ;; Parses all the definition names from a C or LISP mode buffer and
123 ;; adds them to the completion database.
125 ;; m-x add-completions-from-lisp-file
126 ;; Parses all the definition names from a C or Lisp mode file and
127 ;; adds them to the completion database.
129 ;; UPDATING THE DATABASE FROM A TAGS TABLE
130 ;; m-x add-completions-from-tags-table
131 ;; Adds completions from the current tags-table-buffer.
133 ;; HOW A COMPLETION IS FOUND
137 ;; Completion is string case independent if case-fold-search has its
138 ;; normal default of T. Also when the completion is inserted the case of the
139 ;; entry is coerced appropriately.
140 ;; [E.G. APP --> APPROPRIATELY app --> appropriately
141 ;; App --> Appropriately]
144 ;; The form `(completion-initialize)' initializes the completion system by
145 ;; trying to load in the user's completions. After the first call, further
146 ;; calls have no effect so one should be careful not to put the form in a
147 ;; site's standard site-init file.
149 ;;---------------------------------------------------------------------------
153 ;;---------------------------------------------------------------------------
154 ;; Functions you might like to call
155 ;;---------------------------------------------------------------------------
157 ;; add-completion string &optional num-uses
158 ;; Adds a new string to the database
160 ;; add-permanent-completion string
161 ;; Adds a new string to the database with num-uses = T
164 ;; kill-completion string
165 ;; Kills the completion from the database.
167 ;; clear-all-completions
168 ;; Clears the database
170 ;; list-all-completions
171 ;; Returns a list of all completions.
174 ;; next-completion string &optional index
175 ;; Returns a completion entry that starts with string.
177 ;; find-exact-completion string
178 ;; Returns a completion entry that exactly matches string.
181 ;; Inserts a completion at point
183 ;; completion-initialize
184 ;; Loads the completions file and sets up so that exiting emacs will
187 ;; save-completions-to-file &optional filename
188 ;; load-completions-from-file &optional filename
190 ;;-----------------------------------------------
192 ;;-----------------------------------------------
194 ;; get-completion-list string
196 ;; These things are for manipulating the structure
197 ;; make-completion string num-uses
198 ;; completion-num-uses completion
199 ;; completion-string completion
200 ;; set-completion-num-uses completion num-uses
201 ;; set-completion-string completion string
205 ;;-----------------------------------------------
206 ;; To Do :: (anybody ?)
207 ;;-----------------------------------------------
209 ;; Implement Lookup and keyboard interface in C
210 ;; Add package prefix smarts (for Common Lisp)
211 ;; Add autoprompting of possible completions after every keystroke (fast
213 ;; Add doc. to texinfo
216 ;;-----------------------------------------------
218 ;;-----------------------------------------------
219 ;; Sometime in '84 Brewster implemented a somewhat buggy version for
221 ;; Jan. '85 Jim became enamored of the idea and implemented a faster,
222 ;; more robust version.
223 ;; With input from many users at TMC, (rose, craig, and gls come to mind),
224 ;; the current style of interface was developed.
225 ;; 9/87, Jim and Brewster took terminals home. Yuck. After
226 ;; complaining for a while Brewster implemented a subset of the current
227 ;; LISPM version for GNU Emacs.
228 ;; 8/88 After complaining for a while (and with sufficient
229 ;; promised rewards), Jim reimplemented a version of GNU completion
230 ;; superior to that of the LISPM version.
232 ;;-----------------------------------------------
234 ;;-----------------------------------------------
235 ;; Cliff Lasser (cal@think.com), Kevin Herbert (kph@cisco.com),
236 ;; eero@media-lab, kgk@cs.brown.edu, jla@ai.mit.edu,
238 ;;-----------------------------------------------
240 ;;-----------------------------------------------
241 ;; From version 9 to 10
242 ;; - Allowance for non-integral *completion-version* nos.
243 ;; - Fix cmpl-apply-as-top-level for keyboard macros
244 ;; - Fix broken completion merging (in save-completions-to-file)
245 ;; - More misc. fixes for version 19.0 of emacs
247 ;; From Version 8 to 9
248 ;; - Ported to version 19.0 of emacs (backcompatible with version 18)
249 ;; - Added add-completions-from-tags-table (with thanks to eero@media-lab)
251 ;; From Version 7 to 8
252 ;; - Misc. changes to comments
253 ;; - new completion key bindings: c-x o, M->, M-<, c-a, c-e
254 ;; - cdabbrev now checks all the visible window buffers and the "other buffer"
255 ;; - `%' is now a symbol character rather than a separator (except in C mode)
257 ;; From Version 6 to 7
258 ;; - Fixed bug with saving out .completion file the first time
260 ;; From Version 5 to 6
261 ;; - removed statistics recording
262 ;; - reworked advise to handle autoloads
263 ;; - Fixed fortran mode support
264 ;; - Added new cursor motion triggers
266 ;; From Version 4 to 5
267 ;; - doesn't bother saving if nothing has changed
268 ;; - auto-save if haven't used for a 1/2 hour
269 ;; - save period extended to two weeks
270 ;; - minor fix to capitalization code
271 ;; - added *completion-auto-save-period* to variables recorded.
272 ;; - added reenter protection to cmpl-record-statistics-filter
273 ;; - added backup protection to save-completions-to-file (prevents
274 ;; problems with disk full errors)
278 ;;---------------------------------------------------------------------------
279 ;; User changeable parameters
280 ;;---------------------------------------------------------------------------
282 (defgroup completion nil
283 "Dynamic word-completion code."
288 (defcustom enable-completion t
289 "Non-nil means enable recording and saving of completions.
290 If nil, no new words are added to the database or saved to the init file."
294 (defcustom save-completions-flag t
295 "Non-nil means save most-used completions when exiting Emacs.
296 See also `save-completions-retention-time'."
300 (defcustom save-completions-file-name
301 (let ((olddef (convert-standard-filename "~/.completions")))
303 ((file-readable-p olddef
) olddef
)
304 ((file-directory-p user-emacs-directory
)
305 (convert-standard-filename
306 (expand-file-name "completions" user-emacs-directory
)))
308 "The filename to save completions to."
312 (defcustom save-completions-retention-time
336
313 "Discard a completion if unused for this many hours.
314 \(1 day = 24, 1 week = 168). If this is 0, non-permanent completions
315 will not be saved unless these are used. Default is two weeks."
319 (defcustom completion-on-separator-character nil
320 "Non-nil means separator characters mark previous word as used.
321 This means the word will be saved as a completion."
325 (defcustom completions-file-versions-kept kept-new-versions
326 "Number of versions to keep for the saved completions file."
330 (defcustom completion-prompt-speed-threshold
4800
331 "Minimum output speed at which to display next potential completion."
335 (defcustom completion-cdabbrev-prompt-flag nil
336 "If non-nil, the next completion prompt does a cdabbrev search.
337 This can be time consuming."
341 (defcustom completion-search-distance
15000
342 "How far to search in the buffer when looking for completions.
343 In number of characters. If nil, search the whole buffer."
347 (defcustom completions-merging-modes
'(lisp c
)
348 "List of modes {`c' or `lisp'} for automatic completions merging.
349 Definitions from visited files which have these modes
350 are automatically added to the completion database."
351 :type
'(set (const lisp
) (const c
))
354 ;;(defvar *record-cmpl-statistics-p* nil
355 ;; "*If non-nil, record completion statistics.")
357 ;;(defvar *completion-auto-save-period* 1800
358 ;; "*The period in seconds to wait for emacs to be idle before autosaving
359 ;;the completions. Default is a 1/2 hour.")
361 (defvar completion-min-length
6
362 "*The minimum length of a stored completion.
363 DON'T CHANGE WITHOUT RECOMPILING ! This is used by macros.")
365 (defvar completion-max-length
200
366 "*The maximum length of a stored completion.
367 DON'T CHANGE WITHOUT RECOMPILING ! This is used by macros.")
369 (defvar completion-prefix-min-length
3
370 "The minimum length of a completion search string.
371 DON'T CHANGE WITHOUT RECOMPILING ! This is used by macros.")
373 ;;---------------------------------------------------------------------------
374 ;; Internal Variables
375 ;;---------------------------------------------------------------------------
377 (defvar cmpl-initialized-p nil
378 "Set to t when the completion system is initialized.
379 Indicates that the old completion file has been read in.")
381 (defvar cmpl-completions-accepted-p nil
382 "Set to t as soon as the first completion has been accepted.
383 Used to decide whether to save completions.")
385 (defvar cmpl-preceding-syntax
)
387 (defvar completion-string
)
389 ;;---------------------------------------------------------------------------
391 ;;---------------------------------------------------------------------------
393 ;;-----------------------------------------------
394 ;; String case coercion
395 ;;-----------------------------------------------
397 (defun cmpl-string-case-type (string)
398 "Return :capitalized, :up, :down, :mixed, or :neither for case of STRING."
399 (let ((case-fold-search nil
))
400 (cond ((string-match "[[:lower:]]" string
)
401 (cond ((string-match "[[:upper:]]" string
)
402 (cond ((and (> (length string
) 1)
403 (null (string-match "[[:upper:]]" string
1)))
409 (cond ((string-match "[[:upper:]]" string
)
414 ;; (cmpl-string-case-type "123ABCDEF456") --> :up
415 ;; (cmpl-string-case-type "123abcdef456") --> :down
416 ;; (cmpl-string-case-type "123aBcDeF456") --> :mixed
417 ;; (cmpl-string-case-type "123456") --> :neither
418 ;; (cmpl-string-case-type "Abcde123") --> :capitalized
420 (defun cmpl-coerce-string-case (string case-type
)
421 (cond ((eq case-type
:down
) (downcase string
))
422 ((eq case-type
:up
) (upcase string
))
423 ((eq case-type
:capitalized
)
424 (setq string
(downcase string
))
425 (aset string
0 (logand ?
\337 (aref string
0)))
429 (defun cmpl-merge-string-cases (string-to-coerce given-string
)
430 (let ((string-case-type (cmpl-string-case-type string-to-coerce
)))
431 (cond ((memq string-case-type
'(:down
:up
:capitalized
))
432 ;; Found string is in a standard case. Coerce to a type based on
434 (cmpl-coerce-string-case string-to-coerce
435 (cmpl-string-case-type given-string
)))
437 ;; If the found string is in some unusual case, just insert it
442 ;; (cmpl-merge-string-cases "AbCdEf456" "abc") --> AbCdEf456
443 ;; (cmpl-merge-string-cases "abcdef456" "ABC") --> ABCDEF456
444 ;; (cmpl-merge-string-cases "ABCDEF456" "Abc") --> Abcdef456
445 ;; (cmpl-merge-string-cases "ABCDEF456" "abc") --> abcdef456
448 (defun cmpl-hours-since-origin ()
449 (let ((time (current-time)))
450 (floor (+ (* 65536.0 (nth 0 time
)) (nth 1 time
)) 3600)))
452 ;;---------------------------------------------------------------------------
453 ;; "Symbol" parsing functions
454 ;;---------------------------------------------------------------------------
455 ;; The functions symbol-before-point, symbol-under-point, etc. quickly return
456 ;; an appropriate symbol string. The strategy is to temporarily change
457 ;; the syntax table to enable fast symbol searching. There are three classes
458 ;; of syntax in these "symbol" syntax tables ::
460 ;; syntax (?_) - "symbol" chars (e.g. alphanumerics)
461 ;; syntax (?w) - symbol chars to ignore at end of words (e.g. period).
462 ;; syntax (? ) - everything else
464 ;; Thus by judicious use of scan-sexps and forward-word, we can get
465 ;; the word we want relatively fast and without consing.
467 ;; Why do we need a separate category for "symbol chars to ignore at ends" ?
468 ;; For example, in LISP we want starting :'s trimmed
469 ;; so keyword argument specifiers also define the keyword completion. And,
470 ;; for example, in C we want `.' appearing in a structure ref. to
471 ;; be kept intact in order to store the whole structure ref.; however, if
472 ;; it appears at the end of a symbol it should be discarded because it is
473 ;; probably used as a period.
475 ;; Here is the default completion syntax ::
476 ;; Symbol chars :: A-Z a-z 0-9 @ / \ * + ~ $ < > %
477 ;; Symbol chars to ignore at ends :: _ : . -
478 ;; Separator chars. :: <tab> <space> ! ^ & ( ) = ` | { } [ ] ; " ' #
479 ;; , ? <Everything else>
481 ;; Mode specific differences and notes ::
483 ;; Symbol chars :: ! & ? = ^
486 ;; Separator chars :: + * / : %
487 ;; A note on the hyphen (`-'). Perhaps the hyphen should also be a separator
488 ;; char., however, we wanted to have completion symbols include pointer
489 ;; references. For example, "foo->bar" is a symbol as far as completion is
493 ;; Separator chars :: + - * / :
497 ;; Of course there is no pathname "mode" and in fact we have not implemented
498 ;; this table. However, if there was such a mode, this is what it would look
501 ;;-----------------------------------------------
503 ;;-----------------------------------------------
505 (defconst completion-standard-syntax-table
506 (let ((table (make-syntax-table))
508 ;; Default syntax is whitespace.
511 (modify-syntax-entry i
" " table
)
516 (modify-syntax-entry (+ ?a i
) "_" table
)
517 (modify-syntax-entry (+ ?A i
) "_" table
)
522 (modify-syntax-entry (+ ?
0 i
) "_" table
)
525 (let ((symbol-chars '(?
@ ?
/ ?
\\ ?
* ?
+ ?~ ?$ ?
< ?
> ?%
))
526 (symbol-chars-ignore '(?_ ?- ?
: ?.
)))
527 (dolist (char symbol-chars
)
528 (modify-syntax-entry char
"_" table
))
529 (dolist (char symbol-chars-ignore
)
530 (modify-syntax-entry char
"w" table
)))
533 (defvar completion-syntax-table completion-standard-syntax-table
534 "This variable holds the current completion syntax table.")
535 (make-variable-buffer-local 'completion-syntax-table
)
537 ;;-----------------------------------------------
539 ;;-----------------------------------------------
540 (defvar cmpl-symbol-start nil
541 "Holds first character of symbol, after any completion symbol function.")
542 (defvar cmpl-symbol-end nil
543 "Holds last character of symbol, after any completion symbol function.")
545 (defun symbol-under-point ()
546 "Return the symbol that the point is currently on.
547 But only if it is longer than `completion-min-length'."
548 (with-syntax-table completion-syntax-table
549 (when (memq (char-syntax (following-char)) '(?w ?_
))
550 ;; Cursor is on following-char and after preceding-char
551 (let ((saved-point (point)))
552 (setq cmpl-symbol-start
(scan-sexps (1+ saved-point
) -
1)
553 cmpl-symbol-end
(scan-sexps saved-point
1))
554 ;; Remove chars to ignore at the start.
555 (cond ((= (char-syntax (char-after cmpl-symbol-start
)) ?w
)
556 (goto-char cmpl-symbol-start
)
558 (setq cmpl-symbol-start
(point))
559 (goto-char saved-point
)))
560 ;; Remove chars to ignore at the end.
561 (cond ((= (char-syntax (char-after (1- cmpl-symbol-end
))) ?w
)
562 (goto-char cmpl-symbol-end
)
564 (setq cmpl-symbol-end
(point))
565 (goto-char saved-point
)))
566 ;; Return completion if the length is reasonable.
567 (if (and (<= completion-min-length
568 (- cmpl-symbol-end cmpl-symbol-start
))
569 (<= (- cmpl-symbol-end cmpl-symbol-start
)
570 completion-max-length
))
571 (buffer-substring-no-properties
572 cmpl-symbol-start cmpl-symbol-end
))))))
574 ;; tests for symbol-under-point
575 ;; `^' indicates cursor pos. where value is returned
577 ;; ^^^^^^^^^^^^^^^^ --> simple-word-test
578 ;; _harder_word_test_
579 ;; ^^^^^^^^^^^^^^^^^^ --> harder_word_test
582 ;; /foo/bar/quux.hello
583 ;; ^^^^^^^^^^^^^^^^^^^ --> /foo/bar/quux.hello
586 (defun symbol-before-point ()
587 "Return a string of the symbol immediately before point.
588 Returns nil if there isn't one longer than `completion-min-length'."
589 ;; This is called when a word separator is typed so it must be FAST !
590 (with-syntax-table completion-syntax-table
591 ;; Cursor is on following-char and after preceding-char
592 (cond ((= (setq cmpl-preceding-syntax
(char-syntax (preceding-char))) ?_
)
593 ;; Number of chars to ignore at end.
594 (setq cmpl-symbol-end
(point)
595 cmpl-symbol-start
(scan-sexps cmpl-symbol-end -
1))
596 ;; Remove chars to ignore at the start.
597 (cond ((= (char-syntax (char-after cmpl-symbol-start
)) ?w
)
598 (goto-char cmpl-symbol-start
)
600 (setq cmpl-symbol-start
(point))
601 (goto-char cmpl-symbol-end
)))
602 ;; Return value if long enough.
603 (if (>= cmpl-symbol-end
604 (+ cmpl-symbol-start completion-min-length
))
605 (buffer-substring-no-properties
606 cmpl-symbol-start cmpl-symbol-end
)))
607 ((= cmpl-preceding-syntax ?w
)
608 ;; chars to ignore at end
609 (let ((saved-point (point)))
610 (setq cmpl-symbol-start
(scan-sexps saved-point -
1))
611 ;; take off chars. from end
613 (setq cmpl-symbol-end
(point))
614 ;; remove chars to ignore at the start
615 (cond ((= (char-syntax (char-after cmpl-symbol-start
)) ?w
)
616 (goto-char cmpl-symbol-start
)
618 (setq cmpl-symbol-start
(point))))
620 (goto-char saved-point
)
621 ;; Return completion if the length is reasonable
622 (if (and (<= completion-min-length
623 (- cmpl-symbol-end cmpl-symbol-start
))
624 (<= (- cmpl-symbol-end cmpl-symbol-start
)
625 completion-max-length
))
626 (buffer-substring-no-properties
627 cmpl-symbol-start cmpl-symbol-end
)))))))
629 ;; tests for symbol-before-point
630 ;; `^' indicates cursor pos. where value is returned
635 ;; ^ --> simple-word-test
636 ;; _harder_word_test_
637 ;; ^ --> harder_word_test
638 ;; ^ --> harder_word_test
643 (defun symbol-under-or-before-point ()
644 ;; This could be made slightly faster but it is better to avoid
645 ;; copying all the code.
646 ;; However, it is only used by the completion string prompter.
647 ;; If it comes into common use, it could be rewritten.
648 (if (memq (with-syntax-table completion-syntax-table
649 (char-syntax (following-char)))
652 (symbol-before-point)))
655 (defun symbol-before-point-for-complete ()
656 ;; "Returns a string of the symbol immediately before point
657 ;; or nil if there isn't one. Like symbol-before-point but doesn't trim the
659 ;; Cursor is on following-char and after preceding-char
660 (with-syntax-table completion-syntax-table
661 (cond ((memq (setq cmpl-preceding-syntax
(char-syntax (preceding-char)))
663 (setq cmpl-symbol-end
(point)
664 cmpl-symbol-start
(scan-sexps cmpl-symbol-end -
1))
665 ;; Remove chars to ignore at the start.
666 (cond ((= (char-syntax (char-after cmpl-symbol-start
)) ?w
)
667 (goto-char cmpl-symbol-start
)
669 (setq cmpl-symbol-start
(point))
670 (goto-char cmpl-symbol-end
)))
671 ;; Return completion if the length is reasonable.
672 (if (and (<= completion-prefix-min-length
673 (- cmpl-symbol-end cmpl-symbol-start
))
674 (<= (- cmpl-symbol-end cmpl-symbol-start
)
675 completion-max-length
))
676 (buffer-substring-no-properties
677 cmpl-symbol-start cmpl-symbol-end
))))))
679 ;; tests for symbol-before-point-for-complete
680 ;; `^' indicates cursor pos. where value is returned
685 ;; ^ --> simple-word-test
686 ;; _harder_word_test_
687 ;; ^ --> harder_word_test
688 ;; ^ --> harder_word_test_
695 ;;---------------------------------------------------------------------------
696 ;; Statistics Recording
697 ;;---------------------------------------------------------------------------
699 ;; Note that the guts of this has been turned off. The guts
700 ;; are in completion-stats.el.
702 ;;-----------------------------------------------
703 ;; Conditionalizing code on *record-cmpl-statistics-p*
704 ;;-----------------------------------------------
705 ;; All statistics code outside this block should use this
706 (defmacro cmpl-statistics-block
(&rest body
))
707 ;; "Only executes body if we are recording statistics."
709 ;; (list* '*record-cmpl-statistics-p* body)
712 ;;-----------------------------------------------
713 ;; Completion Sources
714 ;;-----------------------------------------------
717 (defconst cmpl-source-unknown
0)
718 (defconst cmpl-source-init-file
1)
719 (defconst cmpl-source-file-parsing
2)
720 (defconst cmpl-source-separator
3)
721 (defconst cmpl-source-cursor-moves
4)
722 (defconst cmpl-source-interactive
5)
723 (defconst cmpl-source-cdabbrev
6)
724 (defconst num-cmpl-sources
7)
725 (defvar current-completion-source cmpl-source-unknown
)
729 ;;---------------------------------------------------------------------------
730 ;; Completion Method #2: dabbrev-expand style
731 ;;---------------------------------------------------------------------------
733 ;; This method is used if there are no useful stored completions. It is
734 ;; based on dabbrev-expand with these differences :
735 ;; 1) Faster (we don't use regexps)
736 ;; 2) case coercion handled correctly
737 ;; This is called cdabbrev to differentiate it.
738 ;; We simply search backwards through the file looking for words which
739 ;; start with the same letters we are trying to complete.
742 (defvar cdabbrev-completions-tried nil
)
743 ;; "A list of all the cdabbrev completions since the last reset.")
745 (defvar cdabbrev-current-point
0)
746 ;; "The current point position the cdabbrev search is at.")
748 (defvar cdabbrev-current-window nil
)
749 ;; "The current window we are looking for cdabbrevs in.
750 ;; Return t if looking in (other-buffer), nil if no more cdabbrevs.")
752 (defvar cdabbrev-wrapped-p nil
)
753 ;; "Return t if the cdabbrev search has wrapped around the file.")
755 (defvar cdabbrev-abbrev-string
"")
756 (defvar cdabbrev-start-point
0)
757 (defvar cdabbrev-stop-point
)
759 ;; Test strings for cdabbrev
760 ;; cdat-upcase ;;same namestring
764 ;; a-cdat-1 ;;doesn't start correctly
768 (defun reset-cdabbrev (abbrev-string &optional initial-completions-tried
)
769 "Reset the cdabbrev search to search for ABBREV-STRING.
770 INITIAL-COMPLETIONS-TRIED is a list of downcased strings to ignore
772 (setq cdabbrev-abbrev-string abbrev-string
773 cdabbrev-completions-tried
774 (cons (downcase abbrev-string
) initial-completions-tried
))
775 (reset-cdabbrev-window t
))
777 (defun set-cdabbrev-buffer ()
778 ;; cdabbrev-current-window must not be nil
779 (set-buffer (if (eq cdabbrev-current-window t
)
781 (window-buffer cdabbrev-current-window
))))
784 (defun reset-cdabbrev-window (&optional initializep
)
785 "Reset the cdabbrev search to search for abbrev-string."
788 (setq cdabbrev-current-window
(selected-window)))
789 ((eq cdabbrev-current-window t
)
790 ;; Everything has failed
791 (setq cdabbrev-current-window nil
))
792 (cdabbrev-current-window
793 (setq cdabbrev-current-window
(next-window cdabbrev-current-window
))
794 (if (eq cdabbrev-current-window
(selected-window))
795 ;; No more windows, try other buffer.
796 (setq cdabbrev-current-window t
))))
797 (if cdabbrev-current-window
799 (set-cdabbrev-buffer)
800 (setq cdabbrev-current-point
(point)
801 cdabbrev-start-point cdabbrev-current-point
803 (if completion-search-distance
805 (- cdabbrev-start-point completion-search-distance
))
807 cdabbrev-wrapped-p nil
))))
809 (defun next-cdabbrev ()
810 "Return the next possible cdabbrev expansion or nil if there isn't one.
811 `reset-cdabbrev' must've been called already.
812 This is sensitive to `case-fold-search'."
813 ;; note that case-fold-search affects the behavior of this function
814 ;; Bug: won't pick up an expansion that starts at the top of buffer
815 (if cdabbrev-current-window
819 downcase-expansion tried-list syntax saved-point-2
)
823 ;; Switch to current completion buffer
824 (set-cdabbrev-buffer)
825 ;; Save current buffer state
826 (setq saved-point
(point)
827 saved-syntax
(syntax-table))
828 ;; Restore completion state
829 (set-syntax-table completion-syntax-table
)
830 (goto-char cdabbrev-current-point
)
831 ;; Loop looking for completions
833 ;; This code returns t if it should loop again
835 (;; search for the string
836 (search-backward cdabbrev-abbrev-string cdabbrev-stop-point t
)
837 ;; return nil if the completion is valid
840 ;; does it start with a separator char ?
841 (or (= (setq syntax
(char-syntax (preceding-char))) ?
)
843 ;; symbol char to ignore at end. Are we at end ?
845 (setq saved-point-2
(point))
848 (= (char-syntax (preceding-char)) ?
)
849 (goto-char saved-point-2
)))))
850 ;; is the symbol long enough ?
851 (setq expansion
(symbol-under-point))
852 ;; have we not tried this one before
854 ;; See if we've already used it
855 (setq tried-list cdabbrev-completions-tried
856 downcase-expansion
(downcase expansion
))
857 (while (and tried-list
858 (not (string-equal downcase-expansion
860 ;; Already tried, don't choose this one
861 (setq tried-list
(cdr tried-list
)))
862 ;; at this point tried-list will be nil if this
863 ;; expansion has not yet been tried
869 ;; If already wrapped, then we've failed completely
873 (goto-char (setq cdabbrev-current-point
874 (if completion-search-distance
875 (min (point-max) (+ cdabbrev-start-point completion-search-distance
))
878 (setq cdabbrev-wrapped-p t
))))
882 (setq cdabbrev-completions-tried
883 (cons downcase-expansion cdabbrev-completions-tried
)
884 cdabbrev-current-point
(point)))))
885 (set-syntax-table saved-syntax
)
886 (goto-char saved-point
)))
887 ;; If no expansion, go to next window
889 (t (reset-cdabbrev-window)
892 ;; The following must be eval'd in the minibuffer ::
893 ;; (reset-cdabbrev "cdat")
894 ;; (next-cdabbrev) --> "cdat-simple"
895 ;; (next-cdabbrev) --> "cdat-1-2-3-4"
896 ;; (next-cdabbrev) --> "CDAT-UPCASE"
897 ;; (next-cdabbrev) --> "cdat-wrapping"
898 ;; (next-cdabbrev) --> "cdat_start_sym"
899 ;; (next-cdabbrev) --> nil
900 ;; (next-cdabbrev) --> nil
901 ;; (next-cdabbrev) --> nil
907 ;;---------------------------------------------------------------------------
908 ;; Completion Database
909 ;;---------------------------------------------------------------------------
911 ;; We use two storage modes for the two search types ::
912 ;; 1) Prefix {cmpl-prefix-obarray} for looking up possible completions
913 ;; Used by search-completion-next
914 ;; the value of the symbol is nil or a cons of head and tail pointers
915 ;; 2) Interning {cmpl-obarray} to see if it's in the database
916 ;; Used by find-exact-completion, completion-in-database-p
917 ;; The value of the symbol is the completion entry
919 ;; bad things may happen if this length is changed due to the way
920 ;; GNU implements obarrays
921 (defconst cmpl-obarray-length
511)
923 (defvar cmpl-prefix-obarray
(make-vector cmpl-obarray-length
0)
924 "An obarray used to store the downcased completion prefixes.
925 Each symbol is bound to a list of completion entries.")
927 (defvar cmpl-obarray
(make-vector cmpl-obarray-length
0)
928 "An obarray used to store the downcased completions.
929 Each symbol is bound to a single completion entry.")
931 ;;-----------------------------------------------
932 ;; Completion Entry Structure Definition
933 ;;-----------------------------------------------
935 ;; A completion entry is a LIST of string, prefix-symbol num-uses, and
936 ;; last-use-time (the time the completion was last used)
937 ;; last-use-time is t if the string should be kept permanently
938 ;; num-uses is incremented every time the completion is used.
940 ;; We chose lists because (car foo) is faster than (aref foo 0) and the
941 ;; creation time is about the same.
945 (defmacro completion-string
(completion-entry)
946 (list 'car completion-entry
))
948 (defmacro completion-num-uses
(completion-entry)
949 ;; "The number of times it has used. Used to decide whether to save
951 (list 'car
(list 'cdr completion-entry
)))
953 (defmacro completion-last-use-time
(completion-entry)
954 ;; "The time it was last used. In hours since origin. Used to decide
955 ;; whether to save it. t if one should always save it."
956 (list 'nth
2 completion-entry
))
958 (defmacro completion-source
(completion-entry)
959 (list 'nth
3 completion-entry
))
962 (defmacro set-completion-string
(completion-entry string
)
963 (list 'setcar completion-entry string
))
965 (defmacro set-completion-num-uses
(completion-entry num-uses
)
966 (list 'setcar
(list 'cdr completion-entry
) num-uses
))
968 (defmacro set-completion-last-use-time
(completion-entry last-use-time
)
969 (list 'setcar
(list 'cdr
(list 'cdr completion-entry
)) last-use-time
))
972 (defun make-completion (string)
973 "Return a completion entry."
974 (list string
0 nil current-completion-source
))
977 ;;(defmacro cmpl-prefix-entry-symbol (completion-entry)
978 ;; (list 'car (list 'cdr completion-entry)))
982 ;;-----------------------------------------------
983 ;; Prefix symbol entry definition
984 ;;-----------------------------------------------
985 ;; A cons of (head . tail)
989 (defalias 'cmpl-prefix-entry-head
'car
)
991 (defalias 'cmpl-prefix-entry-tail
'cdr
)
995 (defmacro set-cmpl-prefix-entry-head
(prefix-entry new-head
)
996 (list 'setcar prefix-entry new-head
))
998 (defmacro set-cmpl-prefix-entry-tail
(prefix-entry new-tail
)
999 (list 'setcdr prefix-entry new-tail
))
1003 (defun make-cmpl-prefix-entry (completion-entry-list)
1004 "Make a new prefix entry containing only completion-entry."
1005 (cons completion-entry-list completion-entry-list
))
1007 ;;-----------------------------------------------
1008 ;; Completion Database - Utilities
1009 ;;-----------------------------------------------
1011 (defun clear-all-completions ()
1012 "Initialize the completion storage. All existing completions are lost."
1014 (setq cmpl-prefix-obarray
(make-vector cmpl-obarray-length
0))
1015 (setq cmpl-obarray
(make-vector cmpl-obarray-length
0))
1016 (cmpl-statistics-block
1017 (record-clear-all-completions)))
1019 (defvar completions-list-return-value
)
1021 (defun list-all-completions ()
1022 "Return a list of all the known completion entries."
1023 (let ((completions-list-return-value nil
))
1024 (mapatoms 'list-all-completions-1 cmpl-prefix-obarray
)
1025 completions-list-return-value
))
1027 (defun list-all-completions-1 (prefix-symbol)
1028 (if (boundp prefix-symbol
)
1029 (setq completions-list-return-value
1030 (append (cmpl-prefix-entry-head (symbol-value prefix-symbol
))
1031 completions-list-return-value
))))
1033 (defun list-all-completions-by-hash-bucket ()
1034 "Return list of lists of known completion entries, organized by hash bucket."
1035 (let ((completions-list-return-value nil
))
1036 (mapatoms 'list-all-completions-by-hash-bucket-1 cmpl-prefix-obarray
)
1037 completions-list-return-value
))
1039 (defun list-all-completions-by-hash-bucket-1 (prefix-symbol)
1040 (if (boundp prefix-symbol
)
1041 (setq completions-list-return-value
1042 (cons (cmpl-prefix-entry-head (symbol-value prefix-symbol
))
1043 completions-list-return-value
))))
1046 ;;-----------------------------------------------
1047 ;; Updating the database
1048 ;;-----------------------------------------------
1050 ;; These are the internal functions used to update the datebase
1053 (defvar completion-to-accept nil
1054 "Set to a string that is pending its acceptance.")
1055 ;; this checked by the top level reading functions
1057 (defvar cmpl-db-downcase-string nil
1058 "Setup by `find-exact-completion', etc. The given string, downcased.")
1059 (defvar cmpl-db-symbol nil
1060 "The interned symbol corresponding to `cmpl-db-downcase-string'.
1061 Set up by `cmpl-db-symbol'.")
1062 (defvar cmpl-db-prefix-symbol nil
1063 "The interned prefix symbol corresponding to `cmpl-db-downcase-string'.")
1064 (defvar cmpl-db-entry nil
)
1065 (defvar cmpl-db-debug-p nil
1066 "Set to t if you want to debug the database.")
1069 (defun find-exact-completion (string)
1070 "Return the completion entry for STRING or nil.
1071 Sets up `cmpl-db-downcase-string' and `cmpl-db-symbol'."
1072 (and (boundp (setq cmpl-db-symbol
1073 (intern (setq cmpl-db-downcase-string
(downcase string
))
1075 (symbol-value cmpl-db-symbol
)))
1077 (defun find-cmpl-prefix-entry (prefix-string)
1078 "Return the prefix entry for string.
1079 Sets `cmpl-db-prefix-symbol'.
1080 Prefix-string must be exactly `completion-prefix-min-length' long
1081 and downcased. Sets up `cmpl-db-prefix-symbol'."
1082 (and (boundp (setq cmpl-db-prefix-symbol
1083 (intern prefix-string cmpl-prefix-obarray
)))
1084 (symbol-value cmpl-db-prefix-symbol
)))
1086 (defvar inside-locate-completion-entry nil
)
1087 ;; used to trap lossage in silent error correction
1089 (defun locate-completion-entry (completion-entry prefix-entry
)
1090 "Locate the completion entry.
1091 Returns a pointer to the element before the completion entry or nil if
1092 the completion entry is at the head.
1093 Must be called after `find-exact-completion'."
1094 (let ((prefix-list (cmpl-prefix-entry-head prefix-entry
))
1097 ((not (eq (car prefix-list
) completion-entry
))
1098 ;; not already at head
1099 (while (and prefix-list
1100 (not (eq completion-entry
1101 (car (setq next-prefix-list
(cdr prefix-list
))))))
1102 (setq prefix-list next-prefix-list
))
1105 ;; Didn't find it. Database is messed up.
1107 ;; not found, error if debug mode
1108 (error "Completion entry exists but not on prefix list - %s"
1110 (inside-locate-completion-entry
1111 ;; recursive error: really scrod
1112 (locate-completion-db-error))
1115 (set cmpl-db-symbol nil
)
1117 (locate-completion-entry-retry completion-entry
)))))))
1119 (defun locate-completion-entry-retry (old-entry)
1120 (let ((inside-locate-completion-entry t
))
1121 (add-completion (completion-string old-entry
)
1122 (completion-num-uses old-entry
)
1123 (completion-last-use-time old-entry
))
1124 (let* ((cmpl-entry (find-exact-completion (completion-string old-entry
)))
1127 (find-cmpl-prefix-entry
1128 (substring cmpl-db-downcase-string
1129 0 completion-prefix-min-length
)))))
1130 (if (and cmpl-entry pref-entry
)
1132 (locate-completion-entry cmpl-entry pref-entry
)
1134 (locate-completion-db-error)))))
1136 (defun locate-completion-db-error ()
1137 ;; recursive error: really scrod
1138 (error "Completion database corrupted. Try M-x clear-all-completions. Send bug report"))
1141 (defun add-completion-to-tail-if-new (string)
1142 "If STRING is not in the database add it to appropriate prefix list.
1143 STRING is added to the end of the appropriate prefix list with
1144 num-uses = 0. The database is unchanged if it is there. STRING must be
1145 longer than `completion-prefix-min-length'.
1146 This must be very fast.
1147 Returns the completion entry."
1148 (or (find-exact-completion string
)
1150 (let (;; create an entry
1151 (entry (list (make-completion string
)))
1153 (prefix-entry (find-cmpl-prefix-entry
1154 (substring cmpl-db-downcase-string
0
1155 completion-prefix-min-length
))))
1156 ;; The next two forms should happen as a unit (atomically) but
1157 ;; no fatal errors should result if that is not the case.
1159 ;; These two should be atomic, but nothing fatal will happen
1161 (setcdr (cmpl-prefix-entry-tail prefix-entry
) entry
)
1162 (set-cmpl-prefix-entry-tail prefix-entry entry
))
1164 (set cmpl-db-prefix-symbol
(make-cmpl-prefix-entry entry
))))
1166 (cmpl-statistics-block
1167 (note-added-completion))
1169 (set cmpl-db-symbol
(car entry
)))))
1171 (defun add-completion-to-head (completion-string)
1172 "If COMPLETION-STRING is not in the database, add it to prefix list.
1173 We add COMPLETION-STRING to the head of the appropriate prefix list,
1174 or it to the head of the list.
1175 COMPLETION-STRING must be longer than `completion-prefix-min-length'.
1176 Updates the saved string with the supplied string.
1177 This must be very fast.
1178 Returns the completion entry."
1179 ;; Handle pending acceptance
1180 (if completion-to-accept
(accept-completion))
1181 ;; test if already in database
1182 (if (setq cmpl-db-entry
(find-exact-completion completion-string
))
1184 (let* ((prefix-entry (find-cmpl-prefix-entry
1185 (substring cmpl-db-downcase-string
0
1186 completion-prefix-min-length
)))
1187 (splice-ptr (locate-completion-entry cmpl-db-entry prefix-entry
))
1188 (cmpl-ptr (cdr splice-ptr
)))
1190 (set-completion-string cmpl-db-entry completion-string
)
1191 ;; move to head (if necessary)
1193 ;; These should all execute atomically but it is not fatal if
1196 (or (setcdr splice-ptr
(cdr cmpl-ptr
))
1197 ;; fix up tail if necessary
1198 (set-cmpl-prefix-entry-tail prefix-entry splice-ptr
))
1199 ;; splice in at head
1200 (setcdr cmpl-ptr
(cmpl-prefix-entry-head prefix-entry
))
1201 (set-cmpl-prefix-entry-head prefix-entry cmpl-ptr
)))
1204 (let (;; create an entry
1205 (entry (list (make-completion completion-string
)))
1207 (prefix-entry (find-cmpl-prefix-entry
1208 (substring cmpl-db-downcase-string
0
1209 completion-prefix-min-length
))))
1211 ;; Splice in at head
1212 (setcdr entry
(cmpl-prefix-entry-head prefix-entry
))
1213 (set-cmpl-prefix-entry-head prefix-entry entry
))
1215 ;; Start new prefix entry
1216 (set cmpl-db-prefix-symbol
(make-cmpl-prefix-entry entry
))))
1218 (cmpl-statistics-block
1219 (note-added-completion))
1220 ;; Add it to the symbol
1221 (set cmpl-db-symbol
(car entry
)))))
1223 (defun delete-completion (completion-string)
1224 "Delete the completion from the database.
1225 String must be longer than `completion-prefix-min-length'."
1226 ;; Handle pending acceptance
1227 (if completion-to-accept
(accept-completion))
1228 (if (setq cmpl-db-entry
(find-exact-completion completion-string
))
1230 (let* ((prefix-entry (find-cmpl-prefix-entry
1231 (substring cmpl-db-downcase-string
0
1232 completion-prefix-min-length
)))
1233 (splice-ptr (locate-completion-entry cmpl-db-entry prefix-entry
)))
1234 ;; delete symbol reference
1235 (set cmpl-db-symbol nil
)
1236 ;; remove from prefix list
1239 (or (setcdr splice-ptr
(cdr (cdr splice-ptr
)))
1240 ;; fix up tail if necessary
1241 (set-cmpl-prefix-entry-tail prefix-entry splice-ptr
)))
1244 (or (set-cmpl-prefix-entry-head
1245 prefix-entry
(cdr (cmpl-prefix-entry-head prefix-entry
)))
1246 ;; List is now empty
1247 (set cmpl-db-prefix-symbol nil
))))
1248 (cmpl-statistics-block
1249 (note-completion-deleted)))
1250 (error "Unknown completion `%s'" completion-string
)))
1254 ;; (add-completion-to-head "banana") --> ("banana" 0 nil 0)
1255 ;; (find-exact-completion "banana") --> ("banana" 0 nil 0)
1256 ;; (find-exact-completion "bana") --> nil
1257 ;; (car (find-cmpl-prefix-entry "ban")) --> (("banana" ...))
1258 ;; (cdr (find-cmpl-prefix-entry "ban")) --> (("banana" ...))
1259 ;; (add-completion-to-head "banish") --> ("banish" 0 nil 0)
1260 ;; (find-exact-completion "banish") --> ("banish" 0 nil 0)
1261 ;; (car (find-cmpl-prefix-entry "ban")) --> (("banish" ...) ("banana" ...))
1262 ;; (cdr (find-cmpl-prefix-entry "ban")) --> (("banana" ...))
1263 ;; (add-completion-to-head "banana") --> ("banana" 0 nil 0)
1264 ;; (car (find-cmpl-prefix-entry "ban")) --> (("banana" ...) ("banish" ...))
1265 ;; (cdr (find-cmpl-prefix-entry "ban")) --> (("banish" ...))
1268 ;; (add-completion-to-head "banner") --> ("banner" 0 nil 0)
1269 ;; (delete-completion "banner")
1270 ;; (find-exact-completion "banner") --> nil
1271 ;; (car (find-cmpl-prefix-entry "ban")) --> (("banana" ...) ("banish" ...))
1272 ;; (cdr (find-cmpl-prefix-entry "ban")) --> (("banish" ...))
1273 ;; (add-completion-to-head "banner") --> ("banner" 0 nil 0)
1274 ;; (delete-completion "banana")
1275 ;; (car (find-cmpl-prefix-entry "ban")) --> (("banner" ...) ("banish" ...))
1276 ;; (cdr (find-cmpl-prefix-entry "ban")) --> (("banish" ...))
1277 ;; (delete-completion "banner")
1278 ;; (delete-completion "banish")
1279 ;; (find-cmpl-prefix-entry "ban") --> nil
1280 ;; (delete-completion "banner") --> error
1283 ;; (add-completion-to-tail-if-new "banana") --> ("banana" 0 nil 0)
1284 ;; (car (find-cmpl-prefix-entry "ban")) --> (("banana" ...))
1285 ;; (cdr (find-cmpl-prefix-entry "ban")) --> (("banana" ...))
1286 ;; (add-completion-to-tail-if-new "banish") --> ("banish" 0 nil 0)
1287 ;; (car (find-cmpl-prefix-entry "ban")) -->(("banana" ...) ("banish" ...))
1288 ;; (cdr (find-cmpl-prefix-entry "ban")) -->(("banish" ...))
1292 ;;---------------------------------------------------------------------------
1293 ;; Database Update :: Interface level routines
1294 ;;---------------------------------------------------------------------------
1296 ;; These lie on top of the database ref. functions but below the standard
1297 ;; user interface level
1300 (defun interactive-completion-string-reader (prompt)
1301 (let* ((default (symbol-under-or-before-point))
1304 (format "%s (default %s): " prompt default
)
1305 (format "%s: " prompt
)))
1306 (read (completing-read new-prompt cmpl-obarray
)))
1307 (if (zerop (length read
)) (setq read
(or default
"")))
1310 (defun check-completion-length (string)
1311 (if (< (length string
) completion-min-length
)
1312 (error "The string `%s' is too short to be saved as a completion"
1316 (defun add-completion (string &optional num-uses last-use-time
)
1317 "Add STRING to completion list, or move it to head of list.
1318 The completion is altered appropriately if num-uses and/or last-use-time is
1320 (interactive (interactive-completion-string-reader "Completion to add"))
1321 (check-completion-length string
)
1322 (let* ((current-completion-source (if (interactive-p)
1323 cmpl-source-interactive
1324 current-completion-source
))
1325 (entry (add-completion-to-head string
)))
1327 (if num-uses
(set-completion-num-uses entry num-uses
))
1329 (set-completion-last-use-time entry last-use-time
))))
1331 (defun add-permanent-completion (string)
1332 "Add STRING if it isn't already listed, and mark it permanent."
1334 (interactive-completion-string-reader "Completion to add permanently"))
1335 (let ((current-completion-source (if (interactive-p)
1336 cmpl-source-interactive
1337 current-completion-source
)))
1338 (add-completion string nil t
)))
1340 (defun kill-completion (string)
1341 (interactive (interactive-completion-string-reader "Completion to kill"))
1342 (check-completion-length string
)
1343 (delete-completion string
))
1345 (defun accept-completion ()
1346 "Accepts the pending completion in `completion-to-accept'.
1347 This bumps num-uses. Called by `add-completion-to-head' and
1348 `completion-search-reset'."
1349 (let ((string completion-to-accept
)
1350 ;; if this is added afresh here, then it must be a cdabbrev
1351 (current-completion-source cmpl-source-cdabbrev
)
1353 (setq completion-to-accept nil
)
1354 (setq entry
(add-completion-to-head string
))
1355 (set-completion-num-uses entry
(1+ (completion-num-uses entry
)))
1356 (setq cmpl-completions-accepted-p t
)))
1358 (defun use-completion-under-point ()
1359 "Add the completion symbol underneath the point into the completion buffer."
1360 (let ((string (and enable-completion
(symbol-under-point)))
1361 (current-completion-source cmpl-source-cursor-moves
))
1362 (if string
(add-completion-to-head string
))))
1364 (defun use-completion-before-point ()
1365 "Add the completion symbol before point into the completion buffer."
1366 (let ((string (and enable-completion
(symbol-before-point)))
1367 (current-completion-source cmpl-source-cursor-moves
))
1368 (if string
(add-completion-to-head string
))))
1370 (defun use-completion-under-or-before-point ()
1371 "Add the completion symbol before point into the completion buffer."
1372 (let ((string (and enable-completion
(symbol-under-or-before-point)))
1373 (current-completion-source cmpl-source-cursor-moves
))
1374 (if string
(add-completion-to-head string
))))
1376 (defun use-completion-before-separator ()
1377 "Add the completion symbol before point into the completion buffer.
1378 Completions added this way will automatically be saved if
1379 `completion-on-separator-character' is non-nil."
1380 (let ((string (and enable-completion
(symbol-before-point)))
1381 (current-completion-source cmpl-source-separator
)
1383 (cmpl-statistics-block
1384 (note-separator-character string
))
1386 (setq entry
(add-completion-to-head string
))
1387 (if (and completion-on-separator-character
1388 (zerop (completion-num-uses entry
)))
1390 (set-completion-num-uses entry
1)
1391 (setq cmpl-completions-accepted-p t
)))))))
1395 ;; (add-completion "banana" 5 10)
1396 ;; (find-exact-completion "banana") --> ("banana" 5 10 0)
1397 ;; (add-completion "banana" 6)
1398 ;; (find-exact-completion "banana") --> ("banana" 6 10 0)
1399 ;; (add-completion "banish")
1400 ;; (car (find-cmpl-prefix-entry "ban")) --> (("banish" ...) ("banana" ...))
1403 ;; (setq completion-to-accept "banana")
1404 ;; (accept-completion)
1405 ;; (find-exact-completion "banana") --> ("banana" 7 10)
1406 ;; (car (find-cmpl-prefix-entry "ban")) --> (("banana" ...) ("banish" ...))
1407 ;; (setq completion-to-accept "banish")
1408 ;; (add-completion "banner")
1409 ;; (car (find-cmpl-prefix-entry "ban"))
1410 ;; --> (("banner" ...) ("banish" 1 ...) ("banana" 7 ...))
1413 ;; (kill-completion "banish")
1414 ;; (car (find-cmpl-prefix-entry "ban")) --> (("banner" ...) ("banana" ...))
1417 ;;---------------------------------------------------------------------------
1418 ;; Searching the database
1419 ;;---------------------------------------------------------------------------
1420 ;; Functions outside this block must call completion-search-reset followed
1421 ;; by calls to completion-search-next or completion-search-peek
1425 ;; Commented out to improve loading speed
1426 (defvar cmpl-test-string
"")
1427 ;; "The current string used by completion-search-next."
1428 (defvar cmpl-test-regexp
"")
1429 ;; "The current regexp used by completion-search-next.
1430 ;; (derived from cmpl-test-string)"
1431 (defvar cmpl-last-index
0)
1432 ;; "The last index that completion-search-next was called with."
1433 (defvar cmpl-cdabbrev-reset-p nil
)
1434 ;; "Set to t when cdabbrevs have been reset."
1435 (defvar cmpl-next-possibilities nil
)
1436 ;; "A pointer to the element BEFORE the next set of possible completions.
1437 ;; cadr of this is the cmpl-next-possibility"
1438 (defvar cmpl-starting-possibilities nil
)
1439 ;; "The initial list of starting possibilities."
1440 (defvar cmpl-next-possibility nil
)
1441 ;; "The cached next possibility."
1442 (defvar cmpl-tried-list nil
)
1443 ;; "A downcased list of all the completions we have tried."
1446 (defun completion-search-reset (string)
1447 "Set up the for completion searching for STRING.
1448 STRING must be longer than `completion-prefix-min-length'."
1449 (if completion-to-accept
(accept-completion))
1450 (setq cmpl-starting-possibilities
1451 (cmpl-prefix-entry-head
1452 (find-cmpl-prefix-entry
1453 (downcase (substring string
0 completion-prefix-min-length
))))
1454 cmpl-test-string string
1455 cmpl-test-regexp
(concat (regexp-quote string
) "."))
1456 (completion-search-reset-1))
1458 (defun completion-search-reset-1 ()
1459 (setq cmpl-next-possibilities cmpl-starting-possibilities
1460 cmpl-next-possibility nil
1461 cmpl-cdabbrev-reset-p nil
1463 cmpl-tried-list nil
))
1465 (defun completion-search-next (index)
1466 "Return the next completion entry.
1467 If INDEX is out of sequence, reset and start from the top.
1468 If there are no more entries, try cdabbrev and returns only a string."
1470 ((= index
(setq cmpl-last-index
(1+ cmpl-last-index
)))
1471 (completion-search-peek t
))
1473 (completion-search-reset-1)
1474 (setq cmpl-last-index index
)
1475 ;; reverse the possibilities list
1476 (setq cmpl-next-possibilities
(reverse cmpl-starting-possibilities
))
1477 ;; do a "normal" search
1478 (while (and (completion-search-peek nil
)
1479 (< (setq index
(1+ index
)) 0))
1480 (setq cmpl-next-possibility nil
))
1481 (cond ((not cmpl-next-possibilities
))
1482 ;; If no more possibilities, leave it that way
1483 ((= -
1 cmpl-last-index
)
1484 ;; next completion is at index 0. reset next-possibility list
1485 ;; to start at beginning
1486 (setq cmpl-next-possibilities cmpl-starting-possibilities
))
1488 ;; otherwise point to one before current
1489 (setq cmpl-next-possibilities
1490 (nthcdr (- (length cmpl-starting-possibilities
)
1491 (length cmpl-next-possibilities
))
1492 cmpl-starting-possibilities
)))))
1494 ;; non-negative index, reset and search
1496 (completion-search-reset-1)
1497 (setq cmpl-last-index index
)
1498 (while (and (completion-search-peek t
)
1499 (not (< (setq index
(1- index
)) 0)))
1500 (setq cmpl-next-possibility nil
))))
1502 cmpl-next-possibility
1503 (setq cmpl-next-possibility nil
)))
1506 (defun completion-search-peek (use-cdabbrev)
1507 "Return the next completion entry without actually moving the pointers.
1508 Calling this again or calling `completion-search-next' results in the same
1509 string being returned. Depends on `case-fold-search'.
1510 If there are no more entries, try cdabbrev and then return only a string."
1512 ;; return the cached value if we have it
1513 (cmpl-next-possibility)
1514 ((and cmpl-next-possibilities
1515 ;; still a few possibilities left
1518 (and (not (eq 0 (string-match cmpl-test-regexp
1519 (completion-string (car cmpl-next-possibilities
)))))
1520 (setq cmpl-next-possibilities
(cdr cmpl-next-possibilities
))))
1521 cmpl-next-possibilities
))
1523 (setq cmpl-next-possibility
(car cmpl-next-possibilities
)
1524 cmpl-tried-list
(cons (downcase (completion-string cmpl-next-possibility
))
1526 cmpl-next-possibilities
(cdr cmpl-next-possibilities
))
1527 cmpl-next-possibility
)
1529 ;; unsuccessful, use cdabbrev
1530 (cond ((not cmpl-cdabbrev-reset-p
)
1531 (reset-cdabbrev cmpl-test-string cmpl-tried-list
)
1532 (setq cmpl-cdabbrev-reset-p t
)))
1533 (setq cmpl-next-possibility
(next-cdabbrev)))
1534 ;; Completely unsuccessful, return nil
1539 ;; (add-completion "banana")
1540 ;; (completion-search-reset "ban")
1541 ;; (completion-search-next 0) --> "banana"
1543 ;; - Discrimination -
1544 ;; (add-completion "cumberland")
1545 ;; (add-completion "cumberbund")
1547 ;; (completion-search-reset "cumb")
1548 ;; (completion-search-peek t) --> "cumberbund"
1549 ;; (completion-search-next 0) --> "cumberbund"
1550 ;; (completion-search-peek t) --> "cumberland"
1551 ;; (completion-search-next 1) --> "cumberland"
1552 ;; (completion-search-peek nil) --> nil
1553 ;; (completion-search-next 2) --> "cumbering" {cdabbrev}
1554 ;; (completion-search-next 3) --> nil or "cumming"{depends on context}
1555 ;; (completion-search-next 1) --> "cumberland"
1556 ;; (completion-search-peek t) --> "cumbering" {cdabbrev}
1559 ;; (completion-search-next 1) --> "cumberland"
1560 ;; (setq completion-to-accept "cumberland")
1561 ;; (completion-search-reset "foo")
1562 ;; (completion-search-reset "cum")
1563 ;; (completion-search-next 0) --> "cumberland"
1566 ;; (kill-completion "cumberland")
1568 ;; (completion-search-reset "cum")
1569 ;; (completion-search-next 0) --> "cumberbund"
1570 ;; (completion-search-next 1) --> "cummings"
1572 ;; - Ignoring Capitalization -
1573 ;; (completion-search-reset "CuMb")
1574 ;; (completion-search-next 0) --> "cumberbund"
1578 ;;-----------------------------------------------
1580 ;;-----------------------------------------------
1582 (defun completion-mode ()
1583 "Toggle whether or not to add new words to the completion database."
1585 (setq enable-completion
(not enable-completion
))
1586 (message "Completion mode is now %s." (if enable-completion
"ON" "OFF")))
1588 (defvar cmpl-current-index
0)
1589 (defvar cmpl-original-string nil
)
1590 (defvar cmpl-last-insert-location -
1)
1591 (defvar cmpl-leave-point-at-start nil
)
1593 (defun complete (&optional arg
)
1594 "Fill out a completion of the word before point.
1595 Point is left at end. Consecutive calls rotate through all possibilities.
1597 control-u :: leave the point at the beginning of the completion rather
1599 a number :: rotate through the possible completions by that amount
1600 `-' :: same as -1 (insert previous completion)
1601 {See the comments at the top of `completion.el' for more info.}"
1603 ;;; Set up variables
1604 (cond ((eq last-command this-command
)
1606 (delete-region cmpl-last-insert-location
(point))
1607 ;; get next completion
1608 (setq cmpl-current-index
(+ cmpl-current-index
(or arg
1))))
1610 (if (not cmpl-initialized-p
)
1611 (completion-initialize)) ;; make sure everything's loaded
1612 (cond ((consp current-prefix-arg
) ;; control-u
1614 (setq cmpl-leave-point-at-start t
))
1616 (setq cmpl-leave-point-at-start nil
)))
1618 (setq cmpl-original-string
(symbol-before-point-for-complete))
1619 (cond ((not cmpl-original-string
)
1620 (setq this-command
'failed-complete
)
1621 (error "To complete, point must be after a symbol at least %d character long"
1622 completion-prefix-min-length
)))
1624 (setq cmpl-current-index
(if current-prefix-arg arg
0))
1626 (cmpl-statistics-block
1627 (note-complete-entered-afresh cmpl-original-string
))
1629 (completion-search-reset cmpl-original-string
)
1630 ;; erase what we've got
1631 (delete-region cmpl-symbol-start cmpl-symbol-end
)))
1633 ;; point is at the point to insert the new symbol
1634 ;; Get the next completion
1635 (let* ((print-status-p
1636 (and (>= baud-rate completion-prompt-speed-threshold
)
1637 (not (window-minibuffer-p (selected-window)))))
1638 (insert-point (point))
1639 (entry (completion-search-next cmpl-current-index
))
1641 ;; entry is either a completion entry or a string (if cdabbrev)
1645 ;; Setup for proper case
1646 (setq string
(if (stringp entry
)
1647 entry
(completion-string entry
)))
1648 (setq string
(cmpl-merge-string-cases
1649 string cmpl-original-string
))
1653 (setq completion-to-accept string
)
1654 ;; fixup and cache point
1655 (cond (cmpl-leave-point-at-start
1656 (setq cmpl-last-insert-location
(point))
1657 (goto-char insert-point
))
1659 (setq cmpl-last-insert-location insert-point
)))
1661 (cmpl-statistics-block
1662 (note-complete-inserted entry cmpl-current-index
))
1663 ;; Done ! cmpl-stat-complete-successful
1664 ;;display the next completion
1666 ((and print-status-p
1667 ;; This updates the display and only prints if there
1671 (completion-search-peek
1672 completion-cdabbrev-prompt-flag
)))
1673 (setq string
(if (stringp entry
)
1674 entry
(completion-string entry
)))
1675 (setq string
(cmpl-merge-string-cases
1676 string cmpl-original-string
))
1677 (message "Next completion: %s" string
))))
1678 (t;; none found, insert old
1679 (insert cmpl-original-string
)
1680 ;; Don't accept completions
1681 (setq completion-to-accept nil
)
1683 ;; This used to call cmpl19-sit-for, an undefined function.
1684 ;; I hope that sit-for does the right thing; I don't know -- rms.
1685 (if (and print-status-p
(sit-for 0))
1686 (message "No %scompletions."
1687 (if (eq this-command last-command
) "more " "")))
1689 (cmpl-statistics-block
1690 (record-complete-failed cmpl-current-index
))
1691 ;; Pretend that we were never here
1692 (setq this-command
'failed-complete
)))))
1694 ;;---------------------------------------------------------------------------
1695 ;; Parsing definitions from files into the database
1696 ;;---------------------------------------------------------------------------
1698 ;;-----------------------------------------------
1699 ;; Top Level functions ::
1700 ;;-----------------------------------------------
1703 (defun add-completions-from-file (file)
1704 "Parse possible completions from a FILE and add them to data base."
1705 (interactive "fFile: ")
1706 (setq file
(expand-file-name file
))
1707 (let* ((buffer (get-file-buffer file
))
1708 (buffer-already-there-p buffer
))
1709 (if (not buffer-already-there-p
)
1710 (let ((completions-merging-modes nil
))
1711 (setq buffer
(find-file-noselect file
))))
1713 (with-current-buffer buffer
1714 (add-completions-from-buffer))
1715 (if (not buffer-already-there-p
)
1716 (kill-buffer buffer
)))))
1718 (defun add-completions-from-buffer ()
1720 (let ((current-completion-source cmpl-source-file-parsing
)
1722 (cmpl-statistics-block
1723 (aref completion-add-count-vector cmpl-source-file-parsing
)))
1725 (cond ((memq major-mode
'(emacs-lisp-mode lisp-mode
))
1726 (add-completions-from-lisp-buffer)
1728 ((memq major-mode
'(c-mode))
1729 (add-completions-from-c-buffer)
1732 (error "Cannot parse completions in %s buffers"
1734 (cmpl-statistics-block
1735 (record-cmpl-parse-file
1737 (- (aref completion-add-count-vector cmpl-source-file-parsing
)
1741 (defun completion-find-file-hook ()
1742 (cond (enable-completion
1743 (cond ((and (memq major-mode
'(emacs-lisp-mode lisp-mode
))
1744 (memq 'lisp completions-merging-modes
))
1745 (add-completions-from-buffer))
1746 ((and (memq major-mode
'(c-mode))
1747 (memq 'c completions-merging-modes
))
1748 (add-completions-from-buffer))))))
1750 ;;-----------------------------------------------
1751 ;; Tags Table Completions
1752 ;;-----------------------------------------------
1754 (defun add-completions-from-tags-table ()
1755 ;; Inspired by eero@media-lab.media.mit.edu
1756 "Add completions from the current tags table."
1758 (visit-tags-table-buffer) ;this will prompt if no tags-table
1760 (goto-char (point-min))
1764 (search-forward "\177")
1766 (and (setq string
(symbol-under-point))
1767 (add-completion-to-tail-if-new string
))
1772 ;;-----------------------------------------------
1773 ;; Lisp File completion parsing
1774 ;;-----------------------------------------------
1775 ;; This merely looks for phrases beginning with (def.... or
1776 ;; (package:def ... and takes the next word.
1778 ;; We tried using forward-lines and explicit searches but the regexp technique
1779 ;; was faster. (About 100K characters per second)
1781 (defconst *lisp-def-regexp
*
1782 "\n(\\(\\w*:\\)?def\\(\\w\\|\\s_\\)*\\s +(*"
1783 "A regexp that searches for Lisp definition form.")
1786 ;; (and (string-match *lisp-def-regexp* "\n(defun foo") (match-end 0)) -> 8
1787 ;; (and (string-match *lisp-def-regexp* "\n(si:def foo") (match-end 0)) -> 9
1788 ;; (and (string-match *lisp-def-regexp* "\n(def-bar foo")(match-end 0)) -> 10
1789 ;; (and (string-match *lisp-def-regexp* "\n(defun (foo") (match-end 0)) -> 9
1791 ;; Parses all the definition names from a Lisp mode buffer and adds them to
1792 ;; the completion database.
1793 (defun add-completions-from-lisp-buffer ()
1795 ;;; Sun-3/280 - 1500 to 3000 lines of lisp code per second
1798 (goto-char (point-min))
1801 (re-search-forward *lisp-def-regexp
*)
1802 (and (setq string
(symbol-under-point))
1803 (add-completion-to-tail-if-new string
)))
1807 ;;-----------------------------------------------
1808 ;; C file completion parsing
1809 ;;-----------------------------------------------
1811 ;; Looks for #define or [<storage class>] [<type>] <name>{,<name>}
1812 ;; or structure, array or pointer defs.
1813 ;; It gets most of the definition names.
1815 ;; As you might suspect by now, we use some symbol table hackery
1817 ;; Symbol separator chars (have whitespace syntax) --> , ; * = (
1818 ;; Opening char --> [ {
1819 ;; Closing char --> ] }
1820 ;; opening and closing must be skipped over
1821 ;; Whitespace chars (have symbol syntax)
1822 ;; Everything else has word syntax
1824 (defconst completion-c-def-syntax-table
1825 (let ((table (make-syntax-table))
1826 (whitespace-chars '(? ?
\n ?
\t ?
\f ?
\v ?
\r))
1827 ;; unfortunately the ?( causes the parens to appear unbalanced
1828 (separator-chars '(?
, ?
* ?
= ?\
( ?\
;))
1830 ;; default syntax is whitespace
1833 (modify-syntax-entry i
"w" table
)
1835 (dolist (char whitespace-chars
)
1836 (modify-syntax-entry char
"_" table
))
1837 (dolist (char separator-chars
)
1838 (modify-syntax-entry char
" " table
))
1839 (modify-syntax-entry ?\
[ "(]" table
)
1840 (modify-syntax-entry ?\
{ "(}" table
)
1841 (modify-syntax-entry ?\
] ")[" table
)
1842 (modify-syntax-entry ?\
} "){" table
)
1846 (defconst *c-def-regexp
*
1847 ;; This stops on lines with possible definitions
1849 ;; This stops after the symbol to add.
1850 ;;"\n\\(#define\\s +.\\|\\(\\(\\w\\|\\s_\\)+\\b\\s *\\)+[(;,[*{=]\\)"
1851 ;; This stops before the symbol to add. {Test cases in parens. below}
1852 ;;"\n\\(\\(\\w\\|\\s_\\)+\\s *(\\|\\(\\(#define\\|auto\\|extern\\|register\\|static\\|int\\|long\\|short\\|unsigned\\|char\\|void\\|float\\|double\\|enum\\|struct\\|union\\|typedef\\)\\s +\\)+\\)"
1853 ;; this simple version picks up too much extraneous stuff
1854 ;; "\n\\(\\w\\|\\s_\\|#\\)\\B"
1855 "A regexp that searches for a definition form.")
1857 ;(defconst *c-cont-regexp*
1858 ; "\\(\\w\\|\\s_\\)+\\b\\s *\\({\\|\\(\\[[0-9\t ]*\\]\\s *\\)*,\\(*\\|\\s \\)*\\b\\)"
1859 ; "This regexp should be used in a looking-at to parse for lists of variables.")
1861 ;(defconst *c-struct-regexp*
1862 ; "\\(*\\|\\s \\)*\\b"
1863 ; "This regexp should be used to test whether a symbol follows a structure definition.")
1865 ;(defun test-c-def-regexp (regexp string)
1866 ; (and (eq 0 (string-match regexp string)) (match-end 0))
1870 ;; (test-c-def-regexp *c-def-regexp* "\n#define foo") -> 10 (9)
1871 ;; (test-c-def-regexp *c-def-regexp* "\nfoo (x, y) {") -> 6 (6)
1872 ;; (test-c-def-regexp *c-def-regexp* "\nint foo (x, y)") -> 10 (5)
1873 ;; (test-c-def-regexp *c-def-regexp* "\n int foo (x, y)") -> nil
1874 ;; (test-c-def-regexp *c-cont-regexp* "oo, bar") -> 4
1875 ;; (test-c-def-regexp *c-cont-regexp* "oo, *bar") -> 5
1876 ;; (test-c-def-regexp *c-cont-regexp* "a [5][6], bar") -> 10
1877 ;; (test-c-def-regexp *c-cont-regexp* "oo(x,y)") -> nil
1878 ;; (test-c-def-regexp *c-cont-regexp* "a [6] ,\t bar") -> 9
1879 ;; (test-c-def-regexp *c-cont-regexp* "oo {trout =1} my_carp;") -> 14
1880 ;; (test-c-def-regexp *c-cont-regexp* "truct_p complex foon") -> nil
1882 ;; Parses all the definition names from a C mode buffer and adds them to the
1883 ;; completion database.
1884 (defun add-completions-from-c-buffer ()
1886 ;; Sun 3/280-- 1250 lines/sec.
1888 (let (string next-point char
)
1890 (goto-char (point-min))
1891 (catch 'finish-add-completions
1892 (with-syntax-table completion-c-def-syntax-table
1894 ;; we loop here only when scan-sexps fails
1895 ;; (i.e. unbalance exps.)
1898 (re-search-forward *c-def-regexp
*)
1900 ((= (preceding-char) ?
#)
1901 ;; preprocessor macro, see if it's one we handle
1902 (cond ((looking-at "\\(define\\|ifdef\\)\\>")
1903 ;; skip forward over definition symbol
1904 ;; and add it to database
1905 (and (forward-word 2)
1906 (setq string
(symbol-before-point))
1908 (add-completion-to-tail-if-new string
)))))
1911 (setq next-point
(point))
1914 ;; scan to next separator char.
1915 (setq next-point
(scan-sexps next-point
1)))
1916 ;; position the point on the word we want to add
1917 (goto-char next-point
)
1918 (while (= (setq char
(following-char)) ?
*)
1919 ;; handle pointer ref
1920 ;; move to next separator char.
1922 (setq next-point
(scan-sexps (point) 1))))
1925 (if (setq string
(symbol-under-point))
1926 ;; (push string foo)
1927 (add-completion-to-tail-if-new string
)
1928 ;; Local TMC hack (useful for parsing paris.h)
1929 (if (and (looking-at "_AP") ;; "ansi prototype"
1933 (symbol-under-point))))
1934 (add-completion-to-tail-if-new string
)))
1936 (goto-char next-point
)
1937 ;; (push (format "%c" (following-char)) foo)
1938 (if (= (char-syntax char
) ?\
()
1939 ;; if on an opening delimiter, go to end
1940 (while (= (char-syntax char
) ?\
()
1941 (setq next-point
(scan-sexps next-point
1)
1942 char
(char-after next-point
)))
1944 ;; Current char is an end char.
1945 (setq next-point nil
)))))))
1946 (search-failed ;;done
1947 (throw 'finish-add-completions t
))
1949 ;; Check for failure in scan-sexps
1950 (if (member (nth 1 e
)
1951 '("Containing expression ends prematurely"
1952 "Unbalanced parentheses"))
1953 ;; unbalanced paren., keep going
1956 (message "Error parsing C buffer for completions--please send bug report")
1957 (throw 'finish-add-completions t
))))))))))
1960 ;;---------------------------------------------------------------------------
1962 ;;---------------------------------------------------------------------------
1964 ;; The version of save-completions-to-file called at kill-emacs time.
1965 (defun kill-emacs-save-completions ()
1966 (if (and save-completions-flag enable-completion cmpl-initialized-p
)
1968 ((not cmpl-completions-accepted-p
)
1969 (message "Completions database has not changed - not writing."))
1971 (save-completions-to-file))))
1972 (cmpl-statistics-block (record-cmpl-kill-emacs)))
1974 ;; There is no point bothering to change this again
1975 ;; unless the package changes so much that it matters
1976 ;; for people that have saved completions.
1977 (defconst completion-version
"11")
1979 (defconst saved-cmpl-file-header
1980 ";;; Completion Initialization file.
1982 ;; Format is (<string> . <last-use-time>)
1983 ;; <string> is the completion
1984 ;; <last-use-time> is the time the completion was last used
1985 ;; If it is t, the completion will never be pruned from the file.
1986 ;; Otherwise it is in hours since origin.
1989 (defun completion-backup-filename (filename)
1990 (concat filename
".BAK"))
1992 (defun save-completions-to-file (&optional filename
)
1993 "Save completions in init file FILENAME.
1994 If file name is not specified, use `save-completions-file-name'."
1996 (setq filename
(expand-file-name (or filename save-completions-file-name
)))
1997 (if (file-writable-p filename
)
1999 (if (not cmpl-initialized-p
)
2000 (completion-initialize)) ;; make sure everything's loaded
2001 (message "Saving completions to file %s" filename
)
2003 (let* ((delete-old-versions t
)
2004 (kept-old-versions 0)
2005 (kept-new-versions completions-file-versions-kept
)
2007 (current-time (cmpl-hours-since-origin))
2011 (backup-filename (completion-backup-filename filename
)))
2013 (with-current-buffer (get-buffer-create " *completion-save-buffer*")
2014 (setq buffer-file-name filename
)
2016 (if (not (verify-visited-file-modtime (current-buffer)))
2018 ;; file has changed on disk. Bring us up-to-date
2019 (message "Completion file has changed. Merging. . .")
2020 (load-completions-from-file filename t
)
2021 (message "Merging finished. Saving completions to file %s" filename
)))
2023 ;; prepare the buffer to be modified
2024 (clear-visited-file-modtime)
2027 (insert (format saved-cmpl-file-header completion-version
))
2028 (dolist (completion (list-all-completions))
2029 (setq total-in-db
(1+ total-in-db
))
2030 (setq last-use-time
(completion-last-use-time completion
))
2031 ;; Update num uses and maybe write completion to a file
2032 (cond ((or;; Write to file if
2034 (and (eq last-use-time t
)
2035 (setq total-perm
(1+ total-perm
)))
2037 (if (> (completion-num-uses completion
) 0)
2039 (setq last-use-time current-time
)
2040 ;; or it was saved before and
2042 ;; save-completions-retention-time is nil
2043 (or (not save-completions-retention-time
)
2044 ;; or time since last use is < ...retention-time*
2045 (< (- current-time last-use-time
)
2046 save-completions-retention-time
)))))
2048 (setq total-saved
(1+ total-saved
))
2049 (insert (prin1-to-string (cons (completion-string completion
)
2050 last-use-time
)) "\n"))))
2054 (let ((file-exists-p (file-exists-p filename
)))
2057 ;; If file exists . . .
2058 ;; Save a backup(so GNU doesn't screw us when we're out of disk)
2059 ;; (GNU leaves a 0 length file if it gets a disk full error!)
2061 ;; If backup doesn't exit, Rename current to backup
2062 ;; {If backup exists the primary file is probably messed up}
2063 (or (file-exists-p backup-filename
)
2064 (rename-file filename backup-filename
))
2065 ;; Copy the backup back to the current name
2066 ;; (so versioning works)
2067 (copy-file backup-filename filename t
)))
2071 ;; If successful, remove backup
2072 (delete-file backup-filename
)))
2074 (set-buffer-modified-p nil
)
2075 (message "Couldn't save completion file `%s'" filename
)))
2076 ;; Reset accepted-p flag
2077 (setq cmpl-completions-accepted-p nil
) )
2078 (cmpl-statistics-block
2079 (record-save-completions total-in-db total-perm total-saved
))))))
2081 ;;(defun auto-save-completions ()
2082 ;; (if (and save-completions-flag enable-completion cmpl-initialized-p
2083 ;; *completion-auto-save-period*
2084 ;; (> cmpl-emacs-idle-time *completion-auto-save-period*)
2085 ;; cmpl-completions-accepted-p)
2086 ;; (save-completions-to-file)))
2088 ;;(add-hook 'cmpl-emacs-idle-time-hooks 'auto-save-completions)
2090 (defun load-completions-from-file (&optional filename no-message-p
)
2091 "Load a completion init file FILENAME.
2092 If file is not specified, then use `save-completions-file-name'."
2094 (setq filename
(expand-file-name (or filename save-completions-file-name
)))
2095 (let* ((backup-filename (completion-backup-filename filename
))
2096 (backup-readable-p (file-readable-p backup-filename
)))
2097 (if backup-readable-p
(setq filename backup-filename
))
2098 (if (file-readable-p filename
)
2100 (if (not no-message-p
)
2101 (message "Loading completions from %sfile %s . . ."
2102 (if backup-readable-p
"backup " "") filename
))
2103 (with-current-buffer (get-buffer-create " *completion-save-buffer*")
2104 (setq buffer-file-name filename
)
2105 ;; prepare the buffer to be modified
2106 (clear-visited-file-modtime)
2109 (let ((insert-okay-p nil
)
2110 (buffer (current-buffer))
2111 string entry last-use-time
2112 cmpl-entry cmpl-last-use-time
2113 (current-completion-source cmpl-source-init-file
)
2115 (cmpl-statistics-block
2116 (aref completion-add-count-vector cmpl-source-file-parsing
)))
2117 (total-in-file 0) (total-perm 0))
2118 ;; insert the file into a buffer
2120 (progn (insert-file-contents filename t
)
2121 (setq insert-okay-p t
))
2124 (message "File error trying to load completion file %s."
2129 (goto-char (point-min))
2133 (setq entry
(read buffer
))
2134 (setq total-in-file
(1+ total-in-file
))
2137 (stringp (setq string
(car entry
)))
2139 ((eq (setq last-use-time
(cdr entry
)) 'T
)
2140 ;; handle case sensitivity
2141 (setq total-perm
(1+ total-perm
))
2142 (setq last-use-time t
))
2143 ((eq last-use-time t
)
2144 (setq total-perm
(1+ total-perm
)))
2145 ((integerp last-use-time
))))
2148 (setq cmpl-last-use-time
2149 (completion-last-use-time
2151 (add-completion-to-tail-if-new string
))))
2152 (if (or (eq last-use-time t
)
2153 (and (> last-use-time
1000);;backcompatibility
2154 (not (eq cmpl-last-use-time t
))
2155 (or (not cmpl-last-use-time
)
2157 (> last-use-time cmpl-last-use-time
))))
2158 ;; update last-use-time
2159 (set-completion-last-use-time cmpl-entry last-use-time
)))
2162 (message "Error: invalid saved completion - %s"
2163 (prin1-to-string entry
))
2164 ;; try to get back in sync
2165 (search-forward "\n("))))
2167 (message "End of file while reading completions."))
2169 (if (= (point) (point-max))
2170 (if (not no-message-p
)
2171 (message "Loading completions from file %s . . . Done."
2173 (message "End of file while reading completions."))))))
2175 (cmpl-statistics-block
2176 (record-load-completions
2177 total-in-file total-perm
2178 (- (aref completion-add-count-vector cmpl-source-init-file
)
2182 (defun completion-initialize ()
2183 "Load the default completions file.
2184 Also sets up so that exiting Emacs will automatically save the file."
2186 (unless cmpl-initialized-p
2187 (load-completions-from-file)
2188 (setq cmpl-initialized-p t
)))
2190 ;;-----------------------------------------------
2191 ;; Kill region patch
2192 ;;-----------------------------------------------
2194 (defun completion-kill-region (&optional beg end
)
2195 "Kill between point and mark.
2196 The text is deleted but saved in the kill ring.
2197 The command \\[yank] can retrieve it from there.
2198 /(If you want to kill and then yank immediately, use \\[copy-region-as-kill].)
2200 This is the primitive for programs to kill text (as opposed to deleting it).
2201 Supply two arguments, character positions indicating the stretch of text
2203 Any command that calls this function is a \"kill command\".
2204 If the previous command was also a kill command,
2205 the text killed this time appends to the text killed last time
2206 to make one entry in the kill ring.
2207 Patched to remove the most recent completion."
2209 (cond ((eq last-command
'complete
)
2210 (delete-region (point) cmpl-last-insert-location
)
2211 (insert cmpl-original-string
)
2212 (setq completion-to-accept nil
)
2213 (cmpl-statistics-block
2214 (record-complete-failed)))
2216 (kill-region beg end
))))
2219 ;;-----------------------------------------------
2220 ;; Patches to self-insert-command.
2221 ;;-----------------------------------------------
2223 ;; Need 2 versions: generic separator chars. and space (to get auto fill
2226 ;; All common separators (eg. space "(" ")" """) characters go through a
2227 ;; function to add new words to the list of words to complete from:
2228 ;; COMPLETION-SEPARATOR-SELF-INSERT-COMMAND (arg).
2229 ;; If the character before this was an alpha-numeric then this adds the
2230 ;; symbol before point to the completion list (using ADD-COMPLETION).
2232 (defun completion-separator-self-insert-command (arg)
2234 (use-completion-before-separator)
2235 (self-insert-command arg
))
2237 (defun completion-separator-self-insert-autofilling (arg)
2239 (use-completion-before-separator)
2240 (self-insert-command arg
)
2241 (and auto-fill-function
2242 (funcall auto-fill-function
)))
2244 ;;-----------------------------------------------
2246 ;;-----------------------------------------------
2248 ;; Note that because of the way byte compiling works, none of
2249 ;; the functions defined with this macro get byte compiled.
2251 (defun completion-def-wrapper (function-name type
)
2252 "Add a call to update the completion database before function execution.
2253 TYPE is the type of the wrapper to be added. Can be :before or :under."
2254 (put function-name
'completion-function
2256 '((:separator . use-completion-before-separator
)
2257 (:before . use-completion-before-point
)
2258 (:backward-under . use-completion-backward-under
)
2259 (:backward . use-completion-backward
)
2260 (:under . use-completion-under-point
)
2261 (:under-or-before . use-completion-under-or-before-point
)
2262 (:minibuffer-separator
2263 . use-completion-minibuffer-separator
))))))
2265 (defun use-completion-minibuffer-separator ()
2266 (let ((completion-syntax-table completion-standard-syntax-table
))
2267 (use-completion-before-separator)))
2269 (defun use-completion-backward-under ()
2270 (use-completion-under-point)
2271 (if (eq last-command
'complete
)
2272 ;; probably a failed completion if you have to back up
2273 (cmpl-statistics-block (record-complete-failed))))
2275 (defun use-completion-backward ()
2276 (if (eq last-command
'complete
)
2277 ;; probably a failed completion if you have to back up
2278 (cmpl-statistics-block (record-complete-failed))))
2280 (defun completion-before-command ()
2281 (funcall (or (and (symbolp this-command
)
2282 (get this-command
'completion-function
))
2283 'use-completion-under-or-before-point
)))
2287 (defconst completion-lisp-syntax-table
2288 (let ((table (copy-syntax-table completion-standard-syntax-table
))
2289 (symbol-chars '(?
! ?
& ?? ?
= ?^
)))
2290 (dolist (char symbol-chars
)
2291 (modify-syntax-entry char
"_" table
))
2294 (defun completion-lisp-mode-hook ()
2295 (setq completion-syntax-table completion-lisp-syntax-table
)
2297 (local-set-key "!" 'self-insert-command
)
2298 (local-set-key "&" 'self-insert-command
)
2299 (local-set-key "%" 'self-insert-command
)
2300 (local-set-key "?" 'self-insert-command
)
2301 (local-set-key "=" 'self-insert-command
)
2302 (local-set-key "^" 'self-insert-command
))
2306 (defconst completion-c-syntax-table
2307 (let ((table (copy-syntax-table completion-standard-syntax-table
))
2308 (separator-chars '(?
+ ?
* ?
/ ?
: ?%
)))
2309 (dolist (char separator-chars
)
2310 (modify-syntax-entry char
" " table
))
2313 (completion-def-wrapper 'electric-c-semi
:separator
)
2314 (defun completion-c-mode-hook ()
2315 (setq completion-syntax-table completion-c-syntax-table
)
2316 (local-set-key "+" 'completion-separator-self-insert-command
)
2317 (local-set-key "*" 'completion-separator-self-insert-command
)
2318 (local-set-key "/" 'completion-separator-self-insert-command
))
2320 ;; FORTRAN mode diffs. (these are defined when fortran is called)
2322 (defconst completion-fortran-syntax-table
2323 (let ((table (copy-syntax-table completion-standard-syntax-table
))
2324 (separator-chars '(?
+ ?- ?
* ?
/ ?
:)))
2325 (dolist (char separator-chars
)
2326 (modify-syntax-entry char
" " table
))
2329 (defun completion-setup-fortran-mode ()
2330 (setq completion-syntax-table completion-fortran-syntax-table
)
2331 (local-set-key "+" 'completion-separator-self-insert-command
)
2332 (local-set-key "-" 'completion-separator-self-insert-command
)
2333 (local-set-key "*" 'completion-separator-self-insert-command
)
2334 (local-set-key "/" 'completion-separator-self-insert-command
))
2336 ;; Enable completion mode.
2338 (defvar fortran-mode-hook
)
2340 (defvar completion-saved-bindings nil
)
2343 (define-minor-mode dynamic-completion-mode
2344 "Enable dynamic word-completion."
2346 ;; This is always good, not specific to dynamic-completion-mode.
2347 (define-key function-key-map
[C-return
] [?\C-
\r])
2349 (dolist (x '((find-file-hook . completion-find-file-hook
)
2350 (pre-command-hook . completion-before-command
)
2351 ;; Save completions when killing Emacs.
2352 (kill-emacs-hook . kill-emacs-save-completions
)
2354 ;; Install the appropriate mode tables.
2355 (lisp-mode-hook . completion-lisp-mode-hook
)
2356 (c-mode-hook . completion-c-mode-hook
)
2357 (fortran-mode-hook . completion-setup-fortran-mode
)))
2358 (if dynamic-completion-mode
2359 (add-hook (car x
) (cdr x
))
2360 (remove-hook (car x
) (cdr x
))))
2362 ;; "Complete" Key Keybindings. We don't want to use a minor-mode
2363 ;; map because these have too high a priority. We could/should
2364 ;; probably change the interpretation of minor-mode-map-alist such
2365 ;; that a map has lower precedence if the symbol is not buffer-local.
2366 (while completion-saved-bindings
2367 (let ((binding (pop completion-saved-bindings
)))
2368 (global-set-key (car binding
) (cdr binding
))))
2369 (when dynamic-completion-mode
2371 '(("\M-\r" . complete
)
2372 ([?\C-
\r] . complete
)
2375 ;; (add-completion "cumberland")
2376 ;; (add-completion "cumberbund")
2382 ;; Patches to standard keymaps insert completions
2383 ([remap kill-region
] . completion-kill-region
)
2386 ;; We've used the completion syntax table given as a guide.
2388 ;; Global separator chars.
2389 ;; We left out <tab> because there are too many special
2390 ;; cases for it. Also, in normal coding it's rarely typed
2392 (" " . completion-separator-self-insert-autofilling
)
2393 ("!" . completion-separator-self-insert-command
)
2394 ("%" . completion-separator-self-insert-command
)
2395 ("^" . completion-separator-self-insert-command
)
2396 ("&" . completion-separator-self-insert-command
)
2397 ("(" . completion-separator-self-insert-command
)
2398 (")" . completion-separator-self-insert-command
)
2399 ("=" . completion-separator-self-insert-command
)
2400 ("`" . completion-separator-self-insert-command
)
2401 ("|" . completion-separator-self-insert-command
)
2402 ("{" . completion-separator-self-insert-command
)
2403 ("}" . completion-separator-self-insert-command
)
2404 ("[" . completion-separator-self-insert-command
)
2405 ("]" . completion-separator-self-insert-command
)
2406 (";" . completion-separator-self-insert-command
)
2407 ("\"". completion-separator-self-insert-command
)
2408 ("'" . completion-separator-self-insert-command
)
2409 ("#" . completion-separator-self-insert-command
)
2410 ("," . completion-separator-self-insert-command
)
2411 ("?" . completion-separator-self-insert-command
)
2413 ;; We include period and colon even though they are symbol
2415 ;; - in text we want to pick up the last word in a sentence.
2416 ;; - in C pointer refs. we want to pick up the first symbol
2417 ;; - it won't make a difference for lisp mode (package names
2419 ("." . completion-separator-self-insert-command
)
2420 (":" . completion-separator-self-insert-command
)))
2421 (push (cons (car binding
) (lookup-key global-map
(car binding
)))
2422 completion-saved-bindings
)
2423 (global-set-key (car binding
) (cdr binding
)))
2431 (cmpl-statistics-block
2432 (record-completion-file-loaded))
2434 (completion-initialize)))
2436 ;;-----------------------------------------------
2437 ;; End of line chars.
2438 ;;-----------------------------------------------
2439 (completion-def-wrapper 'newline
:separator
)
2440 (completion-def-wrapper 'newline-and-indent
:separator
)
2441 (completion-def-wrapper 'comint-send-input
:separator
)
2442 (completion-def-wrapper 'exit-minibuffer
:minibuffer-separator
)
2443 (completion-def-wrapper 'eval-print-last-sexp
:separator
)
2444 (completion-def-wrapper 'eval-last-sexp
:separator
)
2445 ;;(completion-def-wrapper 'minibuffer-complete-and-exit :minibuffer)
2447 ;;-----------------------------------------------
2449 ;;-----------------------------------------------
2451 (completion-def-wrapper 'next-line
:under-or-before
)
2452 (completion-def-wrapper 'previous-line
:under-or-before
)
2453 (completion-def-wrapper 'beginning-of-buffer
:under-or-before
)
2454 (completion-def-wrapper 'end-of-buffer
:under-or-before
)
2455 (completion-def-wrapper 'beginning-of-line
:under-or-before
)
2456 (completion-def-wrapper 'end-of-line
:under-or-before
)
2457 (completion-def-wrapper 'forward-char
:under-or-before
)
2458 (completion-def-wrapper 'forward-word
:under-or-before
)
2459 (completion-def-wrapper 'forward-sexp
:under-or-before
)
2460 (completion-def-wrapper 'backward-char
:backward-under
)
2461 (completion-def-wrapper 'backward-word
:backward-under
)
2462 (completion-def-wrapper 'backward-sexp
:backward-under
)
2464 (completion-def-wrapper 'delete-backward-char
:backward
)
2465 (completion-def-wrapper 'delete-backward-char-untabify
:backward
)
2467 ;; Old names, non-namespace-clean.
2468 (defvaralias 'cmpl-syntax-table
'completion-syntax-table
)
2469 (defalias 'initialize-completions
'completion-initialize
)
2471 (dolist (x '("^To complete, the point must be after a symbol at least [0-9]* character long\\.$"
2472 "^The string \".*\" is too short to be saved as a completion\\.$"))
2473 (add-to-list 'debug-ignored-errors x
))
2475 (provide 'completion
)
2477 ;; arch-tag: 6990dafe-4abd-4a1f-8c42-ffb25e120f5e
2478 ;;; completion.el ends here