1 /* Primitives for word-abbrev mode.
2 Copyright (C) 1985, 1986, 1992 Free Software Foundation, Inc.
4 This file is part of GNU Emacs.
6 GNU Emacs is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2, or (at your option)
11 GNU Emacs is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with GNU Emacs; see the file COPYING. If not, write to
18 the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. */
28 /* An abbrev table is an obarray.
29 Each defined abbrev is represented by a symbol in that obarray
30 whose print name is the abbreviation.
31 The symbol's value is a string which is the expansion.
32 If its function definition is non-nil, it is called
33 after the expansion is done.
34 The plist slot of the abbrev symbol is its usage count. */
36 /* List of all abbrev-table name symbols:
37 symbols whose values are abbrev tables. */
39 Lisp_Object Vabbrev_table_name_list
;
41 /* The table of global abbrevs. These are in effect
42 in any buffer in which abbrev mode is turned on. */
44 Lisp_Object Vglobal_abbrev_table
;
46 /* The local abbrev table used by default (in Fundamental Mode buffers) */
48 Lisp_Object Vfundamental_mode_abbrev_table
;
50 /* Set nonzero when an abbrev definition is changed */
56 /* Non-nil => use this location as the start of abbrev to expand
57 (rather than taking the word before point as the abbrev) */
59 Lisp_Object Vabbrev_start_location
;
61 /* Buffer that Vabbrev_start_location applies to */
62 Lisp_Object Vabbrev_start_location_buffer
;
64 /* The symbol representing the abbrev most recently expanded */
66 Lisp_Object Vlast_abbrev
;
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. */
71 Lisp_Object Vlast_abbrev_text
;
73 /* Character address of start of last abbrev expanded */
75 int last_abbrev_point
;
77 /* Hook to run before expanding any abbrev. */
79 Lisp_Object Vpre_abbrev_expand_hook
, Qpre_abbrev_expand_hook
;
81 DEFUN ("make-abbrev-table", Fmake_abbrev_table
, Smake_abbrev_table
, 0, 0, 0,
82 "Create a new, empty abbrev table object.")
85 return Fmake_vector (make_number (59), make_number (0));
88 DEFUN ("clear-abbrev-table", Fclear_abbrev_table
, Sclear_abbrev_table
, 1, 1, 0,
89 "Undefine all abbrevs in abbrev table TABLE, leaving it empty.")
95 CHECK_VECTOR (table
, 0);
96 size
= XVECTOR (table
)->size
;
98 for (i
= 0; i
< size
; i
++)
99 XVECTOR (table
)->contents
[i
] = make_number (0);
103 DEFUN ("define-abbrev", Fdefine_abbrev
, Sdefine_abbrev
, 3, 5, 0,
104 "Define an abbrev in TABLE named NAME, to expand to EXPANSION and call HOOK.\n\
105 NAME and EXPANSION are strings.\n\
106 To undefine an abbrev, define it with EXPANSION = nil.\n\
107 If HOOK is non-nil, it should be a function of no arguments;\n\
108 it is called after EXPANSION is inserted.")
109 (table
, name
, expansion
, hook
, count
)
110 Lisp_Object table
, name
, expansion
, hook
, count
;
112 Lisp_Object sym
, oexp
, ohook
, tem
;
113 CHECK_VECTOR (table
, 0);
114 CHECK_STRING (name
, 1);
115 if (!NILP (expansion
))
116 CHECK_STRING (expansion
, 2);
118 count
= make_number (0);
120 CHECK_NUMBER (count
, 0);
122 sym
= Fintern (name
, table
);
124 oexp
= XSYMBOL (sym
)->value
;
125 ohook
= XSYMBOL (sym
)->function
;
126 if (!((EQ (oexp
, expansion
)
127 || (XTYPE (oexp
) == Lisp_String
&& XTYPE (expansion
) == Lisp_String
128 && (tem
= Fstring_equal (oexp
, expansion
), !NILP (tem
))))
131 || (tem
= Fequal (ohook
, hook
), !NILP (tem
)))))
134 Fset (sym
, expansion
);
136 Fsetplist (sym
, count
);
141 DEFUN ("define-global-abbrev", Fdefine_global_abbrev
, Sdefine_global_abbrev
, 2, 2,
142 "sDefine global abbrev: \nsExpansion for %s: ",
143 "Define ABBREV as a global abbreviation for EXPANSION.")
145 Lisp_Object name
, expansion
;
147 Fdefine_abbrev (Vglobal_abbrev_table
, Fdowncase (name
),
148 expansion
, Qnil
, make_number (0));
152 DEFUN ("define-mode-abbrev", Fdefine_mode_abbrev
, Sdefine_mode_abbrev
, 2, 2,
153 "sDefine mode abbrev: \nsExpansion for %s: ",
154 "Define ABBREV as a mode-specific abbreviation for EXPANSION.")
156 Lisp_Object name
, expansion
;
158 if (NILP (current_buffer
->abbrev_table
))
159 error ("Major mode has no abbrev table");
161 Fdefine_abbrev (current_buffer
->abbrev_table
, Fdowncase (name
),
162 expansion
, Qnil
, make_number (0));
166 DEFUN ("abbrev-symbol", Fabbrev_symbol
, Sabbrev_symbol
, 1, 2, 0,
167 "Return the symbol representing abbrev named ABBREV.\n\
168 This symbol's name is ABBREV, but it is not the canonical symbol of that name;\n\
169 it is interned in an abbrev-table rather than the normal obarray.\n\
170 The value is nil if that abbrev is not defined.\n\
171 Optional second arg TABLE is abbrev table to look it up in.\n\
172 The default is to try buffer's mode-specific abbrev table, then global table.")
174 Lisp_Object abbrev
, table
;
177 CHECK_STRING (abbrev
, 0);
179 sym
= Fintern_soft (abbrev
, table
);
183 if (!NILP (current_buffer
->abbrev_table
))
184 sym
= Fintern_soft (abbrev
, current_buffer
->abbrev_table
);
185 if (NILP (XSYMBOL (sym
)->value
))
188 sym
= Fintern_soft (abbrev
, Vglobal_abbrev_table
);
190 if (NILP (XSYMBOL (sym
)->value
)) return Qnil
;
194 DEFUN ("abbrev-expansion", Fabbrev_expansion
, Sabbrev_expansion
, 1, 2, 0,
195 "Return the string that ABBREV expands into in the current buffer.\n\
196 Optionally specify an abbrev table as second arg;\n\
197 then ABBREV is looked up in that table only.")
199 Lisp_Object abbrev
, table
;
202 sym
= Fabbrev_symbol (abbrev
, table
);
203 if (NILP (sym
)) return sym
;
204 return Fsymbol_value (sym
);
207 /* Expand the word before point, if it is an abbrev.
208 Returns 1 if an expansion is done. */
210 DEFUN ("expand-abbrev", Fexpand_abbrev
, Sexpand_abbrev
, 0, 0, "",
211 "Expand the abbrev before point, if there is an abbrev there.\n\
212 Effective when explicitly called even when `abbrev-mode' is nil.\n\
213 Returns t if expansion took place.")
216 register char *buffer
, *p
;
217 register int wordstart
, wordend
, idx
;
219 int uccount
= 0, lccount
= 0;
220 register Lisp_Object sym
;
221 Lisp_Object expansion
, hook
, tem
;
222 int oldmodiff
= MODIFF
;
225 if (!NILP (Vrun_hooks
))
226 call1 (Vrun_hooks
, Qpre_abbrev_expand_hook
);
227 /* If the hook changes the buffer, treat that as having "done an
229 value
= (MODIFF
!= oldmodiff
? Qt
: Qnil
);
231 if (XBUFFER (Vabbrev_start_location_buffer
) != current_buffer
)
232 Vabbrev_start_location
= Qnil
;
233 if (!NILP (Vabbrev_start_location
))
235 tem
= Vabbrev_start_location
;
236 CHECK_NUMBER_COERCE_MARKER (tem
, 0);
237 wordstart
= XINT (tem
);
238 Vabbrev_start_location
= Qnil
;
239 if (FETCH_CHAR (wordstart
) == '-')
240 del_range (wordstart
, wordstart
+ 1);
243 wordstart
= scan_words (point
, -1);
248 wordend
= scan_words (wordstart
, 1);
254 whitecnt
= point
- wordend
;
255 if (wordend
<= wordstart
)
258 p
= buffer
= (char *) alloca (wordend
- wordstart
);
260 for (idx
= wordstart
; idx
< point
; idx
++)
262 register int c
= FETCH_CHAR (idx
);
264 c
= DOWNCASE (c
), uccount
++;
265 else if (! NOCASEP (c
))
270 if (XTYPE (current_buffer
->abbrev_table
) == Lisp_Vector
)
271 sym
= oblookup (current_buffer
->abbrev_table
, buffer
, p
- buffer
);
274 if (XTYPE (sym
) == Lisp_Int
|| NILP (XSYMBOL (sym
)->value
))
275 sym
= oblookup (Vglobal_abbrev_table
, buffer
, p
- buffer
);
276 if (XTYPE (sym
) == Lisp_Int
|| NILP (XSYMBOL (sym
)->value
))
279 if (INTERACTIVE
&& !EQ (minibuf_window
, selected_window
))
286 = Fbuffer_substring (make_number (wordstart
), make_number (wordend
));
287 del_range (wordstart
, wordend
);
289 /* Now sym is the abbrev symbol. */
291 last_abbrev_point
= wordstart
;
293 if (XTYPE (XSYMBOL (sym
)->plist
) == Lisp_Int
)
294 XSETINT (XSYMBOL (sym
)->plist
,
295 XINT (XSYMBOL (sym
)->plist
) + 1); /* Increment use count */
297 expansion
= XSYMBOL (sym
)->value
;
298 insert_from_string (expansion
, 0, XSTRING (expansion
)->size
);
299 SET_PT (point
+ whitecnt
);
301 if (uccount
&& !lccount
)
303 /* Abbrev was all caps */
304 /* If expansion is multiple words, normally capitalize each word */
305 /* This used to be if (!... && ... >= ...) Fcapitalize; else Fupcase
306 but Megatest 68000 compiler can't handle that */
307 if (!abbrev_all_caps
)
308 if (scan_words (point
, -1) > scan_words (wordstart
, 1))
310 upcase_initials_region (make_number (wordstart
),
311 make_number (point
));
314 /* If expansion is one word, or if user says so, upcase it all. */
315 Fupcase_region (make_number (wordstart
), make_number (point
));
320 /* Abbrev included some caps. Cap first initial of expansion */
324 /* Don't let Fcapitalize_word operate on text after point. */
327 Fcapitalize_word (make_number (1));
333 hook
= XSYMBOL (sym
)->function
;
340 DEFUN ("unexpand-abbrev", Funexpand_abbrev
, Sunexpand_abbrev
, 0, 0, "",
341 "Undo the expansion of the last abbrev that expanded.\n\
342 This differs from ordinary undo in that other editing done since then\n\
348 if (last_abbrev_point
< BEGV
349 || last_abbrev_point
> ZV
)
351 SET_PT (last_abbrev_point
);
352 if (XTYPE (Vlast_abbrev_text
) == Lisp_String
)
354 /* This isn't correct if Vlast_abbrev->function was used
355 to do the expansion */
357 XSET (val
, Lisp_String
, XSYMBOL (Vlast_abbrev
)->value
);
358 adjust
= XSTRING (val
)->size
;
359 del_range (point
, point
+ adjust
);
360 insert_from_string (Vlast_abbrev_text
, 0,
361 XSTRING (Vlast_abbrev_text
)->size
);
362 adjust
-= XSTRING (Vlast_abbrev_text
)->size
;
363 Vlast_abbrev_text
= Qnil
;
365 SET_PT (last_abbrev_point
< opoint
? opoint
- adjust
: opoint
);
370 write_abbrev (sym
, stream
)
371 Lisp_Object sym
, stream
;
374 if (NILP (XSYMBOL (sym
)->value
))
377 XSET (name
, Lisp_String
, XSYMBOL (sym
)->name
);
378 Fprin1 (name
, stream
);
380 Fprin1 (XSYMBOL (sym
)->value
, stream
);
382 Fprin1 (XSYMBOL (sym
)->function
, stream
);
384 Fprin1 (XSYMBOL (sym
)->plist
, stream
);
389 describe_abbrev (sym
, stream
)
390 Lisp_Object sym
, stream
;
394 if (NILP (XSYMBOL (sym
)->value
))
396 one
= make_number (1);
397 Fprin1 (Fsymbol_name (sym
), stream
);
398 Findent_to (make_number (15), one
);
399 Fprin1 (XSYMBOL (sym
)->plist
, stream
);
400 Findent_to (make_number (20), one
);
401 Fprin1 (XSYMBOL (sym
)->value
, stream
);
402 if (!NILP (XSYMBOL (sym
)->function
))
404 Findent_to (make_number (45), one
);
405 Fprin1 (XSYMBOL (sym
)->function
, stream
);
410 DEFUN ("insert-abbrev-table-description",
411 Finsert_abbrev_table_description
, Sinsert_abbrev_table_description
,
413 "Insert before point a full description of abbrev table named NAME.\n\
414 NAME is a symbol whose value is an abbrev table.\n\
415 If optional 2nd arg HUMAN is non-nil, a human-readable description is inserted.\n\
416 Otherwise the description is an expression,\n\
417 a call to `define-abbrev-table', which would\n\
418 define the abbrev table NAME exactly as it is currently defined.")
420 Lisp_Object name
, readable
;
425 CHECK_SYMBOL (name
, 0);
426 table
= Fsymbol_value (name
);
427 CHECK_VECTOR (table
, 0);
429 XSET (stream
, Lisp_Buffer
, current_buffer
);
431 if (!NILP (readable
))
434 Fprin1 (name
, stream
);
435 insert_string (")\n\n");
436 map_obarray (table
, describe_abbrev
, stream
);
437 insert_string ("\n\n");
441 insert_string ("(define-abbrev-table '");
442 Fprin1 (name
, stream
);
443 insert_string (" '(\n");
444 map_obarray (table
, write_abbrev
, stream
);
445 insert_string (" ))\n\n");
451 DEFUN ("define-abbrev-table", Fdefine_abbrev_table
, Sdefine_abbrev_table
,
453 "Define TABNAME (a symbol) as an abbrev table name.\n\
454 Define abbrevs in it according to DEFINITIONS, which is a list of elements\n\
455 of the form (ABBREVNAME EXPANSION HOOK USECOUNT).")
457 Lisp_Object tabname
, defns
;
459 Lisp_Object name
, exp
, hook
, count
;
460 Lisp_Object table
, elt
;
462 CHECK_SYMBOL (tabname
, 0);
463 table
= Fboundp (tabname
);
464 if (NILP (table
) || (table
= Fsymbol_value (tabname
), NILP (table
)))
466 table
= Fmake_abbrev_table ();
467 Fset (tabname
, table
);
468 Vabbrev_table_name_list
=
469 Fcons (tabname
, Vabbrev_table_name_list
);
471 CHECK_VECTOR (table
, 0);
473 for (;!NILP (defns
); defns
= Fcdr (defns
))
476 name
= Fcar (elt
); elt
= Fcdr (elt
);
477 exp
= Fcar (elt
); elt
= Fcdr (elt
);
478 hook
= Fcar (elt
); elt
= Fcdr (elt
);
480 Fdefine_abbrev (table
, name
, exp
, hook
, count
);
487 DEFVAR_LISP ("abbrev-table-name-list", &Vabbrev_table_name_list
,
488 "List of symbols whose values are abbrev tables.");
489 Vabbrev_table_name_list
= Fcons (intern ("fundamental-mode-abbrev-table"),
490 Fcons (intern ("global-abbrev-table"),
493 DEFVAR_LISP ("global-abbrev-table", &Vglobal_abbrev_table
,
494 "The abbrev table whose abbrevs affect all buffers.\n\
495 Each buffer may also have a local abbrev table.\n\
496 If it does, the local table overrides the global one\n\
497 for any particular abbrev defined in both.");
498 Vglobal_abbrev_table
= Fmake_abbrev_table ();
500 DEFVAR_LISP ("fundamental-mode-abbrev-table", &Vfundamental_mode_abbrev_table
,
501 "The abbrev table of mode-specific abbrevs for Fundamental Mode.");
502 Vfundamental_mode_abbrev_table
= Fmake_abbrev_table ();
503 current_buffer
->abbrev_table
= Vfundamental_mode_abbrev_table
;
505 DEFVAR_LISP ("last-abbrev", &Vlast_abbrev
,
506 "The abbrev-symbol of the last abbrev expanded. See `abbrev-symbol'.");
508 DEFVAR_LISP ("last-abbrev-text", &Vlast_abbrev_text
,
509 "The exact text of the last abbrev expanded.\n\
510 nil if the abbrev has already been unexpanded.");
512 DEFVAR_INT ("last-abbrev-location", &last_abbrev_point
,
513 "The location of the start of the last abbrev expanded.");
516 Vlast_abbrev_text
= Qnil
;
517 last_abbrev_point
= 0;
519 DEFVAR_LISP ("abbrev-start-location", &Vabbrev_start_location
,
520 "Buffer position for `expand-abbrev' to use as the start of the abbrev.\n\
521 nil means use the word before point as the abbrev.\n\
522 Calling `expand-abbrev' sets this to nil.");
523 Vabbrev_start_location
= Qnil
;
525 DEFVAR_LISP ("abbrev-start-location-buffer", &Vabbrev_start_location_buffer
,
526 "Buffer that `abbrev-start-location' has been set for.\n\
527 Trying to expand an abbrev in any other buffer clears `abbrev-start-location'.");
528 Vabbrev_start_location_buffer
= Qnil
;
530 DEFVAR_PER_BUFFER ("local-abbrev-table", ¤t_buffer
->abbrev_table
, Qnil
,
531 "Local (mode-specific) abbrev table of current buffer.");
533 DEFVAR_BOOL ("abbrevs-changed", &abbrevs_changed
,
534 "Set non-nil by defining or altering any word abbrevs.\n\
535 This causes `save-some-buffers' to offer to save the abbrevs.");
538 DEFVAR_BOOL ("abbrev-all-caps", &abbrev_all_caps
,
539 "*Set non-nil means expand multi-word abbrevs all caps if abbrev was so.");
542 DEFVAR_LISP ("pre-abbrev-expand-hook", &Vpre_abbrev_expand_hook
,
543 "Function or functions to be called before abbrev expansion is done.\n\
544 This is the first thing that `expand-abbrev' does, and so this may change\n\
545 the current abbrev table before abbrev lookup happens.");
546 Vpre_abbrev_expand_hook
= Qnil
;
547 Qpre_abbrev_expand_hook
= intern ("pre-abbrev-expand-hook");
548 staticpro (&Qpre_abbrev_expand_hook
);
550 defsubr (&Smake_abbrev_table
);
551 defsubr (&Sclear_abbrev_table
);
552 defsubr (&Sdefine_abbrev
);
553 defsubr (&Sdefine_global_abbrev
);
554 defsubr (&Sdefine_mode_abbrev
);
555 defsubr (&Sabbrev_expansion
);
556 defsubr (&Sabbrev_symbol
);
557 defsubr (&Sexpand_abbrev
);
558 defsubr (&Sunexpand_abbrev
);
559 defsubr (&Sinsert_abbrev_table_description
);
560 defsubr (&Sdefine_abbrev_table
);