completion.el 91.8 KB
Newer Older
Eric S. Raymond's avatar
Eric S. Raymond committed
1
;;; completion.el --- dynamic word-completion code
Erik Naggum's avatar
Erik Naggum committed
2

3
;; Copyright (C) 1990, 1993, 1995, 1997, 2001-2011 Free Software Foundation, Inc.
Eric S. Raymond's avatar
Eric S. Raymond committed
4

Richard M. Stallman's avatar
Richard M. Stallman committed
5
;; Maintainer: FSF
Dan Nicolaescu's avatar
Dan Nicolaescu committed
6
;; Keywords: abbrev convenience
7
;; Author: Jim Salem <alem@bbnplanet.com> of Thinking Machines Inc.
Richard M. Stallman's avatar
Richard M. Stallman committed
8
;;  (ideas suggested by Brewster Kahle)
Eric S. Raymond's avatar
Eric S. Raymond committed
9

10
;; This file is part of GNU Emacs.
Eric S. Raymond's avatar
Eric S. Raymond committed
11

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 15
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
16 17 18 19 20 21 22

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
23
;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
24 25

;;; Commentary:
Erik Naggum's avatar
Erik Naggum committed
26 27 28

;; What to put in .emacs
;;-----------------------
29
;; (dynamic-completion-mode)
Richard M. Stallman's avatar
Richard M. Stallman committed
30

Erik Naggum's avatar
Erik Naggum committed
31 32 33 34 35 36 37
;;---------------------------------------------------------------------------
;; Documentation [Slightly out of date]
;;---------------------------------------------------------------------------
;;  (also check the documentation string of the functions)
;;
;; Introduction
;;---------------
38
;;
Erik Naggum's avatar
Erik Naggum committed
39
;;     After you type a few characters, pressing the "complete" key inserts
40
;; the rest of the word you are likely to type.
Erik Naggum's avatar
Erik Naggum committed
41
;;
42
;; This watches all the words that you type and remembers them.  When
Erik Naggum's avatar
Erik Naggum committed
43
;; typing a new word, pressing "complete" (meta-return) "completes" the
44
;; word by inserting the most recently used word that begins with the
Erik Naggum's avatar
Erik Naggum committed
45 46 47 48
;; same characters.  If you press meta-return repeatedly, it cycles
;; through all the words it knows about.
;;
;;  If you like the completion then just continue typing, it is as if you
49
;; entered the text by hand.  If you want the inserted extra characters
Erik Naggum's avatar
Erik Naggum committed
50 51 52
;; to go away, type control-w or delete.  More options are described below.
;;
;;  The guesses are made in the order of the most recently "used".  Typing
53 54
;; in a word and then typing a separator character (such as a space) "uses"
;; the word.  So does moving a cursor over the word.  If no words are found,
Erik Naggum's avatar
Erik Naggum committed
55 56
;; it uses an extended version of the dabbrev style completion.
;;
57 58
;;   You automatically save the completions you use to a file between
;; sessions.
Erik Naggum's avatar
Erik Naggum committed
59
;;
60
;;   Completion enables programmers to enter longer, more descriptive
Erik Naggum's avatar
Erik Naggum committed
61 62 63 64 65 66
;; variable names while typing fewer keystrokes than they normally would.
;;
;;
;; Full documentation
;;---------------------
;;
67
;;   A "word" is any string containing characters with either word or symbol
Erik Naggum's avatar
Erik Naggum committed
68 69 70 71 72 73 74 75
;; syntax.  [E.G. Any alphanumeric string with hyphens, underscores, etc.]
;; Unless you change the constants, you must type at least three characters
;; for the word to be recognized.  Only words longer than 6 characters are
;; saved.
;;
;;   When you load this file, completion will be on.  I suggest you use the
;; compiled version (because it is noticeably faster).
;;
76
;;  M-x completion-mode toggles whether or not new words are added to the
Erik Naggum's avatar
Erik Naggum committed
77 78 79 80 81
;; database by changing the value of enable-completion.
;;
;;  SAVING/LOADING COMPLETIONS
;;   Completions are automatically saved from one session to another
;; (unless save-completions-flag or enable-completion is nil).
82 83
;; Activating this minor-mode (calling completion-initialize) loads
;; a completions database for a saved completions file
84
;; (default: ~/.completions).  When you exit, Emacs saves a copy of the
85 86
;; completions that you often use.  When you next start, Emacs loads in
;; the saved completion file.
Erik Naggum's avatar
Erik Naggum committed
87
;;
88 89
;;   The number of completions saved depends loosely on
;; *saved-completions-decay-factor*.  Completions that have never been
Erik Naggum's avatar
Erik Naggum committed
90 91 92
;; inserted via "complete" are not saved.  You are encouraged to experiment
;; with different functions (see compute-completion-min-num-uses).
;;
93 94
;;   Some completions are permanent and are always saved out.  These
;; completions have their num-uses slot set to T.  Use
Erik Naggum's avatar
Erik Naggum committed
95 96 97
;; add-permanent-completion to do this
;;
;;   Completions are saved only if enable-completion is T.  The number of old
98
;; versions kept of the saved completions file is controlled by
Erik Naggum's avatar
Erik Naggum committed
99 100 101
;; completions-file-versions-kept.
;;
;; COMPLETE KEY OPTIONS
102 103
;;   The complete function takes a numeric arguments.
;;  control-u :: leave the point at the beginning of the completion rather
Erik Naggum's avatar
Erik Naggum committed
104 105 106 107 108 109 110 111
;;               than the middle.
;;  a number  :: rotate through the possible completions by that amount
;;  `-'       :: same as -1 (insert previous completion)
;;
;; HOW THE DATABASE IS MAINTAINED
;;  <write>
;;
;; UPDATING THE DATABASE MANUALLY
112
;;   m-x kill-completion
Erik Naggum's avatar
Erik Naggum committed
113 114 115
;;     kills the completion at point.
;;   m-x add-completion
;;   m-x add-permanent-completion
116
;;
Erik Naggum's avatar
Erik Naggum committed
117 118 119 120 121
;; UPDATING THE DATABASE FROM A SOURCE CODE FILE
;;   m-x add-completions-from-buffer
;;     Parses all the definition names from a C or LISP mode buffer and
;;     adds them to the completion database.
;;
122
;;   m-x add-completions-from-lisp-file
Erik Naggum's avatar
Erik Naggum committed
123 124 125 126 127 128 129 130 131 132 133
;;     Parses all the definition names from a C or Lisp mode file and
;;     adds them to the completion database.
;;
;; UPDATING THE DATABASE FROM A TAGS TABLE
;;   m-x add-completions-from-tags-table
;;     Adds completions from the current tags-table-buffer.
;;
;; HOW A COMPLETION IS FOUND
;;  <write>
;;
;; STRING CASING
134
;;   Completion is string case independent if case-fold-search has its
Erik Naggum's avatar
Erik Naggum committed
135
;;  normal default of T.  Also when the completion is inserted the case of the
136 137
;;  entry is coerced appropriately.
;;  [E.G.  APP --> APPROPRIATELY     app --> appropriately
Erik Naggum's avatar
Erik Naggum committed
138 139 140
;;         App --> Appropriately]
;;
;; INITIALIZATION
141 142
;;  The form `(completion-initialize)' initializes the completion system by
;; trying to load in the user's completions.  After the first call, further
143
;; calls have no effect so one should be careful not to put the form in a
Erik Naggum's avatar
Erik Naggum committed
144 145 146 147 148
;; site's standard site-init file.
;;
;;---------------------------------------------------------------------------
;;
;;
Richard M. Stallman's avatar
Richard M. Stallman committed
149

Erik Naggum's avatar
Erik Naggum committed
150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179
;;---------------------------------------------------------------------------
;; Functions you might like to call
;;---------------------------------------------------------------------------
;;
;;  add-completion  string &optional num-uses
;;    Adds a new string to the database
;;
;;  add-permanent-completion  string
;;    Adds a new string to the database with num-uses = T
;;

;;  kill-completion string
;;    Kills the completion from the database.
;;
;;  clear-all-completions
;;    Clears the database
;;
;;  list-all-completions
;;    Returns a list of all completions.
;;
;;
;;  next-completion string &optional index
;;    Returns a completion entry that starts with string.
;;
;;  find-exact-completion string
;;    Returns a completion entry that exactly matches string.
;;
;;  complete
;;    Inserts a completion at point
;;
180
;;  completion-initialize
181
;;    Loads the completions file and sets up so that exiting emacs will
Erik Naggum's avatar
Erik Naggum committed
182 183
;;  save them.
;;
184
;;  save-completions-to-file &optional filename
Erik Naggum's avatar
Erik Naggum committed
185 186 187 188 189 190 191 192 193 194
;;  load-completions-from-file &optional filename
;;
;;-----------------------------------------------
;; Other functions
;;-----------------------------------------------
;;
;;  get-completion-list string
;;
;; These things are for manipulating the structure
;;  make-completion string num-uses
195
;;  completion-num-uses completion
Erik Naggum's avatar
Erik Naggum committed
196 197 198
;;  completion-string completion
;;  set-completion-num-uses completion num-uses
;;  set-completion-string completion string
199
;;
Erik Naggum's avatar
Erik Naggum committed
200
;;
Richard M. Stallman's avatar
Richard M. Stallman committed
201

Erik Naggum's avatar
Erik Naggum committed
202 203 204 205 206 207 208 209 210 211 212 213
;;-----------------------------------------------
;; To Do :: (anybody ?)
;;-----------------------------------------------
;;
;;   Implement Lookup and keyboard interface in C
;;   Add package prefix smarts (for Common Lisp)
;;   Add autoprompting of possible completions after every keystroke (fast
;;      terminals only !)
;;   Add doc. to texinfo
;;
;;
;;-----------------------------------------------
Erik Naggum's avatar
Erik Naggum committed
214
;;; Change Log:
Erik Naggum's avatar
Erik Naggum committed
215
;;-----------------------------------------------
216
;;    Sometime in '84 Brewster implemented a somewhat buggy version for
Erik Naggum's avatar
Erik Naggum committed
217
;; Symbolics LISPMs.
218
;;    Jan. '85 Jim became enamored of the idea and implemented a faster,
Erik Naggum's avatar
Erik Naggum committed
219 220
;; more robust version.
;;    With input from many users at TMC, (rose, craig, and gls come to mind),
221 222 223 224 225
;; the current style of interface was developed.
;;    9/87, Jim and Brewster took terminals home.  Yuck.  After
;; complaining for a while Brewster implemented a subset of the current
;; LISPM version for GNU Emacs.
;;    8/88  After complaining for a while (and with sufficient
Erik Naggum's avatar
Erik Naggum committed
226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269
;; promised rewards), Jim reimplemented a version of GNU completion
;; superior to that of the LISPM version.
;;
;;-----------------------------------------------
;; Acknowledgements
;;-----------------------------------------------
;;  Cliff Lasser (cal@think.com), Kevin Herbert (kph@cisco.com),
;;  eero@media-lab, kgk@cs.brown.edu, jla@ai.mit.edu,
;;
;;-----------------------------------------------
;; Change Log
;;-----------------------------------------------
;; From version 9 to 10
;;  - Allowance for non-integral *completion-version* nos.
;;  - Fix cmpl-apply-as-top-level for keyboard macros
;;  - Fix broken completion merging (in save-completions-to-file)
;;  - More misc. fixes for version 19.0 of emacs
;;
;; From Version 8 to 9
;;  - Ported to version 19.0 of emacs (backcompatible with version 18)
;;  - Added add-completions-from-tags-table (with thanks to eero@media-lab)
;;
;; From Version 7 to 8
;;  - Misc. changes to comments
;;  - new completion key bindings: c-x o, M->, M-<, c-a, c-e
;;  - cdabbrev now checks all the visible window buffers and the "other buffer"
;;  - `%' is now a symbol character rather than a separator (except in C mode)
;;
;; From Version 6 to 7
;;  - Fixed bug with saving out .completion file the first time
;;
;; From Version 5 to 6
;;  - removed statistics recording
;;  - reworked advise to handle autoloads
;;  - Fixed fortran mode support
;;  - Added new cursor motion triggers
;;
;; From Version 4 to 5
;;  - doesn't bother saving if nothing has changed
;;  - auto-save if haven't used for a 1/2 hour
;;  - save period extended to two weeks
;;  - minor fix to capitalization code
;;  - added *completion-auto-save-period* to variables recorded.
;;  - added reenter protection to cmpl-record-statistics-filter
270
;;  - added backup protection to save-completions-to-file (prevents
Erik Naggum's avatar
Erik Naggum committed
271
;;    problems with disk full errors)
Richard M. Stallman's avatar
Richard M. Stallman committed
272

Eric S. Raymond's avatar
Eric S. Raymond committed
273 274
;;; Code:

Erik Naggum's avatar
Erik Naggum committed
275 276 277
;;---------------------------------------------------------------------------
;; User changeable parameters
;;---------------------------------------------------------------------------
Richard M. Stallman's avatar
Richard M. Stallman committed
278

279 280
(defgroup completion nil
  "Dynamic word-completion code."
Dan Nicolaescu's avatar
Dan Nicolaescu committed
281 282
  :group 'matching
  :group 'convenience)
283 284 285


(defcustom enable-completion t
286
  "Non-nil means enable recording and saving of completions.
287
If nil, no new words are added to the database or saved to the init file."
288 289
  :type 'boolean
  :group 'completion)
Richard M. Stallman's avatar
Richard M. Stallman committed
290

291
(defcustom save-completions-flag t
292
  "Non-nil means save most-used completions when exiting Emacs.
293
See also `save-completions-retention-time'."
294 295
  :type 'boolean
  :group 'completion)
Richard M. Stallman's avatar
Richard M. Stallman committed
296

297
(defcustom save-completions-file-name
298
  (locate-user-emacs-file "completions" ".completions")
299
  "The filename to save completions to."
300 301
  :type 'file
  :group 'completion)
Richard M. Stallman's avatar
Richard M. Stallman committed
302

303
(defcustom save-completions-retention-time 336
304
  "Discard a completion if unused for this many hours.
305
\(1 day = 24, 1 week = 168).  If this is 0, non-permanent completions
306 307 308
will not be saved unless these are used.  Default is two weeks."
  :type 'integer
  :group 'completion)
Richard M. Stallman's avatar
Richard M. Stallman committed
309

310
(defcustom completion-on-separator-character nil
311
  "Non-nil means separator characters mark previous word as used.
312 313 314
This means the word will be saved as a completion."
  :type 'boolean
  :group 'completion)
Richard M. Stallman's avatar
Richard M. Stallman committed
315

316
(defcustom completions-file-versions-kept kept-new-versions
317
  "Number of versions to keep for the saved completions file."
318 319
  :type 'integer
  :group 'completion)
Richard M. Stallman's avatar
Richard M. Stallman committed
320

321
(defcustom completion-prompt-speed-threshold 4800
322
  "Minimum output speed at which to display next potential completion."
323 324
  :type 'integer
  :group 'completion)
Richard M. Stallman's avatar
Richard M. Stallman committed
325

326
(defcustom completion-cdabbrev-prompt-flag nil
327
  "If non-nil, the next completion prompt does a cdabbrev search.
328 329 330
This can be time consuming."
  :type 'boolean
  :group 'completion)
Richard M. Stallman's avatar
Richard M. Stallman committed
331

332
(defcustom completion-search-distance 15000
333
  "How far to search in the buffer when looking for completions.
334 335 336
In number of characters.  If nil, search the whole buffer."
  :type 'integer
  :group 'completion)
Richard M. Stallman's avatar
Richard M. Stallman committed
337

338
(defcustom completions-merging-modes '(lisp c)
339
  "List of modes {`c' or `lisp'} for automatic completions merging.
340
Definitions from visited files which have these modes
341 342 343
are automatically added to the completion database."
  :type '(set (const lisp) (const c))
  :group 'completion)
Richard M. Stallman's avatar
Richard M. Stallman committed
344

Erik Naggum's avatar
Erik Naggum committed
345 346
;;(defvar *record-cmpl-statistics-p* nil
;;  "*If non-nil, record completion statistics.")
Richard M. Stallman's avatar
Richard M. Stallman committed
347

Erik Naggum's avatar
Erik Naggum committed
348 349 350
;;(defvar *completion-auto-save-period* 1800
;;  "*The period in seconds to wait for emacs to be idle before autosaving
;;the completions.  Default is a 1/2 hour.")
Richard M. Stallman's avatar
Richard M. Stallman committed
351

352
(defvar completion-min-length 6
Richard M. Stallman's avatar
Richard M. Stallman committed
353 354 355
  "*The minimum length of a stored completion.
DON'T CHANGE WITHOUT RECOMPILING !  This is used by macros.")

356
(defvar completion-max-length 200
Richard M. Stallman's avatar
Richard M. Stallman committed
357 358 359
  "*The maximum length of a stored completion.
DON'T CHANGE WITHOUT RECOMPILING !  This is used by macros.")

360
(defvar completion-prefix-min-length 3
Richard M. Stallman's avatar
Richard M. Stallman committed
361 362 363
  "The minimum length of a completion search string.
DON'T CHANGE WITHOUT RECOMPILING !  This is used by macros.")

Erik Naggum's avatar
Erik Naggum committed
364 365 366
;;---------------------------------------------------------------------------
;; Internal Variables
;;---------------------------------------------------------------------------
Richard M. Stallman's avatar
Richard M. Stallman committed
367 368

(defvar cmpl-initialized-p nil
369 370
  "Set to t when the completion system is initialized.
Indicates that the old completion file has been read in.")
Richard M. Stallman's avatar
Richard M. Stallman committed
371 372

(defvar cmpl-completions-accepted-p nil
373 374
  "Set to t as soon as the first completion has been accepted.
Used to decide whether to save completions.")
Richard M. Stallman's avatar
Richard M. Stallman committed
375

376
(defvar cmpl-preceding-syntax)
377 378

(defvar completion-string)
Richard M. Stallman's avatar
Richard M. Stallman committed
379

Erik Naggum's avatar
Erik Naggum committed
380 381 382
;;---------------------------------------------------------------------------
;; Low level tools
;;---------------------------------------------------------------------------
Richard M. Stallman's avatar
Richard M. Stallman committed
383

Erik Naggum's avatar
Erik Naggum committed
384 385 386
;;-----------------------------------------------
;; String case coercion
;;-----------------------------------------------
Richard M. Stallman's avatar
Richard M. Stallman committed
387 388

(defun cmpl-string-case-type (string)
389
  "Return :capitalized, :up, :down, :mixed, or :neither for case of STRING."
Richard M. Stallman's avatar
Richard M. Stallman committed
390
  (let ((case-fold-search nil))
391 392
    (cond ((string-match "[[:lower:]]" string)
	   (cond ((string-match "[[:upper:]]" string)
Richard M. Stallman's avatar
Richard M. Stallman committed
393
		  (cond ((and (> (length string) 1)
394 395
			      (null (string-match "[[:upper:]]" string 1)))
			 :capitalized)
Richard M. Stallman's avatar
Richard M. Stallman committed
396
			(t
397 398
			 :mixed)))
		 (t :down)))
Richard M. Stallman's avatar
Richard M. Stallman committed
399
	  (t
400 401 402
	   (cond ((string-match "[[:upper:]]" string)
		  :up)
		 (t :neither))))))
Richard M. Stallman's avatar
Richard M. Stallman committed
403

Erik Naggum's avatar
Erik Naggum committed
404 405 406 407 408 409
;; Tests -
;; (cmpl-string-case-type "123ABCDEF456") --> :up
;; (cmpl-string-case-type "123abcdef456") --> :down
;; (cmpl-string-case-type "123aBcDeF456") --> :mixed
;; (cmpl-string-case-type "123456")       --> :neither
;; (cmpl-string-case-type "Abcde123")     --> :capitalized
Richard M. Stallman's avatar
Richard M. Stallman committed
410 411

(defun cmpl-coerce-string-case (string case-type)
412 413 414
  (cond ((eq case-type :down) (downcase string))
	((eq case-type :up) (upcase string))
	((eq case-type :capitalized)
Richard M. Stallman's avatar
Richard M. Stallman committed
415 416 417
	 (setq string (downcase string))
	 (aset string 0 (logand ?\337 (aref string 0)))
	 string)
418
	(t string)))
Richard M. Stallman's avatar
Richard M. Stallman committed
419 420

(defun cmpl-merge-string-cases (string-to-coerce given-string)
421
  (let ((string-case-type (cmpl-string-case-type string-to-coerce)))
Richard M. Stallman's avatar
Richard M. Stallman committed
422 423 424 425
    (cond ((memq string-case-type '(:down :up :capitalized))
	   ;; Found string is in a standard case.  Coerce to a type based on
	   ;; the given string
	   (cmpl-coerce-string-case string-to-coerce
426
			       (cmpl-string-case-type given-string)))
Richard M. Stallman's avatar
Richard M. Stallman committed
427 428 429
	  (t
	   ;; If the found string is in some unusual case, just insert it
	   ;; as is
430
	   string-to-coerce))))
Richard M. Stallman's avatar
Richard M. Stallman committed
431

Erik Naggum's avatar
Erik Naggum committed
432 433 434 435 436
;; Tests -
;; (cmpl-merge-string-cases "AbCdEf456" "abc")     --> AbCdEf456
;; (cmpl-merge-string-cases "abcdef456" "ABC")     --> ABCDEF456
;; (cmpl-merge-string-cases "ABCDEF456" "Abc")     --> Abcdef456
;; (cmpl-merge-string-cases "ABCDEF456" "abc")     --> abcdef456
Richard M. Stallman's avatar
Richard M. Stallman committed
437 438


439 440
(defun cmpl-hours-since-origin ()
  (let ((time (current-time)))
441
    (floor (+ (* 65536.0 (nth 0 time)) (nth 1 time)) 3600)))
Richard M. Stallman's avatar
Richard M. Stallman committed
442

Erik Naggum's avatar
Erik Naggum committed
443 444 445 446 447 448 449 450 451
;;---------------------------------------------------------------------------
;; "Symbol" parsing functions
;;---------------------------------------------------------------------------
;; The functions symbol-before-point, symbol-under-point, etc. quickly return
;; an appropriate symbol string.  The strategy is to temporarily change
;; the syntax table to enable fast symbol searching.  There are three classes
;; of syntax in these "symbol" syntax tables ::
;;
;; syntax (?_) - "symbol" chars (e.g. alphanumerics)
452
;; syntax (?w) - symbol chars to ignore at end of words (e.g. period).
Erik Naggum's avatar
Erik Naggum committed
453 454 455
;; syntax (? ) - everything else
;;
;; Thus by judicious use of scan-sexps and forward-word, we can get
456
;; the word we want relatively fast and without consing.
Erik Naggum's avatar
Erik Naggum committed
457 458
;;
;; Why do we need a separate category for "symbol chars to ignore at ends" ?
459
;; For example, in LISP we want starting :'s trimmed
Erik Naggum's avatar
Erik Naggum committed
460 461
;; so keyword argument specifiers also define the keyword completion.  And,
;; for example, in C we want `.' appearing in a structure ref. to
462
;; be kept intact in order to store the whole structure ref.; however, if
Erik Naggum's avatar
Erik Naggum committed
463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478
;; it appears at the end of a symbol it should be discarded because it is
;; probably used as a period.

;; Here is the default completion syntax ::
;; Symbol chars :: A-Z a-z 0-9 @ / \ * + ~ $ < > %
;; Symbol chars to ignore at ends :: _ : . -
;; Separator chars. :: <tab> <space> ! ^ & ( ) = ` | { } [ ] ; " ' #
;;                     , ? <Everything else>

;; Mode specific differences and notes ::
;;  LISP diffs ->
;;    Symbol chars :: ! & ? = ^
;;
;; C diffs ->
;;   Separator chars :: + * / : %
;;  A note on the hyphen (`-').  Perhaps the hyphen should also be a separator
479
;; char., however, we wanted to have completion symbols include pointer
Erik Naggum's avatar
Erik Naggum committed
480 481 482 483 484 485 486 487 488 489 490 491 492 493 494
;; references.  For example, "foo->bar" is a symbol as far as completion is
;; concerned.
;;
;; FORTRAN diffs ->
;;   Separator chars :: + - * / :
;;
;; Pathname diffs ->
;;   Symbol chars :: .
;;  Of course there is no pathname "mode" and in fact we have not implemented
;; this table.  However, if there was such a mode, this is what it would look
;; like.

;;-----------------------------------------------
;; Table definitions
;;-----------------------------------------------
Richard M. Stallman's avatar
Richard M. Stallman committed
495

496
(defconst completion-standard-syntax-table
Richard M. Stallman's avatar
Richard M. Stallman committed
497
  (let ((table (make-syntax-table))
498
	i)
Richard M. Stallman's avatar
Richard M. Stallman committed
499 500 501 502 503
    ;; Default syntax is whitespace.
    (setq i 0)
    (while (< i 256)
      (modify-syntax-entry i " " table)
      (setq i (1+ i)))
Richard M. Stallman's avatar
Richard M. Stallman committed
504
    ;; alpha chars
505 506
    (setq i 0)
    (while (< i 26)
Richard M. Stallman's avatar
Richard M. Stallman committed
507
      (modify-syntax-entry (+ ?a i) "_" table)
508 509
      (modify-syntax-entry (+ ?A i) "_" table)
      (setq i (1+ i)))
Richard M. Stallman's avatar
Richard M. Stallman committed
510
    ;; digit chars.
511 512 513 514
    (setq i 0)
    (while (< i 10)
      (modify-syntax-entry (+ ?0 i) "_" table)
      (setq i (1+ i)))
Richard M. Stallman's avatar
Richard M. Stallman committed
515 516
    ;; Other ones
    (let ((symbol-chars '(?@ ?/ ?\\ ?* ?+ ?~ ?$ ?< ?> ?%))
517
	  (symbol-chars-ignore '(?_ ?- ?: ?.)))
518
      (dolist (char symbol-chars)
Richard M. Stallman's avatar
Richard M. Stallman committed
519
	(modify-syntax-entry char "_" table))
520
      (dolist (char symbol-chars-ignore)
521
	(modify-syntax-entry char "w" table)))
Richard M. Stallman's avatar
Richard M. Stallman committed
522 523
    table))

524
(defvar completion-syntax-table completion-standard-syntax-table
Richard M. Stallman's avatar
Richard M. Stallman committed
525
  "This variable holds the current completion syntax table.")
526
(make-variable-buffer-local 'completion-syntax-table)
Richard M. Stallman's avatar
Richard M. Stallman committed
527

Erik Naggum's avatar
Erik Naggum committed
528 529 530
;;-----------------------------------------------
;; Symbol functions
;;-----------------------------------------------
Richard M. Stallman's avatar
Richard M. Stallman committed
531
(defvar cmpl-symbol-start nil
532
  "Holds first character of symbol, after any completion symbol function.")
Richard M. Stallman's avatar
Richard M. Stallman committed
533
(defvar cmpl-symbol-end nil
534
  "Holds last character of symbol, after any completion symbol function.")
Richard M. Stallman's avatar
Richard M. Stallman committed
535 536

(defun symbol-under-point ()
537
  "Return the symbol that the point is currently on.
538
But only if it is longer than `completion-min-length'."
539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561
  (with-syntax-table completion-syntax-table
    (when (memq (char-syntax (following-char)) '(?w ?_))
      ;; Cursor is on following-char and after preceding-char
      (let ((saved-point (point)))
        (setq cmpl-symbol-start (scan-sexps (1+ saved-point) -1)
              cmpl-symbol-end (scan-sexps saved-point 1))
        ;; Remove chars to ignore at the start.
        (cond ((= (char-syntax (char-after cmpl-symbol-start)) ?w)
               (goto-char cmpl-symbol-start)
               (forward-word 1)
               (setq cmpl-symbol-start (point))
               (goto-char saved-point)))
        ;; Remove chars to ignore at the end.
        (cond ((= (char-syntax (char-after (1- cmpl-symbol-end))) ?w)
               (goto-char cmpl-symbol-end)
               (forward-word -1)
               (setq cmpl-symbol-end (point))
               (goto-char saved-point)))
        ;; Return completion if the length is reasonable.
        (if (and (<= completion-min-length
                     (- cmpl-symbol-end cmpl-symbol-start))
                 (<= (- cmpl-symbol-end cmpl-symbol-start)
                     completion-max-length))
562 563
            (buffer-substring-no-properties
             cmpl-symbol-start cmpl-symbol-end))))))
Richard M. Stallman's avatar
Richard M. Stallman committed
564

Erik Naggum's avatar
Erik Naggum committed
565 566 567 568 569 570 571 572 573 574 575
;; tests for symbol-under-point
;;  `^' indicates cursor pos. where value is returned
;;  simple-word-test
;;  ^^^^^^^^^^^^^^^^  --> simple-word-test
;;  _harder_word_test_
;;  ^^^^^^^^^^^^^^^^^^ --> harder_word_test
;;  .___.______.
;;  --> nil
;;  /foo/bar/quux.hello
;;  ^^^^^^^^^^^^^^^^^^^ --> /foo/bar/quux.hello
;;
Richard M. Stallman's avatar
Richard M. Stallman committed
576 577

(defun symbol-before-point ()
578
  "Return a string of the symbol immediately before point.
579
Returns nil if there isn't one longer than `completion-min-length'."
Richard M. Stallman's avatar
Richard M. Stallman committed
580
  ;; This is called when a word separator is typed so it must be FAST !
581 582 583 584 585 586 587 588 589 590 591 592 593 594 595
  (with-syntax-table completion-syntax-table
    ;; Cursor is on following-char and after preceding-char
    (cond ((= (setq cmpl-preceding-syntax (char-syntax (preceding-char))) ?_)
           ;; Number of chars to ignore at end.
           (setq cmpl-symbol-end (point)
                 cmpl-symbol-start (scan-sexps cmpl-symbol-end -1))
           ;; Remove chars to ignore at the start.
           (cond ((= (char-syntax (char-after cmpl-symbol-start)) ?w)
                  (goto-char cmpl-symbol-start)
                  (forward-word 1)
                  (setq cmpl-symbol-start (point))
                  (goto-char cmpl-symbol-end)))
           ;; Return value if long enough.
           (if (>= cmpl-symbol-end
                   (+ cmpl-symbol-start completion-min-length))
596 597
               (buffer-substring-no-properties
                cmpl-symbol-start cmpl-symbol-end)))
598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616
          ((= cmpl-preceding-syntax ?w)
           ;; chars to ignore at end
           (let ((saved-point (point)))
             (setq cmpl-symbol-start (scan-sexps saved-point -1))
             ;; take off chars. from end
             (forward-word -1)
             (setq cmpl-symbol-end (point))
             ;; remove chars to ignore at the start
             (cond ((= (char-syntax (char-after cmpl-symbol-start)) ?w)
                    (goto-char cmpl-symbol-start)
                    (forward-word 1)
                    (setq cmpl-symbol-start (point))))
             ;; Restore state.
             (goto-char saved-point)
             ;; Return completion if the length is reasonable
             (if (and (<= completion-min-length
                          (- cmpl-symbol-end cmpl-symbol-start))
                      (<= (- cmpl-symbol-end cmpl-symbol-start)
                          completion-max-length))
617 618
                 (buffer-substring-no-properties
                  cmpl-symbol-start cmpl-symbol-end)))))))
Richard M. Stallman's avatar
Richard M. Stallman committed
619

Erik Naggum's avatar
Erik Naggum committed
620 621 622 623 624 625 626 627 628 629 630 631 632
;; tests for symbol-before-point
;;  `^' indicates cursor pos. where value is returned
;;  simple-word-test
;;  ^ --> nil
;;   ^ --> nil
;;          ^  --> simple-w
;;                  ^ --> simple-word-test
;;  _harder_word_test_
;;                   ^  --> harder_word_test
;;                    ^  --> harder_word_test
;;          ^ --> harder
;;  .___....
;;  --> nil
Richard M. Stallman's avatar
Richard M. Stallman committed
633 634

(defun symbol-under-or-before-point ()
Erik Naggum's avatar
Erik Naggum committed
635 636 637 638
  ;; This could be made slightly faster but it is better to avoid
  ;; copying all the code.
  ;; However, it is only used by the completion string prompter.
  ;; If it comes into common use, it could be rewritten.
639 640 641 642 643
  (if (memq (with-syntax-table completion-syntax-table
              (char-syntax (following-char)))
            '(?w ?_))
      (symbol-under-point)
    (symbol-before-point)))
Richard M. Stallman's avatar
Richard M. Stallman committed
644 645 646 647 648 649 650


(defun symbol-before-point-for-complete ()
  ;; "Returns a string of the symbol immediately before point
  ;; or nil if there isn't one.  Like symbol-before-point but doesn't trim the
  ;; end chars."
  ;; Cursor is on following-char and after preceding-char
651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666
  (with-syntax-table completion-syntax-table
    (cond ((memq (setq cmpl-preceding-syntax (char-syntax (preceding-char)))
                 '(?_ ?w))
           (setq cmpl-symbol-end (point)
                 cmpl-symbol-start (scan-sexps cmpl-symbol-end -1))
           ;; Remove chars to ignore at the start.
           (cond ((= (char-syntax (char-after cmpl-symbol-start)) ?w)
                  (goto-char cmpl-symbol-start)
                  (forward-word 1)
                  (setq cmpl-symbol-start (point))
                  (goto-char cmpl-symbol-end)))
           ;; Return completion if the length is reasonable.
           (if (and (<= completion-prefix-min-length
                        (- cmpl-symbol-end cmpl-symbol-start))
                    (<= (- cmpl-symbol-end cmpl-symbol-start)
                        completion-max-length))
667 668
               (buffer-substring-no-properties
                cmpl-symbol-start cmpl-symbol-end))))))
Richard M. Stallman's avatar
Richard M. Stallman committed
669

Erik Naggum's avatar
Erik Naggum committed
670 671 672 673 674 675 676 677 678 679 680 681 682
;; tests for symbol-before-point-for-complete
;;  `^' indicates cursor pos. where value is returned
;;  simple-word-test
;;  ^ --> nil
;;   ^ --> nil
;;          ^  --> simple-w
;;                  ^ --> simple-word-test
;;  _harder_word_test_
;;                   ^  --> harder_word_test
;;                    ^  --> harder_word_test_
;;          ^ --> harder_
;;  .___....
;;  --> nil
Richard M. Stallman's avatar
Richard M. Stallman committed
683 684 685



Erik Naggum's avatar
Erik Naggum committed
686 687 688
;;---------------------------------------------------------------------------
;; Statistics Recording
;;---------------------------------------------------------------------------
Richard M. Stallman's avatar
Richard M. Stallman committed
689

Erik Naggum's avatar
Erik Naggum committed
690 691
;; Note that the guts of this has been turned off.  The guts
;; are in completion-stats.el.
Richard M. Stallman's avatar
Richard M. Stallman committed
692

Erik Naggum's avatar
Erik Naggum committed
693 694 695 696
;;-----------------------------------------------
;; Conditionalizing code on *record-cmpl-statistics-p*
;;-----------------------------------------------
;; All statistics code outside this block should use this
697
(defmacro cmpl-statistics-block (&rest body))
Erik Naggum's avatar
Erik Naggum committed
698 699 700
;;  "Only executes body if we are recording statistics."
;;  (list 'cond
;;	(list* '*record-cmpl-statistics-p* body)
701
;;	))
Richard M. Stallman's avatar
Richard M. Stallman committed
702

Erik Naggum's avatar
Erik Naggum committed
703 704 705
;;-----------------------------------------------
;; Completion Sources
;;-----------------------------------------------
Richard M. Stallman's avatar
Richard M. Stallman committed
706 707 708 709 710 711 712 713 714 715 716 717 718 719

;; ID numbers
(defconst cmpl-source-unknown 0)
(defconst cmpl-source-init-file 1)
(defconst cmpl-source-file-parsing 2)
(defconst cmpl-source-separator 3)
(defconst cmpl-source-cursor-moves 4)
(defconst cmpl-source-interactive 5)
(defconst cmpl-source-cdabbrev 6)
(defconst num-cmpl-sources 7)
(defvar current-completion-source cmpl-source-unknown)



Erik Naggum's avatar
Erik Naggum committed
720 721 722 723
;;---------------------------------------------------------------------------
;; Completion Method #2: dabbrev-expand style
;;---------------------------------------------------------------------------
;;
724
;;   This method is used if there are no useful stored completions.  It is
Erik Naggum's avatar
Erik Naggum committed
725 726 727 728 729 730 731
;; based on dabbrev-expand with these differences :
;;   1) Faster (we don't use regexps)
;;   2) case coercion handled correctly
;; This is called cdabbrev to differentiate it.
;;   We simply search backwards through the file looking for words which
;; start with the same letters we are trying to complete.
;;
Richard M. Stallman's avatar
Richard M. Stallman committed
732 733

(defvar cdabbrev-completions-tried nil)
Erik Naggum's avatar
Erik Naggum committed
734
;;  "A list of all the cdabbrev completions since the last reset.")
Richard M. Stallman's avatar
Richard M. Stallman committed
735 736

(defvar cdabbrev-current-point 0)
Erik Naggum's avatar
Erik Naggum committed
737
;;  "The current point position the cdabbrev search is at.")
Richard M. Stallman's avatar
Richard M. Stallman committed
738 739

(defvar cdabbrev-current-window nil)
740 741
;;  "The current window we are looking for cdabbrevs in.
;; Return t if looking in (other-buffer), nil if no more  cdabbrevs.")
Richard M. Stallman's avatar
Richard M. Stallman committed
742 743

(defvar cdabbrev-wrapped-p nil)
744
;;  "Return t if the cdabbrev search has wrapped around the file.")
Richard M. Stallman's avatar
Richard M. Stallman committed
745 746 747

(defvar cdabbrev-abbrev-string "")
(defvar cdabbrev-start-point 0)
748
(defvar cdabbrev-stop-point)
Richard M. Stallman's avatar
Richard M. Stallman committed
749

Erik Naggum's avatar
Erik Naggum committed
750 751 752 753 754 755 756
;; Test strings for cdabbrev
;; cdat-upcase   ;;same namestring
;; CDAT-UPCASE   ;;ok
;; cdat2         ;;too short
;; cdat-1-2-3-4  ;;ok
;; a-cdat-1      ;;doesn't start correctly
;; cdat-simple   ;;ok
Richard M. Stallman's avatar
Richard M. Stallman committed
757 758 759


(defun reset-cdabbrev (abbrev-string &optional initial-completions-tried)
760
  "Reset the cdabbrev search to search for ABBREV-STRING.
761
INITIAL-COMPLETIONS-TRIED is a list of downcased strings to ignore
Richard M. Stallman's avatar
Richard M. Stallman committed
762 763 764
during the search."
  (setq cdabbrev-abbrev-string abbrev-string
	cdabbrev-completions-tried
765 766
	(cons (downcase abbrev-string) initial-completions-tried))
  (reset-cdabbrev-window t))
Richard M. Stallman's avatar
Richard M. Stallman committed
767 768

(defun set-cdabbrev-buffer ()
Pavel Janík's avatar
Pavel Janík committed
769
  ;; cdabbrev-current-window must not be nil
Richard M. Stallman's avatar
Richard M. Stallman committed
770 771
  (set-buffer (if (eq cdabbrev-current-window t)
		  (other-buffer)
772
		  (window-buffer cdabbrev-current-window))))
Richard M. Stallman's avatar
Richard M. Stallman committed
773 774 775


(defun reset-cdabbrev-window (&optional initializep)
776
  "Reset the cdabbrev search to search for abbrev-string."
Richard M. Stallman's avatar
Richard M. Stallman committed
777 778
  ;; Set the window
  (cond (initializep
779
	 (setq cdabbrev-current-window (selected-window)))
Richard M. Stallman's avatar
Richard M. Stallman committed
780 781 782 783 784 785 786
	((eq cdabbrev-current-window t)
	 ;; Everything has failed
	 (setq cdabbrev-current-window nil))
	(cdabbrev-current-window
	 (setq cdabbrev-current-window (next-window cdabbrev-current-window))
	 (if (eq cdabbrev-current-window (selected-window))
	     ;; No more windows, try other buffer.
787
	     (setq cdabbrev-current-window t))))
788 789 790 791 792 793 794 795 796 797
  (if cdabbrev-current-window
      (save-excursion
	(set-cdabbrev-buffer)
	(setq cdabbrev-current-point (point)
	      cdabbrev-start-point cdabbrev-current-point
	      cdabbrev-stop-point
	      (if completion-search-distance
		  (max (point-min)
		       (- cdabbrev-start-point completion-search-distance))
		  (point-min))
798
	      cdabbrev-wrapped-p nil))))
Richard M. Stallman's avatar
Richard M. Stallman committed
799 800 801

(defun next-cdabbrev ()
  "Return the next possible cdabbrev expansion or nil if there isn't one.
802 803
`reset-cdabbrev' must've been called already.
This is sensitive to `case-fold-search'."
Richard M. Stallman's avatar
Richard M. Stallman committed
804 805
  ;; note that case-fold-search affects the behavior of this function
  ;; Bug: won't pick up an expansion that starts at the top of buffer
806
  (if cdabbrev-current-window
807
      (let (saved-point
808 809 810 811 812 813 814 815 816 817 818 819
	    saved-syntax
	    (expansion nil)
	    downcase-expansion tried-list syntax saved-point-2)
	(save-excursion
	  (unwind-protect
	      (progn
		;; Switch to current completion buffer
		(set-cdabbrev-buffer)
		;; Save current buffer state
		(setq saved-point  (point)
		      saved-syntax (syntax-table))
		;; Restore completion state
820
		(set-syntax-table completion-syntax-table)
821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839
		(goto-char cdabbrev-current-point)
		;; Loop looking for completions
		(while
		    ;; This code returns t if it should loop again
		    (cond
		      (;; search for the string
		       (search-backward cdabbrev-abbrev-string cdabbrev-stop-point t)
		       ;; return nil if the completion is valid
		       (not
			(and
			 ;; does it start with a separator char ?
			 (or (= (setq syntax (char-syntax (preceding-char))) ? )
			     (and (= syntax ?w)
				  ;; symbol char to ignore at end.  Are we at end ?
				  (progn
				    (setq saved-point-2 (point))
				    (forward-word -1)
				    (prog1
				      (= (char-syntax (preceding-char)) ? )
840
				      (goto-char saved-point-2)))))
841 842 843 844 845 846 847 848 849 850 851
			 ;; is the symbol long enough ?
			 (setq expansion (symbol-under-point))
			 ;; have we not tried this one before
			 (progn
			   ;; See if we've already used it
			   (setq tried-list cdabbrev-completions-tried
				 downcase-expansion (downcase expansion))
			   (while (and tried-list
				       (not (string-equal downcase-expansion
							  (car tried-list))))
			     ;; Already tried, don't choose this one
852
			     (setq tried-list (cdr tried-list)))
853 854 855 856
			   ;; at this point tried-list will be nil if this
			   ;; expansion has not yet been tried
			   (if tried-list
			       (setq expansion nil)
857
			       t)))))
858 859 860 861 862 863 864 865 866 867 868
		      ;; search failed
		      (cdabbrev-wrapped-p
		       ;; If already wrapped, then we've failed completely
		       nil)
		      (t
		       ;; need to wrap
		       (goto-char (setq cdabbrev-current-point
					(if completion-search-distance
					    (min (point-max) (+ cdabbrev-start-point completion-search-distance))
					    (point-max))))

869
		       (setq cdabbrev-wrapped-p t))))
870 871 872 873 874
		;; end of while loop
		(cond (expansion
		       ;; successful
		       (setq cdabbrev-completions-tried
			     (cons downcase-expansion cdabbrev-completions-tried)
875
			     cdabbrev-current-point (point)))))
876
	    (set-syntax-table saved-syntax)
877
	    (goto-char saved-point)))
878 879 880 881
	;; If no expansion, go to next window
	(cond (expansion)
	      (t (reset-cdabbrev-window)
		 (next-cdabbrev))))))
Richard M. Stallman's avatar
Richard M. Stallman committed
882

Erik Naggum's avatar
Erik Naggum committed
883 884 885 886 887 888 889 890 891 892
;; The following must be eval'd in the minibuffer ::
;; (reset-cdabbrev "cdat")
;; (next-cdabbrev)  --> "cdat-simple"
;; (next-cdabbrev)  --> "cdat-1-2-3-4"
;; (next-cdabbrev)  --> "CDAT-UPCASE"
;; (next-cdabbrev)  --> "cdat-wrapping"
;; (next-cdabbrev)  --> "cdat_start_sym"
;; (next-cdabbrev)  --> nil
;; (next-cdabbrev)  --> nil
;; (next-cdabbrev)  --> nil
Richard M. Stallman's avatar
Richard M. Stallman committed
893

Erik Naggum's avatar
Erik Naggum committed
894 895
;; _cdat_start_sym
;; cdat-wrapping
Richard M. Stallman's avatar
Richard M. Stallman committed
896 897


Erik Naggum's avatar
Erik Naggum committed
898 899 900 901 902 903 904 905 906 907 908 909 910 911
;;---------------------------------------------------------------------------
;; Completion Database
;;---------------------------------------------------------------------------

;; We use two storage modes for the two search types ::
;;  1) Prefix {cmpl-prefix-obarray} for looking up possible completions
;;      Used by search-completion-next
;;      the value of the symbol is nil or a cons of head and tail pointers
;;  2) Interning {cmpl-obarray} to see if it's in the database
;;      Used by find-exact-completion, completion-in-database-p
;;      The value of the symbol is the completion entry

;; bad things may happen if this length is changed due to the way
;; GNU implements obarrays
Richard M. Stallman's avatar
Richard M. Stallman committed
912 913 914
(defconst cmpl-obarray-length 511)

(defvar cmpl-prefix-obarray (make-vector cmpl-obarray-length 0)
915
  "An obarray used to store the downcased completion prefixes.
Richard M. Stallman's avatar
Richard M. Stallman committed
916 917 918 919 920 921
Each symbol is bound to a list of completion entries.")

(defvar cmpl-obarray (make-vector cmpl-obarray-length 0)
  "An obarray used to store the downcased completions.
Each symbol is bound to a single completion entry.")

Erik Naggum's avatar
Erik Naggum committed
922 923 924
;;-----------------------------------------------
;; Completion Entry Structure Definition
;;-----------------------------------------------
Richard M. Stallman's avatar
Richard M. Stallman committed
925

Erik Naggum's avatar
Erik Naggum committed
926 927
;; A completion entry is a LIST of string, prefix-symbol num-uses, and
;; last-use-time (the time the completion was last used)
Pavel Janík's avatar
Pavel Janík committed
928
;; last-use-time is t if the string should be kept permanently
Erik Naggum's avatar
Erik Naggum committed
929
;; num-uses is incremented every time the completion is used.
Richard M. Stallman's avatar
Richard M. Stallman committed
930

931
;; We chose lists because (car foo) is faster than (aref foo 0) and the
Erik Naggum's avatar
Erik Naggum committed
932
;; creation time is about the same.
Richard M. Stallman's avatar
Richard M. Stallman committed
933

Erik Naggum's avatar
Erik Naggum committed
934
;; READER MACROS
Richard M. Stallman's avatar
Richard M. Stallman committed
935 936 937 938 939

(defmacro completion-string (completion-entry)
  (list 'car completion-entry))

(defmacro completion-num-uses (completion-entry)
940
  ;;  "The number of times it has used.  Used to decide whether to save
Richard M. Stallman's avatar
Richard M. Stallman committed
941 942 943 944
  ;; it."
  (list 'car (list 'cdr completion-entry)))

(defmacro completion-last-use-time (completion-entry)
945
  ;;  "The time it was last used.  In hours since origin.  Used to decide
Pavel Janík's avatar
Pavel Janík committed
946
  ;; whether to save it.  t if one should always save it."
Richard M. Stallman's avatar
Richard M. Stallman committed
947 948 949 950 951
  (list 'nth 2 completion-entry))

(defmacro completion-source (completion-entry)
  (list 'nth 3 completion-entry))

Erik Naggum's avatar
Erik Naggum committed
952
;; WRITER MACROS
Richard M. Stallman's avatar
Richard M. Stallman committed
953 954 955 956 957 958 959 960 961
(defmacro set-completion-string (completion-entry string)
  (list 'setcar completion-entry string))

(defmacro set-completion-num-uses (completion-entry num-uses)
  (list 'setcar (list 'cdr completion-entry) num-uses))

(defmacro set-completion-last-use-time (completion-entry last-use-time)
  (list 'setcar (list 'cdr (list 'cdr completion-entry)) last-use-time))

Erik Naggum's avatar
Erik Naggum committed
962
;; CONSTRUCTOR
Richard M. Stallman's avatar
Richard M. Stallman committed
963
(defun make-completion (string)
964 965
  "Return a completion entry."
  (list string 0 nil current-completion-source))
Richard M. Stallman's avatar
Richard M. Stallman committed
966 967 968 969 970 971 972

;; Obsolete
;;(defmacro cmpl-prefix-entry-symbol (completion-entry)
;;  (list 'car (list 'cdr completion-entry)))



Erik Naggum's avatar
Erik Naggum committed
973 974 975 976
;;-----------------------------------------------
;; Prefix symbol entry definition
;;-----------------------------------------------
;; A cons of (head . tail)
Richard M. Stallman's avatar
Richard M. Stallman committed
977

Erik Naggum's avatar
Erik Naggum committed
978
;; READER Macros
Richard M. Stallman's avatar
Richard M. Stallman committed
979

980
(defalias 'cmpl-prefix-entry-head 'car)
Richard M. Stallman's avatar
Richard M. Stallman committed
981

982
(defalias 'cmpl-prefix-entry-tail 'cdr)
Richard M. Stallman's avatar
Richard M. Stallman committed
983

Erik Naggum's avatar
Erik Naggum committed
984
;; WRITER Macros
Richard M. Stallman's avatar
Richard M. Stallman committed
985 986 987 988 989 990 991

(defmacro set-cmpl-prefix-entry-head (prefix-entry new-head)
  (list 'setcar prefix-entry new-head))

(defmacro set-cmpl-prefix-entry-tail (prefix-entry new-tail)
  (list 'setcdr prefix-entry new-tail))

Erik Naggum's avatar
Erik Naggum committed
992
;; Constructor
Richard M. Stallman's avatar
Richard M. Stallman committed
993 994

(defun make-cmpl-prefix-entry (completion-entry-list)
995
  "Make a new prefix entry containing only completion-entry."
Richard M. Stallman's avatar
Richard M. Stallman committed
996 997
  (cons completion-entry-list completion-entry-list))

Erik Naggum's avatar
Erik Naggum committed
998 999 1000
;;-----------------------------------------------
;; Completion Database - Utilities
;;-----------------------------------------------
Richard M. Stallman's avatar
Richard M. Stallman committed
1001 1002

(defun clear-all-completions ()
1003
  "Initialize the completion storage.  All existing completions are lost."
Richard M. Stallman's avatar
Richard M. Stallman committed
1004 1005 1006 1007
  (interactive)
  (setq cmpl-prefix-obarray (make-vector cmpl-obarray-length 0))
  (setq cmpl-obarray (make-vector cmpl-obarray-length 0))
  (cmpl-statistics-block
1008
    (record-clear-all-completions)))
Richard M. Stallman's avatar
Richard M. Stallman committed
1009

1010 1011
(defvar completions-list-return-value)

Richard M. Stallman's avatar
Richard M. Stallman committed
1012
(defun list-all-completions ()
1013
  "Return a list of all the known completion entries."
1014
  (let ((completions-list-return-value nil))
Richard M. Stallman's avatar
Richard M. Stallman committed
1015
    (mapatoms 'list-all-completions-1 cmpl-prefix-obarray)
1016
    completions-list-return-value))
Richard M. Stallman's avatar
Richard M. Stallman committed
1017 1018 1019

(defun list-all-completions-1 (prefix-symbol)
  (if (boundp prefix-symbol)
1020
      (setq completions-list-return-value
Richard M. Stallman's avatar
Richard M. Stallman committed
1021
	    (append (cmpl-prefix-entry-head (symbol-value prefix-symbol))
1022
		    completions-list-return-value))))
Richard M. Stallman's avatar
Richard M. Stallman committed
1023 1024

(defun list-all-completions-by-hash-bucket ()
1025
  "Return list of lists of known completion entries, organized by hash bucket."
1026
  (let ((completions-list-return-value nil))
Richard M. Stallman's avatar
Richard M. Stallman committed
1027
    (mapatoms 'list-all-completions-by-hash-bucket-1 cmpl-prefix-obarray)
1028
    completions-list-return-value))
Richard M. Stallman's avatar
Richard M. Stallman committed
1029 1030 1031

(defun list-all-completions-by-hash-bucket-1 (prefix-symbol)
  (if (boundp prefix-symbol)
1032
      (setq completions-list-return-value
Richard M. Stallman's avatar
Richard M. Stallman committed
1033
	    (cons (cmpl-prefix-entry-head (symbol-value prefix-symbol))
1034
		  completions-list-return-value))))
Richard M. Stallman's avatar
Richard M. Stallman committed
1035 1036


Erik Naggum's avatar
Erik Naggum committed
1037 1038 1039 1040 1041 1042 1043
;;-----------------------------------------------
;; Updating the database
;;-----------------------------------------------
;;
;;   These are the internal functions used to update the datebase
;;
;;
1044 1045
(defvar completion-to-accept nil
  "Set to a string that is pending its acceptance.")
Richard M. Stallman's avatar
Richard M. Stallman committed
1046 1047
  ;; this checked by the top level reading functions

1048 1049 1050 1051 1052 1053 1054
(defvar cmpl-db-downcase-string nil
  "Setup by `find-exact-completion', etc.  The given string, downcased.")
(defvar cmpl-db-symbol nil
  "The interned symbol corresponding to `cmpl-db-downcase-string'.
Set up by `cmpl-db-symbol'.")
(defvar cmpl-db-prefix-symbol nil
  "The interned prefix symbol corresponding to `cmpl-db-downcase-string'.")
Richard M. Stallman's avatar
Richard M. Stallman committed
1055 1056
(defvar cmpl-db-entry nil)
(defvar cmpl-db-debug-p nil
Pavel Janík's avatar
Pavel Janík committed
1057
  "Set to t if you want to debug the database.")
Richard M. Stallman's avatar
Richard M. Stallman committed
1058

Erik Naggum's avatar
Erik Naggum committed
1059
;; READS
Richard M. Stallman's avatar
Richard M. Stallman committed
1060
(defun find-exact-completion (string)
1061
  "Return the completion entry for STRING or nil.
1062
Sets up `cmpl-db-downcase-string' and `cmpl-db-symbol'."
Richard M. Stallman's avatar
Richard M. Stallman committed
1063 1064 1065
  (and (boundp (setq cmpl-db-symbol
		     (intern (setq cmpl-db-downcase-string (downcase string))
			     cmpl-obarray)))
1066
       (symbol-value cmpl-db-symbol)))
Richard M. Stallman's avatar
Richard M. Stallman committed
1067 1068

(defun find-cmpl-prefix-entry (prefix-string)
1069
  "Return the prefix entry for string.
1070 1071 1072
Sets `cmpl-db-prefix-symbol'.
Prefix-string must be exactly `completion-prefix-min-length' long
and downcased.  Sets up `cmpl-db-prefix-symbol'."
Richard M. Stallman's avatar
Richard M. Stallman committed
1073 1074 1075 1076 1077 1078 1079 1080
  (and (boundp (setq cmpl-db-prefix-symbol
		     (intern prefix-string cmpl-prefix-obarray)))
       (symbol-value cmpl-db-prefix-symbol)))

(defvar inside-locate-completion-entry nil)
;; used to trap lossage in silent error correction

(defun locate-completion-entry (completion-entry prefix-entry)
1081
  "Locate the completion entry.
Christopher Zaborsky's avatar
Christopher Zaborsky committed
1082 1083
Returns a pointer to the element before the completion entry or nil if
the completion entry is at the head.
1084
Must be called after `find-exact-completion'."
Richard M. Stallman's avatar
Richard M. Stallman committed
1085
  (let ((prefix-list (cmpl-prefix-entry-head prefix-entry))
1086