Mercurial > emacs
annotate lisp/abbrev.el @ 19897:d9bb216aa23f
(strokes-click-command): Doc fix.
author | Richard M. Stallman <rms@gnu.org> |
---|---|
date | Fri, 12 Sep 1997 22:41:34 +0000 |
parents | 5745bc43cfe9 |
children | a77d473867b8 |
rev | line source |
---|---|
662
8a533acedb77
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
411
diff
changeset
|
1 ;;; abbrev.el --- abbrev mode commands for Emacs |
411 | 2 |
846
20674ae6bf52
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
807
diff
changeset
|
3 ;; Copyright (C) 1985, 1986, 1987, 1992 Free Software Foundation, Inc. |
20674ae6bf52
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
807
diff
changeset
|
4 |
2247
2c7997f249eb
Add or correct keywords
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
1329
diff
changeset
|
5 ;; Keywords: abbrev |
2c7997f249eb
Add or correct keywords
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
1329
diff
changeset
|
6 |
411 | 7 ;; This file is part of GNU Emacs. |
8 | |
9 ;; GNU Emacs is free software; you can redistribute it and/or modify | |
10 ;; it under the terms of the GNU General Public License as published by | |
807
4f28bd14272c
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
732
diff
changeset
|
11 ;; the Free Software Foundation; either version 2, or (at your option) |
411 | 12 ;; any later version. |
13 | |
14 ;; GNU Emacs is distributed in the hope that it will be useful, | |
15 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of | |
16 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
17 ;; GNU General Public License for more details. | |
18 | |
19 ;; You should have received a copy of the GNU General Public License | |
14169 | 20 ;; along with GNU Emacs; see the file COPYING. If not, write to the |
21 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330, | |
22 ;; Boston, MA 02111-1307, USA. | |
411 | 23 |
2307
10e417efb12a
Added or corrected Commentary sections
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
2247
diff
changeset
|
24 ;;; Commentary: |
10e417efb12a
Added or corrected Commentary sections
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
2247
diff
changeset
|
25 |
10e417efb12a
Added or corrected Commentary sections
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
2247
diff
changeset
|
26 ;; This facility is documented in the Emacs Manual. |
10e417efb12a
Added or corrected Commentary sections
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
2247
diff
changeset
|
27 |
807
4f28bd14272c
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
732
diff
changeset
|
28 ;;; Code: |
411 | 29 |
19307 | 30 (defcustom only-global-abbrevs nil |
31 "*t means user plans to use global abbrevs only. | |
32 This makes the commands that normally define mode-specific abbrevs | |
33 define global abbrevs instead." | |
34 :type 'boolean | |
35 :group 'abbrev-mode) | |
411 | 36 |
37 (defun abbrev-mode (arg) | |
38 "Toggle abbrev mode. | |
1329 | 39 With argument ARG, turn abbrev mode on iff ARG is positive. |
411 | 40 In abbrev mode, inserting an abbreviation causes it to expand |
41 and be replaced by its expansion." | |
42 (interactive "P") | |
43 (setq abbrev-mode | |
44 (if (null arg) (not abbrev-mode) | |
45 (> (prefix-numeric-value arg) 0))) | |
11558
03792bb111ab
(abbrev-mode): Use force-mode-line-update.
Karl Heuer <kwzh@gnu.org>
parents:
9180
diff
changeset
|
46 (force-mode-line-update)) |
19307 | 47 |
48 (defcustom abbrev-mode nil | |
49 "Toggle abbrev mode. | |
50 In abbrev mode, inserting an abbreviation causes it to expand | |
51 and be replaced by its expansion. | |
52 You must modify via \\[customize] for this variable to have an effect." | |
53 :set (lambda (symbol value) | |
54 (abbrev-mode (if value 1 0))) | |
55 :type 'boolean | |
56 :group 'abbrev-mode) | |
57 | |
411 | 58 |
59 (defvar edit-abbrevs-map nil | |
60 "Keymap used in edit-abbrevs.") | |
61 (if edit-abbrevs-map | |
62 nil | |
63 (setq edit-abbrevs-map (make-sparse-keymap)) | |
64 (define-key edit-abbrevs-map "\C-x\C-s" 'edit-abbrevs-redefine) | |
65 (define-key edit-abbrevs-map "\C-c\C-c" 'edit-abbrevs-redefine)) | |
66 | |
67 (defun kill-all-abbrevs () | |
68 "Undefine all defined abbrevs." | |
69 (interactive) | |
70 (let ((tables abbrev-table-name-list)) | |
71 (while tables | |
72 (clear-abbrev-table (symbol-value (car tables))) | |
73 (setq tables (cdr tables))))) | |
74 | |
75 (defun insert-abbrevs () | |
76 "Insert after point a description of all defined abbrevs. | |
77 Mark is set after the inserted text." | |
78 (interactive) | |
79 (push-mark | |
80 (save-excursion | |
81 (let ((tables abbrev-table-name-list)) | |
82 (while tables | |
83 (insert-abbrev-table-description (car tables) t) | |
84 (setq tables (cdr tables)))) | |
85 (point)))) | |
86 | |
87 (defun list-abbrevs () | |
88 "Display a list of all defined abbrevs." | |
89 (interactive) | |
90 (display-buffer (prepare-abbrev-list-buffer))) | |
91 | |
92 (defun prepare-abbrev-list-buffer () | |
93 (save-excursion | |
94 (set-buffer (get-buffer-create "*Abbrevs*")) | |
95 (erase-buffer) | |
96 (let ((tables abbrev-table-name-list)) | |
97 (while tables | |
98 (insert-abbrev-table-description (car tables) t) | |
99 (setq tables (cdr tables)))) | |
100 (goto-char (point-min)) | |
101 (set-buffer-modified-p nil) | |
102 (edit-abbrevs-mode)) | |
103 (get-buffer-create "*Abbrevs*")) | |
104 | |
105 (defun edit-abbrevs-mode () | |
106 "Major mode for editing the list of abbrev definitions. | |
107 \\{edit-abbrevs-map}" | |
108 (interactive) | |
109 (setq major-mode 'edit-abbrevs-mode) | |
110 (setq mode-name "Edit-Abbrevs") | |
111 (use-local-map edit-abbrevs-map)) | |
112 | |
113 (defun edit-abbrevs () | |
114 "Alter abbrev definitions by editing a list of them. | |
115 Selects a buffer containing a list of abbrev definitions. | |
116 You can edit them and type \\<edit-abbrevs-map>\\[edit-abbrevs-redefine] to redefine abbrevs | |
117 according to your editing. | |
118 Buffer contains a header line for each abbrev table, | |
119 which is the abbrev table name in parentheses. | |
120 This is followed by one line per abbrev in that table: | |
121 NAME USECOUNT EXPANSION HOOK | |
122 where NAME and EXPANSION are strings with quotes, | |
123 USECOUNT is an integer, and HOOK is any valid function | |
124 or may be omitted (it is usually omitted)." | |
125 (interactive) | |
126 (switch-to-buffer (prepare-abbrev-list-buffer))) | |
127 | |
128 (defun edit-abbrevs-redefine () | |
129 "Redefine abbrevs according to current buffer contents." | |
130 (interactive) | |
131 (define-abbrevs t) | |
132 (set-buffer-modified-p nil)) | |
133 | |
134 (defun define-abbrevs (&optional arg) | |
135 "Define abbrevs according to current visible buffer contents. | |
136 See documentation of `edit-abbrevs' for info on the format of the | |
137 text you must have in the buffer. | |
138 With argument, eliminate all abbrev definitions except | |
139 the ones defined from the buffer now." | |
140 (interactive "P") | |
141 (if arg (kill-all-abbrevs)) | |
142 (save-excursion | |
143 (goto-char (point-min)) | |
144 (while (and (not (eobp)) (re-search-forward "^(" nil t)) | |
145 (let* ((buf (current-buffer)) | |
146 (table (read buf)) | |
862
46630543d659
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
846
diff
changeset
|
147 abbrevs name hook exp count) |
411 | 148 (forward-line 1) |
149 (while (progn (forward-line 1) | |
150 (not (eolp))) | |
151 (setq name (read buf) count (read buf) exp (read buf)) | |
152 (skip-chars-backward " \t\n\f") | |
153 (setq hook (if (not (eolp)) (read buf))) | |
154 (skip-chars-backward " \t\n\f") | |
155 (setq abbrevs (cons (list name exp hook count) abbrevs))) | |
156 (define-abbrev-table table abbrevs))))) | |
157 | |
158 (defun read-abbrev-file (&optional file quietly) | |
159 "Read abbrev definitions from file written with `write-abbrev-file'. | |
160 Optional argument FILE is the name of the file to read; | |
161 it defaults to the value of `abbrev-file-name'. | |
162 Optional second argument QUIETLY non-nil means don't print anything." | |
163 (interactive "fRead abbrev file: ") | |
164 (load (if (and file (> (length file) 0)) file abbrev-file-name) | |
165 nil quietly) | |
166 (setq save-abbrevs t abbrevs-changed nil)) | |
167 | |
168 (defun quietly-read-abbrev-file (&optional file) | |
169 "Read abbrev definitions from file written with write-abbrev-file. | |
170 Optional argument FILE is the name of the file to read; | |
171 it defaults to the value of `abbrev-file-name'. | |
172 Does not print anything." | |
173 ;(interactive "fRead abbrev file: ") | |
174 (read-abbrev-file file t)) | |
175 | |
176 (defun write-abbrev-file (file) | |
807
4f28bd14272c
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
732
diff
changeset
|
177 "Write all abbrev definitions to a file of Lisp code. |
411 | 178 The file written can be loaded in another session to define the same abbrevs. |
179 The argument FILE is the file name to write." | |
180 (interactive | |
181 (list | |
182 (read-file-name "Write abbrev file: " | |
183 (file-name-directory (expand-file-name abbrev-file-name)) | |
184 abbrev-file-name))) | |
185 (or (and file (> (length file) 0)) | |
186 (setq file abbrev-file-name)) | |
187 (save-excursion | |
188 (set-buffer (get-buffer-create " write-abbrev-file")) | |
189 (erase-buffer) | |
190 (let ((tables abbrev-table-name-list)) | |
191 (while tables | |
192 (insert-abbrev-table-description (car tables) nil) | |
193 (setq tables (cdr tables)))) | |
194 (write-region 1 (point-max) file) | |
195 (erase-buffer))) | |
196 | |
197 (defun add-mode-abbrev (arg) | |
198 "Define mode-specific abbrev for last word(s) before point. | |
199 Argument is how many words before point form the expansion; | |
200 or zero means the region is the expansion. | |
201 A negative argument means to undefine the specified abbrev. | |
202 Reads the abbreviation in the minibuffer. | |
203 | |
204 Don't use this function in a Lisp program; use `define-abbrev' instead." | |
205 (interactive "p") | |
206 (add-abbrev | |
207 (if only-global-abbrevs | |
208 global-abbrev-table | |
209 (or local-abbrev-table | |
210 (error "No per-mode abbrev table"))) | |
211 "Mode" arg)) | |
212 | |
213 (defun add-global-abbrev (arg) | |
214 "Define global (all modes) abbrev for last word(s) before point. | |
215 The prefix argument specifies the number of words before point that form the | |
216 expansion; or zero means the region is the expansion. | |
217 A negative argument means to undefine the specified abbrev. | |
218 This command uses the minibuffer to read the abbreviation. | |
219 | |
220 Don't use this function in a Lisp program; use `define-abbrev' instead." | |
221 (interactive "p") | |
222 (add-abbrev global-abbrev-table "Global" arg)) | |
223 | |
224 (defun add-abbrev (table type arg) | |
225 (let ((exp (and (>= arg 0) | |
226 (buffer-substring | |
227 (point) | |
228 (if (= arg 0) (mark) | |
229 (save-excursion (forward-word (- arg)) (point)))))) | |
230 name) | |
231 (setq name | |
232 (read-string (format (if exp "%s abbrev for \"%s\": " | |
233 "Undefine %s abbrev: ") | |
234 type exp))) | |
9180
569ed1f55710
(add-abbrev, inverse-add-abbrev):
Richard M. Stallman <rms@gnu.org>
parents:
2307
diff
changeset
|
235 (set-text-properties 0 (length name) nil name) |
411 | 236 (if (or (null exp) |
237 (not (abbrev-expansion name table)) | |
238 (y-or-n-p (format "%s expands to \"%s\"; redefine? " | |
239 name (abbrev-expansion name table)))) | |
240 (define-abbrev table (downcase name) exp)))) | |
241 | |
242 (defun inverse-add-mode-abbrev (arg) | |
243 "Define last word before point as a mode-specific abbrev. | |
244 With prefix argument N, defines the Nth word before point. | |
245 This command uses the minibuffer to read the expansion. | |
246 Expands the abbreviation after defining it." | |
247 (interactive "p") | |
248 (inverse-add-abbrev | |
249 (if only-global-abbrevs | |
250 global-abbrev-table | |
251 (or local-abbrev-table | |
252 (error "No per-mode abbrev table"))) | |
253 "Mode" arg)) | |
254 | |
255 (defun inverse-add-global-abbrev (arg) | |
256 "Define last word before point as a global (mode-independent) abbrev. | |
257 With prefix argument N, defines the Nth word before point. | |
258 This command uses the minibuffer to read the expansion. | |
259 Expands the abbreviation after defining it." | |
260 (interactive "p") | |
261 (inverse-add-abbrev global-abbrev-table "Global" arg)) | |
262 | |
263 (defun inverse-add-abbrev (table type arg) | |
264 (let (name nameloc exp) | |
265 (save-excursion | |
266 (forward-word (- arg)) | |
267 (setq name (buffer-substring (point) (progn (forward-word 1) | |
268 (setq nameloc (point)))))) | |
9180
569ed1f55710
(add-abbrev, inverse-add-abbrev):
Richard M. Stallman <rms@gnu.org>
parents:
2307
diff
changeset
|
269 (set-text-properties 0 (length name) nil name) |
411 | 270 (setq exp (read-string (format "%s expansion for \"%s\": " |
271 type name))) | |
272 (if (or (not (abbrev-expansion name table)) | |
273 (y-or-n-p (format "%s expands to \"%s\"; redefine? " | |
274 name (abbrev-expansion name table)))) | |
275 (progn | |
276 (define-abbrev table (downcase name) exp) | |
277 (save-excursion | |
278 (goto-char nameloc) | |
279 (expand-abbrev)))))) | |
280 | |
281 (defun abbrev-prefix-mark (&optional arg) | |
282 "Mark current point as the beginning of an abbrev. | |
283 Abbrev to be expanded starts here rather than at beginning of word. | |
284 This way, you can expand an abbrev with a prefix: insert the prefix, | |
285 use this command, then insert the abbrev." | |
286 (interactive "P") | |
287 (or arg (expand-abbrev)) | |
288 (setq abbrev-start-location (point-marker) | |
289 abbrev-start-location-buffer (current-buffer)) | |
290 (insert "-")) | |
291 | |
292 (defun expand-region-abbrevs (start end &optional noquery) | |
293 "For abbrev occurrence in the region, offer to expand it. | |
294 The user is asked to type y or n for each occurrence. | |
295 A prefix argument means don't query; expand all abbrevs. | |
296 If called from a Lisp program, arguments are START END &optional NOQUERY." | |
297 (interactive "r\nP") | |
298 (save-excursion | |
299 (goto-char start) | |
300 (let ((lim (- (point-max) end)) | |
301 pnt string) | |
302 (while (and (not (eobp)) | |
303 (progn (forward-word 1) | |
304 (<= (setq pnt (point)) (- (point-max) lim)))) | |
305 (if (abbrev-expansion | |
306 (setq string | |
307 (buffer-substring | |
308 (save-excursion (forward-word -1) (point)) | |
309 pnt))) | |
310 (if (or noquery (y-or-n-p (format "Expand `%s'? " string))) | |
311 (expand-abbrev))))))) | |
662
8a533acedb77
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
411
diff
changeset
|
312 |
8a533acedb77
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
411
diff
changeset
|
313 ;;; abbrev.el ends here |