completion.el 93.7 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 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150
;;---------------------------------------------------------------------------
;; Documentation [Slightly out of date]
;;---------------------------------------------------------------------------
;;  (also check the documentation string of the functions)
;;
;; Introduction
;;---------------
;;  
;;     After you type a few characters, pressing the "complete" key inserts
;; the rest of the word you are likely to type.  
;;
;; This watches all the words that you type and remembers them.  When 
;; typing a new word, pressing "complete" (meta-return) "completes" the
;; word by inserting the most recently used word that begins with the 
;; 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
;; entered the text by hand.  If you want the inserted extra characters 
;; 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
;; 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, 
;; it uses an extended version of the dabbrev style completion.
;;
;;   You automatically save the completions you use to a file between 
;; sessions.  
;;
;;   Completion enables programmers to enter longer, more descriptive 
;; variable names while typing fewer keystrokes than they normally would.
;;
;;
;; Full documentation
;;---------------------
;;
;;   A "word" is any string containing characters with either word or symbol 
;; 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).
;;
;;  M-X completion-mode toggles whether or not new words are added to the
;; 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
;; to load a completions database for a saved completions file 
;; (default: ~/.completions).  When you exit, EMACS saves a copy of the
;; completions that you 
;; often use.  When you next start, EMACS loads in the saved completion file.
;;
;;   The number of completions saved depends loosely on 
;; *saved-completions-decay-factor*.  Completions that have never been 
;; inserted via "complete" are not saved.  You are encouraged to experiment
;; with different functions (see compute-completion-min-num-uses).
;;
;;   Some completions are permanent and are always saved out.  These 
;; completions have their num-uses slot set to T.  Use 
;; add-permanent-completion to do this
;;
;;   Completions are saved only if enable-completion is T.  The number of old
;; versions kept of the saved completions file is controlled by 
;; completions-file-versions-kept.
;;
;; COMPLETE KEY OPTIONS
;;   The complete function takes a numeric arguments.  
;;  control-u :: leave the point at the beginning of the completion rather 
;;               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
;;   m-x kill-completion 
;;     kills the completion at point.
;;   m-x add-completion
;;   m-x add-permanent-completion
;;   
;; 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.
;;
;;   m-x add-completions-from-lisp-file 
;;     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
;;   Completion is string case independent if case-fold-search has its 
;;  normal default of T.  Also when the completion is inserted the case of the
;;  entry is coerced appropriately.  
;;  [E.G.  APP --> APPROPRIATELY     app --> appropriately  
;;         App --> Appropriately]
;;
;; INITIALIZATION
;;  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 
;; 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 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202
;;---------------------------------------------------------------------------
;; 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
;;    Loads the completions file and sets up so that exiting emacs will 
;;  save them.
;;
;;  save-completions-to-file &optional filename  
;;  load-completions-from-file &optional filename
;;
;;-----------------------------------------------
;; Other functions
;;-----------------------------------------------
;;
;;  get-completion-list string
;;
;; These things are for manipulating the structure
;;  make-completion string num-uses
;;  completion-num-uses completion 
;;  completion-string completion
;;  set-completion-num-uses completion num-uses
;;  set-completion-string completion string
;;  
;;
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 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273
;;-----------------------------------------------
;;    Sometime in '84 Brewster implemented a somewhat buggy version for 
;; Symbolics LISPMs.
;;    Jan. '85 Jim became enamored of the idea and implemented a faster, 
;; more robust version.
;;    With input from many users at TMC, (rose, craig, and gls come to mind),
;; 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 
;; 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
;;  - added backup protection to save-completions-to-file (prevents 
;;    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 290 291
If nil, no new words added to the database or saved to the init file."
  :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
(defconst completion-min-length nil ;; defined below in eval-when
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
(defconst completion-max-length nil ;; defined below in eval-when
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
(defconst completion-prefix-min-length nil ;; defined below in eval-when
Richard M. Stallman's avatar
Richard M. Stallman committed
362 363 364 365 366 367
  "The minimum length of a completion search string.
DON'T CHANGE WITHOUT RECOMPILING !  This is used by macros.")

(defmacro eval-when-compile-load-eval (&rest body)
  ;; eval everything before expanding
  (mapcar 'eval body)
Jim Blandy's avatar
Jim Blandy committed
368
  (cons 'progn body))
Richard M. Stallman's avatar
Richard M. Stallman committed
369

370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394
(eval-when-compile
  (defvar completion-gensym-counter 0)
  (defun completion-gensym (&optional arg)
    "Generate a new uninterned symbol.
The name is made by appending a number to PREFIX, default \"G\"."
    (let ((prefix (if (stringp arg) arg "G"))
	  (num (if (integerp arg) arg
		 (prog1 completion-gensym-counter
		   (setq completion-gensym-counter (1+ completion-gensym-counter))))))
      (make-symbol (format "%s%d" prefix num)))))

(defmacro completion-dolist (spec &rest body)
  "(completion-dolist (VAR LIST [RESULT]) BODY...): loop over a list.
Evaluate BODY with VAR bound to each `car' from LIST, in turn.
Then evaluate RESULT to get return value, default nil."
  (let ((temp (completion-gensym "--dolist-temp--")))
    (append (list 'let (list (list temp (nth 1 spec)) (car spec))
		  (append (list 'while temp
				(list 'setq (car spec) (list 'car temp)))
			  body (list (list 'setq temp
					   (list 'cdr temp)))))
	    (if (cdr (cdr spec))
		(cons (list 'setq (car spec) nil) (cdr (cdr spec)))
	      '(nil)))))

Richard M. Stallman's avatar
Richard M. Stallman committed
395 396 397
(defun completion-eval-when ()
  (eval-when-compile-load-eval
   ;; These vars. are defined at both compile and load time.
398 399 400
   (setq completion-min-length 6)
   (setq completion-max-length 200)
   (setq completion-prefix-min-length 3)))
Richard M. Stallman's avatar
Richard M. Stallman committed
401 402 403

(completion-eval-when)
 
Erik Naggum's avatar
Erik Naggum committed
404 405 406
;;---------------------------------------------------------------------------
;; Internal Variables
;;---------------------------------------------------------------------------
Richard M. Stallman's avatar
Richard M. Stallman committed
407 408

(defvar cmpl-initialized-p nil
409 410
  "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
411 412

(defvar cmpl-completions-accepted-p nil
413 414
  "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
415

416
(defvar cmpl-preceding-syntax)
417 418

(defvar completion-string)
Richard M. Stallman's avatar
Richard M. Stallman committed
419

Erik Naggum's avatar
Erik Naggum committed
420 421 422
;;---------------------------------------------------------------------------
;; Low level tools
;;---------------------------------------------------------------------------
Richard M. Stallman's avatar
Richard M. Stallman committed
423

Erik Naggum's avatar
Erik Naggum committed
424 425 426
;;-----------------------------------------------
;; Misc.
;;-----------------------------------------------
Richard M. Stallman's avatar
Richard M. Stallman committed
427 428 429

(defun minibuffer-window-selected-p ()
  "True iff the current window is the minibuffer."
430
  (window-minibuffer-p (selected-window)))
Richard M. Stallman's avatar
Richard M. Stallman committed
431

432
;; This used to be `(eval form)'.  Eval FORM at run time now.
433
(defmacro cmpl-read-time-eval (form)
434
  form)
Richard M. Stallman's avatar
Richard M. Stallman committed
435

Erik Naggum's avatar
Erik Naggum committed
436 437 438
;;-----------------------------------------------
;; String case coercion
;;-----------------------------------------------
Richard M. Stallman's avatar
Richard M. Stallman committed
439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456

(defun cmpl-string-case-type (string)
  "Returns :capitalized, :up, :down, :mixed, or :neither."
  (let ((case-fold-search nil))
    (cond ((string-match "[a-z]" string)
	   (cond ((string-match "[A-Z]" string)
		  (cond ((and (> (length string) 1)
			      (null (string-match "[A-Z]" string 1)))
			 ':capitalized)
			(t
			 ':mixed)))
		 (t ':down)))
	  (t
	   (cond ((string-match "[A-Z]" string)
		  ':up)
		 (t ':neither))))
    ))

Erik Naggum's avatar
Erik Naggum committed
457 458 459 460 461 462
;; 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
463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488

(defun cmpl-coerce-string-case (string case-type)
  (cond ((eq case-type ':down) (downcase string))
	((eq case-type ':up) (upcase string))
	((eq case-type ':capitalized)
	 (setq string (downcase string))
	 (aset string 0 (logand ?\337 (aref string 0)))
	 string)
	(t string)
	))

(defun cmpl-merge-string-cases (string-to-coerce given-string)
  (let ((string-case-type (cmpl-string-case-type string-to-coerce))
	)
    (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
			       (cmpl-string-case-type given-string))
	   )
	  (t
	   ;; If the found string is in some unusual case, just insert it
	   ;; as is
	   string-to-coerce)
	  )))

Erik Naggum's avatar
Erik Naggum committed
489 490 491 492 493
;; 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
494 495


496 497
(defun cmpl-hours-since-origin ()
  (let ((time (current-time)))
498
    (floor (+ (* 65536.0 (nth 0 time)) (nth 1 time)) 3600)))
Richard M. Stallman's avatar
Richard M. Stallman committed
499

Erik Naggum's avatar
Erik Naggum committed
500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551
;;---------------------------------------------------------------------------
;; "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)
;; syntax (?w) - symbol chars to ignore at end of words (e.g. period).  
;; syntax (? ) - everything else
;;
;; Thus by judicious use of scan-sexps and forward-word, we can get
;; the word we want relatively fast and without consing.  
;;
;; Why do we need a separate category for "symbol chars to ignore at ends" ?
;; For example, in LISP we want starting :'s trimmed 
;; so keyword argument specifiers also define the keyword completion.  And,
;; for example, in C we want `.' appearing in a structure ref. to
;; be kept intact in order to store the whole structure ref.; however, if 
;; 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
;; char., however, we wanted to have completion symbols include pointer 
;; 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
552

553
(defun cmpl-make-standard-completion-syntax-table ()
Richard M. Stallman's avatar
Richard M. Stallman committed
554
  (let ((table (make-syntax-table))
555
	i)
Richard M. Stallman's avatar
Richard M. Stallman committed
556 557 558 559 560
    ;; 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
561
    ;; alpha chars
562 563
    (setq i 0)
    (while (< i 26)
Richard M. Stallman's avatar
Richard M. Stallman committed
564
      (modify-syntax-entry (+ ?a i) "_" table)
565 566
      (modify-syntax-entry (+ ?A i) "_" table)
      (setq i (1+ i)))
Richard M. Stallman's avatar
Richard M. Stallman committed
567
    ;; digit chars.
568 569 570 571
    (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
572 573 574 575
    ;; Other ones
    (let ((symbol-chars '(?@ ?/ ?\\ ?* ?+ ?~ ?$ ?< ?> ?%))
	  (symbol-chars-ignore '(?_ ?- ?: ?.))
	  )
576
      (completion-dolist (char symbol-chars)
Richard M. Stallman's avatar
Richard M. Stallman committed
577
	(modify-syntax-entry char "_" table))
578
      (completion-dolist (char symbol-chars-ignore)
Richard M. Stallman's avatar
Richard M. Stallman committed
579 580 581 582 583
	(modify-syntax-entry char "w" table)
	)
      )
    table))

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

586
(defun cmpl-make-lisp-completion-syntax-table ()
Richard M. Stallman's avatar
Richard M. Stallman committed
587 588 589
  (let ((table (copy-syntax-table cmpl-standard-syntax-table))
	(symbol-chars '(?! ?& ?? ?= ?^))
	)
590
    (completion-dolist (char symbol-chars)
Richard M. Stallman's avatar
Richard M. Stallman committed
591 592 593
      (modify-syntax-entry char "_" table))
    table))
	   
594
(defun cmpl-make-c-completion-syntax-table ()
Richard M. Stallman's avatar
Richard M. Stallman committed
595 596 597
  (let ((table (copy-syntax-table cmpl-standard-syntax-table))
	(separator-chars '(?+ ?* ?/ ?: ?%))
	)
598
    (completion-dolist (char separator-chars)
Richard M. Stallman's avatar
Richard M. Stallman committed
599 600 601
      (modify-syntax-entry char " " table))
    table))

602
(defun cmpl-make-fortran-completion-syntax-table ()
Richard M. Stallman's avatar
Richard M. Stallman committed
603 604 605
  (let ((table (copy-syntax-table cmpl-standard-syntax-table))
	(separator-chars '(?+ ?- ?* ?/ ?:))
	)
606
    (completion-dolist (char separator-chars)
Richard M. Stallman's avatar
Richard M. Stallman committed
607 608 609
      (modify-syntax-entry char " " table))
    table))

610 611 612
(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
613 614 615 616 617

(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
618 619 620
;;-----------------------------------------------
;; Symbol functions
;;-----------------------------------------------
Richard M. Stallman's avatar
Richard M. Stallman committed
621
(defvar cmpl-symbol-start nil
622
  "Holds first character of symbol, after any completion symbol function.")
Richard M. Stallman's avatar
Richard M. Stallman committed
623
(defvar cmpl-symbol-end nil
624
  "Holds last character of symbol, after any completion symbol function.")
Erik Naggum's avatar
Erik Naggum committed
625 626
;; These are temp. vars. we use to avoid using let.
;;   Why ?  Small speed improvement.
Richard M. Stallman's avatar
Richard M. Stallman committed
627 628 629 630
(defvar cmpl-saved-syntax nil)
(defvar cmpl-saved-point nil)

(defun symbol-under-point ()
631 632
  "Returns the symbol that the point is currently on.
But only if it is longer than `completion-min-length'."
Richard M. Stallman's avatar
Richard M. Stallman committed
633
  (setq cmpl-saved-syntax (syntax-table))
634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663
  (unwind-protect
      (progn
	(set-syntax-table cmpl-syntax-table)
	(cond 
	;; Cursor is on following-char and after preceding-char
	  ((memq (char-syntax (following-char)) '(?w ?_))     
	   (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))
		  (goto-char cmpl-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 cmpl-saved-point)
		  ))
	   ;; Return completion if the length is reasonable.
	   (if (and (<= (cmpl-read-time-eval completion-min-length)
			(- cmpl-symbol-end cmpl-symbol-start))
		    (<= (- cmpl-symbol-end cmpl-symbol-start)
			(cmpl-read-time-eval completion-max-length)))
	       (buffer-substring cmpl-symbol-start cmpl-symbol-end)))))
    (set-syntax-table cmpl-saved-syntax)))
Richard M. Stallman's avatar
Richard M. Stallman committed
664

Erik Naggum's avatar
Erik Naggum committed
665 666 667 668 669 670 671 672 673 674 675
;; 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
676 677

(defun symbol-before-point ()
678 679
  "Returns a string of the symbol immediately before point.
Returns nil if there isn't one longer than `completion-min-length'."       
Richard M. Stallman's avatar
Richard M. Stallman committed
680 681
  ;; This is called when a word separator is typed so it must be FAST !
  (setq cmpl-saved-syntax (syntax-table))
682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702
  (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)
		     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
			  (cmpl-read-time-eval completion-min-length)))
		   (buffer-substring cmpl-symbol-start cmpl-symbol-end))
Richard M. Stallman's avatar
Richard M. Stallman committed
703
	       )
704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725
	      ((= 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)
		      (setq cmpl-symbol-start (point))
		      ))
	       ;; Restore state.
	       (goto-char cmpl-saved-point)
	       ;; Return completion if the length is reasonable
	       (if (and (<= (cmpl-read-time-eval completion-min-length)
			    (- cmpl-symbol-end cmpl-symbol-start))
			(<= (- cmpl-symbol-end cmpl-symbol-start)
			    (cmpl-read-time-eval completion-max-length)))
		   (buffer-substring cmpl-symbol-start cmpl-symbol-end)))))
    (set-syntax-table cmpl-saved-syntax)))
Richard M. Stallman's avatar
Richard M. Stallman committed
726

Erik Naggum's avatar
Erik Naggum committed
727 728 729 730 731 732 733 734 735 736 737 738 739
;; 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
740 741

(defun symbol-under-or-before-point ()
Erik Naggum's avatar
Erik Naggum committed
742 743 744 745
  ;; 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.
746 747 748 749 750 751 752 753
  (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
754 755
	 (symbol-under-point))
	(t
756
	 (symbol-before-point))))
Richard M. Stallman's avatar
Richard M. Stallman committed
757 758 759 760 761 762 763 764


(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))
765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788
  (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)
		     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 (<= (cmpl-read-time-eval
			     completion-prefix-min-length)
			    (- cmpl-symbol-end cmpl-symbol-start))
			(<= (- cmpl-symbol-end cmpl-symbol-start)
			    (cmpl-read-time-eval completion-max-length)))
		   (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
789

Erik Naggum's avatar
Erik Naggum committed
790 791 792 793 794 795 796 797 798 799 800 801 802
;; 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
803 804 805



Erik Naggum's avatar
Erik Naggum committed
806 807 808
;;---------------------------------------------------------------------------
;; Statistics Recording
;;---------------------------------------------------------------------------
Richard M. Stallman's avatar
Richard M. Stallman committed
809

Erik Naggum's avatar
Erik Naggum committed
810 811
;; 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
812

Erik Naggum's avatar
Erik Naggum committed
813 814 815 816
;;-----------------------------------------------
;; Conditionalizing code on *record-cmpl-statistics-p*
;;-----------------------------------------------
;; All statistics code outside this block should use this
817
(defmacro cmpl-statistics-block (&rest body))
Erik Naggum's avatar
Erik Naggum committed
818 819 820 821
;;  "Only executes body if we are recording statistics."
;;  (list 'cond
;;	(list* '*record-cmpl-statistics-p* body)
;;	))		 
Richard M. Stallman's avatar
Richard M. Stallman committed
822

Erik Naggum's avatar
Erik Naggum committed
823 824 825
;;-----------------------------------------------
;; Completion Sources
;;-----------------------------------------------
Richard M. Stallman's avatar
Richard M. Stallman committed
826 827 828 829 830 831 832 833 834 835 836 837 838 839

;; 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
840 841 842 843 844 845 846 847 848 849 850 851
;;---------------------------------------------------------------------------
;; Completion Method #2: dabbrev-expand style
;;---------------------------------------------------------------------------
;;
;;   This method is used if there are no useful stored completions.  It is 
;; 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
852 853

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

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

(defvar cdabbrev-current-window nil)
860 861
;;  "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
862 863

(defvar cdabbrev-wrapped-p nil)
864
;;  "Return t if the cdabbrev search has wrapped around the file.")
Richard M. Stallman's avatar
Richard M. Stallman committed
865 866 867

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

Erik Naggum's avatar
Erik Naggum committed
870 871 872 873 874 875 876
;; 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
877 878 879 880


(defun reset-cdabbrev (abbrev-string &optional initial-completions-tried)
  "Resets the cdabbrev search to search for abbrev-string.
881
INITIAL-COMPLETIONS-TRIED is a list of downcased strings to ignore
Richard M. Stallman's avatar
Richard M. Stallman committed
882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898
during the search."
  (setq cdabbrev-abbrev-string abbrev-string
	cdabbrev-completions-tried
	(cons (downcase abbrev-string) initial-completions-tried)
	)
  (reset-cdabbrev-window t)
  )

(defun set-cdabbrev-buffer ()
  ;; cdabbrev-current-window must not be NIL
  (set-buffer (if (eq cdabbrev-current-window t)
		  (other-buffer)
		  (window-buffer cdabbrev-current-window)))
  )


(defun reset-cdabbrev-window (&optional initializep)
899
  "Resets the cdabbrev search to search for abbrev-string."
Richard M. Stallman's avatar
Richard M. Stallman committed
900 901 902 903 904 905 906 907 908 909 910 911 912
  ;; Set the window
  (cond (initializep
	 (setq cdabbrev-current-window (selected-window))
	 )
	((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.
	     (setq cdabbrev-current-window t)))
	)
913 914 915 916 917 918 919 920 921 922 923 924
  (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))
	      cdabbrev-wrapped-p nil)
	)))
Richard M. Stallman's avatar
Richard M. Stallman committed
925 926 927

(defun next-cdabbrev ()
  "Return the next possible cdabbrev expansion or nil if there isn't one.
928 929
`reset-cdabbrev' must've been called already.
This is sensitive to `case-fold-search'."
Richard M. Stallman's avatar
Richard M. Stallman committed
930 931
  ;; 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
932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013
  (if cdabbrev-current-window
      (let (saved-point 
	    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)) ? )
				      (goto-char saved-point-2)
				      ))))
			 ;; 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
			     (setq tried-list (cdr tried-list))
			     )
			   ;; at this point tried-list will be nil if this
			   ;; expansion has not yet been tried
			   (if tried-list
			       (setq expansion nil)
			       t)
			   ))))
		      ;; 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))))

		       (setq cdabbrev-wrapped-p t))
		      ))
		;; end of while loop
		(cond (expansion
		       ;; successful
		       (setq cdabbrev-completions-tried
			     (cons downcase-expansion cdabbrev-completions-tried)
			     cdabbrev-current-point (point))))
		)
	    (set-syntax-table saved-syntax)
	    (goto-char saved-point)
	    ))
	;; If no expansion, go to next window
	(cond (expansion)
	      (t (reset-cdabbrev-window)
		 (next-cdabbrev))))))
Richard M. Stallman's avatar
Richard M. Stallman committed
1014

Erik Naggum's avatar
Erik Naggum committed
1015 1016 1017 1018 1019 1020 1021 1022 1023 1024
;; 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
1025

Erik Naggum's avatar
Erik Naggum committed
1026 1027
;; _cdat_start_sym
;; cdat-wrapping
Richard M. Stallman's avatar
Richard M. Stallman committed
1028 1029


Erik Naggum's avatar
Erik Naggum committed
1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043
;;---------------------------------------------------------------------------
;; 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
1044 1045 1046
(defconst cmpl-obarray-length 511)

(defvar cmpl-prefix-obarray (make-vector cmpl-obarray-length 0)
1047
  "An obarray used to store the downcased completion prefixes.
Richard M. Stallman's avatar
Richard M. Stallman committed
1048 1049 1050 1051 1052 1053
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
1054 1055 1056
;;-----------------------------------------------
;; Completion Entry Structure Definition
;;-----------------------------------------------
Richard M. Stallman's avatar
Richard M. Stallman committed
1057

Erik Naggum's avatar
Erik Naggum committed
1058 1059 1060 1061
;; A completion entry is a LIST of string, prefix-symbol num-uses, and
;; last-use-time (the time the completion was last used)
;; last-use-time is T if the string should be kept permanently
;; num-uses is incremented every time the completion is used.
Richard M. Stallman's avatar
Richard M. Stallman committed
1062

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

Erik Naggum's avatar
Erik Naggum committed
1066
;; READER MACROS
Richard M. Stallman's avatar
Richard M. Stallman committed
1067 1068 1069 1070 1071 1072 1073 1074 1075 1076

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

(defmacro completion-num-uses (completion-entry)
  ;;  "The number of times it has used.  Used to decide whether to save 
  ;; it."
  (list 'car (list 'cdr completion-entry)))

(defmacro completion-last-use-time (completion-entry)
1077
  ;;  "The time it was last used.  In hours since origin.  Used to decide
Richard M. Stallman's avatar
Richard M. Stallman committed
1078 1079 1080 1081 1082 1083
  ;; whether to save it.  T if one should always save it."
  (list 'nth 2 completion-entry))

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

Erik Naggum's avatar
Erik Naggum committed
1084
;; WRITER MACROS
Richard M. Stallman's avatar
Richard M. Stallman committed
1085 1086 1087 1088 1089 1090 1091 1092 1093
(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
1094
;; CONSTRUCTOR
Richard M. Stallman's avatar
Richard M. Stallman committed
1095 1096 1097 1098 1099 1100 1101 1102 1103 1104
(defun make-completion (string)
  "Returns a list of a completion entry."
  (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
1105 1106 1107 1108
;;-----------------------------------------------
;; Prefix symbol entry definition
;;-----------------------------------------------
;; A cons of (head . tail)
Richard M. Stallman's avatar
Richard M. Stallman committed
1109

Erik Naggum's avatar
Erik Naggum committed
1110
;; READER Macros
Richard M. Stallman's avatar
Richard M. Stallman committed
1111 1112 1113 1114 1115 1116 1117

(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
1118
;; WRITER Macros
Richard M. Stallman's avatar
Richard M. Stallman committed
1119 1120 1121 1122 1123 1124 1125

(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
1126
;; Constructor
Richard M. Stallman's avatar
Richard M. Stallman committed
1127 1128 1129 1130 1131

(defun make-cmpl-prefix-entry (completion-entry-list)
  "Makes a new prefix entry containing only completion-entry."
  (cons completion-entry-list completion-entry-list))

Erik Naggum's avatar
Erik Naggum committed
1132 1133 1134
;;-----------------------------------------------
;; Completion Database - Utilities
;;-----------------------------------------------
Richard M. Stallman's avatar
Richard M. Stallman committed
1135 1136 1137 1138 1139 1140 1141 1142 1143 1144

(defun clear-all-completions ()
  "Initializes the completion storage.  All existing completions are lost."
  (interactive)
  (setq cmpl-prefix-obarray (make-vector cmpl-obarray-length 0))
  (setq cmpl-obarray (make-vector cmpl-obarray-length 0))
  (cmpl-statistics-block
    (record-clear-all-completions))
  )

1145 1146
(defvar completions-list-return-value)

Richard M. Stallman's avatar
Richard M. Stallman committed
1147 1148
(defun list-all-completions ()
  "Returns a list of all the known completion entries."
1149
  (let ((completions-list-return-value nil))
Richard M. Stallman's avatar
Richard M. Stallman committed
1150
    (mapatoms 'list-all-completions-1 cmpl-prefix-obarray)
1151
    completions-list-return-value))
Richard M. Stallman's avatar
Richard M. Stallman committed
1152 1153 1154

(defun list-all-completions-1 (prefix-symbol)
  (if (boundp prefix-symbol)
1155
      (setq completions-list-return-value
Richard M. Stallman's avatar
Richard M. Stallman committed
1156
	    (append (cmpl-prefix-entry-head (symbol-value prefix-symbol))
1157
		    completions-list-return-value))))
Richard M. Stallman's avatar
Richard M. Stallman committed
1158 1159

(defun list-all-completions-by-hash-bucket ()
1160
  "Return list of lists of known completion entries, organized by hash bucket."
1161
  (let ((completions-list-return-value nil))
Richard M. Stallman's avatar
Richard M. Stallman committed
1162
    (mapatoms 'list-all-completions-by-hash-bucket-1 cmpl-prefix-obarray)
1163
    completions-list-return-value))
Richard M. Stallman's avatar
Richard M. Stallman committed
1164 1165 1166

(defun list-all-completions-by-hash-bucket-1 (prefix-symbol)
  (if (boundp prefix-symbol)
1167
      (setq completions-list-return-value
Richard M. Stallman's avatar
Richard M. Stallman committed
1168
	    (cons (cmpl-prefix-entry-head (symbol-value prefix-symbol))
1169
		  completions-list-return-value))))
Richard M. Stallman's avatar
Richard M. Stallman committed
1170 1171


Erik Naggum's avatar
Erik Naggum committed
1172 1173 1174 1175 1176 1177 1178
;;-----------------------------------------------
;; Updating the database
;;-----------------------------------------------
;;
;;   These are the internal functions used to update the datebase
;;
;;
Richard M. Stallman's avatar
Richard M. Stallman committed
1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193
(defvar completion-to-accept nil)
  ;;"Set to a string that is pending its acceptance."
  ;; this checked by the top level reading functions

(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."
(defvar cmpl-db-entry nil)
(defvar cmpl-db-debug-p nil
  "Set to T if you want to debug the database.")

Erik Naggum's avatar
Erik Naggum committed
1194
;; READS
Richard M. Stallman's avatar
Richard M. Stallman committed
1195 1196
(defun find-exact-completion (string)
  "Returns the completion entry for string or nil.
1197
Sets up `cmpl-db-downcase-string' and `cmpl-db-symbol'."
Richard M. Stallman's avatar
Richard M. Stallman committed
1198 1199 1200 1201 1202 1203 1204
  (and (boundp (setq cmpl-db-symbol
		     (intern (setq cmpl-db-downcase-string (downcase string))
			     cmpl-obarray)))
       (symbol-value cmpl-db-symbol)
       ))

(defun find-cmpl-prefix-entry (prefix-string)
Christopher Zaborsky's avatar
Christopher Zaborsky committed
1205
  "Returns the prefix entry for string.
1206 1207 1208
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
1209 1210 1211 1212 1213 1214 1215 1216
  (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)
Christopher Zaborsky's avatar
Christopher Zaborsky committed
1217 1218 1219
  "Locates the completion entry.
Returns a pointer to the element before the completion entry or nil if
the completion entry is at the head.
1220
Must be called after `find-exact-completion'."
Richard M. Stallman's avatar
Richard M. Stallman committed
1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237
  (let ((prefix-list (cmpl-prefix-entry-head prefix-entry))
	 next-prefix-list
	 )
    (cond
      ((not (eq (car prefix-list) completion-entry))
       ;; not already at head
       (while (and prefix-list
		   (not (eq completion-entry
			    (car (setq next-prefix-list (cdr prefix-list)))
			    )))
	 (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"
1238
		     completion-string))
Richard M. Stallman's avatar
Richard M. Stallman committed
1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253
	     (inside-locate-completion-entry
	      ;; recursive error: really scrod
	      (locate-completion-db-error))
	     (t
	       ;; Patch out
	       (set cmpl-db-symbol nil)
	       ;; Retry
	       (locate-completion-entry-retry completion-entry)
	       ))))))

(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))
1254 1255 1256 1257 1258 1259
    (let* ((cmpl-entry (find-exact-completion (completion-string old-entry)))
	   (pref-entry
	    (if cmpl-entry
		(find-cmpl-prefix-entry
		  (substring cmpl-db-downcase-string
			     0 completion-prefix-min-length))))
Richard M. Stallman's avatar
Richard M. Stallman committed
1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272
	  )
      (if (and cmpl-entry pref-entry)
	  ;; try again
	  (locate-completion-entry cmpl-entry pref-entry)
	  ;; still losing
	  (locate-completion-db-error))
      )))

(defun locate-completion-db-error ()
  ;; recursive error: really scrod
  (error "Completion database corrupted.  Try M-x clear-all-completions.  Send bug report.")
  )

Erik Naggum's avatar
Erik Naggum committed
1273
;; WRITES
Richard M. Stallman's avatar
Richard M. Stallman committed
1274
(defun add-completion-to-tail-if-new (string)
Christopher Zaborsky's avatar
Christopher Zaborsky committed
1275
  "If STRING is not in the database add it to appropriate prefix list.
1276
STRING is added to the end of the appropriate prefix list with
Christopher Zaborsky's avatar
Christopher Zaborsky committed
1277
num-uses = 0.  The database is unchanged if it is there.  STRING must be
1278
longer than `completion-prefix-min-length'.
Richard M. Stallman's avatar
Richard M. Stallman committed
1279 1280 1281 1282 1283 1284 1285 1286 1287
This must be very fast.
Returns the completion entry."
  (or (find-exact-completion string)
      ;; not there
      (let (;; create an entry
	    (entry (make-completion string))
	    ;; setup the prefix
	    (prefix-entry (find-cmpl-prefix-entry
			    (substring cmpl-db-downcase-string 0
1288 1289
				       (cmpl-read-time-eval
					completion-prefix-min-length))))
Richard M. Stallman's avatar
Richard M. Stallman committed
1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307
	    )
	;; 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
	       (set cmpl-db-prefix-symbol (make-cmpl-prefix-entry entry))
	       ))
	;; statistics
	(cmpl-statistics-block
	  (note-added-completion))
	;; set symbol
	(set cmpl-db-symbol (car entry))
	)))

1308 1309 1310 1311 1312
(defun add-completion-to-head (completion-string)
  "If COMPLETION-STRING is not in the database, add it to prefix list.
We add COMPLETION-STRING to the head of the appropriate prefix list,
or it to the head of the list.
COMPLETION-STRING must be longer than `completion-prefix-min-length'.
Richard M. Stallman's avatar
Richard M. Stallman committed
1313 1314 1315 1316 1317 1318
Updates the saved string with the supplied string.
This must be very fast.
Returns the completion entry."
  ;; Handle pending acceptance
  (if completion-to-accept (accept-completion))
  ;; test if already in database
1319
  (if (setq cmpl-db-entry (find-exact-completion completion-string))
Richard M. Stallman's avatar
Richard M. Stallman committed
1320 1321 1322
      ;; found
      (let* ((prefix-entry (find-cmpl-prefix-entry
			     (substring cmpl-db-downcase-string 0
1323 1324
					(cmpl-read-time-eval
					 completion-prefix-min-length))))
Richard M. Stallman's avatar
Richard M. Stallman committed
1325 1326 1327 1328
	     (splice-ptr (locate-completion-entry cmpl-db-entry prefix-entry))
	     (cmpl-ptr (cdr splice-ptr))
	     )
	;; update entry
1329
	(set-completion-string cmpl-db-entry completion-string)
Richard M. Stallman's avatar
Richard M. Stallman committed
1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344
	;; move to head (if necessary)
	(cond (splice-ptr
	       ;; These should all execute atomically but it is not fatal if
	       ;; they don't.
	       ;; splice it out
	       (or (setcdr splice-ptr (cdr cmpl-ptr))
		   ;; fix up tail if necessary
		   (set-cmpl-prefix-entry-tail prefix-entry splice-ptr))
	       ;; splice in at head
	       (setcdr cmpl-ptr (cmpl-prefix-entry-head prefix-entry))
	       (set-cmpl-prefix-entry-head prefix-entry cmpl-ptr)
	       ))
	cmpl-db-entry)
    ;; not there
    (let (;; create an entry
1345
	  (entry (make-completion completion-string))
Richard M. Stallman's avatar
Richard M. Stallman committed
1346 1347 1348
	  ;; setup the prefix
	  (prefix-entry (find-cmpl-prefix-entry
			  (substring cmpl-db-downcase-string 0
1349 1350
				     (cmpl-read-time-eval
				      completion-prefix-min-length))))
Richard M. Stallman's avatar
Richard M. Stallman committed
1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366
	  )
      (cond (prefix-entry
	     ;; Splice in at head
	     (setcdr entry (cmpl-prefix-entry-head prefix-entry))
	     (set-cmpl-prefix-entry-head prefix-entry entry))
	    (t
	     ;; Start new prefix entry
	     (set cmpl-db-prefix-symbol (make-cmpl-prefix-entry entry))
	     ))
      ;; statistics
      (cmpl-statistics-block
	(note-added-completion))
      ;; Add it to the symbol
      (set cmpl-db-symbol (car entry))
      )))
      
1367
(defun delete-completion (completion-string)
Christopher Zaborsky's avatar
Christopher Zaborsky committed
1368
  "Deletes the completion from the database.
1369
String must be longer than `completion-prefix-min-length'."
Richard M. Stallman's avatar
Richard M. Stallman committed
1370 1371
  ;; Handle pending acceptance
  (if completion-to-accept (accept-completion))
1372
  (if (setq cmpl-db-entry (find-exact-completion completion-string))
Richard M. Stallman's avatar
Richard M. Stallman committed
1373 1374 1375
      ;; found
      (let* ((prefix-entry (find-cmpl-prefix-entry 
			     (substring cmpl-db-downcase-string 0
1376 1377
					(cmpl-read-time-eval
					 completion-prefix-min-length))))
Richard M. Stallman's avatar
Richard M. Stallman committed
1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398
	     (splice-ptr (locate-completion-entry cmpl-db-entry prefix-entry))
	     )
	 ;; delete symbol reference
	 (set cmpl-db-symbol nil)
	 ;; remove from prefix list
	 (cond (splice-ptr
		;; not at head
		(or (setcdr splice-ptr (cdr (cdr splice-ptr)))
		    ;; fix up tail if necessary
		    (set-cmpl-prefix-entry-tail prefix-entry splice-ptr))
		)
	       (t
		;; at head
		(or (set-cmpl-prefix-entry-head
		      prefix-entry (cdr (cmpl-prefix-entry-head prefix-entry)))
		    ;; List is now empty
		    (set cmpl-db-prefix-symbol nil))
		))
	 (cmpl-statistics-block
	   (note-completion-deleted))
	 )
1399
      (error "Unknown completion `%s'" completion-string)
Richard M. Stallman's avatar
Richard M. Stallman committed
1400 1401
      ))

Erik Naggum's avatar
Erik Naggum committed
1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439
;; Tests --
;;  - Add and Find -
;; (add-completion-to-head "banana")     --> ("banana" 0 nil 0)
;; (find-exact-completion "banana")      --> ("banana" 0 nil 0)
;; (find-exact-completion "bana")        --> nil
;; (car (find-cmpl-prefix-entry "ban"))  --> (("banana" ...))
;; (cdr (find-cmpl-prefix-entry "ban"))  --> (("banana" ...))
;; (add-completion-to-head "banish")     --> ("banish" 0 nil 0)
;; (find-exact-completion "banish")      --> ("banish" 0 nil 0)
;; (car (find-cmpl-prefix-entry "ban"))  --> (("banish" ...) ("banana" ...))
;; (cdr (find-cmpl-prefix-entry "ban"))  --> (("banana" ...))
;; (add-completion-to-head "banana")     --> ("banana" 0 nil 0)
;; (car (find-cmpl-prefix-entry "ban"))  --> (("banana" ...) ("banish" ...))
;; (cdr (find-cmpl-prefix-entry "ban"))  --> (("banish" ...))
;;
;;  - Deleting -
;; (add-completion-to-head "banner")     --> ("banner" 0 nil 0)
;; (delete-completion "banner")        
;; (find-exact-completion "banner")      --> nil
;; (car (find-cmpl-prefix-entry "ban"))  --> (("banana" ...) ("banish" ...))
;; (cdr (find-cmpl-prefix-entry "ban"))  --> (("banish" ...))
;; (add-completion-to-head "banner")     --> ("banner" 0 nil 0) 
;; (delete-completion "banana")        
;; (car (find-cmpl-prefix-entry "ban"))  --> (("banner" ...) ("banish" ...))
;; (cdr (find-cmpl-prefix-entry "ban"))  --> (("banish" ...))
;; (delete-completion "banner")        
;; (delete-completion "banish")                 
;; (find-cmpl-prefix-entry "ban")        --> nil
;; (delete-completion "banner")          --> error
;;
;; - Tail -
;; (add-completion-to-tail-if-new "banana") --> ("banana" 0 nil 0)
;; (car (find-cmpl-prefix-entry "ban"))     --> (("banana" ...))
;; (cdr (find-cmpl-prefix-entry "ban"))     --> (("banana" ...))
;; (add-completion-to-tail-if-new "banish") --> ("banish" 0 nil 0)
;; (car (find-cmpl-prefix-entry "ban"))     -->(("banana" ...) ("banish" ...))
;; (cdr (find-cmpl-prefix-entry "ban"))     -->(("banish" ...))
;;
Richard M. Stallman's avatar
Richard M. Stallman committed
1440 1441


Erik Naggum's avatar
Erik Naggum committed
1442 1443 1444 1445 1446 1447
;;---------------------------------------------------------------------------
;; Database Update :: Interface level routines
;;---------------------------------------------------------------------------
;; 
;; These lie on top of the database ref. functions but below the standard
;; user interface level
Richard M. Stallman's avatar
Richard M. Stallman committed
1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463


(