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