completion.el 90.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 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 13 14 15 16 17 18 19 20 21 22
;; 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
;; the Free Software Foundation; either version 2, or (at your option)
;; 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
23 24 25
;; along with GNU Emacs; see the file COPYING.  If not, write to the
;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
;; Boston, MA 02111-1307, USA.
26 27

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

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

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

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


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

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

299 300 301 302
(defcustom save-completions-file-name (convert-standard-filename "~/.completions")
  "*The filename to save completions to."
  :type 'file
  :group 'completion)
Richard M. Stallman's avatar
Richard M. Stallman committed
303

304
(defcustom save-completions-retention-time 336
305 306
  "*Discard a completion if unused for this many hours.
\(1 day = 24, 1 week = 168).  If this is 0, non-permanent completions
307 308 309
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
310

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

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

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

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

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

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

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

Erik Naggum's avatar
Erik Naggum committed
349 350 351
;;(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
352

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

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

361
(defvar completion-prefix-min-length 3
Richard M. Stallman's avatar
Richard M. Stallman committed
362 363 364
  "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
365 366 367
;;---------------------------------------------------------------------------
;; Internal Variables
;;---------------------------------------------------------------------------
Richard M. Stallman's avatar
Richard M. Stallman committed
368 369

(defvar cmpl-initialized-p nil
370 371
  "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
372 373

(defvar cmpl-completions-accepted-p nil
374 375
  "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
376

377
(defvar cmpl-preceding-syntax)
378 379

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

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

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

Erik Naggum's avatar
Erik Naggum committed
405 406 407 408 409 410
;; 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
411 412

(defun cmpl-coerce-string-case (string case-type)
413 414 415
  (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
416 417 418
	 (setq string (downcase string))
	 (aset string 0 (logand ?\337 (aref string 0)))
	 string)
419
	(t string)))
Richard M. Stallman's avatar
Richard M. Stallman committed
420 421

(defun cmpl-merge-string-cases (string-to-coerce given-string)
422
  (let ((string-case-type (cmpl-string-case-type string-to-coerce)))
Richard M. Stallman's avatar
Richard M. Stallman committed
423 424 425 426
    (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
427
			       (cmpl-string-case-type given-string)))
Richard M. Stallman's avatar
Richard M. Stallman committed
428 429 430
	  (t
	   ;; If the found string is in some unusual case, just insert it
	   ;; as is
431
	   string-to-coerce))))
Richard M. Stallman's avatar
Richard M. Stallman committed
432

Erik Naggum's avatar
Erik Naggum committed
433 434 435 436 437
;; 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
438 439

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

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

525
(defconst cmpl-standard-syntax-table (cmpl-make-standard-completion-syntax-table))
Richard M. Stallman's avatar
Richard M. Stallman committed
526

527
(defun cmpl-make-lisp-completion-syntax-table ()
Richard M. Stallman's avatar
Richard M. Stallman committed
528
  (let ((table (copy-syntax-table cmpl-standard-syntax-table))
529
	(symbol-chars '(?! ?& ?? ?= ?^)))
530
    (dolist (char symbol-chars)
Richard M. Stallman's avatar
Richard M. Stallman committed
531 532
      (modify-syntax-entry char "_" table))
    table))
533

534
(defun cmpl-make-c-completion-syntax-table ()
Richard M. Stallman's avatar
Richard M. Stallman committed
535
  (let ((table (copy-syntax-table cmpl-standard-syntax-table))
536
	(separator-chars '(?+ ?* ?/ ?: ?%)))
537
    (dolist (char separator-chars)
Richard M. Stallman's avatar
Richard M. Stallman committed
538 539 540
      (modify-syntax-entry char " " table))
    table))

541
(defun cmpl-make-fortran-completion-syntax-table ()
Richard M. Stallman's avatar
Richard M. Stallman committed
542
  (let ((table (copy-syntax-table cmpl-standard-syntax-table))
543
	(separator-chars '(?+ ?- ?* ?/ ?:)))
544
    (dolist (char separator-chars)
Richard M. Stallman's avatar
Richard M. Stallman committed
545 546 547
      (modify-syntax-entry char " " table))
    table))

548 549 550
(defconst cmpl-lisp-syntax-table       (cmpl-make-lisp-completion-syntax-table))
(defconst cmpl-c-syntax-table          (cmpl-make-c-completion-syntax-table))
(defconst cmpl-fortran-syntax-table    (cmpl-make-fortran-completion-syntax-table))
Richard M. Stallman's avatar
Richard M. Stallman committed
551 552 553 554 555

(defvar cmpl-syntax-table cmpl-standard-syntax-table
  "This variable holds the current completion syntax table.")
(make-variable-buffer-local 'cmpl-syntax-table)

Erik Naggum's avatar
Erik Naggum committed
556 557 558
;;-----------------------------------------------
;; Symbol functions
;;-----------------------------------------------
Richard M. Stallman's avatar
Richard M. Stallman committed
559
(defvar cmpl-symbol-start nil
560
  "Holds first character of symbol, after any completion symbol function.")
Richard M. Stallman's avatar
Richard M. Stallman committed
561
(defvar cmpl-symbol-end nil
562
  "Holds last character of symbol, after any completion symbol function.")
Erik Naggum's avatar
Erik Naggum committed
563 564
;; These are temp. vars. we use to avoid using let.
;;   Why ?  Small speed improvement.
Richard M. Stallman's avatar
Richard M. Stallman committed
565 566 567 568
(defvar cmpl-saved-syntax nil)
(defvar cmpl-saved-point nil)

(defun symbol-under-point ()
569
  "Return the symbol that the point is currently on.
570
But only if it is longer than `completion-min-length'."
Richard M. Stallman's avatar
Richard M. Stallman committed
571
  (setq cmpl-saved-syntax (syntax-table))
572 573 574
  (unwind-protect
      (progn
	(set-syntax-table cmpl-syntax-table)
575
	(cond
576
	;; Cursor is on following-char and after preceding-char
577
	  ((memq (char-syntax (following-char)) '(?w ?_))
578 579 580 581 582 583 584 585
	   (setq cmpl-saved-point (point)
		 cmpl-symbol-start (scan-sexps (1+ cmpl-saved-point) -1)
		 cmpl-symbol-end (scan-sexps cmpl-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))
586
		  (goto-char cmpl-saved-point)))
587 588 589 590 591
	   ;; 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))
592
		  (goto-char cmpl-saved-point)))
593
	   ;; Return completion if the length is reasonable.
594
	   (if (and (<= completion-min-length
595 596
			(- cmpl-symbol-end cmpl-symbol-start))
		    (<= (- cmpl-symbol-end cmpl-symbol-start)
597
			completion-max-length))
598 599
	       (buffer-substring cmpl-symbol-start cmpl-symbol-end)))))
    (set-syntax-table cmpl-saved-syntax)))
Richard M. Stallman's avatar
Richard M. Stallman committed
600

Erik Naggum's avatar
Erik Naggum committed
601 602 603 604 605 606 607 608 609 610 611
;; 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
612 613

(defun symbol-before-point ()
614
  "Return a string of the symbol immediately before point.
615
Returns nil if there isn't one longer than `completion-min-length'."
Richard M. Stallman's avatar
Richard M. Stallman committed
616 617
  ;; This is called when a word separator is typed so it must be FAST !
  (setq cmpl-saved-syntax (syntax-table))
618 619 620 621 622 623 624
  (unwind-protect
      (progn
	(set-syntax-table cmpl-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)
625
		     cmpl-symbol-start (scan-sexps cmpl-symbol-end -1))
626 627 628 629 630
	       ;; 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))
631
		      (goto-char cmpl-symbol-end)))
632 633
	       ;; Return value if long enough.
	       (if (>= cmpl-symbol-end
634
		       (+ cmpl-symbol-start completion-min-length))
635
		   (buffer-substring cmpl-symbol-start cmpl-symbol-end)))
636 637 638 639 640 641 642 643 644 645 646
	      ((= cmpl-preceding-syntax ?w)
	       ;; chars to ignore at end
	       (setq cmpl-saved-point (point)
		     cmpl-symbol-start (scan-sexps cmpl-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)
647
		      (setq cmpl-symbol-start (point))))
648 649 650
	       ;; Restore state.
	       (goto-char cmpl-saved-point)
	       ;; Return completion if the length is reasonable
651
	       (if (and (<= completion-min-length
652 653
			    (- cmpl-symbol-end cmpl-symbol-start))
			(<= (- cmpl-symbol-end cmpl-symbol-start)
654
			    completion-max-length))
655 656
		   (buffer-substring cmpl-symbol-start cmpl-symbol-end)))))
    (set-syntax-table cmpl-saved-syntax)))
Richard M. Stallman's avatar
Richard M. Stallman committed
657

Erik Naggum's avatar
Erik Naggum committed
658 659 660 661 662 663 664 665 666 667 668 669 670
;; 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
671 672

(defun symbol-under-or-before-point ()
Erik Naggum's avatar
Erik Naggum committed
673 674 675 676
  ;; 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.
677 678 679 680 681 682 683 684
  (cond ((memq (progn
		 (setq cmpl-saved-syntax (syntax-table))
		 (unwind-protect
		     (progn
		       (set-syntax-table cmpl-syntax-table)
		       (char-syntax (following-char)))
		   (set-syntax-table cmpl-saved-syntax)))
	       '(?w ?_))
Richard M. Stallman's avatar
Richard M. Stallman committed
685 686
	 (symbol-under-point))
	(t
687
	 (symbol-before-point))))
Richard M. Stallman's avatar
Richard M. Stallman committed
688 689 690 691 692 693 694 695


(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
  (setq cmpl-saved-syntax (syntax-table))
696 697 698 699 700 701
  (unwind-protect
      (progn
	(set-syntax-table cmpl-syntax-table)
	(cond ((memq (setq cmpl-preceding-syntax (char-syntax (preceding-char)))
		     '(?_ ?w))
	       (setq cmpl-symbol-end (point)
702
		     cmpl-symbol-start (scan-sexps cmpl-symbol-end -1))
703 704 705 706 707
	       ;; 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))
708
		      (goto-char cmpl-symbol-end)))
709
	       ;; Return completion if the length is reasonable.
710
	       (if (and (<= completion-prefix-min-length
711 712
			    (- cmpl-symbol-end cmpl-symbol-start))
			(<= (- cmpl-symbol-end cmpl-symbol-start)
713
			    completion-max-length))
714 715 716
		   (buffer-substring cmpl-symbol-start cmpl-symbol-end)))))
    ;; Restore syntax table.
    (set-syntax-table cmpl-saved-syntax)))
Richard M. Stallman's avatar
Richard M. Stallman committed
717

Erik Naggum's avatar
Erik Naggum committed
718 719 720 721 722 723 724 725 726 727 728 729 730
;; 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
731 732 733



Erik Naggum's avatar
Erik Naggum committed
734 735 736
;;---------------------------------------------------------------------------
;; Statistics Recording
;;---------------------------------------------------------------------------
Richard M. Stallman's avatar
Richard M. Stallman committed
737

Erik Naggum's avatar
Erik Naggum committed
738 739
;; 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
740

Erik Naggum's avatar
Erik Naggum committed
741 742 743 744
;;-----------------------------------------------
;; Conditionalizing code on *record-cmpl-statistics-p*
;;-----------------------------------------------
;; All statistics code outside this block should use this
745
(defmacro cmpl-statistics-block (&rest body))
Erik Naggum's avatar
Erik Naggum committed
746 747 748
;;  "Only executes body if we are recording statistics."
;;  (list 'cond
;;	(list* '*record-cmpl-statistics-p* body)
749
;;	))
Richard M. Stallman's avatar
Richard M. Stallman committed
750

Erik Naggum's avatar
Erik Naggum committed
751 752 753
;;-----------------------------------------------
;; Completion Sources
;;-----------------------------------------------
Richard M. Stallman's avatar
Richard M. Stallman committed
754 755 756 757 758 759 760 761 762 763 764 765 766 767

;; 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
768 769 770 771
;;---------------------------------------------------------------------------
;; Completion Method #2: dabbrev-expand style
;;---------------------------------------------------------------------------
;;
772
;;   This method is used if there are no useful stored completions.  It is
Erik Naggum's avatar
Erik Naggum committed
773 774 775 776 777 778 779
;; 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
780 781

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

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

(defvar cdabbrev-current-window nil)
788 789
;;  "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
790 791

(defvar cdabbrev-wrapped-p nil)
792
;;  "Return t if the cdabbrev search has wrapped around the file.")
Richard M. Stallman's avatar
Richard M. Stallman committed
793 794 795

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

Erik Naggum's avatar
Erik Naggum committed
798 799 800 801 802 803 804
;; 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
805 806 807


(defun reset-cdabbrev (abbrev-string &optional initial-completions-tried)
808
  "Reset the cdabbrev search to search for ABBREV-STRING.
809
INITIAL-COMPLETIONS-TRIED is a list of downcased strings to ignore
Richard M. Stallman's avatar
Richard M. Stallman committed
810 811 812
during the search."
  (setq cdabbrev-abbrev-string abbrev-string
	cdabbrev-completions-tried
813 814
	(cons (downcase abbrev-string) initial-completions-tried))
  (reset-cdabbrev-window t))
Richard M. Stallman's avatar
Richard M. Stallman committed
815 816

(defun set-cdabbrev-buffer ()
Pavel Janík's avatar
Pavel Janík committed
817
  ;; cdabbrev-current-window must not be nil
Richard M. Stallman's avatar
Richard M. Stallman committed
818 819
  (set-buffer (if (eq cdabbrev-current-window t)
		  (other-buffer)
820
		  (window-buffer cdabbrev-current-window))))
Richard M. Stallman's avatar
Richard M. Stallman committed
821 822 823


(defun reset-cdabbrev-window (&optional initializep)
824
  "Reset the cdabbrev search to search for abbrev-string."
Richard M. Stallman's avatar
Richard M. Stallman committed
825 826
  ;; Set the window
  (cond (initializep
827
	 (setq cdabbrev-current-window (selected-window)))
Richard M. Stallman's avatar
Richard M. Stallman committed
828 829 830 831 832 833 834
	((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.
835
	     (setq cdabbrev-current-window t))))
836 837 838 839 840 841 842 843 844 845
  (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))
846
	      cdabbrev-wrapped-p nil))))
Richard M. Stallman's avatar
Richard M. Stallman committed
847 848 849

(defun next-cdabbrev ()
  "Return the next possible cdabbrev expansion or nil if there isn't one.
850 851
`reset-cdabbrev' must've been called already.
This is sensitive to `case-fold-search'."
Richard M. Stallman's avatar
Richard M. Stallman committed
852 853
  ;; 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
854
  (if cdabbrev-current-window
855
      (let (saved-point
856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887
	    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
		(set-syntax-table cmpl-syntax-table)
		(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)) ? )
888
				      (goto-char saved-point-2)))))
889 890 891 892 893 894 895 896 897 898 899
			 ;; 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
900
			     (setq tried-list (cdr tried-list)))
901 902 903 904
			   ;; at this point tried-list will be nil if this
			   ;; expansion has not yet been tried
			   (if tried-list
			       (setq expansion nil)
905
			       t)))))
906 907 908 909 910 911 912 913 914 915 916
		      ;; 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))))

917
		       (setq cdabbrev-wrapped-p t))))
918 919 920 921 922
		;; end of while loop
		(cond (expansion
		       ;; successful
		       (setq cdabbrev-completions-tried
			     (cons downcase-expansion cdabbrev-completions-tried)
923
			     cdabbrev-current-point (point)))))
924
	    (set-syntax-table saved-syntax)
925
	    (goto-char saved-point)))
926 927 928 929
	;; If no expansion, go to next window
	(cond (expansion)
	      (t (reset-cdabbrev-window)
		 (next-cdabbrev))))))
Richard M. Stallman's avatar
Richard M. Stallman committed
930

Erik Naggum's avatar
Erik Naggum committed
931 932 933 934 935 936 937 938 939 940
;; 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
941

Erik Naggum's avatar
Erik Naggum committed
942 943
;; _cdat_start_sym
;; cdat-wrapping
Richard M. Stallman's avatar
Richard M. Stallman committed
944 945


Erik Naggum's avatar
Erik Naggum committed
946 947 948 949 950 951 952 953 954 955 956 957 958 959
;;---------------------------------------------------------------------------
;; 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
960 961 962
(defconst cmpl-obarray-length 511)

(defvar cmpl-prefix-obarray (make-vector cmpl-obarray-length 0)
963
  "An obarray used to store the downcased completion prefixes.
Richard M. Stallman's avatar
Richard M. Stallman committed
964 965 966 967 968 969
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
970 971 972
;;-----------------------------------------------
;; Completion Entry Structure Definition
;;-----------------------------------------------
Richard M. Stallman's avatar
Richard M. Stallman committed
973

Erik Naggum's avatar
Erik Naggum committed
974 975
;; 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
976
;; last-use-time is t if the string should be kept permanently
Erik Naggum's avatar
Erik Naggum committed
977
;; num-uses is incremented every time the completion is used.
Richard M. Stallman's avatar
Richard M. Stallman committed
978

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

Erik Naggum's avatar
Erik Naggum committed
982
;; READER MACROS
Richard M. Stallman's avatar
Richard M. Stallman committed
983 984 985 986 987

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

(defmacro completion-num-uses (completion-entry)
988
  ;;  "The number of times it has used.  Used to decide whether to save
Richard M. Stallman's avatar
Richard M. Stallman committed
989 990 991 992
  ;; it."
  (list 'car (list 'cdr completion-entry)))

(defmacro completion-last-use-time (completion-entry)
993
  ;;  "The time it was last used.  In hours since origin.  Used to decide
Pavel Janík's avatar
Pavel Janík committed
994
  ;; whether to save it.  t if one should always save it."
Richard M. Stallman's avatar
Richard M. Stallman committed
995 996 997 998 999
  (list 'nth 2 completion-entry))

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

Erik Naggum's avatar
Erik Naggum committed
1000
;; WRITER MACROS
Richard M. Stallman's avatar
Richard M. Stallman committed
1001 1002 1003 1004 1005 1006 1007 1008 1009
(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
1010
;; CONSTRUCTOR
Richard M. Stallman's avatar
Richard M. Stallman committed
1011
(defun make-completion (string)
1012
  "Return a list of a completion entry."
Richard M. Stallman's avatar
Richard M. Stallman committed
1013 1014 1015 1016 1017 1018 1019 1020
  (list (list string 0 nil current-completion-source)))

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



Erik Naggum's avatar
Erik Naggum committed
1021 1022 1023 1024
;;-----------------------------------------------
;; Prefix symbol entry definition
;;-----------------------------------------------
;; A cons of (head . tail)
Richard M. Stallman's avatar
Richard M. Stallman committed
1025

Erik Naggum's avatar
Erik Naggum committed
1026
;; READER Macros
Richard M. Stallman's avatar
Richard M. Stallman committed
1027 1028 1029 1030 1031 1032 1033

(defmacro cmpl-prefix-entry-head (prefix-entry)
  (list 'car prefix-entry))

(defmacro cmpl-prefix-entry-tail (prefix-entry)
  (list 'cdr prefix-entry))

Erik Naggum's avatar
Erik Naggum committed
1034
;; WRITER Macros
Richard M. Stallman's avatar
Richard M. Stallman committed
1035 1036 1037 1038 1039 1040 1041

(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
1042
;; Constructor
Richard M. Stallman's avatar
Richard M. Stallman committed
1043 1044

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

Erik Naggum's avatar
Erik Naggum committed
1048 1049 1050
;;-----------------------------------------------
;; Completion Database - Utilities
;;-----------------------------------------------
Richard M. Stallman's avatar
Richard M. Stallman committed
1051 1052

(defun clear-all-completions ()
1053
  "Initialize the completion storage.  All existing completions are lost."