annotate man/lispref/abbrevs.texi @ 2367:ecf1ebac70d8

[xemacs-hg @ 2004-11-04 23:05:23 by ben] commit mega-patch configure.in: Turn off -Winline and -Wchar-subscripts. Use the right set of cflags when compiling modules. Rewrite ldap configuration to separate the inclusion of lber (needed in recent Cygwin) from the basic checks for the needed libraries. add a function for MAKE_JUNK_C; initially code was added to generate xemacs.def using this, but it will need to be rewritten. add an rm -f for junk.c to avoid weird Cygwin bug with cp -f onto an existing file. Sort list of auto-detected functions and eliminate unused checks for stpcpy, setlocale and getwd. Add autodetection of Cygwin scanf problems BETA: Rewrite section on configure to indicate what flags are important and what not. digest-doc.c, make-dump-id.c, profile.c, sorted-doc.c: Add proper decls for main(). make-msgfile.c: Document that this is old junk. Move proposal to text.c. make-msgfile.lex: Move proposal to text.c. make-mswin-unicode.pl: Convert error-generating code so that the entire message will be seen as a single unrecognized token. mule/mule-ccl.el: Update docs. lispref/mule.texi: Update CCL docs. ldap/eldap.c: Mule-ize. Use EXTERNAL_LIST_LOOP_2 instead of deleted EXTERNAL_LIST_LOOP. * XEmacs 21.5.18 "chestnut" is released. --------------------------------------------------------------- MULE-RELATED WORK: --------------------------------------------------------------- --------------------------- byte-char conversion --------------------------- buffer.c, buffer.h, insdel.c, text.c: Port FSF algorithm for byte-char conversion, replacing broken previous version. Track the char position of the gap. Add functions to do char-byte conversion downwards as well as upwards. Move comments about algorithm workings to internals manual. --------------------------- work on types --------------------------- alloc.c, console-x-impl.h, dump-data.c, dump-data.h, dumper.c, dialog-msw.c, dired-msw.c, doc.c, editfns.c, esd.c, event-gtk.h, event-msw.c, events.c, file-coding.c, file-coding.h, fns.c, glyphs-eimage.c, glyphs-gtk.c, glyphs-msw.c, glyphs-shared.c, glyphs-x.c, glyphs.c, glyphs.h, gui.c, hpplay.c, imgproc.c, intl-win32.c, lrecord.h, lstream.c, keymap.c, lisp.h, libsst.c, linuxplay.c, miscplay.c, miscplay.h, mule-coding.c, nas.c, nt.c, ntheap.c, ntplay.c, objects-msw.c, objects-tty.c, objects-x.c, print.c, process-nt.c, process.c, redisplay.h, select-common.h, select-gtk.c, select-x.c, sgiplay.c, sound.c, sound.h, sunplay.c, sysfile.h, sysdep.c, syswindows.h, text.c, unexnt.c, win32.c, xgccache.c: Further work on types. This creates a full set of types for all the basic semantics of `char' that I have so far identified, so that its semantics can always be identified for the purposes of proper Mule-safe code, and the raw use of `char' always avoided. (1) More type renaming, for consistency of naming. Char_ASCII -> Ascbyte UChar_ASCII -> UAscbyte Char_Binary -> CBinbyte UChar_Binary -> Binbyte SChar_Binary -> SBinbyte (2) Introduce Rawbyte, CRawbyte, Boolbyte, Chbyte, UChbyte, and Bitbyte and use them. (3) New types Itext, Wexttext and Textcount for separating out the concepts of bytes and textual units (different under UTF-16 and UTF-32, which are potential internal encodings). (4) qxestr*_c -> qxestr*_ascii. lisp.h: New; goes with other qxe() functions. #### Maybe goes in a different section. lisp.h: Group generic int-type defs together with EMACS_INT defs. lisp.h: * lisp.h (WEXTTEXT_IS_WIDE) New defns. lisp.h: New type to replace places where int occurs as a boolean. It's signed because occasionally people may want to use -1 as an error value, and because unsigned ints are viral -- see comments in the internals manual against using them. dynarr.c: int -> Bytecount. --------------------------- Mule-izing --------------------------- device-x.c: Partially Mule-ize. dumper.c, dumper.h: Mule-ize. Use Rawbyte. Use stderr_out not printf. Use wext_*(). sysdep.c, syswindows.h, text.c: New Wexttext API for manipulation of external text that may be Unicode (e.g. startup code under Windows). emacs.c: Mule-ize. Properly deal with argv in external encoding. Use wext_*() and Wexttext. Use Rawbyte. #if 0 some old junk on SCO that is unlikely to be correct. Rewrite allocation code in run-temacs. emacs.c, symsinit.h, win32.c: Rename win32 init function and call it even earlier, to initialize mswindows_9x_p even earlier, for use in startup code (XEUNICODE_P). process.c: Use _wenviron not environ under Windows, to get Unicode environment variables. event-Xt.c: Mule-ize drag-n-drop related stuff. dragdrop.c, dragdrop.h, frame-x.c: Mule-ize. text.h: Add some more stand-in defines for particular kinds of conversion; use in Mule-ization work in frame-x.c etc. --------------------------- Freshening --------------------------- intl-auto-encap-win32.c, intl-auto-encap-win32.h: Regenerate. --------------------------- Unicode-work --------------------------- intl-win32.c, syswindows.h: Factor out common options to MultiByteToWideChar and WideCharToMultiByte. Add convert_unicode_to_multibyte_malloc() and convert_unicode_to_multibyte_dynarr() and use. Add stuff for alloca() conversion of multibyte/unicode. alloc.c: Use dfc_external_data_len() in case of unicode coding system. alloc.c, mule-charset.c: Don't zero out and reinit charset Unicode tables. This fucks up dump-time loading. Anyway, either we load them at dump time or run time, never both. unicode.c: Dump the blank tables as well. --------------------------------------------------------------- DOCUMENTATION, MOSTLY MULE-RELATED: --------------------------------------------------------------- EmacsFrame.c, emodules.c, event-Xt.c, fileio.c, input-method-xlib.c, mule-wnnfns.c, redisplay-gtk.c, redisplay-tty.c, redisplay-x.c, regex.c, sysdep.c: Add comment about Mule work needed. text.h: Add more documentation describing why DFC routines were not written to return their value. Add some other DFC documentation. console-msw.c, console-msw.h: Add pointer to docs in win32.c. emacs.c: Add comments on sources of doc info. text.c, charset.h, unicode.c, intl-win32.c, intl-encap-win32.c, text.h, file-coding.c, mule-coding.c: Collect background comments and related to text matters and internationalization, and proposals for work to be done, in text.c or Internals manual, stuff related to specific textual API's in text.h, and stuff related to internal implementation of Unicode conversion in unicode.c. Put lots of pointers to the comments to make them easier to find. s/mingw32.h, s/win32-common.h, s/win32-native.h, s/windowsnt.h, win32.c: Add bunches of new documentation on the different kinds of builds and environments under Windows and how they work. Collect this info in win32.c. Add pointers to these docs in the relevant s/* files. emacs.c: Document places with long comments. Remove comment about exiting, move to internals manual, put in pointer. event-stream.c: Move docs about event queues and focus to internals manual, put in pointer. events.h: Move docs about event stream callbacks to internals manual, put in pointer. profile.c, redisplay.c, signal.c: Move documentation to the Internals manual. process-nt.c: Add pointer to comment in win32-native.el. lisp.h: Add comments about some comment conventions. lisp.h: Add comment about the second argument. device-msw.c, redisplay-msw.c: @@#### comments are out-of-date. --------------------------------------------------------------- PDUMP WORK (MOTIVATED BY UNICODE CHANGES) --------------------------------------------------------------- alloc.c, buffer.c, bytecode.c, console-impl.h, console.c, device.c, dumper.c, lrecord.h, elhash.c, emodules.h, events.c, extents.c, frame.c, glyphs.c, glyphs.h, mule-charset.c, mule-coding.c, objects.c, profile.c, rangetab.c, redisplay.c, specifier.c, specifier.h, window.c, lstream.c, file-coding.h, file-coding.c: PDUMP: Properly implement dump_add_root_block(), which never worked before, and is necessary for dumping Unicode tables. Pdump name changes for accuracy: XD_STRUCT_PTR -> XD_BLOCK_PTR. XD_STRUCT_ARRAY -> XD_BLOCK_ARRAY. XD_C_STRING -> XD_ASCII_STRING. *_structure_* -> *_block_*. lrecord.h: some comments added about dump_add_root_block() vs dump_add_root_block_ptr(). extents.c: remove incorrect comment about pdump problems with gap array. --------------------------------------------------------------- ALLOCATION --------------------------------------------------------------- abbrev.c, alloc.c, bytecode.c, casefiddle.c, device-msw.c, device-x.c, dired-msw.c, doc.c, doprnt.c, dragdrop.c, editfns.c, emodules.c, file-coding.c, fileio.c, filelock.c, fns.c, glyphs-eimage.c, glyphs-gtk.c, glyphs-msw.c, glyphs-x.c, gui-msw.c, gui-x.c, imgproc.c, intl-win32.c, lread.c, menubar-gtk.c, menubar.c, nt.c, objects-msw.c, objects-x.c, print.c, process-nt.c, process-unix.c, process.c, realpath.c, redisplay.c, search.c, select-common.c, symbols.c, sysdep.c, syswindows.h, text.c, text.h, ui-byhand.c: New macros {alloca,xnew}_{itext,{i,ext,raw,bin,asc}bytes} for more convenient allocation of these commonly requested items. Modify functions to use alloca_ibytes, alloca_array, alloca_extbytes, xnew_ibytes, etc. also XREALLOC_ARRAY, xnew. alloc.c: Rewrite the allocation functions to factor out repeated code. Add assertions for freeing dumped data. lisp.h: Moved down and consolidated with other allocation stuff. lisp.h, dynarr.c: New functions for allocation that's very efficient when mostly in LIFO order. lisp.h, text.c, text.h: Factor out some stuff for general use by alloca()-conversion funs. text.h, lisp.h: Fill out convenience routines for allocating various kinds of bytes and put them in lisp.h. Use them in place of xmalloc(), ALLOCA(). text.h: Fill out the convenience functions so the _MALLOC() kinds match the alloca() kinds. --------------------------------------------------------------- ERROR-CHECKING --------------------------------------------------------------- text.h: Create ASSERT_ASCTEXT_ASCII() and ASSERT_ASCTEXT_ASCII_LEN() from similar Eistring checkers and change the Eistring checkers to use them instead. --------------------------------------------------------------- MACROS IN LISP.H --------------------------------------------------------------- lisp.h: Redo GCPRO declarations. Create a "base" set of functions that can be used to generate any kind of gcpro sets -- regular, ngcpro, nngcpro, private ones used in GC_EXTERNAL_LIST_LOOP_2. buffer.c, callint.c, chartab.c, console-msw.c, device-x.c, dialog-msw.c, dired.c, extents.c, ui-gtk.c, rangetab.c, nt.c, mule-coding.c, minibuf.c, menubar-msw.c, menubar.c, menubar-gtk.c, lread.c, lisp.h, gutter.c, glyphs.c, glyphs-widget.c, fns.c, fileio.c, file-coding.c, specifier.c: Eliminate EXTERNAL_LIST_LOOP, which does not check for circularities. Use EXTERNAL_LIST_LOOP_2 instead or EXTERNAL_LIST_LOOP_3 or EXTERNAL_PROPERTY_LIST_LOOP_3 or GC_EXTERNAL_LIST_LOOP_2 (new macro). Removed/redid comments on EXTERNAL_LIST_LOOP. --------------------------------------------------------------- SPACING FIXES --------------------------------------------------------------- callint.c, hftctl.c, number-gmp.c, process-unix.c: Spacing fixes. --------------------------------------------------------------- FIX FOR GEOMETRY PROBLEM IN FIRST FRAME --------------------------------------------------------------- unicode.c: Add workaround for newlib bug in sscanf() [should be fixed by release 1.5.12 of Cygwin]. toolbar.c: bug fix for problem of initial frame being 77 chars wide on Windows. will be overridden by my other ws. --------------------------------------------------------------- FIX FOR LEAKING PROCESS HANDLES: --------------------------------------------------------------- process-nt.c: Fixes for leaking handles. Inspired by work done by Adrian Aichner <adrian@xemacs.org>. --------------------------------------------------------------- FIX FOR CYGWIN BUG (Unicode-related): --------------------------------------------------------------- unicode.c: Add workaround for newlib bug in sscanf() [should be fixed by release 1.5.12 of Cygwin]. --------------------------------------------------------------- WARNING FIXES: --------------------------------------------------------------- console-stream.c: `reinit' is unused. compiler.h, event-msw.c, frame-msw.c, intl-encap-win32.c, text.h: Add stuff to deal with ANSI-aliasing warnings I got. regex.c: Gather includes together to avoid warning. --------------------------------------------------------------- CHANGES TO INITIALIZATION ROUTINES: --------------------------------------------------------------- buffer.c, emacs.c, console.c, debug.c, device-x.c, device.c, dragdrop.c, emodules.c, eval.c, event-Xt.c, event-gtk.c, event-msw.c, event-stream.c, event-tty.c, events.c, extents.c, faces.c, file-coding.c, fileio.c, font-lock.c, frame-msw.c, glyphs-widget.c, glyphs.c, gui-x.c, insdel.c, lread.c, lstream.c, menubar-gtk.c, menubar-x.c, minibuf.c, mule-wnnfns.c, objects-msw.c, objects.c, print.c, scrollbar-x.c, search.c, select-x.c, text.c, undo.c, unicode.c, window.c, symsinit.h: Call reinit_*() functions directly from emacs.c, for clarity. Factor out some redundant init code. Move disallowed stuff that had crept into vars_of_glyphs() into complex_vars_of_glyphs(). Call init_eval_semi_early() from eval.c not in the middle of vars_of_() in emacs.c since there should be no order dependency in the latter calls. --------------------------------------------------------------- ARMAGEDDON: --------------------------------------------------------------- alloc.c, emacs.c, lisp.h, print.c: Rename inhibit_non_essential_printing_operations to inhibit_non_essential_conversion_operations. text.c: Assert on !inhibit_non_essential_conversion_operations. console-msw.c, print.c: Don't do conversion in SetConsoleTitle or FindWindow to avoid problems during armageddon. Put #errors for NON_ASCII_INTERNAL_FORMAT in places where problems would arise. --------------------------------------------------------------- CHANGES TO THE BUILD PROCEDURE: --------------------------------------------------------------- config.h.in, s/cxux.h, s/usg5-4-2.h, m/powerpc.h: Add comment about correct ordering of this file. Rearrange everything to follow this -- put all #undefs together and before the s&m files. Add undefs for HAVE_ALLOCA, C_ALLOCA, BROKEN_ALLOCA_IN_FUNCTION_CALLS, STACK_DIRECTION. Remove unused HAVE_STPCPY, HAVE_GETWD, HAVE_SETLOCALE. m/gec63.h: Deleted; totally broken, not used at all, not in FSF. m/7300.h, m/acorn.h, m/alliant-2800.h, m/alliant.h, m/altos.h, m/amdahl.h, m/apollo.h, m/att3b.h, m/aviion.h, m/celerity.h, m/clipper.h, m/cnvrgnt.h, m/convex.h, m/cydra5.h, m/delta.h, m/delta88k.h, m/dpx2.h, m/elxsi.h, m/ews4800r.h, m/gould.h, m/hp300bsd.h, m/hp800.h, m/hp9000s300.h, m/i860.h, m/ibmps2-aix.h, m/ibmrs6000.h, m/ibmrt-aix.h, m/ibmrt.h, m/intel386.h, m/iris4d.h, m/iris5d.h, m/iris6d.h, m/irist.h, m/isi-ov.h, m/luna88k.h, m/m68k.h, m/masscomp.h, m/mg1.h, m/mips-nec.h, m/mips-siemens.h, m/mips.h, m/news.h, m/nh3000.h, m/nh4000.h, m/ns32000.h, m/orion105.h, m/pfa50.h, m/plexus.h, m/pmax.h, m/powerpc.h, m/pyrmips.h, m/sequent-ptx.h, m/sequent.h, m/sgi-challenge.h, m/symmetry.h, m/tad68k.h, m/tahoe.h, m/targon31.h, m/tekxd88.h, m/template.h, m/tower32.h, m/tower32v3.h, m/ustation.h, m/vax.h, m/wicat.h, m/xps100.h: Delete C_ALLOCA, HAVE_ALLOCA, STACK_DIRECTION, BROKEN_ALLOCA_IN_FUNCTION_CALLS. All of this is auto-detected. When in doubt, I followed recent FSF sources, which also have these things deleted.
author ben
date Thu, 04 Nov 2004 23:08:28 +0000
parents 1ccc32a20af4
children 9fae6227ede5
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
1 @c -*-texinfo-*-
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
2 @c This is part of the XEmacs Lisp Reference Manual.
444
576fb035e263 Import from CVS: tag r21-2-37
cvs
parents: 0
diff changeset
3 @c Copyright (C) 1990, 1991, 1992, 1993, 1994 Free Software Foundation, Inc.
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
4 @c See the file lispref.texi for copying conditions.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
5 @setfilename ../../info/abbrevs.info
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
6 @node Abbrevs, Extents, Syntax Tables, Top
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
7 @chapter Abbrevs And Abbrev Expansion
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
8 @cindex abbrev
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
9 @cindex abbrev table
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
10
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
11 An abbreviation or @dfn{abbrev} is a string of characters that may be
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
12 expanded to a longer string. The user can insert the abbrev string and
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
13 find it replaced automatically with the expansion of the abbrev. This
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
14 saves typing.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
15
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
16 The set of abbrevs currently in effect is recorded in an @dfn{abbrev
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
17 table}. Each buffer has a local abbrev table, but normally all buffers
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
18 in the same major mode share one abbrev table. There is also a global
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
19 abbrev table. Normally both are used.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
20
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
21 An abbrev table is represented as an obarray containing a symbol for
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
22 each abbreviation. The symbol's name is the abbreviation; its value is
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
23 the expansion; its function definition is the hook function to do the
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
24 expansion (@pxref{Defining Abbrevs}); its property list cell contains
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
25 the use count, the number of times the abbreviation has been expanded.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
26 Because these symbols are not interned in the usual obarray, they will
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
27 never appear as the result of reading a Lisp expression; in fact,
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
28 normally they are never used except by the code that handles abbrevs.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
29 Therefore, it is safe to use them in an extremely nonstandard way.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
30 @xref{Creating Symbols}.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
31
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
32 For the user-level commands for abbrevs, see @ref{Abbrevs,, Abbrev
446
1ccc32a20af4 Import from CVS: tag r21-2-38
cvs
parents: 444
diff changeset
33 Mode, xemacs, The XEmacs User's Manual}.
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
34
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
35 @menu
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
36 * Abbrev Mode:: Setting up XEmacs for abbreviation.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
37 * Tables: Abbrev Tables. Creating and working with abbrev tables.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
38 * Defining Abbrevs:: Specifying abbreviations and their expansions.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
39 * Files: Abbrev Files. Saving abbrevs in files.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
40 * Expansion: Abbrev Expansion. Controlling expansion; expansion subroutines.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
41 * Standard Abbrev Tables:: Abbrev tables used by various major modes.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
42 @end menu
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
43
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
44 @node Abbrev Mode
444
576fb035e263 Import from CVS: tag r21-2-37
cvs
parents: 0
diff changeset
45 @section Setting Up Abbrev Mode
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
46
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
47 Abbrev mode is a minor mode controlled by the value of the variable
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
48 @code{abbrev-mode}.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
49
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
50 @defvar abbrev-mode
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
51 A non-@code{nil} value of this variable turns on the automatic expansion
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
52 of abbrevs when their abbreviations are inserted into a buffer.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
53 If the value is @code{nil}, abbrevs may be defined, but they are not
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
54 expanded automatically.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
55
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
56 This variable automatically becomes local when set in any fashion.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
57 @end defvar
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
58
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
59 @defvar default-abbrev-mode
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
60 This is the value of @code{abbrev-mode} for buffers that do not override it.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
61 This is the same as @code{(default-value 'abbrev-mode)}.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
62 @end defvar
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
63
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
64 @node Abbrev Tables
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
65 @section Abbrev Tables
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
66
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
67 This section describes how to create and manipulate abbrev tables.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
68
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
69 @defun make-abbrev-table
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
70 This function creates and returns a new, empty abbrev table---an obarray
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
71 containing no symbols. It is a vector filled with zeros.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
72 @end defun
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
73
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
74 @defun clear-abbrev-table table
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
75 This function undefines all the abbrevs in abbrev table @var{table},
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
76 leaving it empty. The function returns @code{nil}.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
77 @end defun
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
78
444
576fb035e263 Import from CVS: tag r21-2-37
cvs
parents: 0
diff changeset
79 @defun define-abbrev-table table-name definitions
576fb035e263 Import from CVS: tag r21-2-37
cvs
parents: 0
diff changeset
80 This function defines @var{table-name} (a symbol) as an abbrev table name,
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
81 i.e., as a variable whose value is an abbrev table. It defines abbrevs
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
82 in the table according to @var{definitions}, a list of elements of the
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
83 form @code{(@var{abbrevname} @var{expansion} @var{hook}
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
84 @var{usecount})}. The value is always @code{nil}.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
85 @end defun
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
86
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
87 @defvar abbrev-table-name-list
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
88 This is a list of symbols whose values are abbrev tables.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
89 @code{define-abbrev-table} adds the new abbrev table name to this list.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
90 @end defvar
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
91
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
92 @defun insert-abbrev-table-description name &optional human
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
93 This function inserts before point a description of the abbrev table
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
94 named @var{name}. The argument @var{name} is a symbol whose value is an
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
95 abbrev table. The value is always @code{nil}.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
96
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
97 If @var{human} is non-@code{nil}, the description is human-oriented.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
98 Otherwise the description is a Lisp expression---a call to
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
99 @code{define-abbrev-table} that would define @var{name} exactly as it
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
100 is currently defined.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
101 @end defun
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
102
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
103 @node Defining Abbrevs
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
104 @section Defining Abbrevs
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
105
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
106 These functions define an abbrev in a specified abbrev table.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
107 @code{define-abbrev} is the low-level basic function, while
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
108 @code{add-abbrev} is used by commands that ask for information from the
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
109 user.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
110
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
111 @defun add-abbrev table type arg
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
112 This function adds an abbreviation to abbrev table @var{table} based on
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
113 information from the user. The argument @var{type} is a string
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
114 describing in English the kind of abbrev this will be (typically,
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
115 @code{"global"} or @code{"mode-specific"}); this is used in prompting
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
116 the user. The argument @var{arg} is the number of words in the
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
117 expansion.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
118
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
119 The return value is the symbol that internally represents the new
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
120 abbrev, or @code{nil} if the user declines to confirm redefining an
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
121 existing abbrev.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
122 @end defun
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
123
444
576fb035e263 Import from CVS: tag r21-2-37
cvs
parents: 0
diff changeset
124 @defun define-abbrev table name &optional expansion hook count
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
125 This function defines an abbrev in @var{table} named @var{name}, to
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
126 expand to @var{expansion}, and call @var{hook}. The return value is an
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
127 uninterned symbol that represents the abbrev inside XEmacs; its name is
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
128 @var{name}.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
129
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
130 The argument @var{name} should be a string. The argument
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
131 @var{expansion} should be a string, or @code{nil} to undefine the
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
132 abbrev.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
133
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
134 The argument @var{hook} is a function or @code{nil}. If @var{hook} is
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
135 non-@code{nil}, then it is called with no arguments after the abbrev is
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
136 replaced with @var{expansion}; point is located at the end of
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
137 @var{expansion} when @var{hook} is called.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
138
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
139 The use count of the abbrev is initialized to zero.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
140 @end defun
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
141
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
142 @defopt only-global-abbrevs
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
143 If this variable is non-@code{nil}, it means that the user plans to use
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
144 global abbrevs only. This tells the commands that define mode-specific
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
145 abbrevs to define global ones instead. This variable does not alter the
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
146 behavior of the functions in this section; it is examined by their
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
147 callers.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
148 @end defopt
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
149
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
150 @node Abbrev Files
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
151 @section Saving Abbrevs in Files
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
152
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
153 A file of saved abbrev definitions is actually a file of Lisp code.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
154 The abbrevs are saved in the form of a Lisp program to define the same
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
155 abbrev tables with the same contents. Therefore, you can load the file
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
156 with @code{load} (@pxref{How Programs Do Loading}). However, the
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
157 function @code{quietly-read-abbrev-file} is provided as a more
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
158 convenient interface.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
159
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
160 User-level facilities such as @code{save-some-buffers} can save
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
161 abbrevs in a file automatically, under the control of variables
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
162 described here.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
163
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
164 @defopt abbrev-file-name
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
165 This is the default file name for reading and saving abbrevs.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
166 @end defopt
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
167
444
576fb035e263 Import from CVS: tag r21-2-37
cvs
parents: 0
diff changeset
168 @defun quietly-read-abbrev-file &optional filename
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
169 This function reads abbrev definitions from a file named @var{filename},
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
170 previously written with @code{write-abbrev-file}. If @var{filename} is
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
171 @code{nil}, the file specified in @code{abbrev-file-name} is used.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
172 @code{save-abbrevs} is set to @code{t} so that changes will be saved.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
173
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
174 This function does not display any messages. It returns @code{nil}.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
175 @end defun
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
176
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
177 @defopt save-abbrevs
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
178 A non-@code{nil} value for @code{save-abbrev} means that XEmacs should
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
179 save abbrevs when files are saved. @code{abbrev-file-name} specifies
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
180 the file to save the abbrevs in.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
181 @end defopt
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
182
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
183 @defvar abbrevs-changed
444
576fb035e263 Import from CVS: tag r21-2-37
cvs
parents: 0
diff changeset
184 This variable is set non-@code{nil} by defining or altering any
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
185 abbrevs. This serves as a flag for various XEmacs commands to offer to
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
186 save your abbrevs.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
187 @end defvar
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
188
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
189 @deffn Command write-abbrev-file filename
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
190 Save all abbrev definitions, in all abbrev tables, in the file
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
191 @var{filename}, in the form of a Lisp program that when loaded will
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
192 define the same abbrevs. This function returns @code{nil}.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
193 @end deffn
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
194
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
195 @node Abbrev Expansion
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
196 @section Looking Up and Expanding Abbreviations
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
197
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
198 Abbrevs are usually expanded by commands for interactive use,
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
199 including @code{self-insert-command}. This section describes the
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
200 subroutines used in writing such functions, as well as the variables
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
201 they use for communication.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
202
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
203 @defun abbrev-symbol abbrev &optional table
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
204 This function returns the symbol representing the abbrev named
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
205 @var{abbrev}. The value returned is @code{nil} if that abbrev is not
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
206 defined. The optional second argument @var{table} is the abbrev table
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
207 to look it up in. If @var{table} is @code{nil}, this function tries
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
208 first the current buffer's local abbrev table, and second the global
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
209 abbrev table.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
210 @end defun
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
211
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
212 @defun abbrev-expansion abbrev &optional table
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
213 This function returns the string that @var{abbrev} would expand into (as
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
214 defined by the abbrev tables used for the current buffer). The optional
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
215 argument @var{table} specifies the abbrev table to use, as in
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
216 @code{abbrev-symbol}.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
217 @end defun
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
218
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
219 @deffn Command expand-abbrev
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
220 This command expands the abbrev before point, if any.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
221 If point does not follow an abbrev, this command does nothing.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
222 The command returns @code{t} if it did expansion, @code{nil} otherwise.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
223 @end deffn
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
224
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
225 @deffn Command abbrev-prefix-mark &optional arg
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
226 Mark current point as the beginning of an abbrev. The next call to
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
227 @code{expand-abbrev} will use the text from here to point (where it is
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
228 then) as the abbrev to expand, rather than using the previous word as
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
229 usual.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
230 @end deffn
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
231
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
232 @defopt abbrev-all-caps
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
233 When this is set non-@code{nil}, an abbrev entered entirely in upper
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
234 case is expanded using all upper case. Otherwise, an abbrev entered
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
235 entirely in upper case is expanded by capitalizing each word of the
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
236 expansion.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
237 @end defopt
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
238
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
239 @defvar abbrev-start-location
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
240 This is the buffer position for @code{expand-abbrev} to use as the start
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
241 of the next abbrev to be expanded. (@code{nil} means use the word
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
242 before point instead.) @code{abbrev-start-location} is set to
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
243 @code{nil} each time @code{expand-abbrev} is called. This variable is
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
244 also set by @code{abbrev-prefix-mark}.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
245 @end defvar
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
246
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
247 @defvar abbrev-start-location-buffer
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
248 The value of this variable is the buffer for which
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
249 @code{abbrev-start-location} has been set. Trying to expand an abbrev
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
250 in any other buffer clears @code{abbrev-start-location}. This variable
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
251 is set by @code{abbrev-prefix-mark}.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
252 @end defvar
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
253
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
254 @defvar last-abbrev
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
255 This is the @code{abbrev-symbol} of the last abbrev expanded. This
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
256 information is left by @code{expand-abbrev} for the sake of the
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
257 @code{unexpand-abbrev} command.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
258 @end defvar
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
259
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
260 @defvar last-abbrev-location
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
261 This is the location of the last abbrev expanded. This contains
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
262 information left by @code{expand-abbrev} for the sake of the
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
263 @code{unexpand-abbrev} command.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
264 @end defvar
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
265
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
266 @defvar last-abbrev-text
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
267 This is the exact expansion text of the last abbrev expanded, after case
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
268 conversion (if any). Its value is @code{nil} if the abbrev has already
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
269 been unexpanded. This contains information left by @code{expand-abbrev}
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
270 for the sake of the @code{unexpand-abbrev} command.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
271 @end defvar
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
272
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
273 @c Emacs 19 feature
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
274 @defvar pre-abbrev-expand-hook
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
275 This is a normal hook whose functions are executed, in sequence, just
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
276 before any expansion of an abbrev. @xref{Hooks}. Since it is a normal
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
277 hook, the hook functions receive no arguments. However, they can find
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
278 the abbrev to be expanded by looking in the buffer before point.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
279 @end defvar
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
280
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
281 The following sample code shows a simple use of
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
282 @code{pre-abbrev-expand-hook}. If the user terminates an abbrev with a
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
283 punctuation character, the hook function asks for confirmation. Thus,
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
284 this hook allows the user to decide whether to expand the abbrev, and
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
285 aborts expansion if it is not confirmed.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
286
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
287 @smallexample
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
288 (add-hook 'pre-abbrev-expand-hook 'query-if-not-space)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
289
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
290 ;; @r{This is the function invoked by @code{pre-abbrev-expand-hook}.}
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
291
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
292 ;; @r{If the user terminated the abbrev with a space, the function does}
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
293 ;; @r{nothing (that is, it returns so that the abbrev can expand). If the}
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
294 ;; @r{user entered some other character, this function asks whether}
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
295 ;; @r{expansion should continue.}
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
296
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
297 ;; @r{If the user answers the prompt with @kbd{y}, the function returns}
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
298 ;; @r{@code{nil} (because of the @code{not} function), but that is}
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
299 ;; @r{acceptable; the return value has no effect on expansion.}
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
300
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
301 (defun query-if-not-space ()
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
302 (if (/= ?\ (preceding-char))
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
303 (if (not (y-or-n-p "Do you want to expand this abbrev? "))
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
304 (error "Not expanding this abbrev"))))
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
305 @end smallexample
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
306
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
307 @node Standard Abbrev Tables
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
308 @section Standard Abbrev Tables
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
309
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
310 Here we list the variables that hold the abbrev tables for the
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
311 preloaded major modes of XEmacs.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
312
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
313 @defvar global-abbrev-table
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
314 This is the abbrev table for mode-independent abbrevs. The abbrevs
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
315 defined in it apply to all buffers. Each buffer may also have a local
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
316 abbrev table, whose abbrev definitions take precedence over those in the
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
317 global table.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
318 @end defvar
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
319
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
320 @defvar local-abbrev-table
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
321 The value of this buffer-local variable is the (mode-specific)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
322 abbreviation table of the current buffer.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
323 @end defvar
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
324
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
325 @defvar fundamental-mode-abbrev-table
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
326 This is the local abbrev table used in Fundamental mode; in other words,
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
327 it is the local abbrev table in all buffers in Fundamental mode.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
328 @end defvar
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
329
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
330 @defvar text-mode-abbrev-table
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
331 This is the local abbrev table used in Text mode.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
332 @end defvar
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
333
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
334 @defvar c-mode-abbrev-table
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
335 This is the local abbrev table used in C mode.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
336 @end defvar
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
337
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
338 @defvar lisp-mode-abbrev-table
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
339 This is the local abbrev table used in Lisp mode and Emacs Lisp mode.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
340 @end defvar