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