|
428
|
1 \input texinfo @c -*-texinfo-*-
|
|
|
2 @c %**start of header
|
|
|
3 @setfilename ../../info/lispref.info
|
|
|
4 @c @smallbook
|
|
|
5 @settitle XEmacs Lisp Reference Manual
|
|
|
6 @c %**end of header
|
|
|
7
|
|
|
8 @ifinfo
|
|
|
9 @dircategory XEmacs Editor
|
|
|
10 @direntry
|
|
|
11 * Lispref: (lispref). XEmacs Lisp Reference Manual.
|
|
|
12 @end direntry
|
|
|
13
|
|
|
14 Edition History:
|
|
|
15
|
|
|
16 GNU Emacs Lisp Reference Manual Second Edition (v2.01), May 1993
|
|
|
17 GNU Emacs Lisp Reference Manual Further Revised (v2.02), August 1993
|
|
|
18 Lucid Emacs Lisp Reference Manual (for 19.10) First Edition, March 1994
|
|
|
19 XEmacs Lisp Programmer's Manual (for 19.12) Second Edition, April 1995
|
|
|
20 GNU Emacs Lisp Reference Manual v2.4, June 1995
|
|
|
21 XEmacs Lisp Programmer's Manual (for 19.13) Third Edition, July 1995
|
|
|
22 XEmacs Lisp Reference Manual (for 19.14 and 20.0) v3.1, March 1996
|
|
|
23 XEmacs Lisp Reference Manual (for 19.15 and 20.1, 20.2, 20.3) v3.2, April, May, November 1997
|
|
|
24 XEmacs Lisp Reference Manual (for 21.0) v3.3, April 1998
|
|
|
25 @c Please REMEMBER to update edition number in *four* places in this file
|
|
|
26 @c and also in *one* place in intro.texi
|
|
|
27
|
|
|
28 Copyright (C) 1990, 1991, 1992, 1993, 1994, 1995 Free Software Foundation, Inc.
|
|
|
29 Copyright (C) 1994, 1995 Sun Microsystems, Inc.
|
|
|
30 Copyright (C) 1995, 1996 Ben Wing.
|
|
|
31
|
|
|
32
|
|
|
33 Permission is granted to make and distribute verbatim copies of this
|
|
|
34 manual provided the copyright notice and this permission notice are
|
|
|
35 preserved on all copies.
|
|
|
36
|
|
|
37 @ignore
|
|
|
38 Permission is granted to process this file through TeX and print the
|
|
|
39 results, provided the printed document carries copying permission notice
|
|
|
40 identical to this one except for the removal of this paragraph (this
|
|
|
41 paragraph not being relevant to the printed manual).
|
|
|
42
|
|
|
43 @end ignore
|
|
|
44 Permission is granted to copy and distribute modified versions of this
|
|
|
45 manual under the conditions for verbatim copying, provided that the
|
|
|
46 entire resulting derived work is distributed under the terms of a
|
|
|
47 permission notice identical to this one.
|
|
|
48
|
|
|
49 Permission is granted to copy and distribute translations of this manual
|
|
|
50 into another language, under the above conditions for modified versions,
|
|
|
51 except that this permission notice may be stated in a translation
|
|
|
52 approved by the Foundation.
|
|
|
53
|
|
|
54 Permission is granted to copy and distribute modified versions of this
|
|
|
55 manual under the conditions for verbatim copying, provided also that the
|
|
|
56 section entitled ``GNU General Public License'' is included exactly as
|
|
|
57 in the original, and provided that the entire resulting derived work is
|
|
|
58 distributed under the terms of a permission notice identical to this
|
|
|
59 one.
|
|
|
60
|
|
|
61 Permission is granted to copy and distribute translations of this manual
|
|
|
62 into another language, under the above conditions for modified versions,
|
|
|
63 except that the section entitled ``GNU General Public License'' may be
|
|
|
64 included in a translation approved by the Free Software Foundation
|
|
|
65 instead of in the original English.
|
|
|
66 @end ifinfo
|
|
|
67
|
|
|
68 @c Combine indices.
|
|
|
69 @synindex cp fn
|
|
|
70 @syncodeindex vr fn
|
|
|
71 @syncodeindex ky fn
|
|
|
72 @syncodeindex pg fn
|
|
|
73 @syncodeindex tp fn
|
|
|
74
|
|
|
75 @setchapternewpage odd
|
|
|
76 @finalout
|
|
|
77
|
|
|
78 @titlepage
|
|
|
79 @title XEmacs Lisp Reference Manual
|
|
|
80 @c The edition number appears in several places in this file
|
|
|
81 @c and also in the file intro.texi.
|
|
|
82 @c This manual documents XEmacs 19.14 and 20.0 and was based on the
|
|
|
83 @c documentation for FSF Emacs 19.29 (v2.4).
|
|
|
84 @subtitle Version 3.3 (for XEmacs 21.0), April 1998
|
|
|
85
|
|
|
86 @author by Ben Wing
|
|
|
87 @author
|
|
|
88 @author Based on the GNU Emacs Lisp Reference Manual
|
|
|
89 @author by Bil Lewis, Dan LaLiberte, Richard Stallman
|
|
|
90 @author and the GNU Manual Group
|
|
|
91 @page
|
|
|
92 @vskip 0pt plus 1filll
|
|
|
93 Copyright @copyright{} 1990, 1991, 1992, 1993, 1994, 1995 Free Software Foundation, Inc.
|
|
|
94 Copyright @copyright{} 1994, 1995 Sun Microsystems, Inc.
|
|
|
95 Copyright @copyright{} 1995, 1996 Ben Wing.
|
|
|
96 @sp 2
|
|
|
97 Version 3.3 @*
|
|
|
98 Revised for XEmacs Versions 21.0,@*
|
|
|
99 April 1998.@*
|
|
|
100
|
|
|
101 Permission is granted to make and distribute verbatim copies of this
|
|
|
102 manual provided the copyright notice and this permission notice are
|
|
|
103 preserved on all copies.
|
|
|
104
|
|
|
105 Permission is granted to copy and distribute modified versions of this
|
|
|
106 manual under the conditions for verbatim copying, provided also that the
|
|
|
107 section entitled ``GNU General Public License'' is included
|
|
|
108 exactly as in the original, and provided that the entire resulting
|
|
|
109 derived work is distributed under the terms of a permission notice
|
|
|
110 identical to this one.
|
|
|
111
|
|
|
112 Permission is granted to copy and distribute translations of this manual
|
|
|
113 into another language, under the above conditions for modified versions,
|
|
|
114 except that the section entitled ``GNU General Public License'' may be
|
|
|
115 included in a translation approved by the Free Software Foundation
|
|
|
116 instead of in the original English.
|
|
|
117
|
|
|
118 Cover art by Etienne Suvasa.
|
|
|
119 @end titlepage
|
|
|
120 @page
|
|
|
121
|
|
|
122 @node Top, Copying, (dir), (dir)
|
|
|
123
|
|
|
124 @ifinfo
|
|
|
125 This Info file contains the third edition of the XEmacs Lisp
|
|
|
126 Reference Manual, corresponding to XEmacs version 21.0.
|
|
|
127 @end ifinfo
|
|
|
128
|
|
|
129 @menu
|
|
|
130 * Copying:: Conditions for copying and changing XEmacs.
|
|
|
131 * Introduction:: Introduction and conventions used.
|
|
|
132
|
|
693
|
133 * Packaging:: Lisp library administrative infrastructure.
|
|
|
134
|
|
428
|
135 * Lisp Data Types:: Data types of objects in XEmacs Lisp.
|
|
|
136 * Numbers:: Numbers and arithmetic functions.
|
|
|
137 * Strings and Characters:: Strings, and functions that work on them.
|
|
|
138 * Lists:: Lists, cons cells, and related functions.
|
|
|
139 * Sequences Arrays Vectors:: Lists, strings and vectors are called sequences.
|
|
|
140 Certain functions act on any kind of sequence.
|
|
|
141 The description of vectors is here as well.
|
|
|
142 * Symbols:: Symbols represent names, uniquely.
|
|
|
143
|
|
|
144 * Evaluation:: How Lisp expressions are evaluated.
|
|
|
145 * Control Structures:: Conditionals, loops, nonlocal exits.
|
|
|
146 * Variables:: Using symbols in programs to stand for values.
|
|
|
147 * Functions:: A function is a Lisp program
|
|
|
148 that can be invoked from other functions.
|
|
|
149 * Macros:: Macros are a way to extend the Lisp language.
|
|
|
150 * Customization:: Writing customization declarations.
|
|
|
151
|
|
|
152 * Loading:: Reading files of Lisp code into Lisp.
|
|
|
153 * Byte Compilation:: Compilation makes programs run faster.
|
|
|
154 * Debugging:: Tools and tips for debugging Lisp programs.
|
|
|
155
|
|
|
156 * Read and Print:: Converting Lisp objects to text and back.
|
|
|
157 * Minibuffers:: Using the minibuffer to read input.
|
|
|
158 * Command Loop:: How the editor command loop works,
|
|
|
159 and how you can call its subroutines.
|
|
|
160 * Keymaps:: Defining the bindings from keys to commands.
|
|
|
161 * Menus:: Defining pull-down and pop-up menus.
|
|
|
162 * Dialog Boxes:: Creating dialog boxes.
|
|
|
163 * Toolbar:: Controlling the toolbar.
|
|
442
|
164 * Gutter:: Controlling the gutter.
|
|
428
|
165 * Scrollbars:: Controlling the scrollbars.
|
|
|
166 * Drag and Drop:: Generic API to inter-application communication
|
|
|
167 via specific protocols.
|
|
|
168 * Modes:: Defining major and minor modes.
|
|
|
169 * Documentation:: Writing and using documentation strings.
|
|
|
170
|
|
|
171 * Files:: Accessing files.
|
|
|
172 * Backups and Auto-Saving:: Controlling how backups and auto-save
|
|
|
173 files are made.
|
|
|
174 * Buffers:: Creating and using buffer objects.
|
|
|
175 * Windows:: Manipulating windows and displaying buffers.
|
|
|
176 * Frames:: Making multiple X windows.
|
|
|
177 * Consoles and Devices:: Opening frames on multiple TTY's or X displays.
|
|
|
178 * Positions:: Buffer positions and motion functions.
|
|
|
179 * Markers:: Markers represent positions and update
|
|
|
180 automatically when the text is changed.
|
|
|
181
|
|
|
182 * Text:: Examining and changing text in buffers.
|
|
|
183 * Searching and Matching:: Searching buffers for strings or regexps.
|
|
|
184 * Syntax Tables:: The syntax table controls word and list parsing.
|
|
|
185 * Abbrevs:: How Abbrev mode works, and its data structures.
|
|
|
186
|
|
|
187 * Extents:: Extents are regions of text with particular
|
|
|
188 display characteristics.
|
|
|
189 * Specifiers:: How faces and glyphs are specified.
|
|
|
190 * Faces and Window-System Objects::
|
|
|
191 A face is a set of display characteristics
|
|
|
192 specifying how text is to be displayed.
|
|
|
193 * Glyphs:: General interface to pixmaps displayed in a
|
|
|
194 buffer or frame.
|
|
|
195 * Annotations:: Higher-level interface to glyphs in a buffer.
|
|
|
196 * Display:: Parameters controlling screen usage.
|
|
|
197 The bell. Waiting for input.
|
|
|
198
|
|
|
199 * Hash Tables:: Fast data structures for mappings.
|
|
|
200 * Range Tables:: Keeping track of ranges of numbers.
|
|
|
201 * Databases:: An interface to standard DBM and DB databases.
|
|
|
202
|
|
|
203 * Processes:: Running and communicating with subprocesses.
|
|
|
204 * System Interface:: Getting the user id, system type, environment
|
|
|
205 variables, and other such things.
|
|
|
206 * X-Windows:: Functions specific to the X Window System.
|
|
|
207 * ToolTalk Support:: Interfacing with the ToolTalk message service.
|
|
|
208 * LDAP Support:: Interfacing with the Lightweight Directory
|
|
|
209 Access Protocol.
|
|
442
|
210 * PostgreSQL Support:: Interfacing to the PostgreSQL libpq library.
|
|
428
|
211 * Internationalization:: How Emacs supports different languages and
|
|
|
212 cultural conventions.
|
|
|
213 * MULE:: Specifics of the Asian-language support.
|
|
|
214
|
|
|
215 Appendices
|
|
|
216
|
|
|
217 * Tips:: Advice for writing Lisp programs.
|
|
|
218 * Building XEmacs and Object Allocation::
|
|
|
219 Behind-the-scenes information about XEmacs.
|
|
|
220 * Standard Errors:: List of all error symbols.
|
|
|
221 * Standard Buffer-Local Variables:: List of variables local in all buffers.
|
|
|
222 * Standard Keymaps:: List of standard keymaps.
|
|
|
223 * Standard Hooks:: List of standard hook variables.
|
|
|
224
|
|
|
225 * Index:: Index including concepts, functions, variables,
|
|
|
226 and other terms.
|
|
|
227
|
|
|
228 --- The Detailed Node Listing ---
|
|
|
229
|
|
|
230 Here are other nodes that are inferiors of those already listed,
|
|
|
231 mentioned here so you can get to them in one step:
|
|
|
232
|
|
|
233 Introduction
|
|
|
234
|
|
|
235 * Caveats:: Flaws and a request for help.
|
|
|
236 * Lisp History:: XEmacs Lisp is descended from Maclisp.
|
|
|
237 * Conventions:: How the manual is formatted.
|
|
|
238 * Acknowledgements:: The authors, editors, and sponsors of this manual.
|
|
|
239
|
|
|
240 Conventions
|
|
|
241
|
|
|
242 * Some Terms:: Explanation of terms we use in this manual.
|
|
|
243 * nil and t:: How the symbols @code{nil} and @code{t} are used.
|
|
|
244 * Evaluation Notation:: The format we use for examples of evaluation.
|
|
|
245 * Printing Notation:: The format we use for examples that print output.
|
|
|
246 * Error Messages:: The format we use for examples of errors.
|
|
|
247 * Buffer Text Notation:: The format we use for buffer contents in examples.
|
|
|
248 * Format of Descriptions:: Notation for describing functions, variables, etc.
|
|
|
249
|
|
|
250 Format of Descriptions
|
|
|
251
|
|
444
|
252 * A Sample Function Description::
|
|
|
253 * A Sample Variable Description::
|
|
428
|
254
|
|
693
|
255 Packaging
|
|
|
256
|
|
|
257 * Package Overview:: Lisp Libraries and Packages.
|
|
|
258 * Package Terminology:: Basic stuff.
|
|
|
259 * Building Packages:: Turn packaged source into a tarball.
|
|
|
260 * Local.rules File:: Tell the XEmacs Packaging System about your host.
|
|
|
261 * Creating Packages:: Tell the XEmacs Packaging System about your package.
|
|
|
262 * Issues::
|
|
|
263
|
|
|
264 Package Overview
|
|
|
265
|
|
761
|
266 * The User View::
|
|
|
267 * The Library Maintainer View::
|
|
|
268 * The Package Release Engineer View::
|
|
693
|
269
|
|
|
270 The Library Maintainer's View
|
|
|
271
|
|
|
272 * Infrastructure:: Global Makefiles and common rules.
|
|
|
273 * Control Files:: Package-specific Makefiles and administrative files.
|
|
|
274 * Obtaining:: Obtaining the XEmacs Packaging System and utilities.
|
|
|
275
|
|
|
276 Creating Packages
|
|
|
277
|
|
1648
|
278 * package-info.in:: package-info.in
|
|
|
279 * Makefile:: @file{Makefile}
|
|
693
|
280 * Makefile Targets::
|
|
|
281
|
|
428
|
282 Lisp Data Types
|
|
|
283
|
|
|
284 * Printed Representation:: How Lisp objects are represented as text.
|
|
|
285 * Comments:: Comments and their formatting conventions.
|
|
|
286 * Programming Types:: Types found in all Lisp systems.
|
|
|
287 * Editing Types:: Types specific to XEmacs.
|
|
|
288 * Type Predicates:: Tests related to types.
|
|
|
289 * Equality Predicates:: Tests of equality between any two objects.
|
|
|
290
|
|
|
291 Programming Types
|
|
|
292
|
|
|
293 * Integer Type:: Numbers without fractional parts.
|
|
|
294 * Floating Point Type:: Numbers with fractional parts and with a large range.
|
|
|
295 * Character Type:: The representation of letters, numbers and
|
|
|
296 control characters.
|
|
|
297 * Sequence Type:: Both lists and arrays are classified as sequences.
|
|
|
298 * Cons Cell Type:: Cons cells, and lists (which are made from cons cells).
|
|
|
299 * Array Type:: Arrays include strings and vectors.
|
|
|
300 * String Type:: An (efficient) array of characters.
|
|
|
301 * Vector Type:: One-dimensional arrays.
|
|
|
302 * Symbol Type:: A multi-use object that refers to a function,
|
|
|
303 variable, property list, or itself.
|
|
|
304 * Function Type:: A piece of executable code you can call from elsewhere.
|
|
|
305 * Macro Type:: A method of expanding an expression into another
|
|
|
306 expression, more fundamental but less pretty.
|
|
|
307 * Primitive Function Type:: A function written in C, callable from Lisp.
|
|
|
308 * Compiled-Function Type:: A function written in Lisp, then compiled.
|
|
|
309 * Autoload Type:: A type used for automatically loading seldom-used
|
|
|
310 functions.
|
|
|
311
|
|
|
312 Cons Cell Type
|
|
|
313
|
|
|
314 * Dotted Pair Notation:: An alternative syntax for lists.
|
|
|
315 * Association List Type:: A specially constructed list.
|
|
|
316
|
|
|
317 Editing Types
|
|
|
318
|
|
|
319 * Buffer Type:: The basic object of editing.
|
|
|
320 * Window Type:: What makes buffers visible.
|
|
440
|
321 * Window Configuration Type:: Save what the screen looks like.
|
|
428
|
322 * Marker Type:: A position in a buffer.
|
|
|
323 * Process Type:: A process running on the underlying OS.
|
|
|
324 * Stream Type:: Receive or send characters.
|
|
|
325 * Keymap Type:: What function a keystroke invokes.
|
|
|
326 * Syntax Table Type:: What a character means.
|
|
|
327
|
|
|
328 Numbers
|
|
|
329
|
|
|
330 * Integer Basics:: Representation and range of integers.
|
|
2028
|
331 * Ratio Basics:: Representation and range of rational numbers.
|
|
428
|
332 * Float Basics:: Representation and range of floating point.
|
|
2028
|
333 * The Bignum Extension:: Arbitrary precision integers, ratios, and floats.
|
|
428
|
334 * Predicates on Numbers:: Testing for numbers.
|
|
|
335 * Comparison of Numbers:: Equality and inequality predicates.
|
|
|
336 * Arithmetic Operations:: How to add, subtract, multiply and divide.
|
|
|
337 * Bitwise Operations:: Logical and, or, not, shifting.
|
|
|
338 * Numeric Conversions:: Converting float to integer and vice versa.
|
|
|
339 * Math Functions:: Trig, exponential and logarithmic functions.
|
|
|
340 * Random Numbers:: Obtaining random integers, predictable or not.
|
|
|
341
|
|
|
342 Strings and Characters
|
|
|
343
|
|
440
|
344 * String Basics:: Basic properties of strings and characters.
|
|
428
|
345 * Predicates for Strings:: Testing whether an object is a string or char.
|
|
|
346 * Creating Strings:: Functions to allocate new strings.
|
|
|
347 * Predicates for Characters:: Testing whether an object is a character.
|
|
|
348 * Character Codes:: Each character has an equivalent integer.
|
|
|
349 * Text Comparison:: Comparing characters or strings.
|
|
|
350 * String Conversion:: Converting characters or strings and vice versa.
|
|
|
351 * Modifying Strings:: Changing characters in a string.
|
|
|
352 * String Properties:: Additional information attached to strings.
|
|
|
353 * Formatting Strings:: @code{format}: XEmacs's analog of @code{printf}.
|
|
|
354 * Character Case:: Case conversion functions.
|
|
|
355 * Char Tables:: Mapping from characters to Lisp objects.
|
|
|
356 * Case Tables:: Customizing case conversion.
|
|
|
357
|
|
|
358 Lists
|
|
|
359
|
|
|
360 * Cons Cells:: How lists are made out of cons cells.
|
|
|
361 * Lists as Boxes:: Graphical notation to explain lists.
|
|
|
362 * List-related Predicates:: Is this object a list? Comparing two lists.
|
|
|
363 * List Elements:: Extracting the pieces of a list.
|
|
|
364 * Building Lists:: Creating list structure.
|
|
|
365 * Modifying Lists:: Storing new pieces into an existing list.
|
|
|
366 * Sets And Lists:: A list can represent a finite mathematical set.
|
|
|
367 * Association Lists:: A list can represent a finite relation or mapping.
|
|
|
368 * Property Lists:: A different way to represent a finite mapping.
|
|
|
369 * Weak Lists:: A list with special garbage-collection behavior.
|
|
|
370
|
|
|
371 Modifying Existing List Structure
|
|
|
372
|
|
|
373 * Setcar:: Replacing an element in a list.
|
|
|
374 * Setcdr:: Replacing part of the list backbone.
|
|
|
375 This can be used to remove or add elements.
|
|
|
376 * Rearrangement:: Reordering the elements in a list; combining lists.
|
|
|
377
|
|
|
378 Sequences, Arrays, and Vectors
|
|
|
379
|
|
|
380 * Sequence Functions:: Functions that accept any kind of sequence.
|
|
|
381 * Arrays:: Characteristics of arrays in XEmacs Lisp.
|
|
|
382 * Array Functions:: Functions specifically for arrays.
|
|
|
383 * Vectors:: Functions specifically for vectors.
|
|
|
384
|
|
|
385 Symbols
|
|
|
386
|
|
|
387 * Symbol Components:: Symbols have names, values, function definitions
|
|
|
388 and property lists.
|
|
|
389 * Definitions:: A definition says how a symbol will be used.
|
|
|
390 * Creating Symbols:: How symbols are kept unique.
|
|
|
391 * Symbol Properties:: Each symbol has a property list
|
|
|
392 for recording miscellaneous information.
|
|
|
393
|
|
|
394 Evaluation
|
|
|
395
|
|
|
396 * Intro Eval:: Evaluation in the scheme of things.
|
|
|
397 * Eval:: How to invoke the Lisp interpreter explicitly.
|
|
|
398 * Forms:: How various sorts of objects are evaluated.
|
|
444
|
399 * Quoting:: Avoiding evaluation (to put constants in
|
|
428
|
400 the program).
|
|
|
401
|
|
|
402 Kinds of Forms
|
|
|
403
|
|
|
404 * Self-Evaluating Forms:: Forms that evaluate to themselves.
|
|
|
405 * Symbol Forms:: Symbols evaluate as variables.
|
|
|
406 * Classifying Lists:: How to distinguish various sorts of list forms.
|
|
|
407 * Function Forms:: Forms that call functions.
|
|
|
408 * Macro Forms:: Forms that call macros.
|
|
|
409 * Special Forms:: ``Special forms'' are idiosyncratic primitives,
|
|
|
410 most of them extremely important.
|
|
|
411 * Autoloading:: Functions set up to load files
|
|
|
412 containing their real definitions.
|
|
|
413
|
|
|
414 Control Structures
|
|
|
415
|
|
|
416 * Sequencing:: Evaluation in textual order.
|
|
|
417 * Conditionals:: @code{if}, @code{cond}.
|
|
|
418 * Combining Conditions:: @code{and}, @code{or}, @code{not}.
|
|
|
419 * Iteration:: @code{while} loops.
|
|
|
420 * Nonlocal Exits:: Jumping out of a sequence.
|
|
|
421
|
|
|
422 Nonlocal Exits
|
|
|
423
|
|
|
424 * Catch and Throw:: Nonlocal exits for the program's own purposes.
|
|
|
425 * Examples of Catch:: Showing how such nonlocal exits can be written.
|
|
|
426 * Errors:: How errors are signaled and handled.
|
|
|
427 * Cleanups:: Arranging to run a cleanup form if an
|
|
|
428 error happens.
|
|
|
429
|
|
|
430 Errors
|
|
|
431
|
|
|
432 * Signaling Errors:: How to report an error.
|
|
|
433 * Processing of Errors:: What XEmacs does when you report an error.
|
|
|
434 * Handling Errors:: How you can trap errors and continue execution.
|
|
|
435 * Error Symbols:: How errors are classified for trapping them.
|
|
|
436
|
|
|
437 Variables
|
|
|
438
|
|
|
439 * Global Variables:: Variable values that exist permanently, everywhere.
|
|
|
440 * Constant Variables:: Certain "variables" have values that never change.
|
|
|
441 * Local Variables:: Variable values that exist only temporarily.
|
|
|
442 * Void Variables:: Symbols that lack values.
|
|
|
443 * Defining Variables:: A definition says a symbol is used as a variable.
|
|
|
444 * Accessing Variables:: Examining values of variables whose names
|
|
|
445 are known only at run time.
|
|
|
446 * Setting Variables:: Storing new values in variables.
|
|
|
447 * Variable Scoping:: How Lisp chooses among local and global values.
|
|
|
448 * Buffer-Local Variables:: Variable values in effect only in one buffer.
|
|
|
449
|
|
|
450 Scoping Rules for Variable Bindings
|
|
|
451
|
|
444
|
452 * Scope:: Scope means where in the program a value
|
|
428
|
453 is visible. Comparison with other languages.
|
|
|
454 * Extent:: Extent means how long in time a value exists.
|
|
|
455 * Impl of Scope:: Two ways to implement dynamic scoping.
|
|
444
|
456 * Using Scoping:: How to use dynamic scoping carefully and
|
|
428
|
457 avoid problems.
|
|
|
458
|
|
|
459 Buffer-Local Variables
|
|
|
460
|
|
|
461 * Intro to Buffer-Local:: Introduction and concepts.
|
|
|
462 * Creating Buffer-Local:: Creating and destroying buffer-local bindings.
|
|
|
463 * Default Value:: The default value is seen in buffers
|
|
|
464 that don't have their own local values.
|
|
|
465
|
|
|
466 Functions
|
|
|
467
|
|
|
468 * What Is a Function:: Lisp functions vs primitives; terminology.
|
|
|
469 * Lambda Expressions:: How functions are expressed as Lisp objects.
|
|
|
470 * Function Names:: A symbol can serve as the name of a function.
|
|
|
471 * Defining Functions:: Lisp expressions for defining functions.
|
|
|
472 * Calling Functions:: How to use an existing function.
|
|
|
473 * Mapping Functions:: Applying a function to each element of a list, etc.
|
|
444
|
474 * Anonymous Functions:: Lambda-expressions are functions with no names.
|
|
428
|
475 * Function Cells:: Accessing or setting the function definition
|
|
|
476 of a symbol.
|
|
|
477 * Related Topics:: Cross-references to specific Lisp primitives
|
|
444
|
478 that have a special bearing on how
|
|
428
|
479 functions work.
|
|
|
480
|
|
|
481 Lambda Expressions
|
|
|
482
|
|
|
483 * Lambda Components:: The parts of a lambda expression.
|
|
|
484 * Simple Lambda:: A simple example.
|
|
|
485 * Argument List:: Details and special features of argument lists.
|
|
|
486 * Function Documentation:: How to put documentation in a function.
|
|
|
487
|
|
|
488 Macros
|
|
|
489
|
|
|
490 * Simple Macro:: A basic example.
|
|
|
491 * Expansion:: How, when and why macros are expanded.
|
|
|
492 * Compiling Macros:: How macros are expanded by the compiler.
|
|
|
493 * Defining Macros:: How to write a macro definition.
|
|
|
494 * Backquote:: Easier construction of list structure.
|
|
|
495 * Problems with Macros:: Don't evaluate the macro arguments too many times.
|
|
|
496 Don't hide the user's variables.
|
|
|
497
|
|
|
498 Loading
|
|
|
499
|
|
|
500 * How Programs Do Loading:: The @code{load} function and others.
|
|
|
501 * Autoload:: Setting up a function to autoload.
|
|
|
502 * Named Features:: Loading a library if it isn't already loaded.
|
|
|
503 * Repeated Loading:: Precautions about loading a file twice.
|
|
|
504
|
|
|
505 Byte Compilation
|
|
|
506
|
|
446
|
507 * Speed of Byte-Code:: An example of speedup from byte compilation.
|
|
|
508 * Compilation Functions:: Byte compilation functions.
|
|
|
509 * Docs and Compilation:: Dynamic loading of documentation strings.
|
|
|
510 * Dynamic Loading:: Dynamic loading of individual functions.
|
|
|
511 * Eval During Compile:: Code to be evaluated when you compile.
|
|
|
512 * Compiled-Function Objects:: The data type used for byte-compiled functions.
|
|
|
513 * Disassembly:: Disassembling byte-code; how to read byte-code.
|
|
|
514 * Different Behavior:: When compiled code gives different results.
|
|
428
|
515
|
|
|
516 Debugging Lisp Programs
|
|
|
517
|
|
|
518 * Debugger:: How the XEmacs Lisp debugger is implemented.
|
|
|
519 * Syntax Errors:: How to find syntax errors.
|
|
444
|
520 * Compilation Errors:: How to find errors that show up in
|
|
428
|
521 byte compilation.
|
|
|
522 * Edebug:: A source-level XEmacs Lisp debugger.
|
|
444
|
523
|
|
428
|
524 The Lisp Debugger
|
|
|
525
|
|
|
526 * Error Debugging:: Entering the debugger when an error happens.
|
|
|
527 * Function Debugging:: Entering it when a certain function is called.
|
|
|
528 * Explicit Debug:: Entering it at a certain point in the program.
|
|
|
529 * Using Debugger:: What the debugger does; what you see while in it.
|
|
|
530 * Debugger Commands:: Commands used while in the debugger.
|
|
|
531 * Invoking the Debugger:: How to call the function @code{debug}.
|
|
|
532 * Internals of Debugger:: Subroutines of the debugger, and global variables.
|
|
|
533
|
|
|
534 Debugging Invalid Lisp Syntax
|
|
|
535
|
|
|
536 * Excess Open:: How to find a spurious open paren or missing close.
|
|
|
537 * Excess Close:: How to find a spurious close paren or missing open.
|
|
|
538
|
|
|
539 Reading and Printing Lisp Objects
|
|
|
540
|
|
|
541 * Streams Intro:: Overview of streams, reading and printing.
|
|
444
|
542 * Input Streams:: Various data types that can be used as
|
|
428
|
543 input streams.
|
|
|
544 * Input Functions:: Functions to read Lisp objects from text.
|
|
444
|
545 * Output Streams:: Various data types that can be used as
|
|
428
|
546 output streams.
|
|
|
547 * Output Functions:: Functions to print Lisp objects as text.
|
|
|
548
|
|
|
549 Minibuffers
|
|
|
550
|
|
|
551 * Intro to Minibuffers:: Basic information about minibuffers.
|
|
|
552 * Text from Minibuffer:: How to read a straight text string.
|
|
|
553 * Object from Minibuffer:: How to read a Lisp object or expression.
|
|
|
554 * Completion:: How to invoke and customize completion.
|
|
|
555 * Yes-or-No Queries:: Asking a question with a simple answer.
|
|
|
556 * Minibuffer Misc:: Various customization hooks and variables.
|
|
|
557
|
|
|
558 Completion
|
|
|
559
|
|
|
560 * Basic Completion:: Low-level functions for completing strings.
|
|
|
561 (These are too low level to use the minibuffer.)
|
|
|
562 * Minibuffer Completion:: Invoking the minibuffer with completion.
|
|
|
563 * Completion Commands:: Minibuffer commands that do completion.
|
|
|
564 * High-Level Completion:: Convenient special cases of completion
|
|
|
565 (reading buffer name, file name, etc.)
|
|
|
566 * Reading File Names:: Using completion to read file names.
|
|
|
567 * Programmed Completion:: Finding the completions for a given file name.
|
|
|
568
|
|
|
569 Command Loop
|
|
|
570
|
|
|
571 * Command Overview:: How the command loop reads commands.
|
|
|
572 * Defining Commands:: Specifying how a function should read arguments.
|
|
|
573 * Interactive Call:: Calling a command, so that it will read arguments.
|
|
|
574 * Command Loop Info:: Variables set by the command loop for you to examine.
|
|
|
575 * Events:: What input looks like when you read it.
|
|
|
576 * Reading Input:: How to read input events from the keyboard or mouse.
|
|
|
577 * Waiting:: Waiting for user input or elapsed time.
|
|
|
578 * Quitting:: How @kbd{C-g} works. How to catch or defer quitting.
|
|
|
579 * Prefix Command Arguments:: How the commands to set prefix args work.
|
|
|
580 * Recursive Editing:: Entering a recursive edit,
|
|
|
581 and why you usually shouldn't.
|
|
|
582 * Disabling Commands:: How the command loop handles disabled commands.
|
|
|
583 * Command History:: How the command history is set up, and how accessed.
|
|
|
584 * Keyboard Macros:: How keyboard macros are implemented.
|
|
|
585
|
|
|
586 Defining Commands
|
|
|
587
|
|
|
588 * Using Interactive:: General rules for @code{interactive}.
|
|
|
589 * Interactive Codes:: The standard letter-codes for reading arguments
|
|
|
590 in various ways.
|
|
|
591 * Interactive Examples:: Examples of how to read interactive arguments.
|
|
|
592
|
|
|
593 Events
|
|
|
594
|
|
|
595 * Event Types:: Events come in different types.
|
|
|
596 * Event Contents:: What the contents of each event type are.
|
|
|
597 * Event Predicates:: Querying whether an event is of a
|
|
|
598 particular type.
|
|
|
599 * Accessing Mouse Event Positions::
|
|
|
600 Determining where a mouse event occurred,
|
|
|
601 and over what.
|
|
|
602 * Accessing Other Event Info:: Accessing non-positional event info.
|
|
|
603 * Working With Events:: Creating, copying, and destroying events.
|
|
|
604 * Converting Events:: Converting between events, keys, and
|
|
|
605 characters.
|
|
|
606
|
|
|
607 Accessing Mouse Event Positions
|
|
|
608
|
|
|
609 * Frame-Level Event Position Info::
|
|
|
610 * Window-Level Event Position Info::
|
|
|
611 * Event Text Position Info::
|
|
|
612 * Event Glyph Position Info::
|
|
|
613 * Event Toolbar Position Info::
|
|
|
614 * Other Event Position Info::
|
|
|
615
|
|
|
616 Reading Input
|
|
|
617
|
|
|
618 * Key Sequence Input:: How to read one key sequence.
|
|
|
619 * Reading One Event:: How to read just one event.
|
|
|
620 * Dispatching an Event:: What to do with an event once it has been read.
|
|
|
621 * Quoted Character Input:: Asking the user to specify a character.
|
|
|
622 * Peeking and Discarding:: How to reread or throw away input events.
|
|
|
623
|
|
|
624 Keymaps
|
|
|
625
|
|
|
626 * Keymap Terminology:: Definitions of terms pertaining to keymaps.
|
|
|
627 * Format of Keymaps:: What a keymap looks like as a Lisp object.
|
|
|
628 * Creating Keymaps:: Functions to create and copy keymaps.
|
|
|
629 * Inheritance and Keymaps:: How one keymap can inherit the bindings
|
|
|
630 of another keymap.
|
|
|
631 * Key Sequences:: How to specify key sequences.
|
|
|
632 * Prefix Keys:: Defining a key with a keymap as its definition.
|
|
|
633 * Active Keymaps:: Each buffer has a local keymap
|
|
|
634 to override the standard (global) bindings.
|
|
|
635 Each minor mode can also override them.
|
|
|
636 * Key Lookup:: How extracting elements from keymaps works.
|
|
|
637 * Functions for Key Lookup:: How to request key lookup.
|
|
|
638 * Changing Key Bindings:: Redefining a key in a keymap.
|
|
|
639 * Key Binding Commands:: Interactive interfaces for redefining keys.
|
|
|
640 * Scanning Keymaps:: Looking through all keymaps, for printing help.
|
|
|
641 * Other Keymap Functions:: Miscellaneous keymap functions.
|
|
|
642
|
|
|
643 Menus
|
|
|
644
|
|
|
645 * Menu Format:: Format of a menu description.
|
|
|
646 * Menubar Format:: How to specify a menubar.
|
|
|
647 * Menubar:: Functions for controlling the menubar.
|
|
|
648 * Modifying Menus:: Modifying a menu description.
|
|
|
649 * Pop-Up Menus:: Functions for specifying pop-up menus.
|
|
|
650 * Menu Filters:: Filter functions for the default menubar.
|
|
|
651 * Buffers Menu:: The menu that displays the list of buffers.
|
|
|
652
|
|
|
653 Dialog Boxes
|
|
|
654
|
|
|
655 * Dialog Box Format::
|
|
|
656 * Dialog Box Functions::
|
|
|
657
|
|
|
658 Toolbar
|
|
|
659
|
|
|
660 * Toolbar Intro:: An introduction.
|
|
|
661 * Toolbar Descriptor Format:: How to create a toolbar.
|
|
|
662 * Specifying the Toolbar:: Setting a toolbar.
|
|
|
663 * Other Toolbar Variables:: Controlling the size of toolbars.
|
|
|
664
|
|
442
|
665 Gutter
|
|
|
666
|
|
428
|
667 Scrollbars
|
|
|
668
|
|
|
669 Major and Minor Modes
|
|
|
670
|
|
|
671 * Major Modes:: Defining major modes.
|
|
|
672 * Minor Modes:: Defining minor modes.
|
|
|
673 * Modeline Format:: Customizing the text that appears in the modeline.
|
|
444
|
674 * Hooks:: How to use hooks; how to write code that
|
|
428
|
675 provides hooks.
|
|
|
676
|
|
|
677 Major Modes
|
|
|
678
|
|
|
679 * Major Mode Conventions:: Coding conventions for keymaps, etc.
|
|
|
680 * Example Major Modes:: Text mode and Lisp modes.
|
|
|
681 * Auto Major Mode:: How XEmacs chooses the major mode automatically.
|
|
|
682 * Mode Help:: Finding out how to use a mode.
|
|
|
683
|
|
|
684 Minor Modes
|
|
|
685
|
|
|
686 * Minor Mode Conventions:: Tips for writing a minor mode.
|
|
|
687 * Keymaps and Minor Modes:: How a minor mode can have its own keymap.
|
|
|
688
|
|
|
689 Modeline Format
|
|
|
690
|
|
|
691 * Modeline Data:: The data structure that controls the modeline.
|
|
|
692 * Modeline Variables:: Variables used in that data structure.
|
|
|
693 * %-Constructs:: Putting information into a modeline.
|
|
|
694
|
|
|
695 Documentation
|
|
|
696
|
|
|
697 * Documentation Basics:: Good style for doc strings.
|
|
|
698 Where to put them. How XEmacs stores them.
|
|
|
699 * Accessing Documentation:: How Lisp programs can access doc strings.
|
|
|
700 * Keys in Documentation:: Substituting current key bindings.
|
|
|
701 * Describing Characters:: Making printable descriptions of
|
|
|
702 non-printing characters and key sequences.
|
|
|
703 * Help Functions:: Subroutines used by XEmacs help facilities.
|
|
|
704
|
|
|
705 Files
|
|
|
706
|
|
|
707 * Visiting Files:: Reading files into Emacs buffers for editing.
|
|
|
708 * Saving Buffers:: Writing changed buffers back into files.
|
|
|
709 * Reading from Files:: Reading files into other buffers.
|
|
|
710 * Writing to Files:: Writing new files from parts of buffers.
|
|
|
711 * File Locks:: Locking and unlocking files, to prevent
|
|
|
712 simultaneous editing by two people.
|
|
|
713 * Information about Files:: Testing existence, accessibility, size of files.
|
|
|
714 * Contents of Directories:: Getting a list of the files in a directory.
|
|
|
715 * Changing File Attributes:: Renaming files, changing protection, etc.
|
|
|
716 * File Names:: Decomposing and expanding file names.
|
|
|
717
|
|
|
718 Visiting Files
|
|
|
719
|
|
|
720 * Visiting Functions:: The usual interface functions for visiting.
|
|
|
721 * Subroutines of Visiting:: Lower-level subroutines that they use.
|
|
|
722
|
|
|
723 Information about Files
|
|
|
724
|
|
|
725 * Testing Accessibility:: Is a given file readable? Writable?
|
|
|
726 * Kinds of Files:: Is it a directory? A link?
|
|
|
727 * File Attributes:: How large is it? Any other names? Etc.
|
|
|
728
|
|
|
729 File Names
|
|
|
730
|
|
|
731 * File Name Components:: The directory part of a file name, and the rest.
|
|
|
732 * Directory Names:: A directory's name as a directory
|
|
|
733 is different from its name as a file.
|
|
444
|
734 * Relative File Names:: Some file names are relative to a
|
|
428
|
735 current directory.
|
|
|
736 * File Name Expansion:: Converting relative file names to absolute ones.
|
|
|
737 * Unique File Names:: Generating names for temporary files.
|
|
|
738 * File Name Completion:: Finding the completions for a given file name.
|
|
|
739
|
|
|
740 Backups and Auto-Saving
|
|
|
741
|
|
444
|
742 * Backup Files:: How backup files are made; how their names
|
|
428
|
743 are chosen.
|
|
|
744 * Auto-Saving:: How auto-save files are made; how their
|
|
|
745 names are chosen.
|
|
444
|
746 * Reverting:: @code{revert-buffer}, and how to customize
|
|
428
|
747 what it does.
|
|
|
748
|
|
|
749 Backup Files
|
|
|
750
|
|
|
751 * Making Backups:: How XEmacs makes backup files, and when.
|
|
444
|
752 * Rename or Copy:: Two alternatives: renaming the old file
|
|
428
|
753 or copying it.
|
|
|
754 * Numbered Backups:: Keeping multiple backups for each source file.
|
|
|
755 * Backup Names:: How backup file names are computed; customization.
|
|
|
756
|
|
|
757 Buffers
|
|
|
758
|
|
|
759 * Buffer Basics:: What is a buffer?
|
|
|
760 * Buffer Names:: Accessing and changing buffer names.
|
|
|
761 * Buffer File Name:: The buffer file name indicates which file
|
|
|
762 is visited.
|
|
|
763 * Buffer Modification:: A buffer is @dfn{modified} if it needs to be saved.
|
|
|
764 * Modification Time:: Determining whether the visited file was changed
|
|
|
765 ``behind XEmacs's back''.
|
|
|
766 * Read Only Buffers:: Modifying text is not allowed in a
|
|
|
767 read-only buffer.
|
|
|
768 * The Buffer List:: How to look at all the existing buffers.
|
|
|
769 * Creating Buffers:: Functions that create buffers.
|
|
|
770 * Killing Buffers:: Buffers exist until explicitly killed.
|
|
|
771 * Current Buffer:: Designating a buffer as current
|
|
|
772 so primitives will access its contents.
|
|
|
773
|
|
|
774 Windows
|
|
|
775
|
|
|
776 * Basic Windows:: Basic information on using windows.
|
|
|
777 * Splitting Windows:: Splitting one window into two windows.
|
|
|
778 * Deleting Windows:: Deleting a window gives its space to other windows.
|
|
|
779 * Selecting Windows:: The selected window is the one that you edit in.
|
|
|
780 * Cyclic Window Ordering:: Moving around the existing windows.
|
|
|
781 * Buffers and Windows:: Each window displays the contents of a buffer.
|
|
|
782 * Displaying Buffers:: Higher-lever functions for displaying a buffer
|
|
|
783 and choosing a window for it.
|
|
|
784 * Window Point:: Each window has its own location of point.
|
|
|
785 * Window Start:: The display-start position controls which text
|
|
444
|
786 is on-screen in the window.
|
|
428
|
787 * Vertical Scrolling:: Moving text up and down in the window.
|
|
|
788 * Horizontal Scrolling:: Moving text sideways on the window.
|
|
|
789 * Size of Window:: Accessing the size of a window.
|
|
|
790 * Resizing Windows:: Changing the size of a window.
|
|
|
791 * Window Configurations:: Saving and restoring the state of the screen.
|
|
|
792
|
|
|
793 Frames
|
|
|
794
|
|
|
795 * Creating Frames:: Creating additional frames.
|
|
|
796 * Frame Properties:: Controlling frame size, position, font, etc.
|
|
|
797 * Frame Titles:: Automatic updating of frame titles.
|
|
|
798 * Deleting Frames:: Frames last until explicitly deleted.
|
|
|
799 * Finding All Frames:: How to examine all existing frames.
|
|
|
800 * Frames and Windows:: A frame contains windows;
|
|
|
801 display of text always works through windows.
|
|
|
802 * Minibuffers and Frames:: How a frame finds the minibuffer to use.
|
|
|
803 * Input Focus:: Specifying the selected frame.
|
|
|
804 * Visibility of Frames:: Frames may be visible or invisible, or icons.
|
|
|
805 * Raising and Lowering:: Raising a frame makes it hide other X windows;
|
|
|
806 lowering it makes the others hide them.
|
|
|
807 * Frame Hooks:: Hooks for customizing frame behavior.
|
|
|
808
|
|
|
809 Positions
|
|
|
810
|
|
|
811 * Point:: The special position where editing takes place.
|
|
|
812 * Motion:: Changing point.
|
|
|
813 * Excursions:: Temporary motion and buffer changes.
|
|
|
814 * Narrowing:: Restricting editing to a portion of the buffer.
|
|
|
815
|
|
|
816 Motion
|
|
|
817
|
|
|
818 * Character Motion:: Moving in terms of characters.
|
|
|
819 * Word Motion:: Moving in terms of words.
|
|
|
820 * Buffer End Motion:: Moving to the beginning or end of the buffer.
|
|
|
821 * Text Lines:: Moving in terms of lines of text.
|
|
|
822 * Screen Lines:: Moving in terms of lines as displayed.
|
|
|
823 * List Motion:: Moving by parsing lists and sexps.
|
|
|
824 * Skipping Characters:: Skipping characters belonging to a certain set.
|
|
|
825
|
|
|
826 Markers
|
|
|
827
|
|
|
828 * Overview of Markers:: The components of a marker, and how it relocates.
|
|
|
829 * Predicates on Markers:: Testing whether an object is a marker.
|
|
|
830 * Creating Markers:: Making empty markers or markers at certain places.
|
|
|
831 * Information from Markers:: Finding the marker's buffer or character
|
|
444
|
832 position.
|
|
428
|
833 * Changing Markers:: Moving the marker to a new buffer or position.
|
|
|
834 * The Mark:: How ``the mark'' is implemented with a marker.
|
|
|
835 * The Region:: How to access ``the region''.
|
|
|
836
|
|
|
837 Text
|
|
|
838
|
|
|
839 * Near Point:: Examining text in the vicinity of point.
|
|
|
840 * Buffer Contents:: Examining text in a general fashion.
|
|
|
841 * Comparing Text:: Comparing substrings of buffers.
|
|
|
842 * Insertion:: Adding new text to a buffer.
|
|
|
843 * Commands for Insertion:: User-level commands to insert text.
|
|
|
844 * Deletion:: Removing text from a buffer.
|
|
|
845 * User-Level Deletion:: User-level commands to delete text.
|
|
|
846 * The Kill Ring:: Where removed text sometimes is saved for later use.
|
|
|
847 * Undo:: Undoing changes to the text of a buffer.
|
|
|
848 * Maintaining Undo:: How to enable and disable undo information.
|
|
|
849 How to control how much information is kept.
|
|
|
850 * Filling:: Functions for explicit filling.
|
|
|
851 * Margins:: How to specify margins for filling commands.
|
|
|
852 * Auto Filling:: How auto-fill mode is implemented to break lines.
|
|
|
853 * Sorting:: Functions for sorting parts of the buffer.
|
|
|
854 * Columns:: Computing horizontal positions, and using them.
|
|
|
855 * Indentation:: Functions to insert or adjust indentation.
|
|
|
856 * Case Changes:: Case conversion of parts of the buffer.
|
|
|
857 * Text Properties:: Assigning Lisp property lists to text characters.
|
|
|
858 * Substitution:: Replacing a given character wherever it appears.
|
|
|
859 * Registers:: How registers are implemented. Accessing the text or
|
|
|
860 position stored in a register.
|
|
|
861 * Transposition:: Swapping two portions of a buffer.
|
|
|
862 * Change Hooks:: Supplying functions to be run when text is changed.
|
|
444
|
863
|
|
428
|
864 The Kill Ring
|
|
|
865
|
|
|
866 * Kill Ring Concepts:: What text looks like in the kill ring.
|
|
|
867 * Kill Functions:: Functions that kill text.
|
|
|
868 * Yank Commands:: Commands that access the kill ring.
|
|
|
869 * Low-Level Kill Ring:: Functions and variables for kill ring access.
|
|
|
870 * Internals of Kill Ring:: Variables that hold kill-ring data.
|
|
|
871
|
|
|
872 Indentation
|
|
|
873
|
|
|
874 * Primitive Indent:: Functions used to count and insert indentation.
|
|
|
875 * Mode-Specific Indent:: Customize indentation for different modes.
|
|
|
876 * Region Indent:: Indent all the lines in a region.
|
|
|
877 * Relative Indent:: Indent the current line based on previous lines.
|
|
|
878 * Indent Tabs:: Adjustable, typewriter-like tab stops.
|
|
|
879 * Motion by Indent:: Move to first non-blank character.
|
|
|
880
|
|
|
881 Searching and Matching
|
|
|
882
|
|
|
883 * String Search:: Search for an exact match.
|
|
|
884 * Regular Expressions:: Describing classes of strings.
|
|
|
885 * Regexp Search:: Searching for a match for a regexp.
|
|
|
886 * Match Data:: Finding out which part of the text matched
|
|
|
887 various parts of a regexp, after regexp search.
|
|
|
888 * Saving Match Data:: Saving and restoring this information.
|
|
|
889 * Standard Regexps:: Useful regexps for finding sentences, pages,...
|
|
|
890 * Searching and Case:: Case-independent or case-significant searching.
|
|
|
891
|
|
|
892 Regular Expressions
|
|
|
893
|
|
|
894 * Syntax of Regexps:: Rules for writing regular expressions.
|
|
|
895 * Regexp Example:: Illustrates regular expression syntax.
|
|
|
896
|
|
|
897 Syntax Tables
|
|
|
898
|
|
|
899 * Syntax Descriptors:: How characters are classified.
|
|
|
900 * Syntax Table Functions:: How to create, examine and alter syntax tables.
|
|
|
901 * Parsing Expressions:: Parsing balanced expressions
|
|
|
902 using the syntax table.
|
|
|
903 * Standard Syntax Tables:: Syntax tables used by various major modes.
|
|
|
904 * Syntax Table Internals:: How syntax table information is stored.
|
|
|
905
|
|
|
906 Syntax Descriptors
|
|
|
907
|
|
|
908 * Syntax Class Table:: Table of syntax classes.
|
|
|
909 * Syntax Flags:: Additional flags each character can have.
|
|
|
910
|
|
|
911 Abbrevs And Abbrev Expansion
|
|
|
912
|
|
|
913 * Abbrev Mode:: Setting up XEmacs for abbreviation.
|
|
|
914 * Tables: Abbrev Tables. Creating and working with abbrev tables.
|
|
|
915 * Defining Abbrevs:: Specifying abbreviations and their expansions.
|
|
|
916 * Files: Abbrev Files. Saving abbrevs in files.
|
|
|
917 * Expansion: Abbrev Expansion. Controlling expansion; expansion subroutines.
|
|
|
918 * Standard Abbrev Tables:: Abbrev tables used by various major modes.
|
|
|
919
|
|
|
920 Extents
|
|
|
921
|
|
|
922 * Intro to Extents:: Extents are regions over a buffer or string.
|
|
|
923 * Creating and Modifying Extents::
|
|
|
924 Basic extent functions.
|
|
|
925 * Extent Endpoints:: Accessing and setting the bounds of an extent.
|
|
|
926 * Finding Extents:: Determining which extents are in an object.
|
|
|
927 * Mapping Over Extents:: More sophisticated functions for extent scanning.
|
|
|
928 * Extent Properties:: Extents have built-in and user-definable properties.
|
|
|
929 * Detached Extents:: Extents that are not in a buffer.
|
|
|
930 * Extent Parents:: Inheriting properties from another extent.
|
|
|
931 * Duplicable Extents:: Extents can be marked to be copied into strings.
|
|
|
932 * Extents and Events:: Extents can interact with the keyboard and mouse.
|
|
|
933 * Atomic Extents:: Treating a block of text as a single entity.
|
|
|
934
|
|
|
935 Specifiers
|
|
|
936
|
|
|
937 * Introduction to Specifiers:: Specifiers provide a clean way for
|
|
|
938 display and other properties to vary
|
|
|
939 (under user control) in a wide variety
|
|
|
940 of contexts.
|
|
|
941 * Specifiers In-Depth:: Gory details about specifier innards.
|
|
|
942 * Specifier Instancing:: Instancing means obtaining the ``value'' of
|
|
|
943 a specifier in a particular context.
|
|
|
944 * Specifier Types:: Specifiers come in different flavors.
|
|
|
945 * Adding Specifications:: Specifications control a specifier's ``value''
|
|
|
946 by giving conditions under which a
|
|
|
947 particular value is valid.
|
|
|
948 * Retrieving Specifications:: Querying a specifier's specifications.
|
|
|
949 * Specifier Instancing Functions::
|
|
|
950 Functions to instance a specifier.
|
|
1869
|
951 * Specifier Examples:: Making all this stuff clearer.
|
|
428
|
952 * Creating Specifiers:: Creating specifiers for your own use.
|
|
|
953 * Specifier Validation Functions::
|
|
|
954 Validating the components of a specifier.
|
|
|
955 * Other Specification Functions::
|
|
|
956 Other ways of working with specifications.
|
|
|
957
|
|
|
958 Faces and Window-System Objects
|
|
|
959
|
|
|
960 * Faces:: Controlling the way text looks.
|
|
|
961 * Fonts:: Controlling the typeface of text.
|
|
|
962 * Colors:: Controlling the color of text and pixmaps.
|
|
|
963
|
|
|
964 Faces
|
|
|
965
|
|
|
966 * Merging Faces:: How XEmacs decides which face to use
|
|
|
967 for a character.
|
|
|
968 * Basic Face Functions:: How to define and examine faces.
|
|
|
969 * Face Properties:: How to access and modify a face's properties.
|
|
|
970 * Face Convenience Functions:: Convenience functions for accessing
|
|
|
971 particular properties of a face.
|
|
|
972 * Other Face Display Functions:: Other functions pertaining to how a
|
|
|
973 a face appears.
|
|
|
974
|
|
|
975 Fonts
|
|
|
976
|
|
|
977 * Font Specifiers:: Specifying how a font will appear.
|
|
|
978 * Font Instances:: What a font specifier gets instanced as.
|
|
|
979 * Font Instance Names:: The name of a font instance.
|
|
|
980 * Font Instance Size:: The size of a font instance.
|
|
|
981 * Font Instance Characteristics:: Display characteristics of font instances.
|
|
|
982 * Font Convenience Functions:: Convenience functions that automatically
|
|
|
983 instance and retrieve the properties
|
|
|
984 of a font specifier.
|
|
|
985
|
|
|
986 Colors
|
|
|
987
|
|
|
988 * Color Specifiers:: Specifying how a color will appear.
|
|
|
989 * Color Instances:: What a color specifier gets instanced as.
|
|
|
990 * Color Instance Properties:: Properties of color instances.
|
|
|
991 * Color Convenience Functions:: Convenience functions that automatically
|
|
|
992 instance and retrieve the properties
|
|
|
993 of a color specifier.
|
|
|
994
|
|
|
995 Glyphs
|
|
|
996
|
|
2182
|
997 * Glyph Intro:: Glyphs are abstract image specifications.
|
|
|
998 * Images:: Specifying the appearance of glyphs.
|
|
|
999 * Using Glyphs:: Creating and displaying glyphs.
|
|
|
1000 * Manipulating Glyphs:: Getting and setting glyph properties.
|
|
|
1001 * Glyph Examples:: Examples of how to work with glyphs.
|
|
428
|
1002
|
|
|
1003 Images
|
|
|
1004
|
|
2182
|
1005 * Image Specifiers:: Specifying an image's appearance.
|
|
|
1006 * Image Instantiator Conversion:: Lazy realization of graphics.
|
|
|
1007 * Image Instantiator Formats:: A catalog of image descriptors.
|
|
|
1008 * Image Instances:: Classes of graphical objects.
|
|
|
1009
|
|
|
1010 Image Instances
|
|
|
1011
|
|
|
1012 * Image Instance Types:: Each image instances has a particular type.
|
|
|
1013 * Image Instance Functions:: Functions for working with image instances.
|
|
|
1014
|
|
|
1015 Using Glyphs
|
|
|
1016
|
|
428
|
1017
|
|
|
1018 Image Instances
|
|
|
1019
|
|
|
1020 * Image Instance Types:: Each image instances has a particular type.
|
|
|
1021 * Image Instance Functions:: Functions for working with image instances.
|
|
|
1022
|
|
2182
|
1023 Using Glyphs
|
|
|
1024
|
|
|
1025 * Creating Glyphs:: Creating new glyphs.
|
|
|
1026 * Buffer Glyphs:: Annotations are glyphs that appear in a buffer.
|
|
|
1027 * Redisplay Glyphs:: Glyphs controlling various redisplay functions.
|
|
|
1028 * Frame Glyphs:: Displaying glyphs in GUI components of the frame.
|
|
|
1029 * External Glyphs:: Icons and mouse pointers for the window system.
|
|
|
1030 * Native GUI Widgets:: Complex active elements treated as a single glyph.
|
|
|
1031 * Subwindows:: Externally-controlled subwindows in buffers.
|
|
|
1032
|
|
|
1033 Native GUI Widgets
|
|
|
1034
|
|
|
1035 * Introduction to Widgets:: Native widgets provide tight integration of
|
|
|
1036 GUI features with the platform GUI.
|
|
|
1037 * Lisp API to Native Widgets:: Native widgets are glyphs.
|
|
|
1038 * Layouts:: Specifying composite widgets from Lisp.
|
|
|
1039 * Primitive Widgets:: Catalogue of available native widgets.
|
|
|
1040
|
|
|
1041 Manipulating Glyphs
|
|
|
1042
|
|
|
1043 * Glyph Properties:: Accessing and modifying a glyph's properties.
|
|
|
1044 * Glyph Convenience Functions:: Accessing particular properties of a glyph.
|
|
|
1045 * Glyph Dimensions:: Determining the height, width, etc. of a glyph.
|
|
|
1046 * Glyph Types:: Each glyph has a particular type.
|
|
|
1047
|
|
428
|
1048 Annotations
|
|
|
1049
|
|
|
1050 * Annotation Basics:: Introduction to annotations.
|
|
|
1051 * Annotation Primitives:: Creating and deleting annotations.
|
|
|
1052 * Annotation Properties:: Retrieving and changing the characteristics
|
|
|
1053 of an annotation.
|
|
|
1054 * Margin Primitives:: Controlling the size of the margins.
|
|
|
1055 * Locating Annotations:: Looking for annotations in a buffer.
|
|
|
1056 * Annotation Hooks:: Hooks called at certain times during an
|
|
|
1057 annotation's lifetime.
|
|
|
1058
|
|
|
1059 Hash Tables
|
|
|
1060
|
|
|
1061 * Introduction to Hash Tables:: Hash tables are fast data structures for
|
|
|
1062 implementing simple tables (i.e. finite
|
|
|
1063 mappings from keys to values).
|
|
|
1064 * Working With Hash Tables:: Hash table functions.
|
|
|
1065 * Weak Hash Tables:: Hash tables with special garbage-collection
|
|
|
1066 behavior.
|
|
|
1067
|
|
|
1068 Range Tables
|
|
|
1069
|
|
|
1070 * Introduction to Range Tables:: Range tables efficiently map ranges of
|
|
|
1071 integers to values.
|
|
|
1072 * Working With Range Tables:: Range table functions.
|
|
|
1073
|
|
|
1074
|
|
|
1075 XEmacs Display
|
|
|
1076
|
|
|
1077 * Refresh Screen:: Clearing the screen and redrawing everything on it.
|
|
|
1078 * Truncation:: Folding or wrapping long text lines.
|
|
|
1079 * The Echo Area:: Where messages are displayed.
|
|
|
1080 * Selective Display:: Hiding part of the buffer text.
|
|
|
1081 * Overlay Arrow:: Display of an arrow to indicate position.
|
|
|
1082 * Temporary Displays:: Displays that go away automatically.
|
|
|
1083 * Blinking:: How XEmacs shows the matching open parenthesis.
|
|
|
1084 * Usual Display:: The usual conventions for displaying nonprinting chars.
|
|
|
1085 * Display Tables:: How to specify other conventions.
|
|
|
1086 * Beeping:: Audible signal to the user.
|
|
|
1087
|
|
|
1088 Processes
|
|
|
1089
|
|
|
1090 * Subprocess Creation:: Functions that start subprocesses.
|
|
|
1091 * Synchronous Processes:: Details of using synchronous subprocesses.
|
|
|
1092 * Asynchronous Processes:: Starting up an asynchronous subprocess.
|
|
|
1093 * Deleting Processes:: Eliminating an asynchronous subprocess.
|
|
|
1094 * Process Information:: Accessing run-status and other attributes.
|
|
|
1095 * Input to Processes:: Sending input to an asynchronous subprocess.
|
|
|
1096 * Signals to Processes:: Stopping, continuing or interrupting
|
|
|
1097 an asynchronous subprocess.
|
|
|
1098 * Output from Processes:: Collecting output from an asynchronous subprocess.
|
|
|
1099 * Sentinels:: Sentinels run when process run-status changes.
|
|
|
1100 * Network:: Opening network connections.
|
|
|
1101
|
|
|
1102 Receiving Output from Processes
|
|
|
1103
|
|
|
1104 * Process Buffers:: If no filter, output is put in a buffer.
|
|
|
1105 * Filter Functions:: Filter functions accept output from the process.
|
|
|
1106 * Accepting Output:: How to wait until process output arrives.
|
|
|
1107
|
|
|
1108 Operating System Interface
|
|
|
1109
|
|
|
1110 * Starting Up:: Customizing XEmacs start-up processing.
|
|
|
1111 * Getting Out:: How exiting works (permanent or temporary).
|
|
|
1112 * System Environment:: Distinguish the name and kind of system.
|
|
|
1113 * Terminal Input:: Recording terminal input for debugging.
|
|
|
1114 * Terminal Output:: Recording terminal output for debugging.
|
|
|
1115 * Flow Control:: How to turn output flow control on or off.
|
|
|
1116 * Batch Mode:: Running XEmacs without terminal interaction.
|
|
|
1117
|
|
|
1118 Starting Up XEmacs
|
|
|
1119
|
|
|
1120 * Start-up Summary:: Sequence of actions XEmacs performs at start-up.
|
|
|
1121 * Init File:: Details on reading the init file (@file{.emacs}).
|
|
|
1122 * Terminal-Specific:: How the terminal-specific Lisp file is read.
|
|
|
1123 * Command Line Arguments:: How command line arguments are processed,
|
|
|
1124 and how you can customize them.
|
|
|
1125
|
|
|
1126 Getting out of XEmacs
|
|
|
1127
|
|
|
1128 * Killing XEmacs:: Exiting XEmacs irreversibly.
|
|
|
1129 * Suspending XEmacs:: Exiting XEmacs reversibly.
|
|
|
1130
|
|
|
1131 X-Windows
|
|
|
1132
|
|
|
1133 * X Selections:: Transferring text to and from other X clients.
|
|
|
1134 * X Server:: Information about the X server connected to
|
|
|
1135 a particular device.
|
|
|
1136 * Resources:: Getting resource values from the server.
|
|
|
1137 * Server Data:: Getting info about the X server.
|
|
|
1138 * Grabs:: Restricting access to the server by other apps.
|
|
|
1139 * X Miscellaneous:: Other X-specific functions and variables.
|
|
|
1140
|
|
|
1141 ToolTalk Support
|
|
|
1142
|
|
|
1143 * XEmacs ToolTalk API Summary::
|
|
|
1144 * Sending Messages::
|
|
|
1145 * Receiving Messages::
|
|
|
1146
|
|
|
1147 LDAP Support
|
|
|
1148
|
|
|
1149 * Building XEmacs with LDAP support:: How to add LDAP support to XEmacs
|
|
|
1150 * XEmacs LDAP API:: Lisp access to LDAP functions
|
|
|
1151 * Syntax of Search Filters:: A brief summary of RFC 1558
|
|
|
1152
|
|
|
1153 XEmacs LDAP API
|
|
|
1154
|
|
|
1155 * LDAP Variables:: Lisp variables related to LDAP
|
|
444
|
1156 * The High-Level LDAP API:: High-level LDAP lisp functions
|
|
428
|
1157 * The Low-Level LDAP API:: Low-level LDAP lisp primitives
|
|
442
|
1158 * LDAP Internationalization:: I18n variables and functions
|
|
428
|
1159
|
|
|
1160 The Low-Level LDAP API
|
|
|
1161
|
|
444
|
1162 * The LDAP Lisp Object::
|
|
|
1163 * Opening and Closing a LDAP Connection::
|
|
|
1164 * Low-level Operations on a LDAP Server::
|
|
442
|
1165
|
|
|
1166 LDAP Internationalization
|
|
|
1167
|
|
444
|
1168 * LDAP Internationalization Variables::
|
|
|
1169 * Encoder/Decoder Functions::
|
|
428
|
1170
|
|
|
1171 Internationalization
|
|
|
1172
|
|
|
1173 * I18N Levels 1 and 2:: Support for different time, date, and currency formats.
|
|
|
1174 * I18N Level 3:: Support for localized messages.
|
|
|
1175 * I18N Level 4:: Support for Asian languages.
|
|
|
1176
|
|
|
1177 MULE
|
|
|
1178
|
|
|
1179 * Internationalization Terminology::
|
|
|
1180 Definition of various internationalization terms.
|
|
|
1181 * Charsets:: Sets of related characters.
|
|
|
1182 * MULE Characters:: Working with characters in XEmacs/MULE.
|
|
|
1183 * Composite Characters:: Making new characters by overstriking other ones.
|
|
|
1184 * ISO 2022:: An international standard for charsets and encodings.
|
|
|
1185 * Coding Systems:: Ways of representing a string of chars using integers.
|
|
|
1186 * CCL:: A special language for writing fast converters.
|
|
|
1187 * Category Tables:: Subdividing charsets into groups.
|
|
|
1188
|
|
|
1189 Tips
|
|
|
1190
|
|
|
1191 * Style Tips:: Writing clean and robust programs.
|
|
|
1192 * Compilation Tips:: Making compiled code run fast.
|
|
|
1193 * Documentation Tips:: Writing readable documentation strings.
|
|
|
1194 * Comment Tips:: Conventions for writing comments.
|
|
|
1195 * Library Headers:: Standard headers for library packages.
|
|
|
1196
|
|
|
1197 Building XEmacs and Object Allocation
|
|
|
1198
|
|
|
1199 * Building XEmacs:: How to preload Lisp libraries into XEmacs.
|
|
|
1200 * Pure Storage:: A kludge to make preloaded Lisp functions sharable.
|
|
|
1201 * Garbage Collection:: Reclaiming space for Lisp objects no longer used.
|
|
|
1202
|
|
|
1203 @end menu
|
|
|
1204
|
|
|
1205 @include intro.texi
|
|
693
|
1206 @include packaging.texi
|
|
428
|
1207 @include objects.texi
|
|
|
1208 @include numbers.texi
|
|
|
1209 @include strings.texi
|
|
|
1210
|
|
|
1211 @include lists.texi
|
|
|
1212 @include sequences.texi
|
|
|
1213 @include symbols.texi
|
|
|
1214 @include eval.texi
|
|
|
1215
|
|
|
1216 @include control.texi
|
|
|
1217 @include variables.texi
|
|
|
1218 @include functions.texi
|
|
|
1219 @include macros.texi
|
|
|
1220 @include customize.texi
|
|
|
1221
|
|
|
1222 @include loading.texi
|
|
|
1223 @include compile.texi
|
|
|
1224 @include debugging.texi
|
|
|
1225 @include streams.texi
|
|
|
1226
|
|
|
1227 @include minibuf.texi
|
|
|
1228 @include commands.texi
|
|
|
1229 @include keymaps.texi
|
|
|
1230 @include menus.texi
|
|
|
1231 @include dialog.texi
|
|
|
1232 @include toolbar.texi
|
|
442
|
1233 @include gutter.texi
|
|
428
|
1234 @include scrollbars.texi
|
|
|
1235 @include dragndrop.texi
|
|
|
1236 @include modes.texi
|
|
|
1237
|
|
|
1238 @include help.texi
|
|
|
1239 @include files.texi
|
|
|
1240 @include backups.texi
|
|
|
1241 @include buffers.texi
|
|
|
1242
|
|
|
1243 @include windows.texi
|
|
|
1244 @include frames.texi
|
|
|
1245 @include consoles-devices.texi
|
|
|
1246 @include positions.texi
|
|
|
1247 @include markers.texi
|
|
|
1248 @include text.texi
|
|
|
1249
|
|
|
1250 @include searching.texi
|
|
|
1251 @include syntax.texi
|
|
|
1252 @include abbrevs.texi
|
|
|
1253
|
|
|
1254 @include extents.texi
|
|
|
1255 @include specifiers.texi
|
|
|
1256 @include faces.texi
|
|
|
1257 @include glyphs.texi
|
|
|
1258 @include annotations.texi
|
|
|
1259 @include display.texi
|
|
|
1260
|
|
|
1261 @include hash-tables.texi
|
|
|
1262 @include range-tables.texi
|
|
|
1263 @include databases.texi
|
|
|
1264
|
|
|
1265 @include processes.texi
|
|
|
1266 @include os.texi
|
|
|
1267 @include x-windows.texi
|
|
|
1268 @include tooltalk.texi
|
|
|
1269 @include ldap.texi
|
|
442
|
1270 @include postgresql.texi
|
|
428
|
1271 @include internationalization.texi
|
|
|
1272 @include mule.texi
|
|
|
1273
|
|
|
1274 @c MOVE to User's Manual: include calendar.texi
|
|
|
1275
|
|
|
1276 @c MOVE to User's Manual: include misc-modes.texi
|
|
|
1277
|
|
|
1278 @c appendices
|
|
|
1279
|
|
|
1280 @c REMOVE this: include non-hacker.texi
|
|
|
1281
|
|
|
1282 @include tips.texi
|
|
|
1283 @include building.texi
|
|
|
1284 @include errors.texi
|
|
|
1285 @include locals.texi
|
|
|
1286 @include maps.texi
|
|
|
1287 @include hooks.texi
|
|
|
1288
|
|
|
1289 @include index.texi
|
|
|
1290
|
|
|
1291 @c Print the tables of contents
|
|
|
1292 @summarycontents
|
|
|
1293 @contents
|
|
|
1294 @c That's all
|
|
|
1295
|
|
|
1296 @bye
|
|
|
1297
|
|
|
1298
|
|
|
1299 These words prevent "local variables" above from confusing XEmacs.
|
