abbrev.el 12.6 KB
Newer Older
Eric S. Raymond's avatar
Eric S. Raymond committed
1
;;; abbrev.el --- abbrev mode commands for Emacs
Jim Blandy's avatar
Jim Blandy committed
2

Eric S. Raymond's avatar
Eric S. Raymond committed
3
;; Copyright (C) 1985, 1986, 1987, 1992 Free Software Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
4

5
;; Maintainer: FSF
Dan Nicolaescu's avatar
Dan Nicolaescu committed
6
;; Keywords: abbrev convenience
Eric S. Raymond's avatar
Eric S. Raymond committed
7

Jim Blandy's avatar
Jim Blandy committed
8 9 10 11
;; This file is part of GNU Emacs.

;; 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
Eric S. Raymond's avatar
Eric S. Raymond committed
12
;; the Free Software Foundation; either version 2, or (at your option)
Jim Blandy's avatar
Jim Blandy committed
13 14 15 16 17 18 19 20
;; 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
21 22 23
;; 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.
Jim Blandy's avatar
Jim Blandy committed
24

25 26 27 28
;;; Commentary:

;; This facility is documented in the Emacs Manual.

Eric S. Raymond's avatar
Eric S. Raymond committed
29
;;; Code:
Jim Blandy's avatar
Jim Blandy committed
30

Pavel Janík's avatar
Pavel Janík committed
31
(defcustom only-global-abbrevs nil
32
  "Non-nil means user plans to use global abbrevs only.
Richard M. Stallman's avatar
Richard M. Stallman committed
33 34 35
This makes the commands that normally define mode-specific abbrevs
define global abbrevs instead."
  :type 'boolean
Dan Nicolaescu's avatar
Dan Nicolaescu committed
36 37
  :group 'abbrev-mode
  :group 'convenience)
Jim Blandy's avatar
Jim Blandy committed
38

39
(defun abbrev-mode (&optional arg)
40
  "Toggle Abbrev mode in the current buffer.
Richard M. Stallman's avatar
Richard M. Stallman committed
41
With argument ARG, turn abbrev mode on iff ARG is positive.
42
In Abbrev mode, inserting an abbreviation causes it to expand
Jim Blandy's avatar
Jim Blandy committed
43 44 45 46 47
and be replaced by its expansion."
  (interactive "P")
  (setq abbrev-mode
	(if (null arg) (not abbrev-mode)
	  (> (prefix-numeric-value arg) 0)))
48
  (force-mode-line-update))
Richard M. Stallman's avatar
Richard M. Stallman committed
49 50

(defcustom abbrev-mode nil
51
  "Enable or disable Abbrev mode.
52 53
Non-nil means automatically expand abbrevs as they are inserted.

54
Setting this variable with `setq' changes it for the current buffer.
55
Changing it with \\[customize] sets the default value.
56 57
Interactively, use the command `abbrev-mode'
to enable or disable Abbrev mode in the current buffer."
Richard M. Stallman's avatar
Richard M. Stallman committed
58 59 60
  :type 'boolean
  :group 'abbrev-mode)

Jim Blandy's avatar
Jim Blandy committed
61

62 63 64 65 66
(defvar edit-abbrevs-map
  (let ((map (make-sparse-keymap)))
    (define-key map "\C-x\C-s" 'edit-abbrevs-redefine)
    (define-key map "\C-c\C-c" 'edit-abbrevs-redefine)
    map)
67
  "Keymap used in `edit-abbrevs'.")
Jim Blandy's avatar
Jim Blandy committed
68 69 70 71 72 73 74 75 76

(defun kill-all-abbrevs ()
  "Undefine all defined abbrevs."
  (interactive)
  (let ((tables abbrev-table-name-list))
    (while tables
      (clear-abbrev-table (symbol-value (car tables)))
      (setq tables (cdr tables)))))

77 78 79 80 81 82 83 84 85 86 87 88
(defun copy-abbrev-table (table)
  "Make a new abbrev-table with the same abbrevs as TABLE."
  (let ((new-table (make-abbrev-table)))
    (mapatoms
     (lambda (symbol)
       (define-abbrev new-table
	 (symbol-name symbol)
	 (symbol-value symbol)
	 (symbol-function symbol)))
     table)
    new-table))

Jim Blandy's avatar
Jim Blandy committed
89 90 91 92 93 94
(defun insert-abbrevs ()
  "Insert after point a description of all defined abbrevs.
Mark is set after the inserted text."
  (interactive)
  (push-mark
   (save-excursion
95 96 97 98 99
     (let ((tables abbrev-table-name-list))
       (while tables
	 (insert-abbrev-table-description (car tables) t)
	 (setq tables (cdr tables))))
     (point))))
Jim Blandy's avatar
Jim Blandy committed
100

101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117
(defun list-abbrevs (&optional local)
  "Display a list of defined abbrevs.
If LOCAL is non-nil, interactively when invoked with a
prefix arg, display only local, i.e. mode-specific, abbrevs.
Otherwise display all abbrevs."
  (interactive "P")
  (display-buffer (prepare-abbrev-list-buffer local)))

(defun abbrev-table-name (table)
  "Value is the name of abbrev table TABLE."
  (let ((tables abbrev-table-name-list)
	found)
    (while (and (not found) tables)
      (when (eq (symbol-value (car tables)) table)
	(setq found (car tables)))
      (setq tables (cdr tables)))
    found))
Pavel Janík's avatar
Pavel Janík committed
118

119
(defun prepare-abbrev-list-buffer (&optional local)
Jim Blandy's avatar
Jim Blandy committed
120
  (save-excursion
121 122 123 124 125 126 127 128 129 130 131
    (let ((table local-abbrev-table))
      (set-buffer (get-buffer-create "*Abbrevs*"))
      (erase-buffer)
      (if local
	  (insert-abbrev-table-description (abbrev-table-name table) t)
	(dolist (table abbrev-table-name-list)
	  (insert-abbrev-table-description table t)))
      (goto-char (point-min))
      (set-buffer-modified-p nil)
      (edit-abbrevs-mode)
      (current-buffer))))
Jim Blandy's avatar
Jim Blandy committed
132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170

(defun edit-abbrevs-mode ()
  "Major mode for editing the list of abbrev definitions.
\\{edit-abbrevs-map}"
  (interactive)
  (setq major-mode 'edit-abbrevs-mode)
  (setq mode-name "Edit-Abbrevs")
  (use-local-map edit-abbrevs-map))

(defun edit-abbrevs ()
  "Alter abbrev definitions by editing a list of them.
Selects a buffer containing a list of abbrev definitions.
You can edit them and type \\<edit-abbrevs-map>\\[edit-abbrevs-redefine] to redefine abbrevs
according to your editing.
Buffer contains a header line for each abbrev table,
 which is the abbrev table name in parentheses.
This is followed by one line per abbrev in that table:
NAME   USECOUNT   EXPANSION   HOOK
where NAME and EXPANSION are strings with quotes,
USECOUNT is an integer, and HOOK is any valid function
or may be omitted (it is usually omitted)."
  (interactive)
  (switch-to-buffer (prepare-abbrev-list-buffer)))

(defun edit-abbrevs-redefine ()
  "Redefine abbrevs according to current buffer contents."
  (interactive)
  (define-abbrevs t)
  (set-buffer-modified-p nil))

(defun define-abbrevs (&optional arg)
  "Define abbrevs according to current visible buffer contents.
See documentation of `edit-abbrevs' for info on the format of the
text you must have in the buffer.
With argument, eliminate all abbrev definitions except
the ones defined from the buffer now."
  (interactive "P")
  (if arg (kill-all-abbrevs))
  (save-excursion
171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187
    (goto-char (point-min))
    (while (and (not (eobp)) (re-search-forward "^(" nil t))
      (let* ((buf (current-buffer))
	     (table (read buf))
	     abbrevs name hook exp count sys)
	(forward-line 1)
	(while (progn (forward-line 1)
		      (not (eolp)))
	  (setq name (read buf) count (read buf))
	  (if (equal count '(sys))
	      (setq sys t count (read buf)))
	  (setq exp (read buf))
	  (skip-chars-backward " \t\n\f")
	  (setq hook (if (not (eolp)) (read buf)))
	  (skip-chars-backward " \t\n\f")
	  (setq abbrevs (cons (list name exp hook count sys) abbrevs)))
	(define-abbrev-table table abbrevs)))))
Jim Blandy's avatar
Jim Blandy committed
188 189 190 191 192

(defun read-abbrev-file (&optional file quietly)
  "Read abbrev definitions from file written with `write-abbrev-file'.
Optional argument FILE is the name of the file to read;
it defaults to the value of `abbrev-file-name'.
193
Optional second argument QUIETLY non-nil means don't display a message."
Jim Blandy's avatar
Jim Blandy committed
194 195 196
  (interactive "fRead abbrev file: ")
  (load (if (and file (> (length file) 0)) file abbrev-file-name)
	nil quietly)
197
  (setq abbrevs-changed nil))
Jim Blandy's avatar
Jim Blandy committed
198 199

(defun quietly-read-abbrev-file (&optional file)
200
  "Read abbrev definitions from file written with `write-abbrev-file'.
Jim Blandy's avatar
Jim Blandy committed
201 202
Optional argument FILE is the name of the file to read;
it defaults to the value of `abbrev-file-name'.
203
Does not display any message."
204
					;(interactive "fRead abbrev file: ")
Jim Blandy's avatar
Jim Blandy committed
205 206
  (read-abbrev-file file t))

207 208 209 210
(defun write-abbrev-file (&optional file)
  "Write all user-level abbrev definitions to a file of Lisp code.
This does not include system abbrevs; it includes only the abbrev tables
listed in listed in `abbrev-table-name-list'.
Jim Blandy's avatar
Jim Blandy committed
211
The file written can be loaded in another session to define the same abbrevs.
212 213
The argument FILE is the file name to write.  If omitted or nil, the file
specified in `abbrev-file-name' is used."
Jim Blandy's avatar
Jim Blandy committed
214 215 216 217 218 219 220
  (interactive
   (list
    (read-file-name "Write abbrev file: "
		    (file-name-directory (expand-file-name abbrev-file-name))
		    abbrev-file-name)))
  (or (and file (> (length file) 0))
      (setq file abbrev-file-name))
221 222 223
  (let ((coding-system-for-write 'emacs-mule))
    (with-temp-file file
      (insert ";;-*-coding: emacs-mule;-*-\n")
224 225 226 227 228 229 230 231 232 233 234
      (dolist (table
               ;; We sort the table in order to ease the automatic
               ;; merging of different versions of the user's abbrevs
               ;; file.  This is useful, for example, for when the
               ;; user keeps their home directory in a revision
               ;; control system, and is therefore keeping multiple
               ;; slightly-differing copies loosely synchronized.
               (sort (copy-sequence abbrev-table-name-list)
                     (lambda (s1 s2)
                       (string< (symbol-name s1)
                                (symbol-name s2)))))
235
	(insert-abbrev-table-description table nil)))))
Jim Blandy's avatar
Jim Blandy committed
236 237 238 239 240 241 242 243 244 245 246 247

(defun add-mode-abbrev (arg)
  "Define mode-specific abbrev for last word(s) before point.
Argument is how many words before point form the expansion;
or zero means the region is the expansion.
A negative argument means to undefine the specified abbrev.
Reads the abbreviation in the minibuffer.

Don't use this function in a Lisp program; use `define-abbrev' instead."
  (interactive "p")
  (add-abbrev
   (if only-global-abbrevs
248
       global-abbrev-table
Jim Blandy's avatar
Jim Blandy committed
249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265
     (or local-abbrev-table
	 (error "No per-mode abbrev table")))
   "Mode" arg))

(defun add-global-abbrev (arg)
  "Define global (all modes) abbrev for last word(s) before point.
The prefix argument specifies the number of words before point that form the
expansion; or zero means the region is the expansion.
A negative argument means to undefine the specified abbrev.
This command uses the minibuffer to read the abbreviation.

Don't use this function in a Lisp program; use `define-abbrev' instead."
  (interactive "p")
  (add-abbrev global-abbrev-table "Global" arg))

(defun add-abbrev (table type arg)
  (let ((exp (and (>= arg 0)
266
		  (buffer-substring-no-properties
Jim Blandy's avatar
Jim Blandy committed
267 268 269 270 271 272 273 274
		   (point)
		   (if (= arg 0) (mark)
		     (save-excursion (forward-word (- arg)) (point))))))
	name)
    (setq name
	  (read-string (format (if exp "%s abbrev for \"%s\": "
				 "Undefine %s abbrev: ")
			       type exp)))
275
    (set-text-properties 0 (length name) nil name)
Jim Blandy's avatar
Jim Blandy committed
276 277 278 279 280
    (if (or (null exp)
	    (not (abbrev-expansion name table))
	    (y-or-n-p (format "%s expands to \"%s\"; redefine? "
			      name (abbrev-expansion name table))))
	(define-abbrev table (downcase name) exp))))
Pavel Janík's avatar
Pavel Janík committed
281

Jim Blandy's avatar
Jim Blandy committed
282 283 284 285 286 287 288 289
(defun inverse-add-mode-abbrev (arg)
  "Define last word before point as a mode-specific abbrev.
With prefix argument N, defines the Nth word before point.
This command uses the minibuffer to read the expansion.
Expands the abbreviation after defining it."
  (interactive "p")
  (inverse-add-abbrev
   (if only-global-abbrevs
Pavel Janík's avatar
Pavel Janík committed
290
       global-abbrev-table
Jim Blandy's avatar
Jim Blandy committed
291 292 293 294 295 296 297 298 299 300 301 302 303
     (or local-abbrev-table
	 (error "No per-mode abbrev table")))
   "Mode" arg))

(defun inverse-add-global-abbrev (arg)
  "Define last word before point as a global (mode-independent) abbrev.
With prefix argument N, defines the Nth word before point.
This command uses the minibuffer to read the expansion.
Expands the abbreviation after defining it."
  (interactive "p")
  (inverse-add-abbrev global-abbrev-table "Global" arg))

(defun inverse-add-abbrev (table type arg)
304
  (let (name exp start end)
Jim Blandy's avatar
Jim Blandy committed
305
    (save-excursion
306 307 308 309 310 311 312 313 314 315 316 317 318 319 320
      (forward-word (1+ (- arg)))
      (setq end (point))
      (backward-word 1)
      (setq start (point)
	    name (buffer-substring-no-properties start end)))

    (setq exp (read-string (format "%s expansion for \"%s\": " type name)
			   nil nil nil t))
    (when (or (not (abbrev-expansion name table))
	      (y-or-n-p (format "%s expands to \"%s\"; redefine? "
				name (abbrev-expansion name table))))
      (define-abbrev table (downcase name) exp)
      (save-excursion
	(goto-char end)
	(expand-abbrev)))))
Jim Blandy's avatar
Jim Blandy committed
321 322 323 324 325

(defun abbrev-prefix-mark (&optional arg)
  "Mark current point as the beginning of an abbrev.
Abbrev to be expanded starts here rather than at beginning of word.
This way, you can expand an abbrev with a prefix: insert the prefix,
326 327 328 329 330
use this command, then insert the abbrev.  This command inserts a
temporary hyphen after the prefix \(until the intended abbrev
expansion occurs).
If the prefix is itself an abbrev, this command expands it, unless
ARG is non-nil.  Interactively, ARG is the prefix argument."
Jim Blandy's avatar
Jim Blandy committed
331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351
  (interactive "P")
  (or arg (expand-abbrev))
  (setq abbrev-start-location (point-marker)
	abbrev-start-location-buffer (current-buffer))
  (insert "-"))

(defun expand-region-abbrevs (start end &optional noquery)
  "For abbrev occurrence in the region, offer to expand it.
The user is asked to type y or n for each occurrence.
A prefix argument means don't query; expand all abbrevs.
If called from a Lisp program, arguments are START END &optional NOQUERY."
  (interactive "r\nP")
  (save-excursion
    (goto-char start)
    (let ((lim (- (point-max) end))
	  pnt string)
      (while (and (not (eobp))
		  (progn (forward-word 1)
			 (<= (setq pnt (point)) (- (point-max) lim))))
	(if (abbrev-expansion
	     (setq string
352
		   (buffer-substring-no-properties
Jim Blandy's avatar
Jim Blandy committed
353 354 355 356
		    (save-excursion (forward-word -1) (point))
		    pnt)))
	    (if (or noquery (y-or-n-p (format "Expand `%s'? " string)))
		(expand-abbrev)))))))
Eric S. Raymond's avatar
Eric S. Raymond committed
357

Miles Bader's avatar
Miles Bader committed
358
;;; arch-tag: dbd6f3ae-dfe3-40ba-b00f-f9e3ff960df5
Eric S. Raymond's avatar
Eric S. Raymond committed
359
;;; abbrev.el ends here