|
428
|
1 /* Primitives for word-abbrev mode.
|
|
|
2 Copyright (C) 1985, 1986, 1992, 1993 Free Software Foundation, Inc.
|
|
793
|
3 Copyright (C) 2002 Ben Wing.
|
|
428
|
4
|
|
|
5 This file is part of XEmacs.
|
|
|
6
|
|
|
7 XEmacs is free software; you can redistribute it and/or modify it
|
|
|
8 under the terms of the GNU General Public License as published by the
|
|
|
9 Free Software Foundation; either version 2, or (at your option) any
|
|
|
10 later version.
|
|
|
11
|
|
|
12 XEmacs is distributed in the hope that it will be useful, but WITHOUT
|
|
|
13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
|
|
|
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
|
|
|
15 for more details.
|
|
|
16
|
|
|
17 You should have received a copy of the GNU General Public License
|
|
|
18 along with XEmacs; see the file COPYING. If not, write to
|
|
|
19 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
|
|
|
20 Boston, MA 02111-1307, USA. */
|
|
|
21
|
|
|
22 /* Synched up with: FSF 19.30. Note that there are many more functions in
|
|
|
23 FSF's abbrev.c. These have been moved into Lisp in XEmacs. */
|
|
|
24
|
|
|
25 /* Authorship:
|
|
|
26
|
|
|
27 FSF: Original version; a long time ago.
|
|
|
28 JWZ or Mly: Mostly moved into Lisp; maybe 1992.
|
|
|
29 Ben Wing: Some changes for Mule for 19.12.
|
|
|
30 Hrvoje Niksic: Largely rewritten in June 1997.
|
|
|
31 */
|
|
|
32
|
|
|
33 /* This file has been Mule-ized. */
|
|
|
34
|
|
|
35 #include <config.h>
|
|
|
36 #include "lisp.h"
|
|
|
37
|
|
|
38 #include "buffer.h"
|
|
|
39 #include "commands.h"
|
|
|
40 #include "insdel.h"
|
|
|
41 #include "syntax.h"
|
|
|
42 #include "window.h"
|
|
|
43
|
|
|
44 /* An abbrev table is an obarray.
|
|
|
45 Each defined abbrev is represented by a symbol in that obarray
|
|
|
46 whose print name is the abbreviation.
|
|
|
47 The symbol's value is a string which is the expansion.
|
|
|
48 If its function definition is non-nil, it is called
|
|
|
49 after the expansion is done.
|
|
|
50 The plist slot of the abbrev symbol is its usage count. */
|
|
|
51
|
|
|
52 /* The table of global abbrevs. These are in effect
|
|
|
53 in any buffer in which abbrev mode is turned on. */
|
|
|
54 Lisp_Object Vglobal_abbrev_table;
|
|
|
55
|
|
|
56 int abbrev_all_caps;
|
|
|
57
|
|
|
58 /* Non-nil => use this location as the start of abbrev to expand
|
|
|
59 (rather than taking the word before point as the abbrev) */
|
|
|
60 Lisp_Object Vabbrev_start_location;
|
|
|
61
|
|
|
62 /* Buffer that Vabbrev_start_location applies to */
|
|
|
63 Lisp_Object Vabbrev_start_location_buffer;
|
|
|
64
|
|
|
65 /* The symbol representing the abbrev most recently expanded */
|
|
|
66 Lisp_Object Vlast_abbrev;
|
|
|
67
|
|
|
68 /* A string for the actual text of the abbrev most recently expanded.
|
|
|
69 This has more info than Vlast_abbrev since case is significant. */
|
|
|
70 Lisp_Object Vlast_abbrev_text;
|
|
|
71
|
|
|
72 /* Character address of start of last abbrev expanded */
|
|
458
|
73 Fixnum last_abbrev_location;
|
|
428
|
74
|
|
|
75 /* Hook to run before expanding any abbrev. */
|
|
|
76 Lisp_Object Vpre_abbrev_expand_hook, Qpre_abbrev_expand_hook;
|
|
|
77
|
|
|
78
|
|
|
79 struct abbrev_match_mapper_closure {
|
|
|
80 struct buffer *buf;
|
|
440
|
81 Lisp_Char_Table *chartab;
|
|
428
|
82 Charcount point, maxlen;
|
|
440
|
83 Lisp_Symbol *found;
|
|
428
|
84 };
|
|
|
85
|
|
|
86 /* For use by abbrev_match(): Match SYMBOL's name against buffer text
|
|
|
87 before point, case-insensitively. When found, return non-zero, so
|
|
|
88 that map_obarray terminates mapping. */
|
|
|
89 static int
|
|
|
90 abbrev_match_mapper (Lisp_Object symbol, void *arg)
|
|
|
91 {
|
|
|
92 struct abbrev_match_mapper_closure *closure =
|
|
|
93 (struct abbrev_match_mapper_closure *)arg;
|
|
|
94 Charcount abbrev_length;
|
|
440
|
95 Lisp_Symbol *sym = XSYMBOL (symbol);
|
|
793
|
96 Lisp_Object abbrev;
|
|
428
|
97
|
|
|
98 /* symbol_value should be OK here, because abbrevs are not expected
|
|
|
99 to contain any SYMBOL_MAGIC stuff. */
|
|
|
100 if (UNBOUNDP (symbol_value (sym)) || NILP (symbol_value (sym)))
|
|
|
101 {
|
|
|
102 /* The symbol value of nil means that abbrev got undefined. */
|
|
|
103 return 0;
|
|
|
104 }
|
|
|
105 abbrev = symbol_name (sym);
|
|
793
|
106 abbrev_length = XSTRING_CHAR_LENGTH (abbrev);
|
|
428
|
107 if (abbrev_length > closure->maxlen)
|
|
|
108 {
|
|
|
109 /* This abbrev is too large -- it wouldn't fit. */
|
|
|
110 return 0;
|
|
|
111 }
|
|
|
112 /* If `bar' is an abbrev, and a user presses `fubar<SPC>', we don't
|
|
|
113 normally want to expand it. OTOH, if the abbrev begins with
|
|
|
114 non-word syntax (e.g. `#if'), it is OK to abbreviate it anywhere. */
|
|
|
115 if (abbrev_length < closure->maxlen && abbrev_length > 0
|
|
793
|
116 && (WORD_SYNTAX_P (closure->chartab, XSTRING_CHAR (abbrev, 0)))
|
|
428
|
117 && (WORD_SYNTAX_P (closure->chartab,
|
|
|
118 BUF_FETCH_CHAR (closure->buf,
|
|
793
|
119 closure->point -
|
|
|
120 (abbrev_length + 1)))))
|
|
428
|
121 {
|
|
|
122 return 0;
|
|
|
123 }
|
|
|
124 /* Match abbreviation string against buffer text. */
|
|
|
125 {
|
|
793
|
126 Intbyte *ptr = XSTRING_DATA (abbrev);
|
|
428
|
127 Charcount idx;
|
|
|
128
|
|
|
129 for (idx = 0; idx < abbrev_length; idx++)
|
|
|
130 {
|
|
|
131 if (DOWNCASE (closure->buf,
|
|
|
132 BUF_FETCH_CHAR (closure->buf,
|
|
|
133 closure->point - abbrev_length + idx))
|
|
|
134 != DOWNCASE (closure->buf, charptr_emchar (ptr)))
|
|
|
135 {
|
|
|
136 break;
|
|
|
137 }
|
|
|
138 INC_CHARPTR (ptr);
|
|
|
139 }
|
|
|
140 if (idx == abbrev_length)
|
|
|
141 {
|
|
|
142 /* This is the one. */
|
|
|
143 closure->found = sym;
|
|
|
144 return 1;
|
|
|
145 }
|
|
|
146 }
|
|
|
147 return 0;
|
|
|
148 }
|
|
|
149
|
|
|
150 /* Match the buffer text against names of symbols in obarray. Returns
|
|
|
151 the matching symbol, or 0 if not found. */
|
|
440
|
152 static Lisp_Symbol *
|
|
428
|
153 abbrev_match (struct buffer *buf, Lisp_Object obarray)
|
|
|
154 {
|
|
|
155 struct abbrev_match_mapper_closure closure;
|
|
|
156
|
|
|
157 /* Precalculate some stuff, so mapper function needn't to it in each
|
|
|
158 iteration. */
|
|
|
159 closure.buf = buf;
|
|
|
160 closure.point = BUF_PT (buf);
|
|
|
161 closure.maxlen = closure.point - BUF_BEGV (buf);
|
|
|
162 closure.chartab = XCHAR_TABLE (buf->mirror_syntax_table);
|
|
|
163 closure.found = 0;
|
|
|
164
|
|
|
165 map_obarray (obarray, abbrev_match_mapper, &closure);
|
|
|
166
|
|
|
167 return closure.found;
|
|
|
168 }
|
|
|
169
|
|
|
170 /* Take the word before point (or Vabbrev_start_location, if non-nil),
|
|
|
171 and look it up in OBARRAY, and return the symbol (or zero). This
|
|
|
172 used to be the default method of searching, with the obvious
|
|
|
173 limitation that the abbrevs may consist only of word characters.
|
|
|
174 It is an order of magnitude faster than the proper abbrev_match(),
|
|
|
175 but then again, vi is an order of magnitude faster than Emacs.
|
|
|
176
|
|
|
177 This speed difference should be unnoticeable, though. I have tested
|
|
|
178 the degenerated cases of thousands of abbrevs being defined, and
|
|
|
179 abbrev_match() was still fast enough for normal operation. */
|
|
440
|
180 static Lisp_Symbol *
|
|
428
|
181 abbrev_oblookup (struct buffer *buf, Lisp_Object obarray)
|
|
|
182 {
|
|
665
|
183 Charbpos wordstart, wordend;
|
|
|
184 Intbyte *word, *p;
|
|
428
|
185 Bytecount idx;
|
|
|
186 Lisp_Object lookup;
|
|
|
187
|
|
|
188 CHECK_VECTOR (obarray);
|
|
|
189
|
|
|
190 if (!NILP (Vabbrev_start_location))
|
|
|
191 {
|
|
|
192 wordstart = get_buffer_pos_char (buf, Vabbrev_start_location,
|
|
|
193 GB_COERCE_RANGE);
|
|
|
194 Vabbrev_start_location = Qnil;
|
|
|
195 #if 0
|
|
|
196 /* Previously, abbrev-prefix-mark crockishly inserted a dash to
|
|
|
197 indicate the abbrev start point. It now uses an extent with
|
|
|
198 a begin glyph so there's no dash to remove. */
|
|
|
199 if (wordstart != BUF_ZV (buf)
|
|
|
200 && BUF_FETCH_CHAR (buf, wordstart) == '-')
|
|
|
201 {
|
|
|
202 buffer_delete_range (buf, wordstart, wordstart + 1, 0);
|
|
|
203 }
|
|
|
204 #endif
|
|
|
205 wordend = BUF_PT (buf);
|
|
|
206 }
|
|
|
207 else
|
|
|
208 {
|
|
665
|
209 Charbpos point = BUF_PT (buf);
|
|
428
|
210
|
|
|
211 wordstart = scan_words (buf, point, -1);
|
|
|
212 if (!wordstart)
|
|
|
213 return 0;
|
|
|
214
|
|
|
215 wordend = scan_words (buf, wordstart, 1);
|
|
|
216 if (!wordend)
|
|
|
217 return 0;
|
|
|
218 if (wordend > BUF_ZV (buf))
|
|
|
219 wordend = BUF_ZV (buf);
|
|
|
220 if (wordend > point)
|
|
|
221 wordend = point;
|
|
|
222 /* Unlike the original function, we allow expansion only after
|
|
|
223 the abbrev, not preceded by a number of spaces. This is
|
|
|
224 because of consistency with abbrev_match. */
|
|
|
225 if (wordend < point)
|
|
|
226 return 0;
|
|
|
227 }
|
|
|
228
|
|
|
229 if (wordend <= wordstart)
|
|
|
230 return 0;
|
|
|
231
|
|
665
|
232 p = word = (Intbyte *) alloca (MAX_EMCHAR_LEN * (wordend - wordstart));
|
|
428
|
233 for (idx = wordstart; idx < wordend; idx++)
|
|
|
234 {
|
|
|
235 Emchar c = BUF_FETCH_CHAR (buf, idx);
|
|
|
236 if (UPPERCASEP (buf, c))
|
|
|
237 c = DOWNCASE (buf, c);
|
|
|
238 p += set_charptr_emchar (p, c);
|
|
|
239 }
|
|
|
240 lookup = oblookup (obarray, word, p - word);
|
|
|
241 if (SYMBOLP (lookup) && !NILP (symbol_value (XSYMBOL (lookup))))
|
|
|
242 return XSYMBOL (lookup);
|
|
|
243 else
|
|
|
244 return NULL;
|
|
|
245 }
|
|
|
246
|
|
|
247 /* Return non-zero if OBARRAY contains an interned symbol ` '. */
|
|
|
248 static int
|
|
|
249 obarray_has_blank_p (Lisp_Object obarray)
|
|
|
250 {
|
|
665
|
251 return !ZEROP (oblookup (obarray, (Intbyte *)" ", 1));
|
|
428
|
252 }
|
|
|
253
|
|
|
254 /* Analyze case in the buffer substring, and report it. */
|
|
|
255 static void
|
|
665
|
256 abbrev_count_case (struct buffer *buf, Charbpos pos, Charcount length,
|
|
428
|
257 int *lccount, int *uccount)
|
|
|
258 {
|
|
|
259 *lccount = *uccount = 0;
|
|
|
260 while (length--)
|
|
|
261 {
|
|
|
262 Emchar c = BUF_FETCH_CHAR (buf, pos);
|
|
|
263 if (UPPERCASEP (buf, c))
|
|
|
264 ++*uccount;
|
|
|
265 else if (LOWERCASEP (buf, c))
|
|
|
266 ++*lccount;
|
|
|
267 ++pos;
|
|
|
268 }
|
|
|
269 }
|
|
|
270
|
|
|
271 DEFUN ("expand-abbrev", Fexpand_abbrev, 0, 0, "", /*
|
|
|
272 Expand the abbrev before point, if any.
|
|
|
273 Effective when explicitly called even when `abbrev-mode' is nil.
|
|
|
274 Returns the abbrev symbol, if expansion took place.
|
|
|
275 If no abbrev matched, but `pre-abbrev-expand-hook' changed the buffer,
|
|
|
276 returns t.
|
|
|
277 */
|
|
|
278 ())
|
|
|
279 {
|
|
|
280 /* This function can GC */
|
|
|
281 struct buffer *buf = current_buffer;
|
|
|
282 int oldmodiff = BUF_MODIFF (buf);
|
|
|
283 Lisp_Object pre_modiff_p;
|
|
665
|
284 Charbpos point; /* position of point */
|
|
|
285 Charbpos abbrev_start; /* position of abbreviation beginning */
|
|
428
|
286
|
|
440
|
287 Lisp_Symbol *(*fun) (struct buffer *, Lisp_Object);
|
|
428
|
288
|
|
440
|
289 Lisp_Symbol *abbrev_symbol;
|
|
428
|
290 Lisp_Object expansion, count, hook;
|
|
|
291 Charcount abbrev_length;
|
|
|
292 int lccount, uccount;
|
|
|
293
|
|
|
294 run_hook (Qpre_abbrev_expand_hook);
|
|
|
295 /* If the hook changes the buffer, treat that as having "done an
|
|
|
296 expansion". */
|
|
|
297 pre_modiff_p = (BUF_MODIFF (buf) != oldmodiff ? Qt : Qnil);
|
|
|
298
|
|
|
299 abbrev_symbol = NULL;
|
|
|
300 if (!BUFFERP (Vabbrev_start_location_buffer) ||
|
|
|
301 XBUFFER (Vabbrev_start_location_buffer) != buf)
|
|
|
302 Vabbrev_start_location = Qnil;
|
|
|
303 /* We use the more general abbrev_match() if the obarray blank flag
|
|
|
304 is not set, and Vabbrev_start_location is nil. Otherwise, use
|
|
|
305 abbrev_oblookup(). */
|
|
|
306 #define MATCHFUN(tbl) ((obarray_has_blank_p (tbl) \
|
|
|
307 && NILP (Vabbrev_start_location)) \
|
|
|
308 ? abbrev_match : abbrev_oblookup)
|
|
|
309 if (!NILP (buf->abbrev_table))
|
|
|
310 {
|
|
|
311 fun = MATCHFUN (buf->abbrev_table);
|
|
|
312 abbrev_symbol = fun (buf, buf->abbrev_table);
|
|
|
313 }
|
|
|
314 if (!abbrev_symbol && !NILP (Vglobal_abbrev_table))
|
|
|
315 {
|
|
|
316 fun = MATCHFUN (Vglobal_abbrev_table);
|
|
|
317 abbrev_symbol = fun (buf, Vglobal_abbrev_table);
|
|
|
318 }
|
|
|
319 if (!abbrev_symbol)
|
|
|
320 return pre_modiff_p;
|
|
|
321
|
|
|
322 /* NOTE: we hope that `pre-abbrev-expand-hook' didn't do something
|
|
|
323 nasty, such as changed the buffer. Here we protect against the
|
|
|
324 buffer getting killed. */
|
|
|
325 if (! BUFFER_LIVE_P (buf))
|
|
|
326 return Qnil;
|
|
|
327 point = BUF_PT (buf);
|
|
|
328
|
|
|
329 /* OK, we're out of the must-be-fast part. An abbreviation matched.
|
|
|
330 Now find the parameters, insert the expansion, and make it all
|
|
|
331 look pretty. */
|
|
793
|
332 abbrev_length = XSTRING_CHAR_LENGTH (symbol_name (abbrev_symbol));
|
|
428
|
333 abbrev_start = point - abbrev_length;
|
|
|
334
|
|
|
335 expansion = symbol_value (abbrev_symbol);
|
|
|
336 CHECK_STRING (expansion);
|
|
|
337
|
|
|
338 count = symbol_plist (abbrev_symbol); /* Gag */
|
|
|
339 if (NILP (count))
|
|
|
340 count = Qzero;
|
|
|
341 else
|
|
|
342 CHECK_NATNUM (count);
|
|
|
343 symbol_plist (abbrev_symbol) = make_int (1 + XINT (count));
|
|
|
344
|
|
|
345 /* Count the case in the original text. */
|
|
|
346 abbrev_count_case (buf, abbrev_start, abbrev_length, &lccount, &uccount);
|
|
|
347
|
|
|
348 /* Remember the last abbrev text, location, etc. */
|
|
793
|
349 Vlast_abbrev = wrap_symbol (abbrev_symbol);
|
|
428
|
350 Vlast_abbrev_text =
|
|
|
351 make_string_from_buffer (buf, abbrev_start, abbrev_length);
|
|
|
352 last_abbrev_location = abbrev_start;
|
|
|
353
|
|
|
354 /* Add an undo boundary, in case we are doing this for a
|
|
|
355 self-inserting command which has avoided making one so far. */
|
|
|
356 if (INTERACTIVE)
|
|
|
357 Fundo_boundary ();
|
|
|
358
|
|
|
359 /* Remove the abbrev */
|
|
|
360 buffer_delete_range (buf, abbrev_start, point, 0);
|
|
|
361 /* And insert the expansion. */
|
|
|
362 buffer_insert_lisp_string (buf, expansion);
|
|
|
363 point = BUF_PT (buf);
|
|
|
364
|
|
|
365 /* Now fiddle with the case. */
|
|
|
366 if (uccount && !lccount)
|
|
|
367 {
|
|
|
368 /* Abbrev was all caps */
|
|
|
369 if (!abbrev_all_caps
|
|
|
370 && scan_words (buf, point, -1) > scan_words (buf, abbrev_start, 1))
|
|
|
371 {
|
|
|
372 Fupcase_initials_region (make_int (abbrev_start), make_int (point),
|
|
771
|
373 wrap_buffer (buf));
|
|
428
|
374 }
|
|
|
375 else
|
|
|
376 {
|
|
|
377 /* If expansion is one word, or if user says so, upcase it all. */
|
|
|
378 Fupcase_region (make_int (abbrev_start), make_int (point),
|
|
771
|
379 wrap_buffer (buf));
|
|
428
|
380 }
|
|
|
381 }
|
|
|
382 else if (uccount)
|
|
|
383 {
|
|
|
384 /* Abbrev included some caps. Cap first initial of expansion */
|
|
665
|
385 Charbpos pos = abbrev_start;
|
|
428
|
386 /* Find the initial. */
|
|
|
387 while (pos < point
|
|
|
388 && !WORD_SYNTAX_P (XCHAR_TABLE (buf->mirror_syntax_table),
|
|
|
389 BUF_FETCH_CHAR (buf, pos)))
|
|
|
390 pos++;
|
|
|
391 /* Change just that. */
|
|
|
392 Fupcase_initials_region (make_int (pos), make_int (pos + 1),
|
|
771
|
393 wrap_buffer (buf));
|
|
428
|
394 }
|
|
|
395
|
|
|
396 hook = symbol_function (abbrev_symbol);
|
|
|
397 if (!NILP (hook) && !UNBOUNDP (hook))
|
|
|
398 call0 (hook);
|
|
|
399
|
|
|
400 return Vlast_abbrev;
|
|
|
401 }
|
|
|
402
|
|
|
403
|
|
|
404 void
|
|
|
405 syms_of_abbrev (void)
|
|
|
406 {
|
|
563
|
407 DEFSYMBOL (Qpre_abbrev_expand_hook);
|
|
428
|
408 DEFSUBR (Fexpand_abbrev);
|
|
|
409 }
|
|
|
410
|
|
|
411 void
|
|
|
412 vars_of_abbrev (void)
|
|
|
413 {
|
|
|
414 DEFVAR_LISP ("global-abbrev-table", &Vglobal_abbrev_table /*
|
|
|
415 The abbrev table whose abbrevs affect all buffers.
|
|
|
416 Each buffer may also have a local abbrev table.
|
|
|
417 If it does, the local table overrides the global one
|
|
|
418 for any particular abbrev defined in both.
|
|
|
419 */ );
|
|
|
420 Vglobal_abbrev_table = Qnil; /* setup by Lisp code */
|
|
|
421
|
|
|
422 DEFVAR_LISP ("last-abbrev", &Vlast_abbrev /*
|
|
|
423 The abbrev-symbol of the last abbrev expanded.
|
|
|
424 See the function `abbrev-symbol'.
|
|
|
425 */ );
|
|
|
426
|
|
|
427 DEFVAR_LISP ("last-abbrev-text", &Vlast_abbrev_text /*
|
|
|
428 The exact text of the last abbrev expanded.
|
|
|
429 nil if the abbrev has already been unexpanded.
|
|
|
430 */ );
|
|
|
431
|
|
|
432 DEFVAR_INT ("last-abbrev-location", &last_abbrev_location /*
|
|
|
433 The location of the start of the last abbrev expanded.
|
|
|
434 */ );
|
|
|
435
|
|
|
436 Vlast_abbrev = Qnil;
|
|
|
437 Vlast_abbrev_text = Qnil;
|
|
|
438 last_abbrev_location = 0;
|
|
|
439
|
|
|
440 DEFVAR_LISP ("abbrev-start-location", &Vabbrev_start_location /*
|
|
|
441 Buffer position for `expand-abbrev' to use as the start of the abbrev.
|
|
|
442 nil means use the word before point as the abbrev.
|
|
|
443 Calling `expand-abbrev' sets this to nil.
|
|
|
444 */ );
|
|
|
445 Vabbrev_start_location = Qnil;
|
|
|
446
|
|
|
447 DEFVAR_LISP ("abbrev-start-location-buffer", &Vabbrev_start_location_buffer /*
|
|
|
448 Buffer that `abbrev-start-location' has been set for.
|
|
|
449 Trying to expand an abbrev in any other buffer clears `abbrev-start-location'.
|
|
|
450 */ );
|
|
|
451 Vabbrev_start_location_buffer = Qnil;
|
|
|
452
|
|
|
453 DEFVAR_BOOL ("abbrev-all-caps", &abbrev_all_caps /*
|
|
|
454 *Non-nil means expand multi-word abbrevs all caps if abbrev was so.
|
|
|
455 */ );
|
|
|
456 abbrev_all_caps = 0;
|
|
|
457
|
|
|
458 DEFVAR_LISP ("pre-abbrev-expand-hook", &Vpre_abbrev_expand_hook /*
|
|
|
459 Function or functions to be called before abbrev expansion is done.
|
|
|
460 This is the first thing that `expand-abbrev' does, and so this may change
|
|
|
461 the current abbrev table before abbrev lookup happens.
|
|
|
462 */ );
|
|
|
463 Vpre_abbrev_expand_hook = Qnil;
|
|
|
464 }
|
