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

Glenn Morris's avatar
Glenn Morris committed
3
;; Copyright (C) 1990, 1993, 1995, 1997, 2001, 2002, 2003, 2004,
Glenn Morris's avatar
Glenn Morris committed
4
;;   2005, 2006, 2007 Free Software Foundation, Inc.
Eric S. Raymond's avatar
Eric S. Raymond committed
5

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

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

13 14
;; GNU Emacs is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
15
;; the Free Software Foundation; either version 3, or (at your option)
16 17 18 19 20 21 22 23
;; any later version.

;; 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
Erik Naggum's avatar
Erik Naggum committed
24
;; along with GNU Emacs; see the file COPYING.  If not, write to the
Lute Kamstra's avatar
Lute Kamstra committed
25 26
;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
;; Boston, MA 02110-1301, USA.
27 28

;;; Commentary:
Erik Naggum's avatar
Erik Naggum committed
29 30 31

;; What to put in .emacs
;;-----------------------
32
;; (dynamic-completion-mode)
Richard M. Stallman's avatar
Richard M. Stallman committed
33

Erik Naggum's avatar
Erik Naggum committed
34 35 36 37 38 39 40
;;---------------------------------------------------------------------------
;; Documentation [Slightly out of date]
;;---------------------------------------------------------------------------
;;  (also check the documentation string of the functions)
;;
;; Introduction
;;---------------
41
;;
Erik Naggum's avatar
Erik Naggum committed
42
;;     After you type a few characters, pressing the "complete" key inserts
43
;; the rest of the word you are likely to type.
Erik Naggum's avatar
Erik Naggum committed
44
;;
45
;; This watches all the words that you type and remembers them.  When
Erik Naggum's avatar
Erik Naggum committed
46
;; typing a new word, pressing "complete" (meta-return) "completes" the
47
;; word by inserting the most recently used word that begins with the
Erik Naggum's avatar
Erik Naggum committed
48 49 50 51
;; 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
52
;; entered the text by hand.  If you want the inserted extra characters
Erik Naggum's avatar
Erik Naggum committed
53 54 55
;; 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
56 57
;; 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
58 59
;; it uses an extended version of the dabbrev style completion.
;;
60 61
;;   You automatically save the completions you use to a file between
;; sessions.
Erik Naggum's avatar
Erik Naggum committed
62
;;
63
;;   Completion enables programmers to enter longer, more descriptive
Erik Naggum's avatar
Erik Naggum committed
64 65 66 67 68 69
;; variable names while typing fewer keystrokes than they normally would.
;;
;;
;; Full documentation
;;---------------------
;;
70
;;   A "word" is any string containing characters with either word or symbol
Erik Naggum's avatar
Erik Naggum committed
71 72 73 74 75 76 77 78
;; 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).
;;
79
;;  M-x completion-mode toggles whether or not new words are added to the
Erik Naggum's avatar
Erik Naggum committed
80 81 82 83 84
;; 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).
85 86
;; Activating this minor-mode (calling completion-initialize) loads
;; a completions database for a saved completions file
87
;; (default: ~/.completions).  When you exit, Emacs saves a copy of the
88 89
;; completions that you often use.  When you next start, Emacs loads in
;; the saved completion file.
Erik Naggum's avatar
Erik Naggum committed
90
;;
91 92
;;   The number of completions saved depends loosely on
;; *saved-completions-decay-factor*.  Completions that have never been
Erik Naggum's avatar
Erik Naggum committed
93 94 95
;; inserted via "complete" are not saved.  You are encouraged to experiment
;; with different functions (see compute-completion-min-num-uses).
;;
96 97
;;   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
98 99 100
;; add-permanent-completion to do this
;;
;;   Completions are saved only if enable-completion is T.  The number of old
101
;; versions kept of the saved completions file is controlled by
Erik Naggum's avatar
Erik Naggum committed
102 103 104
;; completions-file-versions-kept.
;;
;; COMPLETE KEY OPTIONS
105 106
;;   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
107 108 109 110 111 112 113 114
;;               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
115
;;   m-x kill-completion
Erik Naggum's avatar
Erik Naggum committed
116 117 118
;;     kills the completion at point.
;;   m-x add-completion
;;   m-x add-permanent-completion
119
;;
Erik Naggum's avatar
Erik Naggum committed
120 121 122 123 124
;; 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.
;;
125
;;   m-x add-completions-from-lisp-file
Erik Naggum's avatar
Erik Naggum committed
126 127 128 129 130 131 132 133 134 135 136
;;     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
137
;;   Completion is string case independent if case-fold-search has its
Erik Naggum's avatar
Erik Naggum committed
138
;;  normal default of T.  Also when the completion is inserted the case of the
139 140
;;  entry is coerced appropriately.
;;  [E.G.  APP --> APPROPRIATELY     app --> appropriately
Erik Naggum's avatar
Erik Naggum committed
141 142 143
;;         App --> Appropriately]
;;
;; INITIALIZATION
144 145
;;  The form `(completion-initialize)' initializes the completion system by
;; trying to load in the user's completions.  After the first call, further
146
;; calls have no effect so one should be careful not to put the form in a
Erik Naggum's avatar
Erik Naggum committed
147 148 149 150 151
;; site's standard site-init file.
;;
;;---------------------------------------------------------------------------
;;
;;
Richard M. Stallman's avatar
Richard M. Stallman committed
152

Erik Naggum's avatar
Erik Naggum committed
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 180 181 182
;;---------------------------------------------------------------------------
;; 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
;;
183
;;  completion-initialize
184
;;    Loads the completions file and sets up so that exiting emacs will
Erik Naggum's avatar
Erik Naggum committed
185 186
;;  save them.
;;
187
;;  save-completions-to-file &optional filename
Erik Naggum's avatar
Erik Naggum committed
188 189 190 191 192 193 194 195 196 197
;;  load-completions-from-file &optional filename
;;
;;-----------------------------------------------
;; Other functions
;;-----------------------------------------------
;;
;;  get-completion-list string
;;
;; These things are for manipulating the structure
;;  make-completion string num-uses
198
;;  completion-num-uses completion
Erik Naggum's avatar
Erik Naggum committed
199 200 201
;;  completion-string completion
;;  set-completion-num-uses completion num-uses
;;  set-completion-string completion string
202
;;
Erik Naggum's avatar
Erik Naggum committed
203
;;
Richard M. Stallman's avatar
Richard M. Stallman committed
204

Erik Naggum's avatar
Erik Naggum committed
205 206 207 208 209 210 211 212 213 214 215 216
;;-----------------------------------------------
;; 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
217
;;; Change Log:
Erik Naggum's avatar
Erik Naggum committed
218
;;-----------------------------------------------
219
;;    Sometime in '84 Brewster implemented a somewhat buggy version for
Erik Naggum's avatar
Erik Naggum committed
220
;; Symbolics LISPMs.
221
;;    Jan. '85 Jim became enamored of the idea and implemented a faster,
Erik Naggum's avatar
Erik Naggum committed
222 223
;; more robust version.
;;    With input from many users at TMC, (rose, craig, and gls come to mind),
224 225 226 227 228
;; 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
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 270 271 272
;; 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
273
;;  - added backup protection to save-completions-to-file (prevents
Erik Naggum's avatar
Erik Naggum committed
274
;;    problems with disk full errors)
Richard M. Stallman's avatar
Richard M. Stallman committed
275

Eric S. Raymond's avatar
Eric S. Raymond committed
276 277
;;; Code:

Erik Naggum's avatar
Erik Naggum committed
278 279 280
;;---------------------------------------------------------------------------
;; User changeable parameters
;;---------------------------------------------------------------------------
Richard M. Stallman's avatar
Richard M. Stallman committed
281

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


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

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

300 301 302 303
(defcustom save-completions-file-name
  (let ((olddef (convert-standard-filename "~/.completions")))
    (cond
     ((file-readable-p olddef) olddef)
304
     ((file-directory-p user-emacs-directory)
305
      (convert-standard-filename
306
       (expand-file-name "completions" user-emacs-directory)))
307 308
     (t olddef)))
  "The filename to save completions to."
309 310
  :type 'file
  :group 'completion)
Richard M. Stallman's avatar
Richard M. Stallman committed
311

312
(defcustom save-completions-retention-time 336
313
  "Discard a completion if unused for this many hours.
314
\(1 day = 24, 1 week = 168).  If this is 0, non-permanent completions
315 316 317
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
318

319
(defcustom completion-on-separator-character nil
320
  "Non-nil means separator characters mark previous word as used.
321 322 323
This means the word will be saved as a completion."
  :type 'boolean
  :group 'completion)
Richard M. Stallman's avatar
Richard M. Stallman committed
324

325
(defcustom completions-file-versions-kept kept-new-versions
326
  "Number of versions to keep for the saved completions file."
327 328
  :type 'integer
  :group 'completion)
Richard M. Stallman's avatar
Richard M. Stallman committed
329

330
(defcustom completion-prompt-speed-threshold 4800
331
  "Minimum output speed at which to display next potential completion."
332 333
  :type 'integer
  :group 'completion)
Richard M. Stallman's avatar
Richard M. Stallman committed
334

335
(defcustom completion-cdabbrev-prompt-flag nil
336
  "If non-nil, the next completion prompt does a cdabbrev search.
337 338 339
This can be time consuming."
  :type 'boolean
  :group 'completion)
Richard M. Stallman's avatar
Richard M. Stallman committed
340

341
(defcustom completion-search-distance 15000
342
  "How far to search in the buffer when looking for completions.
343 344 345
In number of characters.  If nil, search the whole buffer."
  :type 'integer
  :group 'completion)
Richard M. Stallman's avatar
Richard M. Stallman committed
346

347
(defcustom completions-merging-modes '(lisp c)
348
  "List of modes {`c' or `lisp'} for automatic completions merging.
349
Definitions from visited files which have these modes
350 351 352
are automatically added to the completion database."
  :type '(set (const lisp) (const c))
  :group 'completion)
Richard M. Stallman's avatar
Richard M. Stallman committed
353

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

Erik Naggum's avatar
Erik Naggum committed
357 358 359
;;(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
360

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

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

369
(defvar completion-prefix-min-length 3
Richard M. Stallman's avatar
Richard M. Stallman committed
370 371 372
  "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
373 374 375
;;---------------------------------------------------------------------------
;; Internal Variables
;;---------------------------------------------------------------------------
Richard M. Stallman's avatar
Richard M. Stallman committed
376 377

(defvar cmpl-initialized-p nil
378 379
  "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
380 381

(defvar cmpl-completions-accepted-p nil
382 383
  "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
384

385
(defvar cmpl-preceding-syntax)
386 387

(defvar completion-string)
Richard M. Stallman's avatar
Richard M. Stallman committed
388

Erik Naggum's avatar
Erik Naggum committed
389 390 391
;;---------------------------------------------------------------------------
;; Low level tools
;;---------------------------------------------------------------------------
Richard M. Stallman's avatar
Richard M. Stallman committed
392

Erik Naggum's avatar
Erik Naggum committed
393 394 395
;;-----------------------------------------------
;; String case coercion
;;-----------------------------------------------
Richard M. Stallman's avatar
Richard M. Stallman committed
396 397

(defun cmpl-string-case-type (string)
398
  "Return :capitalized, :up, :down, :mixed, or :neither for case of STRING."
Richard M. Stallman's avatar
Richard M. Stallman committed
399
  (let ((case-fold-search nil))
400 401
    (cond ((string-match "[[:lower:]]" string)
	   (cond ((string-match "[[:upper:]]" string)
Richard M. Stallman's avatar
Richard M. Stallman committed
402
		  (cond ((and (> (length string) 1)
403 404
			      (null (string-match "[[:upper:]]" string 1)))
			 :capitalized)
Richard M. Stallman's avatar
Richard M. Stallman committed
405
			(t
406 407
			 :mixed)))
		 (t :down)))
Richard M. Stallman's avatar
Richard M. Stallman committed
408
	  (t
409 410 411
	   (cond ((string-match "[[:upper:]]" string)
		  :up)
		 (t :neither))))))
Richard M. Stallman's avatar
Richard M. Stallman committed
412

Erik Naggum's avatar
Erik Naggum committed
413 414 415 416 417 418
;; 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
419 420

(defun cmpl-coerce-string-case (string case-type)
421 422 423
  (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
424 425 426
	 (setq string (downcase string))
	 (aset string 0 (logand ?\337 (aref string 0)))
	 string)
427
	(t string)))
Richard M. Stallman's avatar
Richard M. Stallman committed
428 429

(defun cmpl-merge-string-cases (string-to-coerce given-string)
430
  (let ((string-case-type (cmpl-string-case-type string-to-coerce)))
Richard M. Stallman's avatar
Richard M. Stallman committed
431 432 433 434
    (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
435
			       (cmpl-string-case-type given-string)))
Richard M. Stallman's avatar
Richard M. Stallman committed
436 437 438
	  (t
	   ;; If the found string is in some unusual case, just insert it
	   ;; as is
439
	   string-to-coerce))))
Richard M. Stallman's avatar
Richard M. Stallman committed
440

Erik Naggum's avatar
Erik Naggum committed
441 442 443 444 445
;; 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
446 447


448 449
(defun cmpl-hours-since-origin ()
  (let ((time (current-time)))
450
    (floor (+ (* 65536.0 (nth 0 time)) (nth 1 time)) 3600)))
Richard M. Stallman's avatar
Richard M. Stallman committed
451

Erik Naggum's avatar
Erik Naggum committed
452 453 454 455 456 457 458 459 460
;;---------------------------------------------------------------------------
;; "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)
461
;; syntax (?w) - symbol chars to ignore at end of words (e.g. period).
Erik Naggum's avatar
Erik Naggum committed
462 463 464
;; syntax (? ) - everything else
;;
;; Thus by judicious use of scan-sexps and forward-word, we can get
465
;; the word we want relatively fast and without consing.
Erik Naggum's avatar
Erik Naggum committed
466 467
;;
;; Why do we need a separate category for "symbol chars to ignore at ends" ?
468
;; For example, in LISP we want starting :'s trimmed
Erik Naggum's avatar
Erik Naggum committed
469 470
;; so keyword argument specifiers also define the keyword completion.  And,
;; for example, in C we want `.' appearing in a structure ref. to
471
;; be kept intact in order to store the whole structure ref.; however, if
Erik Naggum's avatar
Erik Naggum committed
472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487
;; 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
488
;; char., however, we wanted to have completion symbols include pointer
Erik Naggum's avatar
Erik Naggum committed
489 490 491 492 493 494 495 496 497 498 499 500 501 502 503
;; 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
504

505
(defconst completion-standard-syntax-table
Richard M. Stallman's avatar
Richard M. Stallman committed
506
  (let ((table (make-syntax-table))
507
	i)
Richard M. Stallman's avatar
Richard M. Stallman committed
508 509 510 511 512
    ;; 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
513
    ;; alpha chars
514 515
    (setq i 0)
    (while (< i 26)
Richard M. Stallman's avatar
Richard M. Stallman committed
516
      (modify-syntax-entry (+ ?a i) "_" table)
517 518
      (modify-syntax-entry (+ ?A i) "_" table)
      (setq i (1+ i)))
Richard M. Stallman's avatar
Richard M. Stallman committed
519
    ;; digit chars.
520 521 522 523
    (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
524 525
    ;; Other ones
    (let ((symbol-chars '(?@ ?/ ?\\ ?* ?+ ?~ ?$ ?< ?> ?%))
526
	  (symbol-chars-ignore '(?_ ?- ?: ?.)))
527
      (dolist (char symbol-chars)
Richard M. Stallman's avatar
Richard M. Stallman committed
528
	(modify-syntax-entry char "_" table))
529
      (dolist (char symbol-chars-ignore)
530
	(modify-syntax-entry char "w" table)))
Richard M. Stallman's avatar
Richard M. Stallman committed
531 532
    table))

533
(defvar completion-syntax-table completion-standard-syntax-table
Richard M. Stallman's avatar
Richard M. Stallman committed
534
  "This variable holds the current completion syntax table.")
535
(make-variable-buffer-local 'completion-syntax-table)
Richard M. Stallman's avatar
Richard M. Stallman committed
536

Erik Naggum's avatar
Erik Naggum committed
537 538 539
;;-----------------------------------------------
;; Symbol functions
;;-----------------------------------------------
Richard M. Stallman's avatar
Richard M. Stallman committed
540
(defvar cmpl-symbol-start nil
541
  "Holds first character of symbol, after any completion symbol function.")
Richard M. Stallman's avatar
Richard M. Stallman committed
542
(defvar cmpl-symbol-end nil
543
  "Holds last character of symbol, after any completion symbol function.")
Richard M. Stallman's avatar
Richard M. Stallman committed
544 545

(defun symbol-under-point ()
546
  "Return the symbol that the point is currently on.
547
But only if it is longer than `completion-min-length'."
548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571
  (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))
            (buffer-substring cmpl-symbol-start cmpl-symbol-end))))))
Richard M. Stallman's avatar
Richard M. Stallman committed
572

Erik Naggum's avatar
Erik Naggum committed
573 574 575 576 577 578 579 580 581 582 583
;; 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
584 585

(defun symbol-before-point ()
586
  "Return a string of the symbol immediately before point.
587
Returns nil if there isn't one longer than `completion-min-length'."
Richard M. Stallman's avatar
Richard M. Stallman committed
588
  ;; This is called when a word separator is typed so it must be FAST !
589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624
  (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))
               (buffer-substring cmpl-symbol-start cmpl-symbol-end)))
          ((= 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))
                 (buffer-substring cmpl-symbol-start cmpl-symbol-end)))))))
Richard M. Stallman's avatar
Richard M. Stallman committed
625

Erik Naggum's avatar
Erik Naggum committed
626 627 628 629 630 631 632 633 634 635 636 637 638
;; 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
639 640

(defun symbol-under-or-before-point ()
Erik Naggum's avatar
Erik Naggum committed
641 642 643 644
  ;; 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.
645 646 647 648 649
  (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
650 651 652 653 654 655 656


(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
657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673
  (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))
               (buffer-substring cmpl-symbol-start cmpl-symbol-end))))))
Richard M. Stallman's avatar
Richard M. Stallman committed
674

Erik Naggum's avatar
Erik Naggum committed
675 676 677 678 679 680 681 682 683 684 685 686 687
;; 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
688 689 690



Erik Naggum's avatar
Erik Naggum committed
691 692 693
;;---------------------------------------------------------------------------
;; Statistics Recording
;;---------------------------------------------------------------------------
Richard M. Stallman's avatar
Richard M. Stallman committed
694

Erik Naggum's avatar
Erik Naggum committed
695 696
;; 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
697

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

Erik Naggum's avatar
Erik Naggum committed
708 709 710
;;-----------------------------------------------
;; Completion Sources
;;-----------------------------------------------
Richard M. Stallman's avatar
Richard M. Stallman committed
711 712 713 714 715 716 717 718 719 720 721 722 723 724

;; 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
725 726 727 728
;;---------------------------------------------------------------------------
;; Completion Method #2: dabbrev-expand style
;;---------------------------------------------------------------------------
;;
729
;;   This method is used if there are no useful stored completions.  It is
Erik Naggum's avatar
Erik Naggum committed
730 731 732 733 734 735 736
;; 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
737 738

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

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

(defvar cdabbrev-current-window nil)
745 746
;;  "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
747 748

(defvar cdabbrev-wrapped-p nil)
749
;;  "Return t if the cdabbrev search has wrapped around the file.")
Richard M. Stallman's avatar
Richard M. Stallman committed
750 751 752

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

Erik Naggum's avatar
Erik Naggum committed
755 756 757 758 759 760 761
;; 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
762 763 764


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

(defun set-cdabbrev-buffer ()
Pavel Janík's avatar
Pavel Janík committed
774
  ;; cdabbrev-current-window must not be nil
Richard M. Stallman's avatar
Richard M. Stallman committed
775 776
  (set-buffer (if (eq cdabbrev-current-window t)
		  (other-buffer)
777
		  (window-buffer cdabbrev-current-window))))
Richard M. Stallman's avatar
Richard M. Stallman committed
778 779 780


(defun reset-cdabbrev-window (&optional initializep)
781
  "Reset the cdabbrev search to search for abbrev-string."
Richard M. Stallman's avatar
Richard M. Stallman committed
782 783
  ;; Set the window
  (cond (initializep
784
	 (setq cdabbrev-current-window (selected-window)))
Richard M. Stallman's avatar
Richard M. Stallman committed
785 786 787 788 789 790 791
	((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.
792
	     (setq cdabbrev-current-window t))))
793 794 795 796 797 798 799 800 801 802
  (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))
803
	      cdabbrev-wrapped-p nil))))
Richard M. Stallman's avatar
Richard M. Stallman committed
804 805 806

(defun next-cdabbrev ()
  "Return the next possible cdabbrev expansion or nil if there isn't one.
807 808
`reset-cdabbrev' must've been called already.
This is sensitive to `case-fold-search'."
Richard M. Stallman's avatar
Richard M. Stallman committed
809 810
  ;; 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
811
  (if cdabbrev-current-window
812
      (let (saved-point
813 814 815 816 817 818 819 820 821 822 823 824
	    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
825
		(set-syntax-table completion-syntax-table)
826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844
		(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)) ? )
845
				      (goto-char saved-point-2)))))
846 847 848 849 850 851 852 853 854 855 856
			 ;; 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
857
			     (setq tried-list (cdr tried-list)))
858 859 860 861
			   ;; at this point tried-list will be nil if this
			   ;; expansion has not yet been tried
			   (if tried-list
			       (setq expansion nil)
862
			       t)))))
863 864 865 866 867 868 869 870 871 872 873
		      ;; 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))))

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

Erik Naggum's avatar
Erik Naggum committed
888 889 890 891 892 893 894 895 896 897
;; 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
898

Erik Naggum's avatar
Erik Naggum committed
899 900
;; _cdat_start_sym
;; cdat-wrapping
Richard M. Stallman's avatar
Richard M. Stallman committed
901 902


Erik Naggum's avatar
Erik Naggum committed
903 904 905 906 907 908 909 910 911 912 913 914 915 916
;;---------------------------------------------------------------------------
;; 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
917 918 919
(defconst cmpl-obarray-length 511)

(defvar cmpl-prefix-obarray (make-vector cmpl-obarray-length 0)
920
  "An obarray used to store the downcased completion prefixes.
Richard M. Stallman's avatar
Richard M. Stallman committed
921 922 923 924 925 926
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
927 928 929
;;-----------------------------------------------
;; Completion Entry Structure Definition
;;-----------------------------------------------
Richard M. Stallman's avatar
Richard M. Stallman committed
930

Erik Naggum's avatar
Erik Naggum committed
931 932
;; 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
933
;; last-use-time is t if the string should be kept permanently
Erik Naggum's avatar
Erik Naggum committed
934
;; num-uses is incremented every time the completion is used.
Richard M. Stallman's avatar
Richard M. Stallman committed
935

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

Erik Naggum's avatar
Erik Naggum committed
939
;; READER MACROS
Richard M. Stallman's avatar
Richard M. Stallman committed
940 941 942 943 944

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

(defmacro completion-num-uses (completion-entry)
945
  ;;  "The number of times it has used.  Used to decide whether to save
Richard M. Stallman's avatar
Richard M. Stallman committed
946 947 948 949
  ;; it."
  (list 'car (list 'cdr completion-entry)))

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

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

Erik Naggum's avatar
Erik Naggum committed
957
;; WRITER MACROS
Richard M. Stallman's avatar
Richard M. Stallman committed
958 959 960 961 962 963 964 965 966
(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
967
;; CONSTRUCTOR
Richard M. Stallman's avatar
Richard M. Stallman committed
968
(defun make-completion (string)
969 970
  "Return a completion entry."
  (list string 0 nil current-completion-source))
Richard M. Stallman's avatar
Richard M. Stallman committed
971 972 973 974 975 976 977

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



Erik Naggum's avatar
Erik Naggum committed
978 979 980 981
;;-----------------------------------------------
;; Prefix symbol entry definition
;;-----------------------------------------------
;; A cons of (head . tail)
Richard M. Stallman's avatar
Richard M. Stallman committed
982

Erik Naggum's avatar
Erik Naggum committed
983
;; READER Macros
Richard M. Stallman's avatar
Richard M. Stallman committed
984

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

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

Erik Naggum's avatar
Erik Naggum committed
989
;; WRITER Macros
Richard M. Stallman's avatar
Richard M. Stallman committed
990 991 992 993 994 995 996

(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
997
;; Constructor
Richard M. Stallman's avatar
Richard M. Stallman committed
998 999

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

Erik Naggum's avatar
Erik Naggum committed
1003 1004 1005
;;-----------------------------------------------
;; Completion Database - Utilities
;;-----------------------------------------------
Richard M. Stallman's avatar
Richard M. Stallman committed
1006 1007

(defun clear-all-completions ()
1008
  "Initialize the completion storage.  All existing completions are lost."
Richard M. Stallman's avatar
Richard M. Stallman committed
1009 1010 1011 1012
  (interactive)
  (setq cmpl-prefix-obarray (make-vector cmpl-obarray-length 0))
  (setq cmpl-obarray (make-vector cmpl-obarray-length 0))
  (cmpl-statistics-block
1013
    (record-clear-all-completions)))
Richard M. Stallman's avatar
Richard M. Stallman committed
1014

1015 1016
(defvar completions-list-return-value)

Richard M. Stallman's avatar
Richard M. Stallman committed
1017
(defun list-all-completions ()
1018
  "Return a list of all the known completion entries."
1019
  (let ((completions-list-return-value nil))
Richard M. Stallman's avatar
Richard M. Stallman committed
1020
    (mapatoms 'list-all-completions-1 cmpl-prefix-obarray)
1021
    completions-list-return-value))
Richard M. Stallman's avatar
Richard M. Stallman committed
1022 1023 1024

(defun list-all-completions-1 (prefix-symbol)
  (if (boundp prefix-symbol)
1025
      (setq completions-list-return-value
Richard M. Stallman's avatar
Richard M. Stallman committed
1026
	    (append (cmpl-prefix-entry-head (symbol-value prefix-symbol))
1027
		    completions-list-return-value))))
Richard M. Stallman's avatar
Richard M. Stallman committed
1028 1029

(defun list-all-completions-by-hash-bucket ()
1030
  "Return list of lists of known completion entries, organized by hash bucket."
1031
  (let ((completions-list-return-value nil))
Richard M. Stallman's avatar
Richard M. Stallman committed
1032
    (mapatoms 'list-all-completions-by-hash-bucket-1 cmpl-prefix-obarray)
1033
    completions-list-return-value))
Richard M. Stallman's avatar
Richard M. Stallman committed
1034 1035 1036

(defun list-all-completions-by-hash-bucket-1 (prefix-symbol)
  (if (boundp prefix-symbol)
1037
      (setq completions-list-return-value
Richard M. Stallman's avatar
Richard M. Stallman committed
1038
	    (cons (cmpl-prefix-entry-head (symbol-value prefix-symbol))
1039
		  completions-list-return-value))))
Richard M. Stallman's avatar
Richard M. Stallman committed
1040 1041

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

1053 1054 1055 1056 1057 1058 1059
(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
1060 1061
(defvar cmpl-db-entry nil)
(defvar cmpl-db-debug-p nil
Pavel Janík's avatar
Pavel Janík committed
1062
  "Set to t if you want to debug the database.")
Richard M. Stallman's avatar
Richard M. Stallman committed
1063

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

(defun find-cmpl-prefix-entry (prefix-string)
1074
  "Return the prefix entry for string.
1075 1076 1077
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
1078 1079 1080 1081 1082 1083 1084 1085
  (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)
1086
  "Locate the completion entry.
Christopher Zaborsky's avatar
Christopher Zaborsky committed
1087 1088
Returns a pointer to the element before the completion entry or nil if
the completion entry is at the head.
1089
Must be called after `find-exact-completion'."
Richard M. Stallman's avatar
Richard M. Stallman committed
1090
  (let ((prefix-list (cmpl-prefix-entry-head prefix-entry))
1091
	 next-prefix-list)
Richard M. Stallman's avatar
Richard M. Stallman committed
1092 1093 1094 1095 1096
    (cond
      ((not (eq (car prefix-list) completion-entry))
       ;; not already at head
       (while (and prefix-list
		   (not (eq completion-entry
1097
			    (car (setq next-prefix-list (cdr prefix-list))))))
Richard M. Stallman's avatar
Richard M. Stallman committed
1098 1099 1100 1101 1102 1103 1104
	 (setq prefix-list next-prefix-list))
       (cond (;; found
	      prefix-list)
	     ;; Didn't find it.  Database is messed up.
	     (cmpl-db-debug-p
	      ;; not found, error if debug mode
	      (error "Completion entry exists but not on prefix list - %s"
1105
		     completion-string))
Richard M. Stallman's avatar
Richard M. Stallman committed
1106 1107 1108 1109 1110 1111 1112
	     (inside-locate-completion-entry
	      ;; recursive error: really scrod
	      (locate-completion-db-error))
	     (t
	       ;; Patch out
	       (set cmpl-db-symbol nil)
	       ;; Retry
1113
	       (locate-completion-entry-retry completion-entry)))))))
Richard M. Stallman's avatar
Richard M. Stallman committed
1114 1115 1116 1117 1118 1119

(defun locate-completion-entry-retry (old-entry)
  (let ((inside-locate-completion-entry t))
    (add-completion (completion-string old-entry)
		    (completion-num-uses old-entry)
		    (completion-last-use-time old-entry))
1120 1121 1122 1123 1124
    (let* ((cmpl-entry (find-exact-completion (completion-string old-entry)))
	   (pref-entry
	    (if cmpl-entry
		(find-cmpl-prefix-entry
		  (substring cmpl-db-downcase-string
1125
			     0 completion-prefix-min-length)))))
Richard M. Stallman's avatar
Richard M. Stallman committed
1126 1127 1128 1129
      (if (and cmpl-entry pref-entry)
	  ;; try again
	  (locate-completion-entry cmpl-entry pref-entry)
	  ;; still losing
1130
	  (locate-completion-db-error)))))
Richard M. Stallman's avatar
Richard M. Stallman committed
1131 1132 1133

(defun locate-completion-db-error ()
  ;; recursive error: really scrod
1134
  (error "Completion database corrupted.  Try M-x clear-all-completions.  Send bug report"))
Richard M. Stallman's avatar
Richard M. Stallman committed
1135

Erik Naggum's avatar
Erik Naggum committed
1136
;; WRITES
Richard M. Stallman's avatar
Richard M. Stallman committed
1137
(defun add-completion-to-tail-if-new (string)
Christopher Zaborsky's avatar
Christopher Zaborsky committed
1138
  "If STRING is not in the database add it to appropriate prefix list.
1139
STRING is added to the end of the appropriate prefix list with
Christopher Zaborsky's avatar
Christopher Zaborsky committed
1140
num-uses = 0.  The database is unchanged if it is there.  STRING must be
1141
longer than `completion-prefix-min-length'.
Richard M. Stallman's avatar
Richard M. Stallman committed
1142 1143 1144 1145 1146
This must be very fast.
Returns the completion entry."
  (or (find-exact-completion string)
      ;; not there
      (let (;; create an entry
1147
	    (entry (list (make-completion string)))
Richard M. Stallman's avatar
Richard M. Stallman committed
1148 1149 1150
	    ;; setup the prefix
	    (prefix-entry (find-cmpl-prefix-entry
			    (substring cmpl-db-downcase-string 0
1151
				       completion-prefix-min-length))))
Richard M. Stallman's avatar
Richard M. Stallman committed
1152 1153 1154 1155 1156 1157 1158 1159
	;; The next two forms should happen as a unit (atomically) but
	;; no fatal errors should result if that is not the case.
	(cond (prefix-entry
	       ;; These two should be atomic, but nothing fatal will happen
	       ;; if they're not.
	       (setcdr (cmpl-prefix-entry-tail prefix-entry) entry)
	       (set-cmpl-prefix-entry-tail prefix-entry entry))
	      (t
1160
	       (set cmpl-db-prefix-symbol (make-cmpl-prefix-entry entry))))
Richard M. Stallman's avatar
Richard M. Stallman committed
1161 1162 1163 1164
	;; statistics
	(cmpl-statistics-block
	  (note-added-completion))
	;; set symbol
1165
	(set cmpl-db-symbol (car entry)))))
Richard M. Stallman's avatar
Richard M. Stallman committed
1166