Commit | Line | Data |
---|---|---|
c0274f38 | 1 | ;;; completion.el --- dynamic word-completion code |
b578f267 | 2 | |
0d30b337 | 3 | ;; Copyright (C) 1990, 1993, 1995, 1997, 2002, 2003, 2004, |
aaef169d | 4 | ;; 2005, 2006 Free Software Foundation, Inc. |
c0274f38 | 5 | |
af4d5234 | 6 | ;; Maintainer: FSF |
f5f727f8 | 7 | ;; Keywords: abbrev convenience |
32168d16 | 8 | ;; Author: Jim Salem <alem@bbnplanet.com> of Thinking Machines Inc. |
9d0eba57 | 9 | ;; (ideas suggested by Brewster Kahle) |
d1c7011d | 10 | |
1add72b5 | 11 | ;; This file is part of GNU Emacs. |
d1c7011d | 12 | |
1add72b5 RS |
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 2, or (at your option) | |
16 | ;; any later version. | |
17 | ||
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. | |
22 | ||
23 | ;; You should have received a copy of the GNU General Public License | |
b578f267 | 24 | ;; along with GNU Emacs; see the file COPYING. If not, write to the |
086add15 LK |
25 | ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, |
26 | ;; Boston, MA 02110-1301, USA. | |
1add72b5 RS |
27 | |
28 | ;;; Commentary: | |
b578f267 EN |
29 | |
30 | ;; What to put in .emacs | |
31 | ;;----------------------- | |
bb310d1e | 32 | ;; (dynamic-completion-mode) |
59ca07b5 | 33 | \f |
b578f267 EN |
34 | ;;--------------------------------------------------------------------------- |
35 | ;; Documentation [Slightly out of date] | |
36 | ;;--------------------------------------------------------------------------- | |
37 | ;; (also check the documentation string of the functions) | |
38 | ;; | |
39 | ;; Introduction | |
40 | ;;--------------- | |
71296446 | 41 | ;; |
b578f267 | 42 | ;; After you type a few characters, pressing the "complete" key inserts |
71296446 | 43 | ;; the rest of the word you are likely to type. |
b578f267 | 44 | ;; |
71296446 | 45 | ;; This watches all the words that you type and remembers them. When |
b578f267 | 46 | ;; typing a new word, pressing "complete" (meta-return) "completes" the |
71296446 | 47 | ;; word by inserting the most recently used word that begins with the |
b578f267 EN |
48 | ;; same characters. If you press meta-return repeatedly, it cycles |
49 | ;; through all the words it knows about. | |
50 | ;; | |
51 | ;; If you like the completion then just continue typing, it is as if you | |
71296446 | 52 | ;; entered the text by hand. If you want the inserted extra characters |
b578f267 EN |
53 | ;; to go away, type control-w or delete. More options are described below. |
54 | ;; | |
55 | ;; The guesses are made in the order of the most recently "used". Typing | |
71296446 JB |
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, | |
b578f267 EN |
58 | ;; it uses an extended version of the dabbrev style completion. |
59 | ;; | |
71296446 JB |
60 | ;; You automatically save the completions you use to a file between |
61 | ;; sessions. | |
b578f267 | 62 | ;; |
71296446 | 63 | ;; Completion enables programmers to enter longer, more descriptive |
b578f267 EN |
64 | ;; variable names while typing fewer keystrokes than they normally would. |
65 | ;; | |
66 | ;; | |
67 | ;; Full documentation | |
68 | ;;--------------------- | |
69 | ;; | |
71296446 | 70 | ;; A "word" is any string containing characters with either word or symbol |
b578f267 EN |
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 | |
74 | ;; saved. | |
75 | ;; | |
76 | ;; When you load this file, completion will be on. I suggest you use the | |
77 | ;; compiled version (because it is noticeably faster). | |
78 | ;; | |
7975cb9f | 79 | ;; M-x completion-mode toggles whether or not new words are added to the |
b578f267 EN |
80 | ;; database by changing the value of enable-completion. |
81 | ;; | |
82 | ;; SAVING/LOADING COMPLETIONS | |
83 | ;; Completions are automatically saved from one session to another | |
84 | ;; (unless save-completions-flag or enable-completion is nil). | |
699ee5f5 LT |
85 | ;; Activating this minor-mode (calling completion-initialize) loads |
86 | ;; a completions database for a saved completions file | |
36cc948e | 87 | ;; (default: ~/.completions). When you exit, Emacs saves a copy of the |
699ee5f5 LT |
88 | ;; completions that you often use. When you next start, Emacs loads in |
89 | ;; the saved completion file. | |
b578f267 | 90 | ;; |
71296446 JB |
91 | ;; The number of completions saved depends loosely on |
92 | ;; *saved-completions-decay-factor*. Completions that have never been | |
b578f267 EN |
93 | ;; inserted via "complete" are not saved. You are encouraged to experiment |
94 | ;; with different functions (see compute-completion-min-num-uses). | |
95 | ;; | |
71296446 JB |
96 | ;; Some completions are permanent and are always saved out. These |
97 | ;; completions have their num-uses slot set to T. Use | |
b578f267 EN |
98 | ;; add-permanent-completion to do this |
99 | ;; | |
100 | ;; Completions are saved only if enable-completion is T. The number of old | |
71296446 | 101 | ;; versions kept of the saved completions file is controlled by |
b578f267 EN |
102 | ;; completions-file-versions-kept. |
103 | ;; | |
104 | ;; COMPLETE KEY OPTIONS | |
71296446 JB |
105 | ;; The complete function takes a numeric arguments. |
106 | ;; control-u :: leave the point at the beginning of the completion rather | |
b578f267 EN |
107 | ;; than the middle. |
108 | ;; a number :: rotate through the possible completions by that amount | |
109 | ;; `-' :: same as -1 (insert previous completion) | |
110 | ;; | |
111 | ;; HOW THE DATABASE IS MAINTAINED | |
112 | ;; <write> | |
113 | ;; | |
114 | ;; UPDATING THE DATABASE MANUALLY | |
71296446 | 115 | ;; m-x kill-completion |
b578f267 EN |
116 | ;; kills the completion at point. |
117 | ;; m-x add-completion | |
118 | ;; m-x add-permanent-completion | |
71296446 | 119 | ;; |
b578f267 EN |
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. | |
124 | ;; | |
71296446 | 125 | ;; m-x add-completions-from-lisp-file |
b578f267 EN |
126 | ;; Parses all the definition names from a C or Lisp mode file and |
127 | ;; adds them to the completion database. | |
128 | ;; | |
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. | |
132 | ;; | |
133 | ;; HOW A COMPLETION IS FOUND | |
134 | ;; <write> | |
135 | ;; | |
136 | ;; STRING CASING | |
71296446 | 137 | ;; Completion is string case independent if case-fold-search has its |
b578f267 | 138 | ;; normal default of T. Also when the completion is inserted the case of the |
71296446 JB |
139 | ;; entry is coerced appropriately. |
140 | ;; [E.G. APP --> APPROPRIATELY app --> appropriately | |
b578f267 EN |
141 | ;; App --> Appropriately] |
142 | ;; | |
143 | ;; INITIALIZATION | |
36cc948e SM |
144 | ;; The form `(completion-initialize)' initializes the completion system by |
145 | ;; trying to load in the user's completions. After the first call, further | |
71296446 | 146 | ;; calls have no effect so one should be careful not to put the form in a |
b578f267 EN |
147 | ;; site's standard site-init file. |
148 | ;; | |
149 | ;;--------------------------------------------------------------------------- | |
150 | ;; | |
151 | ;; | |
59ca07b5 | 152 | \f |
b578f267 EN |
153 | ;;--------------------------------------------------------------------------- |
154 | ;; Functions you might like to call | |
155 | ;;--------------------------------------------------------------------------- | |
156 | ;; | |
157 | ;; add-completion string &optional num-uses | |
158 | ;; Adds a new string to the database | |
159 | ;; | |
160 | ;; add-permanent-completion string | |
161 | ;; Adds a new string to the database with num-uses = T | |
162 | ;; | |
163 | ||
164 | ;; kill-completion string | |
165 | ;; Kills the completion from the database. | |
166 | ;; | |
167 | ;; clear-all-completions | |
168 | ;; Clears the database | |
169 | ;; | |
170 | ;; list-all-completions | |
171 | ;; Returns a list of all completions. | |
172 | ;; | |
173 | ;; | |
174 | ;; next-completion string &optional index | |
175 | ;; Returns a completion entry that starts with string. | |
176 | ;; | |
177 | ;; find-exact-completion string | |
178 | ;; Returns a completion entry that exactly matches string. | |
179 | ;; | |
180 | ;; complete | |
181 | ;; Inserts a completion at point | |
182 | ;; | |
36cc948e | 183 | ;; completion-initialize |
71296446 | 184 | ;; Loads the completions file and sets up so that exiting emacs will |
b578f267 EN |
185 | ;; save them. |
186 | ;; | |
71296446 | 187 | ;; save-completions-to-file &optional filename |
b578f267 EN |
188 | ;; load-completions-from-file &optional filename |
189 | ;; | |
190 | ;;----------------------------------------------- | |
191 | ;; Other functions | |
192 | ;;----------------------------------------------- | |
193 | ;; | |
194 | ;; get-completion-list string | |
195 | ;; | |
196 | ;; These things are for manipulating the structure | |
197 | ;; make-completion string num-uses | |
71296446 | 198 | ;; completion-num-uses completion |
b578f267 EN |
199 | ;; completion-string completion |
200 | ;; set-completion-num-uses completion num-uses | |
201 | ;; set-completion-string completion string | |
71296446 | 202 | ;; |
b578f267 | 203 | ;; |
59ca07b5 | 204 | \f |
b578f267 EN |
205 | ;;----------------------------------------------- |
206 | ;; To Do :: (anybody ?) | |
207 | ;;----------------------------------------------- | |
208 | ;; | |
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 | |
212 | ;; terminals only !) | |
213 | ;; Add doc. to texinfo | |
214 | ;; | |
215 | ;; | |
216 | ;;----------------------------------------------- | |
717e06e5 | 217 | ;;; Change Log: |
b578f267 | 218 | ;;----------------------------------------------- |
71296446 | 219 | ;; Sometime in '84 Brewster implemented a somewhat buggy version for |
b578f267 | 220 | ;; Symbolics LISPMs. |
71296446 | 221 | ;; Jan. '85 Jim became enamored of the idea and implemented a faster, |
b578f267 EN |
222 | ;; more robust version. |
223 | ;; With input from many users at TMC, (rose, craig, and gls come to mind), | |
71296446 JB |
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 | |
b578f267 EN |
229 | ;; promised rewards), Jim reimplemented a version of GNU completion |
230 | ;; superior to that of the LISPM version. | |
231 | ;; | |
232 | ;;----------------------------------------------- | |
233 | ;; Acknowledgements | |
234 | ;;----------------------------------------------- | |
235 | ;; Cliff Lasser (cal@think.com), Kevin Herbert (kph@cisco.com), | |
236 | ;; eero@media-lab, kgk@cs.brown.edu, jla@ai.mit.edu, | |
237 | ;; | |
238 | ;;----------------------------------------------- | |
239 | ;; Change Log | |
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 | |
246 | ;; | |
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) | |
250 | ;; | |
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) | |
256 | ;; | |
257 | ;; From Version 6 to 7 | |
258 | ;; - Fixed bug with saving out .completion file the first time | |
259 | ;; | |
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 | |
265 | ;; | |
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 | |
71296446 | 273 | ;; - added backup protection to save-completions-to-file (prevents |
b578f267 | 274 | ;; problems with disk full errors) |
59ca07b5 | 275 | \f |
d1c7011d ER |
276 | ;;; Code: |
277 | ||
b578f267 EN |
278 | ;;--------------------------------------------------------------------------- |
279 | ;; User changeable parameters | |
280 | ;;--------------------------------------------------------------------------- | |
59ca07b5 | 281 | |
00ed33e7 RS |
282 | (defgroup completion nil |
283 | "Dynamic word-completion code." | |
f5f727f8 DN |
284 | :group 'matching |
285 | :group 'convenience) | |
00ed33e7 RS |
286 | |
287 | ||
288 | (defcustom enable-completion t | |
36cc948e | 289 | "Non-nil means enable recording and saving of completions. |
d2c49fd8 | 290 | If nil, no new words are added to the database or saved to the init file." |
00ed33e7 RS |
291 | :type 'boolean |
292 | :group 'completion) | |
59ca07b5 | 293 | |
00ed33e7 | 294 | (defcustom save-completions-flag t |
36cc948e | 295 | "Non-nil means save most-used completions when exiting Emacs. |
5c510e70 | 296 | See also `save-completions-retention-time'." |
00ed33e7 RS |
297 | :type 'boolean |
298 | :group 'completion) | |
59ca07b5 | 299 | |
36cc948e SM |
300 | (defcustom save-completions-file-name |
301 | (let ((olddef (convert-standard-filename "~/.completions"))) | |
302 | (cond | |
303 | ((file-readable-p olddef) olddef) | |
304 | ((file-directory-p (convert-standard-filename "~/.emacs.d/")) | |
21b15ee8 SM |
305 | (convert-standard-filename |
306 | (expand-file-name "completions" "~/.emacs.d/"))) | |
36cc948e SM |
307 | (t olddef))) |
308 | "The filename to save completions to." | |
00ed33e7 RS |
309 | :type 'file |
310 | :group 'completion) | |
59ca07b5 | 311 | |
00ed33e7 | 312 | (defcustom save-completions-retention-time 336 |
36cc948e | 313 | "Discard a completion if unused for this many hours. |
a7a2b1f6 | 314 | \(1 day = 24, 1 week = 168). If this is 0, non-permanent completions |
00ed33e7 RS |
315 | will not be saved unless these are used. Default is two weeks." |
316 | :type 'integer | |
317 | :group 'completion) | |
59ca07b5 | 318 | |
00ed33e7 | 319 | (defcustom completion-on-separator-character nil |
36cc948e | 320 | "Non-nil means separator characters mark previous word as used. |
00ed33e7 RS |
321 | This means the word will be saved as a completion." |
322 | :type 'boolean | |
323 | :group 'completion) | |
59ca07b5 | 324 | |
00ed33e7 | 325 | (defcustom completions-file-versions-kept kept-new-versions |
36cc948e | 326 | "Number of versions to keep for the saved completions file." |
00ed33e7 RS |
327 | :type 'integer |
328 | :group 'completion) | |
59ca07b5 | 329 | |
00ed33e7 | 330 | (defcustom completion-prompt-speed-threshold 4800 |
36cc948e | 331 | "Minimum output speed at which to display next potential completion." |
00ed33e7 RS |
332 | :type 'integer |
333 | :group 'completion) | |
59ca07b5 | 334 | |
00ed33e7 | 335 | (defcustom completion-cdabbrev-prompt-flag nil |
36cc948e | 336 | "If non-nil, the next completion prompt does a cdabbrev search. |
00ed33e7 RS |
337 | This can be time consuming." |
338 | :type 'boolean | |
339 | :group 'completion) | |
59ca07b5 | 340 | |
00ed33e7 | 341 | (defcustom completion-search-distance 15000 |
36cc948e | 342 | "How far to search in the buffer when looking for completions. |
00ed33e7 RS |
343 | In number of characters. If nil, search the whole buffer." |
344 | :type 'integer | |
345 | :group 'completion) | |
59ca07b5 | 346 | |
00ed33e7 | 347 | (defcustom completions-merging-modes '(lisp c) |
36cc948e | 348 | "List of modes {`c' or `lisp'} for automatic completions merging. |
a7a2b1f6 | 349 | Definitions from visited files which have these modes |
00ed33e7 RS |
350 | are automatically added to the completion database." |
351 | :type '(set (const lisp) (const c)) | |
352 | :group 'completion) | |
59ca07b5 | 353 | |
b578f267 EN |
354 | ;;(defvar *record-cmpl-statistics-p* nil |
355 | ;; "*If non-nil, record completion statistics.") | |
59ca07b5 | 356 | |
b578f267 EN |
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.") | |
59ca07b5 | 360 | |
7975cb9f | 361 | (defvar completion-min-length 6 |
59ca07b5 RS |
362 | "*The minimum length of a stored completion. |
363 | DON'T CHANGE WITHOUT RECOMPILING ! This is used by macros.") | |
364 | ||
7975cb9f | 365 | (defvar completion-max-length 200 |
59ca07b5 RS |
366 | "*The maximum length of a stored completion. |
367 | DON'T CHANGE WITHOUT RECOMPILING ! This is used by macros.") | |
368 | ||
7975cb9f | 369 | (defvar completion-prefix-min-length 3 |
59ca07b5 RS |
370 | "The minimum length of a completion search string. |
371 | DON'T CHANGE WITHOUT RECOMPILING ! This is used by macros.") | |
372 | ||
b578f267 EN |
373 | ;;--------------------------------------------------------------------------- |
374 | ;; Internal Variables | |
375 | ;;--------------------------------------------------------------------------- | |
59ca07b5 RS |
376 | |
377 | (defvar cmpl-initialized-p nil | |
a7a2b1f6 RS |
378 | "Set to t when the completion system is initialized. |
379 | Indicates that the old completion file has been read in.") | |
59ca07b5 RS |
380 | |
381 | (defvar cmpl-completions-accepted-p nil | |
a7a2b1f6 RS |
382 | "Set to t as soon as the first completion has been accepted. |
383 | Used to decide whether to save completions.") | |
59ca07b5 | 384 | |
136f8f67 | 385 | (defvar cmpl-preceding-syntax) |
438c6ef0 RS |
386 | |
387 | (defvar completion-string) | |
59ca07b5 | 388 | \f |
b578f267 EN |
389 | ;;--------------------------------------------------------------------------- |
390 | ;; Low level tools | |
391 | ;;--------------------------------------------------------------------------- | |
59ca07b5 | 392 | |
b578f267 EN |
393 | ;;----------------------------------------------- |
394 | ;; String case coercion | |
395 | ;;----------------------------------------------- | |
59ca07b5 RS |
396 | |
397 | (defun cmpl-string-case-type (string) | |
d2c49fd8 | 398 | "Return :capitalized, :up, :down, :mixed, or :neither for case of STRING." |
59ca07b5 | 399 | (let ((case-fold-search nil)) |
d2c49fd8 DL |
400 | (cond ((string-match "[[:lower:]]" string) |
401 | (cond ((string-match "[[:upper:]]" string) | |
59ca07b5 | 402 | (cond ((and (> (length string) 1) |
d2c49fd8 DL |
403 | (null (string-match "[[:upper:]]" string 1))) |
404 | :capitalized) | |
59ca07b5 | 405 | (t |
d2c49fd8 DL |
406 | :mixed))) |
407 | (t :down))) | |
59ca07b5 | 408 | (t |
d2c49fd8 DL |
409 | (cond ((string-match "[[:upper:]]" string) |
410 | :up) | |
411 | (t :neither)))))) | |
59ca07b5 | 412 | |
b578f267 EN |
413 | ;; Tests - |
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 | |
59ca07b5 RS |
419 | |
420 | (defun cmpl-coerce-string-case (string case-type) | |
d2c49fd8 DL |
421 | (cond ((eq case-type :down) (downcase string)) |
422 | ((eq case-type :up) (upcase string)) | |
423 | ((eq case-type :capitalized) | |
59ca07b5 RS |
424 | (setq string (downcase string)) |
425 | (aset string 0 (logand ?\337 (aref string 0))) | |
426 | string) | |
d2c49fd8 | 427 | (t string))) |
59ca07b5 RS |
428 | |
429 | (defun cmpl-merge-string-cases (string-to-coerce given-string) | |
d2c49fd8 | 430 | (let ((string-case-type (cmpl-string-case-type string-to-coerce))) |
59ca07b5 RS |
431 | (cond ((memq string-case-type '(:down :up :capitalized)) |
432 | ;; Found string is in a standard case. Coerce to a type based on | |
433 | ;; the given string | |
434 | (cmpl-coerce-string-case string-to-coerce | |
d2c49fd8 | 435 | (cmpl-string-case-type given-string))) |
59ca07b5 RS |
436 | (t |
437 | ;; If the found string is in some unusual case, just insert it | |
438 | ;; as is | |
d2c49fd8 | 439 | string-to-coerce)))) |
59ca07b5 | 440 | |
b578f267 EN |
441 | ;; Tests - |
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 | |
59ca07b5 RS |
446 | |
447 | \f | |
a7a2b1f6 RS |
448 | (defun cmpl-hours-since-origin () |
449 | (let ((time (current-time))) | |
5a3d3a16 | 450 | (floor (+ (* 65536.0 (nth 0 time)) (nth 1 time)) 3600))) |
59ca07b5 | 451 | \f |
b578f267 EN |
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 :: | |
459 | ;; | |
460 | ;; syntax (?_) - "symbol" chars (e.g. alphanumerics) | |
71296446 | 461 | ;; syntax (?w) - symbol chars to ignore at end of words (e.g. period). |
b578f267 EN |
462 | ;; syntax (? ) - everything else |
463 | ;; | |
464 | ;; Thus by judicious use of scan-sexps and forward-word, we can get | |
71296446 | 465 | ;; the word we want relatively fast and without consing. |
b578f267 EN |
466 | ;; |
467 | ;; Why do we need a separate category for "symbol chars to ignore at ends" ? | |
71296446 | 468 | ;; For example, in LISP we want starting :'s trimmed |
b578f267 EN |
469 | ;; so keyword argument specifiers also define the keyword completion. And, |
470 | ;; for example, in C we want `.' appearing in a structure ref. to | |
71296446 | 471 | ;; be kept intact in order to store the whole structure ref.; however, if |
b578f267 EN |
472 | ;; it appears at the end of a symbol it should be discarded because it is |
473 | ;; probably used as a period. | |
474 | ||
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> | |
480 | ||
481 | ;; Mode specific differences and notes :: | |
482 | ;; LISP diffs -> | |
483 | ;; Symbol chars :: ! & ? = ^ | |
484 | ;; | |
485 | ;; C diffs -> | |
486 | ;; Separator chars :: + * / : % | |
487 | ;; A note on the hyphen (`-'). Perhaps the hyphen should also be a separator | |
71296446 | 488 | ;; char., however, we wanted to have completion symbols include pointer |
b578f267 EN |
489 | ;; references. For example, "foo->bar" is a symbol as far as completion is |
490 | ;; concerned. | |
491 | ;; | |
492 | ;; FORTRAN diffs -> | |
493 | ;; Separator chars :: + - * / : | |
494 | ;; | |
495 | ;; Pathname diffs -> | |
496 | ;; Symbol 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 | |
499 | ;; like. | |
500 | ||
501 | ;;----------------------------------------------- | |
502 | ;; Table definitions | |
503 | ;;----------------------------------------------- | |
59ca07b5 | 504 | |
36cc948e | 505 | (defconst completion-standard-syntax-table |
1aa323ac | 506 | (let ((table (make-syntax-table)) |
136f8f67 | 507 | i) |
1aa323ac RS |
508 | ;; Default syntax is whitespace. |
509 | (setq i 0) | |
510 | (while (< i 256) | |
511 | (modify-syntax-entry i " " table) | |
512 | (setq i (1+ i))) | |
59ca07b5 | 513 | ;; alpha chars |
136f8f67 RS |
514 | (setq i 0) |
515 | (while (< i 26) | |
59ca07b5 | 516 | (modify-syntax-entry (+ ?a i) "_" table) |
136f8f67 RS |
517 | (modify-syntax-entry (+ ?A i) "_" table) |
518 | (setq i (1+ i))) | |
59ca07b5 | 519 | ;; digit chars. |
136f8f67 RS |
520 | (setq i 0) |
521 | (while (< i 10) | |
522 | (modify-syntax-entry (+ ?0 i) "_" table) | |
523 | (setq i (1+ i))) | |
59ca07b5 RS |
524 | ;; Other ones |
525 | (let ((symbol-chars '(?@ ?/ ?\\ ?* ?+ ?~ ?$ ?< ?> ?%)) | |
d2c49fd8 | 526 | (symbol-chars-ignore '(?_ ?- ?: ?.))) |
3f429351 | 527 | (dolist (char symbol-chars) |
59ca07b5 | 528 | (modify-syntax-entry char "_" table)) |
3f429351 | 529 | (dolist (char symbol-chars-ignore) |
d2c49fd8 | 530 | (modify-syntax-entry char "w" table))) |
59ca07b5 RS |
531 | table)) |
532 | ||
36cc948e | 533 | (defvar completion-syntax-table completion-standard-syntax-table |
59ca07b5 | 534 | "This variable holds the current completion syntax table.") |
36cc948e | 535 | (make-variable-buffer-local 'completion-syntax-table) |
59ca07b5 | 536 | |
b578f267 EN |
537 | ;;----------------------------------------------- |
538 | ;; Symbol functions | |
539 | ;;----------------------------------------------- | |
59ca07b5 | 540 | (defvar cmpl-symbol-start nil |
a7a2b1f6 | 541 | "Holds first character of symbol, after any completion symbol function.") |
59ca07b5 | 542 | (defvar cmpl-symbol-end nil |
a7a2b1f6 | 543 | "Holds last character of symbol, after any completion symbol function.") |
59ca07b5 RS |
544 | |
545 | (defun symbol-under-point () | |
7975cb9f | 546 | "Return the symbol that the point is currently on. |
a7a2b1f6 | 547 | But only if it is longer than `completion-min-length'." |
36cc948e SM |
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) | |
557 | (forward-word 1) | |
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) | |
563 | (forward-word -1) | |
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 cmpl-symbol-start cmpl-symbol-end)))))) | |
59ca07b5 | 572 | |
b578f267 EN |
573 | ;; tests for symbol-under-point |
574 | ;; `^' indicates cursor pos. where value is returned | |
575 | ;; simple-word-test | |
576 | ;; ^^^^^^^^^^^^^^^^ --> simple-word-test | |
577 | ;; _harder_word_test_ | |
578 | ;; ^^^^^^^^^^^^^^^^^^ --> harder_word_test | |
579 | ;; .___.______. | |
580 | ;; --> nil | |
581 | ;; /foo/bar/quux.hello | |
582 | ;; ^^^^^^^^^^^^^^^^^^^ --> /foo/bar/quux.hello | |
583 | ;; | |
59ca07b5 RS |
584 | |
585 | (defun symbol-before-point () | |
7975cb9f | 586 | "Return a string of the symbol immediately before point. |
71296446 | 587 | Returns nil if there isn't one longer than `completion-min-length'." |
59ca07b5 | 588 | ;; This is called when a word separator is typed so it must be FAST ! |
36cc948e SM |
589 | (with-syntax-table completion-syntax-table |
590 | ;; Cursor is on following-char and after preceding-char | |
591 | (cond ((= (setq cmpl-preceding-syntax (char-syntax (preceding-char))) ?_) | |
592 | ;; Number of chars to ignore at end. | |
593 | (setq cmpl-symbol-end (point) | |
594 | cmpl-symbol-start (scan-sexps cmpl-symbol-end -1)) | |
595 | ;; Remove chars to ignore at the start. | |
596 | (cond ((= (char-syntax (char-after cmpl-symbol-start)) ?w) | |
597 | (goto-char cmpl-symbol-start) | |
598 | (forward-word 1) | |
599 | (setq cmpl-symbol-start (point)) | |
600 | (goto-char cmpl-symbol-end))) | |
601 | ;; Return value if long enough. | |
602 | (if (>= cmpl-symbol-end | |
603 | (+ cmpl-symbol-start completion-min-length)) | |
604 | (buffer-substring cmpl-symbol-start cmpl-symbol-end))) | |
605 | ((= cmpl-preceding-syntax ?w) | |
606 | ;; chars to ignore at end | |
607 | (let ((saved-point (point))) | |
608 | (setq cmpl-symbol-start (scan-sexps saved-point -1)) | |
609 | ;; take off chars. from end | |
610 | (forward-word -1) | |
611 | (setq cmpl-symbol-end (point)) | |
612 | ;; remove chars to ignore at the start | |
613 | (cond ((= (char-syntax (char-after cmpl-symbol-start)) ?w) | |
614 | (goto-char cmpl-symbol-start) | |
615 | (forward-word 1) | |
616 | (setq cmpl-symbol-start (point)))) | |
617 | ;; Restore state. | |
618 | (goto-char saved-point) | |
619 | ;; Return completion if the length is reasonable | |
620 | (if (and (<= completion-min-length | |
621 | (- cmpl-symbol-end cmpl-symbol-start)) | |
622 | (<= (- cmpl-symbol-end cmpl-symbol-start) | |
623 | completion-max-length)) | |
624 | (buffer-substring cmpl-symbol-start cmpl-symbol-end))))))) | |
59ca07b5 | 625 | |
b578f267 EN |
626 | ;; tests for symbol-before-point |
627 | ;; `^' indicates cursor pos. where value is returned | |
628 | ;; simple-word-test | |
629 | ;; ^ --> nil | |
630 | ;; ^ --> nil | |
631 | ;; ^ --> simple-w | |
632 | ;; ^ --> simple-word-test | |
633 | ;; _harder_word_test_ | |
634 | ;; ^ --> harder_word_test | |
635 | ;; ^ --> harder_word_test | |
636 | ;; ^ --> harder | |
637 | ;; .___.... | |
638 | ;; --> nil | |
59ca07b5 RS |
639 | |
640 | (defun symbol-under-or-before-point () | |
b578f267 EN |
641 | ;; This could be made slightly faster but it is better to avoid |
642 | ;; copying all the code. | |
643 | ;; However, it is only used by the completion string prompter. | |
644 | ;; If it comes into common use, it could be rewritten. | |
36cc948e SM |
645 | (if (memq (with-syntax-table completion-syntax-table |
646 | (char-syntax (following-char))) | |
647 | '(?w ?_)) | |
648 | (symbol-under-point) | |
649 | (symbol-before-point))) | |
59ca07b5 RS |
650 | |
651 | ||
652 | (defun symbol-before-point-for-complete () | |
653 | ;; "Returns a string of the symbol immediately before point | |
654 | ;; or nil if there isn't one. Like symbol-before-point but doesn't trim the | |
655 | ;; end chars." | |
656 | ;; Cursor is on following-char and after preceding-char | |
36cc948e SM |
657 | (with-syntax-table completion-syntax-table |
658 | (cond ((memq (setq cmpl-preceding-syntax (char-syntax (preceding-char))) | |
659 | '(?_ ?w)) | |
660 | (setq cmpl-symbol-end (point) | |
661 | cmpl-symbol-start (scan-sexps cmpl-symbol-end -1)) | |
662 | ;; Remove chars to ignore at the start. | |
663 | (cond ((= (char-syntax (char-after cmpl-symbol-start)) ?w) | |
664 | (goto-char cmpl-symbol-start) | |
665 | (forward-word 1) | |
666 | (setq cmpl-symbol-start (point)) | |
667 | (goto-char cmpl-symbol-end))) | |
668 | ;; Return completion if the length is reasonable. | |
669 | (if (and (<= completion-prefix-min-length | |
670 | (- cmpl-symbol-end cmpl-symbol-start)) | |
671 | (<= (- cmpl-symbol-end cmpl-symbol-start) | |
672 | completion-max-length)) | |
673 | (buffer-substring cmpl-symbol-start cmpl-symbol-end)))))) | |
59ca07b5 | 674 | |
b578f267 EN |
675 | ;; tests for symbol-before-point-for-complete |
676 | ;; `^' indicates cursor pos. where value is returned | |
677 | ;; simple-word-test | |
678 | ;; ^ --> nil | |
679 | ;; ^ --> nil | |
680 | ;; ^ --> simple-w | |
681 | ;; ^ --> simple-word-test | |
682 | ;; _harder_word_test_ | |
683 | ;; ^ --> harder_word_test | |
684 | ;; ^ --> harder_word_test_ | |
685 | ;; ^ --> harder_ | |
686 | ;; .___.... | |
687 | ;; --> nil | |
59ca07b5 RS |
688 | |
689 | ||
690 | \f | |
b578f267 EN |
691 | ;;--------------------------------------------------------------------------- |
692 | ;; Statistics Recording | |
693 | ;;--------------------------------------------------------------------------- | |
59ca07b5 | 694 | |
b578f267 EN |
695 | ;; Note that the guts of this has been turned off. The guts |
696 | ;; are in completion-stats.el. | |
59ca07b5 | 697 | |
b578f267 EN |
698 | ;;----------------------------------------------- |
699 | ;; Conditionalizing code on *record-cmpl-statistics-p* | |
700 | ;;----------------------------------------------- | |
701 | ;; All statistics code outside this block should use this | |
a7a2b1f6 | 702 | (defmacro cmpl-statistics-block (&rest body)) |
b578f267 EN |
703 | ;; "Only executes body if we are recording statistics." |
704 | ;; (list 'cond | |
705 | ;; (list* '*record-cmpl-statistics-p* body) | |
71296446 | 706 | ;; )) |
59ca07b5 | 707 | |
b578f267 EN |
708 | ;;----------------------------------------------- |
709 | ;; Completion Sources | |
710 | ;;----------------------------------------------- | |
59ca07b5 RS |
711 | |
712 | ;; ID numbers | |
713 | (defconst cmpl-source-unknown 0) | |
714 | (defconst cmpl-source-init-file 1) | |
715 | (defconst cmpl-source-file-parsing 2) | |
716 | (defconst cmpl-source-separator 3) | |
717 | (defconst cmpl-source-cursor-moves 4) | |
718 | (defconst cmpl-source-interactive 5) | |
719 | (defconst cmpl-source-cdabbrev 6) | |
720 | (defconst num-cmpl-sources 7) | |
721 | (defvar current-completion-source cmpl-source-unknown) | |
722 | ||
723 | ||
724 | \f | |
b578f267 EN |
725 | ;;--------------------------------------------------------------------------- |
726 | ;; Completion Method #2: dabbrev-expand style | |
727 | ;;--------------------------------------------------------------------------- | |
728 | ;; | |
71296446 | 729 | ;; This method is used if there are no useful stored completions. It is |
b578f267 EN |
730 | ;; based on dabbrev-expand with these differences : |
731 | ;; 1) Faster (we don't use regexps) | |
732 | ;; 2) case coercion handled correctly | |
733 | ;; This is called cdabbrev to differentiate it. | |
734 | ;; We simply search backwards through the file looking for words which | |
735 | ;; start with the same letters we are trying to complete. | |
736 | ;; | |
59ca07b5 RS |
737 | |
738 | (defvar cdabbrev-completions-tried nil) | |
b578f267 | 739 | ;; "A list of all the cdabbrev completions since the last reset.") |
59ca07b5 RS |
740 | |
741 | (defvar cdabbrev-current-point 0) | |
b578f267 | 742 | ;; "The current point position the cdabbrev search is at.") |
59ca07b5 RS |
743 | |
744 | (defvar cdabbrev-current-window nil) | |
bb310d1e RS |
745 | ;; "The current window we are looking for cdabbrevs in. |
746 | ;; Return t if looking in (other-buffer), nil if no more cdabbrevs.") | |
59ca07b5 RS |
747 | |
748 | (defvar cdabbrev-wrapped-p nil) | |
bb310d1e | 749 | ;; "Return t if the cdabbrev search has wrapped around the file.") |
59ca07b5 RS |
750 | |
751 | (defvar cdabbrev-abbrev-string "") | |
752 | (defvar cdabbrev-start-point 0) | |
136f8f67 | 753 | (defvar cdabbrev-stop-point) |
59ca07b5 | 754 | |
b578f267 EN |
755 | ;; Test strings for cdabbrev |
756 | ;; cdat-upcase ;;same namestring | |
757 | ;; CDAT-UPCASE ;;ok | |
758 | ;; cdat2 ;;too short | |
759 | ;; cdat-1-2-3-4 ;;ok | |
760 | ;; a-cdat-1 ;;doesn't start correctly | |
761 | ;; cdat-simple ;;ok | |
59ca07b5 RS |
762 | |
763 | ||
764 | (defun reset-cdabbrev (abbrev-string &optional initial-completions-tried) | |
7975cb9f | 765 | "Reset the cdabbrev search to search for ABBREV-STRING. |
a7a2b1f6 | 766 | INITIAL-COMPLETIONS-TRIED is a list of downcased strings to ignore |
59ca07b5 RS |
767 | during the search." |
768 | (setq cdabbrev-abbrev-string abbrev-string | |
769 | cdabbrev-completions-tried | |
d2c49fd8 DL |
770 | (cons (downcase abbrev-string) initial-completions-tried)) |
771 | (reset-cdabbrev-window t)) | |
59ca07b5 RS |
772 | |
773 | (defun set-cdabbrev-buffer () | |
0ff9b955 | 774 | ;; cdabbrev-current-window must not be nil |
59ca07b5 RS |
775 | (set-buffer (if (eq cdabbrev-current-window t) |
776 | (other-buffer) | |
d2c49fd8 | 777 | (window-buffer cdabbrev-current-window)))) |
59ca07b5 RS |
778 | |
779 | ||
780 | (defun reset-cdabbrev-window (&optional initializep) | |
7975cb9f | 781 | "Reset the cdabbrev search to search for abbrev-string." |
59ca07b5 RS |
782 | ;; Set the window |
783 | (cond (initializep | |
d2c49fd8 | 784 | (setq cdabbrev-current-window (selected-window))) |
59ca07b5 RS |
785 | ((eq cdabbrev-current-window t) |
786 | ;; Everything has failed | |
787 | (setq cdabbrev-current-window nil)) | |
788 | (cdabbrev-current-window | |
789 | (setq cdabbrev-current-window (next-window cdabbrev-current-window)) | |
790 | (if (eq cdabbrev-current-window (selected-window)) | |
791 | ;; No more windows, try other buffer. | |
d2c49fd8 | 792 | (setq cdabbrev-current-window t)))) |
136f8f67 RS |
793 | (if cdabbrev-current-window |
794 | (save-excursion | |
795 | (set-cdabbrev-buffer) | |
796 | (setq cdabbrev-current-point (point) | |
797 | cdabbrev-start-point cdabbrev-current-point | |
798 | cdabbrev-stop-point | |
799 | (if completion-search-distance | |
800 | (max (point-min) | |
801 | (- cdabbrev-start-point completion-search-distance)) | |
802 | (point-min)) | |
d2c49fd8 | 803 | cdabbrev-wrapped-p nil)))) |
59ca07b5 RS |
804 | |
805 | (defun next-cdabbrev () | |
806 | "Return the next possible cdabbrev expansion or nil if there isn't one. | |
a7a2b1f6 RS |
807 | `reset-cdabbrev' must've been called already. |
808 | This is sensitive to `case-fold-search'." | |
59ca07b5 RS |
809 | ;; note that case-fold-search affects the behavior of this function |
810 | ;; Bug: won't pick up an expansion that starts at the top of buffer | |
136f8f67 | 811 | (if cdabbrev-current-window |
71296446 | 812 | (let (saved-point |
136f8f67 RS |
813 | saved-syntax |
814 | (expansion nil) | |
815 | downcase-expansion tried-list syntax saved-point-2) | |
816 | (save-excursion | |
817 | (unwind-protect | |
818 | (progn | |
819 | ;; Switch to current completion buffer | |
820 | (set-cdabbrev-buffer) | |
821 | ;; Save current buffer state | |
822 | (setq saved-point (point) | |
823 | saved-syntax (syntax-table)) | |
824 | ;; Restore completion state | |
36cc948e | 825 | (set-syntax-table completion-syntax-table) |
136f8f67 RS |
826 | (goto-char cdabbrev-current-point) |
827 | ;; Loop looking for completions | |
828 | (while | |
829 | ;; This code returns t if it should loop again | |
830 | (cond | |
831 | (;; search for the string | |
832 | (search-backward cdabbrev-abbrev-string cdabbrev-stop-point t) | |
833 | ;; return nil if the completion is valid | |
834 | (not | |
835 | (and | |
836 | ;; does it start with a separator char ? | |
837 | (or (= (setq syntax (char-syntax (preceding-char))) ? ) | |
838 | (and (= syntax ?w) | |
839 | ;; symbol char to ignore at end. Are we at end ? | |
840 | (progn | |
841 | (setq saved-point-2 (point)) | |
842 | (forward-word -1) | |
843 | (prog1 | |
844 | (= (char-syntax (preceding-char)) ? ) | |
d2c49fd8 | 845 | (goto-char saved-point-2))))) |
136f8f67 RS |
846 | ;; is the symbol long enough ? |
847 | (setq expansion (symbol-under-point)) | |
848 | ;; have we not tried this one before | |
849 | (progn | |
850 | ;; See if we've already used it | |
851 | (setq tried-list cdabbrev-completions-tried | |
852 | downcase-expansion (downcase expansion)) | |
853 | (while (and tried-list | |
854 | (not (string-equal downcase-expansion | |
855 | (car tried-list)))) | |
856 | ;; Already tried, don't choose this one | |
d2c49fd8 | 857 | (setq tried-list (cdr tried-list))) |
136f8f67 RS |
858 | ;; at this point tried-list will be nil if this |
859 | ;; expansion has not yet been tried | |
860 | (if tried-list | |
861 | (setq expansion nil) | |
d2c49fd8 | 862 | t))))) |
136f8f67 RS |
863 | ;; search failed |
864 | (cdabbrev-wrapped-p | |
865 | ;; If already wrapped, then we've failed completely | |
866 | nil) | |
867 | (t | |
868 | ;; need to wrap | |
869 | (goto-char (setq cdabbrev-current-point | |
870 | (if completion-search-distance | |
871 | (min (point-max) (+ cdabbrev-start-point completion-search-distance)) | |
872 | (point-max)))) | |
873 | ||
d2c49fd8 | 874 | (setq cdabbrev-wrapped-p t)))) |
136f8f67 RS |
875 | ;; end of while loop |
876 | (cond (expansion | |
877 | ;; successful | |
878 | (setq cdabbrev-completions-tried | |
879 | (cons downcase-expansion cdabbrev-completions-tried) | |
d2c49fd8 | 880 | cdabbrev-current-point (point))))) |
136f8f67 | 881 | (set-syntax-table saved-syntax) |
d2c49fd8 | 882 | (goto-char saved-point))) |
136f8f67 RS |
883 | ;; If no expansion, go to next window |
884 | (cond (expansion) | |
885 | (t (reset-cdabbrev-window) | |
886 | (next-cdabbrev)))))) | |
59ca07b5 | 887 | |
b578f267 EN |
888 | ;; The following must be eval'd in the minibuffer :: |
889 | ;; (reset-cdabbrev "cdat") | |
890 | ;; (next-cdabbrev) --> "cdat-simple" | |
891 | ;; (next-cdabbrev) --> "cdat-1-2-3-4" | |
892 | ;; (next-cdabbrev) --> "CDAT-UPCASE" | |
893 | ;; (next-cdabbrev) --> "cdat-wrapping" | |
894 | ;; (next-cdabbrev) --> "cdat_start_sym" | |
895 | ;; (next-cdabbrev) --> nil | |
896 | ;; (next-cdabbrev) --> nil | |
897 | ;; (next-cdabbrev) --> nil | |
59ca07b5 | 898 | |
b578f267 EN |
899 | ;; _cdat_start_sym |
900 | ;; cdat-wrapping | |
59ca07b5 RS |
901 | |
902 | \f | |
b578f267 EN |
903 | ;;--------------------------------------------------------------------------- |
904 | ;; Completion Database | |
905 | ;;--------------------------------------------------------------------------- | |
906 | ||
907 | ;; We use two storage modes for the two search types :: | |
908 | ;; 1) Prefix {cmpl-prefix-obarray} for looking up possible completions | |
909 | ;; Used by search-completion-next | |
910 | ;; the value of the symbol is nil or a cons of head and tail pointers | |
911 | ;; 2) Interning {cmpl-obarray} to see if it's in the database | |
912 | ;; Used by find-exact-completion, completion-in-database-p | |
913 | ;; The value of the symbol is the completion entry | |
914 | ||
915 | ;; bad things may happen if this length is changed due to the way | |
916 | ;; GNU implements obarrays | |
59ca07b5 RS |
917 | (defconst cmpl-obarray-length 511) |
918 | ||
919 | (defvar cmpl-prefix-obarray (make-vector cmpl-obarray-length 0) | |
eb8c3be9 | 920 | "An obarray used to store the downcased completion prefixes. |
59ca07b5 RS |
921 | Each symbol is bound to a list of completion entries.") |
922 | ||
923 | (defvar cmpl-obarray (make-vector cmpl-obarray-length 0) | |
924 | "An obarray used to store the downcased completions. | |
925 | Each symbol is bound to a single completion entry.") | |
926 | ||
b578f267 EN |
927 | ;;----------------------------------------------- |
928 | ;; Completion Entry Structure Definition | |
929 | ;;----------------------------------------------- | |
59ca07b5 | 930 | |
b578f267 EN |
931 | ;; A completion entry is a LIST of string, prefix-symbol num-uses, and |
932 | ;; last-use-time (the time the completion was last used) | |
0ff9b955 | 933 | ;; last-use-time is t if the string should be kept permanently |
b578f267 | 934 | ;; num-uses is incremented every time the completion is used. |
59ca07b5 | 935 | |
71296446 | 936 | ;; We chose lists because (car foo) is faster than (aref foo 0) and the |
b578f267 | 937 | ;; creation time is about the same. |
59ca07b5 | 938 | |
b578f267 | 939 | ;; READER MACROS |
59ca07b5 RS |
940 | |
941 | (defmacro completion-string (completion-entry) | |
942 | (list 'car completion-entry)) | |
943 | ||
944 | (defmacro completion-num-uses (completion-entry) | |
71296446 | 945 | ;; "The number of times it has used. Used to decide whether to save |
59ca07b5 RS |
946 | ;; it." |
947 | (list 'car (list 'cdr completion-entry))) | |
948 | ||
949 | (defmacro completion-last-use-time (completion-entry) | |
a7a2b1f6 | 950 | ;; "The time it was last used. In hours since origin. Used to decide |
0ff9b955 | 951 | ;; whether to save it. t if one should always save it." |
59ca07b5 RS |
952 | (list 'nth 2 completion-entry)) |
953 | ||
954 | (defmacro completion-source (completion-entry) | |
955 | (list 'nth 3 completion-entry)) | |
956 | ||
b578f267 | 957 | ;; WRITER MACROS |
59ca07b5 RS |
958 | (defmacro set-completion-string (completion-entry string) |
959 | (list 'setcar completion-entry string)) | |
960 | ||
961 | (defmacro set-completion-num-uses (completion-entry num-uses) | |
962 | (list 'setcar (list 'cdr completion-entry) num-uses)) | |
963 | ||
964 | (defmacro set-completion-last-use-time (completion-entry last-use-time) | |
965 | (list 'setcar (list 'cdr (list 'cdr completion-entry)) last-use-time)) | |
966 | ||
b578f267 | 967 | ;; CONSTRUCTOR |
59ca07b5 | 968 | (defun make-completion (string) |
36cc948e SM |
969 | "Return a completion entry." |
970 | (list string 0 nil current-completion-source)) | |
59ca07b5 RS |
971 | |
972 | ;; Obsolete | |
973 | ;;(defmacro cmpl-prefix-entry-symbol (completion-entry) | |
974 | ;; (list 'car (list 'cdr completion-entry))) | |
975 | ||
976 | ||
977 | \f | |
b578f267 EN |
978 | ;;----------------------------------------------- |
979 | ;; Prefix symbol entry definition | |
980 | ;;----------------------------------------------- | |
981 | ;; A cons of (head . tail) | |
59ca07b5 | 982 | |
b578f267 | 983 | ;; READER Macros |
59ca07b5 | 984 | |
36cc948e | 985 | (defalias 'cmpl-prefix-entry-head 'car) |
59ca07b5 | 986 | |
36cc948e | 987 | (defalias 'cmpl-prefix-entry-tail 'cdr) |
59ca07b5 | 988 | |
b578f267 | 989 | ;; WRITER Macros |
59ca07b5 RS |
990 | |
991 | (defmacro set-cmpl-prefix-entry-head (prefix-entry new-head) | |
992 | (list 'setcar prefix-entry new-head)) | |
993 | ||
994 | (defmacro set-cmpl-prefix-entry-tail (prefix-entry new-tail) | |
995 | (list 'setcdr prefix-entry new-tail)) | |
996 | ||
b578f267 | 997 | ;; Constructor |
59ca07b5 RS |
998 | |
999 | (defun make-cmpl-prefix-entry (completion-entry-list) | |
7975cb9f | 1000 | "Make a new prefix entry containing only completion-entry." |
59ca07b5 RS |
1001 | (cons completion-entry-list completion-entry-list)) |
1002 | ||
b578f267 EN |
1003 | ;;----------------------------------------------- |
1004 | ;; Completion Database - Utilities | |
1005 | ;;----------------------------------------------- | |
59ca07b5 RS |
1006 | |
1007 | (defun clear-all-completions () | |
d2c49fd8 | 1008 | "Initialize the completion storage. All existing completions are lost." |
59ca07b5 RS |
1009 | (interactive) |
1010 | (setq cmpl-prefix-obarray (make-vector cmpl-obarray-length 0)) | |
1011 | (setq cmpl-obarray (make-vector cmpl-obarray-length 0)) | |
1012 | (cmpl-statistics-block | |
d2c49fd8 | 1013 | (record-clear-all-completions))) |
59ca07b5 | 1014 | |
136f8f67 RS |
1015 | (defvar completions-list-return-value) |
1016 | ||
59ca07b5 | 1017 | (defun list-all-completions () |
d2c49fd8 | 1018 | "Return a list of all the known completion entries." |
136f8f67 | 1019 | (let ((completions-list-return-value nil)) |
59ca07b5 | 1020 | (mapatoms 'list-all-completions-1 cmpl-prefix-obarray) |
136f8f67 | 1021 | completions-list-return-value)) |
59ca07b5 RS |
1022 | |
1023 | (defun list-all-completions-1 (prefix-symbol) | |
1024 | (if (boundp prefix-symbol) | |
136f8f67 | 1025 | (setq completions-list-return-value |
59ca07b5 | 1026 | (append (cmpl-prefix-entry-head (symbol-value prefix-symbol)) |
136f8f67 | 1027 | completions-list-return-value)))) |
59ca07b5 RS |
1028 | |
1029 | (defun list-all-completions-by-hash-bucket () | |
a7a2b1f6 | 1030 | "Return list of lists of known completion entries, organized by hash bucket." |
136f8f67 | 1031 | (let ((completions-list-return-value nil)) |
59ca07b5 | 1032 | (mapatoms 'list-all-completions-by-hash-bucket-1 cmpl-prefix-obarray) |
136f8f67 | 1033 | completions-list-return-value)) |
59ca07b5 RS |
1034 | |
1035 | (defun list-all-completions-by-hash-bucket-1 (prefix-symbol) | |
1036 | (if (boundp prefix-symbol) | |
136f8f67 | 1037 | (setq completions-list-return-value |
59ca07b5 | 1038 | (cons (cmpl-prefix-entry-head (symbol-value prefix-symbol)) |
136f8f67 | 1039 | completions-list-return-value)))) |
59ca07b5 RS |
1040 | |
1041 | \f | |
b578f267 EN |
1042 | ;;----------------------------------------------- |
1043 | ;; Updating the database | |
1044 | ;;----------------------------------------------- | |
1045 | ;; | |
1046 | ;; These are the internal functions used to update the datebase | |
1047 | ;; | |
1048 | ;; | |
36cc948e SM |
1049 | (defvar completion-to-accept nil |
1050 | "Set to a string that is pending its acceptance.") | |
59ca07b5 RS |
1051 | ;; this checked by the top level reading functions |
1052 | ||
36cc948e SM |
1053 | (defvar cmpl-db-downcase-string nil |
1054 | "Setup by `find-exact-completion', etc. The given string, downcased.") | |
1055 | (defvar cmpl-db-symbol nil | |
1056 | "The interned symbol corresponding to `cmpl-db-downcase-string'. | |
1057 | Set up by `cmpl-db-symbol'.") | |
1058 | (defvar cmpl-db-prefix-symbol nil | |
1059 | "The interned prefix symbol corresponding to `cmpl-db-downcase-string'.") | |
59ca07b5 RS |
1060 | (defvar cmpl-db-entry nil) |
1061 | (defvar cmpl-db-debug-p nil | |
0ff9b955 | 1062 | "Set to t if you want to debug the database.") |
59ca07b5 | 1063 | |
b578f267 | 1064 | ;; READS |
59ca07b5 | 1065 | (defun find-exact-completion (string) |
d2c49fd8 | 1066 | "Return the completion entry for STRING or nil. |
a7a2b1f6 | 1067 | Sets up `cmpl-db-downcase-string' and `cmpl-db-symbol'." |
59ca07b5 RS |
1068 | (and (boundp (setq cmpl-db-symbol |
1069 | (intern (setq cmpl-db-downcase-string (downcase string)) | |
1070 | cmpl-obarray))) | |
d2c49fd8 | 1071 | (symbol-value cmpl-db-symbol))) |
59ca07b5 RS |
1072 | |
1073 | (defun find-cmpl-prefix-entry (prefix-string) | |
d2c49fd8 | 1074 | "Return the prefix entry for string. |
a7a2b1f6 RS |
1075 | Sets `cmpl-db-prefix-symbol'. |
1076 | Prefix-string must be exactly `completion-prefix-min-length' long | |
1077 | and downcased. Sets up `cmpl-db-prefix-symbol'." | |
59ca07b5 RS |
1078 | (and (boundp (setq cmpl-db-prefix-symbol |
1079 | (intern prefix-string cmpl-prefix-obarray))) | |
1080 | (symbol-value cmpl-db-prefix-symbol))) | |
1081 | ||
1082 | (defvar inside-locate-completion-entry nil) | |
1083 | ;; used to trap lossage in silent error correction | |
1084 | ||
1085 | (defun locate-completion-entry (completion-entry prefix-entry) | |
d2c49fd8 | 1086 | "Locate the completion entry. |
c2ced5d8 CZ |
1087 | Returns a pointer to the element before the completion entry or nil if |
1088 | the completion entry is at the head. | |
a7a2b1f6 | 1089 | Must be called after `find-exact-completion'." |
59ca07b5 | 1090 | (let ((prefix-list (cmpl-prefix-entry-head prefix-entry)) |
d2c49fd8 | 1091 | next-prefix-list) |
59ca07b5 RS |
1092 | (cond |
1093 | ((not (eq (car prefix-list) completion-entry)) | |
1094 | ;; not already at head | |
1095 | (while (and prefix-list | |
1096 | (not (eq completion-entry | |
d2c49fd8 | 1097 | (car (setq next-prefix-list (cdr prefix-list)))))) |
59ca07b5 RS |
1098 | (setq prefix-list next-prefix-list)) |
1099 | (cond (;; found | |
1100 | prefix-list) | |
1101 | ;; Didn't find it. Database is messed up. | |
1102 | (cmpl-db-debug-p | |
1103 | ;; not found, error if debug mode | |
1104 | (error "Completion entry exists but not on prefix list - %s" | |
136f8f67 | 1105 | completion-string)) |
59ca07b5 RS |
1106 | (inside-locate-completion-entry |
1107 | ;; recursive error: really scrod | |
1108 | (locate-completion-db-error)) | |
1109 | (t | |
1110 | ;; Patch out | |
1111 | (set cmpl-db-symbol nil) | |
1112 | ;; Retry | |
d2c49fd8 | 1113 | (locate-completion-entry-retry completion-entry))))))) |
59ca07b5 RS |
1114 | |
1115 | (defun locate-completion-entry-retry (old-entry) | |
1116 | (let ((inside-locate-completion-entry t)) | |
1117 | (add-completion (completion-string old-entry) | |
1118 | (completion-num-uses old-entry) | |
1119 | (completion-last-use-time old-entry)) | |
136f8f67 RS |
1120 | (let* ((cmpl-entry (find-exact-completion (completion-string old-entry))) |
1121 | (pref-entry | |
1122 | (if cmpl-entry | |
1123 | (find-cmpl-prefix-entry | |
1124 | (substring cmpl-db-downcase-string | |
d2c49fd8 | 1125 | 0 completion-prefix-min-length))))) |
59ca07b5 RS |
1126 | (if (and cmpl-entry pref-entry) |
1127 | ;; try again | |
1128 | (locate-completion-entry cmpl-entry pref-entry) | |
1129 | ;; still losing | |
d2c49fd8 | 1130 | (locate-completion-db-error))))) |
59ca07b5 RS |
1131 | |
1132 | (defun locate-completion-db-error () | |
1133 | ;; recursive error: really scrod | |
55535639 | 1134 | (error "Completion database corrupted. Try M-x clear-all-completions. Send bug report")) |
59ca07b5 | 1135 | |
b578f267 | 1136 | ;; WRITES |
59ca07b5 | 1137 | (defun add-completion-to-tail-if-new (string) |
c2ced5d8 | 1138 | "If STRING is not in the database add it to appropriate prefix list. |
eb8c3be9 | 1139 | STRING is added to the end of the appropriate prefix list with |
c2ced5d8 | 1140 | num-uses = 0. The database is unchanged if it is there. STRING must be |
a7a2b1f6 | 1141 | longer than `completion-prefix-min-length'. |
59ca07b5 RS |
1142 | This must be very fast. |
1143 | Returns the completion entry." | |
1144 | (or (find-exact-completion string) | |
1145 | ;; not there | |
1146 | (let (;; create an entry | |
36cc948e | 1147 | (entry (list (make-completion string))) |
59ca07b5 RS |
1148 | ;; setup the prefix |
1149 | (prefix-entry (find-cmpl-prefix-entry | |
1150 | (substring cmpl-db-downcase-string 0 | |
7975cb9f | 1151 | completion-prefix-min-length)))) |
59ca07b5 RS |
1152 | ;; The next two forms should happen as a unit (atomically) but |
1153 | ;; no fatal errors should result if that is not the case. | |
1154 | (cond (prefix-entry | |
1155 | ;; These two should be atomic, but nothing fatal will happen | |
1156 | ;; if they're not. | |
1157 | (setcdr (cmpl-prefix-entry-tail prefix-entry) entry) | |
1158 | (set-cmpl-prefix-entry-tail prefix-entry entry)) | |
1159 | (t | |
d2c49fd8 | 1160 | (set cmpl-db-prefix-symbol (make-cmpl-prefix-entry entry)))) |
59ca07b5 RS |
1161 | ;; statistics |
1162 | (cmpl-statistics-block | |
1163 | (note-added-completion)) | |
1164 | ;; set symbol | |
d2c49fd8 | 1165 | (set cmpl-db-symbol (car entry))))) |
59ca07b5 | 1166 | |
136f8f67 RS |
1167 | (defun add-completion-to-head (completion-string) |
1168 | "If COMPLETION-STRING is not in the database, add it to prefix list. | |
1169 | We add COMPLETION-STRING to the head of the appropriate prefix list, | |
1170 | or it to the head of the list. | |
1171 | COMPLETION-STRING must be longer than `completion-prefix-min-length'. | |
59ca07b5 RS |
1172 | Updates the saved string with the supplied string. |
1173 | This must be very fast. | |
1174 | Returns the completion entry." | |
1175 | ;; Handle pending acceptance | |
1176 | (if completion-to-accept (accept-completion)) | |
1177 | ;; test if already in database | |
136f8f67 | 1178 | (if (setq cmpl-db-entry (find-exact-completion completion-string)) |
59ca07b5 RS |
1179 | ;; found |
1180 | (let* ((prefix-entry (find-cmpl-prefix-entry | |
1181 | (substring cmpl-db-downcase-string 0 | |
7975cb9f | 1182 | completion-prefix-min-length))) |
59ca07b5 | 1183 | (splice-ptr (locate-completion-entry cmpl-db-entry prefix-entry)) |
d2c49fd8 | 1184 | (cmpl-ptr (cdr splice-ptr))) |
59ca07b5 | 1185 | ;; update entry |
136f8f67 | 1186 | (set-completion-string cmpl-db-entry completion-string) |
59ca07b5 RS |
1187 | ;; move to head (if necessary) |
1188 | (cond (splice-ptr | |
1189 | ;; These should all execute atomically but it is not fatal if | |
1190 | ;; they don't. | |
1191 | ;; splice it out | |
1192 | (or (setcdr splice-ptr (cdr cmpl-ptr)) | |
1193 | ;; fix up tail if necessary | |
1194 | (set-cmpl-prefix-entry-tail prefix-entry splice-ptr)) | |
1195 | ;; splice in at head | |
1196 | (setcdr cmpl-ptr (cmpl-prefix-entry-head prefix-entry)) | |
d2c49fd8 | 1197 | (set-cmpl-prefix-entry-head prefix-entry cmpl-ptr))) |
59ca07b5 RS |
1198 | cmpl-db-entry) |
1199 | ;; not there | |
1200 | (let (;; create an entry | |
36cc948e | 1201 | (entry (list (make-completion completion-string))) |
59ca07b5 RS |
1202 | ;; setup the prefix |
1203 | (prefix-entry (find-cmpl-prefix-entry | |
1204 | (substring cmpl-db-downcase-string 0 | |
7975cb9f | 1205 | completion-prefix-min-length)))) |
59ca07b5 RS |
1206 | (cond (prefix-entry |
1207 | ;; Splice in at head | |
1208 | (setcdr entry (cmpl-prefix-entry-head prefix-entry)) | |
1209 | (set-cmpl-prefix-entry-head prefix-entry entry)) | |
1210 | (t | |
1211 | ;; Start new prefix entry | |
d2c49fd8 | 1212 | (set cmpl-db-prefix-symbol (make-cmpl-prefix-entry entry)))) |
59ca07b5 RS |
1213 | ;; statistics |
1214 | (cmpl-statistics-block | |
1215 | (note-added-completion)) | |
1216 | ;; Add it to the symbol | |
d2c49fd8 | 1217 | (set cmpl-db-symbol (car entry))))) |
71296446 | 1218 | |
136f8f67 | 1219 | (defun delete-completion (completion-string) |
d2c49fd8 | 1220 | "Delete the completion from the database. |
a7a2b1f6 | 1221 | String must be longer than `completion-prefix-min-length'." |
59ca07b5 RS |
1222 | ;; Handle pending acceptance |
1223 | (if completion-to-accept (accept-completion)) | |
136f8f67 | 1224 | (if (setq cmpl-db-entry (find-exact-completion completion-string)) |
59ca07b5 | 1225 | ;; found |
71296446 | 1226 | (let* ((prefix-entry (find-cmpl-prefix-entry |
59ca07b5 | 1227 | (substring cmpl-db-downcase-string 0 |
7975cb9f | 1228 | completion-prefix-min-length))) |
d2c49fd8 | 1229 | (splice-ptr (locate-completion-entry cmpl-db-entry prefix-entry))) |
59ca07b5 RS |
1230 | ;; delete symbol reference |
1231 | (set cmpl-db-symbol nil) | |
1232 | ;; remove from prefix list | |
1233 | (cond (splice-ptr | |
1234 | ;; not at head | |
1235 | (or (setcdr splice-ptr (cdr (cdr splice-ptr))) | |
1236 | ;; fix up tail if necessary | |
d2c49fd8 | 1237 | (set-cmpl-prefix-entry-tail prefix-entry splice-ptr))) |
59ca07b5 RS |
1238 | (t |
1239 | ;; at head | |
1240 | (or (set-cmpl-prefix-entry-head | |
1241 | prefix-entry (cdr (cmpl-prefix-entry-head prefix-entry))) | |
1242 | ;; List is now empty | |
d2c49fd8 | 1243 | (set cmpl-db-prefix-symbol nil)))) |
59ca07b5 | 1244 | (cmpl-statistics-block |
d2c49fd8 DL |
1245 | (note-completion-deleted))) |
1246 | (error "Unknown completion `%s'" completion-string))) | |
59ca07b5 | 1247 | |
b578f267 EN |
1248 | ;; Tests -- |
1249 | ;; - Add and Find - | |
1250 | ;; (add-completion-to-head "banana") --> ("banana" 0 nil 0) | |
1251 | ;; (find-exact-completion "banana") --> ("banana" 0 nil 0) | |
1252 | ;; (find-exact-completion "bana") --> nil | |
1253 | ;; (car (find-cmpl-prefix-entry "ban")) --> (("banana" ...)) | |
1254 | ;; (cdr (find-cmpl-prefix-entry "ban")) --> (("banana" ...)) | |
1255 | ;; (add-completion-to-head "banish") --> ("banish" 0 nil 0) | |
1256 | ;; (find-exact-completion "banish") --> ("banish" 0 nil 0) | |
1257 | ;; (car (find-cmpl-prefix-entry "ban")) --> (("banish" ...) ("banana" ...)) | |
1258 | ;; (cdr (find-cmpl-prefix-entry "ban")) --> (("banana" ...)) | |
1259 | ;; (add-completion-to-head "banana") --> ("banana" 0 nil 0) | |
1260 | ;; (car (find-cmpl-prefix-entry "ban")) --> (("banana" ...) ("banish" ...)) | |
1261 | ;; (cdr (find-cmpl-prefix-entry "ban")) --> (("banish" ...)) | |
1262 | ;; | |
1263 | ;; - Deleting - | |
1264 | ;; (add-completion-to-head "banner") --> ("banner" 0 nil 0) | |
71296446 | 1265 | ;; (delete-completion "banner") |
b578f267 EN |
1266 | ;; (find-exact-completion "banner") --> nil |
1267 | ;; (car (find-cmpl-prefix-entry "ban")) --> (("banana" ...) ("banish" ...)) | |
1268 | ;; (cdr (find-cmpl-prefix-entry "ban")) --> (("banish" ...)) | |
71296446 JB |
1269 | ;; (add-completion-to-head "banner") --> ("banner" 0 nil 0) |
1270 | ;; (delete-completion "banana") | |
b578f267 EN |
1271 | ;; (car (find-cmpl-prefix-entry "ban")) --> (("banner" ...) ("banish" ...)) |
1272 | ;; (cdr (find-cmpl-prefix-entry "ban")) --> (("banish" ...)) | |
71296446 JB |
1273 | ;; (delete-completion "banner") |
1274 | ;; (delete-completion "banish") | |
b578f267 EN |
1275 | ;; (find-cmpl-prefix-entry "ban") --> nil |
1276 | ;; (delete-completion "banner") --> error | |
1277 | ;; | |
1278 | ;; - Tail - | |
1279 | ;; (add-completion-to-tail-if-new "banana") --> ("banana" 0 nil 0) | |
1280 | ;; (car (find-cmpl-prefix-entry "ban")) --> (("banana" ...)) | |
1281 | ;; (cdr (find-cmpl-prefix-entry "ban")) --> (("banana" ...)) | |
1282 | ;; (add-completion-to-tail-if-new "banish") --> ("banish" 0 nil 0) | |
1283 | ;; (car (find-cmpl-prefix-entry "ban")) -->(("banana" ...) ("banish" ...)) | |
1284 | ;; (cdr (find-cmpl-prefix-entry "ban")) -->(("banish" ...)) | |
1285 | ;; | |
59ca07b5 RS |
1286 | |
1287 | \f | |
b578f267 EN |
1288 | ;;--------------------------------------------------------------------------- |
1289 | ;; Database Update :: Interface level routines | |
1290 | ;;--------------------------------------------------------------------------- | |
71296446 | 1291 | ;; |
b578f267 EN |
1292 | ;; These lie on top of the database ref. functions but below the standard |
1293 | ;; user interface level | |
59ca07b5 RS |
1294 | |
1295 | ||
1296 | (defun interactive-completion-string-reader (prompt) | |
1297 | (let* ((default (symbol-under-or-before-point)) | |
1298 | (new-prompt | |
1299 | (if default | |
5b76833f | 1300 | (format "%s (default %s): " prompt default) |
d2c49fd8 DL |
1301 | (format "%s: " prompt))) |
1302 | (read (completing-read new-prompt cmpl-obarray))) | |
59ca07b5 | 1303 | (if (zerop (length read)) (setq read (or default ""))) |
d2c49fd8 | 1304 | (list read))) |
59ca07b5 RS |
1305 | |
1306 | (defun check-completion-length (string) | |
a7a2b1f6 | 1307 | (if (< (length string) completion-min-length) |
136f8f67 | 1308 | (error "The string `%s' is too short to be saved as a completion" |
59ca07b5 RS |
1309 | string) |
1310 | (list string))) | |
1311 | ||
1312 | (defun add-completion (string &optional num-uses last-use-time) | |
a7a2b1f6 | 1313 | "Add STRING to completion list, or move it to head of list. |
71296446 | 1314 | The completion is altered appropriately if num-uses and/or last-use-time is |
59ca07b5 RS |
1315 | specified." |
1316 | (interactive (interactive-completion-string-reader "Completion to add")) | |
1317 | (check-completion-length string) | |
1318 | (let* ((current-completion-source (if (interactive-p) | |
1319 | cmpl-source-interactive | |
1320 | current-completion-source)) | |
1321 | (entry (add-completion-to-head string))) | |
71296446 | 1322 | |
59ca07b5 RS |
1323 | (if num-uses (set-completion-num-uses entry num-uses)) |
1324 | (if last-use-time | |
d2c49fd8 | 1325 | (set-completion-last-use-time entry last-use-time)))) |
59ca07b5 RS |
1326 | |
1327 | (defun add-permanent-completion (string) | |
a7a2b1f6 | 1328 | "Add STRING if it isn't already listed, and mark it permanent." |
59ca07b5 RS |
1329 | (interactive |
1330 | (interactive-completion-string-reader "Completion to add permanently")) | |
1331 | (let ((current-completion-source (if (interactive-p) | |
1332 | cmpl-source-interactive | |
d2c49fd8 DL |
1333 | current-completion-source))) |
1334 | (add-completion string nil t))) | |
59ca07b5 RS |
1335 | |
1336 | (defun kill-completion (string) | |
1337 | (interactive (interactive-completion-string-reader "Completion to kill")) | |
1338 | (check-completion-length string) | |
d2c49fd8 | 1339 | (delete-completion string)) |
59ca07b5 RS |
1340 | |
1341 | (defun accept-completion () | |
a7a2b1f6 | 1342 | "Accepts the pending completion in `completion-to-accept'. |
71296446 | 1343 | This bumps num-uses. Called by `add-completion-to-head' and |
a7a2b1f6 | 1344 | `completion-search-reset'." |
59ca07b5 RS |
1345 | (let ((string completion-to-accept) |
1346 | ;; if this is added afresh here, then it must be a cdabbrev | |
1347 | (current-completion-source cmpl-source-cdabbrev) | |
d2c49fd8 | 1348 | entry) |
59ca07b5 RS |
1349 | (setq completion-to-accept nil) |
1350 | (setq entry (add-completion-to-head string)) | |
1351 | (set-completion-num-uses entry (1+ (completion-num-uses entry))) | |
d2c49fd8 | 1352 | (setq cmpl-completions-accepted-p t))) |
59ca07b5 RS |
1353 | |
1354 | (defun use-completion-under-point () | |
a7a2b1f6 RS |
1355 | "Add the completion symbol underneath the point into the completion buffer." |
1356 | (let ((string (and enable-completion (symbol-under-point))) | |
59ca07b5 RS |
1357 | (current-completion-source cmpl-source-cursor-moves)) |
1358 | (if string (add-completion-to-head string)))) | |
71296446 | 1359 | |
59ca07b5 | 1360 | (defun use-completion-before-point () |
a7a2b1f6 RS |
1361 | "Add the completion symbol before point into the completion buffer." |
1362 | (let ((string (and enable-completion (symbol-before-point))) | |
59ca07b5 RS |
1363 | (current-completion-source cmpl-source-cursor-moves)) |
1364 | (if string (add-completion-to-head string)))) | |
1365 | ||
1366 | (defun use-completion-under-or-before-point () | |
a7a2b1f6 RS |
1367 | "Add the completion symbol before point into the completion buffer." |
1368 | (let ((string (and enable-completion (symbol-under-or-before-point))) | |
59ca07b5 RS |
1369 | (current-completion-source cmpl-source-cursor-moves)) |
1370 | (if string (add-completion-to-head string)))) | |
1371 | ||
1372 | (defun use-completion-before-separator () | |
a7a2b1f6 | 1373 | "Add the completion symbol before point into the completion buffer. |
c2ced5d8 | 1374 | Completions added this way will automatically be saved if |
a7a2b1f6 RS |
1375 | `completion-on-separator-character' is non-nil." |
1376 | (let ((string (and enable-completion (symbol-before-point))) | |
59ca07b5 RS |
1377 | (current-completion-source cmpl-source-separator) |
1378 | entry) | |
1379 | (cmpl-statistics-block | |
d2c49fd8 | 1380 | (note-separator-character string)) |
59ca07b5 RS |
1381 | (cond (string |
1382 | (setq entry (add-completion-to-head string)) | |
136f8f67 | 1383 | (if (and completion-on-separator-character |
59ca07b5 | 1384 | (zerop (completion-num-uses entry))) |
136f8f67 RS |
1385 | (progn |
1386 | (set-completion-num-uses entry 1) | |
d2c49fd8 | 1387 | (setq cmpl-completions-accepted-p t))))))) |
59ca07b5 | 1388 | |
b578f267 EN |
1389 | ;; Tests -- |
1390 | ;; - Add and Find - | |
71296446 | 1391 | ;; (add-completion "banana" 5 10) |
b578f267 | 1392 | ;; (find-exact-completion "banana") --> ("banana" 5 10 0) |
71296446 | 1393 | ;; (add-completion "banana" 6) |
b578f267 EN |
1394 | ;; (find-exact-completion "banana") --> ("banana" 6 10 0) |
1395 | ;; (add-completion "banish") | |
1396 | ;; (car (find-cmpl-prefix-entry "ban")) --> (("banish" ...) ("banana" ...)) | |
1397 | ;; | |
1398 | ;; - Accepting - | |
1399 | ;; (setq completion-to-accept "banana") | |
71296446 | 1400 | ;; (accept-completion) |
b578f267 EN |
1401 | ;; (find-exact-completion "banana") --> ("banana" 7 10) |
1402 | ;; (car (find-cmpl-prefix-entry "ban")) --> (("banana" ...) ("banish" ...)) | |
1403 | ;; (setq completion-to-accept "banish") | |
71296446 | 1404 | ;; (add-completion "banner") |
b578f267 EN |
1405 | ;; (car (find-cmpl-prefix-entry "ban")) |
1406 | ;; --> (("banner" ...) ("banish" 1 ...) ("banana" 7 ...)) | |
1407 | ;; | |
1408 | ;; - Deleting - | |
71296446 | 1409 | ;; (kill-completion "banish") |
b578f267 | 1410 | ;; (car (find-cmpl-prefix-entry "ban")) --> (("banner" ...) ("banana" ...)) |
59ca07b5 RS |
1411 | |
1412 | \f | |
b578f267 EN |
1413 | ;;--------------------------------------------------------------------------- |
1414 | ;; Searching the database | |
1415 | ;;--------------------------------------------------------------------------- | |
1416 | ;; Functions outside this block must call completion-search-reset followed | |
1417 | ;; by calls to completion-search-next or completion-search-peek | |
1418 | ;; | |
1419 | ||
1420 | ;; Status variables | |
59ca07b5 RS |
1421 | ;; Commented out to improve loading speed |
1422 | (defvar cmpl-test-string "") | |
1423 | ;; "The current string used by completion-search-next." | |
1424 | (defvar cmpl-test-regexp "") | |
71296446 | 1425 | ;; "The current regexp used by completion-search-next. |
59ca07b5 RS |
1426 | ;; (derived from cmpl-test-string)" |
1427 | (defvar cmpl-last-index 0) | |
1428 | ;; "The last index that completion-search-next was called with." | |
1429 | (defvar cmpl-cdabbrev-reset-p nil) | |
1430 | ;; "Set to t when cdabbrevs have been reset." | |
1431 | (defvar cmpl-next-possibilities nil) | |
1432 | ;; "A pointer to the element BEFORE the next set of possible completions. | |
1433 | ;; cadr of this is the cmpl-next-possibility" | |
1434 | (defvar cmpl-starting-possibilities nil) | |
1435 | ;; "The initial list of starting possibilities." | |
1436 | (defvar cmpl-next-possibility nil) | |
1437 | ;; "The cached next possibility." | |
1438 | (defvar cmpl-tried-list nil) | |
1439 | ;; "A downcased list of all the completions we have tried." | |
1440 | ||
1441 | ||
1442 | (defun completion-search-reset (string) | |
a7a2b1f6 RS |
1443 | "Set up the for completion searching for STRING. |
1444 | STRING must be longer than `completion-prefix-min-length'." | |
59ca07b5 RS |
1445 | (if completion-to-accept (accept-completion)) |
1446 | (setq cmpl-starting-possibilities | |
1447 | (cmpl-prefix-entry-head | |
46f950ca RS |
1448 | (find-cmpl-prefix-entry |
1449 | (downcase (substring string 0 completion-prefix-min-length)))) | |
59ca07b5 RS |
1450 | cmpl-test-string string |
1451 | cmpl-test-regexp (concat (regexp-quote string) ".")) | |
d2c49fd8 | 1452 | (completion-search-reset-1)) |
59ca07b5 RS |
1453 | |
1454 | (defun completion-search-reset-1 () | |
1455 | (setq cmpl-next-possibilities cmpl-starting-possibilities | |
1456 | cmpl-next-possibility nil | |
1457 | cmpl-cdabbrev-reset-p nil | |
1458 | cmpl-last-index -1 | |
d2c49fd8 | 1459 | cmpl-tried-list nil)) |
59ca07b5 RS |
1460 | |
1461 | (defun completion-search-next (index) | |
a7a2b1f6 RS |
1462 | "Return the next completion entry. |
1463 | If INDEX is out of sequence, reset and start from the top. | |
1464 | If there are no more entries, try cdabbrev and returns only a string." | |
59ca07b5 RS |
1465 | (cond |
1466 | ((= index (setq cmpl-last-index (1+ cmpl-last-index))) | |
1467 | (completion-search-peek t)) | |
136f8f67 | 1468 | ((< index 0) |
59ca07b5 RS |
1469 | (completion-search-reset-1) |
1470 | (setq cmpl-last-index index) | |
1471 | ;; reverse the possibilities list | |
1472 | (setq cmpl-next-possibilities (reverse cmpl-starting-possibilities)) | |
1473 | ;; do a "normal" search | |
1474 | (while (and (completion-search-peek nil) | |
136f8f67 | 1475 | (< (setq index (1+ index)) 0)) |
d2c49fd8 | 1476 | (setq cmpl-next-possibility nil)) |
59ca07b5 RS |
1477 | (cond ((not cmpl-next-possibilities)) |
1478 | ;; If no more possibilities, leave it that way | |
1479 | ((= -1 cmpl-last-index) | |
71296446 | 1480 | ;; next completion is at index 0. reset next-possibility list |
59ca07b5 RS |
1481 | ;; to start at beginning |
1482 | (setq cmpl-next-possibilities cmpl-starting-possibilities)) | |
1483 | (t | |
1484 | ;; otherwise point to one before current | |
1485 | (setq cmpl-next-possibilities | |
1486 | (nthcdr (- (length cmpl-starting-possibilities) | |
1487 | (length cmpl-next-possibilities)) | |
d2c49fd8 | 1488 | cmpl-starting-possibilities))))) |
59ca07b5 RS |
1489 | (t |
1490 | ;; non-negative index, reset and search | |
1491 | ;;(prin1 'reset) | |
1492 | (completion-search-reset-1) | |
1493 | (setq cmpl-last-index index) | |
1494 | (while (and (completion-search-peek t) | |
136f8f67 | 1495 | (not (< (setq index (1- index)) 0))) |
d2c49fd8 | 1496 | (setq cmpl-next-possibility nil)))) |
59ca07b5 RS |
1497 | (prog1 |
1498 | cmpl-next-possibility | |
d2c49fd8 | 1499 | (setq cmpl-next-possibility nil))) |
71296446 | 1500 | |
59ca07b5 RS |
1501 | |
1502 | (defun completion-search-peek (use-cdabbrev) | |
7975cb9f | 1503 | "Return the next completion entry without actually moving the pointers. |
71296446 | 1504 | Calling this again or calling `completion-search-next' results in the same |
a7a2b1f6 RS |
1505 | string being returned. Depends on `case-fold-search'. |
1506 | If there are no more entries, try cdabbrev and then return only a string." | |
59ca07b5 RS |
1507 | (cond |
1508 | ;; return the cached value if we have it | |
1509 | (cmpl-next-possibility) | |
1510 | ((and cmpl-next-possibilities | |
1511 | ;; still a few possibilities left | |
1512 | (progn | |
1513 | (while | |
1514 | (and (not (eq 0 (string-match cmpl-test-regexp | |
1515 | (completion-string (car cmpl-next-possibilities))))) | |
d2c49fd8 DL |
1516 | (setq cmpl-next-possibilities (cdr cmpl-next-possibilities)))) |
1517 | cmpl-next-possibilities)) | |
59ca07b5 RS |
1518 | ;; successful match |
1519 | (setq cmpl-next-possibility (car cmpl-next-possibilities) | |
1520 | cmpl-tried-list (cons (downcase (completion-string cmpl-next-possibility)) | |
1521 | cmpl-tried-list) | |
d2c49fd8 | 1522 | cmpl-next-possibilities (cdr cmpl-next-possibilities)) |
59ca07b5 RS |
1523 | cmpl-next-possibility) |
1524 | (use-cdabbrev | |
1525 | ;; unsuccessful, use cdabbrev | |
1526 | (cond ((not cmpl-cdabbrev-reset-p) | |
1527 | (reset-cdabbrev cmpl-test-string cmpl-tried-list) | |
d2c49fd8 DL |
1528 | (setq cmpl-cdabbrev-reset-p t))) |
1529 | (setq cmpl-next-possibility (next-cdabbrev))) | |
59ca07b5 RS |
1530 | ;; Completely unsuccessful, return nil |
1531 | )) | |
1532 | ||
b578f267 EN |
1533 | ;; Tests -- |
1534 | ;; - Add and Find - | |
71296446 JB |
1535 | ;; (add-completion "banana") |
1536 | ;; (completion-search-reset "ban") | |
b578f267 EN |
1537 | ;; (completion-search-next 0) --> "banana" |
1538 | ;; | |
1539 | ;; - Discrimination - | |
71296446 JB |
1540 | ;; (add-completion "cumberland") |
1541 | ;; (add-completion "cumberbund") | |
1542 | ;; cumbering | |
b578f267 EN |
1543 | ;; (completion-search-reset "cumb") |
1544 | ;; (completion-search-peek t) --> "cumberbund" | |
1545 | ;; (completion-search-next 0) --> "cumberbund" | |
1546 | ;; (completion-search-peek t) --> "cumberland" | |
1547 | ;; (completion-search-next 1) --> "cumberland" | |
1548 | ;; (completion-search-peek nil) --> nil | |
1549 | ;; (completion-search-next 2) --> "cumbering" {cdabbrev} | |
1550 | ;; (completion-search-next 3) --> nil or "cumming"{depends on context} | |
1551 | ;; (completion-search-next 1) --> "cumberland" | |
1552 | ;; (completion-search-peek t) --> "cumbering" {cdabbrev} | |
1553 | ;; | |
1554 | ;; - Accepting - | |
1555 | ;; (completion-search-next 1) --> "cumberland" | |
1556 | ;; (setq completion-to-accept "cumberland") | |
1557 | ;; (completion-search-reset "foo") | |
1558 | ;; (completion-search-reset "cum") | |
1559 | ;; (completion-search-next 0) --> "cumberland" | |
1560 | ;; | |
1561 | ;; - Deleting - | |
1562 | ;; (kill-completion "cumberland") | |
71296446 | 1563 | ;; cummings |
b578f267 EN |
1564 | ;; (completion-search-reset "cum") |
1565 | ;; (completion-search-next 0) --> "cumberbund" | |
1566 | ;; (completion-search-next 1) --> "cummings" | |
1567 | ;; | |
1568 | ;; - Ignoring Capitalization - | |
1569 | ;; (completion-search-reset "CuMb") | |
1570 | ;; (completion-search-next 0) --> "cumberbund" | |
59ca07b5 RS |
1571 | |
1572 | ||
1573 | \f | |
b578f267 EN |
1574 | ;;----------------------------------------------- |
1575 | ;; COMPLETE | |
1576 | ;;----------------------------------------------- | |
59ca07b5 RS |
1577 | |
1578 | (defun completion-mode () | |
d2c49fd8 | 1579 | "Toggle whether or not to add new words to the completion database." |
59ca07b5 | 1580 | (interactive) |
a7a2b1f6 | 1581 | (setq enable-completion (not enable-completion)) |
d2c49fd8 | 1582 | (message "Completion mode is now %s." (if enable-completion "ON" "OFF"))) |
71296446 | 1583 | |
59ca07b5 RS |
1584 | (defvar cmpl-current-index 0) |
1585 | (defvar cmpl-original-string nil) | |
1586 | (defvar cmpl-last-insert-location -1) | |
1587 | (defvar cmpl-leave-point-at-start nil) | |
1588 | ||
1589 | (defun complete (&optional arg) | |
71296446 | 1590 | "Fill out a completion of the word before point. |
eb8c3be9 | 1591 | Point is left at end. Consecutive calls rotate through all possibilities. |
59ca07b5 | 1592 | Prefix args :: |
71296446 | 1593 | control-u :: leave the point at the beginning of the completion rather |
59ca07b5 RS |
1594 | than at the end. |
1595 | a number :: rotate through the possible completions by that amount | |
1596 | `-' :: same as -1 (insert previous completion) | |
a7a2b1f6 | 1597 | {See the comments at the top of `completion.el' for more info.}" |
59ca07b5 RS |
1598 | (interactive "*p") |
1599 | ;;; Set up variables | |
1600 | (cond ((eq last-command this-command) | |
1601 | ;; Undo last one | |
1602 | (delete-region cmpl-last-insert-location (point)) | |
1603 | ;; get next completion | |
d2c49fd8 | 1604 | (setq cmpl-current-index (+ cmpl-current-index (or arg 1)))) |
59ca07b5 RS |
1605 | (t |
1606 | (if (not cmpl-initialized-p) | |
36cc948e | 1607 | (completion-initialize)) ;; make sure everything's loaded |
59ca07b5 RS |
1608 | (cond ((consp current-prefix-arg) ;; control-u |
1609 | (setq arg 0) | |
d2c49fd8 | 1610 | (setq cmpl-leave-point-at-start t)) |
59ca07b5 | 1611 | (t |
d2c49fd8 | 1612 | (setq cmpl-leave-point-at-start nil))) |
59ca07b5 RS |
1613 | ;; get string |
1614 | (setq cmpl-original-string (symbol-before-point-for-complete)) | |
1615 | (cond ((not cmpl-original-string) | |
1616 | (setq this-command 'failed-complete) | |
136f8f67 | 1617 | (error "To complete, point must be after a symbol at least %d character long" |
a7a2b1f6 | 1618 | completion-prefix-min-length))) |
71296446 | 1619 | ;; get index |
59ca07b5 RS |
1620 | (setq cmpl-current-index (if current-prefix-arg arg 0)) |
1621 | ;; statistics | |
1622 | (cmpl-statistics-block | |
1623 | (note-complete-entered-afresh cmpl-original-string)) | |
1624 | ;; reset database | |
1625 | (completion-search-reset cmpl-original-string) | |
1626 | ;; erase what we've got | |
d2c49fd8 | 1627 | (delete-region cmpl-symbol-start cmpl-symbol-end))) |
59ca07b5 RS |
1628 | |
1629 | ;; point is at the point to insert the new symbol | |
1630 | ;; Get the next completion | |
1631 | (let* ((print-status-p | |
a7a2b1f6 | 1632 | (and (>= baud-rate completion-prompt-speed-threshold) |
7975cb9f | 1633 | (not (window-minibuffer-p (selected-window))))) |
59ca07b5 RS |
1634 | (insert-point (point)) |
1635 | (entry (completion-search-next cmpl-current-index)) | |
d2c49fd8 | 1636 | string) |
59ca07b5 RS |
1637 | ;; entry is either a completion entry or a string (if cdabbrev) |
1638 | ||
1639 | ;; If found, insert | |
1640 | (cond (entry | |
1641 | ;; Setup for proper case | |
1642 | (setq string (if (stringp entry) | |
1643 | entry (completion-string entry))) | |
1644 | (setq string (cmpl-merge-string-cases | |
1645 | string cmpl-original-string)) | |
1646 | ;; insert | |
1647 | (insert string) | |
1648 | ;; accept it | |
1649 | (setq completion-to-accept string) | |
1650 | ;; fixup and cache point | |
1651 | (cond (cmpl-leave-point-at-start | |
1652 | (setq cmpl-last-insert-location (point)) | |
1653 | (goto-char insert-point)) | |
1654 | (t;; point at end, | |
d2c49fd8 | 1655 | (setq cmpl-last-insert-location insert-point))) |
59ca07b5 RS |
1656 | ;; statistics |
1657 | (cmpl-statistics-block | |
1658 | (note-complete-inserted entry cmpl-current-index)) | |
1659 | ;; Done ! cmpl-stat-complete-successful | |
1660 | ;;display the next completion | |
1661 | (cond | |
1662 | ((and print-status-p | |
1663 | ;; This updates the display and only prints if there | |
1664 | ;; is no typeahead | |
a7a2b1f6 | 1665 | (sit-for 0) |
59ca07b5 RS |
1666 | (setq entry |
1667 | (completion-search-peek | |
a7a2b1f6 | 1668 | completion-cdabbrev-prompt-flag))) |
59ca07b5 RS |
1669 | (setq string (if (stringp entry) |
1670 | entry (completion-string entry))) | |
1671 | (setq string (cmpl-merge-string-cases | |
1672 | string cmpl-original-string)) | |
d2c49fd8 | 1673 | (message "Next completion: %s" string)))) |
71296446 | 1674 | (t;; none found, insert old |
59ca07b5 RS |
1675 | (insert cmpl-original-string) |
1676 | ;; Don't accept completions | |
1677 | (setq completion-to-accept nil) | |
1678 | ;; print message | |
23b97eb9 RS |
1679 | ;; This used to call cmpl19-sit-for, an undefined function. |
1680 | ;; I hope that sit-for does the right thing; I don't know -- rms. | |
1681 | (if (and print-status-p (sit-for 0)) | |
59ca07b5 RS |
1682 | (message "No %scompletions." |
1683 | (if (eq this-command last-command) "more " ""))) | |
1684 | ;; statistics | |
1685 | (cmpl-statistics-block | |
1686 | (record-complete-failed cmpl-current-index)) | |
1687 | ;; Pretend that we were never here | |
d2c49fd8 | 1688 | (setq this-command 'failed-complete))))) |
59ca07b5 | 1689 | \f |
b578f267 EN |
1690 | ;;--------------------------------------------------------------------------- |
1691 | ;; Parsing definitions from files into the database | |
1692 | ;;--------------------------------------------------------------------------- | |
59ca07b5 | 1693 | |
b578f267 EN |
1694 | ;;----------------------------------------------- |
1695 | ;; Top Level functions :: | |
1696 | ;;----------------------------------------------- | |
59ca07b5 | 1697 | |
b578f267 | 1698 | ;; User interface |
59ca07b5 | 1699 | (defun add-completions-from-file (file) |
d2c49fd8 | 1700 | "Parse possible completions from a FILE and add them to data base." |
59ca07b5 | 1701 | (interactive "fFile: ") |
a7a2b1f6 | 1702 | (setq file (expand-file-name file)) |
59ca07b5 | 1703 | (let* ((buffer (get-file-buffer file)) |
d2c49fd8 | 1704 | (buffer-already-there-p buffer)) |
136f8f67 RS |
1705 | (if (not buffer-already-there-p) |
1706 | (let ((completions-merging-modes nil)) | |
1707 | (setq buffer (find-file-noselect file)))) | |
59ca07b5 | 1708 | (unwind-protect |
36cc948e SM |
1709 | (with-current-buffer buffer |
1710 | (add-completions-from-buffer)) | |
136f8f67 RS |
1711 | (if (not buffer-already-there-p) |
1712 | (kill-buffer buffer))))) | |
59ca07b5 RS |
1713 | |
1714 | (defun add-completions-from-buffer () | |
1715 | (interactive) | |
1716 | (let ((current-completion-source cmpl-source-file-parsing) | |
1717 | (start-num | |
1718 | (cmpl-statistics-block | |
1719 | (aref completion-add-count-vector cmpl-source-file-parsing))) | |
d2c49fd8 | 1720 | mode) |
59ca07b5 RS |
1721 | (cond ((memq major-mode '(emacs-lisp-mode lisp-mode)) |
1722 | (add-completions-from-lisp-buffer) | |
d2c49fd8 | 1723 | (setq mode 'lisp)) |
59ca07b5 RS |
1724 | ((memq major-mode '(c-mode)) |
1725 | (add-completions-from-c-buffer) | |
d2c49fd8 | 1726 | (setq mode 'c)) |
59ca07b5 | 1727 | (t |
136f8f67 | 1728 | (error "Cannot parse completions in %s buffers" |
d2c49fd8 | 1729 | major-mode))) |
59ca07b5 RS |
1730 | (cmpl-statistics-block |
1731 | (record-cmpl-parse-file | |
1732 | mode (point-max) | |
1733 | (- (aref completion-add-count-vector cmpl-source-file-parsing) | |
d2c49fd8 | 1734 | start-num))))) |
59ca07b5 | 1735 | |
b578f267 | 1736 | ;; Find file hook |
36cc948e | 1737 | (defun completion-find-file-hook () |
a7a2b1f6 | 1738 | (cond (enable-completion |
59ca07b5 | 1739 | (cond ((and (memq major-mode '(emacs-lisp-mode lisp-mode)) |
d2c49fd8 | 1740 | (memq 'lisp completions-merging-modes)) |
59ca07b5 RS |
1741 | (add-completions-from-buffer)) |
1742 | ((and (memq major-mode '(c-mode)) | |
d2c49fd8 DL |
1743 | (memq 'c completions-merging-modes)) |
1744 | (add-completions-from-buffer)))))) | |
59ca07b5 | 1745 | |
b578f267 EN |
1746 | ;;----------------------------------------------- |
1747 | ;; Tags Table Completions | |
1748 | ;;----------------------------------------------- | |
59ca07b5 RS |
1749 | |
1750 | (defun add-completions-from-tags-table () | |
1751 | ;; Inspired by eero@media-lab.media.mit.edu | |
a7a2b1f6 | 1752 | "Add completions from the current tags table." |
59ca07b5 RS |
1753 | (interactive) |
1754 | (visit-tags-table-buffer) ;this will prompt if no tags-table | |
1755 | (save-excursion | |
1756 | (goto-char (point-min)) | |
1757 | (let (string) | |
1758 | (condition-case e | |
1759 | (while t | |
1760 | (search-forward "\177") | |
1761 | (backward-char 3) | |
1762 | (and (setq string (symbol-under-point)) | |
1763 | (add-completion-to-tail-if-new string)) | |
d2c49fd8 DL |
1764 | (forward-char 3)) |
1765 | (search-failed))))) | |
59ca07b5 RS |
1766 | |
1767 | \f | |
b578f267 EN |
1768 | ;;----------------------------------------------- |
1769 | ;; Lisp File completion parsing | |
1770 | ;;----------------------------------------------- | |
1771 | ;; This merely looks for phrases beginning with (def.... or | |
1772 | ;; (package:def ... and takes the next word. | |
1773 | ;; | |
1774 | ;; We tried using forward-lines and explicit searches but the regexp technique | |
1775 | ;; was faster. (About 100K characters per second) | |
1776 | ;; | |
59ca07b5 RS |
1777 | (defconst *lisp-def-regexp* |
1778 | "\n(\\(\\w*:\\)?def\\(\\w\\|\\s_\\)*\\s +(*" | |
d2c49fd8 | 1779 | "A regexp that searches for Lisp definition form.") |
59ca07b5 | 1780 | |
b578f267 EN |
1781 | ;; Tests - |
1782 | ;; (and (string-match *lisp-def-regexp* "\n(defun foo") (match-end 0)) -> 8 | |
1783 | ;; (and (string-match *lisp-def-regexp* "\n(si:def foo") (match-end 0)) -> 9 | |
1784 | ;; (and (string-match *lisp-def-regexp* "\n(def-bar foo")(match-end 0)) -> 10 | |
1785 | ;; (and (string-match *lisp-def-regexp* "\n(defun (foo") (match-end 0)) -> 9 | |
59ca07b5 | 1786 | |
71296446 | 1787 | ;; Parses all the definition names from a Lisp mode buffer and adds them to |
b578f267 | 1788 | ;; the completion database. |
59ca07b5 | 1789 | (defun add-completions-from-lisp-buffer () |
59ca07b5 RS |
1790 | ;;; Benchmarks |
1791 | ;;; Sun-3/280 - 1500 to 3000 lines of lisp code per second | |
1792 | (let (string) | |
1793 | (save-excursion | |
1794 | (goto-char (point-min)) | |
1795 | (condition-case e | |
1796 | (while t | |
1797 | (re-search-forward *lisp-def-regexp*) | |
1798 | (and (setq string (symbol-under-point)) | |
d2c49fd8 DL |
1799 | (add-completion-to-tail-if-new string))) |
1800 | (search-failed))))) | |
59ca07b5 RS |
1801 | |
1802 | \f | |
b578f267 EN |
1803 | ;;----------------------------------------------- |
1804 | ;; C file completion parsing | |
1805 | ;;----------------------------------------------- | |
1806 | ;; C : | |
1807 | ;; Looks for #define or [<storage class>] [<type>] <name>{,<name>} | |
1808 | ;; or structure, array or pointer defs. | |
1809 | ;; It gets most of the definition names. | |
1810 | ;; | |
1811 | ;; As you might suspect by now, we use some symbol table hackery | |
1812 | ;; | |
1813 | ;; Symbol separator chars (have whitespace syntax) --> , ; * = ( | |
1814 | ;; Opening char --> [ { | |
1815 | ;; Closing char --> ] } | |
1816 | ;; opening and closing must be skipped over | |
1817 | ;; Whitespace chars (have symbol syntax) | |
1818 | ;; Everything else has word syntax | |
59ca07b5 | 1819 | |
36cc948e | 1820 | (defconst completion-c-def-syntax-table |
32168d16 | 1821 | (let ((table (make-syntax-table)) |
59ca07b5 | 1822 | (whitespace-chars '(? ?\n ?\t ?\f ?\v ?\r)) |
eb8c3be9 | 1823 | ;; unfortunately the ?( causes the parens to appear unbalanced |
d2c49fd8 | 1824 | (separator-chars '(?, ?* ?= ?\( ?\;)) |
136f8f67 | 1825 | i) |
59ca07b5 | 1826 | ;; default syntax is whitespace |
136f8f67 RS |
1827 | (setq i 0) |
1828 | (while (< i 256) | |
1829 | (modify-syntax-entry i "w" table) | |
1830 | (setq i (1+ i))) | |
3f429351 | 1831 | (dolist (char whitespace-chars) |
59ca07b5 | 1832 | (modify-syntax-entry char "_" table)) |
3f429351 | 1833 | (dolist (char separator-chars) |
59ca07b5 RS |
1834 | (modify-syntax-entry char " " table)) |
1835 | (modify-syntax-entry ?\[ "(]" table) | |
1836 | (modify-syntax-entry ?\{ "(}" table) | |
1837 | (modify-syntax-entry ?\] ")[" table) | |
1838 | (modify-syntax-entry ?\} "){" table) | |
1839 | table)) | |
1840 | ||
b578f267 | 1841 | ;; Regexps |
59ca07b5 RS |
1842 | (defconst *c-def-regexp* |
1843 | ;; This stops on lines with possible definitions | |
1844 | "\n[_a-zA-Z#]" | |
1845 | ;; This stops after the symbol to add. | |
1846 | ;;"\n\\(#define\\s +.\\|\\(\\(\\w\\|\\s_\\)+\\b\\s *\\)+[(;,[*{=]\\)" | |
1847 | ;; This stops before the symbol to add. {Test cases in parens. below} | |
1848 | ;;"\n\\(\\(\\w\\|\\s_\\)+\\s *(\\|\\(\\(#define\\|auto\\|extern\\|register\\|static\\|int\\|long\\|short\\|unsigned\\|char\\|void\\|float\\|double\\|enum\\|struct\\|union\\|typedef\\)\\s +\\)+\\)" | |
1849 | ;; this simple version picks up too much extraneous stuff | |
1850 | ;; "\n\\(\\w\\|\\s_\\|#\\)\\B" | |
d2c49fd8 | 1851 | "A regexp that searches for a definition form.") |
59ca07b5 RS |
1852 | ; |
1853 | ;(defconst *c-cont-regexp* | |
1854 | ; "\\(\\w\\|\\s_\\)+\\b\\s *\\({\\|\\(\\[[0-9\t ]*\\]\\s *\\)*,\\(*\\|\\s \\)*\\b\\)" | |
1855 | ; "This regexp should be used in a looking-at to parse for lists of variables.") | |
1856 | ; | |
1857 | ;(defconst *c-struct-regexp* | |
1858 | ; "\\(*\\|\\s \\)*\\b" | |
1859 | ; "This regexp should be used to test whether a symbol follows a structure definition.") | |
1860 | ||
1861 | ;(defun test-c-def-regexp (regexp string) | |
1862 | ; (and (eq 0 (string-match regexp string)) (match-end 0)) | |
1863 | ; ) | |
1864 | ||
b578f267 EN |
1865 | ;; Tests - |
1866 | ;; (test-c-def-regexp *c-def-regexp* "\n#define foo") -> 10 (9) | |
1867 | ;; (test-c-def-regexp *c-def-regexp* "\nfoo (x, y) {") -> 6 (6) | |
1868 | ;; (test-c-def-regexp *c-def-regexp* "\nint foo (x, y)") -> 10 (5) | |
1869 | ;; (test-c-def-regexp *c-def-regexp* "\n int foo (x, y)") -> nil | |
1870 | ;; (test-c-def-regexp *c-cont-regexp* "oo, bar") -> 4 | |
1871 | ;; (test-c-def-regexp *c-cont-regexp* "oo, *bar") -> 5 | |
1872 | ;; (test-c-def-regexp *c-cont-regexp* "a [5][6], bar") -> 10 | |
1873 | ;; (test-c-def-regexp *c-cont-regexp* "oo(x,y)") -> nil | |
1874 | ;; (test-c-def-regexp *c-cont-regexp* "a [6] ,\t bar") -> 9 | |
1875 | ;; (test-c-def-regexp *c-cont-regexp* "oo {trout =1} my_carp;") -> 14 | |
1876 | ;; (test-c-def-regexp *c-cont-regexp* "truct_p complex foon") -> nil | |
1877 | ||
71296446 | 1878 | ;; Parses all the definition names from a C mode buffer and adds them to the |
b578f267 | 1879 | ;; completion database. |
59ca07b5 | 1880 | (defun add-completions-from-c-buffer () |
59ca07b5 RS |
1881 | ;; Benchmark -- |
1882 | ;; Sun 3/280-- 1250 lines/sec. | |
1883 | ||
36cc948e | 1884 | (let (string next-point char) |
59ca07b5 RS |
1885 | (save-excursion |
1886 | (goto-char (point-min)) | |
1887 | (catch 'finish-add-completions | |
36cc948e SM |
1888 | (with-syntax-table completion-c-def-syntax-table |
1889 | (while t | |
1890 | ;; we loop here only when scan-sexps fails | |
1891 | ;; (i.e. unbalance exps.) | |
1892 | (condition-case e | |
1893 | (while t | |
1894 | (re-search-forward *c-def-regexp*) | |
1895 | (cond | |
1896 | ((= (preceding-char) ?#) | |
1897 | ;; preprocessor macro, see if it's one we handle | |
1898 | (setq string (buffer-substring (point) (+ (point) 6))) | |
1899 | (cond ((member string '("define" "ifdef ")) | |
1900 | ;; skip forward over definition symbol | |
1901 | ;; and add it to database | |
1902 | (and (forward-word 2) | |
1903 | (setq string (symbol-before-point)) | |
1904 | ;;(push string foo) | |
1905 | (add-completion-to-tail-if-new string))))) | |
1906 | (t | |
1907 | ;; C definition | |
1908 | (setq next-point (point)) | |
1909 | (while (and | |
1910 | next-point | |
1911 | ;; scan to next separator char. | |
1912 | (setq next-point (scan-sexps next-point 1))) | |
1913 | ;; position the point on the word we want to add | |
1914 | (goto-char next-point) | |
1915 | (while (= (setq char (following-char)) ?*) | |
1916 | ;; handle pointer ref | |
1917 | ;; move to next separator char. | |
1918 | (goto-char | |
1919 | (setq next-point (scan-sexps (point) 1)))) | |
1920 | (forward-word -1) | |
1921 | ;; add to database | |
1922 | (if (setq string (symbol-under-point)) | |
1923 | ;; (push string foo) | |
1924 | (add-completion-to-tail-if-new string) | |
1925 | ;; Local TMC hack (useful for parsing paris.h) | |
1926 | (if (and (looking-at "_AP") ;; "ansi prototype" | |
1927 | (progn | |
1928 | (forward-word -1) | |
1929 | (setq string | |
1930 | (symbol-under-point)))) | |
1931 | (add-completion-to-tail-if-new string))) | |
1932 | ;; go to next | |
1933 | (goto-char next-point) | |
1934 | ;; (push (format "%c" (following-char)) foo) | |
1935 | (if (= (char-syntax char) ?\() | |
1936 | ;; if on an opening delimiter, go to end | |
1937 | (while (= (char-syntax char) ?\() | |
1938 | (setq next-point (scan-sexps next-point 1) | |
1939 | char (char-after next-point))) | |
1940 | (or (= char ?,) | |
1941 | ;; Current char is an end char. | |
1942 | (setq next-point nil))))))) | |
1943 | (search-failed ;;done | |
1944 | (throw 'finish-add-completions t)) | |
1945 | (error | |
1946 | ;; Check for failure in scan-sexps | |
1947 | (if (or (string-equal (nth 1 e) | |
1948 | "Containing expression ends prematurely") | |
1949 | (string-equal (nth 1 e) "Unbalanced parentheses")) | |
1950 | ;; unbalanced paren., keep going | |
1951 | ;;(ding) | |
1952 | (forward-line 1) | |
1953 | (message "Error parsing C buffer for completions--please send bug report") | |
1954 | (throw 'finish-add-completions t)))))))))) | |
59ca07b5 RS |
1955 | |
1956 | \f | |
b578f267 EN |
1957 | ;;--------------------------------------------------------------------------- |
1958 | ;; Init files | |
1959 | ;;--------------------------------------------------------------------------- | |
59ca07b5 | 1960 | |
b578f267 | 1961 | ;; The version of save-completions-to-file called at kill-emacs time. |
59ca07b5 | 1962 | (defun kill-emacs-save-completions () |
136f8f67 RS |
1963 | (if (and save-completions-flag enable-completion cmpl-initialized-p) |
1964 | (cond | |
1965 | ((not cmpl-completions-accepted-p) | |
1966 | (message "Completions database has not changed - not writing.")) | |
1967 | (t | |
36cc948e SM |
1968 | (save-completions-to-file)))) |
1969 | (cmpl-statistics-block (record-cmpl-kill-emacs))) | |
59ca07b5 | 1970 | |
1add72b5 RS |
1971 | ;; There is no point bothering to change this again |
1972 | ;; unless the package changes so much that it matters | |
1973 | ;; for people that have saved completions. | |
1974 | (defconst completion-version "11") | |
1975 | ||
59ca07b5 RS |
1976 | (defconst saved-cmpl-file-header |
1977 | ";;; Completion Initialization file. | |
b578f267 EN |
1978 | ;; Version = %s |
1979 | ;; Format is (<string> . <last-use-time>) | |
1980 | ;; <string> is the completion | |
1981 | ;; <last-use-time> is the time the completion was last used | |
1982 | ;; If it is t, the completion will never be pruned from the file. | |
1983 | ;; Otherwise it is in hours since origin. | |
59ca07b5 RS |
1984 | \n") |
1985 | ||
1986 | (defun completion-backup-filename (filename) | |
1987 | (concat filename ".BAK")) | |
1988 | ||
1989 | (defun save-completions-to-file (&optional filename) | |
a7a2b1f6 RS |
1990 | "Save completions in init file FILENAME. |
1991 | If file name is not specified, use `save-completions-file-name'." | |
59ca07b5 | 1992 | (interactive) |
a7a2b1f6 | 1993 | (setq filename (expand-file-name (or filename save-completions-file-name))) |
136f8f67 RS |
1994 | (if (file-writable-p filename) |
1995 | (progn | |
1996 | (if (not cmpl-initialized-p) | |
36cc948e | 1997 | (completion-initialize)) ;; make sure everything's loaded |
136f8f67 RS |
1998 | (message "Saving completions to file %s" filename) |
1999 | ||
2000 | (let* ((delete-old-versions t) | |
2001 | (kept-old-versions 0) | |
2002 | (kept-new-versions completions-file-versions-kept) | |
2003 | last-use-time | |
2004 | (current-time (cmpl-hours-since-origin)) | |
2005 | (total-in-db 0) | |
2006 | (total-perm 0) | |
2007 | (total-saved 0) | |
d2c49fd8 | 2008 | (backup-filename (completion-backup-filename filename))) |
71296446 | 2009 | |
36cc948e | 2010 | (with-current-buffer (get-buffer-create " *completion-save-buffer*") |
136f8f67 RS |
2011 | (setq buffer-file-name filename) |
2012 | ||
2013 | (if (not (verify-visited-file-modtime (current-buffer))) | |
2014 | (progn | |
2015 | ;; file has changed on disk. Bring us up-to-date | |
2016 | (message "Completion file has changed. Merging. . .") | |
2017 | (load-completions-from-file filename t) | |
2018 | (message "Merging finished. Saving completions to file %s" filename))) | |
2019 | ||
2020 | ;; prepare the buffer to be modified | |
2021 | (clear-visited-file-modtime) | |
2022 | (erase-buffer) | |
2023 | ;; (/ 1 0) | |
2024 | (insert (format saved-cmpl-file-header completion-version)) | |
3f429351 | 2025 | (dolist (completion (list-all-completions)) |
136f8f67 RS |
2026 | (setq total-in-db (1+ total-in-db)) |
2027 | (setq last-use-time (completion-last-use-time completion)) | |
2028 | ;; Update num uses and maybe write completion to a file | |
2029 | (cond ((or;; Write to file if | |
2030 | ;; permanent | |
2031 | (and (eq last-use-time t) | |
2032 | (setq total-perm (1+ total-perm))) | |
2033 | ;; or if | |
2034 | (if (> (completion-num-uses completion) 0) | |
2035 | ;; it's been used | |
2036 | (setq last-use-time current-time) | |
2037 | ;; or it was saved before and | |
2038 | (and last-use-time | |
2039 | ;; save-completions-retention-time is nil | |
2040 | (or (not save-completions-retention-time) | |
2041 | ;; or time since last use is < ...retention-time* | |
2042 | (< (- current-time last-use-time) | |
d2c49fd8 | 2043 | save-completions-retention-time))))) |
136f8f67 RS |
2044 | ;; write to file |
2045 | (setq total-saved (1+ total-saved)) | |
2046 | (insert (prin1-to-string (cons (completion-string completion) | |
d2c49fd8 | 2047 | last-use-time)) "\n")))) |
71296446 | 2048 | |
136f8f67 RS |
2049 | ;; write the buffer |
2050 | (condition-case e | |
2051 | (let ((file-exists-p (file-exists-p filename))) | |
2052 | (if file-exists-p | |
2053 | (progn | |
2054 | ;; If file exists . . . | |
2055 | ;; Save a backup(so GNU doesn't screw us when we're out of disk) | |
2056 | ;; (GNU leaves a 0 length file if it gets a disk full error!) | |
71296446 | 2057 | |
136f8f67 RS |
2058 | ;; If backup doesn't exit, Rename current to backup |
2059 | ;; {If backup exists the primary file is probably messed up} | |
2060 | (or (file-exists-p backup-filename) | |
2061 | (rename-file filename backup-filename)) | |
2062 | ;; Copy the backup back to the current name | |
2063 | ;; (so versioning works) | |
2064 | (copy-file backup-filename filename t))) | |
2065 | ;; Save it | |
2066 | (save-buffer) | |
2067 | (if file-exists-p | |
2068 | ;; If successful, remove backup | |
2069 | (delete-file backup-filename))) | |
2070 | (error | |
2071 | (set-buffer-modified-p nil) | |
d2c49fd8 | 2072 | (message "Couldn't save completion file `%s'" filename))) |
136f8f67 | 2073 | ;; Reset accepted-p flag |
d2c49fd8 | 2074 | (setq cmpl-completions-accepted-p nil) ) |
136f8f67 | 2075 | (cmpl-statistics-block |
d2c49fd8 | 2076 | (record-save-completions total-in-db total-perm total-saved)))))) |
59ca07b5 | 2077 | |
4e0c8650 | 2078 | ;;(defun auto-save-completions () |
b578f267 EN |
2079 | ;; (if (and save-completions-flag enable-completion cmpl-initialized-p |
2080 | ;; *completion-auto-save-period* | |
2081 | ;; (> cmpl-emacs-idle-time *completion-auto-save-period*) | |
2082 | ;; cmpl-completions-accepted-p) | |
2083 | ;; (save-completions-to-file))) | |
59ca07b5 | 2084 | |
4e0c8650 | 2085 | ;;(add-hook 'cmpl-emacs-idle-time-hooks 'auto-save-completions) |
59ca07b5 RS |
2086 | |
2087 | (defun load-completions-from-file (&optional filename no-message-p) | |
d2c49fd8 | 2088 | "Load a completion init file FILENAME. |
a7a2b1f6 | 2089 | If file is not specified, then use `save-completions-file-name'." |
59ca07b5 | 2090 | (interactive) |
a7a2b1f6 | 2091 | (setq filename (expand-file-name (or filename save-completions-file-name))) |
59ca07b5 | 2092 | (let* ((backup-filename (completion-backup-filename filename)) |
d2c49fd8 | 2093 | (backup-readable-p (file-readable-p backup-filename))) |
136f8f67 RS |
2094 | (if backup-readable-p (setq filename backup-filename)) |
2095 | (if (file-readable-p filename) | |
2096 | (progn | |
2097 | (if (not no-message-p) | |
2098 | (message "Loading completions from %sfile %s . . ." | |
2099 | (if backup-readable-p "backup " "") filename)) | |
36cc948e | 2100 | (with-current-buffer (get-buffer-create " *completion-save-buffer*") |
136f8f67 RS |
2101 | (setq buffer-file-name filename) |
2102 | ;; prepare the buffer to be modified | |
2103 | (clear-visited-file-modtime) | |
2104 | (erase-buffer) | |
71296446 | 2105 | |
136f8f67 RS |
2106 | (let ((insert-okay-p nil) |
2107 | (buffer (current-buffer)) | |
36cc948e | 2108 | string entry last-use-time |
136f8f67 RS |
2109 | cmpl-entry cmpl-last-use-time |
2110 | (current-completion-source cmpl-source-init-file) | |
2111 | (start-num | |
2112 | (cmpl-statistics-block | |
2113 | (aref completion-add-count-vector cmpl-source-file-parsing))) | |
d2c49fd8 | 2114 | (total-in-file 0) (total-perm 0)) |
136f8f67 RS |
2115 | ;; insert the file into a buffer |
2116 | (condition-case e | |
2117 | (progn (insert-file-contents filename t) | |
2118 | (setq insert-okay-p t)) | |
2119 | ||
71296446 | 2120 | (file-error |
136f8f67 RS |
2121 | (message "File error trying to load completion file %s." |
2122 | filename))) | |
71296446 | 2123 | ;; parse it |
136f8f67 RS |
2124 | (if insert-okay-p |
2125 | (progn | |
2126 | (goto-char (point-min)) | |
2127 | ||
2128 | (condition-case e | |
2129 | (while t | |
2130 | (setq entry (read buffer)) | |
2131 | (setq total-in-file (1+ total-in-file)) | |
2132 | (cond | |
2133 | ((and (consp entry) | |
2134 | (stringp (setq string (car entry))) | |
2135 | (cond | |
2136 | ((eq (setq last-use-time (cdr entry)) 'T) | |
2137 | ;; handle case sensitivity | |
2138 | (setq total-perm (1+ total-perm)) | |
2139 | (setq last-use-time t)) | |
2140 | ((eq last-use-time t) | |
2141 | (setq total-perm (1+ total-perm))) | |
d2c49fd8 | 2142 | ((integerp last-use-time)))) |
136f8f67 RS |
2143 | ;; Valid entry |
2144 | ;; add it in | |
2145 | (setq cmpl-last-use-time | |
2146 | (completion-last-use-time | |
2147 | (setq cmpl-entry | |
d2c49fd8 | 2148 | (add-completion-to-tail-if-new string)))) |
71296446 | 2149 | (if (or (eq last-use-time t) |
136f8f67 RS |
2150 | (and (> last-use-time 1000);;backcompatibility |
2151 | (not (eq cmpl-last-use-time t)) | |
2152 | (or (not cmpl-last-use-time) | |
2153 | ;; more recent | |
d2c49fd8 | 2154 | (> last-use-time cmpl-last-use-time)))) |
136f8f67 | 2155 | ;; update last-use-time |
d2c49fd8 | 2156 | (set-completion-last-use-time cmpl-entry last-use-time))) |
136f8f67 RS |
2157 | (t |
2158 | ;; Bad format | |
2159 | (message "Error: invalid saved completion - %s" | |
2160 | (prin1-to-string entry)) | |
2161 | ;; try to get back in sync | |
d2c49fd8 | 2162 | (search-forward "\n(")))) |
136f8f67 | 2163 | (search-failed |
d2c49fd8 | 2164 | (message "End of file while reading completions.")) |
136f8f67 RS |
2165 | (end-of-file |
2166 | (if (= (point) (point-max)) | |
2167 | (if (not no-message-p) | |
2168 | (message "Loading completions from file %s . . . Done." | |
2169 | filename)) | |
d2c49fd8 | 2170 | (message "End of file while reading completions.")))))) |
59ca07b5 | 2171 | |
136f8f67 RS |
2172 | (cmpl-statistics-block |
2173 | (record-load-completions | |
2174 | total-in-file total-perm | |
2175 | (- (aref completion-add-count-vector cmpl-source-init-file) | |
2176 | start-num))) | |
d2c49fd8 | 2177 | )))))) |
59ca07b5 | 2178 | |
36cc948e | 2179 | (defun completion-initialize () |
a7a2b1f6 | 2180 | "Load the default completions file. |
7975cb9f | 2181 | Also sets up so that exiting Emacs will automatically save the file." |
59ca07b5 | 2182 | (interactive) |
36cc948e SM |
2183 | (unless cmpl-initialized-p |
2184 | (load-completions-from-file) | |
2185 | (setq cmpl-initialized-p t))) | |
59ca07b5 | 2186 | \f |
b578f267 EN |
2187 | ;;----------------------------------------------- |
2188 | ;; Kill region patch | |
2189 | ;;----------------------------------------------- | |
59ca07b5 | 2190 | |
a7a2b1f6 | 2191 | (defun completion-kill-region (&optional beg end) |
59ca07b5 RS |
2192 | "Kill between point and mark. |
2193 | The text is deleted but saved in the kill ring. | |
2194 | The command \\[yank] can retrieve it from there. | |
2195 | /(If you want to kill and then yank immediately, use \\[copy-region-as-kill].) | |
2196 | ||
2197 | This is the primitive for programs to kill text (as opposed to deleting it). | |
0c53eb03 | 2198 | Supply two arguments, character positions indicating the stretch of text |
59ca07b5 RS |
2199 | to be killed. |
2200 | Any command that calls this function is a \"kill command\". | |
2201 | If the previous command was also a kill command, | |
2202 | the text killed this time appends to the text killed last time | |
2203 | to make one entry in the kill ring. | |
2204 | Patched to remove the most recent completion." | |
71296446 | 2205 | (interactive "r") |
a7a2b1f6 | 2206 | (cond ((eq last-command 'complete) |
59ca07b5 RS |
2207 | (delete-region (point) cmpl-last-insert-location) |
2208 | (insert cmpl-original-string) | |
2209 | (setq completion-to-accept nil) | |
2210 | (cmpl-statistics-block | |
a7a2b1f6 | 2211 | (record-complete-failed))) |
59ca07b5 | 2212 | (t |
a7a2b1f6 | 2213 | (kill-region beg end)))) |
59ca07b5 | 2214 | |
a7a2b1f6 | 2215 | \f |
b578f267 EN |
2216 | ;;----------------------------------------------- |
2217 | ;; Patches to self-insert-command. | |
2218 | ;;----------------------------------------------- | |
59ca07b5 | 2219 | |
b578f267 EN |
2220 | ;; Need 2 versions: generic separator chars. and space (to get auto fill |
2221 | ;; to work) | |
59ca07b5 | 2222 | |
b578f267 EN |
2223 | ;; All common separators (eg. space "(" ")" """) characters go through a |
2224 | ;; function to add new words to the list of words to complete from: | |
2225 | ;; COMPLETION-SEPARATOR-SELF-INSERT-COMMAND (arg). | |
71296446 | 2226 | ;; If the character before this was an alpha-numeric then this adds the |
b578f267 | 2227 | ;; symbol before point to the completion list (using ADD-COMPLETION). |
59ca07b5 RS |
2228 | |
2229 | (defun completion-separator-self-insert-command (arg) | |
2230 | (interactive "p") | |
2231 | (use-completion-before-separator) | |
d2c49fd8 | 2232 | (self-insert-command arg)) |
59ca07b5 RS |
2233 | |
2234 | (defun completion-separator-self-insert-autofilling (arg) | |
2235 | (interactive "p") | |
2236 | (use-completion-before-separator) | |
2237 | (self-insert-command arg) | |
a7263218 | 2238 | (and auto-fill-function |
d2c49fd8 | 2239 | (funcall auto-fill-function))) |
59ca07b5 | 2240 | |
b578f267 EN |
2241 | ;;----------------------------------------------- |
2242 | ;; Wrapping Macro | |
2243 | ;;----------------------------------------------- | |
59ca07b5 | 2244 | |
71296446 | 2245 | ;; Note that because of the way byte compiling works, none of |
b578f267 | 2246 | ;; the functions defined with this macro get byte compiled. |
59ca07b5 | 2247 | |
36cc948e | 2248 | (defun completion-def-wrapper (function-name type) |
c2ced5d8 CZ |
2249 | "Add a call to update the completion database before function execution. |
2250 | TYPE is the type of the wrapper to be added. Can be :before or :under." | |
36cc948e SM |
2251 | (put function-name 'completion-function |
2252 | (cdr (assq type | |
699ee5f5 LT |
2253 | '((:separator . use-completion-before-separator) |
2254 | (:before . use-completion-before-point) | |
2255 | (:backward-under . use-completion-backward-under) | |
2256 | (:backward . use-completion-backward) | |
2257 | (:under . use-completion-under-point) | |
2258 | (:under-or-before . use-completion-under-or-before-point) | |
2259 | (:minibuffer-separator | |
2260 | . use-completion-minibuffer-separator)))))) | |
a7a2b1f6 RS |
2261 | |
2262 | (defun use-completion-minibuffer-separator () | |
36cc948e | 2263 | (let ((completion-syntax-table completion-standard-syntax-table)) |
a7a2b1f6 RS |
2264 | (use-completion-before-separator))) |
2265 | ||
2266 | (defun use-completion-backward-under () | |
2267 | (use-completion-under-point) | |
2268 | (if (eq last-command 'complete) | |
2269 | ;; probably a failed completion if you have to back up | |
2270 | (cmpl-statistics-block (record-complete-failed)))) | |
2271 | ||
2272 | (defun use-completion-backward () | |
2273 | (if (eq last-command 'complete) | |
2274 | ;; probably a failed completion if you have to back up | |
2275 | (cmpl-statistics-block (record-complete-failed)))) | |
2276 | ||
2277 | (defun completion-before-command () | |
76e91049 RS |
2278 | (funcall (or (and (symbolp this-command) |
2279 | (get this-command 'completion-function)) | |
a7a2b1f6 | 2280 | 'use-completion-under-or-before-point))) |
bb310d1e | 2281 | \f |
36cc948e SM |
2282 | ;; Lisp mode diffs. |
2283 | ||
2284 | (defconst completion-lisp-syntax-table | |
2285 | (let ((table (copy-syntax-table completion-standard-syntax-table)) | |
2286 | (symbol-chars '(?! ?& ?? ?= ?^))) | |
2287 | (dolist (char symbol-chars) | |
2288 | (modify-syntax-entry char "_" table)) | |
2289 | table)) | |
2290 | ||
2291 | (defun completion-lisp-mode-hook () | |
2292 | (setq completion-syntax-table completion-lisp-syntax-table) | |
2293 | ;; Lisp Mode diffs | |
2294 | (local-set-key "!" 'self-insert-command) | |
2295 | (local-set-key "&" 'self-insert-command) | |
2296 | (local-set-key "%" 'self-insert-command) | |
2297 | (local-set-key "?" 'self-insert-command) | |
2298 | (local-set-key "=" 'self-insert-command) | |
2299 | (local-set-key "^" 'self-insert-command)) | |
2300 | ||
b578f267 | 2301 | ;; C mode diffs. |
603715b0 | 2302 | |
36cc948e SM |
2303 | (defconst completion-c-syntax-table |
2304 | (let ((table (copy-syntax-table completion-standard-syntax-table)) | |
2305 | (separator-chars '(?+ ?* ?/ ?: ?%))) | |
2306 | (dolist (char separator-chars) | |
2307 | (modify-syntax-entry char " " table)) | |
2308 | table)) | |
603715b0 | 2309 | |
36cc948e | 2310 | (completion-def-wrapper 'electric-c-semi :separator) |
32168d16 | 2311 | (defun completion-c-mode-hook () |
36cc948e SM |
2312 | (setq completion-syntax-table completion-c-syntax-table) |
2313 | (local-set-key "+" 'completion-separator-self-insert-command) | |
2314 | (local-set-key "*" 'completion-separator-self-insert-command) | |
2315 | (local-set-key "/" 'completion-separator-self-insert-command)) | |
59ca07b5 | 2316 | |
b578f267 | 2317 | ;; FORTRAN mode diffs. (these are defined when fortran is called) |
603715b0 | 2318 | |
36cc948e SM |
2319 | (defconst completion-fortran-syntax-table |
2320 | (let ((table (copy-syntax-table completion-standard-syntax-table)) | |
2321 | (separator-chars '(?+ ?- ?* ?/ ?:))) | |
2322 | (dolist (char separator-chars) | |
2323 | (modify-syntax-entry char " " table)) | |
2324 | table)) | |
603715b0 | 2325 | |
59ca07b5 | 2326 | (defun completion-setup-fortran-mode () |
36cc948e SM |
2327 | (setq completion-syntax-table completion-fortran-syntax-table) |
2328 | (local-set-key "+" 'completion-separator-self-insert-command) | |
2329 | (local-set-key "-" 'completion-separator-self-insert-command) | |
2330 | (local-set-key "*" 'completion-separator-self-insert-command) | |
2331 | (local-set-key "/" 'completion-separator-self-insert-command)) | |
bb310d1e | 2332 | \f |
36cc948e SM |
2333 | ;; Enable completion mode. |
2334 | ||
2335 | (defvar fortran-mode-hook) | |
2336 | ||
2337 | (defvar completion-saved-bindings nil) | |
71296446 | 2338 | |
bb310d1e | 2339 | ;;;###autoload |
36cc948e | 2340 | (define-minor-mode dynamic-completion-mode |
bb310d1e | 2341 | "Enable dynamic word-completion." |
36cc948e SM |
2342 | :global t |
2343 | ;; This is always good, not specific to dynamic-completion-mode. | |
bb310d1e RS |
2344 | (define-key function-key-map [C-return] [?\C-\r]) |
2345 | ||
36cc948e SM |
2346 | (dolist (x '((find-file-hook . completion-find-file-hook) |
2347 | (pre-command-hook . completion-before-command) | |
2348 | ;; Save completions when killing Emacs. | |
2349 | (kill-emacs-hook . kill-emacs-save-completions) | |
2350 | ||
2351 | ;; Install the appropriate mode tables. | |
2352 | (lisp-mode-hook . completion-lisp-mode-hook) | |
2353 | (c-mode-hook . completion-c-mode-hook) | |
2354 | (fortran-mode-hook . completion-setup-fortran-mode))) | |
2355 | (if dynamic-completion-mode | |
2356 | (add-hook (car x) (cdr x)) | |
2357 | (remove-hook (car x) (cdr x)))) | |
699ee5f5 | 2358 | |
36cc948e SM |
2359 | ;; "Complete" Key Keybindings. We don't want to use a minor-mode |
2360 | ;; map because these have too high a priority. We could/should | |
2361 | ;; probably change the interpretation of minor-mode-map-alist such | |
2362 | ;; that a map has lower precedence if the symbol is not buffer-local. | |
2363 | (while completion-saved-bindings | |
2364 | (let ((binding (pop completion-saved-bindings))) | |
2365 | (global-set-key (car binding) (cdr binding)))) | |
2366 | (when dynamic-completion-mode | |
2367 | (dolist (binding | |
2368 | '(("\M-\r" . complete) | |
2369 | ([?\C-\r] . complete) | |
2370 | ||
2371 | ;; Tests - | |
2372 | ;; (add-completion "cumberland") | |
2373 | ;; (add-completion "cumberbund") | |
2374 | ;; cum | |
2375 | ;; Cumber | |
2376 | ;; cumbering | |
2377 | ;; cumb | |
2378 | ||
2379 | ;; Patches to standard keymaps insert completions | |
2380 | ([remap kill-region] . completion-kill-region) | |
2381 | ||
2382 | ;; Separators | |
2383 | ;; We've used the completion syntax table given as a guide. | |
2384 | ;; | |
2385 | ;; Global separator chars. | |
2386 | ;; We left out <tab> because there are too many special | |
2387 | ;; cases for it. Also, in normal coding it's rarely typed | |
2388 | ;; after a word. | |
2389 | (" " . completion-separator-self-insert-autofilling) | |
2390 | ("!" . completion-separator-self-insert-command) | |
2391 | ("%" . completion-separator-self-insert-command) | |
2392 | ("^" . completion-separator-self-insert-command) | |
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 | ||
2410 | ;; We include period and colon even though they are symbol | |
2411 | ;; chars because : | |
2412 | ;; - in text we want to pick up the last word in a sentence. | |
2413 | ;; - in C pointer refs. we want to pick up the first symbol | |
2414 | ;; - it won't make a difference for lisp mode (package names | |
2415 | ;; are short) | |
2416 | ("." . completion-separator-self-insert-command) | |
2417 | (":" . completion-separator-self-insert-command))) | |
2418 | (push (cons (car binding) (lookup-key global-map (car binding))) | |
2419 | completion-saved-bindings) | |
2420 | (global-set-key (car binding) (cdr binding))) | |
2421 | ||
2422 | ;; Tests -- | |
2423 | ;; foobarbiz | |
2424 | ;; foobar | |
2425 | ;; fooquux | |
2426 | ;; fooper | |
bb310d1e | 2427 | |
36cc948e SM |
2428 | (cmpl-statistics-block |
2429 | (record-completion-file-loaded)) | |
59ca07b5 | 2430 | |
36cc948e SM |
2431 | (completion-initialize))) |
2432 | ||
2433 | ;;----------------------------------------------- | |
2434 | ;; End of line chars. | |
2435 | ;;----------------------------------------------- | |
2436 | (completion-def-wrapper 'newline :separator) | |
2437 | (completion-def-wrapper 'newline-and-indent :separator) | |
2438 | (completion-def-wrapper 'comint-send-input :separator) | |
2439 | (completion-def-wrapper 'exit-minibuffer :minibuffer-separator) | |
2440 | (completion-def-wrapper 'eval-print-last-sexp :separator) | |
2441 | (completion-def-wrapper 'eval-last-sexp :separator) | |
2442 | ;;(completion-def-wrapper 'minibuffer-complete-and-exit :minibuffer) | |
59ca07b5 | 2443 | |
36cc948e SM |
2444 | ;;----------------------------------------------- |
2445 | ;; Cursor movement | |
2446 | ;;----------------------------------------------- | |
c0274f38 | 2447 | |
36cc948e SM |
2448 | (completion-def-wrapper 'next-line :under-or-before) |
2449 | (completion-def-wrapper 'previous-line :under-or-before) | |
2450 | (completion-def-wrapper 'beginning-of-buffer :under-or-before) | |
2451 | (completion-def-wrapper 'end-of-buffer :under-or-before) | |
2452 | (completion-def-wrapper 'beginning-of-line :under-or-before) | |
2453 | (completion-def-wrapper 'end-of-line :under-or-before) | |
2454 | (completion-def-wrapper 'forward-char :under-or-before) | |
2455 | (completion-def-wrapper 'forward-word :under-or-before) | |
2456 | (completion-def-wrapper 'forward-sexp :under-or-before) | |
2457 | (completion-def-wrapper 'backward-char :backward-under) | |
2458 | (completion-def-wrapper 'backward-word :backward-under) | |
2459 | (completion-def-wrapper 'backward-sexp :backward-under) | |
2460 | ||
2461 | (completion-def-wrapper 'delete-backward-char :backward) | |
2462 | (completion-def-wrapper 'delete-backward-char-untabify :backward) | |
2463 | ||
2464 | ;; Old names, non-namespace-clean. | |
2465 | (defvaralias 'cmpl-syntax-table 'completion-syntax-table) | |
2466 | (defalias 'initialize-completions 'completion-initialize) | |
2467 | ||
2468 | (dolist (x '("^To complete, the point must be after a symbol at least [0-9]* character long\\.$" | |
d2c49fd8 | 2469 | "^The string \".*\" is too short to be saved as a completion\\.$")) |
36cc948e | 2470 | (add-to-list 'debug-ignored-errors x)) |
d2c49fd8 | 2471 | |
1aa323ac RS |
2472 | (provide 'completion) |
2473 | ||
36cc948e | 2474 | ;; arch-tag: 6990dafe-4abd-4a1f-8c42-ffb25e120f5e |
c0274f38 | 2475 | ;;; completion.el ends here |