1 ;;; completion.el --- dynamic word-completion code
2 ;; Copyright (C) 1990, 1993 Free Software Foundation, Inc.
6 ;; Author: Jim Salem <salem@think.com> and Brewster Kahle <brewster@think.com>
7 ;; of Thinking Machines Inc.
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)
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.
27 ;;; What to put in .emacs
28 ;;;-----------------------
29 ;;; (load "completion")
30 ;;; (initialize-completions)
32 ;;;---------------------------------------------------------------------------
33 ;;; Documentation [Slightly out of date]
34 ;;;---------------------------------------------------------------------------
35 ;;; (also check the documentation string of the functions)
40 ;;; After you type a few characters, pressing the "complete" key inserts
41 ;;; the rest of the word you are likely to type.
43 ;;; This watches all the words that you type and remembers them. When
44 ;;; typing a new word, pressing "complete" (meta-return) "completes" the
45 ;;; word by inserting the most recently used word that begins with the
46 ;;; same characters. If you press meta-return repeatedly, it cycles
47 ;;; through all the words it knows about.
49 ;;; If you like the completion then just continue typing, it is as if you
50 ;;; entered the text by hand. If you want the inserted extra characters
51 ;;; to go away, type control-w or delete. More options are described below.
53 ;;; The guesses are made in the order of the most recently "used". Typing
54 ;;; in a word and then typing a separator character (such as a space) "uses"
55 ;;; the word. So does moving a cursor over the word. If no words are found,
56 ;;; it uses an extended version of the dabbrev style completion.
58 ;;; You automatically save the completions you use to a file between
61 ;;; Completion enables programmers to enter longer, more descriptive
62 ;;; variable names while typing fewer keystrokes than they normally would.
65 ;;; Full documentation
66 ;;;---------------------
68 ;;; A "word" is any string containing characters with either word or symbol
69 ;;; syntax. [E.G. Any alphanumeric string with hyphens, underscores, etc.]
70 ;;; Unless you change the constants, you must type at least three characters
71 ;;; for the word to be recognized. Only words longer than 6 characters are
74 ;;; When you load this file, completion will be on. I suggest you use the
75 ;;; compiled version (because it is noticeably faster).
77 ;;; M-X completion-mode toggles whether or not new words are added to the
78 ;;; database by changing the value of enable-completion.
80 ;;; SAVING/LOADING COMPLETIONS
81 ;;; Completions are automatically saved from one session to another
82 ;;; (unless save-completions-flag or enable-completion is nil).
83 ;;; Loading this file (or calling initialize-completions) causes EMACS
84 ;;; to load a completions database for a saved completions file
85 ;;; (default: ~/.completions). When you exit, EMACS saves a copy of the
86 ;;; completions that you
87 ;;; often use. When you next start, EMACS loads in the saved completion file.
89 ;;; The number of completions saved depends loosely on
90 ;;; *saved-completions-decay-factor*. Completions that have never been
91 ;;; inserted via "complete" are not saved. You are encouraged to experiment
92 ;;; with different functions (see compute-completion-min-num-uses).
94 ;;; Some completions are permanent and are always saved out. These
95 ;;; completions have their num-uses slot set to T. Use
96 ;;; add-permanent-completion to do this
98 ;;; Completions are saved only if enable-completion is T. The number of old
99 ;;; versions kept of the saved completions file is controlled by
100 ;;; completions-file-versions-kept.
102 ;;; COMPLETE KEY OPTIONS
103 ;;; The complete function takes a numeric arguments.
104 ;;; control-u :: leave the point at the beginning of the completion rather
106 ;;; a number :: rotate through the possible completions by that amount
107 ;;; `-' :: same as -1 (insert previous completion)
109 ;;; HOW THE DATABASE IS MAINTAINED
112 ;;; UPDATING THE DATABASE MANUALLY
113 ;;; m-x kill-completion
114 ;;; kills the completion at point.
115 ;;; m-x add-completion
116 ;;; m-x add-permanent-completion
118 ;;; UPDATING THE DATABASE FROM A SOURCE CODE FILE
119 ;;; m-x add-completions-from-buffer
120 ;;; Parses all the definition names from a C or LISP mode buffer and
121 ;;; adds them to the completion database.
123 ;;; m-x add-completions-from-lisp-file
124 ;;; Parses all the definition names from a C or Lisp mode file and
125 ;;; adds them to the completion database.
127 ;;; UPDATING THE DATABASE FROM A TAGS TABLE
128 ;;; m-x add-completions-from-tags-table
129 ;;; Adds completions from the current tags-table-buffer.
131 ;;; HOW A COMPLETION IS FOUND
135 ;;; Completion is string case independent if case-fold-search has its
136 ;;; normal default of T. Also when the completion is inserted the case of the
137 ;;; entry is coerced appropriately.
138 ;;; [E.G. APP --> APPROPRIATELY app --> appropriately
139 ;;; App --> Appropriately]
142 ;;; The form `(initialize-completions)' initializes the completion system by
143 ;;; trying to load in the user's completions. After the first cal, further
144 ;;; calls have no effect so one should be careful not to put the form in a
145 ;;; site's standard site-init file.
147 ;;;---------------------------------------------------------------------------
151 ;;;---------------------------------------------------------------------------
152 ;;; Functions you might like to call
153 ;;;---------------------------------------------------------------------------
155 ;;; add-completion string &optional num-uses
156 ;;; Adds a new string to the database
158 ;;; add-permanent-completion string
159 ;;; Adds a new string to the database with num-uses = T
162 ;;; kill-completion string
163 ;;; Kills the completion from the database.
165 ;;; clear-all-completions
166 ;;; Clears the database
168 ;;; list-all-completions
169 ;;; Returns a list of all completions.
172 ;;; next-completion string &optional index
173 ;;; Returns a completion entry that starts with string.
175 ;;; find-exact-completion string
176 ;;; Returns a completion entry that exactly matches string.
179 ;;; Inserts a completion at point
181 ;;; initialize-completions
182 ;;; Loads the completions file and sets up so that exiting emacs will
185 ;;; save-completions-to-file &optional filename
186 ;;; load-completions-from-file &optional filename
188 ;;;-----------------------------------------------
190 ;;;-----------------------------------------------
192 ;;; get-completion-list string
194 ;;; These things are for manipulating the structure
195 ;;; make-completion string num-uses
196 ;;; completion-num-uses completion
197 ;;; completion-string completion
198 ;;; set-completion-num-uses completion num-uses
199 ;;; set-completion-string completion string
203 ;;;-----------------------------------------------
204 ;;; To Do :: (anybody ?)
205 ;;;-----------------------------------------------
207 ;;; Implement Lookup and keyboard interface in C
208 ;;; Add package prefix smarts (for Common Lisp)
209 ;;; Add autoprompting of possible completions after every keystroke (fast
210 ;;; terminals only !)
211 ;;; Add doc. to texinfo
214 ;;;-----------------------------------------------
216 ;;;-----------------------------------------------
217 ;;; Sometime in '84 Brewster implemented a somewhat buggy version for
218 ;;; Symbolics LISPMs.
219 ;;; Jan. '85 Jim became enamored of the idea and implemented a faster,
220 ;;; more robust version.
221 ;;; With input from many users at TMC, (rose, craig, and gls come to mind),
222 ;;; the current style of interface was developed.
223 ;;; 9/87, Jim and Brewster took terminals home. Yuck. After
224 ;;; complaining for a while Brewester implemented a subset of the current
225 ;;; LISPM version for GNU Emacs.
226 ;;; 8/88 After complaining for a while (and with sufficient
227 ;;; promised rewards), Jim reimplemented a version of GNU completion
228 ;;; superior to that of the LISPM version.
230 ;;;-----------------------------------------------
232 ;;;-----------------------------------------------
233 ;;; Cliff Lasser (cal@think.com), Kevin Herbert (kph@cisco.com),
234 ;;; eero@media-lab, kgk@cs.brown.edu, jla@ai.mit.edu,
236 ;;;-----------------------------------------------
238 ;;;-----------------------------------------------
239 ;;; From version 9 to 10
240 ;;; - Allowance for non-integral *completion-version* nos.
241 ;;; - Fix cmpl-apply-as-top-level for keyboard macros
242 ;;; - Fix broken completion merging (in save-completions-to-file)
243 ;;; - More misc. fixes for version 19.0 of emacs
245 ;;; From Version 8 to 9
246 ;;; - Ported to version 19.0 of emacs (backcompatible with version 18)
247 ;;; - Added add-completions-from-tags-table (with thanks to eero@media-lab)
249 ;;; From Version 7 to 8
250 ;;; - Misc. changes to comments
251 ;;; - new completion key bindings: c-x o, M->, M-<, c-a, c-e
252 ;;; - cdabbrev now checks all the visible window buffers and the "other buffer"
253 ;;; - `%' is now a symbol character rather than a separator (except in C mode)
255 ;;; From Version 6 to 7
256 ;;; - Fixed bug with saving out .completion file the first time
258 ;;; From Version 5 to 6
259 ;;; - removed statistics recording
260 ;;; - reworked advise to handle autoloads
261 ;;; - Fixed fortran mode support
262 ;;; - Added new cursor motion triggers
264 ;;; From Version 4 to 5
265 ;;; - doesn't bother saving if nothing has changed
266 ;;; - auto-save if haven't used for a 1/2 hour
267 ;;; - save period extended to two weeks
268 ;;; - minor fix to capitalization code
269 ;;; - added *completion-auto-save-period* to variables recorded.
270 ;;; - added reenter protection to cmpl-record-statistics-filter
271 ;;; - added backup protection to save-completions-to-file (prevents
272 ;;; problems with disk full errors)
276 ;;;---------------------------------------------------------------------------
277 ;;; User changeable parameters
278 ;;;---------------------------------------------------------------------------
280 (defvar enable-completion t
281 "*Non-nil means enable recording and saving of completions.
282 If nil, no new words added to the database or saved to the init file.")
284 (defvar save-completions-flag t
285 "*Non-nil means save most-used completions when exiting Emacs.
286 See also `saved-completions-retention-time'.")
288 (defvar save-completions-file-name "~/.completions"
289 "*The filename to save completions to.")
291 (defvar save-completions-retention-time 336
292 "*Discard a completion if unused for this many hours.
293 \(1 day = 24, 1 week = 168). If this is 0, non-permanent completions
294 will not be saved unless these are used. Default is two weeks.")
296 (defvar completion-on-separator-character nil
297 "*Non-nil means separator characters mark previous word as used.
298 This means the word will be saved as a completion.")
300 (defvar completions-file-versions-kept kept-new-versions
301 "*Number of versions to keep for the saved completions file.")
303 (defvar completion-prompt-speed-threshold 4800
304 "*Minimum output speed at which to display next potential completion.")
306 (defvar completion-cdabbrev-prompt-flag nil
307 "*If non-nil, the next completion prompt does a cdabbrev search.
308 This can be time consuming.")
310 (defvar completion-search-distance 15000
311 "*How far to search in the buffer when looking for completions.
312 In number of characters. If nil, search the whole buffer.")
314 (defvar completions-merging-modes '(lisp c)
315 "*List of modes {`c' or `lisp'} for automatic completions merging.
316 Definitions from visited files which have these modes
317 are automatically added to the completion database.")
319 ;;;(defvar *record-cmpl-statistics-p* nil
320 ;;; "*If non-nil, record completion statistics.")
322 ;;;(defvar *completion-auto-save-period* 1800
323 ;;; "*The period in seconds to wait for emacs to be idle before autosaving
324 ;;;the completions. Default is a 1/2 hour.")
326 (defconst completion-min-length nil ;; defined below in eval-when
327 "*The minimum length of a stored completion.
328 DON'T CHANGE WITHOUT RECOMPILING ! This is used by macros.")
330 (defconst completion-max-length nil ;; defined below in eval-when
331 "*The maximum length of a stored completion.
332 DON'T CHANGE WITHOUT RECOMPILING ! This is used by macros.")
334 (defconst completion-prefix-min-length nil ;; defined below in eval-when
335 "The minimum length of a completion search string.
336 DON'T CHANGE WITHOUT RECOMPILING ! This is used by macros.")
338 (defmacro eval-when-compile-load-eval (&rest body)
339 ;; eval everything before expanding
343 (defun completion-eval-when ()
344 (eval-when-compile-load-eval
345 ;; These vars. are defined at both compile and load time.
346 (setq completion-min-length 6)
347 (setq completion-max-length 200)
348 (setq completion-prefix-min-length 3)))
350 (completion-eval-when)
352 ;; Need this file around too
355 ;;;---------------------------------------------------------------------------
356 ;;; Internal Variables
357 ;;;---------------------------------------------------------------------------
359 (defvar cmpl-initialized-p nil
360 "Set to t when the completion system is initialized.
361 Indicates that the old completion file has been read in.")
363 (defvar cmpl-completions-accepted-p nil
364 "Set to t as soon as the first completion has been accepted.
365 Used to decide whether to save completions.")
368 ;;;---------------------------------------------------------------------------
370 ;;;---------------------------------------------------------------------------
372 ;;;-----------------------------------------------
374 ;;;-----------------------------------------------
376 (defun minibuffer-window-selected-p ()
377 "True iff the current window is the minibuffer."
378 (window-minibuffer-p (selected-window)))
380 (defmacro cmpl-read-time-eval (form)
381 ;; Like the #. reader macro
385 ;;;-----------------------------------------------
386 ;;; String case coercion
387 ;;;-----------------------------------------------
389 (defun cmpl-string-case-type (string)
390 "Returns :capitalized, :up, :down, :mixed, or :neither."
391 (let ((case-fold-search nil))
392 (cond ((string-match "[a-z]" string)
393 (cond ((string-match "[A-Z]" string)
394 (cond ((and (> (length string) 1)
395 (null (string-match "[A-Z]" string 1)))
401 (cond ((string-match "[A-Z]" string)
407 ;;; (cmpl-string-case-type "123ABCDEF456") --> :up
408 ;;; (cmpl-string-case-type "123abcdef456") --> :down
409 ;;; (cmpl-string-case-type "123aBcDeF456") --> :mixed
410 ;;; (cmpl-string-case-type "123456") --> :neither
411 ;;; (cmpl-string-case-type "Abcde123") --> :capitalized
413 (defun cmpl-coerce-string-case (string case-type)
414 (cond ((eq case-type ':down) (downcase string))
415 ((eq case-type ':up) (upcase string))
416 ((eq case-type ':capitalized)
417 (setq string (downcase string))
418 (aset string 0 (logand ?\337 (aref string 0)))
423 (defun cmpl-merge-string-cases (string-to-coerce given-string)
424 (let ((string-case-type (cmpl-string-case-type string-to-coerce))
426 (cond ((memq string-case-type '(:down :up :capitalized))
427 ;; Found string is in a standard case. Coerce to a type based on
429 (cmpl-coerce-string-case string-to-coerce
430 (cmpl-string-case-type given-string))
433 ;; If the found string is in some unusual case, just insert it
439 ;;; (cmpl-merge-string-cases "AbCdEf456" "abc") --> AbCdEf456
440 ;;; (cmpl-merge-string-cases "abcdef456" "ABC") --> ABCDEF456
441 ;;; (cmpl-merge-string-cases "ABCDEF456" "Abc") --> Abcdef456
442 ;;; (cmpl-merge-string-cases "ABCDEF456" "abc") --> abcdef456
445 (defun cmpl-hours-since-origin ()
446 (let ((time (current-time)))
447 (+ (* (/ (car time) 3600.0) (lsh 1 16))
448 (/ (nth 2 time) 3600.0))))
450 ;;;---------------------------------------------------------------------------
451 ;;; "Symbol" parsing functions
452 ;;;---------------------------------------------------------------------------
453 ;;; The functions symbol-before-point, symbol-under-point, etc. quickly return
454 ;;; an appropriate symbol string. The strategy is to temporarily change
455 ;;; the syntax table to enable fast symbol searching. There are three classes
456 ;;; of syntax in these "symbol" syntax tables ::
458 ;;; syntax (?_) - "symbol" chars (e.g. alphanumerics)
459 ;;; syntax (?w) - symbol chars to ignore at end of words (e.g. period).
460 ;;; syntax (? ) - everything else
462 ;;; Thus by judicious use of scan-sexps and forward-word, we can get
463 ;;; the word we want relatively fast and without consing.
465 ;;; Why do we need a separate category for "symbol chars to ignore at ends" ?
466 ;;; For example, in LISP we want starting :'s trimmed
467 ;;; so keyword argument specifiers also define the keyword completion. And,
468 ;;; for example, in C we want `.' appearing in a structure ref. to
469 ;;; be kept intact in order to store the whole structure ref.; however, if
470 ;;; it appears at the end of a symbol it should be discarded because it is
471 ;;; probably used as a period.
473 ;;; Here is the default completion syntax ::
474 ;;; Symbol chars :: A-Z a-z 0-9 @ / \ * + ~ $ < > %
475 ;;; Symbol chars to ignore at ends :: _ : . -
476 ;;; Separator chars. :: <tab> <space> ! ^ & ( ) = ` | { } [ ] ; " ' #
477 ;;; , ? <Everything else>
479 ;;; Mode specific differences and notes ::
481 ;;; Symbol chars :: ! & ? = ^
484 ;;; Separator chars :: + * / : %
485 ;;; A note on the hyphen (`-'). Perhaps the hyphen should also be a separator
486 ;;; char., however, we wanted to have completion symbols include pointer
487 ;;; references. For example, "foo->bar" is a symbol as far as completion is
491 ;;; Separator chars :: + - * / :
493 ;;; Pathname diffs ->
494 ;;; Symbol chars :: .
495 ;;; Of course there is no pathname "mode" and in fact we have not implemented
496 ;;; this table. However, if there was such a mode, this is what it would look
499 ;;;-----------------------------------------------
500 ;;; Table definitions
501 ;;;-----------------------------------------------
503 (defun cmpl-make-standard-completion-syntax-table ()
504 (let ((table (make-vector 256 0)) ;; default syntax is whitespace
508 (modify-syntax-entry (+ ?a i) "_" table)
509 (modify-syntax-entry (+ ?A i) "_" table))
512 (modify-syntax-entry (+ ?0 i) "_" table))
514 (let ((symbol-chars '(?@ ?/ ?\\ ?* ?+ ?~ ?$ ?< ?> ?%))
515 (symbol-chars-ignore '(?_ ?- ?: ?.))
517 (dolist (char symbol-chars)
518 (modify-syntax-entry char "_" table))
519 (dolist (char symbol-chars-ignore)
520 (modify-syntax-entry char "w" table)
525 (defconst cmpl-standard-syntax-table (cmpl-make-standard-completion-syntax-table))
527 (defun cmpl-make-lisp-completion-syntax-table ()
528 (let ((table (copy-syntax-table cmpl-standard-syntax-table))
529 (symbol-chars '(?! ?& ?? ?= ?^))
531 (dolist (char symbol-chars)
532 (modify-syntax-entry char "_" table))
535 (defun cmpl-make-c-completion-syntax-table ()
536 (let ((table (copy-syntax-table cmpl-standard-syntax-table))
537 (separator-chars '(?+ ?* ?/ ?: ?%))
539 (dolist (char separator-chars)
540 (modify-syntax-entry char " " table))
543 (defun cmpl-make-fortran-completion-syntax-table ()
544 (let ((table (copy-syntax-table cmpl-standard-syntax-table))
545 (separator-chars '(?+ ?- ?* ?/ ?:))
547 (dolist (char separator-chars)
548 (modify-syntax-entry char " " table))
551 (defconst cmpl-lisp-syntax-table (cmpl-make-lisp-completion-syntax-table))
552 (defconst cmpl-c-syntax-table (cmpl-make-c-completion-syntax-table))
553 (defconst cmpl-fortran-syntax-table (cmpl-make-fortran-completion-syntax-table))
555 (defvar cmpl-syntax-table cmpl-standard-syntax-table
556 "This variable holds the current completion syntax table.")
557 (make-variable-buffer-local 'cmpl-syntax-table)
559 ;;;-----------------------------------------------
560 ;;; Installing the appropriate mode tables
561 ;;;-----------------------------------------------
563 (add-hook 'lisp-mode-hook
565 (setq cmpl-syntax-table cmpl-lisp-syntax-table)))
567 (add-hook 'c-mode-hook
569 (setq cmpl-syntax-table cmpl-c-syntax-table)))
571 (add-hook 'fortran-mode-hook
573 (setq cmpl-syntax-table cmpl-fortran-syntax-table)
574 (completion-setup-fortran-mode)))
576 ;;;-----------------------------------------------
578 ;;;-----------------------------------------------
579 (defvar cmpl-symbol-start nil
580 "Holds first character of symbol, after any completion symbol function.")
581 (defvar cmpl-symbol-end nil
582 "Holds last character of symbol, after any completion symbol function.")
583 ;;; These are temp. vars. we use to avoid using let.
584 ;;; Why ? Small speed improvement.
585 (defvar cmpl-saved-syntax nil)
586 (defvar cmpl-saved-point nil)
588 (defun symbol-under-point ()
589 "Returns the symbol that the point is currently on.
590 But only if it is longer than `completion-min-length'."
591 (setq cmpl-saved-syntax (syntax-table))
592 (set-syntax-table cmpl-syntax-table)
594 ;; Cursor is on following-char and after preceding-char
595 ((memq (char-syntax (following-char)) '(?w ?_))
596 (setq cmpl-saved-point (point)
597 cmpl-symbol-start (scan-sexps (1+ cmpl-saved-point) -1)
598 cmpl-symbol-end (scan-sexps cmpl-saved-point 1))
599 ;; remove chars to ignore at the start
600 (cond ((= (char-syntax (char-after cmpl-symbol-start)) ?w)
601 (goto-char cmpl-symbol-start)
603 (setq cmpl-symbol-start (point))
604 (goto-char cmpl-saved-point)
606 ;; remove chars to ignore at the end
607 (cond ((= (char-syntax (char-after (1- cmpl-symbol-end))) ?w)
608 (goto-char cmpl-symbol-end)
610 (setq cmpl-symbol-end (point))
611 (goto-char cmpl-saved-point)
614 (set-syntax-table cmpl-saved-syntax)
615 ;; Return completion if the length is reasonable
616 (if (and (<= (cmpl-read-time-eval completion-min-length)
617 (- cmpl-symbol-end cmpl-symbol-start))
618 (<= (- cmpl-symbol-end cmpl-symbol-start)
619 (cmpl-read-time-eval completion-max-length)))
620 (buffer-substring cmpl-symbol-start cmpl-symbol-end))
623 ;; restore table if no symbol
624 (set-syntax-table cmpl-saved-syntax)
628 ;;; tests for symbol-under-point
629 ;;; `^' indicates cursor pos. where value is returned
631 ;;; ^^^^^^^^^^^^^^^^ --> simple-word-test
632 ;;; _harder_word_test_
633 ;;; ^^^^^^^^^^^^^^^^^^ --> harder_word_test
636 ;;; /foo/bar/quux.hello
637 ;;; ^^^^^^^^^^^^^^^^^^^ --> /foo/bar/quux.hello
640 (defun symbol-before-point ()
641 "Returns a string of the symbol immediately before point.
642 Returns nil if there isn't one longer than `completion-min-length'."
643 ;; This is called when a word separator is typed so it must be FAST !
644 (setq cmpl-saved-syntax (syntax-table))
645 (set-syntax-table cmpl-syntax-table)
646 ;; Cursor is on following-char and after preceding-char
647 (cond ((= (setq cmpl-preceding-syntax (char-syntax (preceding-char))) ?_)
648 ;; No chars. to ignore at end
649 (setq cmpl-symbol-end (point)
650 cmpl-symbol-start (scan-sexps (1+ cmpl-symbol-end) -1)
652 ;; remove chars to ignore at the start
653 (cond ((= (char-syntax (char-after cmpl-symbol-start)) ?w)
654 (goto-char cmpl-symbol-start)
656 (setq cmpl-symbol-start (point))
657 (goto-char cmpl-symbol-end)
660 (set-syntax-table cmpl-saved-syntax)
661 ;; return value if long enough
662 (if (>= cmpl-symbol-end
664 (cmpl-read-time-eval completion-min-length)))
665 (buffer-substring cmpl-symbol-start cmpl-symbol-end))
667 ((= cmpl-preceding-syntax ?w)
668 ;; chars to ignore at end
669 (setq cmpl-saved-point (point)
670 cmpl-symbol-start (scan-sexps (1+ cmpl-saved-point) -1))
671 ;; take off chars. from end
673 (setq cmpl-symbol-end (point))
674 ;; remove chars to ignore at the start
675 (cond ((= (char-syntax (char-after cmpl-symbol-start)) ?w)
676 (goto-char cmpl-symbol-start)
678 (setq cmpl-symbol-start (point))
681 (goto-char cmpl-saved-point)
682 (set-syntax-table cmpl-saved-syntax)
683 ;; Return completion if the length is reasonable
684 (if (and (<= (cmpl-read-time-eval completion-min-length)
685 (- cmpl-symbol-end cmpl-symbol-start))
686 (<= (- cmpl-symbol-end cmpl-symbol-start)
687 (cmpl-read-time-eval completion-max-length)))
688 (buffer-substring cmpl-symbol-start cmpl-symbol-end))
691 ;; restore table if no symbol
692 (set-syntax-table cmpl-saved-syntax)
696 ;;; tests for symbol-before-point
697 ;;; `^' indicates cursor pos. where value is returned
702 ;;; ^ --> simple-word-test
703 ;;; _harder_word_test_
704 ;;; ^ --> harder_word_test
705 ;;; ^ --> harder_word_test
710 (defun symbol-under-or-before-point ()
711 ;;; This could be made slightly faster but it is better to avoid
712 ;;; copying all the code.
713 ;;; However, it is only used by the completion string prompter.
714 ;;; If it comes into common use, it could be rewritten.
715 (setq cmpl-saved-syntax (syntax-table))
716 (set-syntax-table cmpl-syntax-table)
717 (cond ((memq (char-syntax (following-char)) '(?w ?_))
718 (set-syntax-table cmpl-saved-syntax)
719 (symbol-under-point))
721 (set-syntax-table cmpl-saved-syntax)
722 (symbol-before-point))
726 (defun symbol-before-point-for-complete ()
727 ;; "Returns a string of the symbol immediately before point
728 ;; or nil if there isn't one. Like symbol-before-point but doesn't trim the
730 ;; Cursor is on following-char and after preceding-char
731 (setq cmpl-saved-syntax (syntax-table))
732 (set-syntax-table cmpl-syntax-table)
733 (cond ((memq (setq cmpl-preceding-syntax (char-syntax (preceding-char)))
735 (setq cmpl-symbol-end (point)
736 cmpl-symbol-start (scan-sexps (1+ cmpl-symbol-end) -1)
738 ;; remove chars to ignore at the start
739 (cond ((= (char-syntax (char-after cmpl-symbol-start)) ?w)
740 (goto-char cmpl-symbol-start)
742 (setq cmpl-symbol-start (point))
743 (goto-char cmpl-symbol-end)
746 (set-syntax-table cmpl-saved-syntax)
747 ;; Return completion if the length is reasonable
748 (if (and (<= (cmpl-read-time-eval
749 completion-prefix-min-length)
750 (- cmpl-symbol-end cmpl-symbol-start))
751 (<= (- cmpl-symbol-end cmpl-symbol-start)
752 (cmpl-read-time-eval completion-max-length)))
753 (buffer-substring cmpl-symbol-start cmpl-symbol-end))
756 ;; restore table if no symbol
757 (set-syntax-table cmpl-saved-syntax)
761 ;;; tests for symbol-before-point-for-complete
762 ;;; `^' indicates cursor pos. where value is returned
767 ;;; ^ --> simple-word-test
768 ;;; _harder_word_test_
769 ;;; ^ --> harder_word_test
770 ;;; ^ --> harder_word_test_
777 ;;;---------------------------------------------------------------------------
778 ;;; Statistics Recording
779 ;;;---------------------------------------------------------------------------
781 ;;; Note that the guts of this has been turned off. The guts
782 ;;; are in completion-stats.el.
784 ;;;-----------------------------------------------
785 ;;; Conditionalizing code on *record-cmpl-statistics-p*
786 ;;;-----------------------------------------------
787 ;;; All statistics code outside this block should use this
788 (defmacro cmpl-statistics-block (&rest body))
789 ;;; "Only executes body if we are recording statistics."
791 ;;; (list* '*record-cmpl-statistics-p* body)
794 ;;;-----------------------------------------------
795 ;;; Completion Sources
796 ;;;-----------------------------------------------
799 (defconst cmpl-source-unknown 0)
800 (defconst cmpl-source-init-file 1)
801 (defconst cmpl-source-file-parsing 2)
802 (defconst cmpl-source-separator 3)
803 (defconst cmpl-source-cursor-moves 4)
804 (defconst cmpl-source-interactive 5)
805 (defconst cmpl-source-cdabbrev 6)
806 (defconst num-cmpl-sources 7)
807 (defvar current-completion-source cmpl-source-unknown)
811 ;;;---------------------------------------------------------------------------
812 ;;; Completion Method #2: dabbrev-expand style
813 ;;;---------------------------------------------------------------------------
815 ;;; This method is used if there are no useful stored completions. It is
816 ;;; based on dabbrev-expand with these differences :
817 ;;; 1) Faster (we don't use regexps)
818 ;;; 2) case coercion handled correctly
819 ;;; This is called cdabbrev to differentiate it.
820 ;;; We simply search backwards through the file looking for words which
821 ;;; start with the same letters we are trying to complete.
824 (defvar cdabbrev-completions-tried nil)
825 ;;; "A list of all the cdabbrev completions since the last reset.")
827 (defvar cdabbrev-current-point 0)
828 ;;; "The current point position the cdabbrev search is at.")
830 (defvar cdabbrev-current-window nil)
831 ;;; "The current window we are looking for cdabbrevs in. T if looking in
832 ;;; (other-buffer), NIL if no more cdabbrevs.")
834 (defvar cdabbrev-wrapped-p nil)
835 ;;; "T if the cdabbrev search has wrapped around the file.")
837 (defvar cdabbrev-abbrev-string "")
838 (defvar cdabbrev-start-point 0)
840 ;;; Test strings for cdabbrev
841 ;;; cdat-upcase ;;same namestring
843 ;;; cdat2 ;;too short
844 ;;; cdat-1-2-3-4 ;;ok
845 ;;; a-cdat-1 ;;doesn't start correctly
849 (defun reset-cdabbrev (abbrev-string &optional initial-completions-tried)
850 "Resets the cdabbrev search to search for abbrev-string.
851 INITIAL-COMPLETIONS-TRIED is a list of downcased strings to ignore
853 (setq cdabbrev-abbrev-string abbrev-string
854 cdabbrev-completions-tried
855 (cons (downcase abbrev-string) initial-completions-tried)
857 (reset-cdabbrev-window t)
860 (defun set-cdabbrev-buffer ()
861 ;; cdabbrev-current-window must not be NIL
862 (set-buffer (if (eq cdabbrev-current-window t)
864 (window-buffer cdabbrev-current-window)))
868 (defun reset-cdabbrev-window (&optional initializep)
869 "Resets the cdabbrev search to search for abbrev-string."
872 (setq cdabbrev-current-window (selected-window))
874 ((eq cdabbrev-current-window t)
875 ;; Everything has failed
876 (setq cdabbrev-current-window nil))
877 (cdabbrev-current-window
878 (setq cdabbrev-current-window (next-window cdabbrev-current-window))
879 (if (eq cdabbrev-current-window (selected-window))
880 ;; No more windows, try other buffer.
881 (setq cdabbrev-current-window t)))
883 (when cdabbrev-current-window
885 (set-cdabbrev-buffer)
886 (setq cdabbrev-current-point (point)
887 cdabbrev-start-point cdabbrev-current-point
889 (if completion-search-distance
891 (- cdabbrev-start-point completion-search-distance))
893 cdabbrev-wrapped-p nil)
896 (defun next-cdabbrev ()
897 "Return the next possible cdabbrev expansion or nil if there isn't one.
898 `reset-cdabbrev' must've been called already.
899 This is sensitive to `case-fold-search'."
900 ;; note that case-fold-search affects the behavior of this function
901 ;; Bug: won't pick up an expansion that starts at the top of buffer
902 (when cdabbrev-current-window
906 downcase-expansion tried-list syntax saved-point-2)
910 ;; Switch to current completion buffer
911 (set-cdabbrev-buffer)
912 ;; Save current buffer state
913 (setq saved-point (point)
914 saved-syntax (syntax-table))
915 ;; Restore completion state
916 (set-syntax-table cmpl-syntax-table)
917 (goto-char cdabbrev-current-point)
918 ;; Loop looking for completions
920 ;; This code returns t if it should loop again
922 (;; search for the string
923 (search-backward cdabbrev-abbrev-string cdabbrev-stop-point t)
924 ;; return nil if the completion is valid
927 ;; does it start with a separator char ?
928 (or (= (setq syntax (char-syntax (preceding-char))) ? )
930 ;; symbol char to ignore at end. Are we at end ?
932 (setq saved-point-2 (point))
935 (= (char-syntax (preceding-char)) ? )
936 (goto-char saved-point-2)
938 ;; is the symbol long enough ?
939 (setq expansion (symbol-under-point))
940 ;; have we not tried this one before
942 ;; See if we've already used it
943 (setq tried-list cdabbrev-completions-tried
944 downcase-expansion (downcase expansion))
945 (while (and tried-list
946 (not (string-equal downcase-expansion
948 ;; Already tried, don't choose this one
949 (setq tried-list (cdr tried-list))
951 ;; at this point tried-list will be nil if this
952 ;; expansion has not yet been tried
959 ;; If already wrapped, then we've failed completely
963 (goto-char (setq cdabbrev-current-point
964 (if completion-search-distance
965 (min (point-max) (+ cdabbrev-start-point completion-search-distance))
968 (setq cdabbrev-wrapped-p t))
973 (setq cdabbrev-completions-tried
974 (cons downcase-expansion cdabbrev-completions-tried)
975 cdabbrev-current-point (point))))
977 (set-syntax-table saved-syntax)
978 (goto-char saved-point)
980 ;; If no expansion, go to next window
982 (t (reset-cdabbrev-window)
986 ;;; The following must be eval'd in the minibuffer ::
987 ;;; (reset-cdabbrev "cdat")
988 ;;; (next-cdabbrev) --> "cdat-simple"
989 ;;; (next-cdabbrev) --> "cdat-1-2-3-4"
990 ;;; (next-cdabbrev) --> "CDAT-UPCASE"
991 ;;; (next-cdabbrev) --> "cdat-wrapping"
992 ;;; (next-cdabbrev) --> "cdat_start_sym"
993 ;;; (next-cdabbrev) --> nil
994 ;;; (next-cdabbrev) --> nil
995 ;;; (next-cdabbrev) --> nil
1001 ;;;---------------------------------------------------------------------------
1002 ;;; Completion Database
1003 ;;;---------------------------------------------------------------------------
1005 ;;; We use two storage modes for the two search types ::
1006 ;;; 1) Prefix {cmpl-prefix-obarray} for looking up possible completions
1007 ;;; Used by search-completion-next
1008 ;;; the value of the symbol is nil or a cons of head and tail pointers
1009 ;;; 2) Interning {cmpl-obarray} to see if it's in the database
1010 ;;; Used by find-exact-completion, completion-in-database-p
1011 ;;; The value of the symbol is the completion entry
1013 ;;; bad things may happen if this length is changed due to the way
1014 ;;; GNU implements obarrays
1015 (defconst cmpl-obarray-length 511)
1017 (defvar cmpl-prefix-obarray (make-vector cmpl-obarray-length 0)
1018 "An obarray used to store the downcased completion prefixes.
1019 Each symbol is bound to a list of completion entries.")
1021 (defvar cmpl-obarray (make-vector cmpl-obarray-length 0)
1022 "An obarray used to store the downcased completions.
1023 Each symbol is bound to a single completion entry.")
1025 ;;;-----------------------------------------------
1026 ;;; Completion Entry Structure Definition
1027 ;;;-----------------------------------------------
1029 ;;; A completion entry is a LIST of string, prefix-symbol num-uses, and
1030 ;;; last-use-time (the time the completion was last used)
1031 ;;; last-use-time is T if the string should be kept permanently
1032 ;;; num-uses is incremented everytime the completion is used.
1034 ;;; We chose lists because (car foo) is faster than (aref foo 0) and the
1035 ;;; creation time is about the same.
1039 (defmacro completion-string (completion-entry)
1040 (list 'car completion-entry))
1042 (defmacro completion-num-uses (completion-entry)
1043 ;; "The number of times it has used. Used to decide whether to save
1045 (list 'car (list 'cdr completion-entry)))
1047 (defmacro completion-last-use-time (completion-entry)
1048 ;; "The time it was last used. In hours since origin. Used to decide
1049 ;; whether to save it. T if one should always save it."
1050 (list 'nth 2 completion-entry))
1052 (defmacro completion-source (completion-entry)
1053 (list 'nth 3 completion-entry))
1056 (defmacro set-completion-string (completion-entry string)
1057 (list 'setcar completion-entry string))
1059 (defmacro set-completion-num-uses (completion-entry num-uses)
1060 (list 'setcar (list 'cdr completion-entry) num-uses))
1062 (defmacro set-completion-last-use-time (completion-entry last-use-time)
1063 (list 'setcar (list 'cdr (list 'cdr completion-entry)) last-use-time))
1066 (defun make-completion (string)
1067 "Returns a list of a completion entry."
1068 (list (list string 0 nil current-completion-source)))
1071 ;;(defmacro cmpl-prefix-entry-symbol (completion-entry)
1072 ;; (list 'car (list 'cdr completion-entry)))
1076 ;;;-----------------------------------------------
1077 ;;; Prefix symbol entry definition
1078 ;;;-----------------------------------------------
1079 ;;; A cons of (head . tail)
1083 (defmacro cmpl-prefix-entry-head (prefix-entry)
1084 (list 'car prefix-entry))
1086 (defmacro cmpl-prefix-entry-tail (prefix-entry)
1087 (list 'cdr prefix-entry))
1091 (defmacro set-cmpl-prefix-entry-head (prefix-entry new-head)
1092 (list 'setcar prefix-entry new-head))
1094 (defmacro set-cmpl-prefix-entry-tail (prefix-entry new-tail)
1095 (list 'setcdr prefix-entry new-tail))
1099 (defun make-cmpl-prefix-entry (completion-entry-list)
1100 "Makes a new prefix entry containing only completion-entry."
1101 (cons completion-entry-list completion-entry-list))
1103 ;;;-----------------------------------------------
1104 ;;; Completion Database - Utilities
1105 ;;;-----------------------------------------------
1107 (defun clear-all-completions ()
1108 "Initializes the completion storage. All existing completions are lost."
1110 (setq cmpl-prefix-obarray (make-vector cmpl-obarray-length 0))
1111 (setq cmpl-obarray (make-vector cmpl-obarray-length 0))
1112 (cmpl-statistics-block
1113 (record-clear-all-completions))
1116 (defun list-all-completions ()
1117 "Returns a list of all the known completion entries."
1118 (let ((return-completions nil))
1119 (mapatoms 'list-all-completions-1 cmpl-prefix-obarray)
1120 return-completions))
1122 (defun list-all-completions-1 (prefix-symbol)
1123 (if (boundp prefix-symbol)
1124 (setq return-completions
1125 (append (cmpl-prefix-entry-head (symbol-value prefix-symbol))
1126 return-completions))))
1128 (defun list-all-completions-by-hash-bucket ()
1129 "Return list of lists of known completion entries, organized by hash bucket."
1130 (let ((return-completions nil))
1131 (mapatoms 'list-all-completions-by-hash-bucket-1 cmpl-prefix-obarray)
1132 return-completions))
1134 (defun list-all-completions-by-hash-bucket-1 (prefix-symbol)
1135 (if (boundp prefix-symbol)
1136 (setq return-completions
1137 (cons (cmpl-prefix-entry-head (symbol-value prefix-symbol))
1138 return-completions))))
1141 ;;;-----------------------------------------------
1142 ;;; Updating the database
1143 ;;;-----------------------------------------------
1145 ;;; These are the internal functions used to update the datebase
1148 (defvar completion-to-accept nil)
1149 ;;"Set to a string that is pending its acceptance."
1150 ;; this checked by the top level reading functions
1152 (defvar cmpl-db-downcase-string nil)
1153 ;; "Setup by find-exact-completion, etc. The given string, downcased."
1154 (defvar cmpl-db-symbol nil)
1155 ;; "The interned symbol corresponding to cmpl-db-downcase-string.
1156 ;; Set up by cmpl-db-symbol."
1157 (defvar cmpl-db-prefix-symbol nil)
1158 ;; "The interned prefix symbol corresponding to cmpl-db-downcase-string."
1159 (defvar cmpl-db-entry nil)
1160 (defvar cmpl-db-debug-p nil
1161 "Set to T if you want to debug the database.")
1164 (defun find-exact-completion (string)
1165 "Returns the completion entry for string or nil.
1166 Sets up `cmpl-db-downcase-string' and `cmpl-db-symbol'."
1167 (and (boundp (setq cmpl-db-symbol
1168 (intern (setq cmpl-db-downcase-string (downcase string))
1170 (symbol-value cmpl-db-symbol)
1173 (defun find-cmpl-prefix-entry (prefix-string)
1174 "Returns the prefix entry for string.
1175 Sets `cmpl-db-prefix-symbol'.
1176 Prefix-string must be exactly `completion-prefix-min-length' long
1177 and downcased. Sets up `cmpl-db-prefix-symbol'."
1178 (and (boundp (setq cmpl-db-prefix-symbol
1179 (intern prefix-string cmpl-prefix-obarray)))
1180 (symbol-value cmpl-db-prefix-symbol)))
1182 (defvar inside-locate-completion-entry nil)
1183 ;; used to trap lossage in silent error correction
1185 (defun locate-completion-entry (completion-entry prefix-entry)
1186 "Locates the completion entry.
1187 Returns a pointer to the element before the completion entry or nil if
1188 the completion entry is at the head.
1189 Must be called after `find-exact-completion'."
1190 (let ((prefix-list (cmpl-prefix-entry-head prefix-entry))
1194 ((not (eq (car prefix-list) completion-entry))
1195 ;; not already at head
1196 (while (and prefix-list
1197 (not (eq completion-entry
1198 (car (setq next-prefix-list (cdr prefix-list)))
1200 (setq prefix-list next-prefix-list))
1203 ;; Didn't find it. Database is messed up.
1205 ;; not found, error if debug mode
1206 (error "Completion entry exists but not on prefix list - %s"
1208 (inside-locate-completion-entry
1209 ;; recursive error: really scrod
1210 (locate-completion-db-error))
1213 (set cmpl-db-symbol nil)
1215 (locate-completion-entry-retry completion-entry)
1218 (defun locate-completion-entry-retry (old-entry)
1219 (let ((inside-locate-completion-entry t))
1220 (add-completion (completion-string old-entry)
1221 (completion-num-uses old-entry)
1222 (completion-last-use-time old-entry))
1223 (let ((cmpl-entry (find-exact-completion (completion-string old-entry)))
1226 (find-cmpl-prefix-entry
1227 (substring cmpl-db-downcase-string
1228 0 completion-prefix-min-length))))
1230 (if (and cmpl-entry pref-entry)
1232 (locate-completion-entry cmpl-entry pref-entry)
1234 (locate-completion-db-error))
1237 (defun locate-completion-db-error ()
1238 ;; recursive error: really scrod
1239 (error "Completion database corrupted. Try M-x clear-all-completions. Send bug report.")
1243 (defun add-completion-to-tail-if-new (string)
1244 "If STRING is not in the database add it to appropriate prefix list.
1245 STRING is added to the end of the appropriate prefix list with
1246 num-uses = 0. The database is unchanged if it is there. STRING must be
1247 longer than `completion-prefix-min-length'.
1248 This must be very fast.
1249 Returns the completion entry."
1250 (or (find-exact-completion string)
1252 (let (;; create an entry
1253 (entry (make-completion string))
1255 (prefix-entry (find-cmpl-prefix-entry
1256 (substring cmpl-db-downcase-string 0
1257 (cmpl-read-time-eval
1258 completion-prefix-min-length))))
1260 ;; The next two forms should happen as a unit (atomically) but
1261 ;; no fatal errors should result if that is not the case.
1263 ;; These two should be atomic, but nothing fatal will happen
1265 (setcdr (cmpl-prefix-entry-tail prefix-entry) entry)
1266 (set-cmpl-prefix-entry-tail prefix-entry entry))
1268 (set cmpl-db-prefix-symbol (make-cmpl-prefix-entry entry))
1271 (cmpl-statistics-block
1272 (note-added-completion))
1274 (set cmpl-db-symbol (car entry))
1277 (defun add-completion-to-head (string)
1278 "If STRING is not in the database, add it to prefix list.
1279 STRING is added to the head of the appropriate prefix list. Otherwise
1280 it is moved to the head of the list.
1281 STRING must be longer than `completion-prefix-min-length'.
1282 Updates the saved string with the supplied string.
1283 This must be very fast.
1284 Returns the completion entry."
1285 ;; Handle pending acceptance
1286 (if completion-to-accept (accept-completion))
1287 ;; test if already in database
1288 (if (setq cmpl-db-entry (find-exact-completion string))
1290 (let* ((prefix-entry (find-cmpl-prefix-entry
1291 (substring cmpl-db-downcase-string 0
1292 (cmpl-read-time-eval
1293 completion-prefix-min-length))))
1294 (splice-ptr (locate-completion-entry cmpl-db-entry prefix-entry))
1295 (cmpl-ptr (cdr splice-ptr))
1298 (set-completion-string cmpl-db-entry string)
1299 ;; move to head (if necessary)
1301 ;; These should all execute atomically but it is not fatal if
1304 (or (setcdr splice-ptr (cdr cmpl-ptr))
1305 ;; fix up tail if necessary
1306 (set-cmpl-prefix-entry-tail prefix-entry splice-ptr))
1307 ;; splice in at head
1308 (setcdr cmpl-ptr (cmpl-prefix-entry-head prefix-entry))
1309 (set-cmpl-prefix-entry-head prefix-entry cmpl-ptr)
1313 (let (;; create an entry
1314 (entry (make-completion string))
1316 (prefix-entry (find-cmpl-prefix-entry
1317 (substring cmpl-db-downcase-string 0
1318 (cmpl-read-time-eval
1319 completion-prefix-min-length))))
1322 ;; Splice in at head
1323 (setcdr entry (cmpl-prefix-entry-head prefix-entry))
1324 (set-cmpl-prefix-entry-head prefix-entry entry))
1326 ;; Start new prefix entry
1327 (set cmpl-db-prefix-symbol (make-cmpl-prefix-entry entry))
1330 (cmpl-statistics-block
1331 (note-added-completion))
1332 ;; Add it to the symbol
1333 (set cmpl-db-symbol (car entry))
1336 (defun delete-completion (string)
1337 "Deletes the completion from the database.
1338 String must be longer than `completion-prefix-min-length'."
1339 ;; Handle pending acceptance
1340 (if completion-to-accept (accept-completion))
1341 (if (setq cmpl-db-entry (find-exact-completion string))
1343 (let* ((prefix-entry (find-cmpl-prefix-entry
1344 (substring cmpl-db-downcase-string 0
1345 (cmpl-read-time-eval
1346 completion-prefix-min-length))))
1347 (splice-ptr (locate-completion-entry cmpl-db-entry prefix-entry))
1349 ;; delete symbol reference
1350 (set cmpl-db-symbol nil)
1351 ;; remove from prefix list
1354 (or (setcdr splice-ptr (cdr (cdr splice-ptr)))
1355 ;; fix up tail if necessary
1356 (set-cmpl-prefix-entry-tail prefix-entry splice-ptr))
1360 (or (set-cmpl-prefix-entry-head
1361 prefix-entry (cdr (cmpl-prefix-entry-head prefix-entry)))
1362 ;; List is now empty
1363 (set cmpl-db-prefix-symbol nil))
1365 (cmpl-statistics-block
1366 (note-completion-deleted))
1368 (error "Unknown completion: %s. Couldn't delete it." string)
1372 ;;; - Add and Find -
1373 ;;; (add-completion-to-head "banana") --> ("banana" 0 nil 0)
1374 ;;; (find-exact-completion "banana") --> ("banana" 0 nil 0)
1375 ;;; (find-exact-completion "bana") --> nil
1376 ;;; (car (find-cmpl-prefix-entry "ban")) --> (("banana" ...))
1377 ;;; (cdr (find-cmpl-prefix-entry "ban")) --> (("banana" ...))
1378 ;;; (add-completion-to-head "banish") --> ("banish" 0 nil 0)
1379 ;;; (find-exact-completion "banish") --> ("banish" 0 nil 0)
1380 ;;; (car (find-cmpl-prefix-entry "ban")) --> (("banish" ...) ("banana" ...))
1381 ;;; (cdr (find-cmpl-prefix-entry "ban")) --> (("banana" ...))
1382 ;;; (add-completion-to-head "banana") --> ("banana" 0 nil 0)
1383 ;;; (car (find-cmpl-prefix-entry "ban")) --> (("banana" ...) ("banish" ...))
1384 ;;; (cdr (find-cmpl-prefix-entry "ban")) --> (("banish" ...))
1387 ;;; (add-completion-to-head "banner") --> ("banner" 0 nil 0)
1388 ;;; (delete-completion "banner")
1389 ;;; (find-exact-completion "banner") --> nil
1390 ;;; (car (find-cmpl-prefix-entry "ban")) --> (("banana" ...) ("banish" ...))
1391 ;;; (cdr (find-cmpl-prefix-entry "ban")) --> (("banish" ...))
1392 ;;; (add-completion-to-head "banner") --> ("banner" 0 nil 0)
1393 ;;; (delete-completion "banana")
1394 ;;; (car (find-cmpl-prefix-entry "ban")) --> (("banner" ...) ("banish" ...))
1395 ;;; (cdr (find-cmpl-prefix-entry "ban")) --> (("banish" ...))
1396 ;;; (delete-completion "banner")
1397 ;;; (delete-completion "banish")
1398 ;;; (find-cmpl-prefix-entry "ban") --> nil
1399 ;;; (delete-completion "banner") --> error
1402 ;;; (add-completion-to-tail-if-new "banana") --> ("banana" 0 nil 0)
1403 ;;; (car (find-cmpl-prefix-entry "ban")) --> (("banana" ...))
1404 ;;; (cdr (find-cmpl-prefix-entry "ban")) --> (("banana" ...))
1405 ;;; (add-completion-to-tail-if-new "banish") --> ("banish" 0 nil 0)
1406 ;;; (car (find-cmpl-prefix-entry "ban")) -->(("banana" ...) ("banish" ...))
1407 ;;; (cdr (find-cmpl-prefix-entry "ban")) -->(("banish" ...))
1411 ;;;---------------------------------------------------------------------------
1412 ;;; Database Update :: Interface level routines
1413 ;;;---------------------------------------------------------------------------
1415 ;;; These lie on top of the database ref. functions but below the standard
1416 ;;; user interface level
1419 (defun interactive-completion-string-reader (prompt)
1420 (let* ((default (symbol-under-or-before-point))
1423 (format "%s: (default: %s) " prompt default)
1424 (format "%s: " prompt))
1426 (read (completing-read new-prompt cmpl-obarray))
1428 (if (zerop (length read)) (setq read (or default "")))
1432 (defun check-completion-length (string)
1433 (if (< (length string) completion-min-length)
1434 (error "The string \"%s\" is too short to be saved as a completion."
1438 (defun add-completion (string &optional num-uses last-use-time)
1439 "Add STRING to completion list, or move it to head of list.
1440 The completion is altered appropriately if num-uses and/or last-use-time is
1442 (interactive (interactive-completion-string-reader "Completion to add"))
1443 (check-completion-length string)
1444 (let* ((current-completion-source (if (interactive-p)
1445 cmpl-source-interactive
1446 current-completion-source))
1447 (entry (add-completion-to-head string)))
1449 (if num-uses (set-completion-num-uses entry num-uses))
1451 (set-completion-last-use-time entry last-use-time))
1454 (defun add-permanent-completion (string)
1455 "Add STRING if it isn't already listed, and mark it permanent."
1457 (interactive-completion-string-reader "Completion to add permanently"))
1458 (let ((current-completion-source (if (interactive-p)
1459 cmpl-source-interactive
1460 current-completion-source))
1462 (add-completion string nil t)
1465 (defun kill-completion (string)
1466 (interactive (interactive-completion-string-reader "Completion to kill"))
1467 (check-completion-length string)
1468 (delete-completion string)
1471 (defun accept-completion ()
1472 "Accepts the pending completion in `completion-to-accept'.
1473 This bumps num-uses. Called by `add-completion-to-head' and
1474 `completion-search-reset'."
1475 (let ((string completion-to-accept)
1476 ;; if this is added afresh here, then it must be a cdabbrev
1477 (current-completion-source cmpl-source-cdabbrev)
1480 (setq completion-to-accept nil)
1481 (setq entry (add-completion-to-head string))
1482 (set-completion-num-uses entry (1+ (completion-num-uses entry)))
1483 (setq cmpl-completions-accepted-p t)
1486 (defun use-completion-under-point ()
1487 "Add the completion symbol underneath the point into the completion buffer."
1488 (let ((string (and enable-completion (symbol-under-point)))
1489 (current-completion-source cmpl-source-cursor-moves))
1490 (if string (add-completion-to-head string))))
1492 (defun use-completion-before-point ()
1493 "Add the completion symbol before point into the completion buffer."
1494 (let ((string (and enable-completion (symbol-before-point)))
1495 (current-completion-source cmpl-source-cursor-moves))
1496 (if string (add-completion-to-head string))))
1498 (defun use-completion-under-or-before-point ()
1499 "Add the completion symbol before point into the completion buffer."
1500 (let ((string (and enable-completion (symbol-under-or-before-point)))
1501 (current-completion-source cmpl-source-cursor-moves))
1502 (if string (add-completion-to-head string))))
1504 (defun use-completion-before-separator ()
1505 "Add the completion symbol before point into the completion buffer.
1506 Completions added this way will automatically be saved if
1507 `completion-on-separator-character' is non-nil."
1508 (let ((string (and enable-completion (symbol-before-point)))
1509 (current-completion-source cmpl-source-separator)
1511 (cmpl-statistics-block
1512 (note-separator-character string)
1515 (setq entry (add-completion-to-head string))
1516 (when (and completion-on-separator-character
1517 (zerop (completion-num-uses entry)))
1518 (set-completion-num-uses entry 1)
1519 (setq cmpl-completions-accepted-p t)
1524 ;;; - Add and Find -
1525 ;;; (add-completion "banana" 5 10)
1526 ;;; (find-exact-completion "banana") --> ("banana" 5 10 0)
1527 ;;; (add-completion "banana" 6)
1528 ;;; (find-exact-completion "banana") --> ("banana" 6 10 0)
1529 ;;; (add-completion "banish")
1530 ;;; (car (find-cmpl-prefix-entry "ban")) --> (("banish" ...) ("banana" ...))
1533 ;;; (setq completion-to-accept "banana")
1534 ;;; (accept-completion)
1535 ;;; (find-exact-completion "banana") --> ("banana" 7 10)
1536 ;;; (car (find-cmpl-prefix-entry "ban")) --> (("banana" ...) ("banish" ...))
1537 ;;; (setq completion-to-accept "banish")
1538 ;;; (add-completion "banner")
1539 ;;; (car (find-cmpl-prefix-entry "ban"))
1540 ;;; --> (("banner" ...) ("banish" 1 ...) ("banana" 7 ...))
1543 ;;; (kill-completion "banish")
1544 ;;; (car (find-cmpl-prefix-entry "ban")) --> (("banner" ...) ("banana" ...))
1547 ;;;---------------------------------------------------------------------------
1548 ;;; Searching the database
1549 ;;;---------------------------------------------------------------------------
1550 ;;; Functions outside this block must call completion-search-reset followed
1551 ;;; by calls to completion-search-next or completion-search-peek
1554 ;;; Status variables
1555 ;; Commented out to improve loading speed
1556 (defvar cmpl-test-string "")
1557 ;; "The current string used by completion-search-next."
1558 (defvar cmpl-test-regexp "")
1559 ;; "The current regexp used by completion-search-next.
1560 ;; (derived from cmpl-test-string)"
1561 (defvar cmpl-last-index 0)
1562 ;; "The last index that completion-search-next was called with."
1563 (defvar cmpl-cdabbrev-reset-p nil)
1564 ;; "Set to t when cdabbrevs have been reset."
1565 (defvar cmpl-next-possibilities nil)
1566 ;; "A pointer to the element BEFORE the next set of possible completions.
1567 ;; cadr of this is the cmpl-next-possibility"
1568 (defvar cmpl-starting-possibilities nil)
1569 ;; "The initial list of starting possibilities."
1570 (defvar cmpl-next-possibility nil)
1571 ;; "The cached next possibility."
1572 (defvar cmpl-tried-list nil)
1573 ;; "A downcased list of all the completions we have tried."
1576 (defun completion-search-reset (string)
1577 "Set up the for completion searching for STRING.
1578 STRING must be longer than `completion-prefix-min-length'."
1579 (if completion-to-accept (accept-completion))
1580 (setq cmpl-starting-possibilities
1581 (cmpl-prefix-entry-head
1582 (find-cmpl-prefix-entry (downcase (substring string 0 3))))
1583 cmpl-test-string string
1584 cmpl-test-regexp (concat (regexp-quote string) "."))
1585 (completion-search-reset-1)
1588 (defun completion-search-reset-1 ()
1589 (setq cmpl-next-possibilities cmpl-starting-possibilities
1590 cmpl-next-possibility nil
1591 cmpl-cdabbrev-reset-p nil
1596 (defun completion-search-next (index)
1597 "Return the next completion entry.
1598 If INDEX is out of sequence, reset and start from the top.
1599 If there are no more entries, try cdabbrev and returns only a string."
1601 ((= index (setq cmpl-last-index (1+ cmpl-last-index)))
1602 (completion-search-peek t))
1604 (completion-search-reset-1)
1605 (setq cmpl-last-index index)
1606 ;; reverse the possibilities list
1607 (setq cmpl-next-possibilities (reverse cmpl-starting-possibilities))
1608 ;; do a "normal" search
1609 (while (and (completion-search-peek nil)
1610 (minusp (setq index (1+ index))))
1611 (setq cmpl-next-possibility nil)
1613 (cond ((not cmpl-next-possibilities))
1614 ;; If no more possibilities, leave it that way
1615 ((= -1 cmpl-last-index)
1616 ;; next completion is at index 0. reset next-possibility list
1617 ;; to start at beginning
1618 (setq cmpl-next-possibilities cmpl-starting-possibilities))
1620 ;; otherwise point to one before current
1621 (setq cmpl-next-possibilities
1622 (nthcdr (- (length cmpl-starting-possibilities)
1623 (length cmpl-next-possibilities))
1624 cmpl-starting-possibilities))
1627 ;; non-negative index, reset and search
1629 (completion-search-reset-1)
1630 (setq cmpl-last-index index)
1631 (while (and (completion-search-peek t)
1632 (not (minusp (setq index (1- index)))))
1633 (setq cmpl-next-possibility nil)
1637 cmpl-next-possibility
1638 (setq cmpl-next-possibility nil)
1642 (defun completion-search-peek (use-cdabbrev)
1643 "Returns the next completion entry without actually moving the pointers.
1644 Calling this again or calling `completion-search-next' results in the same
1645 string being returned. Depends on `case-fold-search'.
1646 If there are no more entries, try cdabbrev and then return only a string."
1648 ;; return the cached value if we have it
1649 (cmpl-next-possibility)
1650 ((and cmpl-next-possibilities
1651 ;; still a few possibilities left
1654 (and (not (eq 0 (string-match cmpl-test-regexp
1655 (completion-string (car cmpl-next-possibilities)))))
1656 (setq cmpl-next-possibilities (cdr cmpl-next-possibilities))
1658 cmpl-next-possibilities
1661 (setq cmpl-next-possibility (car cmpl-next-possibilities)
1662 cmpl-tried-list (cons (downcase (completion-string cmpl-next-possibility))
1664 cmpl-next-possibilities (cdr cmpl-next-possibilities)
1666 cmpl-next-possibility)
1668 ;; unsuccessful, use cdabbrev
1669 (cond ((not cmpl-cdabbrev-reset-p)
1670 (reset-cdabbrev cmpl-test-string cmpl-tried-list)
1671 (setq cmpl-cdabbrev-reset-p t)
1673 (setq cmpl-next-possibility (next-cdabbrev))
1675 ;; Completely unsuccessful, return nil
1679 ;;; - Add and Find -
1680 ;;; (add-completion "banana")
1681 ;;; (completion-search-reset "ban")
1682 ;;; (completion-search-next 0) --> "banana"
1684 ;;; - Discrimination -
1685 ;;; (add-completion "cumberland")
1686 ;;; (add-completion "cumberbund")
1688 ;;; (completion-search-reset "cumb")
1689 ;;; (completion-search-peek t) --> "cumberbund"
1690 ;;; (completion-search-next 0) --> "cumberbund"
1691 ;;; (completion-search-peek t) --> "cumberland"
1692 ;;; (completion-search-next 1) --> "cumberland"
1693 ;;; (completion-search-peek nil) --> nil
1694 ;;; (completion-search-next 2) --> "cumbering" {cdabbrev}
1695 ;;; (completion-search-next 3) --> nil or "cumming"{depends on context}
1696 ;;; (completion-search-next 1) --> "cumberland"
1697 ;;; (completion-search-peek t) --> "cumbering" {cdabbrev}
1700 ;;; (completion-search-next 1) --> "cumberland"
1701 ;;; (setq completion-to-accept "cumberland")
1702 ;;; (completion-search-reset "foo")
1703 ;;; (completion-search-reset "cum")
1704 ;;; (completion-search-next 0) --> "cumberland"
1707 ;;; (kill-completion "cumberland")
1709 ;;; (completion-search-reset "cum")
1710 ;;; (completion-search-next 0) --> "cumberbund"
1711 ;;; (completion-search-next 1) --> "cummings"
1713 ;;; - Ignoring Capitalization -
1714 ;;; (completion-search-reset "CuMb")
1715 ;;; (completion-search-next 0) --> "cumberbund"
1719 ;;;-----------------------------------------------
1721 ;;;-----------------------------------------------
1723 (defun completion-mode ()
1724 "Toggles whether or not to add new words to the completion database."
1726 (setq enable-completion (not enable-completion))
1727 (message "Completion mode is now %s." (if enable-completion "ON" "OFF"))
1730 (defvar cmpl-current-index 0)
1731 (defvar cmpl-original-string nil)
1732 (defvar cmpl-last-insert-location -1)
1733 (defvar cmpl-leave-point-at-start nil)
1735 (defun complete (&optional arg)
1736 "Fill out a completion of the word before point.
1737 Point is left at end. Consecutive calls rotate through all possibilities.
1739 control-u :: leave the point at the beginning of the completion rather
1741 a number :: rotate through the possible completions by that amount
1742 `-' :: same as -1 (insert previous completion)
1743 {See the comments at the top of `completion.el' for more info.}"
1745 ;;; Set up variables
1746 (cond ((eq last-command this-command)
1748 (delete-region cmpl-last-insert-location (point))
1749 ;; get next completion
1750 (setq cmpl-current-index (+ cmpl-current-index (or arg 1)))
1753 (if (not cmpl-initialized-p)
1754 (initialize-completions)) ;; make sure everything's loaded
1755 (cond ((consp current-prefix-arg) ;; control-u
1757 (setq cmpl-leave-point-at-start t)
1760 (setq cmpl-leave-point-at-start nil)
1763 (setq cmpl-original-string (symbol-before-point-for-complete))
1764 (cond ((not cmpl-original-string)
1765 (setq this-command 'failed-complete)
1766 (error "To complete, the point must be after a symbol at least %d character long."
1767 completion-prefix-min-length)))
1769 (setq cmpl-current-index (if current-prefix-arg arg 0))
1771 (cmpl-statistics-block
1772 (note-complete-entered-afresh cmpl-original-string))
1774 (completion-search-reset cmpl-original-string)
1775 ;; erase what we've got
1776 (delete-region cmpl-symbol-start cmpl-symbol-end)
1779 ;; point is at the point to insert the new symbol
1780 ;; Get the next completion
1781 (let* ((print-status-p
1782 (and (>= baud-rate completion-prompt-speed-threshold)
1783 (not (minibuffer-window-selected-p))))
1784 (insert-point (point))
1785 (entry (completion-search-next cmpl-current-index))
1788 ;; entry is either a completion entry or a string (if cdabbrev)
1792 ;; Setup for proper case
1793 (setq string (if (stringp entry)
1794 entry (completion-string entry)))
1795 (setq string (cmpl-merge-string-cases
1796 string cmpl-original-string))
1800 (setq completion-to-accept string)
1801 ;; fixup and cache point
1802 (cond (cmpl-leave-point-at-start
1803 (setq cmpl-last-insert-location (point))
1804 (goto-char insert-point))
1806 (setq cmpl-last-insert-location insert-point))
1809 (cmpl-statistics-block
1810 (note-complete-inserted entry cmpl-current-index))
1811 ;; Done ! cmpl-stat-complete-successful
1812 ;;display the next completion
1814 ((and print-status-p
1815 ;; This updates the display and only prints if there
1819 (completion-search-peek
1820 completion-cdabbrev-prompt-flag)))
1821 (setq string (if (stringp entry)
1822 entry (completion-string entry)))
1823 (setq string (cmpl-merge-string-cases
1824 string cmpl-original-string))
1825 (message "Next completion: %s" string)
1828 (t;; none found, insert old
1829 (insert cmpl-original-string)
1830 ;; Don't accept completions
1831 (setq completion-to-accept nil)
1833 ;; This used to call cmpl19-sit-for, an undefined function.
1834 ;; I hope that sit-for does the right thing; I don't know -- rms.
1835 (if (and print-status-p (sit-for 0))
1836 (message "No %scompletions."
1837 (if (eq this-command last-command) "more " "")))
1839 (cmpl-statistics-block
1840 (record-complete-failed cmpl-current-index))
1841 ;; Pretend that we were never here
1842 (setq this-command 'failed-complete)
1845 ;;;-----------------------------------------------
1846 ;;; "Complete" Key Keybindings
1847 ;;;-----------------------------------------------
1849 (global-set-key "\M-\r" 'complete)
1850 (global-set-key [?\C-\r] 'complete)
1851 (define-key function-key-map [C-return] [?\C-\r])
1854 ;;; (add-completion "cumberland")
1855 ;;; (add-completion "cumberbund")
1862 ;;;---------------------------------------------------------------------------
1863 ;;; Parsing definitions from files into the database
1864 ;;;---------------------------------------------------------------------------
1866 ;;;-----------------------------------------------
1867 ;;; Top Level functions ::
1868 ;;;-----------------------------------------------
1871 (defun add-completions-from-file (file)
1872 "Parse possible completions from a file and add them to data base."
1873 (interactive "fFile: ")
1874 (setq file (expand-file-name file))
1875 (let* ((buffer (get-file-buffer file))
1876 (buffer-already-there-p buffer)
1878 (when (not buffer-already-there-p)
1879 (let ((completions-merging-modes nil))
1880 (setq buffer (find-file-noselect file))
1885 (add-completions-from-buffer)
1887 (when (not buffer-already-there-p)
1888 (kill-buffer buffer))
1891 (defun add-completions-from-buffer ()
1893 (let ((current-completion-source cmpl-source-file-parsing)
1895 (cmpl-statistics-block
1896 (aref completion-add-count-vector cmpl-source-file-parsing)))
1899 (cond ((memq major-mode '(emacs-lisp-mode lisp-mode))
1900 (add-completions-from-lisp-buffer)
1903 ((memq major-mode '(c-mode))
1904 (add-completions-from-c-buffer)
1908 (error "Do not know how to parse completions in %s buffers."
1911 (cmpl-statistics-block
1912 (record-cmpl-parse-file
1914 (- (aref completion-add-count-vector cmpl-source-file-parsing)
1919 (defun cmpl-find-file-hook ()
1920 (cond (enable-completion
1921 (cond ((and (memq major-mode '(emacs-lisp-mode lisp-mode))
1922 (memq 'lisp completions-merging-modes)
1924 (add-completions-from-buffer))
1925 ((and (memq major-mode '(c-mode))
1926 (memq 'c completions-merging-modes)
1928 (add-completions-from-buffer)
1932 (pushnew 'cmpl-find-file-hook find-file-hooks)
1934 ;;;-----------------------------------------------
1935 ;;; Tags Table Completions
1936 ;;;-----------------------------------------------
1938 (defun add-completions-from-tags-table ()
1939 ;; Inspired by eero@media-lab.media.mit.edu
1940 "Add completions from the current tags table."
1942 (visit-tags-table-buffer) ;this will prompt if no tags-table
1944 (goto-char (point-min))
1948 (search-forward "\177")
1950 (and (setq string (symbol-under-point))
1951 (add-completion-to-tail-if-new string))
1958 ;;;-----------------------------------------------
1959 ;;; Lisp File completion parsing
1960 ;;;-----------------------------------------------
1961 ;;; This merely looks for phrases beginning with (def.... or
1962 ;;; (package:def ... and takes the next word.
1964 ;;; We tried using forward-lines and explicit searches but the regexp technique
1965 ;;; was faster. (About 100K characters per second)
1967 (defconst *lisp-def-regexp*
1968 "\n(\\(\\w*:\\)?def\\(\\w\\|\\s_\\)*\\s +(*"
1969 "A regexp that searches for lisp definition form."
1973 ;;; (and (string-match *lisp-def-regexp* "\n(defun foo") (match-end 0)) -> 8
1974 ;;; (and (string-match *lisp-def-regexp* "\n(si:def foo") (match-end 0)) -> 9
1975 ;;; (and (string-match *lisp-def-regexp* "\n(def-bar foo")(match-end 0)) -> 10
1976 ;;; (and (string-match *lisp-def-regexp* "\n(defun (foo") (match-end 0)) -> 9
1978 ;;; Parses all the definition names from a Lisp mode buffer and adds them to
1979 ;;; the completion database.
1980 (defun add-completions-from-lisp-buffer ()
1982 ;;; Sun-3/280 - 1500 to 3000 lines of lisp code per second
1985 (goto-char (point-min))
1988 (re-search-forward *lisp-def-regexp*)
1989 (and (setq string (symbol-under-point))
1990 (add-completion-to-tail-if-new string))
1996 ;;;-----------------------------------------------
1997 ;;; C file completion parsing
1998 ;;;-----------------------------------------------
2000 ;;; Looks for #define or [<storage class>] [<type>] <name>{,<name>}
2001 ;;; or structure, array or pointer defs.
2002 ;;; It gets most of the definition names.
2004 ;;; As you might suspect by now, we use some symbol table hackery
2006 ;;; Symbol separator chars (have whitespace syntax) --> , ; * = (
2007 ;;; Opening char --> [ {
2008 ;;; Closing char --> ] }
2009 ;;; opening and closing must be skipped over
2010 ;;; Whitespace chars (have symbol syntax)
2011 ;;; Everything else has word syntax
2013 (defun cmpl-make-c-def-completion-syntax-table ()
2014 (let ((table (make-vector 256 0))
2015 (whitespace-chars '(? ?\n ?\t ?\f ?\v ?\r))
2016 ;; unfortunately the ?( causes the parens to appear unbalanced
2017 (separator-chars '(?, ?* ?= ?\( ?\;
2020 ;; default syntax is whitespace
2022 (modify-syntax-entry i "w" table))
2023 (dolist (char whitespace-chars)
2024 (modify-syntax-entry char "_" table))
2025 (dolist (char separator-chars)
2026 (modify-syntax-entry char " " table))
2027 (modify-syntax-entry ?\[ "(]" table)
2028 (modify-syntax-entry ?\{ "(}" table)
2029 (modify-syntax-entry ?\] ")[" table)
2030 (modify-syntax-entry ?\} "){" table)
2033 (defconst cmpl-c-def-syntax-table (cmpl-make-c-def-completion-syntax-table))
2036 (defconst *c-def-regexp*
2037 ;; This stops on lines with possible definitions
2039 ;; This stops after the symbol to add.
2040 ;;"\n\\(#define\\s +.\\|\\(\\(\\w\\|\\s_\\)+\\b\\s *\\)+[(;,[*{=]\\)"
2041 ;; This stops before the symbol to add. {Test cases in parens. below}
2042 ;;"\n\\(\\(\\w\\|\\s_\\)+\\s *(\\|\\(\\(#define\\|auto\\|extern\\|register\\|static\\|int\\|long\\|short\\|unsigned\\|char\\|void\\|float\\|double\\|enum\\|struct\\|union\\|typedef\\)\\s +\\)+\\)"
2043 ;; this simple version picks up too much extraneous stuff
2044 ;; "\n\\(\\w\\|\\s_\\|#\\)\\B"
2045 "A regexp that searches for a definition form."
2048 ;(defconst *c-cont-regexp*
2049 ; "\\(\\w\\|\\s_\\)+\\b\\s *\\({\\|\\(\\[[0-9\t ]*\\]\\s *\\)*,\\(*\\|\\s \\)*\\b\\)"
2050 ; "This regexp should be used in a looking-at to parse for lists of variables.")
2052 ;(defconst *c-struct-regexp*
2053 ; "\\(*\\|\\s \\)*\\b"
2054 ; "This regexp should be used to test whether a symbol follows a structure definition.")
2056 ;(defun test-c-def-regexp (regexp string)
2057 ; (and (eq 0 (string-match regexp string)) (match-end 0))
2061 ;;; (test-c-def-regexp *c-def-regexp* "\n#define foo") -> 10 (9)
2062 ;;; (test-c-def-regexp *c-def-regexp* "\nfoo (x, y) {") -> 6 (6)
2063 ;;; (test-c-def-regexp *c-def-regexp* "\nint foo (x, y)") -> 10 (5)
2064 ;;; (test-c-def-regexp *c-def-regexp* "\n int foo (x, y)") -> nil
2065 ;;; (test-c-def-regexp *c-cont-regexp* "oo, bar") -> 4
2066 ;;; (test-c-def-regexp *c-cont-regexp* "oo, *bar") -> 5
2067 ;;; (test-c-def-regexp *c-cont-regexp* "a [5][6], bar") -> 10
2068 ;;; (test-c-def-regexp *c-cont-regexp* "oo(x,y)") -> nil
2069 ;;; (test-c-def-regexp *c-cont-regexp* "a [6] ,\t bar") -> 9
2070 ;;; (test-c-def-regexp *c-cont-regexp* "oo {trout =1} my_carp;") -> 14
2071 ;;; (test-c-def-regexp *c-cont-regexp* "truct_p complex foon") -> nil
2073 ;;; Parses all the definition names from a C mode buffer and adds them to the
2074 ;;; completion database.
2075 (defun add-completions-from-c-buffer ()
2077 ;; Sun 3/280-- 1250 lines/sec.
2079 (let (string next-point char
2080 (saved-syntax (syntax-table))
2083 (goto-char (point-min))
2084 (catch 'finish-add-completions
2087 ;; we loop here only when scan-sexps fails
2088 ;; (i.e. unbalance exps.)
2089 (set-syntax-table cmpl-c-def-syntax-table)
2092 (re-search-forward *c-def-regexp*)
2094 ((= (preceding-char) ?#)
2095 ;; preprocessor macro, see if it's one we handle
2096 (setq string (buffer-substring (point) (+ (point) 6)))
2097 (cond ((or (string-equal string "define")
2098 (string-equal string "ifdef ")
2100 ;; skip forward over definition symbol
2101 ;; and add it to database
2102 (and (forward-word 2)
2103 (setq string (symbol-before-point))
2105 (add-completion-to-tail-if-new string)
2109 (setq next-point (point))
2112 ;; scan to next separator char.
2113 (setq next-point (scan-sexps next-point 1))
2115 ;; position the point on the word we want to add
2116 (goto-char next-point)
2117 (while (= (setq char (following-char)) ?*)
2118 ;; handle pointer ref
2119 ;; move to next separator char.
2121 (setq next-point (scan-sexps (point) 1)))
2125 (if (setq string (symbol-under-point))
2126 ;; (push string foo)
2127 (add-completion-to-tail-if-new string)
2128 ;; Local TMC hack (useful for parsing paris.h)
2129 (if (and (looking-at "_AP") ;; "ansi prototype"
2133 (symbol-under-point))
2135 (add-completion-to-tail-if-new string)
2139 (goto-char next-point)
2140 ;; (push (format "%c" (following-char)) foo)
2141 (if (= (char-syntax char) ?\()
2142 ;; if on an opening delimiter, go to end
2143 (while (= (char-syntax char) ?\()
2144 (setq next-point (scan-sexps next-point 1)
2145 char (char-after next-point))
2148 ;; Current char is an end char.
2149 (setq next-point nil)
2152 (search-failed ;;done
2153 (throw 'finish-add-completions t)
2156 ;; Check for failure in scan-sexps
2157 (if (or (string-equal (second e)
2158 "Containing expression ends prematurely")
2159 (string-equal (second e) "Unbalanced parentheses"))
2160 ;; unbalanced paren., keep going
2163 (message "Error parsing C buffer for completions. Please bug report.")
2164 (throw 'finish-add-completions t)
2167 (set-syntax-table saved-syntax)
2171 ;;;---------------------------------------------------------------------------
2173 ;;;---------------------------------------------------------------------------
2175 ;;; The version of save-completions-to-file called at kill-emacs time.
2176 (defun kill-emacs-save-completions ()
2177 (when (and save-completions-flag enable-completion cmpl-initialized-p)
2179 ((not cmpl-completions-accepted-p)
2180 (message "Completions database has not changed - not writing."))
2182 (save-completions-to-file)
2186 ;; There is no point bothering to change this again
2187 ;; unless the package changes so much that it matters
2188 ;; for people that have saved completions.
2189 (defconst completion-version "11")
2191 (defconst saved-cmpl-file-header
2192 ";;; Completion Initialization file.
2194 ;;; Format is (<string> . <last-use-time>)
2195 ;;; <string> is the completion
2196 ;;; <last-use-time> is the time the completion was last used
2197 ;;; If it is t, the completion will never be pruned from the file.
2198 ;;; Otherwise it is in hours since origin.
2201 (defun completion-backup-filename (filename)
2202 (concat filename ".BAK"))
2204 (defun save-completions-to-file (&optional filename)
2205 "Save completions in init file FILENAME.
2206 If file name is not specified, use `save-completions-file-name'."
2208 (setq filename (expand-file-name (or filename save-completions-file-name)))
2209 (when (file-writable-p filename)
2210 (if (not cmpl-initialized-p)
2211 (initialize-completions));; make sure everything's loaded
2212 (message "Saving completions to file %s" filename)
2214 (let* ((trim-versions-without-asking t)
2215 (kept-old-versions 0)
2216 (kept-new-versions completions-file-versions-kept)
2218 (current-time (cmpl-hours-since-origin))
2222 (backup-filename (completion-backup-filename filename))
2226 (get-buffer-create " *completion-save-buffer*")
2227 (set-buffer " *completion-save-buffer*")
2228 (setq buffer-file-name filename)
2230 (when (not (verify-visited-file-modtime (current-buffer)))
2231 ;; file has changed on disk. Bring us up-to-date
2232 (message "Completion file has changed. Merging. . .")
2233 (load-completions-from-file filename t)
2234 (message "Merging finished. Saving completions to file %s" filename)
2237 ;; prepare the buffer to be modified
2238 (clear-visited-file-modtime)
2241 (insert (format saved-cmpl-file-header completion-version))
2242 (dolist (completion (list-all-completions))
2243 (setq total-in-db (1+ total-in-db))
2244 (setq last-use-time (completion-last-use-time completion))
2245 ;; Update num uses and maybe write completion to a file
2246 (cond ((or;; Write to file if
2248 (and (eq last-use-time t)
2249 (setq total-perm (1+ total-perm)))
2251 (if (plusp (completion-num-uses completion))
2253 (setq last-use-time current-time)
2254 ;; or it was saved before and
2256 ;; save-completions-retention-time is nil
2257 (or (not save-completions-retention-time)
2258 ;; or time since last use is < ...retention-time*
2259 (< (- current-time last-use-time)
2260 save-completions-retention-time))
2263 (setq total-saved (1+ total-saved))
2264 (insert (prin1-to-string (cons (completion-string completion)
2265 last-use-time)) "\n")
2270 (let ((file-exists-p (file-exists-p filename)))
2272 ;; If file exists . . .
2273 ;; Save a backup(so GNU doesn't screw us when we're out of disk)
2274 ;; (GNU leaves a 0 length file if it gets a disk full error!)
2276 ;; If backup doesn't exit, Rename current to backup
2277 ;; {If backup exists the primary file is probably messed up}
2278 (unless (file-exists-p backup-filename)
2279 (rename-file filename backup-filename))
2280 ;; Copy the backup back to the current name
2281 ;; (so versioning works)
2282 (copy-file backup-filename filename t)
2287 ;; If successful, remove backup
2288 (delete-file backup-filename)
2291 (set-buffer-modified-p nil)
2292 (message "Couldn't save completion file %s." filename)
2294 ;; Reset accepted-p flag
2295 (setq cmpl-completions-accepted-p nil)
2297 (cmpl-statistics-block
2298 (record-save-completions total-in-db total-perm total-saved))
2301 ;;;(defun autosave-completions ()
2302 ;;; (when (and save-completions-flag enable-completion cmpl-initialized-p
2303 ;;; *completion-auto-save-period*
2304 ;;; (> cmpl-emacs-idle-time *completion-auto-save-period*)
2305 ;;; cmpl-completions-accepted-p)
2306 ;;; (save-completions-to-file)
2309 ;;;(pushnew 'autosave-completions cmpl-emacs-idle-time-hooks)
2311 (defun load-completions-from-file (&optional filename no-message-p)
2312 "Loads a completion init file FILENAME.
2313 If file is not specified, then use `save-completions-file-name'."
2315 (setq filename (expand-file-name (or filename save-completions-file-name)))
2316 (let* ((backup-filename (completion-backup-filename filename))
2317 (backup-readable-p (file-readable-p backup-filename))
2319 (when backup-readable-p (setq filename backup-filename))
2320 (when (file-readable-p filename)
2321 (if (not no-message-p)
2322 (message "Loading completions from %sfile %s . . ."
2323 (if backup-readable-p "backup " "") filename))
2325 (get-buffer-create " *completion-save-buffer*")
2326 (set-buffer " *completion-save-buffer*")
2327 (setq buffer-file-name filename)
2328 ;; prepare the buffer to be modified
2329 (clear-visited-file-modtime)
2332 (let ((insert-okay-p nil)
2333 (buffer (current-buffer))
2334 (current-time (cmpl-hours-since-origin))
2335 string num-uses entry last-use-time
2336 cmpl-entry cmpl-last-use-time
2337 (current-completion-source cmpl-source-init-file)
2339 (cmpl-statistics-block
2340 (aref completion-add-count-vector cmpl-source-file-parsing)))
2341 (total-in-file 0) (total-perm 0)
2343 ;; insert the file into a buffer
2345 (progn (insert-file-contents filename t)
2346 (setq insert-okay-p t))
2349 (message "File error trying to load completion file %s."
2353 (goto-char (point-min))
2357 (setq entry (read buffer))
2358 (setq total-in-file (1+ total-in-file))
2361 (stringp (setq string (car entry)))
2363 ((eq (setq last-use-time (cdr entry)) 'T)
2364 ;; handle case sensitivity
2365 (setq total-perm (1+ total-perm))
2366 (setq last-use-time t))
2367 ((eq last-use-time t)
2368 (setq total-perm (1+ total-perm)))
2369 ((integerp last-use-time))
2373 (setq cmpl-last-use-time
2374 (completion-last-use-time
2376 (add-completion-to-tail-if-new string))
2378 (if (or (eq last-use-time t)
2379 (and (> last-use-time 1000);;backcompatibility
2380 (not (eq cmpl-last-use-time t))
2381 (or (not cmpl-last-use-time)
2383 (> last-use-time cmpl-last-use-time))
2385 ;; update last-use-time
2386 (set-completion-last-use-time cmpl-entry last-use-time)
2390 (message "Error: invalid saved completion - %s"
2391 (prin1-to-string entry))
2392 ;; try to get back in sync
2393 (search-forward "\n(")
2396 (message "End of file while reading completions.")
2399 (if (= (point) (point-max))
2400 (if (not no-message-p)
2401 (message "Loading completions from file %s . . . Done."
2403 (message "End of file while reading completions.")
2407 (cmpl-statistics-block
2408 (record-load-completions
2409 total-in-file total-perm
2410 (- (aref completion-add-count-vector cmpl-source-init-file)
2415 (defun initialize-completions ()
2416 "Load the default completions file.
2417 Also sets up so that exiting emacs will automatically save the file."
2419 (cond ((not cmpl-initialized-p)
2420 (load-completions-from-file)
2422 (setq cmpl-initialized-p t)
2426 ;;;-----------------------------------------------
2427 ;;; Kill EMACS patch
2428 ;;;-----------------------------------------------
2430 (add-hook 'kill-emacs-hook
2432 (kill-emacs-save-completions)
2433 (cmpl-statistics-block
2434 (record-cmpl-kill-emacs))))
2436 ;;;-----------------------------------------------
2437 ;;; Kill region patch
2438 ;;;-----------------------------------------------
2440 (defun completion-kill-region (&optional beg end)
2441 "Kill between point and mark.
2442 The text is deleted but saved in the kill ring.
2443 The command \\[yank] can retrieve it from there.
2444 /(If you want to kill and then yank immediately, use \\[copy-region-as-kill].)
2446 This is the primitive for programs to kill text (as opposed to deleting it).
2447 Supply two arguments, character numbers indicating the stretch of text
2449 Any command that calls this function is a \"kill command\".
2450 If the previous command was also a kill command,
2451 the text killed this time appends to the text killed last time
2452 to make one entry in the kill ring.
2453 Patched to remove the most recent completion."
2455 (cond ((eq last-command 'complete)
2456 (delete-region (point) cmpl-last-insert-location)
2457 (insert cmpl-original-string)
2458 (setq completion-to-accept nil)
2459 (cmpl-statistics-block
2460 (record-complete-failed)))
2462 (kill-region beg end))))
2464 (global-set-key "\C-w" 'completion-kill-region)
2466 ;;;-----------------------------------------------
2467 ;;; Patches to self-insert-command.
2468 ;;;-----------------------------------------------
2470 ;;; Need 2 versions: generic separator chars. and space (to get auto fill
2473 ;;; All common separators (eg. space "(" ")" """) characters go through a
2474 ;;; function to add new words to the list of words to complete from:
2475 ;;; COMPLETION-SEPARATOR-SELF-INSERT-COMMAND (arg).
2476 ;;; If the character before this was an alpha-numeric then this adds the
2477 ;;; symbol before point to the completion list (using ADD-COMPLETION).
2479 (defun completion-separator-self-insert-command (arg)
2481 (use-completion-before-separator)
2482 (self-insert-command arg)
2485 (defun completion-separator-self-insert-autofilling (arg)
2487 (use-completion-before-separator)
2488 (self-insert-command arg)
2489 (and (> (current-column) fill-column)
2491 (funcall auto-fill-function))
2494 ;;;-----------------------------------------------
2496 ;;;-----------------------------------------------
2498 ;;; Note that because of the way byte compiling works, none of
2499 ;;; the functions defined with this macro get byte compiled.
2501 (defmacro def-completion-wrapper (function-name type &optional new-name)
2502 "Add a call to update the completion database before function execution.
2503 TYPE is the type of the wrapper to be added. Can be :before or :under."
2504 (cond ((eq type ':separator)
2505 (list 'put (list 'quote function-name) ''completion-function
2506 ''use-completion-before-separator))
2508 (list 'put (list 'quote function-name) ''completion-function
2509 ''use-completion-before-point))
2510 ((eq type ':backward-under)
2511 (list 'put (list 'quote function-name) ''completion-function
2512 ''use-completion-backward-under))
2513 ((eq type ':backward)
2514 (list 'put (list 'quote function-name) ''completion-function
2515 ''use-completion-backward))
2517 (list 'put (list 'quote function-name) ''completion-function
2518 ''use-completion-under-point))
2519 ((eq type ':under-or-before)
2520 (list 'put (list 'quote function-name) ''completion-function
2521 ''use-completion-under-or-before-point))
2522 ((eq type ':minibuffer-separator)
2523 (list 'put (list 'quote function-name) ''completion-function
2524 ''use-completion-minibuffer-separator))))
2526 (defun use-completion-minibuffer-separator ()
2527 (let ((cmpl-syntax-table cmpl-standard-syntax-table))
2528 (use-completion-before-separator)))
2530 (defun use-completion-backward-under ()
2531 (use-completion-under-point)
2532 (if (eq last-command 'complete)
2533 ;; probably a failed completion if you have to back up
2534 (cmpl-statistics-block (record-complete-failed))))
2536 (defun use-completion-backward ()
2537 (if (eq last-command 'complete)
2538 ;; probably a failed completion if you have to back up
2539 (cmpl-statistics-block (record-complete-failed))))
2541 (defun completion-before-command ()
2542 (funcall (or (get this-command 'completion-function)
2543 'use-completion-under-or-before-point)))
2544 (add-hook 'before-command-hook 'completion-before-command)
2547 ;;;---------------------------------------------------------------------------
2548 ;;; Patches to standard keymaps insert completions
2549 ;;;---------------------------------------------------------------------------
2551 ;;;-----------------------------------------------
2553 ;;;-----------------------------------------------
2554 ;;; We've used the completion syntax table given as a guide.
2556 ;;; Global separator chars.
2557 ;;; We left out <tab> because there are too many special cases for it. Also,
2558 ;;; in normal coding it's rarely typed after a word.
2559 (global-set-key " " 'completion-separator-self-insert-autofilling)
2560 (global-set-key "!" 'completion-separator-self-insert-command)
2561 (global-set-key "%" 'completion-separator-self-insert-command)
2562 (global-set-key "^" 'completion-separator-self-insert-command)
2563 (global-set-key "&" 'completion-separator-self-insert-command)
2564 (global-set-key "(" 'completion-separator-self-insert-command)
2565 (global-set-key ")" 'completion-separator-self-insert-command)
2566 (global-set-key "=" 'completion-separator-self-insert-command)
2567 (global-set-key "`" 'completion-separator-self-insert-command)
2568 (global-set-key "|" 'completion-separator-self-insert-command)
2569 (global-set-key "{" 'completion-separator-self-insert-command)
2570 (global-set-key "}" 'completion-separator-self-insert-command)
2571 (global-set-key "[" 'completion-separator-self-insert-command)
2572 (global-set-key "]" 'completion-separator-self-insert-command)
2573 (global-set-key ";" 'completion-separator-self-insert-command)
2574 (global-set-key "\"" 'completion-separator-self-insert-command)
2575 (global-set-key "'" 'completion-separator-self-insert-command)
2576 (global-set-key "#" 'completion-separator-self-insert-command)
2577 (global-set-key "," 'completion-separator-self-insert-command)
2578 (global-set-key "?" 'completion-separator-self-insert-command)
2580 ;;; We include period and colon even though they are symbol chars because :
2581 ;;; - in text we want to pick up the last word in a sentence.
2582 ;;; - in C pointer refs. we want to pick up the first symbol
2583 ;;; - it won't make a difference for lisp mode (package names are short)
2584 (global-set-key "." 'completion-separator-self-insert-command)
2585 (global-set-key ":" 'completion-separator-self-insert-command)
2588 (define-key lisp-mode-map "!" 'self-insert-command)
2589 (define-key lisp-mode-map "&" 'self-insert-command)
2590 (define-key lisp-mode-map "%" 'self-insert-command)
2591 (define-key lisp-mode-map "?" 'self-insert-command)
2592 (define-key lisp-mode-map "=" 'self-insert-command)
2593 (define-key lisp-mode-map "^" 'self-insert-command)
2596 (def-completion-wrapper electric-c-semi :separator)
2597 (define-key c-mode-map "+" 'completion-separator-self-insert-command)
2598 (define-key c-mode-map "*" 'completion-separator-self-insert-command)
2599 (define-key c-mode-map "/" 'completion-separator-self-insert-command)
2601 ;;; FORTRAN mode diffs. (these are defined when fortran is called)
2602 (defun completion-setup-fortran-mode ()
2603 (define-key fortran-mode-map "+" 'completion-separator-self-insert-command)
2604 (define-key fortran-mode-map "-" 'completion-separator-self-insert-command)
2605 (define-key fortran-mode-map "*" 'completion-separator-self-insert-command)
2606 (define-key fortran-mode-map "/" 'completion-separator-self-insert-command)
2609 ;;;-----------------------------------------------
2610 ;;; End of line chars.
2611 ;;;-----------------------------------------------
2612 (def-completion-wrapper newline :separator)
2613 (def-completion-wrapper newline-and-indent :separator)
2614 (def-completion-wrapper comint-send-input :separator)
2615 (def-completion-wrapper exit-minibuffer :minibuffer-separator)
2616 (def-completion-wrapper eval-print-last-sexp :separator)
2617 (def-completion-wrapper eval-last-sexp :separator)
2618 ;;(def-completion-wrapper minibuffer-complete-and-exit :minibuffer)
2620 ;;;-----------------------------------------------
2622 ;;;-----------------------------------------------
2624 (def-completion-wrapper next-line :under-or-before)
2625 (def-completion-wrapper previous-line :under-or-before)
2626 (def-completion-wrapper beginning-of-buffer :under-or-before)
2627 (def-completion-wrapper end-of-buffer :under-or-before)
2628 (def-completion-wrapper beginning-of-line :under-or-before)
2629 (def-completion-wrapper end-of-line :under-or-before)
2630 (def-completion-wrapper forward-char :under-or-before)
2631 (def-completion-wrapper forward-word :under-or-before)
2632 (def-completion-wrapper forward-sexp :under-or-before)
2633 (def-completion-wrapper backward-char :backward-under)
2634 (def-completion-wrapper backward-word :backward-under)
2635 (def-completion-wrapper backward-sexp :backward-under)
2637 (def-completion-wrapper delete-backward-char :backward)
2638 (def-completion-wrapper delete-backward-char-untabify :backward)
2646 (cmpl-statistics-block
2647 (record-completion-file-loaded))
2649 ;;; completion.el ends here