Commit | Line | Data |
---|---|---|
5b359918 RS |
1 | @c -*-texinfo-*- |
2 | @c This is part of the GNU Emacs Lisp Reference Manual. | |
fd897522 | 3 | @c Copyright (C) 1990, 1991, 1992, 1993, 1994, 1995, 1998, 1999 |
177c0ea7 | 4 | @c Free Software Foundation, Inc. |
5b359918 RS |
5 | @c See the file elisp.texi for copying conditions. |
6 | @setfilename ../info/objects | |
2b3fc6c3 | 7 | @node Lisp Data Types, Numbers, Introduction, Top |
5b359918 RS |
8 | @chapter Lisp Data Types |
9 | @cindex object | |
10 | @cindex Lisp object | |
11 | @cindex type | |
12 | @cindex data type | |
13 | ||
14 | A Lisp @dfn{object} is a piece of data used and manipulated by Lisp | |
15 | programs. For our purposes, a @dfn{type} or @dfn{data type} is a set of | |
16 | possible objects. | |
17 | ||
18 | Every object belongs to at least one type. Objects of the same type | |
19 | have similar structures and may usually be used in the same contexts. | |
20 | Types can overlap, and objects can belong to two or more types. | |
21 | Consequently, we can ask whether an object belongs to a particular type, | |
22 | but not for ``the'' type of an object. | |
23 | ||
24 | @cindex primitive type | |
25 | A few fundamental object types are built into Emacs. These, from | |
a61b9217 GM |
26 | which all other types are constructed, are called @dfn{primitive types}. |
27 | Each object belongs to one and only one primitive type. These types | |
28 | include @dfn{integer}, @dfn{float}, @dfn{cons}, @dfn{symbol}, | |
29 | @dfn{string}, @dfn{vector}, @dfn{hash-table}, @dfn{subr}, and | |
30 | @dfn{byte-code function}, plus several special types, such as | |
31 | @dfn{buffer}, that are related to editing. (@xref{Editing Types}.) | |
5b359918 RS |
32 | |
33 | Each primitive type has a corresponding Lisp function that checks | |
34 | whether an object is a member of that type. | |
35 | ||
36 | Note that Lisp is unlike many other languages in that Lisp objects are | |
37 | @dfn{self-typing}: the primitive type of the object is implicit in the | |
38 | object itself. For example, if an object is a vector, nothing can treat | |
39 | it as a number; Lisp knows it is a vector, not a number. | |
40 | ||
41 | In most languages, the programmer must declare the data type of each | |
42 | variable, and the type is known by the compiler but not represented in | |
43 | the data. Such type declarations do not exist in Emacs Lisp. A Lisp | |
2b3fc6c3 RS |
44 | variable can have any type of value, and it remembers whatever value |
45 | you store in it, type and all. | |
5b359918 RS |
46 | |
47 | This chapter describes the purpose, printed representation, and read | |
48 | syntax of each of the standard types in GNU Emacs Lisp. Details on how | |
49 | to use these types can be found in later chapters. | |
50 | ||
51 | @menu | |
52 | * Printed Representation:: How Lisp objects are represented as text. | |
53 | * Comments:: Comments and their formatting conventions. | |
54 | * Programming Types:: Types found in all Lisp systems. | |
55 | * Editing Types:: Types specific to Emacs. | |
8241495d | 56 | * Circular Objects:: Read syntax for circular structure. |
5b359918 RS |
57 | * Type Predicates:: Tests related to types. |
58 | * Equality Predicates:: Tests of equality between any two objects. | |
59 | @end menu | |
60 | ||
61 | @node Printed Representation | |
62 | @comment node-name, next, previous, up | |
63 | @section Printed Representation and Read Syntax | |
64 | @cindex printed representation | |
65 | @cindex read syntax | |
66 | ||
67 | The @dfn{printed representation} of an object is the format of the | |
68 | output generated by the Lisp printer (the function @code{prin1}) for | |
69 | that object. The @dfn{read syntax} of an object is the format of the | |
70 | input accepted by the Lisp reader (the function @code{read}) for that | |
f9f59935 RS |
71 | object. @xref{Read and Print}. |
72 | ||
73 | Most objects have more than one possible read syntax. Some types of | |
969fe9b5 RS |
74 | object have no read syntax, since it may not make sense to enter objects |
75 | of these types directly in a Lisp program. Except for these cases, the | |
76 | printed representation of an object is also a read syntax for it. | |
5b359918 RS |
77 | |
78 | In other languages, an expression is text; it has no other form. In | |
79 | Lisp, an expression is primarily a Lisp object and only secondarily the | |
80 | text that is the object's read syntax. Often there is no need to | |
81 | emphasize this distinction, but you must keep it in the back of your | |
82 | mind, or you will occasionally be very confused. | |
83 | ||
84 | @cindex hash notation | |
85 | Every type has a printed representation. Some types have no read | |
969fe9b5 RS |
86 | syntax---for example, the buffer type has none. Objects of these types |
87 | are printed in @dfn{hash notation}: the characters @samp{#<} followed by | |
88 | a descriptive string (typically the type name followed by the name of | |
89 | the object), and closed with a matching @samp{>}. Hash notation cannot | |
90 | be read at all, so the Lisp reader signals the error | |
91 | @code{invalid-read-syntax} whenever it encounters @samp{#<}. | |
5b359918 RS |
92 | @kindex invalid-read-syntax |
93 | ||
94 | @example | |
95 | (current-buffer) | |
96 | @result{} #<buffer objects.texi> | |
97 | @end example | |
98 | ||
99 | When you evaluate an expression interactively, the Lisp interpreter | |
100 | first reads the textual representation of it, producing a Lisp object, | |
101 | and then evaluates that object (@pxref{Evaluation}). However, | |
102 | evaluation and reading are separate activities. Reading returns the | |
103 | Lisp object represented by the text that is read; the object may or may | |
104 | not be evaluated later. @xref{Input Functions}, for a description of | |
105 | @code{read}, the basic function for reading objects. | |
106 | ||
107 | @node Comments | |
108 | @comment node-name, next, previous, up | |
109 | @section Comments | |
110 | @cindex comments | |
111 | @cindex @samp{;} in comment | |
112 | ||
113 | A @dfn{comment} is text that is written in a program only for the sake | |
114 | of humans that read the program, and that has no effect on the meaning | |
115 | of the program. In Lisp, a semicolon (@samp{;}) starts a comment if it | |
116 | is not within a string or character constant. The comment continues to | |
117 | the end of line. The Lisp reader discards comments; they do not become | |
118 | part of the Lisp objects which represent the program within the Lisp | |
119 | system. | |
120 | ||
bfe721d1 KH |
121 | The @samp{#@@@var{count}} construct, which skips the next @var{count} |
122 | characters, is useful for program-generated comments containing binary | |
123 | data. The Emacs Lisp byte compiler uses this in its output files | |
124 | (@pxref{Byte Compilation}). It isn't meant for source files, however. | |
125 | ||
5b359918 RS |
126 | @xref{Comment Tips}, for conventions for formatting comments. |
127 | ||
128 | @node Programming Types | |
129 | @section Programming Types | |
130 | @cindex programming types | |
131 | ||
132 | There are two general categories of types in Emacs Lisp: those having | |
133 | to do with Lisp programming, and those having to do with editing. The | |
134 | former exist in many Lisp implementations, in one form or another. The | |
135 | latter are unique to Emacs Lisp. | |
136 | ||
137 | @menu | |
138 | * Integer Type:: Numbers without fractional parts. | |
139 | * Floating Point Type:: Numbers with fractional parts and with a large range. | |
140 | * Character Type:: The representation of letters, numbers and | |
141 | control characters. | |
3e099569 RS |
142 | * Symbol Type:: A multi-use object that refers to a function, |
143 | variable, or property list, and has a unique identity. | |
5b359918 | 144 | * Sequence Type:: Both lists and arrays are classified as sequences. |
2b3fc6c3 | 145 | * Cons Cell Type:: Cons cells, and lists (which are made from cons cells). |
5b359918 RS |
146 | * Array Type:: Arrays include strings and vectors. |
147 | * String Type:: An (efficient) array of characters. | |
148 | * Vector Type:: One-dimensional arrays. | |
f9f59935 RS |
149 | * Char-Table Type:: One-dimensional sparse arrays indexed by characters. |
150 | * Bool-Vector Type:: One-dimensional arrays of @code{t} or @code{nil}. | |
8241495d | 151 | * Hash Table Type:: Super-fast lookup tables. |
3e099569 RS |
152 | * Function Type:: A piece of executable code you can call from elsewhere. |
153 | * Macro Type:: A method of expanding an expression into another | |
5b359918 RS |
154 | expression, more fundamental but less pretty. |
155 | * Primitive Function Type:: A function written in C, callable from Lisp. | |
156 | * Byte-Code Type:: A function written in Lisp, then compiled. | |
157 | * Autoload Type:: A type used for automatically loading seldom-used | |
158 | functions. | |
159 | @end menu | |
160 | ||
161 | @node Integer Type | |
162 | @subsection Integer Type | |
163 | ||
0fddfa72 RS |
164 | The range of values for integers in Emacs Lisp is @minus{}134217728 to |
165 | 134217727 (28 bits; i.e., | |
37680279 | 166 | @ifnottex |
0fddfa72 | 167 | -2**27 |
37680279 | 168 | @end ifnottex |
5b359918 | 169 | @tex |
8241495d | 170 | @math{-2^{27}} |
5b359918 RS |
171 | @end tex |
172 | to | |
37680279 | 173 | @ifnottex |
0fddfa72 | 174 | 2**27 - 1) |
37680279 | 175 | @end ifnottex |
5b359918 | 176 | @tex |
8241495d | 177 | @math{2^{28}-1}) |
5b359918 | 178 | @end tex |
0fddfa72 RS |
179 | on most machines. (Some machines may provide a wider range.) It is |
180 | important to note that the Emacs Lisp arithmetic functions do not check | |
181 | for overflow. Thus @code{(1+ 134217727)} is @minus{}134217728 on most | |
182 | machines. | |
5b359918 | 183 | |
2b3fc6c3 | 184 | The read syntax for integers is a sequence of (base ten) digits with an |
5b359918 RS |
185 | optional sign at the beginning and an optional period at the end. The |
186 | printed representation produced by the Lisp interpreter never has a | |
187 | leading @samp{+} or a final @samp{.}. | |
188 | ||
189 | @example | |
190 | @group | |
191 | -1 ; @r{The integer -1.} | |
192 | 1 ; @r{The integer 1.} | |
8241495d | 193 | 1. ; @r{Also the integer 1.} |
5b359918 | 194 | +1 ; @r{Also the integer 1.} |
969fe9b5 | 195 | 268435457 ; @r{Also the integer 1 on a 28-bit implementation.} |
5b359918 RS |
196 | @end group |
197 | @end example | |
198 | ||
199 | @xref{Numbers}, for more information. | |
200 | ||
201 | @node Floating Point Type | |
202 | @subsection Floating Point Type | |
203 | ||
1d284913 RS |
204 | Floating point numbers are the computer equivalent of scientific |
205 | notation. The precise number of significant figures and the range of | |
206 | possible exponents is machine-specific; Emacs always uses the C data | |
207 | type @code{double} to store the value. | |
5b359918 RS |
208 | |
209 | The printed representation for floating point numbers requires either | |
210 | a decimal point (with at least one digit following), an exponent, or | |
211 | both. For example, @samp{1500.0}, @samp{15e2}, @samp{15.0e2}, | |
212 | @samp{1.5e3}, and @samp{.15e4} are five ways of writing a floating point | |
213 | number whose value is 1500. They are all equivalent. | |
214 | ||
215 | @xref{Numbers}, for more information. | |
216 | ||
217 | @node Character Type | |
218 | @subsection Character Type | |
8241495d | 219 | @cindex @sc{ascii} character codes |
5b359918 RS |
220 | |
221 | A @dfn{character} in Emacs Lisp is nothing more than an integer. In | |
222 | other words, characters are represented by their character codes. For | |
223 | example, the character @kbd{A} is represented as the @w{integer 65}. | |
224 | ||
225 | Individual characters are not often used in programs. It is far more | |
226 | common to work with @emph{strings}, which are sequences composed of | |
227 | characters. @xref{String Type}. | |
228 | ||
229 | Characters in strings, buffers, and files are currently limited to the | |
f9f59935 | 230 | range of 0 to 524287---nineteen bits. But not all values in that range |
75708135 RS |
231 | are valid character codes. Codes 0 through 127 are @sc{ascii} codes; the |
232 | rest are non-@sc{ascii} (@pxref{Non-ASCII Characters}). Characters that represent | |
969fe9b5 RS |
233 | keyboard input have a much wider range, to encode modifier keys such as |
234 | Control, Meta and Shift. | |
5b359918 RS |
235 | |
236 | @cindex read syntax for characters | |
237 | @cindex printed representation for characters | |
238 | @cindex syntax for characters | |
b6954afd RS |
239 | @cindex @samp{?} in character constant |
240 | @cindex question mark in character constant | |
5b359918 RS |
241 | Since characters are really integers, the printed representation of a |
242 | character is a decimal number. This is also a possible read syntax for | |
243 | a character, but writing characters that way in Lisp programs is a very | |
244 | bad idea. You should @emph{always} use the special read syntax formats | |
245 | that Emacs Lisp provides for characters. These syntax formats start | |
246 | with a question mark. | |
247 | ||
248 | The usual read syntax for alphanumeric characters is a question mark | |
249 | followed by the character; thus, @samp{?A} for the character | |
250 | @kbd{A}, @samp{?B} for the character @kbd{B}, and @samp{?a} for the | |
177c0ea7 | 251 | character @kbd{a}. |
5b359918 RS |
252 | |
253 | For example: | |
254 | ||
255 | @example | |
256 | ?Q @result{} 81 ?q @result{} 113 | |
257 | @end example | |
258 | ||
259 | You can use the same syntax for punctuation characters, but it is | |
2b3fc6c3 RS |
260 | often a good idea to add a @samp{\} so that the Emacs commands for |
261 | editing Lisp code don't get confused. For example, @samp{?\ } is the | |
262 | way to write the space character. If the character is @samp{\}, you | |
263 | @emph{must} use a second @samp{\} to quote it: @samp{?\\}. | |
5b359918 RS |
264 | |
265 | @cindex whitespace | |
266 | @cindex bell character | |
267 | @cindex @samp{\a} | |
268 | @cindex backspace | |
269 | @cindex @samp{\b} | |
270 | @cindex tab | |
271 | @cindex @samp{\t} | |
272 | @cindex vertical tab | |
273 | @cindex @samp{\v} | |
274 | @cindex formfeed | |
275 | @cindex @samp{\f} | |
276 | @cindex newline | |
277 | @cindex @samp{\n} | |
278 | @cindex return | |
279 | @cindex @samp{\r} | |
280 | @cindex escape | |
281 | @cindex @samp{\e} | |
282 | You can express the characters Control-g, backspace, tab, newline, | |
9eae55d2 RS |
283 | vertical tab, formfeed, return, del, and escape as @samp{?\a}, |
284 | @samp{?\b}, @samp{?\t}, @samp{?\n}, @samp{?\v}, @samp{?\f}, | |
285 | @samp{?\r}, @samp{?\d}, and @samp{?\e}, respectively. Thus, | |
5b359918 RS |
286 | |
287 | @example | |
288 | ?\a @result{} 7 ; @r{@kbd{C-g}} | |
289 | ?\b @result{} 8 ; @r{backspace, @key{BS}, @kbd{C-h}} | |
290 | ?\t @result{} 9 ; @r{tab, @key{TAB}, @kbd{C-i}} | |
969fe9b5 | 291 | ?\n @result{} 10 ; @r{newline, @kbd{C-j}} |
5b359918 RS |
292 | ?\v @result{} 11 ; @r{vertical tab, @kbd{C-k}} |
293 | ?\f @result{} 12 ; @r{formfeed character, @kbd{C-l}} | |
294 | ?\r @result{} 13 ; @r{carriage return, @key{RET}, @kbd{C-m}} | |
295 | ?\e @result{} 27 ; @r{escape character, @key{ESC}, @kbd{C-[}} | |
296 | ?\\ @result{} 92 ; @r{backslash character, @kbd{\}} | |
8241495d | 297 | ?\d @result{} 127 ; @r{delete character, @key{DEL}} |
5b359918 RS |
298 | @end example |
299 | ||
300 | @cindex escape sequence | |
301 | These sequences which start with backslash are also known as | |
302 | @dfn{escape sequences}, because backslash plays the role of an escape | |
303 | character; this usage has nothing to do with the character @key{ESC}. | |
304 | ||
305 | @cindex control characters | |
306 | Control characters may be represented using yet another read syntax. | |
307 | This consists of a question mark followed by a backslash, caret, and the | |
308 | corresponding non-control character, in either upper or lower case. For | |
309 | example, both @samp{?\^I} and @samp{?\^i} are valid read syntax for the | |
310 | character @kbd{C-i}, the character whose value is 9. | |
311 | ||
312 | Instead of the @samp{^}, you can use @samp{C-}; thus, @samp{?\C-i} is | |
313 | equivalent to @samp{?\^I} and to @samp{?\^i}: | |
314 | ||
315 | @example | |
316 | ?\^I @result{} 9 ?\C-I @result{} 9 | |
317 | @end example | |
318 | ||
f9f59935 | 319 | In strings and buffers, the only control characters allowed are those |
8241495d | 320 | that exist in @sc{ascii}; but for keyboard input purposes, you can turn |
f9f59935 | 321 | any character into a control character with @samp{C-}. The character |
8241495d | 322 | codes for these non-@sc{ascii} control characters include the |
969fe9b5 | 323 | @tex |
8241495d | 324 | @math{2^{26}} |
969fe9b5 | 325 | @end tex |
37680279 | 326 | @ifnottex |
bfe721d1 | 327 | 2**26 |
37680279 | 328 | @end ifnottex |
bfe721d1 | 329 | bit as well as the code for the corresponding non-control |
8241495d | 330 | character. Ordinary terminals have no way of generating non-@sc{ascii} |
ebc6903b RS |
331 | control characters, but you can generate them straightforwardly using X |
332 | and other window systems. | |
5b359918 | 333 | |
bfe721d1 KH |
334 | For historical reasons, Emacs treats the @key{DEL} character as |
335 | the control equivalent of @kbd{?}: | |
5b359918 RS |
336 | |
337 | @example | |
338 | ?\^? @result{} 127 ?\C-? @result{} 127 | |
339 | @end example | |
340 | ||
bfe721d1 KH |
341 | @noindent |
342 | As a result, it is currently not possible to represent the character | |
969fe9b5 RS |
343 | @kbd{Control-?}, which is a meaningful input character under X, using |
344 | @samp{\C-}. It is not easy to change this, as various Lisp files refer | |
345 | to @key{DEL} in this way. | |
bfe721d1 | 346 | |
5b359918 RS |
347 | For representing control characters to be found in files or strings, |
348 | we recommend the @samp{^} syntax; for control characters in keyboard | |
969fe9b5 RS |
349 | input, we prefer the @samp{C-} syntax. Which one you use does not |
350 | affect the meaning of the program, but may guide the understanding of | |
351 | people who read it. | |
5b359918 RS |
352 | |
353 | @cindex meta characters | |
354 | A @dfn{meta character} is a character typed with the @key{META} | |
355 | modifier key. The integer that represents such a character has the | |
969fe9b5 | 356 | @tex |
8241495d | 357 | @math{2^{27}} |
969fe9b5 | 358 | @end tex |
37680279 | 359 | @ifnottex |
bfe721d1 | 360 | 2**27 |
37680279 | 361 | @end ifnottex |
bfe721d1 | 362 | bit set (which on most machines makes it a negative number). We |
5b359918 RS |
363 | use high bits for this and other modifiers to make possible a wide range |
364 | of basic character codes. | |
365 | ||
bfe721d1 | 366 | In a string, the |
969fe9b5 | 367 | @tex |
8241495d | 368 | @math{2^{7}} |
969fe9b5 | 369 | @end tex |
37680279 | 370 | @ifnottex |
bfe721d1 | 371 | 2**7 |
37680279 | 372 | @end ifnottex |
75708135 | 373 | bit attached to an @sc{ascii} character indicates a meta character; thus, the |
f9f59935 | 374 | meta characters that can fit in a string have codes in the range from |
8241495d | 375 | 128 to 255, and are the meta versions of the ordinary @sc{ascii} |
f9f59935 RS |
376 | characters. (In Emacs versions 18 and older, this convention was used |
377 | for characters outside of strings as well.) | |
5b359918 RS |
378 | |
379 | The read syntax for meta characters uses @samp{\M-}. For example, | |
380 | @samp{?\M-A} stands for @kbd{M-A}. You can use @samp{\M-} together with | |
2b3fc6c3 RS |
381 | octal character codes (see below), with @samp{\C-}, or with any other |
382 | syntax for a character. Thus, you can write @kbd{M-A} as @samp{?\M-A}, | |
383 | or as @samp{?\M-\101}. Likewise, you can write @kbd{C-M-b} as | |
384 | @samp{?\M-\C-b}, @samp{?\C-\M-b}, or @samp{?\M-\002}. | |
5b359918 | 385 | |
f9f59935 | 386 | The case of a graphic character is indicated by its character code; |
8241495d RS |
387 | for example, @sc{ascii} distinguishes between the characters @samp{a} |
388 | and @samp{A}. But @sc{ascii} has no way to represent whether a control | |
f9f59935 | 389 | character is upper case or lower case. Emacs uses the |
969fe9b5 | 390 | @tex |
8241495d | 391 | @math{2^{25}} |
969fe9b5 | 392 | @end tex |
37680279 | 393 | @ifnottex |
bfe721d1 | 394 | 2**25 |
37680279 | 395 | @end ifnottex |
969fe9b5 | 396 | bit to indicate that the shift key was used in typing a control |
bfe721d1 | 397 | character. This distinction is possible only when you use X terminals |
969fe9b5 | 398 | or other special terminals; ordinary terminals do not report the |
b6954afd | 399 | distinction to the computer in any way. The Lisp syntax for |
177c0ea7 | 400 | the shift bit is @samp{\S-}; thus, @samp{?\C-\S-o} or @samp{?\C-\S-O} |
b6954afd | 401 | represents the shifted-control-o character. |
5b359918 RS |
402 | |
403 | @cindex hyper characters | |
404 | @cindex super characters | |
405 | @cindex alt characters | |
406 | The X Window System defines three other modifier bits that can be set | |
407 | in a character: @dfn{hyper}, @dfn{super} and @dfn{alt}. The syntaxes | |
a9f0a989 RS |
408 | for these bits are @samp{\H-}, @samp{\s-} and @samp{\A-}. (Case is |
409 | significant in these prefixes.) Thus, @samp{?\H-\M-\A-x} represents | |
410 | @kbd{Alt-Hyper-Meta-x}. | |
969fe9b5 | 411 | @tex |
bfe721d1 | 412 | Numerically, the |
8241495d | 413 | bit values are @math{2^{22}} for alt, @math{2^{23}} for super and @math{2^{24}} for hyper. |
969fe9b5 | 414 | @end tex |
37680279 | 415 | @ifnottex |
bfe721d1 KH |
416 | Numerically, the |
417 | bit values are 2**22 for alt, 2**23 for super and 2**24 for hyper. | |
37680279 | 418 | @end ifnottex |
5b359918 | 419 | |
5b359918 RS |
420 | @cindex @samp{\} in character constant |
421 | @cindex backslash in character constant | |
422 | @cindex octal character code | |
f9f59935 RS |
423 | Finally, the most general read syntax for a character represents the |
424 | character code in either octal or hex. To use octal, write a question | |
425 | mark followed by a backslash and the octal character code (up to three | |
5b359918 RS |
426 | octal digits); thus, @samp{?\101} for the character @kbd{A}, |
427 | @samp{?\001} for the character @kbd{C-a}, and @code{?\002} for the | |
8241495d | 428 | character @kbd{C-b}. Although this syntax can represent any @sc{ascii} |
5b359918 | 429 | character, it is preferred only when the precise octal value is more |
8241495d | 430 | important than the @sc{ascii} representation. |
5b359918 RS |
431 | |
432 | @example | |
433 | @group | |
434 | ?\012 @result{} 10 ?\n @result{} 10 ?\C-j @result{} 10 | |
435 | ?\101 @result{} 65 ?A @result{} 65 | |
436 | @end group | |
437 | @end example | |
438 | ||
f9f59935 RS |
439 | To use hex, write a question mark followed by a backslash, @samp{x}, |
440 | and the hexadecimal character code. You can use any number of hex | |
441 | digits, so you can represent any character code in this way. | |
442 | Thus, @samp{?\x41} for the character @kbd{A}, @samp{?\x1} for the | |
c99554b1 | 443 | character @kbd{C-a}, and @code{?\x8e0} for the Latin-1 character |
f9f59935 | 444 | @iftex |
969fe9b5 | 445 | @samp{@`a}. |
f9f59935 | 446 | @end iftex |
37680279 | 447 | @ifnottex |
f9f59935 | 448 | @samp{a} with grave accent. |
37680279 | 449 | @end ifnottex |
f9f59935 | 450 | |
5b359918 RS |
451 | A backslash is allowed, and harmless, preceding any character without |
452 | a special escape meaning; thus, @samp{?\+} is equivalent to @samp{?+}. | |
453 | There is no reason to add a backslash before most characters. However, | |
454 | you should add a backslash before any of the characters | |
455 | @samp{()\|;'`"#.,} to avoid confusing the Emacs commands for editing | |
456 | Lisp code. Also add a backslash before whitespace characters such as | |
457 | space, tab, newline and formfeed. However, it is cleaner to use one of | |
458 | the easily readable escape sequences, such as @samp{\t}, instead of an | |
459 | actual whitespace character such as a tab. | |
460 | ||
2b3fc6c3 RS |
461 | @node Symbol Type |
462 | @subsection Symbol Type | |
463 | ||
464 | A @dfn{symbol} in GNU Emacs Lisp is an object with a name. The symbol | |
465 | name serves as the printed representation of the symbol. In ordinary | |
466 | use, the name is unique---no two symbols have the same name. | |
467 | ||
468 | A symbol can serve as a variable, as a function name, or to hold a | |
469 | property list. Or it may serve only to be distinct from all other Lisp | |
470 | objects, so that its presence in a data structure may be recognized | |
471 | reliably. In a given context, usually only one of these uses is | |
472 | intended. But you can use one symbol in all of these ways, | |
473 | independently. | |
474 | ||
a61b9217 GM |
475 | A symbol whose name starts with a colon (@samp{:}) is called a |
476 | @dfn{keyword symbol}. These symbols automatically act as constants, and | |
477 | are normally used only by comparing an unknown symbol with a few | |
478 | specific alternatives. | |
479 | ||
2b3fc6c3 RS |
480 | @cindex @samp{\} in symbols |
481 | @cindex backslash in symbols | |
482 | A symbol name can contain any characters whatever. Most symbol names | |
483 | are written with letters, digits, and the punctuation characters | |
484 | @samp{-+=*/}. Such names require no special punctuation; the characters | |
485 | of the name suffice as long as the name does not look like a number. | |
486 | (If it does, write a @samp{\} at the beginning of the name to force | |
a2bd77b8 | 487 | interpretation as a symbol.) The characters @samp{_~!@@$%^&:<>@{@}?} are |
2b3fc6c3 RS |
488 | less often used but also require no special punctuation. Any other |
489 | characters may be included in a symbol's name by escaping them with a | |
490 | backslash. In contrast to its use in strings, however, a backslash in | |
491 | the name of a symbol simply quotes the single character that follows the | |
492 | backslash. For example, in a string, @samp{\t} represents a tab | |
493 | character; in the name of a symbol, however, @samp{\t} merely quotes the | |
969fe9b5 | 494 | letter @samp{t}. To have a symbol with a tab character in its name, you |
2b3fc6c3 RS |
495 | must actually use a tab (preceded with a backslash). But it's rare to |
496 | do such a thing. | |
497 | ||
498 | @cindex CL note---case of letters | |
499 | @quotation | |
ec221d13 | 500 | @b{Common Lisp note:} In Common Lisp, lower case letters are always |
bfe721d1 KH |
501 | ``folded'' to upper case, unless they are explicitly escaped. In Emacs |
502 | Lisp, upper case and lower case letters are distinct. | |
2b3fc6c3 RS |
503 | @end quotation |
504 | ||
505 | Here are several examples of symbol names. Note that the @samp{+} in | |
506 | the fifth example is escaped to prevent it from being read as a number. | |
bfe721d1 | 507 | This is not necessary in the sixth example because the rest of the name |
2b3fc6c3 RS |
508 | makes it invalid as a number. |
509 | ||
510 | @example | |
511 | @group | |
512 | foo ; @r{A symbol named @samp{foo}.} | |
513 | FOO ; @r{A symbol named @samp{FOO}, different from @samp{foo}.} | |
514 | char-to-string ; @r{A symbol named @samp{char-to-string}.} | |
515 | @end group | |
516 | @group | |
517 | 1+ ; @r{A symbol named @samp{1+}} | |
518 | ; @r{(not @samp{+1}, which is an integer).} | |
519 | @end group | |
520 | @group | |
521 | \+1 ; @r{A symbol named @samp{+1}} | |
522 | ; @r{(not a very readable name).} | |
523 | @end group | |
524 | @group | |
525 | \(*\ 1\ 2\) ; @r{A symbol named @samp{(* 1 2)} (a worse name).} | |
526 | @c the @'s in this next line use up three characters, hence the | |
527 | @c apparent misalignment of the comment. | |
528 | +-*/_~!@@$%^&=:<>@{@} ; @r{A symbol named @samp{+-*/_~!@@$%^&=:<>@{@}}.} | |
529 | ; @r{These characters need not be escaped.} | |
530 | @end group | |
531 | @end example | |
532 | ||
adcac9f5 | 533 | @ifinfo |
756e1ca0 EZ |
534 | @c This uses ``colon'' instead of a literal `:' because Info cannot |
535 | @c cope with a `:' in a menu | |
536 | @cindex @samp{#@var{colon}} read syntax | |
adcac9f5 EZ |
537 | @end ifinfo |
538 | @ifnotinfo | |
539 | @cindex @samp{#:} read syntax | |
540 | @end ifnotinfo | |
8241495d RS |
541 | Normally the Lisp reader interns all symbols (@pxref{Creating |
542 | Symbols}). To prevent interning, you can write @samp{#:} before the | |
543 | name of the symbol. | |
544 | ||
5b359918 RS |
545 | @node Sequence Type |
546 | @subsection Sequence Types | |
547 | ||
548 | A @dfn{sequence} is a Lisp object that represents an ordered set of | |
549 | elements. There are two kinds of sequence in Emacs Lisp, lists and | |
550 | arrays. Thus, an object of type list or of type array is also | |
551 | considered a sequence. | |
552 | ||
969fe9b5 RS |
553 | Arrays are further subdivided into strings, vectors, char-tables and |
554 | bool-vectors. Vectors can hold elements of any type, but string | |
555 | elements must be characters, and bool-vector elements must be @code{t} | |
03231f93 RS |
556 | or @code{nil}. Char-tables are like vectors except that they are |
557 | indexed by any valid character code. The characters in a string can | |
558 | have text properties like characters in a buffer (@pxref{Text | |
559 | Properties}), but vectors do not support text properties, even when | |
560 | their elements happen to be characters. | |
969fe9b5 RS |
561 | |
562 | Lists, strings and the other array types are different, but they have | |
563 | important similarities. For example, all have a length @var{l}, and all | |
564 | have elements which can be indexed from zero to @var{l} minus one. | |
565 | Several functions, called sequence functions, accept any kind of | |
5b359918 RS |
566 | sequence. For example, the function @code{elt} can be used to extract |
567 | an element of a sequence, given its index. @xref{Sequences Arrays | |
568 | Vectors}. | |
569 | ||
969fe9b5 RS |
570 | It is generally impossible to read the same sequence twice, since |
571 | sequences are always created anew upon reading. If you read the read | |
572 | syntax for a sequence twice, you get two sequences with equal contents. | |
573 | There is one exception: the empty list @code{()} always stands for the | |
574 | same object, @code{nil}. | |
5b359918 | 575 | |
2b3fc6c3 RS |
576 | @node Cons Cell Type |
577 | @subsection Cons Cell and List Types | |
5b359918 RS |
578 | @cindex address field of register |
579 | @cindex decrement field of register | |
ebc6903b | 580 | @cindex pointers |
5b359918 | 581 | |
b6954afd RS |
582 | A @dfn{cons cell} is an object that consists of two slots, called the |
583 | @sc{car} slot and the @sc{cdr} slot. Each slot can @dfn{hold} or | |
8241495d | 584 | @dfn{refer to} any Lisp object. We also say that ``the @sc{car} of |
b6954afd RS |
585 | this cons cell is'' whatever object its @sc{car} slot currently holds, |
586 | and likewise for the @sc{cdr}. | |
587 | ||
588 | @quotation | |
589 | A note to C programmers: in Lisp, we do not distinguish between | |
590 | ``holding'' a value and ``pointing to'' the value, because pointers in | |
591 | Lisp are implicit. | |
592 | @end quotation | |
2b3fc6c3 RS |
593 | |
594 | A @dfn{list} is a series of cons cells, linked together so that the | |
ebc6903b | 595 | @sc{cdr} slot of each cons cell holds either the next cons cell or the |
2b3fc6c3 RS |
596 | empty list. @xref{Lists}, for functions that work on lists. Because |
597 | most cons cells are used as part of lists, the phrase @dfn{list | |
598 | structure} has come to refer to any structure made out of cons cells. | |
5b359918 | 599 | |
ebc6903b | 600 | The names @sc{car} and @sc{cdr} derive from the history of Lisp. The |
5b359918 RS |
601 | original Lisp implementation ran on an @w{IBM 704} computer which |
602 | divided words into two parts, called the ``address'' part and the | |
603 | ``decrement''; @sc{car} was an instruction to extract the contents of | |
604 | the address part of a register, and @sc{cdr} an instruction to extract | |
605 | the contents of the decrement. By contrast, ``cons cells'' are named | |
b6954afd | 606 | for the function @code{cons} that creates them, which in turn was named |
5b359918 RS |
607 | for its purpose, the construction of cells. |
608 | ||
609 | @cindex atom | |
610 | Because cons cells are so central to Lisp, we also have a word for | |
611 | ``an object which is not a cons cell''. These objects are called | |
612 | @dfn{atoms}. | |
613 | ||
614 | @cindex parenthesis | |
615 | The read syntax and printed representation for lists are identical, and | |
616 | consist of a left parenthesis, an arbitrary number of elements, and a | |
617 | right parenthesis. | |
618 | ||
619 | Upon reading, each object inside the parentheses becomes an element | |
620 | of the list. That is, a cons cell is made for each element. The | |
b6954afd RS |
621 | @sc{car} slot of the cons cell holds the element, and its @sc{cdr} |
622 | slot refers to the next cons cell of the list, which holds the next | |
ebc6903b | 623 | element in the list. The @sc{cdr} slot of the last cons cell is set to |
b6954afd | 624 | hold @code{nil}. |
5b359918 RS |
625 | |
626 | @cindex box diagrams, for lists | |
627 | @cindex diagrams, boxed, for lists | |
628 | A list can be illustrated by a diagram in which the cons cells are | |
ebc6903b RS |
629 | shown as pairs of boxes, like dominoes. (The Lisp reader cannot read |
630 | such an illustration; unlike the textual notation, which can be | |
631 | understood by both humans and computers, the box illustrations can be | |
632 | understood only by humans.) This picture represents the three-element | |
633 | list @code{(rose violet buttercup)}: | |
5b359918 RS |
634 | |
635 | @example | |
636 | @group | |
969fe9b5 RS |
637 | --- --- --- --- --- --- |
638 | | | |--> | | |--> | | |--> nil | |
639 | --- --- --- --- --- --- | |
5b359918 RS |
640 | | | | |
641 | | | | | |
642 | --> rose --> violet --> buttercup | |
643 | @end group | |
644 | @end example | |
645 | ||
b6954afd RS |
646 | In this diagram, each box represents a slot that can hold or refer to |
647 | any Lisp object. Each pair of boxes represents a cons cell. Each arrow | |
648 | represents a reference to a Lisp object, either an atom or another cons | |
649 | cell. | |
5b359918 | 650 | |
ebc6903b | 651 | In this example, the first box, which holds the @sc{car} of the first |
b6954afd RS |
652 | cons cell, refers to or ``holds'' @code{rose} (a symbol). The second |
653 | box, holding the @sc{cdr} of the first cons cell, refers to the next | |
ebc6903b RS |
654 | pair of boxes, the second cons cell. The @sc{car} of the second cons |
655 | cell is @code{violet}, and its @sc{cdr} is the third cons cell. The | |
656 | @sc{cdr} of the third (and last) cons cell is @code{nil}. | |
5b359918 | 657 | |
ebc6903b | 658 | Here is another diagram of the same list, @code{(rose violet |
5b359918 RS |
659 | buttercup)}, sketched in a different manner: |
660 | ||
661 | @smallexample | |
662 | @group | |
663 | --------------- ---------------- ------------------- | |
664 | | car | cdr | | car | cdr | | car | cdr | | |
665 | | rose | o-------->| violet | o-------->| buttercup | nil | | |
666 | | | | | | | | | | | |
667 | --------------- ---------------- ------------------- | |
668 | @end group | |
669 | @end smallexample | |
670 | ||
671 | @cindex @samp{(@dots{})} in lists | |
672 | @cindex @code{nil} in lists | |
673 | @cindex empty list | |
674 | A list with no elements in it is the @dfn{empty list}; it is identical | |
675 | to the symbol @code{nil}. In other words, @code{nil} is both a symbol | |
676 | and a list. | |
677 | ||
678 | Here are examples of lists written in Lisp syntax: | |
679 | ||
680 | @example | |
681 | (A 2 "A") ; @r{A list of three elements.} | |
682 | () ; @r{A list of no elements (the empty list).} | |
683 | nil ; @r{A list of no elements (the empty list).} | |
684 | ("A ()") ; @r{A list of one element: the string @code{"A ()"}.} | |
685 | (A ()) ; @r{A list of two elements: @code{A} and the empty list.} | |
686 | (A nil) ; @r{Equivalent to the previous.} | |
687 | ((A B C)) ; @r{A list of one element} | |
688 | ; @r{(which is a list of three elements).} | |
689 | @end example | |
690 | ||
691 | Here is the list @code{(A ())}, or equivalently @code{(A nil)}, | |
692 | depicted with boxes and arrows: | |
693 | ||
694 | @example | |
695 | @group | |
969fe9b5 RS |
696 | --- --- --- --- |
697 | | | |--> | | |--> nil | |
698 | --- --- --- --- | |
5b359918 RS |
699 | | | |
700 | | | | |
701 | --> A --> nil | |
702 | @end group | |
703 | @end example | |
704 | ||
705 | @menu | |
706 | * Dotted Pair Notation:: An alternative syntax for lists. | |
707 | * Association List Type:: A specially constructed list. | |
708 | @end menu | |
709 | ||
710 | @node Dotted Pair Notation | |
711 | @comment node-name, next, previous, up | |
712 | @subsubsection Dotted Pair Notation | |
713 | @cindex dotted pair notation | |
714 | @cindex @samp{.} in lists | |
715 | ||
716 | @dfn{Dotted pair notation} is an alternative syntax for cons cells | |
717 | that represents the @sc{car} and @sc{cdr} explicitly. In this syntax, | |
718 | @code{(@var{a} .@: @var{b})} stands for a cons cell whose @sc{car} is | |
719 | the object @var{a}, and whose @sc{cdr} is the object @var{b}. Dotted | |
720 | pair notation is therefore more general than list syntax. In the dotted | |
92e732c4 | 721 | pair notation, the list @samp{(1 2 3)} is written as @samp{(1 . (2 . (3 |
ebc6903b RS |
722 | . nil)))}. For @code{nil}-terminated lists, you can use either |
723 | notation, but list notation is usually clearer and more convenient. | |
724 | When printing a list, the dotted pair notation is only used if the | |
725 | @sc{cdr} of a cons cell is not a list. | |
5b359918 | 726 | |
ebc6903b RS |
727 | Here's an example using boxes to illustrate dotted pair notation. |
728 | This example shows the pair @code{(rose . violet)}: | |
5b359918 RS |
729 | |
730 | @example | |
731 | @group | |
969fe9b5 RS |
732 | --- --- |
733 | | | |--> violet | |
734 | --- --- | |
5b359918 RS |
735 | | |
736 | | | |
737 | --> rose | |
738 | @end group | |
739 | @end example | |
740 | ||
ebc6903b RS |
741 | You can combine dotted pair notation with list notation to represent |
742 | conveniently a chain of cons cells with a non-@code{nil} final @sc{cdr}. | |
743 | You write a dot after the last element of the list, followed by the | |
744 | @sc{cdr} of the final cons cell. For example, @code{(rose violet | |
745 | . buttercup)} is equivalent to @code{(rose . (violet . buttercup))}. | |
746 | The object looks like this: | |
5b359918 RS |
747 | |
748 | @example | |
749 | @group | |
969fe9b5 RS |
750 | --- --- --- --- |
751 | | | |--> | | |--> buttercup | |
752 | --- --- --- --- | |
5b359918 RS |
753 | | | |
754 | | | | |
755 | --> rose --> violet | |
756 | @end group | |
757 | @end example | |
758 | ||
ebc6903b RS |
759 | The syntax @code{(rose .@: violet .@: buttercup)} is invalid because |
760 | there is nothing that it could mean. If anything, it would say to put | |
761 | @code{buttercup} in the @sc{cdr} of a cons cell whose @sc{cdr} is already | |
762 | used for @code{violet}. | |
5b359918 | 763 | |
ebc6903b | 764 | The list @code{(rose violet)} is equivalent to @code{(rose . (violet))}, |
5b359918 RS |
765 | and looks like this: |
766 | ||
767 | @example | |
768 | @group | |
969fe9b5 RS |
769 | --- --- --- --- |
770 | | | |--> | | |--> nil | |
771 | --- --- --- --- | |
5b359918 RS |
772 | | | |
773 | | | | |
774 | --> rose --> violet | |
775 | @end group | |
776 | @end example | |
777 | ||
778 | Similarly, the three-element list @code{(rose violet buttercup)} | |
779 | is equivalent to @code{(rose . (violet . (buttercup)))}. | |
37680279 | 780 | @ifnottex |
5b359918 RS |
781 | It looks like this: |
782 | ||
783 | @example | |
784 | @group | |
969fe9b5 RS |
785 | --- --- --- --- --- --- |
786 | | | |--> | | |--> | | |--> nil | |
787 | --- --- --- --- --- --- | |
5b359918 RS |
788 | | | | |
789 | | | | | |
790 | --> rose --> violet --> buttercup | |
791 | @end group | |
792 | @end example | |
37680279 | 793 | @end ifnottex |
5b359918 RS |
794 | |
795 | @node Association List Type | |
796 | @comment node-name, next, previous, up | |
797 | @subsubsection Association List Type | |
798 | ||
799 | An @dfn{association list} or @dfn{alist} is a specially-constructed | |
800 | list whose elements are cons cells. In each element, the @sc{car} is | |
801 | considered a @dfn{key}, and the @sc{cdr} is considered an | |
802 | @dfn{associated value}. (In some cases, the associated value is stored | |
803 | in the @sc{car} of the @sc{cdr}.) Association lists are often used as | |
804 | stacks, since it is easy to add or remove associations at the front of | |
805 | the list. | |
806 | ||
807 | For example, | |
808 | ||
809 | @example | |
810 | (setq alist-of-colors | |
92e732c4 | 811 | '((rose . red) (lily . white) (buttercup . yellow))) |
5b359918 RS |
812 | @end example |
813 | ||
814 | @noindent | |
815 | sets the variable @code{alist-of-colors} to an alist of three elements. In the | |
816 | first element, @code{rose} is the key and @code{red} is the value. | |
817 | ||
818 | @xref{Association Lists}, for a further explanation of alists and for | |
8241495d RS |
819 | functions that work on alists. @xref{Hash Tables}, for another kind of |
820 | lookup table, which is much faster for handling a large number of keys. | |
5b359918 RS |
821 | |
822 | @node Array Type | |
823 | @subsection Array Type | |
824 | ||
825 | An @dfn{array} is composed of an arbitrary number of slots for | |
b6954afd | 826 | holding or referring to other Lisp objects, arranged in a contiguous block of |
969fe9b5 RS |
827 | memory. Accessing any element of an array takes approximately the same |
828 | amount of time. In contrast, accessing an element of a list requires | |
829 | time proportional to the position of the element in the list. (Elements | |
830 | at the end of a list take longer to access than elements at the | |
831 | beginning of a list.) | |
832 | ||
833 | Emacs defines four types of array: strings, vectors, bool-vectors, and | |
834 | char-tables. | |
835 | ||
836 | A string is an array of characters and a vector is an array of | |
837 | arbitrary objects. A bool-vector can hold only @code{t} or @code{nil}. | |
838 | These kinds of array may have any length up to the largest integer. | |
839 | Char-tables are sparse arrays indexed by any valid character code; they | |
840 | can hold arbitrary objects. | |
841 | ||
842 | The first element of an array has index zero, the second element has | |
843 | index 1, and so on. This is called @dfn{zero-origin} indexing. For | |
844 | example, an array of four elements has indices 0, 1, 2, @w{and 3}. The | |
845 | largest possible index value is one less than the length of the array. | |
846 | Once an array is created, its length is fixed. | |
847 | ||
848 | All Emacs Lisp arrays are one-dimensional. (Most other programming | |
849 | languages support multidimensional arrays, but they are not essential; | |
850 | you can get the same effect with an array of arrays.) Each type of | |
851 | array has its own read syntax; see the following sections for details. | |
852 | ||
853 | The array type is contained in the sequence type and | |
854 | contains the string type, the vector type, the bool-vector type, and the | |
855 | char-table type. | |
5b359918 RS |
856 | |
857 | @node String Type | |
858 | @subsection String Type | |
859 | ||
860 | A @dfn{string} is an array of characters. Strings are used for many | |
861 | purposes in Emacs, as can be expected in a text editor; for example, as | |
862 | the names of Lisp symbols, as messages for the user, and to represent | |
863 | text extracted from buffers. Strings in Lisp are constants: evaluation | |
864 | of a string returns the same string. | |
865 | ||
f9f59935 RS |
866 | @xref{Strings and Characters}, for functions that operate on strings. |
867 | ||
868 | @menu | |
869 | * Syntax for Strings:: | |
870 | * Non-ASCII in Strings:: | |
871 | * Nonprinting Characters:: | |
872 | * Text Props and Strings:: | |
873 | @end menu | |
874 | ||
875 | @node Syntax for Strings | |
876 | @subsubsection Syntax for Strings | |
877 | ||
5b359918 RS |
878 | @cindex @samp{"} in strings |
879 | @cindex double-quote in strings | |
880 | @cindex @samp{\} in strings | |
881 | @cindex backslash in strings | |
882 | The read syntax for strings is a double-quote, an arbitrary number of | |
f9f59935 RS |
883 | characters, and another double-quote, @code{"like this"}. To include a |
884 | double-quote in a string, precede it with a backslash; thus, @code{"\""} | |
885 | is a string containing just a single double-quote character. Likewise, | |
886 | you can include a backslash by preceding it with another backslash, like | |
887 | this: @code{"this \\ is a single embedded backslash"}. | |
2b3fc6c3 | 888 | |
f9f59935 | 889 | @cindex newline in strings |
2b3fc6c3 RS |
890 | The newline character is not special in the read syntax for strings; |
891 | if you write a new line between the double-quotes, it becomes a | |
892 | character in the string. But an escaped newline---one that is preceded | |
893 | by @samp{\}---does not become part of the string; i.e., the Lisp reader | |
f9f59935 RS |
894 | ignores an escaped newline while reading a string. An escaped space |
895 | @w{@samp{\ }} is likewise ignored. | |
5b359918 RS |
896 | |
897 | @example | |
898 | "It is useful to include newlines | |
899 | in documentation strings, | |
900 | but the newline is \ | |
901 | ignored if escaped." | |
177c0ea7 JB |
902 | @result{} "It is useful to include newlines |
903 | in documentation strings, | |
5b359918 RS |
904 | but the newline is ignored if escaped." |
905 | @end example | |
906 | ||
f9f59935 | 907 | @node Non-ASCII in Strings |
75708135 | 908 | @subsubsection Non-@sc{ascii} Characters in Strings |
f9f59935 | 909 | |
8241495d | 910 | You can include a non-@sc{ascii} international character in a string |
f9f59935 | 911 | constant by writing it literally. There are two text representations |
8241495d | 912 | for non-@sc{ascii} characters in Emacs strings (and in buffers): unibyte |
f9f59935 | 913 | and multibyte. If the string constant is read from a multibyte source, |
969fe9b5 RS |
914 | such as a multibyte buffer or string, or a file that would be visited as |
915 | multibyte, then the character is read as a multibyte character, and that | |
916 | makes the string multibyte. If the string constant is read from a | |
917 | unibyte source, then the character is read as unibyte and that makes the | |
918 | string unibyte. | |
f9f59935 | 919 | |
13ede7fc | 920 | You can also represent a multibyte non-@sc{ascii} character with its |
8241495d | 921 | character code: use a hex escape, @samp{\x@var{nnnnnnn}}, with as many |
13ede7fc | 922 | digits as necessary. (Multibyte non-@sc{ascii} character codes are all |
f9f59935 | 923 | greater than 256.) Any character which is not a valid hex digit |
b6954afd RS |
924 | terminates this construct. If the next character in the string could be |
925 | interpreted as a hex digit, write @w{@samp{\ }} (backslash and space) to | |
926 | terminate the hex escape---for example, @w{@samp{\x8e0\ }} represents | |
927 | one character, @samp{a} with grave accent. @w{@samp{\ }} in a string | |
928 | constant is just like backslash-newline; it does not contribute any | |
929 | character to the string, but it does terminate the preceding hex escape. | |
f9f59935 RS |
930 | |
931 | Using a multibyte hex escape forces the string to multibyte. You can | |
8241495d | 932 | represent a unibyte non-@sc{ascii} character with its character code, |
f9f59935 RS |
933 | which must be in the range from 128 (0200 octal) to 255 (0377 octal). |
934 | This forces a unibyte string. | |
177c0ea7 | 935 | |
f9f59935 RS |
936 | @xref{Text Representations}, for more information about the two |
937 | text representations. | |
938 | ||
939 | @node Nonprinting Characters | |
940 | @subsubsection Nonprinting Characters in Strings | |
941 | ||
f9f59935 RS |
942 | You can use the same backslash escape-sequences in a string constant |
943 | as in character literals (but do not use the question mark that begins a | |
944 | character constant). For example, you can write a string containing the | |
a9f0a989 RS |
945 | nonprinting characters tab and @kbd{C-a}, with commas and spaces between |
946 | them, like this: @code{"\t, \C-a"}. @xref{Character Type}, for a | |
947 | description of the read syntax for characters. | |
948 | ||
949 | However, not all of the characters you can write with backslash | |
950 | escape-sequences are valid in strings. The only control characters that | |
8241495d RS |
951 | a string can hold are the @sc{ascii} control characters. Strings do not |
952 | distinguish case in @sc{ascii} control characters. | |
a9f0a989 RS |
953 | |
954 | Properly speaking, strings cannot hold meta characters; but when a | |
955 | string is to be used as a key sequence, there is a special convention | |
8241495d | 956 | that provides a way to represent meta versions of @sc{ascii} characters in a |
a9f0a989 RS |
957 | string. If you use the @samp{\M-} syntax to indicate a meta character |
958 | in a string constant, this sets the | |
969fe9b5 | 959 | @tex |
8241495d | 960 | @math{2^{7}} |
969fe9b5 | 961 | @end tex |
37680279 | 962 | @ifnottex |
f9f59935 | 963 | 2**7 |
37680279 | 964 | @end ifnottex |
a9f0a989 RS |
965 | bit of the character in the string. If the string is used in |
966 | @code{define-key} or @code{lookup-key}, this numeric code is translated | |
967 | into the equivalent meta character. @xref{Character Type}. | |
968 | ||
969 | Strings cannot hold characters that have the hyper, super, or alt | |
970 | modifiers. | |
f9f59935 RS |
971 | |
972 | @node Text Props and Strings | |
973 | @subsubsection Text Properties in Strings | |
974 | ||
975 | A string can hold properties for the characters it contains, in | |
976 | addition to the characters themselves. This enables programs that copy | |
977 | text between strings and buffers to copy the text's properties with no | |
978 | special effort. @xref{Text Properties}, for an explanation of what text | |
979 | properties mean. Strings with text properties use a special read and | |
980 | print syntax: | |
5b359918 RS |
981 | |
982 | @example | |
983 | #("@var{characters}" @var{property-data}...) | |
984 | @end example | |
985 | ||
986 | @noindent | |
987 | where @var{property-data} consists of zero or more elements, in groups | |
988 | of three as follows: | |
989 | ||
990 | @example | |
991 | @var{beg} @var{end} @var{plist} | |
992 | @end example | |
993 | ||
994 | @noindent | |
995 | The elements @var{beg} and @var{end} are integers, and together specify | |
996 | a range of indices in the string; @var{plist} is the property list for | |
f9f59935 | 997 | that range. For example, |
5b359918 | 998 | |
f9f59935 RS |
999 | @example |
1000 | #("foo bar" 0 3 (face bold) 3 4 nil 4 7 (face italic)) | |
1001 | @end example | |
1002 | ||
1003 | @noindent | |
1004 | represents a string whose textual contents are @samp{foo bar}, in which | |
1005 | the first three characters have a @code{face} property with value | |
1006 | @code{bold}, and the last three have a @code{face} property with value | |
ebc6903b | 1007 | @code{italic}. (The fourth character has no text properties, so its |
a9f0a989 RS |
1008 | property list is @code{nil}. It is not actually necessary to mention |
1009 | ranges with @code{nil} as the property list, since any characters not | |
1010 | mentioned in any range will default to having no properties.) | |
5b359918 RS |
1011 | |
1012 | @node Vector Type | |
1013 | @subsection Vector Type | |
1014 | ||
1015 | A @dfn{vector} is a one-dimensional array of elements of any type. It | |
1016 | takes a constant amount of time to access any element of a vector. (In | |
1017 | a list, the access time of an element is proportional to the distance of | |
1018 | the element from the beginning of the list.) | |
1019 | ||
1020 | The printed representation of a vector consists of a left square | |
1021 | bracket, the elements, and a right square bracket. This is also the | |
1022 | read syntax. Like numbers and strings, vectors are considered constants | |
1023 | for evaluation. | |
1024 | ||
1025 | @example | |
1026 | [1 "two" (three)] ; @r{A vector of three elements.} | |
1027 | @result{} [1 "two" (three)] | |
1028 | @end example | |
1029 | ||
1030 | @xref{Vectors}, for functions that work with vectors. | |
1031 | ||
f9f59935 RS |
1032 | @node Char-Table Type |
1033 | @subsection Char-Table Type | |
1034 | ||
1035 | A @dfn{char-table} is a one-dimensional array of elements of any type, | |
1036 | indexed by character codes. Char-tables have certain extra features to | |
1037 | make them more useful for many jobs that involve assigning information | |
1038 | to character codes---for example, a char-table can have a parent to | |
1039 | inherit from, a default value, and a small number of extra slots to use for | |
1040 | special purposes. A char-table can also specify a single value for | |
1041 | a whole character set. | |
1042 | ||
1043 | The printed representation of a char-table is like a vector | |
969fe9b5 | 1044 | except that there is an extra @samp{#^} at the beginning. |
f9f59935 RS |
1045 | |
1046 | @xref{Char-Tables}, for special functions to operate on char-tables. | |
969fe9b5 RS |
1047 | Uses of char-tables include: |
1048 | ||
1049 | @itemize @bullet | |
1050 | @item | |
1051 | Case tables (@pxref{Case Tables}). | |
1052 | ||
1053 | @item | |
1054 | Character category tables (@pxref{Categories}). | |
1055 | ||
1056 | @item | |
3ae8380b | 1057 | Display tables (@pxref{Display Tables}). |
969fe9b5 RS |
1058 | |
1059 | @item | |
1060 | Syntax tables (@pxref{Syntax Tables}). | |
1061 | @end itemize | |
f9f59935 RS |
1062 | |
1063 | @node Bool-Vector Type | |
1064 | @subsection Bool-Vector Type | |
1065 | ||
1066 | A @dfn{bool-vector} is a one-dimensional array of elements that | |
1067 | must be @code{t} or @code{nil}. | |
1068 | ||
8241495d | 1069 | The printed representation of a bool-vector is like a string, except |
f9f59935 RS |
1070 | that it begins with @samp{#&} followed by the length. The string |
1071 | constant that follows actually specifies the contents of the bool-vector | |
1072 | as a bitmap---each ``character'' in the string contains 8 bits, which | |
1073 | specify the next 8 elements of the bool-vector (1 stands for @code{t}, | |
177c0ea7 | 1074 | and 0 for @code{nil}). The least significant bits of the character |
ebc6903b | 1075 | correspond to the lowest indices in the bool-vector. If the length is not a |
a9f0a989 RS |
1076 | multiple of 8, the printed representation shows extra elements, but |
1077 | these extras really make no difference. | |
f9f59935 RS |
1078 | |
1079 | @example | |
1080 | (make-bool-vector 3 t) | |
a9f0a989 | 1081 | @result{} #&3"\007" |
f9f59935 | 1082 | (make-bool-vector 3 nil) |
a9f0a989 | 1083 | @result{} #&3"\0" |
969fe9b5 | 1084 | ;; @r{These are equal since only the first 3 bits are used.} |
a9f0a989 | 1085 | (equal #&3"\377" #&3"\007") |
969fe9b5 | 1086 | @result{} t |
f9f59935 RS |
1087 | @end example |
1088 | ||
8241495d RS |
1089 | @node Hash Table Type |
1090 | @subsection Hash Table Type | |
1091 | ||
1092 | A hash table is a very fast kind of lookup table, somewhat like an | |
1093 | alist in that it maps keys to corresponding values, but much faster. | |
1094 | Hash tables are a new feature in Emacs 21; they have no read syntax, and | |
1095 | print using hash notation. @xref{Hash Tables}. | |
1096 | ||
1097 | @example | |
1098 | (make-hash-table) | |
1099 | @result{} #<hash-table 'eql nil 0/65 0x83af980> | |
1100 | @end example | |
1101 | ||
2b3fc6c3 RS |
1102 | @node Function Type |
1103 | @subsection Function Type | |
5b359918 RS |
1104 | |
1105 | Just as functions in other programming languages are executable, | |
1106 | @dfn{Lisp function} objects are pieces of executable code. However, | |
1107 | functions in Lisp are primarily Lisp objects, and only secondarily the | |
1108 | text which represents them. These Lisp objects are lambda expressions: | |
1109 | lists whose first element is the symbol @code{lambda} (@pxref{Lambda | |
1110 | Expressions}). | |
1111 | ||
1112 | In most programming languages, it is impossible to have a function | |
1113 | without a name. In Lisp, a function has no intrinsic name. A lambda | |
1114 | expression is also called an @dfn{anonymous function} (@pxref{Anonymous | |
1115 | Functions}). A named function in Lisp is actually a symbol with a valid | |
1116 | function in its function cell (@pxref{Defining Functions}). | |
1117 | ||
1118 | Most of the time, functions are called when their names are written in | |
1119 | Lisp expressions in Lisp programs. However, you can construct or obtain | |
1120 | a function object at run time and then call it with the primitive | |
1121 | functions @code{funcall} and @code{apply}. @xref{Calling Functions}. | |
1122 | ||
2b3fc6c3 RS |
1123 | @node Macro Type |
1124 | @subsection Macro Type | |
5b359918 RS |
1125 | |
1126 | A @dfn{Lisp macro} is a user-defined construct that extends the Lisp | |
1127 | language. It is represented as an object much like a function, but with | |
969fe9b5 | 1128 | different argument-passing semantics. A Lisp macro has the form of a |
5b359918 RS |
1129 | list whose first element is the symbol @code{macro} and whose @sc{cdr} |
1130 | is a Lisp function object, including the @code{lambda} symbol. | |
1131 | ||
1132 | Lisp macro objects are usually defined with the built-in | |
1133 | @code{defmacro} function, but any list that begins with @code{macro} is | |
1134 | a macro as far as Emacs is concerned. @xref{Macros}, for an explanation | |
1135 | of how to write a macro. | |
1136 | ||
f9f59935 RS |
1137 | @strong{Warning}: Lisp macros and keyboard macros (@pxref{Keyboard |
1138 | Macros}) are entirely different things. When we use the word ``macro'' | |
1139 | without qualification, we mean a Lisp macro, not a keyboard macro. | |
1140 | ||
5b359918 RS |
1141 | @node Primitive Function Type |
1142 | @subsection Primitive Function Type | |
1143 | @cindex special forms | |
1144 | ||
1145 | A @dfn{primitive function} is a function callable from Lisp but | |
1146 | written in the C programming language. Primitive functions are also | |
1147 | called @dfn{subrs} or @dfn{built-in functions}. (The word ``subr'' is | |
1148 | derived from ``subroutine''.) Most primitive functions evaluate all | |
1149 | their arguments when they are called. A primitive function that does | |
1150 | not evaluate all its arguments is called a @dfn{special form} | |
1151 | (@pxref{Special Forms}).@refill | |
1152 | ||
1153 | It does not matter to the caller of a function whether the function is | |
969fe9b5 RS |
1154 | primitive. However, this does matter if you try to redefine a primitive |
1155 | with a function written in Lisp. The reason is that the primitive | |
1156 | function may be called directly from C code. Calls to the redefined | |
1157 | function from Lisp will use the new definition, but calls from C code | |
1158 | may still use the built-in definition. Therefore, @strong{we discourage | |
1159 | redefinition of primitive functions}. | |
5b359918 RS |
1160 | |
1161 | The term @dfn{function} refers to all Emacs functions, whether written | |
2b3fc6c3 RS |
1162 | in Lisp or C. @xref{Function Type}, for information about the |
1163 | functions written in Lisp. | |
5b359918 RS |
1164 | |
1165 | Primitive functions have no read syntax and print in hash notation | |
1166 | with the name of the subroutine. | |
1167 | ||
1168 | @example | |
1169 | @group | |
1170 | (symbol-function 'car) ; @r{Access the function cell} | |
1171 | ; @r{of the symbol.} | |
1172 | @result{} #<subr car> | |
1173 | (subrp (symbol-function 'car)) ; @r{Is this a primitive function?} | |
1174 | @result{} t ; @r{Yes.} | |
1175 | @end group | |
1176 | @end example | |
1177 | ||
1178 | @node Byte-Code Type | |
1179 | @subsection Byte-Code Function Type | |
1180 | ||
1181 | The byte compiler produces @dfn{byte-code function objects}. | |
1182 | Internally, a byte-code function object is much like a vector; however, | |
1183 | the evaluator handles this data type specially when it appears as a | |
1184 | function to be called. @xref{Byte Compilation}, for information about | |
1185 | the byte compiler. | |
1186 | ||
bfe721d1 KH |
1187 | The printed representation and read syntax for a byte-code function |
1188 | object is like that for a vector, with an additional @samp{#} before the | |
1189 | opening @samp{[}. | |
5b359918 RS |
1190 | |
1191 | @node Autoload Type | |
1192 | @subsection Autoload Type | |
1193 | ||
1194 | An @dfn{autoload object} is a list whose first element is the symbol | |
8241495d RS |
1195 | @code{autoload}. It is stored as the function definition of a symbol, |
1196 | where it serves as a placeholder for the real definition. The autoload | |
1197 | object says that the real definition is found in a file of Lisp code | |
1198 | that should be loaded when necessary. It contains the name of the file, | |
1199 | plus some other information about the real definition. | |
5b359918 RS |
1200 | |
1201 | After the file has been loaded, the symbol should have a new function | |
1202 | definition that is not an autoload object. The new definition is then | |
1203 | called as if it had been there to begin with. From the user's point of | |
1204 | view, the function call works as expected, using the function definition | |
1205 | in the loaded file. | |
1206 | ||
1207 | An autoload object is usually created with the function | |
1208 | @code{autoload}, which stores the object in the function cell of a | |
1209 | symbol. @xref{Autoload}, for more details. | |
1210 | ||
1211 | @node Editing Types | |
1212 | @section Editing Types | |
1213 | @cindex editing types | |
1214 | ||
a9f0a989 | 1215 | The types in the previous section are used for general programming |
969fe9b5 RS |
1216 | purposes, and most of them are common to most Lisp dialects. Emacs Lisp |
1217 | provides several additional data types for purposes connected with | |
1218 | editing. | |
5b359918 RS |
1219 | |
1220 | @menu | |
1221 | * Buffer Type:: The basic object of editing. | |
1222 | * Marker Type:: A position in a buffer. | |
1223 | * Window Type:: Buffers are displayed in windows. | |
1224 | * Frame Type:: Windows subdivide frames. | |
1225 | * Window Configuration Type:: Recording the way a frame is subdivided. | |
969fe9b5 | 1226 | * Frame Configuration Type:: Recording the status of all frames. |
5b359918 RS |
1227 | * Process Type:: A process running on the underlying OS. |
1228 | * Stream Type:: Receive or send characters. | |
1229 | * Keymap Type:: What function a keystroke invokes. | |
5b359918 RS |
1230 | * Overlay Type:: How an overlay is represented. |
1231 | @end menu | |
1232 | ||
1233 | @node Buffer Type | |
1234 | @subsection Buffer Type | |
1235 | ||
1236 | A @dfn{buffer} is an object that holds text that can be edited | |
1237 | (@pxref{Buffers}). Most buffers hold the contents of a disk file | |
1238 | (@pxref{Files}) so they can be edited, but some are used for other | |
1239 | purposes. Most buffers are also meant to be seen by the user, and | |
1240 | therefore displayed, at some time, in a window (@pxref{Windows}). But a | |
1241 | buffer need not be displayed in any window. | |
1242 | ||
1243 | The contents of a buffer are much like a string, but buffers are not | |
1244 | used like strings in Emacs Lisp, and the available operations are | |
969fe9b5 | 1245 | different. For example, you can insert text efficiently into an |
8241495d RS |
1246 | existing buffer, altering the buffer's contents, whereas ``inserting'' |
1247 | text into a string requires concatenating substrings, and the result is | |
1248 | an entirely new string object. | |
5b359918 RS |
1249 | |
1250 | Each buffer has a designated position called @dfn{point} | |
1251 | (@pxref{Positions}). At any time, one buffer is the @dfn{current | |
1252 | buffer}. Most editing commands act on the contents of the current | |
2b3fc6c3 RS |
1253 | buffer in the neighborhood of point. Many of the standard Emacs |
1254 | functions manipulate or test the characters in the current buffer; a | |
1255 | whole chapter in this manual is devoted to describing these functions | |
1256 | (@pxref{Text}). | |
5b359918 RS |
1257 | |
1258 | Several other data structures are associated with each buffer: | |
1259 | ||
1260 | @itemize @bullet | |
1261 | @item | |
1262 | a local syntax table (@pxref{Syntax Tables}); | |
1263 | ||
1264 | @item | |
1265 | a local keymap (@pxref{Keymaps}); and, | |
1266 | ||
1267 | @item | |
969fe9b5 | 1268 | a list of buffer-local variable bindings (@pxref{Buffer-Local Variables}). |
bfe721d1 KH |
1269 | |
1270 | @item | |
969fe9b5 | 1271 | overlays (@pxref{Overlays}). |
bfe721d1 KH |
1272 | |
1273 | @item | |
1274 | text properties for the text in the buffer (@pxref{Text Properties}). | |
5b359918 RS |
1275 | @end itemize |
1276 | ||
1277 | @noindent | |
2b3fc6c3 | 1278 | The local keymap and variable list contain entries that individually |
5b359918 RS |
1279 | override global bindings or values. These are used to customize the |
1280 | behavior of programs in different buffers, without actually changing the | |
1281 | programs. | |
1282 | ||
bfe721d1 | 1283 | A buffer may be @dfn{indirect}, which means it shares the text |
969fe9b5 | 1284 | of another buffer, but presents it differently. @xref{Indirect Buffers}. |
bfe721d1 KH |
1285 | |
1286 | Buffers have no read syntax. They print in hash notation, showing the | |
5b359918 RS |
1287 | buffer name. |
1288 | ||
1289 | @example | |
1290 | @group | |
1291 | (current-buffer) | |
1292 | @result{} #<buffer objects.texi> | |
1293 | @end group | |
1294 | @end example | |
1295 | ||
1296 | @node Marker Type | |
1297 | @subsection Marker Type | |
1298 | ||
1299 | A @dfn{marker} denotes a position in a specific buffer. Markers | |
1300 | therefore have two components: one for the buffer, and one for the | |
1301 | position. Changes in the buffer's text automatically relocate the | |
1302 | position value as necessary to ensure that the marker always points | |
1303 | between the same two characters in the buffer. | |
1304 | ||
1305 | Markers have no read syntax. They print in hash notation, giving the | |
1306 | current character position and the name of the buffer. | |
1307 | ||
1308 | @example | |
1309 | @group | |
1310 | (point-marker) | |
1311 | @result{} #<marker at 10779 in objects.texi> | |
1312 | @end group | |
1313 | @end example | |
1314 | ||
1315 | @xref{Markers}, for information on how to test, create, copy, and move | |
1316 | markers. | |
1317 | ||
1318 | @node Window Type | |
1319 | @subsection Window Type | |
1320 | ||
1321 | A @dfn{window} describes the portion of the terminal screen that Emacs | |
1322 | uses to display a buffer. Every window has one associated buffer, whose | |
1323 | contents appear in the window. By contrast, a given buffer may appear | |
1324 | in one window, no window, or several windows. | |
1325 | ||
1326 | Though many windows may exist simultaneously, at any time one window | |
1327 | is designated the @dfn{selected window}. This is the window where the | |
1328 | cursor is (usually) displayed when Emacs is ready for a command. The | |
1329 | selected window usually displays the current buffer, but this is not | |
1330 | necessarily the case. | |
1331 | ||
1332 | Windows are grouped on the screen into frames; each window belongs to | |
1333 | one and only one frame. @xref{Frame Type}. | |
1334 | ||
1335 | Windows have no read syntax. They print in hash notation, giving the | |
1336 | window number and the name of the buffer being displayed. The window | |
1337 | numbers exist to identify windows uniquely, since the buffer displayed | |
1338 | in any given window can change frequently. | |
1339 | ||
1340 | @example | |
1341 | @group | |
1342 | (selected-window) | |
1343 | @result{} #<window 1 on objects.texi> | |
1344 | @end group | |
1345 | @end example | |
1346 | ||
1347 | @xref{Windows}, for a description of the functions that work on windows. | |
1348 | ||
1349 | @node Frame Type | |
1350 | @subsection Frame Type | |
1351 | ||
a9f0a989 | 1352 | A @dfn{frame} is a rectangle on the screen that contains one or more |
5b359918 RS |
1353 | Emacs windows. A frame initially contains a single main window (plus |
1354 | perhaps a minibuffer window) which you can subdivide vertically or | |
1355 | horizontally into smaller windows. | |
1356 | ||
1357 | Frames have no read syntax. They print in hash notation, giving the | |
1358 | frame's title, plus its address in core (useful to identify the frame | |
1359 | uniquely). | |
1360 | ||
1361 | @example | |
1362 | @group | |
1363 | (selected-frame) | |
a9f0a989 | 1364 | @result{} #<frame emacs@@psilocin.gnu.org 0xdac80> |
5b359918 RS |
1365 | @end group |
1366 | @end example | |
1367 | ||
1368 | @xref{Frames}, for a description of the functions that work on frames. | |
1369 | ||
1370 | @node Window Configuration Type | |
1371 | @subsection Window Configuration Type | |
1372 | @cindex screen layout | |
1373 | ||
1374 | A @dfn{window configuration} stores information about the positions, | |
1375 | sizes, and contents of the windows in a frame, so you can recreate the | |
1376 | same arrangement of windows later. | |
1377 | ||
9e2b495b RS |
1378 | Window configurations do not have a read syntax; their print syntax |
1379 | looks like @samp{#<window-configuration>}. @xref{Window | |
1380 | Configurations}, for a description of several functions related to | |
1381 | window configurations. | |
5b359918 | 1382 | |
969fe9b5 RS |
1383 | @node Frame Configuration Type |
1384 | @subsection Frame Configuration Type | |
1385 | @cindex screen layout | |
1386 | ||
1387 | A @dfn{frame configuration} stores information about the positions, | |
1388 | sizes, and contents of the windows in all frames. It is actually | |
1389 | a list whose @sc{car} is @code{frame-configuration} and whose | |
1390 | @sc{cdr} is an alist. Each alist element describes one frame, | |
1391 | which appears as the @sc{car} of that element. | |
1392 | ||
1393 | @xref{Frame Configurations}, for a description of several functions | |
1394 | related to frame configurations. | |
1395 | ||
5b359918 RS |
1396 | @node Process Type |
1397 | @subsection Process Type | |
1398 | ||
1399 | The word @dfn{process} usually means a running program. Emacs itself | |
1400 | runs in a process of this sort. However, in Emacs Lisp, a process is a | |
1401 | Lisp object that designates a subprocess created by the Emacs process. | |
1402 | Programs such as shells, GDB, ftp, and compilers, running in | |
1403 | subprocesses of Emacs, extend the capabilities of Emacs. | |
1404 | ||
1405 | An Emacs subprocess takes textual input from Emacs and returns textual | |
1406 | output to Emacs for further manipulation. Emacs can also send signals | |
1407 | to the subprocess. | |
1408 | ||
1409 | Process objects have no read syntax. They print in hash notation, | |
1410 | giving the name of the process: | |
1411 | ||
1412 | @example | |
1413 | @group | |
1414 | (process-list) | |
1415 | @result{} (#<process shell>) | |
1416 | @end group | |
1417 | @end example | |
1418 | ||
1419 | @xref{Processes}, for information about functions that create, delete, | |
1420 | return information about, send input or signals to, and receive output | |
1421 | from processes. | |
1422 | ||
1423 | @node Stream Type | |
1424 | @subsection Stream Type | |
1425 | ||
1426 | A @dfn{stream} is an object that can be used as a source or sink for | |
1427 | characters---either to supply characters for input or to accept them as | |
1428 | output. Many different types can be used this way: markers, buffers, | |
1429 | strings, and functions. Most often, input streams (character sources) | |
1430 | obtain characters from the keyboard, a buffer, or a file, and output | |
1431 | streams (character sinks) send characters to a buffer, such as a | |
1432 | @file{*Help*} buffer, or to the echo area. | |
1433 | ||
1434 | The object @code{nil}, in addition to its other meanings, may be used | |
1435 | as a stream. It stands for the value of the variable | |
1436 | @code{standard-input} or @code{standard-output}. Also, the object | |
1437 | @code{t} as a stream specifies input using the minibuffer | |
1438 | (@pxref{Minibuffers}) or output in the echo area (@pxref{The Echo | |
1439 | Area}). | |
1440 | ||
1441 | Streams have no special printed representation or read syntax, and | |
1442 | print as whatever primitive type they are. | |
1443 | ||
3e099569 | 1444 | @xref{Read and Print}, for a description of functions |
2b3fc6c3 | 1445 | related to streams, including parsing and printing functions. |
5b359918 RS |
1446 | |
1447 | @node Keymap Type | |
1448 | @subsection Keymap Type | |
1449 | ||
1450 | A @dfn{keymap} maps keys typed by the user to commands. This mapping | |
1451 | controls how the user's command input is executed. A keymap is actually | |
1452 | a list whose @sc{car} is the symbol @code{keymap}. | |
1453 | ||
1454 | @xref{Keymaps}, for information about creating keymaps, handling prefix | |
1455 | keys, local as well as global keymaps, and changing key bindings. | |
1456 | ||
5b359918 RS |
1457 | @node Overlay Type |
1458 | @subsection Overlay Type | |
1459 | ||
f9f59935 RS |
1460 | An @dfn{overlay} specifies properties that apply to a part of a |
1461 | buffer. Each overlay applies to a specified range of the buffer, and | |
1462 | contains a property list (a list whose elements are alternating property | |
1463 | names and values). Overlay properties are used to present parts of the | |
1464 | buffer temporarily in a different display style. Overlays have no read | |
1465 | syntax, and print in hash notation, giving the buffer name and range of | |
1466 | positions. | |
5b359918 | 1467 | |
bfe721d1 KH |
1468 | @xref{Overlays}, for how to create and use overlays. |
1469 | ||
8241495d RS |
1470 | @node Circular Objects |
1471 | @section Read Syntax for Circular Objects | |
1472 | @cindex circular structure, read syntax | |
1473 | @cindex shared structure, read syntax | |
1474 | @cindex @samp{#@var{n}=} read syntax | |
1475 | @cindex @samp{#@var{n}#} read syntax | |
1476 | ||
1477 | In Emacs 21, to represent shared or circular structure within a | |
1478 | complex of Lisp objects, you can use the reader constructs | |
1479 | @samp{#@var{n}=} and @samp{#@var{n}#}. | |
1480 | ||
1481 | Use @code{#@var{n}=} before an object to label it for later reference; | |
1482 | subsequently, you can use @code{#@var{n}#} to refer the same object in | |
1483 | another place. Here, @var{n} is some integer. For example, here is how | |
1484 | to make a list in which the first element recurs as the third element: | |
1485 | ||
1486 | @example | |
1487 | (#1=(a) b #1#) | |
1488 | @end example | |
1489 | ||
1490 | @noindent | |
1491 | This differs from ordinary syntax such as this | |
1492 | ||
1493 | @example | |
1494 | ((a) b (a)) | |
1495 | @end example | |
1496 | ||
1497 | @noindent | |
1498 | which would result in a list whose first and third elements | |
1499 | look alike but are not the same Lisp object. This shows the difference: | |
1500 | ||
1501 | @example | |
1502 | (prog1 nil | |
1503 | (setq x '(#1=(a) b #1#))) | |
1504 | (eq (nth 0 x) (nth 2 x)) | |
1505 | @result{} t | |
1506 | (setq x '((a) b (a))) | |
1507 | (eq (nth 0 x) (nth 2 x)) | |
1508 | @result{} nil | |
1509 | @end example | |
1510 | ||
1511 | You can also use the same syntax to make a circular structure, which | |
1512 | appears as an ``element'' within itself. Here is an example: | |
1513 | ||
1514 | @example | |
1515 | #1=(a #1#) | |
1516 | @end example | |
1517 | ||
1518 | @noindent | |
1519 | This makes a list whose second element is the list itself. | |
1520 | Here's how you can see that it really works: | |
1521 | ||
1522 | @example | |
1523 | (prog1 nil | |
1524 | (setq x '#1=(a #1#))) | |
1525 | (eq x (cadr x)) | |
1526 | @result{} t | |
1527 | @end example | |
1528 | ||
1529 | The Lisp printer can produce this syntax to record circular and shared | |
1530 | structure in a Lisp object, if you bind the variable @code{print-circle} | |
1531 | to a non-@code{nil} value. @xref{Output Variables}. | |
1532 | ||
5b359918 RS |
1533 | @node Type Predicates |
1534 | @section Type Predicates | |
1535 | @cindex predicates | |
1536 | @cindex type checking | |
1537 | @kindex wrong-type-argument | |
1538 | ||
1539 | The Emacs Lisp interpreter itself does not perform type checking on | |
1540 | the actual arguments passed to functions when they are called. It could | |
1541 | not do so, since function arguments in Lisp do not have declared data | |
1542 | types, as they do in other programming languages. It is therefore up to | |
1543 | the individual function to test whether each actual argument belongs to | |
1544 | a type that the function can use. | |
1545 | ||
1546 | All built-in functions do check the types of their actual arguments | |
1547 | when appropriate, and signal a @code{wrong-type-argument} error if an | |
1548 | argument is of the wrong type. For example, here is what happens if you | |
2b3fc6c3 | 1549 | pass an argument to @code{+} that it cannot handle: |
5b359918 RS |
1550 | |
1551 | @example | |
1552 | @group | |
1553 | (+ 2 'a) | |
f9f59935 | 1554 | @error{} Wrong type argument: number-or-marker-p, a |
5b359918 RS |
1555 | @end group |
1556 | @end example | |
1557 | ||
1558 | @cindex type predicates | |
1559 | @cindex testing types | |
22697dac KH |
1560 | If you want your program to handle different types differently, you |
1561 | must do explicit type checking. The most common way to check the type | |
1562 | of an object is to call a @dfn{type predicate} function. Emacs has a | |
1563 | type predicate for each type, as well as some predicates for | |
1564 | combinations of types. | |
5b359918 | 1565 | |
22697dac KH |
1566 | A type predicate function takes one argument; it returns @code{t} if |
1567 | the argument belongs to the appropriate type, and @code{nil} otherwise. | |
1568 | Following a general Lisp convention for predicate functions, most type | |
1569 | predicates' names end with @samp{p}. | |
1570 | ||
1571 | Here is an example which uses the predicates @code{listp} to check for | |
1572 | a list and @code{symbolp} to check for a symbol. | |
1573 | ||
1574 | @example | |
1575 | (defun add-on (x) | |
1576 | (cond ((symbolp x) | |
1577 | ;; If X is a symbol, put it on LIST. | |
1578 | (setq list (cons x list))) | |
1579 | ((listp x) | |
1580 | ;; If X is a list, add its elements to LIST. | |
1581 | (setq list (append x list))) | |
1582 | (t | |
969fe9b5 | 1583 | ;; We handle only symbols and lists. |
22697dac KH |
1584 | (error "Invalid argument %s in add-on" x)))) |
1585 | @end example | |
1586 | ||
1587 | Here is a table of predefined type predicates, in alphabetical order, | |
5b359918 RS |
1588 | with references to further information. |
1589 | ||
1590 | @table @code | |
1591 | @item atom | |
1592 | @xref{List-related Predicates, atom}. | |
1593 | ||
1594 | @item arrayp | |
1595 | @xref{Array Functions, arrayp}. | |
1596 | ||
969fe9b5 RS |
1597 | @item bool-vector-p |
1598 | @xref{Bool-Vectors, bool-vector-p}. | |
1599 | ||
5b359918 RS |
1600 | @item bufferp |
1601 | @xref{Buffer Basics, bufferp}. | |
1602 | ||
1603 | @item byte-code-function-p | |
1604 | @xref{Byte-Code Type, byte-code-function-p}. | |
1605 | ||
1606 | @item case-table-p | |
969fe9b5 | 1607 | @xref{Case Tables, case-table-p}. |
5b359918 RS |
1608 | |
1609 | @item char-or-string-p | |
1610 | @xref{Predicates for Strings, char-or-string-p}. | |
1611 | ||
969fe9b5 RS |
1612 | @item char-table-p |
1613 | @xref{Char-Tables, char-table-p}. | |
1614 | ||
5b359918 RS |
1615 | @item commandp |
1616 | @xref{Interactive Call, commandp}. | |
1617 | ||
1618 | @item consp | |
1619 | @xref{List-related Predicates, consp}. | |
1620 | ||
969fe9b5 RS |
1621 | @item display-table-p |
1622 | @xref{Display Tables, display-table-p}. | |
1623 | ||
5b359918 RS |
1624 | @item floatp |
1625 | @xref{Predicates on Numbers, floatp}. | |
1626 | ||
969fe9b5 RS |
1627 | @item frame-configuration-p |
1628 | @xref{Frame Configurations, frame-configuration-p}. | |
1629 | ||
5b359918 RS |
1630 | @item frame-live-p |
1631 | @xref{Deleting Frames, frame-live-p}. | |
1632 | ||
1633 | @item framep | |
1634 | @xref{Frames, framep}. | |
1635 | ||
f9f59935 RS |
1636 | @item functionp |
1637 | @xref{Functions, functionp}. | |
1638 | ||
5b359918 RS |
1639 | @item integer-or-marker-p |
1640 | @xref{Predicates on Markers, integer-or-marker-p}. | |
1641 | ||
1642 | @item integerp | |
1643 | @xref{Predicates on Numbers, integerp}. | |
1644 | ||
1645 | @item keymapp | |
1646 | @xref{Creating Keymaps, keymapp}. | |
1647 | ||
e88399c8 DL |
1648 | @item keywordp |
1649 | @xref{Constant Variables}. | |
1650 | ||
5b359918 RS |
1651 | @item listp |
1652 | @xref{List-related Predicates, listp}. | |
1653 | ||
1654 | @item markerp | |
1655 | @xref{Predicates on Markers, markerp}. | |
1656 | ||
2b3fc6c3 RS |
1657 | @item wholenump |
1658 | @xref{Predicates on Numbers, wholenump}. | |
5b359918 RS |
1659 | |
1660 | @item nlistp | |
1661 | @xref{List-related Predicates, nlistp}. | |
1662 | ||
1663 | @item numberp | |
1664 | @xref{Predicates on Numbers, numberp}. | |
1665 | ||
1666 | @item number-or-marker-p | |
1667 | @xref{Predicates on Markers, number-or-marker-p}. | |
1668 | ||
1669 | @item overlayp | |
1670 | @xref{Overlays, overlayp}. | |
1671 | ||
1672 | @item processp | |
1673 | @xref{Processes, processp}. | |
1674 | ||
1675 | @item sequencep | |
1676 | @xref{Sequence Functions, sequencep}. | |
1677 | ||
1678 | @item stringp | |
1679 | @xref{Predicates for Strings, stringp}. | |
1680 | ||
1681 | @item subrp | |
1682 | @xref{Function Cells, subrp}. | |
1683 | ||
1684 | @item symbolp | |
1685 | @xref{Symbols, symbolp}. | |
1686 | ||
1687 | @item syntax-table-p | |
1688 | @xref{Syntax Tables, syntax-table-p}. | |
1689 | ||
1690 | @item user-variable-p | |
1691 | @xref{Defining Variables, user-variable-p}. | |
1692 | ||
1693 | @item vectorp | |
1694 | @xref{Vectors, vectorp}. | |
1695 | ||
1696 | @item window-configuration-p | |
1697 | @xref{Window Configurations, window-configuration-p}. | |
1698 | ||
1699 | @item window-live-p | |
1700 | @xref{Deleting Windows, window-live-p}. | |
1701 | ||
1702 | @item windowp | |
1703 | @xref{Basic Windows, windowp}. | |
1704 | @end table | |
1705 | ||
22697dac KH |
1706 | The most general way to check the type of an object is to call the |
1707 | function @code{type-of}. Recall that each object belongs to one and | |
1708 | only one primitive type; @code{type-of} tells you which one (@pxref{Lisp | |
1709 | Data Types}). But @code{type-of} knows nothing about non-primitive | |
1710 | types. In most cases, it is more convenient to use type predicates than | |
1711 | @code{type-of}. | |
1712 | ||
1713 | @defun type-of object | |
1714 | This function returns a symbol naming the primitive type of | |
9e2b495b RS |
1715 | @var{object}. The value is one of the symbols @code{symbol}, |
1716 | @code{integer}, @code{float}, @code{string}, @code{cons}, @code{vector}, | |
a61b9217 | 1717 | @code{char-table}, @code{bool-vector}, @code{hash-table}, @code{subr}, |
969fe9b5 RS |
1718 | @code{compiled-function}, @code{marker}, @code{overlay}, @code{window}, |
1719 | @code{buffer}, @code{frame}, @code{process}, or | |
9e2b495b | 1720 | @code{window-configuration}. |
22697dac KH |
1721 | |
1722 | @example | |
1723 | (type-of 1) | |
1724 | @result{} integer | |
1725 | (type-of 'nil) | |
1726 | @result{} symbol | |
1727 | (type-of '()) ; @r{@code{()} is @code{nil}.} | |
1728 | @result{} symbol | |
1729 | (type-of '(x)) | |
1730 | @result{} cons | |
1731 | @end example | |
1732 | @end defun | |
1733 | ||
5b359918 RS |
1734 | @node Equality Predicates |
1735 | @section Equality Predicates | |
1736 | @cindex equality | |
1737 | ||
1738 | Here we describe two functions that test for equality between any two | |
1739 | objects. Other functions test equality between objects of specific | |
2b3fc6c3 RS |
1740 | types, e.g., strings. For these predicates, see the appropriate chapter |
1741 | describing the data type. | |
5b359918 RS |
1742 | |
1743 | @defun eq object1 object2 | |
1744 | This function returns @code{t} if @var{object1} and @var{object2} are | |
1745 | the same object, @code{nil} otherwise. The ``same object'' means that a | |
1746 | change in one will be reflected by the same change in the other. | |
1747 | ||
1748 | @code{eq} returns @code{t} if @var{object1} and @var{object2} are | |
1749 | integers with the same value. Also, since symbol names are normally | |
1750 | unique, if the arguments are symbols with the same name, they are | |
1751 | @code{eq}. For other types (e.g., lists, vectors, strings), two | |
1752 | arguments with the same contents or elements are not necessarily | |
1753 | @code{eq} to each other: they are @code{eq} only if they are the same | |
1754 | object. | |
1755 | ||
5b359918 RS |
1756 | @example |
1757 | @group | |
1758 | (eq 'foo 'foo) | |
1759 | @result{} t | |
1760 | @end group | |
1761 | ||
1762 | @group | |
1763 | (eq 456 456) | |
1764 | @result{} t | |
1765 | @end group | |
1766 | ||
1767 | @group | |
1768 | (eq "asdf" "asdf") | |
1769 | @result{} nil | |
1770 | @end group | |
1771 | ||
1772 | @group | |
1773 | (eq '(1 (2 (3))) '(1 (2 (3)))) | |
1774 | @result{} nil | |
1775 | @end group | |
1776 | ||
1777 | @group | |
1778 | (setq foo '(1 (2 (3)))) | |
1779 | @result{} (1 (2 (3))) | |
1780 | (eq foo foo) | |
1781 | @result{} t | |
1782 | (eq foo '(1 (2 (3)))) | |
1783 | @result{} nil | |
1784 | @end group | |
1785 | ||
1786 | @group | |
1787 | (eq [(1 2) 3] [(1 2) 3]) | |
1788 | @result{} nil | |
1789 | @end group | |
1790 | ||
1791 | @group | |
1792 | (eq (point-marker) (point-marker)) | |
1793 | @result{} nil | |
1794 | @end group | |
1795 | @end example | |
1796 | ||
a9f0a989 RS |
1797 | The @code{make-symbol} function returns an uninterned symbol, distinct |
1798 | from the symbol that is used if you write the name in a Lisp expression. | |
1799 | Distinct symbols with the same name are not @code{eq}. @xref{Creating | |
1800 | Symbols}. | |
969fe9b5 RS |
1801 | |
1802 | @example | |
1803 | @group | |
1804 | (eq (make-symbol "foo") 'foo) | |
1805 | @result{} nil | |
1806 | @end group | |
1807 | @end example | |
5b359918 RS |
1808 | @end defun |
1809 | ||
1810 | @defun equal object1 object2 | |
1811 | This function returns @code{t} if @var{object1} and @var{object2} have | |
1812 | equal components, @code{nil} otherwise. Whereas @code{eq} tests if its | |
1813 | arguments are the same object, @code{equal} looks inside nonidentical | |
a61b9217 GM |
1814 | arguments to see if their elements or contents are the same. So, if two |
1815 | objects are @code{eq}, they are @code{equal}, but the converse is not | |
1816 | always true. | |
5b359918 RS |
1817 | |
1818 | @example | |
1819 | @group | |
1820 | (equal 'foo 'foo) | |
1821 | @result{} t | |
1822 | @end group | |
1823 | ||
1824 | @group | |
1825 | (equal 456 456) | |
1826 | @result{} t | |
1827 | @end group | |
1828 | ||
1829 | @group | |
1830 | (equal "asdf" "asdf") | |
1831 | @result{} t | |
1832 | @end group | |
1833 | @group | |
1834 | (eq "asdf" "asdf") | |
1835 | @result{} nil | |
1836 | @end group | |
1837 | ||
1838 | @group | |
1839 | (equal '(1 (2 (3))) '(1 (2 (3)))) | |
1840 | @result{} t | |
1841 | @end group | |
1842 | @group | |
1843 | (eq '(1 (2 (3))) '(1 (2 (3)))) | |
1844 | @result{} nil | |
1845 | @end group | |
1846 | ||
1847 | @group | |
1848 | (equal [(1 2) 3] [(1 2) 3]) | |
1849 | @result{} t | |
1850 | @end group | |
1851 | @group | |
1852 | (eq [(1 2) 3] [(1 2) 3]) | |
1853 | @result{} nil | |
1854 | @end group | |
1855 | ||
1856 | @group | |
1857 | (equal (point-marker) (point-marker)) | |
1858 | @result{} t | |
1859 | @end group | |
1860 | ||
1861 | @group | |
1862 | (eq (point-marker) (point-marker)) | |
1863 | @result{} nil | |
1864 | @end group | |
1865 | @end example | |
1866 | ||
f9f59935 RS |
1867 | Comparison of strings is case-sensitive, but does not take account of |
1868 | text properties---it compares only the characters in the strings. | |
1869 | A unibyte string never equals a multibyte string unless the | |
8241495d | 1870 | contents are entirely @sc{ascii} (@pxref{Text Representations}). |
5b359918 RS |
1871 | |
1872 | @example | |
1873 | @group | |
1874 | (equal "asdf" "ASDF") | |
1875 | @result{} nil | |
1876 | @end group | |
1877 | @end example | |
bfe721d1 | 1878 | |
a61b9217 GM |
1879 | However, two distinct buffers are never considered @code{equal}, even if |
1880 | their textual contents are the same. | |
5b359918 RS |
1881 | @end defun |
1882 | ||
a61b9217 GM |
1883 | The test for equality is implemented recursively; for example, given |
1884 | two cons cells @var{x} and @var{y}, @code{(equal @var{x} @var{y})} | |
1885 | returns @code{t} if and only if both the expressions below return | |
1886 | @code{t}: | |
1887 | ||
1888 | @example | |
1889 | (equal (car @var{x}) (car @var{y})) | |
1890 | (equal (cdr @var{x}) (cdr @var{y})) | |
1891 | @end example | |
1892 | ||
1893 | Because of this recursive method, circular lists may therefore cause | |
1894 | infinite recursion (leading to an error). |