dabbrev.el 38.6 KB
Newer Older
1
;;; dabbrev.el --- dynamic abbreviation package
Erik Naggum's avatar
Erik Naggum committed
2

3
;; Copyright (C) 1985, 1986, 1992, 1994, 1996, 1997, 2000, 2001, 2002,
4 5
;;   2003, 2004, 2005, 2006, 2007, 2008, 2009
;;   Free Software Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
6

7
;; Author: Don Morrison
8 9
;;	Lars Lindberg
;; (according to ack.texi)
10 11
;; Maintainer: Lars Lindberg <Lars.Lindberg@sypro.cap.se>
;; Created: 16 Mars 1992
12
;; Lindberg's last update version: 5.7
Dan Nicolaescu's avatar
Dan Nicolaescu committed
13
;; Keywords: abbrev expand completion convenience
Eric S. Raymond's avatar
Eric S. Raymond committed
14

Erik Naggum's avatar
Erik Naggum committed
15 16
;; This file is part of GNU Emacs.

17
;; GNU Emacs is free software: you can redistribute it and/or modify
Jim Blandy's avatar
Jim Blandy committed
18
;; it under the terms of the GNU General Public License as published by
19 20
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
Erik Naggum's avatar
Erik Naggum committed
21 22

;; GNU Emacs is distributed in the hope that it will be useful,
Jim Blandy's avatar
Jim Blandy committed
23 24 25
;; 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.
Erik Naggum's avatar
Erik Naggum committed
26

Jim Blandy's avatar
Jim Blandy committed
27
;; You should have received a copy of the GNU General Public License
28
;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
Jim Blandy's avatar
Jim Blandy committed
29

Eric S. Raymond's avatar
Eric S. Raymond committed
30
;;; Commentary:
Jim Blandy's avatar
Jim Blandy committed
31

32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49
;; The purpose with this package is to let you write just a few
;; characters of words you've written earlier to be able to expand
;; them.
;;
;; To expand a word, just put the point right after the word and press
;; M-/ (dabbrev-expand) or M-C-/ (dabbrev-completion).
;;
;; Check out the customizable variables below to learn about all the
;; features of this package.

;;; Hints and tips for major modes writers:

;; Recommended values		C/Lisp etc	text
;; dabbrev-case-fold-search	nil		t
;; dabbrev-case-replace		nil		t
;;
;; Set the variables you want special for your mode like this:
;; (set (make-local-variable 'dabbrev-case-replace) nil)
Karl Heuer's avatar
Karl Heuer committed
50
;; Then you don't interfere with other modes.
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
;;
;; If your mode handles buffers that refers to other buffers
;; (i.e. compilation-mode, gud-mode), then try to set
;; `dabbrev-select-buffers-function' or `dabbrev-friend-buffer-function'
;; to a function that point out those buffers.

;; Same goes for major-modes that are connected to other modes.  There
;; are for instance a number of mail-modes.  One for reading, one for
;; creating a new mail etc.  Maybe those should be connected.

;; Example for GNUS (when we write a reply, we want dabbrev to look in
;; the article for expansion):
;; (set (make-local-variable 'dabbrev-friend-buffer-function)
;;      (lambda (buffer)
;;         (save-excursion
;;           (set-buffer buffer)
;;           (memq major-mode '(news-reply-mode gnus-article-mode)))))


;; Known bugs and limitations.
;; - Possible to do several levels of `dabbrev-completion' in the
;;   minibuffer.
;; - dabbrev-completion doesn't handle resetting the globals variables
;;   right.  It resets them after finding the abbrev.

;; Future enhancements
;;  - Check the tags-files? Like tags-complete?
;;  - Add the possibility of searching both forward and backward to
;;    the nearest expansion.
80 81
;;  - Check the kill-ring when everything else fails.  (Maybe something
;;  for hippie-expand?).  [Bng] <boris@cs.rochester.edu>
82

83
;;; These people gave suggestions:
84 85 86 87 88 89 90 91 92
;;  [hymie]	Hyman Rosen <marks!hymie@jyacc.jyacc.com>
;;  [burgett]	Steve Burgett <burgett@bizet.eecs.berkeley.edu>
;;  [jules]	Julian Gosnell <jules@x.co.uk>
;;  [kifer]	Michael Kifer <kifer@sbcs.sunysb.edu>
;;  [ake]	Ake Stenhoff <extaksf@aom.ericsson.se>
;;  [alon]	Alon Albert <al%imercury@uunet.uu.net>
;;  [tromey]	Tom Tromey <tromey@busco.lanl.gov>
;;  [Rolf]	Rolf Schreiber <rolf@mathematik.uni-stuttgart.de>
;;  [Petri]	Petri Raitio <per@tekla.fi>
93
;;  [ejb]	Jay Berkenbilt <ejb@ql.org>
94 95
;;  [hawley]	Bob Hawley <rth1@quartet.mt.att.com>
;;  ... and to all the people who have participated in the beta tests.
Jim Blandy's avatar
Jim Blandy committed
96

Eric S. Raymond's avatar
Eric S. Raymond committed
97
;;; Code:
98

Erik Naggum's avatar
Erik Naggum committed
99 100 101
;;----------------------------------------------------------------
;; Customization variables
;;----------------------------------------------------------------
102

103
(defgroup dabbrev nil
104
  "Dynamic Abbreviations."
105
  :tag "Dynamic Abbreviations"
Dan Nicolaescu's avatar
Dan Nicolaescu committed
106 107
  :group 'abbrev
  :group 'convenience)
108

109
(defcustom dabbrev-backward-only nil
Lute Kamstra's avatar
Lute Kamstra committed
110
  "If non-nil, `dabbrev-expand' only looks backwards."
111 112 113 114
  :type 'boolean
  :group 'dabbrev)

(defcustom dabbrev-limit nil
Lute Kamstra's avatar
Lute Kamstra committed
115
  "Limits region searched by `dabbrev-expand' to this many chars away."
116 117 118 119 120
  :type '(choice (const :tag "off" nil)
		 integer)
  :group 'dabbrev)

(defcustom dabbrev-abbrev-skip-leading-regexp nil
Lute Kamstra's avatar
Lute Kamstra committed
121
  "Regexp for skipping leading characters of an abbreviation.
122

123 124
Example: Set this to \"\\\\$\" for programming languages
in which variable names may appear with or without a leading `$'.
125
\(For example, in Makefiles.\)
126

127 128 129 130
Set this to nil if no characters should be skipped."
  :type '(choice regexp
		 (const :tag "off" nil))
  :group 'dabbrev)
131

132
(defcustom dabbrev-eliminate-newlines t
Lute Kamstra's avatar
Lute Kamstra committed
133
  "Non-nil means dabbrev should not insert newlines.
134 135 136 137
Instead it converts them to spaces."
  :type 'boolean
  :group 'dabbrev)

138
(defcustom dabbrev-case-fold-search 'case-fold-search
Lute Kamstra's avatar
Lute Kamstra committed
139
  "Control whether dabbrev searches should ignore case.
140
A value of nil means case is significant.
141 142 143 144
A value of `case-fold-search' means case is significant
 if `case-fold-search' is nil.
Any other non-nil version means case is not significant."
  :type '(choice (const :tag "off" nil)
145 146
		 (const :tag "like search" case-fold-search)
		 (other :tag "on" t))
147
  :group 'dabbrev)
148
;;;###autoload(put 'dabbrev-case-fold-search 'risky-local-variable t)
149

150
(defcustom dabbrev-upcase-means-case-search nil
Lute Kamstra's avatar
Lute Kamstra committed
151
  "The significance of an uppercase character in an abbreviation.
152
A nil value means case fold search when searching for possible expansions;
153
non-nil means case sensitive search.
154

155
This variable has an effect only when the value of
156
`dabbrev-case-fold-search' says to ignore case."
157 158
  :type 'boolean
  :group 'dabbrev)
159

160
(defcustom dabbrev-case-distinction 'case-replace
Lute Kamstra's avatar
Lute Kamstra committed
161
  "Whether dabbrev treats expansions as the same if they differ in case.
162 163 164 165 166 167 168 169 170 171 172

A value of nil means treat them as different.
A value of `case-replace' means distinguish them if `case-replace' is nil.
Any other non-nil value means to treat them as the same.

This variable has an effect only when the value of
`dabbrev-case-fold-search' specifies to ignore case."
  :type '(choice (const :tag "off" nil)
		 (const :tag "based on `case-replace'" case-replace)
		 (other :tag "on" t))
  :group 'dabbrev
173
  :version "22.1")
174

175
(defcustom dabbrev-case-replace 'case-replace
Lute Kamstra's avatar
Lute Kamstra committed
176
  "Whether dabbrev applies the abbreviations's case pattern to the expansion.
177 178 179 180 181

A value of nil means preserve the expansion's case pattern.
A value of `case-replace' means preserve it if `case-replace' is nil.
Any other non-nil value means modify the expansion
by applying the abbreviation's case pattern to it.
182

183
This variable has an effect only when the value of
184 185
`dabbrev-case-fold-search' specifies to ignore case."
  :type '(choice (const :tag "off" nil)
186
		 (const :tag "based on `case-replace'" case-replace)
187
		 (other :tag "on" t))
188
  :group 'dabbrev)
189
;;;###autoload(put 'dabbrev-case-replace 'risky-local-variable t)
190

191
(defcustom dabbrev-abbrev-char-regexp nil
Lute Kamstra's avatar
Lute Kamstra committed
192
  "Regexp to recognize a character in an abbreviation or expansion.
193
This regexp will be surrounded with \\\\( ... \\\\) when actually used.
194

195
Set this variable to \"\\\\sw\" if you want ordinary words or
196 197
\"\\\\sw\\\\|\\\\s_\" if you want symbols (including characters whose
syntax is \"symbol\" as well as those whose syntax is \"word\".
198

199 200
The value nil has a special meaning: the abbreviation is from point to
previous word-start, but the search is for symbols.
201

202
For instance, if you are programming in Lisp, `yes-or-no-p' is a symbol,
203 204
while `yes', `or', `no' and `p' are considered words.  If this
variable is nil, then expanding `yes-or-no-' looks for a symbol
205 206 207 208 209
starting with or containing `no-'.  If you set this variable to
\"\\\\sw\\\\|\\\\s_\", that expansion looks for a symbol starting with
`yes-or-no-'.  Finally, if you set this variable to \"\\\\sw\", then
expanding `yes-or-no-' signals an error because `-' is not part of a word;
but expanding `yes-or-no' looks for a word starting with `no'.
210

211 212 213 214
The recommended value is \"\\\\sw\\\\|\\\\s_\"."
  :type '(choice (const nil)
		 regexp)
  :group 'dabbrev)
215

216
(defcustom dabbrev-check-all-buffers t
Lute Kamstra's avatar
Lute Kamstra committed
217
  "Non-nil means dabbrev package should search *all* buffers.
218

219 220 221
Dabbrev always searches the current buffer first.  Then, if
`dabbrev-check-other-buffers' says so, it searches the buffers
designated by `dabbrev-select-buffers-function'.
222

223
Then, if `dabbrev-check-all-buffers' is non-nil, dabbrev searches
224 225
all the other buffers, except those named in `dabbrev-ignored-buffer-names',
or matched by `dabbrev-ignored-regexps'."
226 227
  :type 'boolean
  :group 'dabbrev)
228

229
(defcustom dabbrev-ignored-buffer-names '("*Messages*" "*Buffer List*")
Lute Kamstra's avatar
Lute Kamstra committed
230
  "List of buffer names that dabbrev should not check.
231
See also `dabbrev-ignored-buffer-regexps'."
232
  :type '(repeat (string :tag "Buffer name"))
Dan Nicolaescu's avatar
Dan Nicolaescu committed
233 234
  :group 'dabbrev
  :version "20.3")
235

236
(defcustom dabbrev-ignored-buffer-regexps nil
Lute Kamstra's avatar
Lute Kamstra committed
237
  "List of regexps matching names of buffers that dabbrev should not check.
238 239 240 241 242
See also `dabbrev-ignored-buffer-names'."
  :type '(repeat regexp)
  :group 'dabbrev
  :version "21.1")

243
(defcustom dabbrev-check-other-buffers t
Lute Kamstra's avatar
Lute Kamstra committed
244
  "Should \\[dabbrev-expand] look in other buffers?\
245

246 247 248 249 250 251 252
nil: Don't look in other buffers.
t: Also look for expansions in the buffers pointed out by
   `dabbrev-select-buffers-function'.
Anything else: When we can't find any more expansions in
the current buffer, then ask the user whether to look in other
buffers too.

253 254 255
The default value is t."
  :type '(choice (const :tag "off" nil)
		 (const :tag "on" t)
256
		 (other :tag "ask" other))
257
  :group 'dabbrev)
258 259 260 261 262 263 264

;; I guess setting this to a function that selects all C- or C++-
;; mode buffers would be a good choice for a debugging buffer,
;; when debugging C- or C++-code.
(defvar dabbrev-select-buffers-function 'dabbrev--select-buffers
  "A function that selects buffers that should be searched by dabbrev.
The function should take no arguments and return a list of buffers to
265 266
search for expansions.  See the source of `dabbrev--select-buffers'
for an example.
267 268 269

A mode setting this variable should make it buffer local.")

270
(defcustom dabbrev-friend-buffer-function 'dabbrev--same-major-mode-p
Lute Kamstra's avatar
Lute Kamstra committed
271
  "A function to decide whether dabbrev should search OTHER-BUFFER.
272 273 274 275
The function should take one argument, OTHER-BUFFER, and return
non-nil if that buffer should be searched.  Have a look at
`dabbrev--same-major-mode-p' for an example.

276 277 278
The value of `dabbrev-friend-buffer-function' has an effect only if
the value of `dabbrev-select-buffers-function' uses it.  The function
`dabbrev--select-buffers' is one function you can use here.
279

280 281 282
A mode setting this variable should make it buffer local."
  :type 'function
  :group 'dabbrev)
283

284
(defcustom dabbrev-search-these-buffers-only nil
285 286 287
  "If non-nil, a list of buffers which dabbrev should search.
If this variable is non-nil, dabbrev will only look in these buffers.
It will not even look in the current buffer if it is not a member of
288 289
this list."
  :group 'dabbrev)
Eric S. Raymond's avatar
Eric S. Raymond committed
290

Erik Naggum's avatar
Erik Naggum committed
291 292 293
;;----------------------------------------------------------------
;; Internal variables
;;----------------------------------------------------------------
Jim Blandy's avatar
Jim Blandy committed
294

295 296
;; Last obarray of completions in `dabbrev-completion'
(defvar dabbrev--last-obarray nil)
Jim Blandy's avatar
Jim Blandy committed
297

298 299
;; Table of expansions seen so far
(defvar dabbrev--last-table nil)
Jim Blandy's avatar
Jim Blandy committed
300

301 302
;; Last string we tried to expand.
(defvar dabbrev--last-abbreviation nil)
Jim Blandy's avatar
Jim Blandy committed
303

304 305
;; Location last abbreviation began
(defvar dabbrev--last-abbrev-location nil)
Jim Blandy's avatar
Jim Blandy committed
306

307 308
;; Direction of last dabbrevs search
(defvar dabbrev--last-direction 0)
Jim Blandy's avatar
Jim Blandy committed
309

310 311
;; Last expansion of an abbreviation.
(defvar dabbrev--last-expansion nil)
Jim Blandy's avatar
Jim Blandy committed
312

313 314 315 316 317 318
;; Location the last expansion was found.
(defvar dabbrev--last-expansion-location nil)

;; The list of remaining buffers with the same mode as current buffer.
(defvar dabbrev--friend-buffer-list nil)

319
;; The buffer we looked in last, not counting the current buffer.
320 321 322 323 324 325 326 327
(defvar dabbrev--last-buffer nil)

;; The buffer we found the expansion last time.
(defvar dabbrev--last-buffer-found nil)

;; The buffer we last did a completion in.
(defvar dabbrev--last-completion-buffer nil)

328 329
;; If non-nil, a function to use when copying successive words.
;; It should be `upcase' or `downcase'.
330 331
(defvar dabbrev--last-case-pattern nil)

332 333
;; Same as dabbrev-check-other-buffers, but is set for every expand.
(defvar dabbrev--check-other-buffers dabbrev-check-other-buffers)
334 335 336 337

;; The regexp for recognizing a character in an abbreviation.
(defvar dabbrev--abbrev-char-regexp nil)

338 339 340
;; The progress reporter for buffer-scanning progress.
(defvar dabbrev--progress-reporter nil)

Erik Naggum's avatar
Erik Naggum committed
341 342 343
;;----------------------------------------------------------------
;; Macros
;;----------------------------------------------------------------
344 345 346 347 348

;;; Get the buffer that mini-buffer was activated from
(defsubst dabbrev--minibuffer-origin ()
  (car (cdr (buffer-list))))

349 350 351 352 353
;; Make a list of some of the elements of LIST.
;; Check each element of LIST, storing it temporarily in the
;; variable ELEMENT, and include it in the result
;; if CONDITION evaluates non-nil.
(defmacro dabbrev-filter-elements (element list condition)
354 355 356 357 358 359 360 361
  `(let (dabbrev-result dabbrev-tail ,element)
    (setq dabbrev-tail ,list)
    (while dabbrev-tail
      (setq ,element (car dabbrev-tail))
      (if ,condition
          (setq dabbrev-result (cons ,element dabbrev-result)))
      (setq dabbrev-tail (cdr dabbrev-tail)))
    (nreverse dabbrev-result)))
362

Erik Naggum's avatar
Erik Naggum committed
363 364 365
;;----------------------------------------------------------------
;; Exported functions
;;----------------------------------------------------------------
366

367
;;;###autoload (define-key esc-map "/" 'dabbrev-expand)
368
;;;??? Do we want this?
369
;;;###autoload (define-key esc-map [?\C-/] 'dabbrev-completion)
370 371 372 373 374 375 376

;;;###autoload
(defun dabbrev-completion (&optional arg)
  "Completion on current word.
Like \\[dabbrev-expand] but finds all expansions in the current buffer
and presents suggestions for completion.

377 378
With a prefix argument, it searches all buffers accepted by the
function pointed out by `dabbrev-friend-buffer-function' to find the
379 380 381
completions.

If the prefix argument is 16 (which comes from C-u C-u),
382
then it searches *all* buffers."
383
  (interactive "*P")
384 385 386
  (dabbrev--reset-global-variables)
  (let* ((dabbrev-check-other-buffers (and arg t))
	 (dabbrev-check-all-buffers
387
	  (and arg (= (prefix-numeric-value arg) 16)))
388
	 (abbrev (dabbrev--abbrev-at-point))
389 390 391 392 393
	 (ignore-case-p (and (if (eq dabbrev-case-fold-search 'case-fold-search)
				 case-fold-search
			       dabbrev-case-fold-search)
			     (or (not dabbrev-upcase-means-case-search)
				 (string= abbrev (downcase abbrev)))))
394 395 396
	 (my-obarray dabbrev--last-obarray)
	 init)
    (save-excursion
397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433
      ;;--------------------------------
      ;; New abbreviation to expand.
      ;;--------------------------------
      (setq dabbrev--last-abbreviation abbrev)
      ;; Find all expansion
      (let ((completion-list
	     (dabbrev--find-all-expansions abbrev ignore-case-p))
	    (completion-ignore-case ignore-case-p))
	;; Make an obarray with all expansions
	(setq my-obarray (make-vector (length completion-list) 0))
	(or (> (length my-obarray) 0)
	    (error "No dynamic expansion for \"%s\" found%s"
		   abbrev
		   (if dabbrev--check-other-buffers "" " in this-buffer")))
	(cond
	 ((or (not ignore-case-p)
	      (not dabbrev-case-replace))
	  (mapc (function (lambda (string)
			    (intern string my-obarray)))
		completion-list))
	 ((string= abbrev (upcase abbrev))
	  (mapc (function (lambda (string)
			    (intern (upcase string) my-obarray)))
		completion-list))
	 ((string= (substring abbrev 0 1)
		   (upcase (substring abbrev 0 1)))
	  (mapc (function (lambda (string)
			    (intern (capitalize string) my-obarray)))
		completion-list))
	 (t
	  (mapc (function (lambda (string)
			    (intern (downcase string) my-obarray)))
		completion-list)))
	(setq dabbrev--last-obarray my-obarray)
	(setq dabbrev--last-completion-buffer (current-buffer))
	;; Find the longest common string.
	(setq init (try-completion abbrev my-obarray))))
434 435 436 437 438 439 440 441 442 443
    ;;--------------------------------
    ;; Let the user choose between the expansions
    ;;--------------------------------
    (or (stringp init)
	(setq init abbrev))
    (cond
     ;; * Replace string fragment with matched common substring completion.
     ((and (not (string-equal init ""))
	   (not (string-equal (downcase init) (downcase abbrev))))
      (if (> (length (all-completions init my-obarray)) 1)
444 445
	  (message "Repeat `%s' to see all completions"
		   (key-description (this-command-keys)))
446
	(message "The only possible completion"))
447
      (dabbrev--substitute-expansion nil abbrev init nil))
448 449 450
     (t
      ;; * String is a common substring completion already.  Make list.
      (message "Making completion list...")
451
      (with-output-to-temp-buffer "*Completions*"
452 453
	(display-completion-list (all-completions init my-obarray)
				 init))
454
      (message "Making completion list...done")))
455 456
    (and (window-minibuffer-p (selected-window))
	 (message nil))))
Jim Blandy's avatar
Jim Blandy committed
457 458 459 460 461

;;;###autoload
(defun dabbrev-expand (arg)
  "Expand previous word \"dynamically\".

462 463 464 465 466
Expands to the most recent, preceding word for which this is a prefix.
If no suitable preceding word is found, words following point are
considered.  If still no suitable word is found, then look in the
buffers accepted by the function pointed out by variable
`dabbrev-friend-buffer-function'.
Jim Blandy's avatar
Jim Blandy committed
467

468
A positive prefix argument, N, says to take the Nth backward *distinct*
469
possibility.  A negative argument says search forward.
Jim Blandy's avatar
Jim Blandy committed
470 471 472

If the cursor has not moved from the end of the previous expansion and
no argument is given, replace the previously-made expansion
473 474 475 476 477
with the next possible expansion not yet tried.

The variable `dabbrev-backward-only' may be used to limit the
direction of search to backward if set non-nil.

478
See also `dabbrev-abbrev-char-regexp' and \\[dabbrev-completion]."
Jim Blandy's avatar
Jim Blandy committed
479
  (interactive "*P")
480 481
  (let (abbrev record-case-pattern
	       expansion old direction (orig-point (point)))
Jim Blandy's avatar
Jim Blandy committed
482 483 484 485 486 487
    ;; abbrev -- the abbrev to expand
    ;; expansion -- the expansion found (eventually) or nil until then
    ;; old -- the text currently in the buffer
    ;;    (the abbrev, or the previously-made expansion)
    (save-excursion
      (if (and (null arg)
488 489
	       (markerp dabbrev--last-abbrev-location)
	       (marker-position dabbrev--last-abbrev-location)
490 491 492 493
	       (or (eq last-command this-command)
		   (and (window-minibuffer-p (selected-window))
			(= dabbrev--last-abbrev-location
			   (point)))))
494
	  ;; Find a different expansion for the same abbrev as last time.
495 496 497 498
	  (progn
	    (setq abbrev dabbrev--last-abbreviation)
	    (setq old dabbrev--last-expansion)
	    (setq direction dabbrev--last-direction))
499 500
	;; If the user inserts a space after expanding
	;; and then asks to expand again, always fetch the next word.
501
	(if (and (eq (preceding-char) ?\s)
502 503 504
		 (markerp dabbrev--last-abbrev-location)
		 (marker-position dabbrev--last-abbrev-location)
		 (= (point) (1+ dabbrev--last-abbrev-location)))
505
	    (progn
506 507 508
	      ;; The "abbrev" to expand is just the space.
	      (setq abbrev " ")
	      (save-excursion
509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529
		(save-restriction
		  (widen)
		  (if dabbrev--last-buffer
		      (set-buffer dabbrev--last-buffer))
		  ;; Find the end of the last "expansion" word.
		  (if (or (eq dabbrev--last-direction 1)
			  (and (eq dabbrev--last-direction 0)
			       (< dabbrev--last-expansion-location (point))))
		      (setq dabbrev--last-expansion-location
			    (+ dabbrev--last-expansion-location
			       (length dabbrev--last-expansion))))
		  (goto-char dabbrev--last-expansion-location)
		  ;; Take the following word, with intermediate separators,
		  ;; as our expansion this time.
		  (re-search-forward
		   (concat "\\(?:" dabbrev--abbrev-char-regexp "\\)+"))
		  (setq expansion (buffer-substring-no-properties
				   dabbrev--last-expansion-location (point)))

		  ;; Record the end of this expansion, in case we repeat this.
		  (setq dabbrev--last-expansion-location (point))))
530 531 532 533 534 535 536 537 538 539
	      ;; Indicate that dabbrev--last-expansion-location is
	      ;; at the end of the expansion.
	      (setq dabbrev--last-direction -1))

	  ;; We have a different abbrev to expand.
	  (dabbrev--reset-global-variables)
	  (setq direction (if (null arg)
			      (if dabbrev-backward-only 1 0)
			    (prefix-numeric-value arg)))
	  (setq abbrev (dabbrev--abbrev-at-point))
540
	  (setq record-case-pattern t)
541
	  (setq old nil)))
542 543 544 545

      ;;--------------------------------
      ;; Find the expansion
      ;;--------------------------------
546 547 548
      (or expansion
	  (setq expansion
		(dabbrev--find-expansion abbrev direction
549 550 551
					 (and (if (eq dabbrev-case-fold-search 'case-fold-search)
						  case-fold-search
						dabbrev-case-fold-search)
552 553
					      (or (not dabbrev-upcase-means-case-search)
						  (string= abbrev (downcase abbrev))))))))
554 555 556 557 558
    (cond
     ((not expansion)
      (dabbrev--reset-global-variables)
      (if old
	  (save-excursion
559
	    (setq buffer-undo-list (cons orig-point buffer-undo-list))
560 561 562 563
	    ;; Put back the original abbrev with its original case pattern.
	    (search-backward old)
	    (insert abbrev)
	    (delete-region (point) (+ (point) (length old)))))
564
      (error "No%s dynamic expansion for `%s' found"
565 566
	     (if old " further" "") abbrev))
     (t
567 568
      (if (not (or (eq dabbrev--last-buffer dabbrev--last-buffer-found)
		   (minibuffer-window-active-p (selected-window))))
Jim Blandy's avatar
Jim Blandy committed
569
	  (progn
570 571 572 573
	    (message "Expansion found in '%s'"
		     (buffer-name dabbrev--last-buffer))
	    (setq dabbrev--last-buffer-found dabbrev--last-buffer))
	(message nil))
574 575 576 577 578 579
      (if (and (or (eq (current-buffer) dabbrev--last-buffer)
		   (null dabbrev--last-buffer))
	       (numberp dabbrev--last-expansion-location)
	       (and (> dabbrev--last-expansion-location (point))))
	  (setq dabbrev--last-expansion-location
		(copy-marker dabbrev--last-expansion-location)))
Jim Blandy's avatar
Jim Blandy committed
580
      ;; Success: stick it in and return.
581
      (setq buffer-undo-list (cons orig-point buffer-undo-list))
582 583
      (dabbrev--substitute-expansion old abbrev expansion
				     record-case-pattern)
584

Jim Blandy's avatar
Jim Blandy committed
585
      ;; Save state for re-expand.
586
      (setq dabbrev--last-expansion expansion)
587 588 589
      (setq dabbrev--last-abbreviation abbrev)
      (setq dabbrev--last-abbrev-location (point-marker))))))

Erik Naggum's avatar
Erik Naggum committed
590 591 592
;;----------------------------------------------------------------
;; Local functions
;;----------------------------------------------------------------
593 594 595

;;; Checks if OTHER-BUFFER has the same major mode as current buffer.
(defun dabbrev--same-major-mode-p (other-buffer)
596 597 598 599
  (eq major-mode
      (save-excursion
	(set-buffer other-buffer)
	major-mode)))
600 601 602 603 604 605

;;; Back over all abbrev type characters and then moves forward over
;;; all skip characters.
(defun dabbrev--goto-start-of-abbrev ()
  ;; Move backwards over abbrev chars
  (save-match-data
606 607 608 609 610 611 612 613 614
    (when (> (point) (minibuffer-prompt-end))
      (forward-char -1)
      (while (and (looking-at dabbrev--abbrev-char-regexp)
		  (> (point) (minibuffer-prompt-end))
		  (not (= (point) (field-beginning (point) nil
						   (1- (point))))))
	(forward-char -1))
      (or (looking-at dabbrev--abbrev-char-regexp)
	  (forward-char 1)))
615 616 617 618
    (and dabbrev-abbrev-skip-leading-regexp
	 (while (looking-at dabbrev-abbrev-skip-leading-regexp)
	   (forward-char 1)))))

619
;;; Extract the symbol at point to serve as abbreviation.
620 621
(defun dabbrev--abbrev-at-point ()
  ;; Check for error
622 623
  (if (bobp)
      (error "No possible abbreviation preceding point"))
624 625
  ;; Return abbrev at point
  (save-excursion
626
    ;; Record the end of the abbreviation.
627
    (setq dabbrev--last-abbrev-location (point))
628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645
    ;; If we aren't right after an abbreviation,
    ;; move point back to just after one.
    ;; This is so the user can get successive words
    ;; by typing the punctuation followed by M-/.
    (save-match-data
      (if (save-excursion
	    (forward-char -1)
	    (not (looking-at (concat "\\("
				     (or dabbrev-abbrev-char-regexp
					 "\\sw\\|\\s_")
				     "\\)+"))))
	  (if (re-search-backward (or dabbrev-abbrev-char-regexp
				      "\\sw\\|\\s_")
				  nil t)
	      (forward-char 1)
	    (error "No possible abbreviation preceding point"))))
    ;; Now find the beginning of that one.
    (dabbrev--goto-start-of-abbrev)
646 647
    (buffer-substring-no-properties
     dabbrev--last-abbrev-location (point))))
648

649 650 651 652 653 654 655 656 657 658 659 660 661 662 663
;;; Initializes all global variables
(defun dabbrev--reset-global-variables ()
  ;; dabbrev--last-obarray and dabbrev--last-completion-buffer
  ;; must not be reset here.
  (setq dabbrev--last-table nil
	dabbrev--last-abbreviation nil
	dabbrev--last-abbrev-location nil
	dabbrev--last-direction nil
	dabbrev--last-expansion nil
	dabbrev--last-expansion-location nil
	dabbrev--friend-buffer-list nil
	dabbrev--last-buffer nil
	dabbrev--last-buffer-found nil
	dabbrev--abbrev-char-regexp (or dabbrev-abbrev-char-regexp
					"\\sw\\|\\s_")
664
	dabbrev--check-other-buffers dabbrev-check-other-buffers))
665 666

(defun dabbrev--select-buffers ()
667 668 669 670 671 672 673 674 675 676 677 678 679 680
  "Return a list of other buffers to search for a possible abbrev.
The current buffer is not included in the list.

This function makes a list of all the buffers returned by `buffer-list',
then discards buffers whose names match `dabbrev-ignored-buffer-names'
or `dabbrev-ignored-buffer-regexps'.  It also discards buffers for which
`dabbrev-friend-buffer-function', if it is bound, returns nil when called
with the buffer as argument.
It returns the list of the buffers that are not discarded."
  (dabbrev-filter-elements
   buffer (buffer-list)
   (and (not (eq (current-buffer) buffer))
	(not (dabbrev--ignore-buffer-p buffer))
	(boundp 'dabbrev-friend-buffer-function)
681
	(funcall dabbrev-friend-buffer-function buffer))))
682

683
(defun dabbrev--try-find (abbrev reverse n ignore-case)
684 685 686 687
  "Search for ABBREV, backwards if REVERSE, N times.
If IGNORE-CASE is non-nil, ignore case while searching.
Return the expansion found, and save the location of the start
of the expansion in `dabbrev--last-expansion-location'."
688
  (save-excursion
689 690 691 692 693 694 695 696 697 698
    (save-restriction
      (widen)
      (let ((expansion nil))
	(and dabbrev--last-expansion-location
	     (goto-char dabbrev--last-expansion-location))
	(let ((case-fold-search ignore-case)
	      (count n))
	  (while (and (> count 0)
		      (setq expansion (dabbrev--search abbrev
						       reverse
699 700 701 702 703
						       (and ignore-case
							    (if (eq dabbrev-case-distinction 'case-replace)
								case-replace
							      dabbrev-case-distinction))
						       )))
704 705 706 707
	    (setq count (1- count))))
	(and expansion
	     (setq dabbrev--last-expansion-location (point)))
	expansion))))
708 709

(defun dabbrev--find-all-expansions (abbrev ignore-case)
710 711
  "Return a list of all possible expansions of ABBREV.
If IGNORE-CASE is non-nil, accept matches which differ in case."
712 713 714 715 716
  (let ((all-expansions nil)
	expansion)
    (save-excursion
      (goto-char (point-min))
      (while (setq expansion (dabbrev--find-expansion abbrev -1 ignore-case))
717
	(setq all-expansions (cons expansion all-expansions))))
718 719
    all-expansions))

720 721 722 723 724 725 726 727 728 729 730
(defun dabbrev--ignore-buffer-p (buffer)
  "Return non-nil if BUFFER should be ignored by dabbrev."
  (let ((bn (buffer-name buffer)))
    (or (member bn dabbrev-ignored-buffer-names)
	(let ((tail dabbrev-ignored-buffer-regexps)
	      (match nil))
	  (while (and tail (not match))
	    (setq match (string-match (car tail) bn)
		  tail (cdr tail)))
	  match))))

731
(defun dabbrev--find-expansion (abbrev direction ignore-case)
732 733 734 735 736 737 738
  "Find one occurrence of ABBREV, and return the expansion.
DIRECTION > 0 means look that many times backwards.
DIRECTION < 0 means look that many times forward.
DIRECTION = 0 means try both backward and forward.
IGNORE-CASE non-nil means ignore case when searching.
This sets `dabbrev--last-direction' to 1 or -1 according
to the direction in which the occurrence was actually found.
739
It sets `dabbrev--last-expansion-location' to the location
740
of the start of the occurrence."
741 742 743 744
  (save-excursion
    ;; If we were scanning something other than the current buffer,
    ;; continue scanning there.
    (when dabbrev--last-buffer
745
      (set-buffer dabbrev--last-buffer))
746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776
    (or
     ;; ------------------------------------------
     ;; Look backward in current buffer.
     ;; ------------------------------------------
     (and (not dabbrev-search-these-buffers-only)
	  (>= direction 0)
	  (setq dabbrev--last-direction (min 1 direction))
	  (dabbrev--try-find abbrev t
			     (max 1 direction)
			     ignore-case))
     ;; ------------------------------------------
     ;; Look forward in current buffer
     ;; or whatever buffer we were last scanning.
     ;; ------------------------------------------
     (and (or (not dabbrev-search-these-buffers-only)
	      dabbrev--last-buffer)
	  (<= direction 0)
	  (setq dabbrev--last-direction -1)
	  (dabbrev--try-find abbrev nil
			     (max 1 (- direction))
			     ignore-case))
     ;; ------------------------------------------
     ;; Look in other buffers.
     ;; Always start at (point-min) and look forward.
     ;; ------------------------------------------
     (progn
       (setq dabbrev--last-direction -1)
       (unless dabbrev--last-buffer
	 ;; If we have just now begun to search other buffers,
	 ;; determine which other buffers we should check.
	 ;; Put that list in dabbrev--friend-buffer-list.
777 778 779 780 781 782 783
	 (unless dabbrev--friend-buffer-list
           (setq dabbrev--friend-buffer-list
                 (dabbrev--make-friend-buffer-list))
           (setq dabbrev--progress-reporter
                 (make-progress-reporter
                  "Scanning for dabbrevs..."
                  (- (length dabbrev--friend-buffer-list)) 0 0 1 1.5))))
784 785 786
       ;; Walk through the buffers till we find a match.
       (let (expansion)
	 (while (and (not expansion) dabbrev--friend-buffer-list)
787
	   (setq dabbrev--last-buffer (pop dabbrev--friend-buffer-list))
788
	   (set-buffer dabbrev--last-buffer)
789 790
           (progress-reporter-update dabbrev--progress-reporter
                                     (- (length dabbrev--friend-buffer-list)))
791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814
	   (setq dabbrev--last-expansion-location (point-min))
	   (setq expansion (dabbrev--try-find abbrev nil 1 ignore-case)))
	 expansion)))))

;; Compute the list of buffers to scan.
;; If dabbrev-search-these-buffers-only, then the current buffer
;; is included in this list if it should be searched.
;; Otherwise, the current buffer is searched first specially.,
;; and it is not included in this list.
(defun dabbrev--make-friend-buffer-list ()
  (let ((list (mapcar (function get-buffer)
		      dabbrev-search-these-buffers-only)))
    (when (and (null dabbrev-search-these-buffers-only)
	       dabbrev--check-other-buffers
	       (or (eq dabbrev--check-other-buffers t)
		   (setq dabbrev--check-other-buffers
			 (y-or-n-p "Scan other buffers also? "))))
      (setq list (funcall dabbrev-select-buffers-function))
      ;; If dabbrev-check-all-buffers, tack on all the other
      ;; buffers at the end of the list, except those which are
      ;; specifically to be ignored.
      (if dabbrev-check-all-buffers
	  (setq list
		(append list
815 816
			(dabbrev-filter-elements
			 buffer (buffer-list)
817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839
			 (and (not (memq buffer list))
			      (not (dabbrev--ignore-buffer-p buffer)))))))
      ;; Remove the current buffer.
      (setq list (delq (current-buffer) list)))
    ;; Move buffers in the list that are visible on the screen
    ;; to the front of the list, but don't add anything to the list.
    (if list
	(walk-windows (lambda (w)
			(unless (eq w (selected-window))
			  (if (memq (window-buffer w) list)
			      (setq list
				    (cons (window-buffer w)
					  (delq (window-buffer w)
						list))))))))
    ;; In a minibuffer, search the buffer it was activated from,
    ;; first after the minibuffer itself.  Unless we aren't supposed
    ;; to search the current buffer either.
    (if (and (window-minibuffer-p (selected-window))
	     (not dabbrev-search-these-buffers-only))
	(setq list
	      (cons (dabbrev--minibuffer-origin)
		    (delq (dabbrev--minibuffer-origin) list))))
    list))
840 841 842

(defun dabbrev--safe-replace-match (string &optional fixedcase literal)
  (if (eq major-mode 'picture-mode)
843 844
      (with-no-warnings
       (picture-replace-match string fixedcase literal))
845 846 847
    (replace-match string fixedcase literal)))

;;;----------------------------------------------------------------
848 849 850 851 852 853 854 855 856
(defun dabbrev--substitute-expansion (old abbrev expansion record-case-pattern)
  "Replace OLD with EXPANSION in the buffer.
OLD is text currently in the buffer, perhaps the abbreviation
or perhaps another expansion that was tried previously.
ABBREV is the abbreviation we are expanding.
It is \" \" if we are copying subsequent words.
EXPANSION is the expansion substring to be used this time.
RECORD-CASE-PATTERN, if non-nil, means set `dabbrev--last-case-pattern'
to record whether we upcased the expansion, downcased it, or did neither."
857
  ;;(undo-boundary)
858 859 860
  (let ((use-case-replace (and (if (eq dabbrev-case-fold-search 'case-fold-search)
				   case-fold-search
				 dabbrev-case-fold-search)
861 862
			       (or (not dabbrev-upcase-means-case-search)
				   (string= abbrev (downcase abbrev)))
863 864 865
			       (if (eq dabbrev-case-replace 'case-replace)
				   case-replace
				 dabbrev-case-replace))))
866 867 868

    ;; If we upcased or downcased the original expansion,
    ;; do likewise for the subsequent words when we copy them.
869 870 871 872 873 874
    ;; Don't do any of the usual case processing, though.
    (when (equal abbrev " ")
      (if dabbrev--last-case-pattern
	  (setq expansion
		(funcall dabbrev--last-case-pattern expansion)))
      (setq use-case-replace nil))
875

876 877 878 879
    ;; If the expansion has mixed case
    ;; and it is not simply a capitalized word,
    ;; or if the abbrev has mixed case,
    ;; and if the given abbrev's case pattern
880 881 882
    ;; matches the start of the expansion,
    ;; copy the expansion's case
    ;; instead of downcasing all the rest.
883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898
    ;;
    ;; Treat a one-capital-letter (possibly with preceding non-letter
    ;; characters) abbrev as "not all upper case", so as to force
    ;; preservation of the expansion's pattern if the expansion starts
    ;; with a capital letter.
    (let ((expansion-rest (substring expansion 1))
	  (first-letter-position (string-match "[[:alpha:]]" abbrev)))
      (if (or (null first-letter-position)
	      (and (not (and (or (string= expansion-rest (downcase expansion-rest))
				 (string= expansion-rest (upcase expansion-rest)))
			     (or (string= abbrev (downcase abbrev))
				 (and (string= abbrev (upcase abbrev))
				      (> (- (length abbrev) first-letter-position)
					 1)))))
		   (string= abbrev
			    (substring expansion 0 (length abbrev)))))
899
	  (setq use-case-replace nil)))
900 901 902 903

    ;; If the abbrev and the expansion are both all-lower-case
    ;; then don't do any conversion.  The conversion would be a no-op
    ;; for this replacement, but it would carry forward to subsequent words.
904
    ;; The goal of this is to prevent that carrying forward.
905 906
    (if (and (string= expansion (downcase expansion))
	     (string= abbrev (downcase abbrev)))
907
	(setq use-case-replace nil))
908

909 910
    (if use-case-replace
	(setq expansion (downcase expansion)))
911 912 913 914 915

    ;; In case we insert subsequent words,
    ;; record if we upcased or downcased the first word,
    ;; in order to do likewise for subsequent words.
    (and record-case-pattern
916
	 (setq dabbrev--last-case-pattern
917 918 919 920
	       (and use-case-replace
		    (cond ((equal abbrev (upcase abbrev)) 'upcase)
			  ((equal abbrev (downcase abbrev)) 'downcase)))))

921
    ;; Convert whitespace to single spaces.
922 923 924 925 926 927
    (if dabbrev-eliminate-newlines
	(let ((pos
	       (if (equal abbrev " ") 0 (length abbrev))))
	  ;; If ABBREV is real, search after the end of it.
	  ;; If ABBREV is space and we are copying successive words,
	  ;; search starting at the front.
928 929 930
	  (while (string-match "[\n \t]+" expansion pos)
	    (setq pos (1+ (match-beginning 0)))
	    (setq expansion (replace-match " " nil nil expansion)))))
931

932 933 934
    (if old
	(save-excursion
	  (search-backward old))
Richard M. Stallman's avatar
Richard M. Stallman committed
935
      ;;(set-match-data (list (point-marker) (point-marker)))
936 937 938
      (search-backward abbrev)
      (search-forward abbrev))

939 940 941 942 943 944 945 946 947 948 949 950 951
    ;; Make case of replacement conform to case of abbreviation
    ;; provided (1) that kind of thing is enabled in this buffer
    ;; and (2) the replacement itself is all lower case.
    (dabbrev--safe-replace-match expansion
				 (not use-case-replace)
				 t)))


;;;----------------------------------------------------------------
;;; Search function used by dabbrevs library.


(defun dabbrev--search (abbrev reverse ignore-case)
952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967
  "Search for something that could be used to expand ABBREV.

Second arg, REVERSE, is t for reverse search, nil for forward.
The variable `dabbrev-limit' controls the maximum search region size.
Third argument IGNORE-CASE non-nil means treat case as insignificant while
looking for a match and when comparing with previous matches.  Also if
that's non-nil and the match is found at the beginning of a sentence
and is in lower case except for the initial then it is converted to
all lower case for return.

Table of expansions already seen is examined in buffer
`dabbrev--last-table' so that only distinct possibilities are found
by dabbrev-re-expand.

Returns the expansion found, or nil if not found.
Leaves point at the location of the start of the expansion."
968 969 970 971 972
  (save-match-data
    (let ((pattern1 (concat (regexp-quote abbrev)
			    "\\(" dabbrev--abbrev-char-regexp "\\)"))
	  (pattern2 (concat (regexp-quote abbrev)
			   "\\(\\(" dabbrev--abbrev-char-regexp "\\)+\\)"))
973 974 975
	  ;; This makes it possible to find matches in minibuffer prompts
	  ;; even when they are "inviolable".
	  (inhibit-point-motion-hooks t)
976
	  found-string result)
977 978 979 980 981 982 983 984 985 986 987 988 989
      ;; Limited search.
      (save-restriction
	(and dabbrev-limit
	     (narrow-to-region dabbrev--last-expansion-location
			       (+ (point)
				  (if reverse (- dabbrev-limit) dabbrev-limit))))
	;;--------------------------------
	;; Look for a distinct expansion, using dabbrev--last-table.
	;;--------------------------------
	(while (and (not found-string)
		    (if reverse
			(re-search-backward pattern1 nil t)
		      (re-search-forward pattern1 nil t)))
990 991 992 993 994 995 996 997
	  (goto-char (match-beginning 0))
	  ;; In case we matched in the middle of a word,
	  ;; back up to start of word and verify we still match.
	  (dabbrev--goto-start-of-abbrev)

	  (if (not (looking-at pattern1))
	      nil
	    ;; We have a truly valid match.  Find the end.
998
	    (re-search-forward pattern2)
999
	    (setq found-string (match-string-no-properties 0))
1000
	    (setq result found-string)
1001
	    (and ignore-case (setq found-string (downcase found-string)))
1002
	    ;; Ignore this match if it's already in the table.
1003 1004 1005
	    (if (dabbrev-filter-elements
		 table-string dabbrev--last-table
		 (string= found-string table-string))
1006 1007
		(setq found-string nil)))
	  ;; Prepare to continue searching.
1008
	  (goto-char (if reverse (match-beginning 0) (match-end 0))))
1009
	;; If we found something, use it.
1010 1011 1012 1013 1014 1015
	(when found-string
	  ;; Put it into `dabbrev--last-table'
	  ;; and return it (either downcased, or as is).
	  (setq dabbrev--last-table
		(cons found-string dabbrev--last-table))
	  result)))))
1016

1017
(dolist (mess '("^No dynamic expansion for .* found"
Dave Love's avatar
Dave Love committed
1018 1019 1020 1021
		"^No further dynamic expansion for .* found$"
		"^No possible abbreviation preceding point$"))
  (add-to-list 'debug-ignored-errors mess))

Roland McGrath's avatar
Roland McGrath committed
1022
(provide 'dabbrev)
1023

1024
;; arch-tag: 29e58596-f080-4306-a409-70296cf9d46f
Erik Naggum's avatar
Erik Naggum committed
1025
;;; dabbrev.el ends here