Fix make bootstrap
[emacs.git] / lisp / abbrev.el
blobb72bdbb81261ecd7fd6bd14cf291ef1d6a1c6759
1 ;;; abbrev.el --- abbrev mode commands for Emacs
3 ;; Copyright (C) 1985, 1986, 1987, 1992, 2001, 2002, 2003, 2004,
4 ;; 2005, 2006, 2007, 2008, 2009, 2010 Free Software Foundation, Inc.
6 ;; Maintainer: FSF
7 ;; Keywords: abbrev convenience
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation, either version 3 of the License, or
14 ;; (at your option) any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
24 ;;; Commentary:
26 ;; This facility is documented in the Emacs Manual.
28 ;; Todo:
30 ;; - Cleanup name space.
32 ;;; Code:
34 (eval-when-compile (require 'cl))
36 (defgroup abbrev-mode nil
37 "Word abbreviations mode."
38 :link '(custom-manual "(emacs)Abbrevs")
39 :group 'abbrev)
41 (defcustom abbrev-file-name
42 (locate-user-emacs-file "abbrev_defs" ".abbrev_defs")
43 "Default name of file from which to read abbrevs."
44 :initialize 'custom-initialize-delay
45 :type 'file)
47 (defcustom only-global-abbrevs nil
48 "Non-nil means user plans to use global abbrevs only.
49 This makes the commands that normally define mode-specific abbrevs
50 define global abbrevs instead."
51 :type 'boolean
52 :group 'abbrev-mode
53 :group 'convenience)
55 (define-minor-mode abbrev-mode
56 "Toggle Abbrev mode in the current buffer.
57 With optional argument ARG, turn abbrev mode on if ARG is
58 positive, otherwise turn it off. In Abbrev mode, inserting an
59 abbreviation causes it to expand and be replaced by its expansion.")
61 (defcustom abbrev-mode nil
62 "Enable or disable Abbrev mode.
63 Non-nil means automatically expand abbrevs as they are inserted.
65 Setting this variable with `setq' changes it for the current buffer.
66 Changing it with \\[customize] sets the default value.
67 Interactively, use the command `abbrev-mode'
68 to enable or disable Abbrev mode in the current buffer."
69 :type 'boolean
70 :group 'abbrev-mode)
71 (put 'abbrev-mode 'safe-local-variable 'booleanp)
74 (defvar edit-abbrevs-map
75 (let ((map (make-sparse-keymap)))
76 (define-key map "\C-x\C-s" 'edit-abbrevs-redefine)
77 (define-key map "\C-c\C-c" 'edit-abbrevs-redefine)
78 map)
79 "Keymap used in `edit-abbrevs'.")
81 (defun kill-all-abbrevs ()
82 "Undefine all defined abbrevs."
83 (interactive)
84 (dolist (tablesym abbrev-table-name-list)
85 (clear-abbrev-table (symbol-value tablesym))))
87 (defun copy-abbrev-table (table)
88 "Make a new abbrev-table with the same abbrevs as TABLE."
89 (let ((new-table (make-abbrev-table)))
90 (mapatoms
91 (lambda (symbol)
92 (define-abbrev new-table
93 (symbol-name symbol)
94 (symbol-value symbol)
95 (symbol-function symbol)))
96 table)
97 new-table))
99 (defun insert-abbrevs ()
100 "Insert after point a description of all defined abbrevs.
101 Mark is set after the inserted text."
102 (interactive)
103 (push-mark
104 (save-excursion
105 (dolist (tablesym abbrev-table-name-list)
106 (insert-abbrev-table-description tablesym t))
107 (point))))
109 (defun list-abbrevs (&optional local)
110 "Display a list of defined abbrevs.
111 If LOCAL is non-nil, interactively when invoked with a
112 prefix arg, display only local, i.e. mode-specific, abbrevs.
113 Otherwise display all abbrevs."
114 (interactive "P")
115 (display-buffer (prepare-abbrev-list-buffer local)))
117 (defun abbrev-table-name (table)
118 "Value is the name of abbrev table TABLE."
119 (let ((tables abbrev-table-name-list)
120 found)
121 (while (and (not found) tables)
122 (when (eq (symbol-value (car tables)) table)
123 (setq found (car tables)))
124 (setq tables (cdr tables)))
125 found))
127 (defun prepare-abbrev-list-buffer (&optional local)
128 (with-current-buffer (get-buffer-create "*Abbrevs*")
129 (erase-buffer)
130 (if local
131 (insert-abbrev-table-description
132 (abbrev-table-name local-abbrev-table) t)
133 (dolist (table abbrev-table-name-list)
134 (insert-abbrev-table-description table t)))
135 (goto-char (point-min))
136 (set-buffer-modified-p nil)
137 (edit-abbrevs-mode)
138 (current-buffer)))
140 (defun edit-abbrevs-mode ()
141 "Major mode for editing the list of abbrev definitions.
142 \\{edit-abbrevs-map}"
143 (interactive)
144 (kill-all-local-variables)
145 (setq major-mode 'edit-abbrevs-mode)
146 (setq mode-name "Edit-Abbrevs")
147 (use-local-map edit-abbrevs-map)
148 (run-mode-hooks 'edit-abbrevs-mode-hook))
150 (defun edit-abbrevs ()
151 "Alter abbrev definitions by editing a list of them.
152 Selects a buffer containing a list of abbrev definitions.
153 You can edit them and type \\<edit-abbrevs-map>\\[edit-abbrevs-redefine] to redefine abbrevs
154 according to your editing.
155 Buffer contains a header line for each abbrev table,
156 which is the abbrev table name in parentheses.
157 This is followed by one line per abbrev in that table:
158 NAME USECOUNT EXPANSION HOOK
159 where NAME and EXPANSION are strings with quotes,
160 USECOUNT is an integer, and HOOK is any valid function
161 or may be omitted (it is usually omitted)."
162 (interactive)
163 (switch-to-buffer (prepare-abbrev-list-buffer)))
165 (defun edit-abbrevs-redefine ()
166 "Redefine abbrevs according to current buffer contents."
167 (interactive)
168 (save-restriction
169 (widen)
170 (define-abbrevs t)
171 (set-buffer-modified-p nil)))
173 (defun define-abbrevs (&optional arg)
174 "Define abbrevs according to current visible buffer contents.
175 See documentation of `edit-abbrevs' for info on the format of the
176 text you must have in the buffer.
177 With argument, eliminate all abbrev definitions except
178 the ones defined from the buffer now."
179 (interactive "P")
180 (if arg (kill-all-abbrevs))
181 (save-excursion
182 (goto-char (point-min))
183 (while (and (not (eobp)) (re-search-forward "^(" nil t))
184 (let* ((buf (current-buffer))
185 (table (read buf))
186 abbrevs name hook exp count sys)
187 (forward-line 1)
188 (while (progn (forward-line 1)
189 (not (eolp)))
190 (setq name (read buf) count (read buf))
191 (if (equal count '(sys))
192 (setq sys t count (read buf)))
193 (setq exp (read buf))
194 (skip-chars-backward " \t\n\f")
195 (setq hook (if (not (eolp)) (read buf)))
196 (skip-chars-backward " \t\n\f")
197 (setq abbrevs (cons (list name exp hook count sys) abbrevs)))
198 (define-abbrev-table table abbrevs)))))
200 (defun read-abbrev-file (&optional file quietly)
201 "Read abbrev definitions from file written with `write-abbrev-file'.
202 Optional argument FILE is the name of the file to read;
203 it defaults to the value of `abbrev-file-name'.
204 Optional second argument QUIETLY non-nil means don't display a message."
205 (interactive
206 (list
207 (read-file-name (format "Read abbrev file (default %s): "
208 abbrev-file-name)
209 nil abbrev-file-name t)))
210 (load (or file abbrev-file-name) nil quietly)
211 (setq abbrevs-changed nil))
213 (defun quietly-read-abbrev-file (&optional file)
214 "Read abbrev definitions from file written with `write-abbrev-file'.
215 Optional argument FILE is the name of the file to read;
216 it defaults to the value of `abbrev-file-name'.
217 Does not display any message."
218 ;(interactive "fRead abbrev file: ")
219 (read-abbrev-file file t))
221 (defun write-abbrev-file (&optional file)
222 "Write all user-level abbrev definitions to a file of Lisp code.
223 This does not include system abbrevs; it includes only the abbrev tables
224 listed in listed in `abbrev-table-name-list'.
225 The file written can be loaded in another session to define the same abbrevs.
226 The argument FILE is the file name to write. If omitted or nil, the file
227 specified in `abbrev-file-name' is used."
228 (interactive
229 (list
230 (read-file-name "Write abbrev file: "
231 (file-name-directory (expand-file-name abbrev-file-name))
232 abbrev-file-name)))
233 (or (and file (> (length file) 0))
234 (setq file abbrev-file-name))
235 (let ((coding-system-for-write 'emacs-mule))
236 (with-temp-file file
237 (insert ";;-*-coding: emacs-mule;-*-\n")
238 (dolist (table
239 ;; We sort the table in order to ease the automatic
240 ;; merging of different versions of the user's abbrevs
241 ;; file. This is useful, for example, for when the
242 ;; user keeps their home directory in a revision
243 ;; control system, and is therefore keeping multiple
244 ;; slightly-differing copies loosely synchronized.
245 (sort (copy-sequence abbrev-table-name-list)
246 (lambda (s1 s2)
247 (string< (symbol-name s1)
248 (symbol-name s2)))))
249 (insert-abbrev-table-description table nil)))))
251 (defun add-mode-abbrev (arg)
252 "Define mode-specific abbrev for last word(s) before point.
253 Argument is how many words before point form the expansion;
254 or zero means the region is the expansion.
255 A negative argument means to undefine the specified abbrev.
256 Reads the abbreviation in the minibuffer.
258 Don't use this function in a Lisp program; use `define-abbrev' instead."
259 (interactive "p")
260 (add-abbrev
261 (if only-global-abbrevs
262 global-abbrev-table
263 (or local-abbrev-table
264 (error "No per-mode abbrev table")))
265 "Mode" arg))
267 (defun add-global-abbrev (arg)
268 "Define global (all modes) abbrev for last word(s) before point.
269 The prefix argument specifies the number of words before point that form the
270 expansion; or zero means the region is the expansion.
271 A negative argument means to undefine the specified abbrev.
272 This command uses the minibuffer to read the abbreviation.
274 Don't use this function in a Lisp program; use `define-abbrev' instead."
275 (interactive "p")
276 (add-abbrev global-abbrev-table "Global" arg))
278 (defun add-abbrev (table type arg)
279 (let ((exp (and (>= arg 0)
280 (buffer-substring-no-properties
281 (point)
282 (if (= arg 0) (mark)
283 (save-excursion (forward-word (- arg)) (point))))))
284 name)
285 (setq name
286 (read-string (format (if exp "%s abbrev for \"%s\": "
287 "Undefine %s abbrev: ")
288 type exp)))
289 (set-text-properties 0 (length name) nil name)
290 (if (or (null exp)
291 (not (abbrev-expansion name table))
292 (y-or-n-p (format "%s expands to \"%s\"; redefine? "
293 name (abbrev-expansion name table))))
294 (define-abbrev table (downcase name) exp))))
296 (defun inverse-add-mode-abbrev (n)
297 "Define last word before point as a mode-specific abbrev.
298 With prefix argument N, defines the Nth word before point.
299 This command uses the minibuffer to read the expansion.
300 Expands the abbreviation after defining it."
301 (interactive "p")
302 (inverse-add-abbrev
303 (if only-global-abbrevs
304 global-abbrev-table
305 (or local-abbrev-table
306 (error "No per-mode abbrev table")))
307 "Mode" n))
309 (defun inverse-add-global-abbrev (n)
310 "Define last word before point as a global (mode-independent) abbrev.
311 With prefix argument N, defines the Nth word before point.
312 This command uses the minibuffer to read the expansion.
313 Expands the abbreviation after defining it."
314 (interactive "p")
315 (inverse-add-abbrev global-abbrev-table "Global" n))
317 (defun inverse-add-abbrev (table type arg)
318 (let (name exp start end)
319 (save-excursion
320 (forward-word (1+ (- arg)))
321 (setq end (point))
322 (backward-word 1)
323 (setq start (point)
324 name (buffer-substring-no-properties start end)))
326 (setq exp (read-string (format "%s expansion for \"%s\": " type name)
327 nil nil nil t))
328 (when (or (not (abbrev-expansion name table))
329 (y-or-n-p (format "%s expands to \"%s\"; redefine? "
330 name (abbrev-expansion name table))))
331 (define-abbrev table (downcase name) exp)
332 (save-excursion
333 (goto-char end)
334 (expand-abbrev)))))
336 (defun abbrev-prefix-mark (&optional arg)
337 "Mark current point as the beginning of an abbrev.
338 Abbrev to be expanded starts here rather than at beginning of word.
339 This way, you can expand an abbrev with a prefix: insert the prefix,
340 use this command, then insert the abbrev. This command inserts a
341 temporary hyphen after the prefix \(until the intended abbrev
342 expansion occurs).
343 If the prefix is itself an abbrev, this command expands it, unless
344 ARG is non-nil. Interactively, ARG is the prefix argument."
345 (interactive "P")
346 (or arg (expand-abbrev))
347 (setq abbrev-start-location (point-marker)
348 abbrev-start-location-buffer (current-buffer))
349 (insert "-"))
351 (defun expand-region-abbrevs (start end &optional noquery)
352 "For abbrev occurrence in the region, offer to expand it.
353 The user is asked to type `y' or `n' for each occurrence.
354 A prefix argument means don't query; expand all abbrevs."
355 (interactive "r\nP")
356 (save-excursion
357 (goto-char start)
358 (let ((lim (- (point-max) end))
359 pnt string)
360 (while (and (not (eobp))
361 (progn (forward-word 1)
362 (<= (setq pnt (point)) (- (point-max) lim))))
363 (if (abbrev-expansion
364 (setq string
365 (buffer-substring-no-properties
366 (save-excursion (forward-word -1) (point))
367 pnt)))
368 (if (or noquery (y-or-n-p (format "Expand `%s'? " string)))
369 (expand-abbrev)))))))
371 ;;; Abbrev properties.
373 (defun abbrev-table-get (table prop)
374 "Get the PROP property of abbrev table TABLE."
375 (let ((sym (intern-soft "" table)))
376 (if sym (get sym prop))))
378 (defun abbrev-table-put (table prop val)
379 "Set the PROP property of abbrev table TABLE to VAL."
380 (let ((sym (intern "" table)))
381 (set sym nil) ; Make sure it won't be confused for an abbrev.
382 (put sym prop val)))
384 (defalias 'abbrev-get 'get
385 "Get the property PROP of abbrev ABBREV
387 \(fn ABBREV PROP)")
389 (defalias 'abbrev-put 'put
390 "Set the property PROP of abbrev ABREV to value VAL.
391 See `define-abbrev' for the effect of some special properties.
393 \(fn ABBREV PROP VAL)")
395 ;;; Code that used to be implemented in src/abbrev.c
397 (defvar abbrev-table-name-list '(fundamental-mode-abbrev-table
398 global-abbrev-table)
399 "List of symbols whose values are abbrev tables.")
401 (defun make-abbrev-table (&optional props)
402 "Create a new, empty abbrev table object.
403 PROPS is a list of properties."
404 ;; The value 59 is an arbitrary prime number.
405 (let ((table (make-vector 59 0)))
406 ;; Each abbrev-table has a `modiff' counter which can be used to detect
407 ;; when an abbreviation was added. An example of use would be to
408 ;; construct :regexp dynamically as the union of all abbrev names, so
409 ;; `modiff' can let us detect that an abbrev was added and hence :regexp
410 ;; needs to be refreshed.
411 ;; The presence of `modiff' entry is also used as a tag indicating this
412 ;; vector is really an abbrev-table.
413 (abbrev-table-put table :abbrev-table-modiff 0)
414 (while (consp props)
415 (abbrev-table-put table (pop props) (pop props)))
416 table))
418 (defun abbrev-table-p (object)
419 (and (vectorp object)
420 (numberp (abbrev-table-get object :abbrev-table-modiff))))
422 (defvar global-abbrev-table (make-abbrev-table)
423 "The abbrev table whose abbrevs affect all buffers.
424 Each buffer may also have a local abbrev table.
425 If it does, the local table overrides the global one
426 for any particular abbrev defined in both.")
428 (defvar abbrev-minor-mode-table-alist nil
429 "Alist of abbrev tables to use for minor modes.
430 Each element looks like (VARIABLE . ABBREV-TABLE);
431 ABBREV-TABLE is active whenever VARIABLE's value is non-nil.")
433 (defvar fundamental-mode-abbrev-table
434 (let ((table (make-abbrev-table)))
435 ;; Set local-abbrev-table's default to be fundamental-mode-abbrev-table.
436 (setq-default local-abbrev-table table)
437 table)
438 "The abbrev table of mode-specific abbrevs for Fundamental Mode.")
440 (defvar abbrevs-changed nil
441 "Set non-nil by defining or altering any word abbrevs.
442 This causes `save-some-buffers' to offer to save the abbrevs.")
444 (defcustom abbrev-all-caps nil
445 "Non-nil means expand multi-word abbrevs all caps if abbrev was so."
446 :type 'boolean
447 :group 'abbrev-mode)
449 (defvar abbrev-start-location nil
450 "Buffer position for `expand-abbrev' to use as the start of the abbrev.
451 When nil, use the word before point as the abbrev.
452 Calling `expand-abbrev' sets this to nil.")
454 (defvar abbrev-start-location-buffer nil
455 "Buffer that `abbrev-start-location' has been set for.
456 Trying to expand an abbrev in any other buffer clears `abbrev-start-location'.")
458 (defvar last-abbrev nil
459 "The abbrev-symbol of the last abbrev expanded. See `abbrev-symbol'.")
461 (defvar last-abbrev-text nil
462 "The exact text of the last abbrev expanded.
463 nil if the abbrev has already been unexpanded.")
465 (defvar last-abbrev-location 0
466 "The location of the start of the last abbrev expanded.")
468 ;; (defvar local-abbrev-table fundamental-mode-abbrev-table
469 ;; "Local (mode-specific) abbrev table of current buffer.")
470 ;; (make-variable-buffer-local 'local-abbrev-table)
472 (defcustom pre-abbrev-expand-hook nil
473 "Function or functions to be called before abbrev expansion is done.
474 This is the first thing that `expand-abbrev' does, and so this may change
475 the current abbrev table before abbrev lookup happens."
476 :type 'hook
477 :group 'abbrev-mode)
478 (make-obsolete-variable 'pre-abbrev-expand-hook 'abbrev-expand-functions "23.1")
480 (defun clear-abbrev-table (table)
481 "Undefine all abbrevs in abbrev table TABLE, leaving it empty."
482 (setq abbrevs-changed t)
483 (let* ((sym (intern-soft "" table)))
484 (dotimes (i (length table))
485 (aset table i 0))
486 ;; Preserve the table's properties.
487 (assert sym)
488 (let ((newsym (intern "" table)))
489 (set newsym nil) ; Make sure it won't be confused for an abbrev.
490 (setplist newsym (symbol-plist sym)))
491 (abbrev-table-put table :abbrev-table-modiff
492 (1+ (abbrev-table-get table :abbrev-table-modiff))))
493 ;; For backward compatibility, always return nil.
494 nil)
496 (defun define-abbrev (table name expansion &optional hook &rest props)
497 "Define an abbrev in TABLE named NAME, to expand to EXPANSION and call HOOK.
498 NAME must be a string, and should be lower-case.
499 EXPANSION should usually be a string.
500 To undefine an abbrev, define it with EXPANSION = nil.
501 If HOOK is non-nil, it should be a function of no arguments;
502 it is called after EXPANSION is inserted.
503 If EXPANSION is not a string (and not nil), the abbrev is a
504 special one, which does not expand in the usual way but only
505 runs HOOK.
507 PROPS is a property list. The following properties are special:
508 - `:count': the value for the abbrev's usage-count, which is incremented each
509 time the abbrev is used (the default is zero).
510 - `:system': if non-nil, says that this is a \"system\" abbreviation
511 which should not be saved in the user's abbreviation file.
512 Unless `:system' is `force', a system abbreviation will not
513 overwrite a non-system abbreviation of the same name.
514 - `:case-fixed': non-nil means that abbreviations are looked up without
515 case-folding, and the expansion is not capitalized/upcased.
516 - `:enable-function': a function of no argument which returns non-nil if the
517 abbrev should be used for a particular call of `expand-abbrev'.
519 An obsolete but still supported calling form is:
521 \(define-abbrev TABLE NAME EXPANSION &optional HOOK COUNT SYSTEM)."
522 (when (and (consp props) (or (null (car props)) (numberp (car props))))
523 ;; Old-style calling convention.
524 (setq props (list* :count (car props)
525 (if (cadr props) (list :system (cadr props))))))
526 (unless (plist-get props :count)
527 (setq props (plist-put props :count 0)))
528 (let ((system-flag (plist-get props :system))
529 (sym (intern name table)))
530 ;; Don't override a prior user-defined abbrev with a system abbrev,
531 ;; unless system-flag is `force'.
532 (unless (and (not (memq system-flag '(nil force)))
533 (boundp sym) (symbol-value sym)
534 (not (abbrev-get sym :system)))
535 (unless (or system-flag
536 (and (boundp sym) (fboundp sym)
537 ;; load-file-name
538 (equal (symbol-value sym) expansion)
539 (equal (symbol-function sym) hook)))
540 (setq abbrevs-changed t))
541 (set sym expansion)
542 (fset sym hook)
543 (setplist sym
544 ;; Don't store the `force' value of `system-flag' into
545 ;; the :system property.
546 (if (eq 'force system-flag) (plist-put props :system t) props))
547 (abbrev-table-put table :abbrev-table-modiff
548 (1+ (abbrev-table-get table :abbrev-table-modiff))))
549 name))
551 (defun abbrev--check-chars (abbrev global)
552 "Check if the characters in ABBREV have word syntax in either the
553 current (if global is nil) or standard syntax table."
554 (with-syntax-table
555 (cond ((null global) (standard-syntax-table))
556 ;; ((syntax-table-p global) global)
557 (t (syntax-table)))
558 (when (string-match "\\W" abbrev)
559 (let ((badchars ())
560 (pos 0))
561 (while (string-match "\\W" abbrev pos)
562 (pushnew (aref abbrev (match-beginning 0)) badchars)
563 (setq pos (1+ pos)))
564 (error "Some abbrev characters (%s) are not word constituents %s"
565 (apply 'string (nreverse badchars))
566 (if global "in the standard syntax" "in this mode"))))))
568 (defun define-global-abbrev (abbrev expansion)
569 "Define ABBREV as a global abbreviation for EXPANSION.
570 The characters in ABBREV must all be word constituents in the standard
571 syntax table."
572 (interactive "sDefine global abbrev: \nsExpansion for %s: ")
573 (abbrev--check-chars abbrev 'global)
574 (define-abbrev global-abbrev-table (downcase abbrev) expansion))
576 (defun define-mode-abbrev (abbrev expansion)
577 "Define ABBREV as a mode-specific abbreviation for EXPANSION.
578 The characters in ABBREV must all be word-constituents in the current mode."
579 (interactive "sDefine mode abbrev: \nsExpansion for %s: ")
580 (unless local-abbrev-table
581 (error "Major mode has no abbrev table"))
582 (abbrev--check-chars abbrev nil)
583 (define-abbrev local-abbrev-table (downcase abbrev) expansion))
585 (defun abbrev--active-tables (&optional tables)
586 "Return the list of abbrev tables currently active.
587 TABLES if non-nil overrides the usual rules. It can hold
588 either a single abbrev table or a list of abbrev tables."
589 ;; We could just remove the `tables' arg and let callers use
590 ;; (or table (abbrev--active-tables)) but then they'd have to be careful
591 ;; to treat the distinction between a single table and a list of tables.
592 (cond
593 ((consp tables) tables)
594 ((vectorp tables) (list tables))
596 (let ((tables (if (listp local-abbrev-table)
597 (append local-abbrev-table
598 (list global-abbrev-table))
599 (list local-abbrev-table global-abbrev-table))))
600 ;; Add the minor-mode abbrev tables.
601 (dolist (x abbrev-minor-mode-table-alist)
602 (when (and (symbolp (car x)) (boundp (car x)) (symbol-value (car x)))
603 (setq tables
604 (if (listp (cdr x))
605 (append (cdr x) tables) (cons (cdr x) tables)))))
606 tables))))
609 (defun abbrev-symbol (abbrev &optional table)
610 "Return the symbol representing abbrev named ABBREV.
611 This symbol's name is ABBREV, but it is not the canonical symbol of that name;
612 it is interned in an abbrev-table rather than the normal obarray.
613 The value is nil if that abbrev is not defined.
614 Optional second arg TABLE is abbrev table to look it up in.
615 The default is to try buffer's mode-specific abbrev table, then global table."
616 (let ((tables (abbrev--active-tables table))
617 sym)
618 (while (and tables (not (symbol-value sym)))
619 (let* ((table (pop tables))
620 (case-fold (not (abbrev-table-get table :case-fixed))))
621 (setq tables (append (abbrev-table-get table :parents) tables))
622 ;; In case the table doesn't set :case-fixed but some of the
623 ;; abbrevs do, we have to be careful.
624 (setq sym
625 ;; First try without case-folding.
626 (or (intern-soft abbrev table)
627 (when case-fold
628 ;; We didn't find any abbrev, try case-folding.
629 (let ((sym (intern-soft (downcase abbrev) table)))
630 ;; Only use it if it doesn't require :case-fixed.
631 (and sym (not (abbrev-get sym :case-fixed))
632 sym)))))))
633 (if (symbol-value sym)
634 sym)))
637 (defun abbrev-expansion (abbrev &optional table)
638 "Return the string that ABBREV expands into in the current buffer.
639 Optionally specify an abbrev table as second arg;
640 then ABBREV is looked up in that table only."
641 (symbol-value (abbrev-symbol abbrev table)))
644 (defun abbrev--before-point ()
645 "Try and find an abbrev before point. Return it if found, nil otherwise."
646 (unless (eq abbrev-start-location-buffer (current-buffer))
647 (setq abbrev-start-location nil))
649 (let ((tables (abbrev--active-tables))
650 (pos (point))
651 start end name res)
653 (if abbrev-start-location
654 (progn
655 (setq start abbrev-start-location)
656 (setq abbrev-start-location nil)
657 ;; Remove the hyphen inserted by `abbrev-prefix-mark'.
658 (if (and (< start (point-max))
659 (eq (char-after start) ?-))
660 (delete-region start (1+ start)))
661 (skip-syntax-backward " ")
662 (setq end (point))
663 (when (> end start)
664 (setq name (buffer-substring start end))
665 (goto-char pos) ; Restore point.
666 (list (abbrev-symbol name tables) name start end)))
668 (while (and tables (not (car res)))
669 (let* ((table (pop tables))
670 (enable-fun (abbrev-table-get table :enable-function)))
671 (setq tables (append (abbrev-table-get table :parents) tables))
672 (setq res
673 (and (or (not enable-fun) (funcall enable-fun))
674 (let ((re (abbrev-table-get table :regexp)))
675 (if (null re)
676 ;; We used to default `re' to "\\<\\(\\w+\\)\\W*"
677 ;; but when words-include-escapes is set, that
678 ;; is not right and fixing it is boring.
679 (let ((lim (point)))
680 (backward-word 1)
681 (setq start (point))
682 (forward-word 1)
683 (setq end (min (point) lim)))
684 (when (looking-back re (line-beginning-position))
685 (setq start (match-beginning 1))
686 (setq end (match-end 1)))))
687 (setq name (buffer-substring start end))
688 (let ((abbrev (abbrev-symbol name table)))
689 (when abbrev
690 (setq enable-fun (abbrev-get abbrev :enable-function))
691 (and (or (not enable-fun) (funcall enable-fun))
692 ;; This will also look it up in parent tables.
693 ;; This is not on purpose, but it seems harmless.
694 (list abbrev name start end))))))
695 ;; Restore point.
696 (goto-char pos)))
697 res)))
699 (defun abbrev-insert (abbrev &optional name wordstart wordend)
700 "Insert abbrev ABBREV at point.
701 If non-nil, NAME is the name by which this abbrev was found.
702 If non-nil, WORDSTART is the place where to insert the abbrev.
703 If WORDEND is non-nil, the abbrev replaces the previous text between
704 WORDSTART and WORDEND.
705 Return ABBREV if the expansion should be considered as having taken place."
706 (unless name (setq name (symbol-name abbrev)))
707 (unless wordstart (setq wordstart (point)))
708 (unless wordend (setq wordend wordstart))
709 ;; Increment use count.
710 (abbrev-put abbrev :count (1+ (abbrev-get abbrev :count)))
711 (let ((value abbrev))
712 ;; If this abbrev has an expansion, delete the abbrev
713 ;; and insert the expansion.
714 (when (stringp (symbol-value abbrev))
715 (goto-char wordstart)
716 ;; Insert at beginning so that markers at the end (e.g. point)
717 ;; are preserved.
718 (insert (symbol-value abbrev))
719 (delete-char (- wordend wordstart))
720 (let ((case-fold-search nil))
721 ;; If the abbrev's name is different from the buffer text (the
722 ;; only difference should be capitalization), then we may want
723 ;; to adjust the capitalization of the expansion.
724 (when (and (not (equal name (symbol-name abbrev)))
725 (string-match "[[:upper:]]" name))
726 (if (not (string-match "[[:lower:]]" name))
727 ;; Abbrev was all caps. If expansion is multiple words,
728 ;; normally capitalize each word.
729 (if (and (not abbrev-all-caps)
730 (save-excursion
731 (> (progn (backward-word 1) (point))
732 (progn (goto-char wordstart)
733 (forward-word 1) (point)))))
734 (upcase-initials-region wordstart (point))
735 (upcase-region wordstart (point)))
736 ;; Abbrev included some caps. Cap first initial of expansion.
737 (let ((end (point)))
738 ;; Find the initial.
739 (goto-char wordstart)
740 (skip-syntax-forward "^w" (1- end))
741 ;; Change just that.
742 (upcase-initials-region (point) (1+ (point)))
743 (goto-char end))))))
744 ;; Now point is at the end of the expansion and the beginning is
745 ;; in last-abbrev-location.
746 (when (symbol-function abbrev)
747 (let* ((hook (symbol-function abbrev))
748 (expanded
749 ;; If the abbrev has a hook function, run it.
750 (funcall hook)))
751 ;; In addition, if the hook function is a symbol with
752 ;; a non-nil `no-self-insert' property, let the value it
753 ;; returned specify whether we consider that an expansion took
754 ;; place. If it returns nil, no expansion has been done.
755 (if (and (symbolp hook)
756 (null expanded)
757 (get hook 'no-self-insert))
758 (setq value nil))))
759 value))
761 (defvar abbrev-expand-functions nil
762 "Wrapper hook around `expand-abbrev'.
763 The functions on this special hook are called with one argument:
764 a function that performs the abbrev expansion. It should return
765 the abbrev symbol if expansion took place.")
767 (defun expand-abbrev ()
768 "Expand the abbrev before point, if there is an abbrev there.
769 Effective when explicitly called even when `abbrev-mode' is nil.
770 Returns the abbrev symbol, if expansion took place."
771 (interactive)
772 (run-hooks 'pre-abbrev-expand-hook)
773 (with-wrapper-hook abbrev-expand-functions ()
774 (destructuring-bind (&optional sym name wordstart wordend)
775 (abbrev--before-point)
776 (when sym
777 (let ((value sym))
778 (unless (or ;; executing-kbd-macro
779 noninteractive
780 (window-minibuffer-p (selected-window)))
781 ;; Add an undo boundary, in case we are doing this for
782 ;; a self-inserting command which has avoided making one so far.
783 (undo-boundary))
784 ;; Now sym is the abbrev symbol.
785 (setq last-abbrev-text name)
786 (setq last-abbrev sym)
787 (setq last-abbrev-location wordstart)
788 ;; If this abbrev has an expansion, delete the abbrev
789 ;; and insert the expansion.
790 (abbrev-insert sym name wordstart wordend))))))
792 (defun unexpand-abbrev ()
793 "Undo the expansion of the last abbrev that expanded.
794 This differs from ordinary undo in that other editing done since then
795 is not undone."
796 (interactive)
797 (save-excursion
798 (unless (or (< last-abbrev-location (point-min))
799 (> last-abbrev-location (point-max)))
800 (goto-char last-abbrev-location)
801 (when (stringp last-abbrev-text)
802 ;; This isn't correct if last-abbrev's hook was used
803 ;; to do the expansion.
804 (let ((val (symbol-value last-abbrev)))
805 (unless (stringp val)
806 (error "Value of abbrev-symbol must be a string"))
807 ;; Don't inherit properties here; just copy from old contents.
808 (insert last-abbrev-text)
809 ;; Delete after inserting, to better preserve markers.
810 (delete-region (point) (+ (point) (length val)))
811 (setq last-abbrev-text nil))))))
813 (defun abbrev--write (sym)
814 "Write the abbrev in a `read'able form.
815 Only writes the non-system abbrevs.
816 Presumes that `standard-output' points to `current-buffer'."
817 (unless (or (null (symbol-value sym)) (abbrev-get sym :system))
818 (insert " (")
819 (prin1 (symbol-name sym))
820 (insert " ")
821 (prin1 (symbol-value sym))
822 (insert " ")
823 (prin1 (symbol-function sym))
824 (insert " ")
825 (prin1 (abbrev-get sym :count))
826 (insert ")\n")))
828 (defun abbrev--describe (sym)
829 (when (symbol-value sym)
830 (prin1 (symbol-name sym))
831 (if (null (abbrev-get sym :system))
832 (indent-to 15 1)
833 (insert " (sys)")
834 (indent-to 20 1))
835 (prin1 (abbrev-get sym :count))
836 (indent-to 20 1)
837 (prin1 (symbol-value sym))
838 (when (symbol-function sym)
839 (indent-to 45 1)
840 (prin1 (symbol-function sym)))
841 (terpri)))
843 (defun insert-abbrev-table-description (name &optional readable)
844 "Insert before point a full description of abbrev table named NAME.
845 NAME is a symbol whose value is an abbrev table.
846 If optional 2nd arg READABLE is non-nil, a human-readable description
847 is inserted. Otherwise the description is an expression,
848 a call to `define-abbrev-table', which would
849 define the abbrev table NAME exactly as it is currently defined.
851 Abbrevs marked as \"system abbrevs\" are omitted."
852 (let ((table (symbol-value name))
853 (symbols ()))
854 (mapatoms (lambda (sym) (if (symbol-value sym) (push sym symbols))) table)
855 (setq symbols (sort symbols 'string-lessp))
856 (let ((standard-output (current-buffer)))
857 (if readable
858 (progn
859 (insert "(")
860 (prin1 name)
861 (insert ")\n\n")
862 (mapc 'abbrev--describe symbols)
863 (insert "\n\n"))
864 (insert "(define-abbrev-table '")
865 (prin1 name)
866 (if (null symbols)
867 (insert " '())\n\n")
868 (insert "\n '(\n")
869 (mapc 'abbrev--write symbols)
870 (insert " ))\n\n")))
871 nil)))
873 (put 'define-abbrev-table 'doc-string-elt 3)
874 (defun define-abbrev-table (tablename definitions
875 &optional docstring &rest props)
876 "Define TABLENAME (a symbol) as an abbrev table name.
877 Define abbrevs in it according to DEFINITIONS, which is a list of elements
878 of the form (ABBREVNAME EXPANSION ...) that are passed to `define-abbrev'.
879 PROPS is a property list to apply to the table.
880 Properties with special meaning:
881 - `:parents' contains a list of abbrev tables from which this table inherits
882 abbreviations.
883 - `:case-fixed' non-nil means that abbreviations are looked up without
884 case-folding, and the expansion is not capitalized/upcased.
885 - `:regexp' describes the form of abbrevs. It defaults to \\=\\<\\(\\w+\\)\\W* which
886 means that an abbrev can only be a single word. The submatch 1 is treated
887 as the potential name of an abbrev.
888 - `:enable-function' can be set to a function of no argument which returns
889 non-nil if and only if the abbrevs in this table should be used for this
890 instance of `expand-abbrev'."
891 ;; We used to manually add the docstring, but we also want to record this
892 ;; location as the definition of the variable (in load-history), so we may
893 ;; as well just use `defvar'.
894 (eval `(defvar ,tablename nil ,@(if (stringp docstring) (list docstring))))
895 (let ((table (if (boundp tablename) (symbol-value tablename))))
896 (unless table
897 (setq table (make-abbrev-table))
898 (set tablename table)
899 (push tablename abbrev-table-name-list))
900 ;; We used to just pass them to `make-abbrev-table', but that fails
901 ;; if the table was pre-existing as is the case if it was created by
902 ;; loading the user's abbrev file.
903 (while (consp props)
904 (abbrev-table-put table (pop props) (pop props)))
905 (dolist (elt definitions)
906 (apply 'define-abbrev table elt))))
908 (defun abbrev-table-menu (table &optional prompt sortfun)
909 "Return a menu that shows all abbrevs in TABLE.
910 Selecting an entry runs `abbrev-insert'.
911 PROMPT is the prompt to use for the keymap.
912 SORTFUN is passed to `sort' to change the default ordering."
913 (unless sortfun (setq sortfun 'string-lessp))
914 (let ((entries ()))
915 (mapatoms (lambda (abbrev)
916 (when (symbol-value abbrev)
917 (let ((name (symbol-name abbrev)))
918 (push `(,(intern name) menu-item ,name
919 (lambda () (interactive)
920 (abbrev-insert ',abbrev)))
921 entries))))
922 table)
923 (nconc (make-sparse-keymap prompt)
924 (sort entries (lambda (x y)
925 (funcall sortfun (nth 2 x) (nth 2 y)))))))
927 (provide 'abbrev)
929 ;; arch-tag: dbd6f3ae-dfe3-40ba-b00f-f9e3ff960df5
930 ;;; abbrev.el ends here